diff --git a/Dockerfile b/Dockerfile index 1b6c2e67..5e62ccdf 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,11 +20,8 @@ RUN mkdir -p /data/public/ # Make sure the Apache config is valid RUN ["apache2ctl", "configtest"] -# Copy the SimpleSAMLphp configuration files to a temporary location -COPY build/ssp-overrides /tmp/ssp-overrides - # Put in place the script to be used by child Docker images to install Composer -# dependencies and move the SSP overrides into place. +# dependencies. COPY build/install-deps-and-ssp-overrides.sh /tmp RUN chmod +x /tmp/install-deps-and-ssp-overrides.sh diff --git a/README.md b/README.md index 720d6c7e..ad9e2e2b 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,18 @@ This website is available as a Docker image here: We recommend using that as the `FROM` in your own Dockerfile in your own -private repo, where you would `COPY` into your own Docker image the files needed -by SimpleSAMLphp (if using SAML logins), your own -`/data/public/img/logos/site-logo.png`, etc. +private repo, where you would `COPY` into your own Docker image any custom files +you need (e.g. your own `/data/public/img/logos/site-logo.png`, etc.). -Your Dockerfile should (in this order)... - -1. Put any custom SAML files into `/tmp/ssp-overrides`. -2. Run the `/tmp/install-deps-and-ssp-overrides.sh`, since it will move the SAML - files into the SimpleSAMLphp folders within the `vendor` folder after - installing composer dependencies. +Your Dockerfile should also run `/tmp/install-deps-and-ssp-overrides.sh`, since +that is what installs the necessary composer dependencies. ### Example Dockerfile using this as the FROM ### - # Change 4.1.6 to the latest tagged version or whichever you want to have - FROM silintl/developer-portal:4.1.6 - - ENV REFRESHED_AT 2021-04-08 - - # Put in place any additional custom SAML files: - COPY build/ssp-overrides /tmp/ssp-overrides + # Change 5.0.0 to the latest tagged version or whichever you want to have + FROM silintl/developer-portal:5.0.0 - # Put dependencies and SSP overrides in their final location + # Install dependencies RUN /tmp/install-deps-and-ssp-overrides.sh # Copy in any custom files needed, which are stored in this repo. diff --git a/action-services.yml b/action-services.yml index e4a0fbb7..0dd329e7 100644 --- a/action-services.yml +++ b/action-services.yml @@ -56,8 +56,4 @@ services: APIAXLE_SECRET: developer-portal-dev-secret APIAXLE_SSL_VERIFYPEER: 'false' GOOGLE_OAUTH_ENABLED: 'false' - SAML_ENTITY_ID: http://developer-portal.local/simplesaml/module.php/saml/sp/metadata.php/default-sp - SAML_ADMIN_PASSWORD: dummy-for-tests-q6.eYWtfLF-BTQXf-OktD5lVFCOFyC4B - SAML_SECRET_SALT: dummy-for-tests-Ac4MTgO9UJ6_wpXXKc6EGU_.gWNNkdMe - SAML_IDP: NONE working_dir: /data diff --git a/application/composer.json b/application/composer.json index cbdca64c..62911ea6 100644 --- a/application/composer.json +++ b/application/composer.json @@ -19,10 +19,5 @@ "phake/phake": "^3.1", "phpunit/phpunit": "^9.0", "roave/security-advisories": "dev-master" - }, - "config": { - "allow-plugins": { - "simplesamlphp/composer-module-installer": true - } } } diff --git a/application/run-tests.sh b/application/run-tests.sh index d325da1e..f64c9a08 100755 --- a/application/run-tests.sh +++ b/application/run-tests.sh @@ -7,11 +7,6 @@ cd /data echo "Installing dev dependencies..." runny composer install --no-scripts --no-interaction -mkdir -p -v /data/vendor/simplesamlphp/simplesamlphp/cert -cp /tmp/ssp-overrides/cert/* /data/vendor/simplesamlphp/simplesamlphp/cert -cp /tmp/ssp-overrides/config/* /data/vendor/simplesamlphp/simplesamlphp/config -cp /tmp/ssp-overrides/metadata/* /data/vendor/simplesamlphp/simplesamlphp/metadata - # Run database migrations echo -e "Waiting for db to run migrations...\n\n" START=`date +%s` diff --git a/build/install-deps-and-ssp-overrides.sh b/build/install-deps-and-ssp-overrides.sh index 552a30b7..8975a735 100644 --- a/build/install-deps-and-ssp-overrides.sh +++ b/build/install-deps-and-ssp-overrides.sh @@ -6,9 +6,5 @@ set -e cd /data composer install --no-dev --no-progress --no-scripts --optimize-autoloader --no-interaction -# Copy the SSP override files into place -mkdir -p -v /data/vendor/simplesamlphp/simplesamlphp/cert -find /tmp/ssp-overrides/ -path '/tmp/ssp-overrides/cert/*' -exec cp {} /data/vendor/simplesamlphp/simplesamlphp/cert \; -cp /tmp/ssp-overrides/config/* /data/vendor/simplesamlphp/simplesamlphp/config -cp /tmp/ssp-overrides/metadata/* /data/vendor/simplesamlphp/simplesamlphp/metadata -rm -rf /tmp/ssp-overrides +# Note: Copying the SSP override files into place is no longer relevant, since +# we no longer support SAML as a login option for the Developer Portal. diff --git a/build/ssp-overrides/config/authsources.php b/build/ssp-overrides/config/authsources.php deleted file mode 100644 index 5e4e658f..00000000 --- a/build/ssp-overrides/config/authsources.php +++ /dev/null @@ -1,59 +0,0 @@ - array( - // The default is to use core:AdminPassword, but it can be replaced with - // any authentication source. - - 'core:AdminPassword', - ), - - - // An authentication source which can authenticate against both SAML 2.0 - // and Shibboleth 1.3 IdPs. - 'default-sp' => array( - 'saml:SP', - - // The entity ID of this SP. - // Can be NULL/unset, in which case an entity ID is generated based on the metadata URL. - 'entityID' => $ENTITY_ID, - - // The entity ID of the IdP this should SP should contact. - // Can be NULL/unset, in which case the user will be shown a list of available IdPs. - 'idp' => $IDP, - - // The URL to the discovery service. - // Can be NULL/unset, in which case a builtin discovery service will be used. - 'discoURL' => null, - - /* - * WARNING: SHA-1 is disallowed starting January the 1st, 2014. - * - * Uncomment the following option to start using SHA-256 for your signatures. - * Currently, SimpleSAMLphp defaults to SHA-1, which has been deprecated since - * 2011, and will be disallowed by NIST as of 2014. Please refer to the following - * document for more information: - * - * http://csrc.nist.gov/publications/nistpubs/800-131A/sp800-131A.pdf - * - * If you are uncertain about identity providers supporting SHA-256 or other - * algorithms of the SHA-2 family, you can configure it individually in the - * IdP-remote metadata set for those that support it. Once you are certain that - * all your configured IdPs support SHA-2, you can safely remove the configuration - * options in the IdP-remote metadata set and uncomment the following option. - * - * Please refer to the hosted SP configuration reference for more information. - */ - //'signature.algorithm' => 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256', - - // Certificate / key for signing and decrypting. - 'privatekey' => 'saml.pem', - 'certificate' => 'saml.crt', - ), - -); diff --git a/build/ssp-overrides/config/config.php b/build/ssp-overrides/config/config.php deleted file mode 100644 index 7870392c..00000000 --- a/build/ssp-overrides/config/config.php +++ /dev/null @@ -1,1223 +0,0 @@ - $BASE_URL, - - /* - * The 'application' configuration array groups a set configuration options - * relative to an application protected by SimpleSAMLphp. - */ - //'application' => [ - /* - * The 'baseURL' configuration option allows you to specify a protocol, - * host and optionally a port that serves as the canonical base for all - * your application's URLs. This is useful when the environment - * observed in the server differs from the one observed by end users, - * for example, when using a load balancer to offload TLS. - * - * Note that this configuration option does not allow setting a path as - * part of the URL. If your setup involves URL rewriting or any other - * tricks that would result in SimpleSAMLphp observing a URL for your - * application's scripts different than the canonical one, you will - * need to compute the right URLs yourself and pass them dynamically - * to SimpleSAMLphp's API. - */ - //'baseURL' => 'https://example.com', - //], - - /* - * The following settings are *filesystem paths* which define where - * SimpleSAMLphp can find or write the following things: - * - 'certdir': The base directory for certificate and key material. - * - 'loggingdir': Where to write logs. - * - 'datadir': Storage of general data. - * - 'tempdir': Saving temporary files. SimpleSAMLphp will attempt to create - * this directory if it doesn't exist. - * When specified as a relative path, this is relative to the SimpleSAMLphp - * root directory. - */ - 'certdir' => 'cert/', - 'loggingdir' => 'log/', - 'datadir' => 'data/', - 'tempdir' => '/tmp/simplesaml', - - /* - * Some information about the technical persons running this installation. - * The email address will be used as the recipient address for error reports, and - * also as the technical contact in generated metadata. - */ - 'technicalcontact_name' => $CONTACT_NAME, - 'technicalcontact_email' => $CONTACT_EMAIL, - - /* - * (Optional) The method by which email is delivered. Defaults to mail which utilizes the - * PHP mail() function. - * - * Valid options are: mail, sendmail and smtp. - */ - //'mail.transport.method' => 'smtp', - - /* - * Set the transport options for the transport method specified. The valid settings are relative to the - * selected transport method. - */ - // // smtp mail transport options - // 'mail.transport.options' => [ - // 'host' => 'mail.example.org', // required - // 'port' => 25, // optional - // 'username' => 'user@example.org', // optional: if set, enables smtp authentication - // 'password' => 'password', // optional: if set, enables smtp authentication - // 'security' => 'tls', // optional: defaults to no smtp security - // ], - // // sendmail mail transport options - // 'mail.transport.options' => [ - // 'path' => '/usr/sbin/sendmail' // optional: defaults to php.ini path - // ], - - /* - * The envelope from address for outgoing emails. - * This should be in a domain that has your application's IP addresses in its SPF record - * to prevent it from being rejected by mail filters. - */ - //'sendmail_from' => 'no-reply@example.org', - - /* - * The timezone of the server. This option should be set to the timezone you want - * SimpleSAMLphp to report the time in. The default is to guess the timezone based - * on your system timezone. - * - * See this page for a list of valid timezones: http://php.net/manual/en/timezones.php - */ - 'timezone' => 'America/New_York', - - - - /********************************** - | SECURITY CONFIGURATION OPTIONS | - **********************************/ - - /* - * This is a secret salt used by SimpleSAMLphp when it needs to generate a secure hash - * of a value. It must be changed from its default value to a secret value. The value of - * 'secretsalt' can be any valid string of any length. - * - * A possible way to generate a random salt is by running the following command from a unix shell: - * tr -c -d '0123456789abcdefghijklmnopqrstuvwxyz' /dev/null;echo - */ - 'secretsalt' => $SECRET_SALT, - - /* - * This password must be kept secret, and modified from the default value 123. - * This password will give access to the installation page of SimpleSAMLphp with - * metadata listing and diagnostics pages. - * You can also put a hash here; run "bin/pwgen.php" to generate one. - */ - 'auth.adminpassword' => $ADMIN_PASSWORD, - - /* - * Set this options to true if you want to require administrator password to access the web interface - * or the metadata pages, respectively. - */ - 'admin.protectindexpage' => true, - 'admin.protectmetadata' => true, - - /* - * Set this option to false if you don't want SimpleSAMLphp to check for new stable releases when - * visiting the configuration tab in the web interface. - */ - 'admin.checkforupdates' => true, - - /* - * Array of domains that are allowed when generating links or redirects - * to URLs. SimpleSAMLphp will use this option to determine whether to - * to consider a given URL valid or not, but you should always validate - * URLs obtained from the input on your own (i.e. ReturnTo or RelayState - * parameters obtained from the $_REQUEST array). - * - * SimpleSAMLphp will automatically add your own domain (either by checking - * it dynamically, or by using the domain defined in the 'baseurlpath' - * directive, the latter having precedence) to the list of trusted domains, - * in case this option is NOT set to NULL. In that case, you are explicitly - * telling SimpleSAMLphp to verify URLs. - * - * Set to an empty array to disallow ALL redirects or links pointing to - * an external URL other than your own domain. This is the default behaviour. - * - * Set to NULL to disable checking of URLs. DO NOT DO THIS UNLESS YOU KNOW - * WHAT YOU ARE DOING! - * - * Example: - * 'trusted.url.domains' => ['sp.example.com', 'app.example.com'], - */ - 'trusted.url.domains' => [], - - /* - * Enable regular expression matching of trusted.url.domains. - * - * Set to true to treat the values in trusted.url.domains as regular - * expressions. Set to false to do exact string matching. - * - * If enabled, the start and end delimiters ('^' and '$') will be added to - * all regular expressions in trusted.url.domains. - */ - 'trusted.url.regex' => false, - - /* - * Enable secure POST from HTTPS to HTTP. - * - * If you have some SP's on HTTP and IdP is normally on HTTPS, this option - * enables secure POSTing to HTTP endpoint without warning from browser. - * - * For this to work, module.php/core/postredirect.php must be accessible - * also via HTTP on IdP, e.g. if your IdP is on - * https://idp.example.org/ssp/, then - * http://idp.example.org/ssp/module.php/core/postredirect.php must be accessible. - */ - 'enable.http_post' => false, - - /* - * Set the allowed clock skew between encrypting/decrypting assertions - * - * If you have an server that is constantly out of sync, this option - * allows you to adjust the allowed clock-skew. - * - * Allowed range: 180 - 300 - * Defaults to 180. - */ - 'assertion.allowed_clock_skew' => 180, - - - /************************ - | ERRORS AND DEBUGGING | - ************************/ - - /* - * The 'debug' option allows you to control how SimpleSAMLphp behaves in certain - * situations where further action may be taken - * - * It can be left unset, in which case, debugging is switched off for all actions. - * If set, it MUST be an array containing the actions that you want to enable, or - * alternatively a hashed array where the keys are the actions and their - * corresponding values are booleans enabling or disabling each particular action. - * - * SimpleSAMLphp provides some pre-defined actiones, though modules could add new - * actions here. Refer to the documentation of every module to learn if they - * allow you to set any more debugging actions. - * - * The pre-defined actions are: - * - * - 'saml': this action controls the logging of SAML messages exchanged with other - * entities. When enabled ('saml' is present in this option, or set to true), all - * SAML messages will be logged, including plaintext versions of encrypted - * messages. - * - * - 'backtraces': this action controls the logging of error backtraces. If you - * want to log backtraces so that you can debug any possible errors happening in - * SimpleSAMLphp, enable this action (add it to the array or set it to true). - * - * - 'validatexml': this action allows you to validate SAML documents against all - * the relevant XML schemas. SAML 1.1 messages or SAML metadata parsed with - * the XML to SimpleSAMLphp metadata converter or the metaedit module will - * validate the SAML documents if this option is enabled. - * - * If you want to disable debugging completely, unset this option or set it to an - * empty array. - */ - 'debug' => [ - 'saml' => false, - 'backtraces' => true, - 'validatexml' => false, - ], - - /* - * When 'showerrors' is enabled, all error messages and stack traces will be output - * to the browser. - * - * When 'errorreporting' is enabled, a form will be presented for the user to report - * the error to 'technicalcontact_email'. - */ - 'showerrors' => $SHOW_ERRORS , - 'errorreporting' => true, - - /* - * Custom error show function called from SimpleSAML\Error\Error::show. - * See docs/simplesamlphp-errorhandling.txt for function code example. - * - * Example: - * 'errors.show_function' => ['SimpleSAML\Module\example\Error', 'show'], - */ - - - - /************************** - | LOGGING AND STATISTICS | - **************************/ - - /* - * Define the minimum log level to log. Available levels: - * - SimpleSAML\Logger::ERR No statistics, only errors - * - SimpleSAML\Logger::WARNING No statistics, only warnings/errors - * - SimpleSAML\Logger::NOTICE Statistics and errors - * - SimpleSAML\Logger::INFO Verbose logs - * - SimpleSAML\Logger::DEBUG Full debug logs - not recommended for production - * - * Choose logging handler. - * - * Options: [syslog,file,errorlog,stderr] - * - */ - 'logging.level' => SimpleSAML\Logger::NOTICE, - 'logging.handler' => 'stderr', - - /* - * Specify the format of the logs. Its use varies depending on the log handler used (for instance, you cannot - * control here how dates are displayed when using the syslog or errorlog handlers), but in general the options - * are: - * - * - %date{}: the date and time, with its format specified inside the brackets. See the PHP documentation - * of the strftime() function for more information on the format. If the brackets are omitted, the standard - * format is applied. This can be useful if you just want to control the placement of the date, but don't care - * about the format. - * - * - %process: the name of the SimpleSAMLphp process. Remember you can configure this in the 'logging.processname' - * option below. - * - * - %level: the log level (name or number depending on the handler used). - * - * - %stat: if the log entry is intended for statistical purposes, it will print the string 'STAT ' (bear in mind - * the trailing space). - * - * - %trackid: the track ID, an identifier that allows you to track a single session. - * - * - %srcip: the IP address of the client. If you are behind a proxy, make sure to modify the - * $_SERVER['REMOTE_ADDR'] variable on your code accordingly to the X-Forwarded-For header. - * - * - %msg: the message to be logged. - * - */ - //'logging.format' => '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg', - - /* - * Choose which facility should be used when logging with syslog. - * - * These can be used for filtering the syslog output from SimpleSAMLphp into its - * own file by configuring the syslog daemon. - * - * See the documentation for openlog (http://php.net/manual/en/function.openlog.php) for available - * facilities. Note that only LOG_USER is valid on windows. - * - * The default is to use LOG_LOCAL5 if available, and fall back to LOG_USER if not. - */ - 'logging.facility' => defined('LOG_LOCAL5') ? constant('LOG_LOCAL5') : LOG_USER, - - /* - * The process name that should be used when logging to syslog. - * The value is also written out by the other logging handlers. - */ - 'logging.processname' => 'simplesamlphp', - - /* - * Logging: file - Logfilename in the loggingdir from above. - */ - 'logging.logfile' => 'simplesamlphp.log', - - /* - * This is an array of outputs. Each output has at least a 'class' option, which - * selects the output. - */ - 'statistics.out' => [// Log statistics to the normal log. - /* - [ - 'class' => 'core:Log', - 'level' => 'notice', - ], - */ - // Log statistics to files in a directory. One file per day. - /* - [ - 'class' => 'core:File', - 'directory' => '/var/log/stats', - ], - */ - ], - - - - /*********************** - | PROXY CONFIGURATION | - ***********************/ - - /* - * Proxy to use for retrieving URLs. - * - * Example: - * 'proxy' => 'tcp://proxy.example.com:5100' - */ - 'proxy' => null, - - /* - * Username/password authentication to proxy (Proxy-Authorization: Basic) - * Example: - * 'proxy.auth' = 'myuser:password' - */ - //'proxy.auth' => 'myuser:password', - - - - /************************** - | DATABASE CONFIGURATION | - **************************/ - - /* - * This database configuration is optional. If you are not using - * core functionality or modules that require a database, you can - * skip this configuration. - */ - - /* - * Database connection string. - * Ensure that you have the required PDO database driver installed - * for your connection string. - */ - 'database.dsn' => 'mysql:host=localhost;dbname=saml', - - /* - * SQL database credentials - */ - 'database.username' => 'simplesamlphp', - 'database.password' => 'secret', - 'database.options' => [], - - /* - * (Optional) Table prefix - */ - 'database.prefix' => '', - - /* - * (Optional) Driver options - */ - 'database.driver_options' => [], - - /* - * True or false if you would like a persistent database connection - */ - 'database.persistent' => false, - - /* - * Database slave configuration is optional as well. If you are only - * running a single database server, leave this blank. If you have - * a master/slave configuration, you can define as many slave servers - * as you want here. Slaves will be picked at random to be queried from. - * - * Configuration options in the slave array are exactly the same as the - * options for the master (shown above) with the exception of the table - * prefix and driver options. - */ - 'database.slaves' => [ - /* - [ - 'dsn' => 'mysql:host=myslave;dbname=saml', - 'username' => 'simplesamlphp', - 'password' => 'secret', - 'persistent' => false, - ], - */ - ], - - - - /************* - | PROTOCOLS | - *************/ - - /* - * Which functionality in SimpleSAMLphp do you want to enable. Normally you would enable only - * one of the functionalities below, but in some cases you could run multiple functionalities. - * In example when you are setting up a federation bridge. - */ - 'enable.saml20-idp' => false, - 'enable.shib13-idp' => false, - 'enable.adfs-idp' => false, - - /* - * Whether SimpleSAMLphp should sign the response or the assertion in SAML 1.1 authentication - * responses. - * - * The default is to sign the assertion element, but that can be overridden by setting this - * option to TRUE. It can also be overridden on a pr. SP basis by adding an option with the - * same name to the metadata of the SP. - */ - 'shib13.signresponse' => true, - - - - /*********** - | MODULES | - ***********/ - - /* - * Configuration to override module enabling/disabling. - * - * Example: - * - * 'module.enable' => [ - * 'exampleauth' => true, // Setting to TRUE enables. - * 'consent' => false, // Setting to FALSE disables. - * 'core' => null, // Unset or NULL uses default. - * ], - * - */ - - - - /************************* - | SESSION CONFIGURATION | - *************************/ - - /* - * This value is the duration of the session in seconds. Make sure that the time duration of - * cookies both at the SP and the IdP exceeds this duration. - */ - 'session.duration' => 8 * (60 * 60), // 8 hours. - - /* - * Sets the duration, in seconds, data should be stored in the datastore. As the data store is used for - * login and logout requests, this option will control the maximum time these operations can take. - * The default is 4 hours (4*60*60) seconds, which should be more than enough for these operations. - */ - 'session.datastore.timeout' => (4 * 60 * 60), // 4 hours - - /* - * Sets the duration, in seconds, auth state should be stored. - */ - 'session.state.timeout' => (60 * 60), // 1 hour - - /* - * Option to override the default settings for the session cookie name - */ - 'session.cookie.name' => 'SimpleSAMLSessionID', - - /* - * Expiration time for the session cookie, in seconds. - * - * Defaults to 0, which means that the cookie expires when the browser is closed. - * - * Example: - * 'session.cookie.lifetime' => 30*60, - */ - 'session.cookie.lifetime' => 0, - - /* - * Limit the path of the cookies. - * - * Can be used to limit the path of the cookies to a specific subdirectory. - * - * Example: - * 'session.cookie.path' => '/simplesaml/', - */ - 'session.cookie.path' => '/', - - /* - * Cookie domain. - * - * Can be used to make the session cookie available to several domains. - * - * Example: - * 'session.cookie.domain' => '.example.org', - */ - 'session.cookie.domain' => null, - - /* - * Set the secure flag in the cookie. - * - * Set this to TRUE if the user only accesses your service - * through https. If the user can access the service through - * both http and https, this must be set to FALSE. - */ - 'session.cookie.secure' => false, - - /* - * Set the SameSite attribute in the cookie. - * - * You can set this to the strings 'None', 'Lax', or 'Strict' to support - * the RFC6265bis SameSite cookie attribute. If set to null, no SameSite - * attribute will be sent. - * - * Example: - * 'session.cookie.samesite' => 'None', - */ - 'session.cookie.samesite' => null, - - /* - * Options to override the default settings for php sessions. - */ - 'session.phpsession.cookiename' => 'SimpleSAML', - 'session.phpsession.savepath' => null, - 'session.phpsession.httponly' => true, - - /* - * Option to override the default settings for the auth token cookie - */ - 'session.authtoken.cookiename' => 'SimpleSAMLAuthToken', - - /* - * Options for remember me feature for IdP sessions. Remember me feature - * has to be also implemented in authentication source used. - * - * Option 'session.cookie.lifetime' should be set to zero (0), i.e. cookie - * expires on browser session if remember me is not checked. - * - * Session duration ('session.duration' option) should be set according to - * 'session.rememberme.lifetime' option. - * - * It's advised to use remember me feature with session checking function - * defined with 'session.check_function' option. - */ - 'session.rememberme.enable' => false, - 'session.rememberme.checked' => false, - 'session.rememberme.lifetime' => (14 * 86400), - - /* - * Custom function for session checking called on session init and loading. - * See docs/simplesamlphp-advancedfeatures.txt for function code example. - * - * Example: - * 'session.check_function' => ['\SimpleSAML\Module\example\Util', 'checkSession'], - */ - - - - /************************** - | MEMCACHE CONFIGURATION | - **************************/ - - /* - * Configuration for the 'memcache' session store. This allows you to store - * multiple redundant copies of sessions on different memcache servers. - * - * 'memcache_store.servers' is an array of server groups. Every data - * item will be mirrored in every server group. - * - * Each server group is an array of servers. The data items will be - * load-balanced between all servers in each server group. - * - * Each server is an array of parameters for the server. The following - * options are available: - * - 'hostname': This is the hostname or ip address where the - * memcache server runs. This is the only required option. - * - 'port': This is the port number of the memcache server. If this - * option isn't set, then we will use the 'memcache.default_port' - * ini setting. This is 11211 by default. - * - * When using the "memcache" extension, the following options are also - * supported: - * - 'weight': This sets the weight of this server in this server - * group. http://php.net/manual/en/function.Memcache-addServer.php - * contains more information about the weight option. - * - 'timeout': The timeout for this server. By default, the timeout - * is 3 seconds. - * - * Example of redundant configuration with load balancing: - * This configuration makes it possible to lose both servers in the - * a-group or both servers in the b-group without losing any sessions. - * Note that sessions will be lost if one server is lost from both the - * a-group and the b-group. - * - * 'memcache_store.servers' => [ - * [ - * ['hostname' => 'mc_a1'], - * ['hostname' => 'mc_a2'], - * ], - * [ - * ['hostname' => 'mc_b1'], - * ['hostname' => 'mc_b2'], - * ], - * ], - * - * Example of simple configuration with only one memcache server, - * running on the same computer as the web server: - * Note that all sessions will be lost if the memcache server crashes. - * - * 'memcache_store.servers' => [ - * [ - * ['hostname' => 'localhost'], - * ], - * ], - * - * Additionally, when using the "memcached" extension, unique keys must - * be provided for each group of servers if persistent connections are - * desired. Each server group can also have an "options" indexed array - * with the options desired for the given group: - * - * 'memcache_store.servers' => [ - * 'memcache_group_1' => [ - * 'options' => [ - * \Memcached::OPT_BINARY_PROTOCOL => true, - * \Memcached::OPT_NO_BLOCK => true, - * \Memcached::OPT_TCP_NODELAY => true, - * \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, - * ], - * ['hostname' => '127.0.0.1', 'port' => 11211], - * ['hostname' => '127.0.0.2', 'port' => 11211], - * ], - * - * 'memcache_group_2' => [ - * 'options' => [ - * \Memcached::OPT_BINARY_PROTOCOL => true, - * \Memcached::OPT_NO_BLOCK => true, - * \Memcached::OPT_TCP_NODELAY => true, - * \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, - * ], - * ['hostname' => '127.0.0.3', 'port' => 11211], - * ['hostname' => '127.0.0.4', 'port' => 11211], - * ], - * ], - * - */ - 'memcache_store.servers' => [ - [ - ['hostname' => 'localhost'], - ], - ], - - /* - * This value allows you to set a prefix for memcache-keys. The default - * for this value is 'simpleSAMLphp', which is fine in most cases. - * - * When running multiple instances of SSP on the same host, and more - * than one instance is using memcache, you probably want to assign - * a unique value per instance to this setting to avoid data collision. - */ - 'memcache_store.prefix' => '', - - /* - * This value is the duration data should be stored in memcache. Data - * will be dropped from the memcache servers when this time expires. - * The time will be reset every time the data is written to the - * memcache servers. - * - * This value should always be larger than the 'session.duration' - * option. Not doing this may result in the session being deleted from - * the memcache servers while it is still in use. - * - * Set this value to 0 if you don't want data to expire. - * - * Note: The oldest data will always be deleted if the memcache server - * runs out of storage space. - */ - 'memcache_store.expires' => 36 * (60 * 60), // 36 hours. - - - - /************************************* - | LANGUAGE AND INTERNATIONALIZATION | - *************************************/ - - /* - * Language-related options. - */ - 'language' => [ - /* - * An array in the form 'language' => . - * - * Each key in the array is the ISO 639 two-letter code for a language, - * and its value is an array with a list of alternative languages that - * can be used if the given language is not available at some point. - * Each alternative language is also specified by its ISO 639 code. - * - * For example, for the "no" language code (Norwegian), we would have: - * - * 'priorities' => [ - * 'no' => ['nb', 'nn', 'en', 'se'], - * ... - * ], - * - * establishing that if a translation for the "no" language code is - * not available, we look for translations in "nb" (Norwegian Bokmål), - * and so on, in that order. - */ - 'priorities' => [ - 'no' => ['nb', 'nn', 'en', 'se'], - 'nb' => ['no', 'nn', 'en', 'se'], - 'nn' => ['no', 'nb', 'en', 'se'], - 'se' => ['nb', 'no', 'nn', 'en'], - 'nr' => ['zu', 'en'], - 'nd' => ['zu', 'en'], - ], - ], - - /* - * Languages available, RTL languages, and what language is the default. - */ - 'language.available' => [ - 'en', 'no', 'nn', 'se', 'da', 'de', 'sv', 'fi', 'es', 'ca', 'fr', 'it', 'nl', 'lb', - 'cs', 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt-br', 'tr', 'ja', 'zh', 'zh-tw', 'ru', - 'et', 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af', 'zu', 'xh', - ], - 'language.rtl' => ['ar', 'dv', 'fa', 'ur', 'he'], - 'language.default' => 'en', - - /* - * Options to override the default settings for the language parameter - */ - 'language.parameter.name' => 'language', - 'language.parameter.setcookie' => true, - - /* - * Options to override the default settings for the language cookie - */ - 'language.cookie.name' => 'language', - 'language.cookie.domain' => null, - 'language.cookie.path' => '/', - 'language.cookie.secure' => false, - 'language.cookie.httponly' => false, - 'language.cookie.lifetime' => (60 * 60 * 24 * 900), - 'language.cookie.samesite' => null, - - /** - * Custom getLanguage function called from SimpleSAML\Locale\Language::getLanguage(). - * Function should return language code of one of the available languages or NULL. - * See SimpleSAML\Locale\Language::getLanguage() source code for more info. - * - * This option can be used to implement a custom function for determining - * the default language for the user. - * - * Example: - * 'language.get_language_function' => ['\SimpleSAML\Module\example\Template', 'getLanguage'], - */ - - /* - * Extra dictionary for attribute names. - * This can be used to define local attributes. - * - * The format of the parameter is a string with :. - * - * Specifying this option will cause us to look for modules//dictionaries/.definition.json - * The dictionary should look something like: - * - * { - * "firstattribute": { - * "en": "English name", - * "no": "Norwegian name" - * }, - * "secondattribute": { - * "en": "English name", - * "no": "Norwegian name" - * } - * } - * - * Note that all attribute names in the dictionary must in lowercase. - * - * Example: 'attributes.extradictionary' => 'ourmodule:ourattributes', - */ - 'attributes.extradictionary' => null, - - - - /************** - | APPEARANCE | - **************/ - - /* - * Which theme directory should be used? - */ - 'theme.use' => 'default', - - /* - * Set this option to the text you would like to appear at the header of each page. Set to false if you don't want - * any text to appear in the header. - */ - //'theme.header' => 'SimpleSAMLphp' - - /** - * A template controller, if any. - * - * Used to intercept certain parts of the template handling, while keeping away unwanted/unexpected hooks. Set - * the 'theme.controller' configuration option to a class that implements the - * \SimpleSAML\XHTML\TemplateControllerInterface interface to use it. - */ - //'theme.controller' => '', - - /* - * Templating options - * - * By default, twig templates are not cached. To turn on template caching: - * Set 'template.cache' to an absolute path pointing to a directory that - * SimpleSAMLphp has read and write permissions to. - */ - //'template.cache' => '', - - /* - * Set the 'template.auto_reload' to true if you would like SimpleSAMLphp to - * recompile the templates (when using the template cache) if the templates - * change. If you don't want to check the source templates for every request, - * set it to false. - */ - 'template.auto_reload' => false, - - /* - * Set this option to true to indicate that your installation of SimpleSAMLphp - * is running in a production environment. This will affect the way resources - * are used, offering an optimized version when running in production, and an - * easy-to-debug one when not. Set it to false when you are testing or - * developing the software, in which case a banner will be displayed to remind - * users that they're dealing with a non-production instance. - * - * Defaults to true. - */ - 'production' => true, - - /* - * SimpleSAMLphp modules can host static resources which are served through PHP. - * The serving of the resources can be configured through these settings. - */ - 'assets' => [ - /* - * These settings adjust the caching headers that are sent - * when serving static resources. - */ - 'caching' => [ - /* - * Amount of seconds before the resource should be fetched again - */ - 'max_age' => 86400, - /* - * Calculate a checksum of every file and send it to the browser - * This allows the browser to avoid downloading assets again in situations - * where the Last-Modified header cannot be trusted, - * for example in cluster setups - * - * Defaults false - */ - 'etag' => false, - ], - ], - - - /********************* - | DISCOVERY SERVICE | - *********************/ - - /* - * Whether the discovery service should allow the user to save his choice of IdP. - */ - 'idpdisco.enableremember' => true, - 'idpdisco.rememberchecked' => true, - - /* - * The disco service only accepts entities it knows. - */ - 'idpdisco.validate' => true, - - 'idpdisco.extDiscoveryStorage' => null, - - /* - * IdP Discovery service look configuration. - * Wether to display a list of idp or to display a dropdown box. For many IdP' a dropdown box - * gives the best use experience. - * - * When using dropdown box a cookie is used to highlight the previously chosen IdP in the dropdown. - * This makes it easier for the user to choose the IdP - * - * Options: [links,dropdown] - */ - 'idpdisco.layout' => 'dropdown', - - - - /************************************* - | AUTHENTICATION PROCESSING FILTERS | - *************************************/ - - /* - * Authentication processing filters that will be executed for all IdPs - * Both Shibboleth and SAML 2.0 - */ - 'authproc.idp' => [ - /* Enable the authproc filter below to add URN prefixes to all attributes - 10 => array[ - 'class' => 'core:AttributeMap', 'addurnprefix' - ], - */ - /* Enable the authproc filter below to automatically generated eduPersonTargetedID. - 20 => 'core:TargetedID', - */ - - // Adopts language from attribute to use in UI - 30 => 'core:LanguageAdaptor', - - 45 => [ - 'class' => 'core:StatisticsWithAttribute', - 'attributename' => 'realm', - 'type' => 'saml20-idp-SSO', - ], - - /* When called without parameters, it will fallback to filter attributes ‹the old way› - * by checking the 'attributes' parameter in metadata on IdP hosted and SP remote. - */ - 50 => 'core:AttributeLimit', - - /* - * Search attribute "distinguishedName" for pattern and replaces if found - */ - /* - 60 => [ - 'class' => 'core:AttributeAlter', - 'pattern' => '/OU=studerende/', - 'replacement' => 'Student', - 'subject' => 'distinguishedName', - '%replace', - ], - */ - - /* - * Consent module is enabled (with no permanent storage, using cookies). - */ - /* - 90 => [ - 'class' => 'consent:Consent', - 'store' => 'consent:Cookie', - 'focus' => 'yes', - 'checked' => true - ], - */ - // If language is set in Consent module it will be added as an attribute. - 99 => 'core:LanguageAdaptor', - ], - - /* - * Authentication processing filters that will be executed for all SPs - * Both Shibboleth and SAML 2.0 - */ - 'authproc.sp' => [ - /* - 10 => [ - 'class' => 'core:AttributeMap', 'removeurnprefix' - ], - */ - - /* - * Generate the 'group' attribute populated from other variables, including eduPersonAffiliation. - 60 => [ - 'class' => 'core:GenerateGroups', 'eduPersonAffiliation' - ], - */ - /* - * All users will be members of 'users' and 'members' - */ - /* - 61 => [ - 'class' => 'core:AttributeAdd', 'groups' => ['users', 'members'] - ], - */ - - // Adopts language from attribute to use in UI - 90 => 'core:LanguageAdaptor', - ], - - - - /************************** - | METADATA CONFIGURATION | - **************************/ - - /* - * This option allows you to specify a directory for your metadata outside of the standard metadata directory - * included in the standard distribution of the software. - */ - 'metadatadir' => 'metadata', - - /* - * This option configures the metadata sources. The metadata sources is given as an array with - * different metadata sources. When searching for metadata, SimpleSAMLphp will search through - * the array from start to end. - * - * Each element in the array is an associative array which configures the metadata source. - * The type of the metadata source is given by the 'type' element. For each type we have - * different configuration options. - * - * Flat file metadata handler: - * - 'type': This is always 'flatfile'. - * - 'directory': The directory we will load the metadata files from. The default value for - * this option is the value of the 'metadatadir' configuration option, or - * 'metadata/' if that option is unset. - * - * XML metadata handler: - * This metadata handler parses an XML file with either an EntityDescriptor element or an - * EntitiesDescriptor element. The XML file may be stored locally, or (for debugging) on a remote - * web server. - * The XML metadata handler defines the following options: - * - 'type': This is always 'xml'. - * - 'file': Path to the XML file with the metadata. - * - 'url': The URL to fetch metadata from. THIS IS ONLY FOR DEBUGGING - THERE IS NO CACHING OF THE RESPONSE. - * - * MDQ metadata handler: - * This metadata handler looks up for the metadata of an entity at the given MDQ server. - * The MDQ metadata handler defines the following options: - * - 'type': This is always 'mdq'. - * - 'server': Base URL of the MDQ server. Mandatory. - * - 'validateFingerprint': The fingerprint of the certificate used to sign the metadata. You don't need this - * option if you don't want to validate the signature on the metadata. Optional. - * - 'cachedir': Directory where metadata can be cached. Optional. - * - 'cachelength': Maximum time metadata can be cached, in seconds. Defaults to 24 - * hours (86400 seconds). Optional. - * - * PDO metadata handler: - * This metadata handler looks up metadata of an entity stored in a database. - * - * Note: If you are using the PDO metadata handler, you must configure the database - * options in this configuration file. - * - * The PDO metadata handler defines the following options: - * - 'type': This is always 'pdo'. - * - * Examples: - * - * This example defines two flatfile sources. One is the default metadata directory, the other - * is a metadata directory with auto-generated metadata files. - * - * 'metadata.sources' => [ - * ['type' => 'flatfile'], - * ['type' => 'flatfile', 'directory' => 'metadata-generated'], - * ], - * - * This example defines a flatfile source and an XML source. - * 'metadata.sources' => [ - * ['type' => 'flatfile'], - * ['type' => 'xml', 'file' => 'idp.example.org-idpMeta.xml'], - * ], - * - * This example defines an mdq source. - * 'metadata.sources' => [ - * [ - * 'type' => 'mdq', - * 'server' => 'http://mdq.server.com:8080', - * 'cachedir' => '/var/simplesamlphp/mdq-cache', - * 'cachelength' => 86400 - * ] - * ], - * - * This example defines an pdo source. - * 'metadata.sources' => [ - * ['type' => 'pdo'] - * ], - * - * Default: - * 'metadata.sources' => [ - * ['type' => 'flatfile'] - * ], - */ - 'metadata.sources' => [ - ['type' => 'flatfile'], - ], - - /* - * Should signing of generated metadata be enabled by default. - * - * Metadata signing can also be enabled for a individual SP or IdP by setting the - * same option in the metadata for the SP or IdP. - */ - 'metadata.sign.enable' => false, - - /* - * The default key & certificate which should be used to sign generated metadata. These - * are files stored in the cert dir. - * These values can be overridden by the options with the same names in the SP or - * IdP metadata. - * - * If these aren't specified here or in the metadata for the SP or IdP, then - * the 'certificate' and 'privatekey' option in the metadata will be used. - * if those aren't set, signing of metadata will fail. - */ - 'metadata.sign.privatekey' => null, - 'metadata.sign.privatekey_pass' => null, - 'metadata.sign.certificate' => null, - 'metadata.sign.algorithm' => null, - - - /**************************** - | DATA STORE CONFIGURATION | - ****************************/ - - /* - * Configure the data store for SimpleSAMLphp. - * - * - 'phpsession': Limited datastore, which uses the PHP session. - * - 'memcache': Key-value datastore, based on memcache. - * - 'sql': SQL datastore, using PDO. - * - 'redis': Key-value datastore, based on redis. - * - * The default datastore is 'phpsession'. - */ - 'store.type' => 'phpsession', - - /* - * The DSN the sql datastore should connect to. - * - * See http://www.php.net/manual/en/pdo.drivers.php for the various - * syntaxes. - */ - 'store.sql.dsn' => 'sqlite:/path/to/sqlitedatabase.sq3', - - /* - * The username and password to use when connecting to the database. - */ - 'store.sql.username' => null, - 'store.sql.password' => null, - - /* - * The prefix we should use on our tables. - */ - 'store.sql.prefix' => 'SimpleSAMLphp', - - /* - * The hostname and port of the Redis datastore instance. - */ - 'store.redis.host' => 'localhost', - 'store.redis.port' => 6379, - - /* - * The prefix we should use on our Redis datastore. - */ - 'store.redis.prefix' => 'SimpleSAMLphp', -]; diff --git a/build/ssp-overrides/metadata/saml20-idp-remote.php b/build/ssp-overrides/metadata/saml20-idp-remote.php deleted file mode 100644 index b0f348cf..00000000 --- a/build/ssp-overrides/metadata/saml20-idp-remote.php +++ /dev/null @@ -1,45 +0,0 @@ - 'saml20-idp-remote', - 'entityid' => $IDP, - 'SingleSignOnService' => array( - 0 => array( - 'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', - 'Location' => $SSO_URL, - ), - ), - 'SingleLogoutService' => $SLO_URL, - 'certData' => $CERT_DATA, - 'NameIDFormat' => 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient', - 'OrganizationName' => $ORG_NAME, - 'OrganizationDisplayName' => $ORG_NAME, - 'OrganizationURL' => $ORG_URL, - 'authproc' => array( - 50 => array( - 'class' => 'core:AttributeMap', - 'oid2name', - ), - ), - - 'redirect.sign' => true, - 'redirect.validate' => true, - 'assertion.encryption' => true, - 'sign.logout' => true, - 'validate.logout' => true, - 'sign.authnrequest' => true, -); diff --git a/docker-compose.yml b/docker-compose.yml index b7c513bb..de620dea 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -106,9 +106,6 @@ services: environment: MYSQL_HOST: testdb MYSQL_DATABASE: test - SAML_ADMIN_PASSWORD: dummy-for-tests-q6.eYWtfLF-BTQXf-OktD5lVFCOFyC4B - SAML_SECRET_SALT: dummy-for-tests-Ac4MTgO9UJ6_wpXXKc6EGU_.gWNNkdMe - SAML_IDP: NONE redis: image: redis:6 diff --git a/local.env.dist b/local.env.dist index 29f45bde..96e9b39c 100644 --- a/local.env.dist +++ b/local.env.dist @@ -21,22 +21,3 @@ MAILER_PASSWORD= MAILER_USERNAME= SHOW_POPULAR_APIS=true THEME_COLOR= - -# Note: These need to be defined even if not set up for SAML logins. -SAML_ADMIN_PASSWORD= -SAML_IDP= -SAML_SECRET_SALT= - -# These are only applicable if using SAML. -SAML_ENABLED= -SAML_IDP_NAME= -SAML_TRUST_EMAIL_FOR= -SAML_ENTITY_ID= -SAML_CONTACT_NAME= -SAML_CONTACT_EMAIL= -SAML_SSO_URL= -SAML_SLO_URL= -SAML_CERT_DATA= -SAML_ORG_NAME= -SAML_ORG_URL= -