Skip to content
Snippets Groups Projects
Select Git revision
  • 7aa3773d6897dda21ca8353bf09c087ecacf4c26
  • main default
  • develop
  • feature/arch_support
  • feature/global_refactoring
  • v1.0.0
6 results

settings.py

Blame
  • settings.py 8.31 KiB
    """
    Django settings for rosetta project.
    
    Generated by 'django-admin startproject' using Django 2.2.
    
    For more information on this file, see
    https://docs.djangoproject.com/en/2.2/topics/settings/
    
    For the full list of settings and their values, see
    https://docs.djangoproject.com/en/2.2/ref/settings/
    """
    
    import os
    from django.core.exceptions import ImproperlyConfigured
    from .core_app.utils import booleanize
    
    # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
    BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    
    
    # Quick-start development settings - unsuitable for production
    # See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
    
    # SECURITY WARNING: keep the secret key used in production secret!
    SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY', '-3byo^nd6-x82fuj*#68mj=5#qp*gagg58sc($u$r-=g8ujxu4')
    
    # SECURITY WARNING: don't run with debug turned on in production!
    DEBUG = booleanize(os.environ.get('DJANGO_DEBUG', False))
    
    # SECURITY WARNING: check if you want this in production
    ALLOWED_HOSTS = ['*']
    
    
    # Application definition
    INSTALLED_APPS = [
        'rosetta.core_app',
        'django.contrib.admin',
        'django.contrib.auth',
        'mozilla_django_oidc',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        'rest_framework',
        'rest_framework_swagger',
        'django_extensions', 
    ]
    
    MIDDLEWARE = [
        'django.middleware.security.SecurityMiddleware',
        'django.contrib.sessions.middleware.SessionMiddleware',
        'django.middleware.common.CommonMiddleware',
        'django.middleware.csrf.CsrfViewMiddleware',
        'django.contrib.auth.middleware.AuthenticationMiddleware',
        'django.contrib.messages.middleware.MessageMiddleware',
        'django.middleware.clickjacking.XFrameOptionsMiddleware',
    ]
    
    ROOT_URLCONF = 'rosetta.urls'
    
    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',
                    'rosetta.context_processors.export_vars'
                ],
            },
        },
    ]
    
    WSGI_APPLICATION = 'rosetta.wsgi.application'
    
    
    # Database
    # https://docs.djangoproject.com/en/2.2/ref/settings/#databases
    
    default_db_engine = 'django.db.backends.sqlite3'
    default_db_name   = os.path.join(BASE_DIR, '../rosetta_database.sqlite3')
    
    DATABASES = {
        'default': {
            'ENGINE': os.environ.get('DJANGO_DB_ENGINE', default_db_engine),
            'NAME': os.environ.get('DJANGO_DB_NAME', default_db_name),
            'USER': os.environ.get('DJANGO_DB_USER', None),
            'PASSWORD': os.environ.get('DJANGO_DB_PASSWORD', None),
            'HOST': os.environ.get('DJANGO_DB_HOST', None),
            'PORT': os.environ.get('DJANGO_DB_PORT',None),
        }
    }
    
    
    
    
    # Password validation
    # https://docs.djangoproject.com/en/2.2/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.2/topics/i18n/
    
    LANGUAGE_CODE = 'en-us'
    
    TIME_ZONE = 'UTC'
    
    USE_I18N = True
    
    USE_L10N = True
    
    USE_TZ = True
    
    
    # Static files (CSS, JavaScript, Images)
    # https://docs.djangoproject.com/en/2.2/howto/static-files/
    
    STATIC_URL = '/static/'         # URL path
    STATIC_ROOT = '/rosetta/static' # Filesystem path
    
    
    # REST framework settings
    REST_FRAMEWORK = {
        'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
        'PAGE_SIZE': 100000
    }
    
    # Swagger settings
    # See https://django-rest-swagger.readthedocs.io/en/latest/settings/
    
    SWAGGER_SETTINGS = {
        'SECURITY_DEFINITIONS': {},
        'USE_SESSION_AUTH': False
    }
    
    
    #===============================
    #  Email settings
    #===============================
    
    DJANGO_PUBLIC_HTTP_HOST = os.environ.get('DJANGO_PUBLIC_HTTP_HOST', 'http://localhost')
    
    DJANGO_EMAIL_SERVICE = os.environ.get('DJANGO_EMAIL_SERVICE', 'Sendgrid')
    if not DJANGO_EMAIL_SERVICE in ['Sendgrid', None]:
        raise ImproperlyConfigured('Invalid EMAIL_METHOD ("{}")'.format(DJANGO_EMAIL_SERVICE))
    DJANGO_EMAIL_FROM = os.environ.get('DJANGO_EMAIL_FROM', 'Rosetta <notifications@rosetta.local')
    DJANGO_EMAIL_APIKEY = os.environ.get('DJANGO_EMAIL_APIKEY', None)
    
    
    #===============================
    #  Logging
    #===============================
    
    DJANGO_LOG_LEVEL  = os.environ.get('DJANGO_LOG_LEVEL','ERROR')
    ROSETTA_LOG_LEVEL = os.environ.get('ROSETTA_LOG_LEVEL','ERROR')
    
    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
     
        'formatters': {
            'verbose': {
                'format': '%(levelname)s %(asctime)s %(module)s %(process)d '
                          '%(thread)d %(message)s',
            },
            'halfverbose': {
                'format': '%(asctime)s, %(name)s: [%(levelname)s] - %(message)s',
                'datefmt': '%m/%d/%Y %I:%M:%S %p'
            }
        },
     
        'filters': {
            'require_debug_false': {
                '()': 'django.utils.log.RequireDebugFalse'
            }
        },
     
        'handlers': {
            'mail_admins': {
                'level': 'ERROR',
                'filters': ['require_debug_false'],
                'class': 'django.utils.log.AdminEmailHandler'
            },
            'console': {
                'level': 'DEBUG',
                'class': 'logging.StreamHandler',
                'formatter': 'halfverbose',
            },
        },
     
        'loggers': {
            'rosetta': {
                'handlers': ['console'],
                'level': ROSETTA_LOG_LEVEL,
                'propagate': False, # Do not propagate or the root logger will emit as well, and even at lower levels. 
            },
            'django': {
                'handlers': ['console'],
                'level': DJANGO_LOG_LEVEL,
                'propagate': False, # Do not propagate or the root logger will emit as well, and even at lower levels. 
            }, 
            # Read more about the 'django' logger: https://docs.djangoproject.com/en/2.2/topics/logging/#django-logger
            # Read more about logging in the right way: https://lincolnloop.com/blog/django-logging-right-way/
        }
    }
    
    
    # Local user data dir
    LOCAL_USER_DATA_DIR = os.environ.get('LOCAL_USER_DATA_DIR', '/data')
    
    # Invitation code if any
    INVITATION_CODE = os.environ.get('INVITATION_CODE', None)
    
    
    #===============================
    #  Auth
    #===============================
    
    OIDC_RP_CLIENT_ID  = os.environ.get('OIDC_RP_CLIENT_ID', None)
    
    if OIDC_RP_CLIENT_ID:
    
        # Add 'mozilla_django_oidc' authentication backend
        AUTHENTICATION_BACKENDS = (
            'django.contrib.auth.backends.ModelBackend',
            'rosetta.auth.RosettaOIDCAuthenticationBackend'
        )
        
        # Base
        OIDC_RP_CLIENT_SECRET  = os.environ.get('OIDC_RP_CLIENT_SECRET')
        OIDC_OP_AUTHORIZATION_ENDPOINT = os.environ.get('OIDC_OP_AUTHORIZATION_ENDPOINT')
        OIDC_OP_TOKEN_ENDPOINT = os.environ.get('OIDC_OP_TOKEN_ENDPOINT')
        OIDC_OP_USER_ENDPOINT = os.environ.get('OIDC_OP_USER_ENDPOINT')
        OIDC_RP_SIGN_ALGO = os.environ.get('OIDC_RP_SIGN_ALGO', 'RS256')
        OIDC_RP_IDP_SIGN_KEY = os.environ.get('OIDC_RP_IDP_SIGN_KEY', None)
        OIDC_OP_JWKS_ENDPOINT = os.environ.get('OIDC_OP_JWKS_ENDPOINT', None)
        
        # Check
        if OIDC_RP_SIGN_ALGO == 'RS256':
            if not OIDC_RP_IDP_SIGN_KEY and not OIDC_OP_JWKS_ENDPOINT:
                raise ImproperlyConfigured('RS256 OpenID requires OIDC_RP_IDP_SIGN_KEY or OIDC_OP_JWKS_ENDPOINT to be set')
    
        # Optional
        OIDC_USE_NONCE =  booleanize(os.environ.get('OIDC_USE_NONCE', False))
        OIDC_TOKEN_USE_BASIC_AUTH = booleanize(os.environ.get('OIDC_TOKEN_USE_BASIC_AUTH', True))
        
        # Non-customizable stuff
        LOGIN_REDIRECT_URL = '/'
        LOGOUT_REDIRECT_URL = '/'
        LOGIN_REDIRECT_URL_FAILURE = '/'
        #OIDC_AUTHENTICATION_CALLBACK_URL = 'rosetta.local/oidc/callback/'
    
        # Required for the Open ID connect redirects to work properly
        USE_X_FORWARDED_HOST = True
        SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')