blob: 4601ae82da43b8ec457db0c5bf32a7f70cd9791b [file] [log] [blame]
Nico Huberee52fbc2023-06-24 11:52:57 +00001<?php
2/**
3 * SimpleID configuration file.
4 *
5 * @package simpleid
6 *
7 */
8/*
9 * $Id$
10 *
11 */
12
13
14/**
15 * Base URL.
16 *
17 * This is the URL of the location you want to place your SimpleID
18 * distribution. It becomes the URL of the SimpleID server.
19 *
20 * It is not allowed to have a trailing slash; SimpleID will add it
21 * for you.
22 *
23 * Examples:
24 * <code>
25 * define('SIMPLEID_BASE_URL', 'http://www.example.com');
26 * define('SIMPLEID_BASE_URL', 'http://www.example.com:8888');
27 * define('SIMPLEID_BASE_URL', 'http://www.example.com/simpleid');
28 * define('SIMPLEID_BASE_URL', 'https://www.example.com:8888/simpleid');
29 * </code>
30 *
31 */
32define('SIMPLEID_BASE_URL', 'http://www.example.com');
33
34/**
35 * Allow clean URLs.
36 *
37 * URLs used in SimpleID are normally in the form
38 * http://www.example.com/index.php?q=foo. Enabling clean URLs will allow for
39 * SimpleID URLs to be in the form http://www.example.com/foo
40 *
41 * In order to support clean URLs, you must be using Apache with mod_rewrite
42 * enabled. You will need to rename .htaccess.dist in the SimpleID web directory
43 * to .htaccess
44 *
45 * @since 0.8
46 *
47 */
48define('SIMPLEID_CLEAN_URL', false);
49
50/**
51 * Directory to store identity information.
52 *
53 * This directory must exist and be readable by the web server.
54 *
55 * For maximum security, it is highly recommended to place this
56 * directory outside your web browser's document root directory, so
57 * that it is not visible to user agents.
58 *
59 */
60define('SIMPLEID_IDENTITIES_DIR', '../identities');
61
62/**
63 * Directory to store cache data.
64 *
65 * This directory must exist and be readable and writable by the
66 * web server.
67 *
68 * For maximum security, it is highly recommended to place this
69 * directory outside your web browser's document root directory, so
70 * that it is not visible to user agents.
71 *
72 */
73define('SIMPLEID_CACHE_DIR', '../cache');
74
75/**
76 * Persistent data storage mechanism.
77 *
78 * SimpleID provides flexible methods to store and retrieve persistent data.
79 * By default, SimpleID uses the file system to store this data, implemented
80 * in filesystem.store.inc. Users can implement other methods by creating
81 * a file with extension .store.inc and specifying the file through this
82 * setting.
83 *
84 * Generally you do not need to change this setting.
85 *
86 */
87define('SIMPLEID_STORE', 'filesystem');
88
89/**
90 * Directory to store persistent data.
91 *
92 * This directory must exist and be readable and writable by the
93 * web server.
94 *
95 * For maximum security, it is highly recommended to place this
96 * directory outside your web browser's document root directory, so
97 * that it is not visible to user agents.
98 *
99 */
100define('SIMPLEID_STORE_DIR', '../store');
101
102/**
103 * Allows use of unencrypted connections.
104 *
105 * Between versions 0.6 and 0.8 (inclusive), SimpleID uses either HTTPS or
106 * a form of digest authentication for its login system. This allows passwords
107 * and other secure information not to be sent to the server as plaintext.
108 *
109 * From version 0.9, SimpleID mandates the use of HTTPS for all connections
110 * (other than direct connections between SimpleID and an OpenID relying
111 * party). However, for debug purposes, it may be necessary to allow
112 * unencrypted connections to SimpleID.
113 *
114 * It is strongly recommended that this is set to false. Setting this to true
115 * will allow passwords to be sent as plaintext. You should not change this
116 * value unless it is absolutely necessary.
117 *
118 * @since 0.9
119 */
120define('SIMPLEID_ALLOW_PLAINTEXT', false);
121
122/**
123 * Allows web browsers to save passwords.
124 *
125 * SimpleID prevents web browsers from saving user passwords entered in a user
126 * logs into SimpleID. Setting this value to true will allow browsers to
127 * ask the user whether the password should be saved in the browser's password
128 * store.
129 *
130 * The default is set to false for security reasons. You should not change
131 * this value unless you are certain regarding the security of your browser's
132 * password store.
133 *
134 * @since 0.8
135 */
136define('SIMPLEID_ALLOW_AUTOCOMPLETE', false);
137
138/**
139 * Performs additional verification of relying party return URLs.
140 *
141 * When authenticating using OpenID version 2, SimpleID version 0.7 or later
142 * can perform additional verification of the relying party's return URLs under
143 * section 9.2.1 of the OpenID specification.
144 *
145 * The default is set to true for security reasons. However, if your web server
146 * is blocked by your web hosting provider's firewall from accessing outside
147 * servers, then set this to false.
148 *
149 * @since 0.7
150 *
151 */
152define('SIMPLEID_VERIFY_RETURN_URL_USING_REALM', true);
153
154
155/**
156 * The locale for the SimpleID user interface.
157 *
158 * @since 0.9
159 */
160define('SIMPLEID_LOCALE', 'en');
161
162/**
163 * Date and time format.
164 *
165 * The date and time format specified using the strftime() syntax.
166 *
167 * See http://www.php.net/strftime for details.
168 *
169 */
170define('SIMPLEID_DATE_TIME_FORMAT', '%Y-%m-%d %H:%M:%S %Z');
171
172/**
173 * The number of seconds before associations expire. This is an advanced
174 * option, for which the default setting should work fine.
175 *
176 * Note that for ICAM compliance, this number must be less than 86400.
177 */
178define('SIMPLEID_ASSOC_EXPIRES_IN', 3600);
179
180/**
181 * SimpleID extensions.
182 *
183 * The SimpleID extensions you wish to load. You should separate the
184 * extensions you wish to load with a comma.
185 *
186 */
187define('SIMPLEID_EXTENSIONS', 'sreg,ui');
188
189/**
190 * Log file.
191 *
192 * You can specify a file into which SimpleID will log various diagnostic
193 * messages.
194 *
195 * The log file's directory must exist and must be writable by the web server.
196 *
197 * To disable logging, set this as an empty string.
198 *
199 * @since 0.7
200 *
201 */
202define('SIMPLEID_LOGFILE', '');
203
204/**
205 * The level of detail for log messages.
206 *
207 * You can determine which messages are captured in the log file by specifying
208 * a number between 0 and 5. The higher the number, the more messages are
209 * logged.
210 *
211 * WARNING: Setting the log level to 5 will result in security sensitive
212 * information also being logged.
213 *
214 * This has effect only if logging is enabled.
215 *
216 * @since 0.7
217 *
218 */
219define('SIMPLEID_LOGLEVEL', 4);
220?>