ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
config.php
Go to the documentation of this file.
1<?php
2/*
3 * The configuration of SimpleSAMLphp
4 *
5 */
6
7$config = array(
8
9 /*******************************
10 | BASIC CONFIGURATION OPTIONS |
11 *******************************/
12
13 /*
14 * Setup the following parameters to match your installation.
15 * See the user manual for more details.
16 */
17
18 /*
19 * baseurlpath is a *URL path* (not a filesystem path).
20 * A valid format for 'baseurlpath' is:
21 * [(http|https)://(hostname|fqdn)[:port]]/[path/to/simplesaml/]
22 *
23 * The full url format is useful if your SimpleSAMLphp setup is hosted behind
24 * a reverse proxy. In that case you can specify the external url here.
25 *
26 * Please note that SimpleSAMLphp will then redirect all queries to the
27 * external url, no matter where you come from (direct access or via the
28 * reverse proxy).
29 */
30 'baseurlpath' => 'simplesaml/',
31
32 /*
33 * The 'application' configuration array groups a set configuration options
34 * relative to an application protected by SimpleSAMLphp.
35 */
36 //'application' => array(
37 /*
38 * The 'baseURL' configuration option allows you to specify a protocol,
39 * host and optionally a port that serves as the canonical base for all
40 * your application's URLs. This is useful when the environment
41 * observed in the server differs from the one observed by end users,
42 * for example, when using a load balancer to offload TLS.
43 *
44 * Note that this configuration option does not allow setting a path as
45 * part of the URL. If your setup involves URL rewriting or any other
46 * tricks that would result in SimpleSAMLphp observing a URL for your
47 * application's scripts different than the canonical one, you will
48 * need to compute the right URLs yourself and pass them dynamically
49 * to SimpleSAMLphp's API.
50 */
51 //'baseURL' => 'https://example.com'
52 //),
53
54 /*
55 * The following settings are *filesystem paths* which define where
56 * SimpleSAMLphp can find or write the following things:
57 * - 'certdir': The base directory for certificate and key material.
58 * - 'loggingdir': Where to write logs.
59 * - 'datadir': Storage of general data.
60 * - 'temdir': Saving temporary files. SimpleSAMLphp will attempt to create
61 * this directory if it doesn't exist.
62 * When specified as a relative path, this is relative to the SimpleSAMLphp
63 * root directory.
64 */
65 'certdir' => 'cert/',
66 'loggingdir' => 'log/',
67 'datadir' => 'data/',
68 'tempdir' => '/tmp/simplesaml',
69
70 /*
71 * Some information about the technical persons running this installation.
72 * The email address will be used as the recipient address for error reports, and
73 * also as the technical contact in generated metadata.
74 */
75 'technicalcontact_name' => 'Administrator',
76 'technicalcontact_email' => 'na@example.org',
77
78 /*
79 * The timezone of the server. This option should be set to the timezone you want
80 * SimpleSAMLphp to report the time in. The default is to guess the timezone based
81 * on your system timezone.
82 *
83 * See this page for a list of valid timezones: http://php.net/manual/en/timezones.php
84 */
85 'timezone' => null,
86
87
88
89 /**********************************
90 | SECURITY CONFIGURATION OPTIONS |
91 **********************************/
92
93 /*
94 * This is a secret salt used by SimpleSAMLphp when it needs to generate a secure hash
95 * of a value. It must be changed from its default value to a secret value. The value of
96 * 'secretsalt' can be any valid string of any length.
97 *
98 * A possible way to generate a random salt is by running the following command from a unix shell:
99 * tr -c -d '0123456789abcdefghijklmnopqrstuvwxyz' </dev/urandom | dd bs=32 count=1 2>/dev/null;echo
100 */
101 'secretsalt' => 'defaultsecretsalt',
102
103 /*
104 * This password must be kept secret, and modified from the default value 123.
105 * This password will give access to the installation page of SimpleSAMLphp with
106 * metadata listing and diagnostics pages.
107 * You can also put a hash here; run "bin/pwgen.php" to generate one.
108 */
109 'auth.adminpassword' => '123',
110
111 /*
112 * Set this options to true if you want to require administrator password to access the web interface
113 * or the metadata pages, respectively.
114 */
115 'admin.protectindexpage' => false,
116 'admin.protectmetadata' => false,
117
118 /*
119 * Set this option to false if you don't want SimpleSAMLphp to check for new stable releases when
120 * visiting the configuration tab in the web interface.
121 */
122 'admin.checkforupdates' => true,
123
124 /*
125 * Array of domains that are allowed when generating links or redirects
126 * to URLs. SimpleSAMLphp will use this option to determine whether to
127 * to consider a given URL valid or not, but you should always validate
128 * URLs obtained from the input on your own (i.e. ReturnTo or RelayState
129 * parameters obtained from the $_REQUEST array).
130 *
131 * SimpleSAMLphp will automatically add your own domain (either by checking
132 * it dynamically, or by using the domain defined in the 'baseurlpath'
133 * directive, the latter having precedence) to the list of trusted domains,
134 * in case this option is NOT set to NULL. In that case, you are explicitly
135 * telling SimpleSAMLphp to verify URLs.
136 *
137 * Set to an empty array to disallow ALL redirects or links pointing to
138 * an external URL other than your own domain. This is the default behaviour.
139 *
140 * Set to NULL to disable checking of URLs. DO NOT DO THIS UNLESS YOU KNOW
141 * WHAT YOU ARE DOING!
142 *
143 * Example:
144 * 'trusted.url.domains' => array('sp.example.com', 'app.example.com'),
145 */
146 'trusted.url.domains' => array(),
147
148 /*
149 * Enable regular expression matching of trusted.url.domains.
150 *
151 * Set to true to treat the values in trusted.url.domains as regular
152 * expressions. Set to false to do exact string matching.
153 *
154 * If enabled, the start and end delimiters ('^' and '$') will be added to
155 * all regular expressions in trusted.url.domains.
156 */
157 'trusted.url.regex' => false,
158
159 /*
160 * Enable secure POST from HTTPS to HTTP.
161 *
162 * If you have some SP's on HTTP and IdP is normally on HTTPS, this option
163 * enables secure POSTing to HTTP endpoint without warning from browser.
164 *
165 * For this to work, module.php/core/postredirect.php must be accessible
166 * also via HTTP on IdP, e.g. if your IdP is on
167 * https://idp.example.org/ssp/, then
168 * http://idp.example.org/ssp/module.php/core/postredirect.php must be accessible.
169 */
170 'enable.http_post' => false,
171
172
173
174 /************************
175 | ERRORS AND DEBUGGING |
176 ************************/
177
178 /*
179 * The 'debug' option allows you to control how SimpleSAMLphp behaves in certain
180 * situations where further action may be taken
181 *
182 * It can be left unset, in which case, debugging is switched off for all actions.
183 * If set, it MUST be an array containing the actions that you want to enable, or
184 * alternatively a hashed array where the keys are the actions and their
185 * corresponding values are booleans enabling or disabling each particular action.
186 *
187 * SimpleSAMLphp provides some pre-defined actiones, though modules could add new
188 * actions here. Refer to the documentation of every module to learn if they
189 * allow you to set any more debugging actions.
190 *
191 * The pre-defined actions are:
192 *
193 * - 'saml': this action controls the logging of SAML messages exchanged with other
194 * entities. When enabled ('saml' is present in this option, or set to true), all
195 * SAML messages will be logged, including plaintext versions of encrypted
196 * messages.
197 *
198 * - 'backtraces': this action controls the logging of error backtraces. If you
199 * want to log backtraces so that you can debug any possible errors happening in
200 * SimpleSAMLphp, enable this action (add it to the array or set it to true).
201 *
202 * - 'validatexml': this action allows you to validate SAML documents against all
203 * the relevant XML schemas. SAML 1.1 messages or SAML metadata parsed with
204 * the XML to SimpleSAMLphp metadata converter or the metaedit module will
205 * validate the SAML documents if this option is enabled.
206 *
207 * If you want to disable debugging completely, unset this option or set it to an
208 * empty array.
209 */
210 'debug' => array(
211 'saml' => false,
212 'backtraces' => true,
213 'validatexml' => false,
214 ),
215
216 /*
217 * When 'showerrors' is enabled, all error messages and stack traces will be output
218 * to the browser.
219 *
220 * When 'errorreporting' is enabled, a form will be presented for the user to report
221 * the error to 'technicalcontact_email'.
222 */
223 'showerrors' => true,
224 'errorreporting' => true,
225
226 /*
227 * Custom error show function called from SimpleSAML_Error_Error::show.
228 * See docs/simplesamlphp-errorhandling.txt for function code example.
229 *
230 * Example:
231 * 'errors.show_function' => array('sspmod_example_Error_Show', 'show'),
232 */
233
234
235
236 /**************************
237 | LOGGING AND STATISTICS |
238 **************************/
239
240 /*
241 * Define the minimum log level to log. Available levels:
242 * - SimpleSAML\Logger::ERR No statistics, only errors
243 * - SimpleSAML\Logger::WARNING No statistics, only warnings/errors
244 * - SimpleSAML\Logger::NOTICE Statistics and errors
245 * - SimpleSAML\Logger::INFO Verbose logs
246 * - SimpleSAML\Logger::DEBUG Full debug logs - not recommended for production
247 *
248 * Choose logging handler.
249 *
250 * Options: [syslog,file,errorlog]
251 *
252 */
253 'logging.level' => SimpleSAML\Logger::NOTICE,
254 'logging.handler' => 'syslog',
255
256 /*
257 * Specify the format of the logs. Its use varies depending on the log handler used (for instance, you cannot
258 * control here how dates are displayed when using the syslog or errorlog handlers), but in general the options
259 * are:
260 *
261 * - %date{<format>}: the date and time, with its format specified inside the brackets. See the PHP documentation
262 * of the strftime() function for more information on the format. If the brackets are omitted, the standard
263 * format is applied. This can be useful if you just want to control the placement of the date, but don't care
264 * about the format.
265 *
266 * - %process: the name of the SimpleSAMLphp process. Remember you can configure this in the 'logging.processname'
267 * option below.
268 *
269 * - %level: the log level (name or number depending on the handler used).
270 *
271 * - %stat: if the log entry is intended for statistical purposes, it will print the string 'STAT ' (bear in mind
272 * the trailing space).
273 *
274 * - %trackid: the track ID, an identifier that allows you to track a single session.
275 *
276 * - %srcip: the IP address of the client. If you are behind a proxy, make sure to modify the
277 * $_SERVER['REMOTE_ADDR'] variable on your code accordingly to the X-Forwarded-For header.
278 *
279 * - %msg: the message to be logged.
280 *
281 */
282 //'logging.format' => '%date{%b %d %H:%M:%S} %process %level %stat[%trackid] %msg',
283
284 /*
285 * Choose which facility should be used when logging with syslog.
286 *
287 * These can be used for filtering the syslog output from SimpleSAMLphp into its
288 * own file by configuring the syslog daemon.
289 *
290 * See the documentation for openlog (http://php.net/manual/en/function.openlog.php) for available
291 * facilities. Note that only LOG_USER is valid on windows.
292 *
293 * The default is to use LOG_LOCAL5 if available, and fall back to LOG_USER if not.
294 */
295 'logging.facility' => defined('LOG_LOCAL5') ? constant('LOG_LOCAL5') : LOG_USER,
296
297 /*
298 * The process name that should be used when logging to syslog.
299 * The value is also written out by the other logging handlers.
300 */
301 'logging.processname' => 'simplesamlphp',
302
303 /*
304 * Logging: file - Logfilename in the loggingdir from above.
305 */
306 'logging.logfile' => 'simplesamlphp.log',
307
308 /*
309 * This is an array of outputs. Each output has at least a 'class' option, which
310 * selects the output.
311 */
312 'statistics.out' => array(// Log statistics to the normal log.
313 /*
314 array(
315 'class' => 'core:Log',
316 'level' => 'notice',
317 ),
318 */
319 // Log statistics to files in a directory. One file per day.
320 /*
321 array(
322 'class' => 'core:File',
323 'directory' => '/var/log/stats',
324 ),
325 */
326 ),
327
328
329
330 /***********************
331 | PROXY CONFIGURATION |
332 ***********************/
333
334 /*
335 * Proxy to use for retrieving URLs.
336 *
337 * Example:
338 * 'proxy' => 'tcp://proxy.example.com:5100'
339 */
340 'proxy' => null,
341
342 /*
343 * Username/password authentication to proxy (Proxy-Authorization: Basic)
344 * Example:
345 * 'proxy.auth' = 'myuser:password'
346 */
347 'proxy.auth' => false,
348
349
350
351 /**************************
352 | DATABASE CONFIGURATION |
353 **************************/
354
355 /*
356 * This database configuration is optional. If you are not using
357 * core functionality or modules that require a database, you can
358 * skip this configuration.
359 */
360
361 /*
362 * Database connection string.
363 * Ensure that you have the required PDO database driver installed
364 * for your connection string.
365 */
366 'database.dsn' => 'mysql:host=localhost;dbname=saml',
367
368 /*
369 * SQL database credentials
370 */
371 'database.username' => 'simplesamlphp',
372 'database.password' => 'secret',
373
374 /*
375 * (Optional) Table prefix
376 */
377 'database.prefix' => '',
378
379 /*
380 * True or false if you would like a persistent database connection
381 */
382 'database.persistent' => false,
383
384 /*
385 * Database slave configuration is optional as well. If you are only
386 * running a single database server, leave this blank. If you have
387 * a master/slave configuration, you can define as many slave servers
388 * as you want here. Slaves will be picked at random to be queried from.
389 *
390 * Configuration options in the slave array are exactly the same as the
391 * options for the master (shown above) with the exception of the table
392 * prefix.
393 */
394 'database.slaves' => array(
395 /*
396 array(
397 'dsn' => 'mysql:host=myslave;dbname=saml',
398 'username' => 'simplesamlphp',
399 'password' => 'secret',
400 'persistent' => false,
401 ),
402 */
403 ),
404
405
406
407 /*************
408 | PROTOCOLS |
409 *************/
410
411 /*
412 * Which functionality in SimpleSAMLphp do you want to enable. Normally you would enable only
413 * one of the functionalities below, but in some cases you could run multiple functionalities.
414 * In example when you are setting up a federation bridge.
415 */
416 'enable.saml20-idp' => false,
417 'enable.shib13-idp' => false,
418 'enable.adfs-idp' => false,
419 'enable.wsfed-sp' => false,
420 'enable.authmemcookie' => false,
421
422 /*
423 * Default IdP for WS-Fed.
424 */
425 'default-wsfed-idp' => 'urn:federation:pingfederate:localhost',
426
427 /*
428 * Whether SimpleSAMLphp should sign the response or the assertion in SAML 1.1 authentication
429 * responses.
430 *
431 * The default is to sign the assertion element, but that can be overridden by setting this
432 * option to TRUE. It can also be overridden on a pr. SP basis by adding an option with the
433 * same name to the metadata of the SP.
434 */
435 'shib13.signresponse' => true,
436
437
438
439 /***********
440 | MODULES |
441 ***********/
442
443 /*
444 * Configuration to override module enabling/disabling.
445 *
446 * Example:
447 *
448 * 'module.enable' => array(
449 * 'exampleauth' => TRUE, // Setting to TRUE enables.
450 * 'saml' => FALSE, // Setting to FALSE disables.
451 * 'core' => NULL, // Unset or NULL uses default.
452 * ),
453 *
454 */
455
456
457
458 /*************************
459 | SESSION CONFIGURATION |
460 *************************/
461
462 /*
463 * This value is the duration of the session in seconds. Make sure that the time duration of
464 * cookies both at the SP and the IdP exceeds this duration.
465 */
466 'session.duration' => 8 * (60 * 60), // 8 hours.
467
468 /*
469 * Sets the duration, in seconds, data should be stored in the datastore. As the data store is used for
470 * login and logout requests, this option will control the maximum time these operations can take.
471 * The default is 4 hours (4*60*60) seconds, which should be more than enough for these operations.
472 */
473 'session.datastore.timeout' => (4 * 60 * 60), // 4 hours
474
475 /*
476 * Sets the duration, in seconds, auth state should be stored.
477 */
478 'session.state.timeout' => (60 * 60), // 1 hour
479
480 /*
481 * Option to override the default settings for the session cookie name
482 */
483 'session.cookie.name' => 'SimpleSAMLSessionID',
484
485 /*
486 * Expiration time for the session cookie, in seconds.
487 *
488 * Defaults to 0, which means that the cookie expires when the browser is closed.
489 *
490 * Example:
491 * 'session.cookie.lifetime' => 30*60,
492 */
493 'session.cookie.lifetime' => 0,
494
495 /*
496 * Limit the path of the cookies.
497 *
498 * Can be used to limit the path of the cookies to a specific subdirectory.
499 *
500 * Example:
501 * 'session.cookie.path' => '/simplesaml/',
502 */
503 'session.cookie.path' => '/',
504
505 /*
506 * Cookie domain.
507 *
508 * Can be used to make the session cookie available to several domains.
509 *
510 * Example:
511 * 'session.cookie.domain' => '.example.org',
512 */
513 'session.cookie.domain' => null,
514
515 /*
516 * Set the secure flag in the cookie.
517 *
518 * Set this to TRUE if the user only accesses your service
519 * through https. If the user can access the service through
520 * both http and https, this must be set to FALSE.
521 */
522 'session.cookie.secure' => false,
523
524 /*
525 * Options to override the default settings for php sessions.
526 */
527 'session.phpsession.cookiename' => 'SimpleSAML',
528 'session.phpsession.savepath' => null,
529 'session.phpsession.httponly' => true,
530
531 /*
532 * Option to override the default settings for the auth token cookie
533 */
534 'session.authtoken.cookiename' => 'SimpleSAMLAuthToken',
535
536 /*
537 * Options for remember me feature for IdP sessions. Remember me feature
538 * has to be also implemented in authentication source used.
539 *
540 * Option 'session.cookie.lifetime' should be set to zero (0), i.e. cookie
541 * expires on browser session if remember me is not checked.
542 *
543 * Session duration ('session.duration' option) should be set according to
544 * 'session.rememberme.lifetime' option.
545 *
546 * It's advised to use remember me feature with session checking function
547 * defined with 'session.check_function' option.
548 */
549 'session.rememberme.enable' => false,
550 'session.rememberme.checked' => false,
551 'session.rememberme.lifetime' => (14 * 86400),
552
553 /*
554 * Custom function for session checking called on session init and loading.
555 * See docs/simplesamlphp-advancedfeatures.txt for function code example.
556 *
557 * Example:
558 * 'session.check_function' => array('sspmod_example_Util', 'checkSession'),
559 */
560
561
562
563 /**************************
564 | MEMCACHE CONFIGURATION |
565 **************************/
566
567 /*
568 * Configuration for the 'memcache' session store. This allows you to store
569 * multiple redundant copies of sessions on different memcache servers.
570 *
571 * 'memcache_store.servers' is an array of server groups. Every data
572 * item will be mirrored in every server group.
573 *
574 * Each server group is an array of servers. The data items will be
575 * load-balanced between all servers in each server group.
576 *
577 * Each server is an array of parameters for the server. The following
578 * options are available:
579 * - 'hostname': This is the hostname or ip address where the
580 * memcache server runs. This is the only required option.
581 * - 'port': This is the port number of the memcache server. If this
582 * option isn't set, then we will use the 'memcache.default_port'
583 * ini setting. This is 11211 by default.
584 * - 'weight': This sets the weight of this server in this server
585 * group. http://php.net/manual/en/function.Memcache-addServer.php
586 * contains more information about the weight option.
587 * - 'timeout': The timeout for this server. By default, the timeout
588 * is 3 seconds.
589 *
590 * Example of redundant configuration with load balancing:
591 * This configuration makes it possible to lose both servers in the
592 * a-group or both servers in the b-group without losing any sessions.
593 * Note that sessions will be lost if one server is lost from both the
594 * a-group and the b-group.
595 *
596 * 'memcache_store.servers' => array(
597 * array(
598 * array('hostname' => 'mc_a1'),
599 * array('hostname' => 'mc_a2'),
600 * ),
601 * array(
602 * array('hostname' => 'mc_b1'),
603 * array('hostname' => 'mc_b2'),
604 * ),
605 * ),
606 *
607 * Example of simple configuration with only one memcache server,
608 * running on the same computer as the web server:
609 * Note that all sessions will be lost if the memcache server crashes.
610 *
611 * 'memcache_store.servers' => array(
612 * array(
613 * array('hostname' => 'localhost'),
614 * ),
615 * ),
616 *
617 */
618 'memcache_store.servers' => array(
619 array(
620 array('hostname' => 'localhost'),
621 ),
622 ),
623
624 /*
625 * This value allows you to set a prefix for memcache-keys. The default
626 * for this value is 'simpleSAMLphp', which is fine in most cases.
627 *
628 * When running multiple instances of SSP on the same host, and more
629 * than one instance is using memcache, you probably want to assign
630 * a unique value per instance to this setting to avoid data collision.
631 */
632 'memcache_store.prefix' => '',
633
634 /*
635 * This value is the duration data should be stored in memcache. Data
636 * will be dropped from the memcache servers when this time expires.
637 * The time will be reset every time the data is written to the
638 * memcache servers.
639 *
640 * This value should always be larger than the 'session.duration'
641 * option. Not doing this may result in the session being deleted from
642 * the memcache servers while it is still in use.
643 *
644 * Set this value to 0 if you don't want data to expire.
645 *
646 * Note: The oldest data will always be deleted if the memcache server
647 * runs out of storage space.
648 */
649 'memcache_store.expires' => 36 * (60 * 60), // 36 hours.
650
651
652
653 /*************************************
654 | LANGUAGE AND INTERNATIONALIZATION |
655 *************************************/
656
657 /*
658 * Languages available, RTL languages, and what language is the default.
659 */
660 'language.available' => array(
661 'en', 'no', 'nn', 'se', 'da', 'de', 'sv', 'fi', 'es', 'fr', 'it', 'nl', 'lb', 'cs',
662 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt-br', 'tr', 'ja', 'zh', 'zh-tw', 'ru', 'et',
663 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af'
664 ),
665 'language.rtl' => array('ar', 'dv', 'fa', 'ur', 'he'),
666 'language.default' => 'en',
667
668 /*
669 * Options to override the default settings for the language parameter
670 */
671 'language.parameter.name' => 'language',
672 'language.parameter.setcookie' => true,
673
674 /*
675 * Options to override the default settings for the language cookie
676 */
677 'language.cookie.name' => 'language',
678 'language.cookie.domain' => null,
679 'language.cookie.path' => '/',
680 'language.cookie.secure' => false,
681 'language.cookie.httponly' => false,
682 'language.cookie.lifetime' => (60 * 60 * 24 * 900),
683
684 /*
685 * Which i18n backend to use.
686 *
687 * "SimpleSAMLphp" is the home made system, valid for 1.x.
688 * For 2.x, only "gettext/gettext" will be possible.
689 *
690 * Home-made templates will always use "SimpleSAMLphp".
691 * To use twig (where avaliable), select "gettext/gettext".
692 */
693 'language.i18n.backend' => 'SimpleSAMLphp',
694
707 /*
708 * Extra dictionary for attribute names.
709 * This can be used to define local attributes.
710 *
711 * The format of the parameter is a string with <module>:<dictionary>.
712 *
713 * Specifying this option will cause us to look for modules/<module>/dictionaries/<dictionary>.definition.json
714 * The dictionary should look something like:
715 *
716 * {
717 * "firstattribute": {
718 * "en": "English name",
719 * "no": "Norwegian name"
720 * },
721 * "secondattribute": {
722 * "en": "English name",
723 * "no": "Norwegian name"
724 * }
725 * }
726 *
727 * Note that all attribute names in the dictionary must in lowercase.
728 *
729 * Example: 'attributes.extradictionary' => 'ourmodule:ourattributes',
730 */
731 'attributes.extradictionary' => null,
732
733
734
735 /**************
736 | APPEARANCE |
737 **************/
738
739 /*
740 * Which theme directory should be used?
741 */
742 'theme.use' => 'default',
743
744 /*
745 * Templating options
746 *
747 * By default, twig templates are not cached. To turn on template caching:
748 * Set 'template.cache' to an absolute path pointing to a directory that
749 * SimpleSAMLphp has read and write permissions to.
750 */
751 //'template.cache' => '',
752
753 /*
754 * Set the 'template.auto_reload' to true if you would like SimpleSAMLphp to
755 * recompile the templates (when using the template cache) if the templates
756 * change. If you don't want to check the source templates for every request,
757 * set it to false.
758 */
759 'template.auto_reload' => false,
760
761
762
763 /*********************
764 | DISCOVERY SERVICE |
765 *********************/
766
767 /*
768 * Whether the discovery service should allow the user to save his choice of IdP.
769 */
770 'idpdisco.enableremember' => true,
771 'idpdisco.rememberchecked' => true,
772
773 /*
774 * The disco service only accepts entities it knows.
775 */
776 'idpdisco.validate' => true,
777
778 'idpdisco.extDiscoveryStorage' => null,
779
780 /*
781 * IdP Discovery service look configuration.
782 * Wether to display a list of idp or to display a dropdown box. For many IdP' a dropdown box
783 * gives the best use experience.
784 *
785 * When using dropdown box a cookie is used to highlight the previously chosen IdP in the dropdown.
786 * This makes it easier for the user to choose the IdP
787 *
788 * Options: [links,dropdown]
789 */
790 'idpdisco.layout' => 'dropdown',
791
792
793
794 /*************************************
795 | AUTHENTICATION PROCESSING FILTERS |
796 *************************************/
797
798 /*
799 * Authentication processing filters that will be executed for all IdPs
800 * Both Shibboleth and SAML 2.0
801 */
802 'authproc.idp' => array(
803 /* Enable the authproc filter below to add URN prefixes to all attributes
804 10 => array(
805 'class' => 'core:AttributeMap', 'addurnprefix'
806 ), */
807 /* Enable the authproc filter below to automatically generated eduPersonTargetedID.
808 20 => 'core:TargetedID',
809 */
810
811 // Adopts language from attribute to use in UI
812 30 => 'core:LanguageAdaptor',
813
814 45 => array(
815 'class' => 'core:StatisticsWithAttribute',
816 'attributename' => 'realm',
817 'type' => 'saml20-idp-SSO',
818 ),
819
820 /* When called without parameters, it will fallback to filter attributes ‹the old way›
821 * by checking the 'attributes' parameter in metadata on IdP hosted and SP remote.
822 */
823 50 => 'core:AttributeLimit',
824
825 /*
826 * Search attribute "distinguishedName" for pattern and replaces if found
827
828 60 => array(
829 'class' => 'core:AttributeAlter',
830 'pattern' => '/OU=studerende/',
831 'replacement' => 'Student',
832 'subject' => 'distinguishedName',
833 '%replace',
834 ),
835 */
836
837 /*
838 * Consent module is enabled (with no permanent storage, using cookies).
839
840 90 => array(
841 'class' => 'consent:Consent',
842 'store' => 'consent:Cookie',
843 'focus' => 'yes',
844 'checked' => TRUE
845 ),
846 */
847 // If language is set in Consent module it will be added as an attribute.
848 99 => 'core:LanguageAdaptor',
849 ),
850
851 /*
852 * Authentication processing filters that will be executed for all SPs
853 * Both Shibboleth and SAML 2.0
854 */
855 'authproc.sp' => array(
856 /*
857 10 => array(
858 'class' => 'core:AttributeMap', 'removeurnprefix'
859 ),
860 */
861
862 /*
863 * Generate the 'group' attribute populated from other variables, including eduPersonAffiliation.
864 60 => array(
865 'class' => 'core:GenerateGroups', 'eduPersonAffiliation'
866 ),
867 */
868 /*
869 * All users will be members of 'users' and 'members'
870 61 => array(
871 'class' => 'core:AttributeAdd', 'groups' => array('users', 'members')
872 ),
873 */
874
875 // Adopts language from attribute to use in UI
876 90 => 'core:LanguageAdaptor',
877
878 ),
879
880
881
882 /**************************
883 | METADATA CONFIGURATION |
884 **************************/
885
886 /*
887 * This option configures the metadata sources. The metadata sources is given as an array with
888 * different metadata sources. When searching for metadata, SimpleSAMLphp will search through
889 * the array from start to end.
890 *
891 * Each element in the array is an associative array which configures the metadata source.
892 * The type of the metadata source is given by the 'type' element. For each type we have
893 * different configuration options.
894 *
895 * Flat file metadata handler:
896 * - 'type': This is always 'flatfile'.
897 * - 'directory': The directory we will load the metadata files from. The default value for
898 * this option is the value of the 'metadatadir' configuration option, or
899 * 'metadata/' if that option is unset.
900 *
901 * XML metadata handler:
902 * This metadata handler parses an XML file with either an EntityDescriptor element or an
903 * EntitiesDescriptor element. The XML file may be stored locally, or (for debugging) on a remote
904 * web server.
905 * The XML metadata handler defines the following options:
906 * - 'type': This is always 'xml'.
907 * - 'file': Path to the XML file with the metadata.
908 * - 'url': The URL to fetch metadata from. THIS IS ONLY FOR DEBUGGING - THERE IS NO CACHING OF THE RESPONSE.
909 *
910 * MDQ metadata handler:
911 * This metadata handler looks up for the metadata of an entity at the given MDQ server.
912 * The MDQ metadata handler defines the following options:
913 * - 'type': This is always 'mdq'.
914 * - 'server': Base URL of the MDQ server. Mandatory.
915 * - 'validateFingerprint': The fingerprint of the certificate used to sign the metadata. You don't need this
916 * option if you don't want to validate the signature on the metadata. Optional.
917 * - 'cachedir': Directory where metadata can be cached. Optional.
918 * - 'cachelength': Maximum time metadata can be cached, in seconds. Defaults to 24
919 * hours (86400 seconds). Optional.
920 *
921 * PDO metadata handler:
922 * This metadata handler looks up metadata of an entity stored in a database.
923 *
924 * Note: If you are using the PDO metadata handler, you must configure the database
925 * options in this configuration file.
926 *
927 * The PDO metadata handler defines the following options:
928 * - 'type': This is always 'pdo'.
929 *
930 * Examples:
931 *
932 * This example defines two flatfile sources. One is the default metadata directory, the other
933 * is a metadata directory with auto-generated metadata files.
934 *
935 * 'metadata.sources' => array(
936 * array('type' => 'flatfile'),
937 * array('type' => 'flatfile', 'directory' => 'metadata-generated'),
938 * ),
939 *
940 * This example defines a flatfile source and an XML source.
941 * 'metadata.sources' => array(
942 * array('type' => 'flatfile'),
943 * array('type' => 'xml', 'file' => 'idp.example.org-idpMeta.xml'),
944 * ),
945 *
946 * This example defines an mdq source.
947 * 'metadata.sources' => array(
948 * array(
949 * 'type' => 'mdq',
950 * 'server' => 'http://mdq.server.com:8080',
951 * 'cachedir' => '/var/simplesamlphp/mdq-cache',
952 * 'cachelength' => 86400
953 * )
954 * ),
955 *
956 * This example defines an pdo source.
957 * 'metadata.sources' => array(
958 * array('type' => 'pdo')
959 * ),
960 *
961 * Default:
962 * 'metadata.sources' => array(
963 * array('type' => 'flatfile')
964 * ),
965 */
966 'metadata.sources' => array(
967 array('type' => 'flatfile'),
968 ),
969
970 /*
971 * Should signing of generated metadata be enabled by default.
972 *
973 * Metadata signing can also be enabled for a individual SP or IdP by setting the
974 * same option in the metadata for the SP or IdP.
975 */
976 'metadata.sign.enable' => false,
977
978 /*
979 * The default key & certificate which should be used to sign generated metadata. These
980 * are files stored in the cert dir.
981 * These values can be overridden by the options with the same names in the SP or
982 * IdP metadata.
983 *
984 * If these aren't specified here or in the metadata for the SP or IdP, then
985 * the 'certificate' and 'privatekey' option in the metadata will be used.
986 * if those aren't set, signing of metadata will fail.
987 */
988 'metadata.sign.privatekey' => null,
989 'metadata.sign.privatekey_pass' => null,
990 'metadata.sign.certificate' => null,
991
992
993
994 /****************************
995 | DATA STORE CONFIGURATION |
996 ****************************/
997
998 /*
999 * Configure the data store for SimpleSAMLphp.
1000 *
1001 * - 'phpsession': Limited datastore, which uses the PHP session.
1002 * - 'memcache': Key-value datastore, based on memcache.
1003 * - 'sql': SQL datastore, using PDO.
1004 * - 'redis': Key-value datastore, based on redis.
1005 *
1006 * The default datastore is 'phpsession'.
1007 *
1008 * (This option replaces the old 'session.handler'-option.)
1009 */
1010 'store.type' => 'phpsession',
1011
1012 /*
1013 * The DSN the sql datastore should connect to.
1014 *
1015 * See http://www.php.net/manual/en/pdo.drivers.php for the various
1016 * syntaxes.
1017 */
1018 'store.sql.dsn' => 'sqlite:/path/to/sqlitedatabase.sq3',
1019
1020 /*
1021 * The username and password to use when connecting to the database.
1022 */
1023 'store.sql.username' => null,
1024 'store.sql.password' => null,
1025
1026 /*
1027 * The prefix we should use on our tables.
1028 */
1029 'store.sql.prefix' => 'SimpleSAMLphp',
1030
1031 /*
1032 * The hostname and port of the Redis datastore instance.
1033 */
1034 'store.redis.host' => 'localhost',
1035 'store.redis.port' => 6379,
1036
1037 /*
1038 * The prefix we should use on our Redis datastore.
1039 */
1040 'store.redis.prefix' => 'SimpleSAMLphp',
1041);
An exception for terminatinating execution or to throw for unit testing.
$config
Definition: config.php:7
Attribute-related utility methods.
defined( 'APPLICATION_ENV')||define( 'APPLICATION_ENV'
Definition: bootstrap.php:27