This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/passbook/root/settings.py

355 lines
11 KiB
Python
Raw Normal View History

2018-11-11 12:41:48 +00:00
"""
Django settings for passbook project.
Generated by 'django-admin startproject' using Django 2.1.3.
For more information on this file, see
https://docs.djangoproject.com/en/2.1/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.1/ref/settings/
"""
2018-11-16 08:10:35 +00:00
import importlib
2018-11-11 12:41:48 +00:00
import os
2019-02-11 16:36:36 +00:00
import sys
2018-11-11 12:41:48 +00:00
2019-09-30 16:04:04 +00:00
import structlog
from celery.schedules import crontab
2019-04-04 19:48:50 +00:00
from sentry_sdk import init as sentry_init
from sentry_sdk.integrations.celery import CeleryIntegration
from sentry_sdk.integrations.django import DjangoIntegration
2018-11-11 12:41:48 +00:00
from passbook import __version__
2018-11-16 08:10:35 +00:00
from passbook.lib.config import CONFIG
from passbook.lib.sentry import before_send
2018-11-16 08:10:35 +00:00
LOGGER = structlog.get_logger()
2018-11-11 12:41:48 +00:00
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
2018-12-09 21:12:41 +00:00
STATIC_ROOT = BASE_DIR + '/static'
2018-11-11 12:41:48 +00:00
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.1/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
2019-09-30 16:04:04 +00:00
SECRET_KEY = CONFIG.y('secret_key',
"9$@r!d^1^jrn#fk#1#@ks#9&i$^s#1)_13%$rwjrhd=e8jfi_s") # noqa Debug
2018-11-11 12:41:48 +00:00
2019-09-30 16:04:04 +00:00
DEBUG = CONFIG.y_bool('debug')
2018-11-11 12:41:48 +00:00
INTERNAL_IPS = ['127.0.0.1']
ALLOWED_HOSTS = ['*']
2019-03-14 17:01:41 +00:00
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
2018-11-11 12:41:48 +00:00
2018-11-16 08:10:35 +00:00
LOGIN_URL = 'passbook_core:auth-login'
# CSRF_FAILURE_VIEW = 'passbook.core.views.errors.CSRFErrorView.as_view'
2018-11-11 12:41:48 +00:00
# Custom user model
AUTH_USER_MODEL = 'passbook_core.User'
2018-12-09 20:06:36 +00:00
CSRF_COOKIE_NAME = 'passbook_csrf'
SESSION_COOKIE_NAME = 'passbook_session'
2019-10-08 08:44:44 +00:00
SESSION_COOKIE_DOMAIN = CONFIG.y('domain', None)
2018-12-09 20:06:36 +00:00
LANGUAGE_COOKIE_NAME = 'passbook_language'
2018-11-11 12:41:48 +00:00
AUTHENTICATION_BACKENDS = [
'django.contrib.auth.backends.ModelBackend',
2018-11-11 12:41:48 +00:00
]
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
2019-03-08 14:49:45 +00:00
'django.contrib.postgres',
2019-09-30 16:04:04 +00:00
# 'rest_framework',
# 'drf_yasg',
'passbook.core.apps.PassbookCoreConfig',
'passbook.admin.apps.PassbookAdminConfig',
'passbook.api.apps.PassbookAPIConfig',
'passbook.lib.apps.PassbookLibConfig',
2019-10-07 14:33:48 +00:00
'passbook.audit.apps.PassbookAuditConfig',
'passbook.recovery.apps.PassbookRecoveryConfig',
2019-10-07 14:33:48 +00:00
'passbook.sources.ldap.apps.PassbookSourceLDAPConfig',
'passbook.sources.oauth.apps.PassbookSourceOAuthConfig',
'passbook.providers.app_gw.apps.PassbookApplicationApplicationGatewayConfig',
'passbook.providers.oauth.apps.PassbookProviderOAuthConfig',
'passbook.providers.oidc.apps.PassbookProviderOIDCConfig',
'passbook.providers.saml.apps.PassbookProviderSAMLConfig',
'passbook.factors.otp.apps.PassbookFactorOTPConfig',
'passbook.factors.captcha.apps.PassbookFactorCaptchaConfig',
'passbook.factors.password.apps.PassbookFactorPasswordConfig',
'passbook.factors.dummy.apps.PassbookFactorDummyConfig',
'passbook.factors.email.apps.PassbookFactorEmailConfig',
2019-10-07 14:33:48 +00:00
'passbook.policies.expiry.apps.PassbookPolicyExpiryConfig',
'passbook.policies.reputation.apps.PassbookPolicyReputationConfig',
'passbook.policies.hibp.apps.PassbookPolicyHIBPConfig',
'passbook.policies.group.apps.PassbookPoliciesGroupConfig',
'passbook.policies.matcher.apps.PassbookPoliciesMatcherConfig',
'passbook.policies.password.apps.PassbookPoliciesPasswordConfig',
'passbook.policies.sso.apps.PassbookPoliciesSSOConfig',
'passbook.policies.webhook.apps.PassbookPoliciesWebhookConfig',
2018-11-11 12:41:48 +00:00
]
2018-11-16 08:10:35 +00:00
REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
]
}
CACHES = {
"default": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": (f"redis://:{CONFIG.y('redis.password')}@{CONFIG.y('redis.host')}:6379"
f"/{CONFIG.y('redis.cache_db')}"),
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
}
}
2019-09-30 16:04:04 +00:00
DJANGO_REDIS_IGNORE_EXCEPTIONS = True
DJANGO_REDIS_LOG_IGNORED_EXCEPTIONS = True
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
2019-09-30 16:04:04 +00:00
SESSION_CACHE_ALIAS = "default"
2018-11-11 12:41:48 +00:00
MIDDLEWARE = [
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.middleware.security.SecurityMiddleware',
2018-11-11 12:41:48 +00:00
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
2019-06-25 16:11:08 +00:00
ROOT_URLCONF = 'passbook.root.urls'
2018-11-11 12:41:48 +00:00
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
2019-09-30 16:04:04 +00:00
WSGI_APPLICATION = 'passbook.root.wsgi.application'
2018-11-11 12:41:48 +00:00
# Database
# https://docs.djangoproject.com/en/2.1/ref/settings/#databases
2019-09-30 16:04:04 +00:00
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'HOST': CONFIG.y('postgresql.host'),
'NAME': CONFIG.y('postgresql.name'),
'USER': CONFIG.y('postgresql.user'),
'PASSWORD': CONFIG.y('postgresql.password'),
2018-11-11 12:41:48 +00:00
}
2019-09-30 16:04:04 +00:00
}
2018-11-11 12:41:48 +00:00
# Password validation
# https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# Internationalization
# https://docs.djangoproject.com/en/2.1/topics/i18n/
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Celery settings
# Add a 10 minute timeout to all Celery tasks.
CELERY_TASK_SOFT_TIME_LIMIT = 600
CELERY_BEAT_SCHEDULE = {
'clean_nonces': {
'task': 'passbook.core.tasks.clean_nonces',
'schedule': crontab(minute='*/5') # Run every 5 minutes
}
}
CELERY_CREATE_MISSING_QUEUES = True
CELERY_TASK_DEFAULT_QUEUE = 'passbook'
2019-09-30 16:04:04 +00:00
CELERY_BROKER_URL = (f"redis://:{CONFIG.y('redis.password')}@{CONFIG.y('redis.host')}"
f":6379/{CONFIG.y('redis.message_queue_db')}")
CELERY_RESULT_BACKEND = (f"redis://:{CONFIG.y('redis.password')}@{CONFIG.y('redis.host')}"
f":6379/{CONFIG.y('redis.message_queue_db')}")
2019-03-03 19:48:31 +00:00
# Database backup
if CONFIG.y('postgresql.backup'):
INSTALLED_APPS += ['dbbackup']
DBBACKUP_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'
AWS_ACCESS_KEY_ID = CONFIG.y('postgresql.backup.access_key')
AWS_SECRET_ACCESS_KEY = CONFIG.y('postgresql.backup.secret_key')
AWS_STORAGE_BUCKET_NAME = CONFIG.y('postgresql.backup.bucket')
AWS_S3_ENDPOINT_URL = CONFIG.y('postgresql.backup.host')
AWS_DEFAULT_ACL = None
LOGGER.info('Database backup is configured', host=CONFIG.y('postgresql.backup.host'))
# Add automatic task to backup
CELERY_BEAT_SCHEDULE['db_backup'] = {
'task': 'passbook.lib.tasks.backup_database',
'schedule': crontab(minute=0, hour=0) # Run every day, midnight
}
2019-04-11 13:30:42 +00:00
# Sentry integration
2019-04-11 13:30:42 +00:00
if not DEBUG:
sentry_init(
2019-07-03 15:35:54 +00:00
dsn="https://33cdbcb23f8b436dbe0ee06847410b67@sentry.beryju.org/3",
2019-04-11 13:30:42 +00:00
integrations=[
DjangoIntegration(),
2019-09-30 16:04:04 +00:00
CeleryIntegration()
2019-04-11 13:30:42 +00:00
],
send_default_pii=True,
before_send=before_send,
2019-07-05 14:00:01 +00:00
release='passbook@%s' % __version__
2019-04-11 13:30:42 +00:00
)
2018-11-11 12:41:48 +00:00
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.1/howto/static-files/
STATIC_URL = '/static/'
2019-09-30 16:04:04 +00:00
structlog.configure_once(
processors=[
structlog.stdlib.add_log_level,
structlog.stdlib.PositionalArgumentsFormatter(),
structlog.processors.TimeStamper(),
structlog.processors.StackInfoRenderer(),
# structlog.processors.format_exc_info,
structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
],
context_class=structlog.threadlocal.wrap_dict(dict),
logger_factory=structlog.stdlib.LoggerFactory(),
wrapper_class=structlog.stdlib.BoundLogger,
cache_logger_on_first_use=True,
)
LOG_PRE_CHAIN = [
# Add the log level and a timestamp to the event_dict if the log entry
# is not from structlog.
structlog.stdlib.add_log_level,
structlog.processors.TimeStamper(),
]
2018-11-11 12:41:48 +00:00
with CONFIG.cd('log'):
2019-09-30 16:04:04 +00:00
LOGGING_HANDLER_MAP = {
'passbook': 'DEBUG',
'django': 'WARNING',
'celery': 'WARNING',
'grpc': 'DEBUG',
'oauthlib': 'DEBUG',
'oauth2_provider': 'DEBUG',
}
2018-11-11 12:41:48 +00:00
LOGGING = {
'version': 1,
2019-09-30 16:04:04 +00:00
'disable_existing_loggers': False,
2018-11-11 12:41:48 +00:00
'formatters': {
2019-09-30 16:04:04 +00:00
"plain": {
"()": structlog.stdlib.ProcessorFormatter,
2019-10-15 13:40:38 +00:00
"processor": structlog.processors.JSONRenderer(sort_keys=True),
2019-09-30 16:04:04 +00:00
"foreign_pre_chain": LOG_PRE_CHAIN,
},
"colored": {
"()": structlog.stdlib.ProcessorFormatter,
"processor": structlog.dev.ConsoleRenderer(colors=DEBUG),
"foreign_pre_chain": LOG_PRE_CHAIN,
2018-11-11 12:41:48 +00:00
},
},
'handlers': {
'console': {
2019-09-30 16:04:04 +00:00
'level': DEBUG,
2018-11-11 12:41:48 +00:00
'class': 'logging.StreamHandler',
2019-09-30 16:04:04 +00:00
'formatter': "colored" if DEBUG else "plain",
2018-11-11 12:41:48 +00:00
},
},
'loggers': {
}
}
2019-09-30 16:04:04 +00:00
for handler_name, level in LOGGING_HANDLER_MAP.items():
LOGGING['loggers'][handler_name] = {
'handlers': ['console'],
'level': level,
'propagate': True,
}
2018-11-11 12:41:48 +00:00
2019-02-11 16:36:36 +00:00
TEST = False
TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
TEST_OUTPUT_VERBOSE = 2
TEST_OUTPUT_FILE_NAME = 'unittest.xml'
if any('test' in arg for arg in sys.argv):
LOGGING = None
TEST = True
2019-02-26 13:24:50 +00:00
CELERY_TASK_ALWAYS_EAGER = True
2019-02-11 16:36:36 +00:00
2019-09-30 16:04:04 +00:00
_DISALLOWED_ITEMS = [
'INSTALLED_APPS',
'MIDDLEWARE',
'AUTHENTICATION_BACKENDS',
'CELERY_BEAT_SCHEDULE'
]
2018-11-16 08:10:35 +00:00
# Load subapps's INSTALLED_APPS
for _app in INSTALLED_APPS:
2019-10-07 14:33:48 +00:00
if _app.startswith('passbook'):
2018-11-16 08:10:35 +00:00
if 'apps' in _app:
_app = '.'.join(_app.split('.')[:-2])
try:
app_settings = importlib.import_module("%s.settings" % _app)
INSTALLED_APPS.extend(getattr(app_settings, 'INSTALLED_APPS', []))
MIDDLEWARE.extend(getattr(app_settings, 'MIDDLEWARE', []))
AUTHENTICATION_BACKENDS.extend(getattr(app_settings, 'AUTHENTICATION_BACKENDS', []))
CELERY_BEAT_SCHEDULE.update(getattr(app_settings, 'CELERY_BEAT_SCHEDULE', {}))
for _attr in dir(app_settings):
if not _attr.startswith('__') and _attr not in _DISALLOWED_ITEMS:
globals()[_attr] = getattr(app_settings, _attr)
2018-11-16 08:10:35 +00:00
except ImportError:
pass
if DEBUG:
INSTALLED_APPS.append('debug_toolbar')
MIDDLEWARE.append('debug_toolbar.middleware.DebugToolbarMiddleware')