Implements PlSession::apiAuth. The authentication is based on a HMAC
[platal.git] / configs / platal.ini
1 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2 ; Copyright (C) 2003-2010 Polytechnique.org ;
3 ; http://opensource.polytechnique.org/ ;
4 ; ;
5 ; This program is free software; you can redistribute it and/or modify ;
6 ; it under the terms of the GNU General Public License as published by ;
7 ; the Free Software Foundation; either version 2 of the License, or ;
8 ; (at your option) any later version. ;
9 ; ;
10 ; This program is distributed in the hope that it will be useful, ;
11 ; but WITHOUT ANY WARRANTY; without even the implied warranty of ;
12 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;
13 ; GNU General Public License for more details. ;
14 ; ;
15 ; You should have received a copy of the GNU General Public License ;
16 ; along with this program; if not, write to the Free Software ;
17 ; Foundation, Inc., ;
18 ; 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ;
19 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
20
21 ; DO NOT EDIT THIS FILE
22 ; This file contains the default values for the configuration variables of
23 ; plat/al. This values can be overriden in by adding a platal.conf file in
24 ; the same directory.
25 ; DO NOT EDIT THIS FILE
26
27
28 ; The core section contains the main configuration of the website like name
29 ; of the site, its URL, or the database parameters. It also provide tools
30 ; to setup debugging or restrictions on the website.
31 [Core]
32
33 ; $globals->locale
34 ; Locale of the web site. This includes language and charset to
35 ; use for system strings.
36 locale = "fr_FR.UTF-8"
37
38 ; $globals->timezone
39 ; The timezone of the server.
40 timezone = "Europe/Paris"
41
42 ; $globals->core->restricted_platal
43 ; When activated restricted_platal, the copy of the website is protected against
44 ; indexation by search engine. This also activate the addition of catch-all emails
45 ; by PlMailer. (see email_catchall and robotstxt_disallowed_uris for more details).
46 ;
47 ; A production website should set this variable to true in platal.conf
48 restricted_platal = 1
49
50 ; $globals->core->robotstxt_disallowed_uris
51 ; List of urls that must not be indexed by search engines when the site is not
52 ; in restricted mode. The urls must be separated by spaces or commas.
53 ;
54 ; e.g: robotstxt_disallowed_uris = "/javascript /images /Xorg"
55 robotstxt_disallowed_uris =
56
57 ; $globals->email_catchall
58 ; An email address that signal a mail to be discarded by the mail routing
59 ; environment.
60 ;
61 ; email_catchall = ""
62
63 ; $globals->cookie_ns
64 ; String to preprend to the name of the cookies generated by the site
65 ;
66 ; cookie_ns = ""
67
68 ; $globals->cookie_path
69 ; The path the cookies generated by the site are associated to.
70 ;
71 ; cookie_path = ""
72
73 ; $globals->debug
74 ; Debug flags. The flags are integer mask and the debug value is a combination
75 ; of this flags. Available values are:
76 ; - provided by the core:
77 ; 1 - DEBUG_BT: displays the backtraces (SQL, mailman, banana executions)
78 ; 2 - DEBUG_VALID: checks that the html of the page is valid
79 ; 4 - DEBUG_SMARTY: don't hide error reported during the execution of smarty
80 ; 8 - DEBUG_NOCACHE: disable data caching
81 ; 16 - DEBUG_SCRIPTCACHE: cache expires after the execution of the script (no caching
82 ; in session or via memcache)
83 ; - provided by xorg:
84 ; 256 - DEBUG_NOCACHE: don't cache db content in the session (this feature as been moved
85 ; to the core and this flag is deprecated)
86 ;
87 ; debug = 0
88
89 ; $globals->mode
90 ; Plat/al execution mode:
91 ; empty -> this copy of plat/al is disabled
92 ; 'r' -> read only, writing in the database is not allowed (excepting logging)
93 ; 'rw' -> read-write, the site is fully available
94 ;
95 ; mode = "rw"
96
97 ; $globals->core->secure_domain
98 ; If not empty, the site automatically redirects the user to the secure_domain.
99 ; The value must be a hostname (eg.: www.polytechnique.org)
100 secure_domain = ""
101
102 ; $globals->baseurl
103 ; The base url of the web site. This value is used only for scripts called from
104 ; command line. The value is computed automatically when php serves a web page.
105 baseurl = "https://www.example.org/"
106
107 ; $globals->sitename
108 ; The name of the site
109 ;
110 ; sitename = ""
111
112 ; $globals->dbhost
113 ; Host where the db is located
114 ; dbhost = "localhost"
115
116 ; $globals->dbuser
117 ; Username to use to connect to the database
118 ; dbuser = "web"
119
120 ; $globals->dbpwd
121 ; Password to use to connect to the database
122 ; dbpwd = ""
123
124 ; $globals->dbdb
125 ; Name of the database
126 ; dbdb = "x4dat"
127
128 ; $globals->dbcharset
129 ; The charset to use when talking to the database
130 ; dbcharset = "utf8"
131
132 ; $globals->core->memcache
133 ; List of space separated addresses of memcache servers
134 memcache = ""
135
136 ; $globals->static_cache_duration
137 ; Cache duration for static content
138 ; static_cache_duration = "604800"
139
140 ; $globals->dynamic_cache_duration
141 ; Cache duration for dynamic content
142 ; dynamic_cache_duration = "3600"
143
144 ; $globals->skin
145 ; Skin to use for unlogged accesses and when the user didn't explicitely
146 ; select a skin.
147 skin = "default"
148
149 ; $globals->register_skin
150 ; Skin to use during registration process
151 register_skin = "register"
152
153 ; $globals->core->econfiance
154 ; Key used to perform transactions with the 'econfiance' webservice in order
155 ; to synchronize the X-Informatique directory with polytechnique.net
156 econfiance = ""
157
158
159 ; The API section contains the configuration for the web services.
160 [Api]
161
162 ; $globals->api->hmac_algo
163 ; Algorithm to use for HMAC-based authentication of API requests. Note that this
164 ; value is shared with clients, and must be changed in all places at once.
165 hmac_algo = "sha256"
166
167 ; $globals->api->timestamp_tolerance
168 ; Maximum number of seconds of drift allowed between the client-side UNIX clock
169 ; and the server-side clock. This should be big enough to also allow for network
170 ; latency, but not too high, to limit replay opportunities.
171 timestamp_tolerance = 10
172
173
174 ; The banana section contains the configuration of the forums.
175 [Banana]
176
177 ; $globals->banana->server
178 ; Hostname of the nntp server
179 server = "localhost"
180
181 ; $globals->banana->port
182 ; Port of the nntp server (if port is 563, banana automatically switch
183 ; to nntps)
184 port = 119
185
186 ; $globals->banana->password
187 ; Password used by banana to authenticate site users with the nntp server.
188 password = "***"
189
190 ; $globals->banana->web_user
191 ; Username used by banana
192 web_user = "***"
193
194 ; $globals->banana->web_pass
195 ; Password used by banana to perform administrative tasks unrelated to a
196 ; specific user
197 web_pass = "***"
198
199 ; $globals->banana->event_forum
200 ; Name of the newsgroup where events are posted
201 event_forum = ""
202
203 ; $globals->banana->event_reply
204 ; Name of a newsgroup where to reply to posted events
205 event_reply = ""
206
207
208 ; The geocoder section contains parameters used to perform the geocoding
209 ; and the formatting of user addresses.
210 [Geocoder]
211
212 ; $globals->geocder->email
213 ; Unused parameter.
214 email = ""
215
216 ; $globals->geocoder->gmaps_key
217 ; API key to use when querying google maps web service
218 gmaps_key = ""
219
220 ; $globals->geocoder->gmaps_url
221 ; URL of geocoding webservice
222 gmaps_url = "http://maps.google.com/maps/geo"
223
224 ; $globals->geocoder->gmaps_hl
225 ; Default output language.
226 gmaps_hl = "fr"
227
228 ; $globals->geocoder->gmaps_gl
229 ; Default location preference.
230 gmaps_gl = "fr"
231
232
233 ; The lists section contains parameters used to interact with mailman.
234 [Lists]
235
236 ; $globals->lists->rpchost
237 ; Hostname where the lists' rpc server is located
238 rpchost = "localhost"
239
240 ; $globasl->lists->rpcport
241 ; Port of the lists' rpc server
242 rpcport = "4949"
243
244 ; $globals->lists->spool
245 ; Path to the archives of mailman. This is used to provide access to the archives
246 ; via the web interface
247 spool = "/var/lib/mailman/archives/private"
248
249 ; $globals->lists->vhost_sep
250 ; Character used to separate the host part and the list name part in the internal
251 ; name of the list in mailman. If vhost_sep is '_', the list blah@example.com will
252 ; be internally named example.com_blah
253 vhost_sep = "_"
254
255 ; $globals->lists->max_mail_per_min
256 ; Maximum number of mails an instance of the moderation cron accepts to deliver.
257 max_mail_per_min = 400
258
259
260 ; The mail section contains parameters used to interacts with email routing
261 [Mail]
262
263 ; $globals->mail->domain
264 ; Main mail domain
265 domain = ""
266
267 ; $globals->mail->domain2
268 ; Secondary mail domain providing aliases to the main domain.
269 domain2 = ""
270
271 ; $globals->mail->alias_dom
272 ; Mail domain hosting user-choosen aliases.
273 alias_dom = ""
274
275 ; $globals->mail->alias_dom2
276 ; Secondary domain for user-choosen aliases.
277 alias_dom2 = ""
278
279 blacklist_check_url = ""
280 blacklist_host_resolution_limit =
281
282 ; $globals->mail->domain_whitelist
283 ; Space-separated list of domains to be accepted in urls in the newsletter even if this
284 ; domain is blacklisted by a spam filter.
285 domain_whitelist = ""
286
287
288 ; The mailstorage section contains parameters describing the availability of email storage services
289 [MailStorage]
290
291 ; $globals->mailstorage->imap_active
292 ; Boolean flag triggering the activation of the administration interface for the imap storage service.
293 imap_active = 0
294
295 ; $globals->mailstorage->googleapps_active
296 ; Boolean flag triggering the activation of the administration interface for the googleapps service.
297 googleapps_active = 0
298
299 ; $globals->mailstorage->googleapps_domain
300 ; Domain used internally when redirecting an email to the googleapps account of a user.
301 googleapps_domain = ""
302
303
304 ; The manageurs section contains parameters for the webservice providing data to manageurs.com
305 [Manageurs]
306
307 ; $globals->manageurs->authorized_ips
308 ; Space-separated list of IP that are allowed on the webservice
309 authorized_ips = "129.104.30.32 129.104.30.33 213.251.145.200"
310
311 ; $globals->manageurs->manageurs_cipher_key
312 ; Key used to cipher data sent to manageurs.com
313 manageurs_cipher_key = ""
314
315 ; $globals->manageurs->manageurs_pass
316 ; Password to be provided by manageurs.com to get authenticated on the webservice
317 manageurs_pass = ""
318
319
320 ; The money section contains parameters for the payment module
321 [Money]
322
323 ; $globals->money->email
324 ; Email address to which payment related actions are reported
325 ;
326 ; email = ""
327
328 ; Undocumented parameter
329 mpay_def_id = 0
330
331 ; Undocumented parameter
332 mpay_def_meth = 0
333
334 ; $globals->money->paypal_site
335 ; Hostname of the Paypal site
336 paypal_site = ""
337
338 ; $globals->money->paypal_compte
339 ; Account on Paypal
340 paypal_compte = ""
341
342 ; $globals->money->cyberplus_key
343 ; API key to use when accessing the CyberPlus payment service
344 ;
345 ; cyperplus_key = ""
346
347
348 ; The poison section contains parameters for injecting poisonous email on the internet
349 [Poison]
350
351 ; $globals->poison->file
352 ; Path to a file containing one poisonous email per line
353 file = ""
354
355
356 ; The search section contains parameters for the search module
357 [Search]
358
359 ; $globals->search->public_max
360 ; Maximum number of profiles a search on the public site is allowed to return.
361 public_max = 25
362
363 ; $globals->search->private_max
364 ; Maximum number of profiles a search on the private site is allowed to return
365 private_max = 800
366
367 ; $globals->search->per_page
368 ; Maximum number of profiles per page in the result of a search
369 per_page = 20
370
371
372 ; The register section contains parameters for the registration process
373 [Register]
374
375 ; $globals->register->notif
376 ; Email address to be notified on new registrations.
377 notif = ""
378
379
380 ; The webservice section contains parameters used to access external webservices
381 [WebService]
382
383 ; $globals->webservice->pass
384 ; Pass to access the webservice of manageurs.com
385 pass = ""
386
387 ; $globals->webservice->pass_ax
388 ; Passphrase to use to access the webservice of the AX
389 pass_ax = ""
390
391 ; $globals->webservice->hsot_ax
392 ; Host of the webservice of the AX
393 host_ax = "https://www.polytechniciens.com/"
394
395 ; $globals->webservice->private_key_ax
396 ; Path to the private key used for authentication with the webservice of the AX
397 private_key_ax = ""
398
399
400 ; The xnet section contains parameters for Polytechnique.net
401 [Xnet]
402
403 ; $globals->xnet->secret
404 ; Authentication key to use to authenticate users with Polytechnique.org
405 secret = ""
406
407 ; $globals->xnet->auth_baseurl
408 ; Baseur of the site used to perform authentication
409 auth_baseurl = ""
410
411 ; $globals->xnet->evts_domain
412 ; Domain address where the aliases containing the list of (non-)subscribers
413 ; of an event are created.
414 evts_domain = ""
415
416 ; The merge section contains parameters about the merge's state.
417 [Merge]
418
419 ; $globals->merge->state
420 ; Pending before the merge, done afterwards.
421 state = "pending"