Skip to content

configuration.md

Latest commit

 

History

History
126 lines (89 loc) · 4.41 KB

configuration.md

File metadata and controls

126 lines (89 loc) · 4.41 KB

Configuration Documentation

This documentation outlines the configuration of a secure file delivery system based on WordPress roles. It is intended for technically proficient users with server access and a basic understanding of PHP and WordPress.

Important Notes

Load Order

The load order of components is critical:

  1. secure-config.php must be loaded before any other components.
  2. Constants such as MIN_MEMORY_LIMIT must only be used after this file is included.
  3. WordPress should then be loaded via wp-load.php.

Access Control

The system implements a hierarchical access control:

  1. Administrator Access

    • Users with the 'administrator' role have full access to all protected files
    • This is a built-in feature that cannot be disabled
    • Administrators can access files in all group directories

  2. Role-Based Access

    • Other users can only access files in their assigned group directories
    • Access is controlled by the $role_folders configuration

Error Handling

If secure-config.php is missing or cannot be loaded, the script must terminate with an appropriate error message. The same applies if the WordPress path (WP_CORE_PATH) is not correctly set or if wp-load.php cannot be found.

File Transfer Settings

define('MAX_DIRECT_DOWNLOAD_SIZE', 1048576);  // 1 MB
define('CHUNK_SIZE', 4194304);               // 4 MB
define('MAX_FILE_SIZE', 1024 * 1024 * 1024); // 1 GB
define('MIN_MEMORY_LIMIT', '128M');          // Minimum PHP memory limit

Explanation:

  • MAX_DIRECT_DOWNLOAD_SIZE: Files up to this size are sent directly. Larger files are streamed.
  • CHUNK_SIZE: Size of data chunks during streaming. Smaller values slow down delivery; larger ones risk memory issues.
  • MAX_FILE_SIZE: Maximum allowed file size.
  • MIN_MEMORY_LIMIT: Minimum required PHP memory limit.

Logging Settings

define('LOG_DIR', dirname(__DIR__) . '/logs');
define('LOG_FILE', LOG_DIR . '/access.log');
define('LOG_MAX_SIZE', 5 * 1024 * 1024);  // 5 MB
define('LOG_MAX_FILES', 5);               // Max. 5 log files
define('DEBUG_MODE', true);               // Enable debug output

Explanation:

  • LOG_DIR: Directory for log files.
  • LOG_FILE: Path to the log file.
  • LOG_MAX_SIZE: Log rotation is triggered once this size is reached.
  • LOG_MAX_FILES: Maximum number of retained log files.
  • DEBUG_MODE: Enables additional debug output (recommended during development; disable in production).

Security Settings

define('CACHE_CONTROL', 'private, no-cache, no-store, must-revalidate');

define('SECURITY_HEADERS', [
    'X-Content-Type-Options: nosniff',
    'X-Frame-Options: DENY',
    'X-XSS-Protection: 1; mode=block',
    'Referrer-Policy: strict-origin-when-cross-origin',
    'Content-Security-Policy: default-src 'self'',
    'Strict-Transport-Security: max-age=31536000; includeSubDomains'
]);

Explanation:

  • CACHE_CONTROL: Controls caching behavior for file downloads.
  • SECURITY_HEADERS: Array of security-related HTTP headers to protect against common attack vectors.

Role-Based Directory Access

$role_folders = [
    'subscriber'  => 'group-1',
    'contributor' => 'group-1',
    'author'      => 'group-2'
];
  • Roles like subscriber and contributor have access to the group-1 directory.
  • author has access to group-2.
  • If multiple roles should access the same directory, assign the same target folder accordingly.

Allowed MIME Types for Downloads

$allowed_mime_types = [
    'pdf'  => 'application/pdf',
    'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
    'jpg'  => 'image/jpeg',
];

$allowed_mime_types['xlsx'] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';

Only file types defined in $allowed_mime_types are eligible for download. Additional types can be dynamically appended.

Behavior for Allowed MIME Types:

  • Files are made available for download, provided path, user role, and other conditions are met.

Behavior for Disallowed MIME Types:

  • The download is blocked.
  • Access is denied, and the request is logged (if logging is enabled).
  • No file data is sent to the client.

Configuration Advice

These configuration values should be tailored to your specific server environment. In production environments, DEBUG_MODE should be set to false. Security headers and role assignments should be reviewed and updated regularly as needed.