mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
dc9ab52edc
- Use the X-Forwarded-For header only if specified in the configuration. This makes FreedomBox safe to use when not behind a reverse proxy server (although we are unlikely to do this). - When fetching the IP address to reset after successful login, use the X-Forwarded-For header only if specified in the configuration. - Minor flake8 refactorings. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
122 lines
3.8 KiB
Python
122 lines
3.8 KiB
Python
#
|
|
# This file is part of FreedomBox.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
import configparser
|
|
import logging
|
|
import os
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
box_name = None
|
|
root = None
|
|
file_root = None
|
|
config_dir = None
|
|
data_dir = None
|
|
custom_static_dir = None
|
|
store_file = None
|
|
actions_dir = None
|
|
doc_dir = None
|
|
host = None
|
|
port = None
|
|
use_x_forwarded_for = False
|
|
use_x_forwarded_host = False
|
|
secure_proxy_ssl_header = None
|
|
develop = False
|
|
server_dir = '/'
|
|
danube_edition = False
|
|
|
|
config_file = None
|
|
|
|
DEFAULT_CONFIG_FILE = '/etc/plinth/plinth.config'
|
|
DEFAULT_ROOT = '/'
|
|
|
|
|
|
def get_fallback_config_paths():
|
|
"""Get config paths of the current source code folder"""
|
|
root_directory = os.path.dirname(os.path.realpath(__file__))
|
|
root_directory = os.path.join(root_directory, '..')
|
|
root_directory = os.path.realpath(root_directory)
|
|
config_path = os.path.join(root_directory, 'plinth.config')
|
|
return config_path, root_directory
|
|
|
|
|
|
def get_config_paths():
|
|
"""Get config paths.
|
|
Return the fallback plinth config if the default one does not exist"""
|
|
root_directory = DEFAULT_ROOT
|
|
config_path = DEFAULT_CONFIG_FILE
|
|
if not os.path.isfile(config_path):
|
|
config_path, root_directory = get_fallback_config_paths()
|
|
return config_path, root_directory
|
|
|
|
|
|
def read(config_path=None, root_directory=None):
|
|
"""
|
|
Read configuration.
|
|
|
|
- config_path: path of plinth.config file
|
|
- root_directory: path of plinth root folder
|
|
"""
|
|
if not config_path and not root_directory:
|
|
config_path, root_directory = get_config_paths()
|
|
|
|
if not os.path.isfile(config_path):
|
|
msg = 'No plinth.config file could be found on path: %s' % config_path
|
|
raise FileNotFoundError(msg)
|
|
|
|
global config_file # pylint: disable-msg=invalid-name,global-statement
|
|
config_file = config_path
|
|
|
|
parser = configparser.ConfigParser(defaults={
|
|
'root': os.path.realpath(root_directory),
|
|
})
|
|
parser.read(config_file)
|
|
|
|
config_items = (
|
|
('Path', 'root', 'string'),
|
|
('Path', 'file_root', 'string'),
|
|
('Path', 'config_dir', 'string'),
|
|
('Path', 'data_dir', 'string'),
|
|
('Path', 'custom_static_dir', 'string'),
|
|
('Path', 'store_file', 'string'),
|
|
('Path', 'actions_dir', 'string'),
|
|
('Path', 'doc_dir', 'string'),
|
|
('Path', 'server_dir', 'string'),
|
|
('Network', 'host', 'string'),
|
|
('Network', 'port', 'int'),
|
|
('Network', 'secure_proxy_ssl_header', 'string'),
|
|
('Network', 'use_x_forwarded_for', 'bool'),
|
|
('Network', 'use_x_forwarded_host', 'bool'),
|
|
('Misc', 'box_name', 'string'),
|
|
('Misc', 'danube_edition', 'bool'),
|
|
)
|
|
|
|
for section, name, datatype in config_items:
|
|
try:
|
|
value = parser.get(section, name)
|
|
except (configparser.NoSectionError, configparser.NoOptionError):
|
|
logger.error('Configuration does not contain option: %s.%s',
|
|
section, name)
|
|
raise
|
|
else:
|
|
if datatype == 'int':
|
|
value = int(value)
|
|
elif datatype == 'bool':
|
|
value = (value.lower() == 'true')
|
|
|
|
globals()[name] = value
|