Skip to content

Commit

Permalink
feat: Add django-constance and simplejwt dependencies in project conf…
Browse files Browse the repository at this point in the history 
…iguration
  • Loading branch information
@AhmedNassar7
AhmedNassar7 committed Dec 23, 2024
1 parent 8bf446d commit 9971c4c
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 61 deletions.
127 changes: 67 additions & 60 deletions egypt_metro/settings.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,12 @@
SECRET_KEY = os.getenv("SECRET_KEY") # Secret key for Django
DEBUG = os.getenv("DEBUG", "False") == "True" # Default to False
ALLOWED_HOSTS = config("ALLOWED_HOSTS", default="").split(",")
BASE_URL = os.getenv("BASE_URL") # Base URL for the project
JWT_SECRET = os.getenv("JWT_SECRET") # Secret key for JWT tokens

# Set API start time to the application's boot time
API_START_TIME = datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")

SESSION_COOKIE_AGE = 3600 # Session lasts for 1 hour
SESSION_SAVE_EVERY_REQUEST = True # Extend session each request
SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Session persists after closing the browser

# Debugging: Log the environment
# logger = logging.getLogger(__name__)
# logger.debug(f"Current environment: {ENVIRONMENT}")

# Application definition
INSTALLED_APPS = [
"django.contrib.admin", # Admin panel
Expand All @@ -63,6 +57,8 @@
"rest_framework_simplejwt", # JWT authentication
"corsheaders", # CORS headers
'drf_yasg', # Swagger
"constance", # Dynamic settings
"constance.backends.database", # Database backend for Constance
# "debug_toolbar", # Debug toolbar

# Custom apps
Expand All @@ -82,6 +78,7 @@
"django.middleware.clickjacking.XFrameOptionsMiddleware", # Clickjacking middleware
"corsheaders.middleware.CorsMiddleware", # CORS middleware
"allauth.account.middleware.AccountMiddleware", # Account middleware
"django.middleware.clickjacking.XFrameOptionsMiddleware", # Clickjacking middleware
# "debug_toolbar.middleware.DebugToolbarMiddleware", # Debug toolbar middleware
]

Expand All @@ -91,19 +88,16 @@
# CORS settings
CORS_ALLOW_ALL_ORIGINS = (
os.getenv("CORS_ALLOW_ALL_ORIGINS", "False") == "True"
) # Default to False

)
if not CORS_ALLOW_ALL_ORIGINS:
CORS_ALLOWED_ORIGINS = [
"https://backend-54v5.onrender.com",
"http://localhost:8000",
]

CORS_ALLOW_HEADERS = list(default_headers) + [ # Default headers + custom headers
CORS_ALLOW_HEADERS = list(default_headers) + [
"Authorization", # Authorization header
"Content-Type", # Content type header
]

CORS_ALLOW_CREDENTIALS = True # Allow credentials

if ENVIRONMENT == "dev":
Expand Down Expand Up @@ -139,11 +133,6 @@
# Custom User Model
AUTH_USER_MODEL = "users.User"

# General settings
SECRET_KEY = os.getenv("SECRET_KEY") # Secret key for Django
BASE_URL = os.getenv("BASE_URL") # Base URL for the project
JWT_SECRET = os.getenv("JWT_SECRET") # Secret key for JWT tokens

# Parse the DATABASE_URL environment variable
default_db_config = dj_database_url.config(
default=os.getenv("DATABASE_URL"), # Load from .env file or environment
Expand All @@ -170,45 +159,42 @@
}
}

# Security Settings General
SESSION_COOKIE_HTTPONLY = True # Prevent JavaScript access to session cookies
CSRF_COOKIE_HTTPONLY = True # Prevent JavaScript access to CSRF cookies
# SESSION_COOKIE_SAMESITE = "Lax" # Set SameSite cookie attribute
# CSRF_COOKIE_SAMESITE = "Lax" # Set SameSite cookie attribute
# CSRF_TRUSTED_ORIGINS = os.getenv("CSRF_TRUSTED_ORIGINS", "").split(",")
SESSION_COOKIE_DOMAIN = os.getenv("SESSION_COOKIE_DOMAIN", None)
CSRF_COOKIE_DOMAIN = os.getenv("CSRF_COOKIE_DOMAIN", None)

# Enforce additional production-specific settings
if ENVIRONMENT == "prod":
DATABASES["default"]["OPTIONS"].update({
"sslmode": "require", # Enforce SSL for secure connections
})

SESSION_COOKIE_SECURE = True # Ensures cookies are only sent over HTTPS
CSRF_COOKIE_SECURE = True # CSRF cookie should also be secure
SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Keep sessions open until explicitly logged out
SESSION_COOKIE_HTTPONLY = True # Avoid client-side access to session cookie
SESSION_SAVE_EVERY_REQUEST = True # Save the session on every request to ensure data consistency
CSRF_COOKIE_HTTPONLY = True # Make sure CSRF cookie can't be accessed via JavaScript
CSRF_TRUSTED_ORIGINS = [
'https://backend-54v5.onrender.com/', # Replace with your actual domain
]

# For secure connections over HTTPS (especially for production)
# Security settings Production
CSRF_COOKIE_SECURE = True # Ensure CSRF cookies are only sent over HTTPS
SESSION_COOKIE_SECURE = True # Ensure session cookies are only sent over HTTPS
SECURE_BROWSER_XSS_FILTER = True # Enable XSS protection for browsers
SECURE_CONTENT_TYPE_NOSNIFF = True # Prevent content type sniffing
SECURE_HSTS_SECONDS = 31536000 # 1 year in seconds
SECURE_HSTS_INCLUDE_SUBDOMAINS = True # Include subdomains for HSTS
SECURE_HSTS_PRELOAD = True # Enable HSTS preload list
SECURE_SSL_REDIRECT = True # Redirect HTTP to HTTPS
SECURE_HSTS_SECONDS = 3600 # HTTP Strict Transport Security (HSTS) in seconds
SECURE_HSTS_INCLUDE_SUBDOMAINS = True
SECURE_HSTS_PRELOAD = True
# Proxy Settings
USE_X_FORWARDED_HOST = True
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

# SECURE_REFERRER_POLICY = "same-origin" # Referrer policy
# X_FRAME_OPTIONS = "DENY" # Prevent framing of site content

REQUIRED_ENV_VARS = ["SECRET_KEY", "DATABASE_URL", "JWT_SECRET", "BASE_URL"]

for var in REQUIRED_ENV_VARS:
if not os.getenv(var):
raise ValueError(f"{var} is not set in environment variables.")

# if ENVIRONMENT == "prod":
# CACHES = {
# "default": {
# "BACKEND": "django.core.cache.backends.redis.RedisCache",
# "LOCATION": "redis://127.0.0.1:6379/1",
# 'OPTIONS': {
# 'CLIENT_CLASS': 'django_redis.client.DefaultClient'
# }
# }
# }

# Password validation
# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators

Expand Down Expand Up @@ -308,16 +294,37 @@
}

# Cache configuration
CACHES = {
"default": {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache", # Local memory cache
"LOCATION": "unique-snowflake", # Unique identifier for the cache
if ENVIRONMENT == "prod":
CACHES = {
"default": {
"BACKEND": "django.core.cache.backends.db.DatabaseCache",
"LOCATION": os.getenv("CACHE_LOCATION", "my_cache_table"),
}
}
else:
CACHES = {
"default": {
"BACKEND": os.getenv(
"CACHE_BACKEND",
"django.core.cache.backends.locmem.LocMemCache"
),
"LOCATION": os.getenv("CACHE_LOCATION", "unique-snowflake"),
}
}

# Constance Settings
CONSTANCE_BACKEND = "constance.backends.database.DatabaseBackend"
CONSTANCE_CONFIG = {
"SITE_TITLE": ("Egypt Metro", "Site title displayed in the admin panel."),
"DEFAULT_TIMEOUT": (30, "Default timeout for user actions."),
}

# Session engine configuration
SESSION_ENGINE = "django.contrib.sessions.backends.cache" # Session engine
# Session Settings
SESSION_ENGINE = "django.contrib.sessions.backends.cached_db" # Cached database session engine
SESSION_CACHE_ALIAS = "default" # Cache alias for sessions
SESSION_COOKIE_AGE = 3600 # Session cookie age in seconds (1 hour)
SESSION_EXPIRE_AT_BROWSER_CLOSE = ENVIRONMENT == "dev" # True for development, False for production
SESSION_SAVE_EVERY_REQUEST = True # Save session data on every request

INTERNAL_IPS = [
"127.0.0.1", # Localhost
Expand All @@ -338,16 +345,16 @@
USE_TZ = True

# Swagger settings
SWAGGER_SETTINGS = {
"USE_SESSION_AUTH": False, # Disable session-based authentication for Swagger
"SECURITY_DEFINITIONS": {
"Bearer": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
},
},
}
# SWAGGER_SETTINGS = {
# "USE_SESSION_AUTH": False, # Disable session-based authentication for Swagger
# "SECURITY_DEFINITIONS": {
# "Bearer": {
# "type": "apiKey",
# "name": "Authorization",
# "in": "header",
# },
# },
# }

# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
Expand Down
40 changes: 39 additions & 1 deletion poetry.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ whitenoise = "6.7.0" # WhiteNoise for serving static files in Django
# Development dependencies including testing and development tools.
django-db-geventpool = "^4.0.7"
django-silk = "^5.3.2"
django-constance = "^4.1.3"
simplejwt = "^2.0.1"
[tool.poetry.dev-dependencies]
pytest = "^6.2.4" # Pytest for unit testing
pytest-asyncio = "^0.15.1" # Pytest plugin for asyncio tests
Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ decorator==5.1.1 ; python_version >= "3.10" and python_version < "4.0"
distlib==0.3.9 ; python_version >= "3.10" and python_version < "4.0"
dj-database-url==2.3.0 ; python_version >= "3.10" and python_version < "4.0"
django-allauth==65.3.0 ; python_version >= "3.10" and python_version < "4.0"
django-constance==4.1.3 ; python_version >= "3.10" and python_version < "4.0"
django-cors-headers==4.6.0 ; python_version >= "3.10" and python_version < "4.0"
django-db-geventpool==4.0.7 ; python_version >= "3.10" and python_version < "4.0"
django-environ==0.11.2 ; python_version >= "3.10" and python_version < "4"
Expand Down Expand Up @@ -87,6 +88,7 @@ requests-oauthlib==2.0.0 ; python_version >= "3.10" and python_version < "4.0"
requests==2.32.3 ; python_version >= "3.10" and python_version < "4.0"
rfc3986[idna2008]==1.5.0 ; python_version >= "3.10" and python_version < "4.0"
rsa==4.9 ; python_version >= "3.10" and python_version < "4"
simplejwt==2.0.1 ; python_version >= "3.10" and python_version < "4.0"
six==1.16.0 ; python_version >= "3.10" and python_version < "4.0"
sniffio==1.3.1 ; python_version >= "3.10" and python_version < "4.0"
soupsieve==2.6 ; python_version >= "3.10" and python_version < "4.0"
Expand All @@ -97,6 +99,7 @@ tomli==2.2.1 ; python_version >= "3.10" and python_version < "3.11"
tornado==6.4.1 ; python_version >= "3.10" and python_version < "4.0"
traitlets==5.14.3 ; python_version >= "3.10" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.10" and python_version < "4.0"
typing==3.7.4.3 ; python_version >= "3.10" and python_version < "4.0"
tzdata==2024.2 ; python_version >= "3.10" and python_version < "4.0"
uritemplate==4.1.1 ; python_version >= "3.10" and python_version < "4.0"
urllib3==2.2.3 ; python_version >= "3.10" and python_version < "4.0"
Expand Down

0 comments on commit 9971c4c

Please sign in to comment.