1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title></title>
<!-- metadata -->
<meta name="generator" content="Offline" />
<meta name="version" content="Offline 0.1" />
<!-- style sheet links -->
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" />
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" />
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" />
</head>
<body>
<div class="dokuwiki export">
<h1><a name="extended_functions" id="extended_functions">Extended functions</a></h1>
<div class="level1">
</div>
<!-- SECTION "Extended functions" [1-34] -->
<h2><a name="presentation" id="presentation">Presentation</a></h2>
<div class="level2">
<p>
When <a href="../../documentation/1.3/writingrulesand_headers.html" class="wikilink1" title="documentation:1.3:writingrulesand_headers">writing rules and headers</a>, you can use <acronym title="Practical Extraction and Report Language">Perl</acronym> expressions that will be evaluated in a jail, to prevent bad code execution.
</p>
<p>
This is also true for:
</p>
<ul>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/portalmenu.html#menu_modules" class="wikilink1" title="documentation:1.3:portalmenu">Menu modules activation rules</a></div>
</li>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/formreplay.html" class="wikilink1" title="documentation:1.3:formreplay">Form replay data</a></div>
</li>
<li class="level1"><div class="li"> Macros</div>
</li>
<li class="level1"><div class="li"> Issuer databases use rules</div>
</li>
<li class="level1"><div class="li"> etc.</div>
</li>
</ul>
<p>
Inside this jail, you can access to:
</p>
<ul>
<li class="level1"><div class="li"> Core <acronym title="Practical Extraction and Report Language">Perl</acronym> subroutines (split, pop, map, etc.)</div>
</li>
<li class="level1"><div class="li"> <a href="../../documentation/1.3/customfunctions.html" class="wikilink1" title="documentation:1.3:customfunctions">Custom functions</a></div>
</li>
<li class="level1"><div class="li"> The <a href="http://perldoc.perl.org/MIME/Base64.html" class="urlextern" title="http://perldoc.perl.org/MIME/Base64.html" rel="nofollow">encode_base64</a> subroutine</div>
</li>
<li class="level1"><div class="li"> All environment variables (trough %ENV)</div>
</li>
<li class="level1"><div class="li"> <a href="#functions_list" title="documentation:1.3:extendedfunctions ↵" class="wikilink1">Extended functions</a></div>
</li>
</ul>
<p>
<p><div class="notetip">To know more about the jail, check <a href="http://perldoc.perl.org/Safe.html" class="urlextern" title="http://perldoc.perl.org/Safe.html" rel="nofollow">Safe module documentation</a>.
</div></p>
</p>
</div>
<!-- SECTION "Presentation" [35-800] -->
<h2><a name="functions_list_available" id="functions_list_available">Functions list available</a></h2>
<div class="level2">
</div>
<!-- SECTION "Functions list available" [801-838] -->
<h3><a name="checklogonhours" id="checklogonhours">checkLogonHours</a></h3>
<div class="level3">
<p>
This function will check the day and the hour of current request, and compare it to allowed days and hours. It returns 1 if this match, 0 else.
</p>
<p>
By default, the allowed days and hours is an hexadecimal value, representing each hour of the week. A day has 24 hours, and a week 7 days, so the value contains 168 bits, converted into 42 hexadecimal characters. Sunday is the first day.
</p>
<p>
For example, for a full access, excepted week-end:
</p>
<pre class="code">
000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000
</pre>
<p>
<p><div class="notetip">The <a href="../../documentation/1.3/authldap.html#schema_extension" class="wikilink1" title="documentation:1.3:authldap">LDAP schema extension</a> can be used to store this value. You can also use the binary value from the logonHours attribute of Active Directory
</div></p>
</p>
<p>
Functions parameters:
</p>
<ul>
<li class="level1"><div class="li"> <strong>logon_hours</strong>: string representing allowed logon hours (GMT)</div>
</li>
<li class="level1"><div class="li"> <strong>syntax</strong> (optional): <code>hexadecimal</code> (default) or <code>octetstring</code></div>
</li>
<li class="level1"><div class="li"> <strong>time_correction</strong> (optional): hours to add or to subtract</div>
</li>
<li class="level1"><div class="li"> <strong>default_access</strong> (optional): what result to return if <strong>logon_hours</strong> is empty</div>
</li>
</ul>
<p>
Simple usage example:
</p>
<pre class="code">
checkLogonHours($ssoLogonHours)
</pre>
<p>
If you use the binary value (Active Directory), use this:
</p>
<pre class="code">
checkLogonHours($ssoLogonHours, 'octetstring')
</pre>
<p>
You can also configure jetlag (if all of your users use the same timezone):
</p>
<pre class="code">
checkLogonHours($ssoLogonHours, '', '+2')
</pre>
<p>
If you manage different timezones, you have to take the jetlag into account in ssoLogonHours values, or use the $_timezone parameter. This parameter is set by the portal and use javascript to get the connected user timezone. It should works on every browser:
</p>
<pre class="code">
checkLogonHours($ssoLogonHours, '', $_timezone)
</pre>
<p>
You can modify the default behavior for people without value in ssoLogonHours. Indeed, by default, users without logon hours values are rejected. You can allow these users instead of reject them:
</p>
<pre class="code">
checkLogonHours($ssoLogonHours, '', '', '1')
</pre>
</div>
<!-- SECTION "checkLogonHours" [839-2766] -->
<h3><a name="checkdate" id="checkdate">checkDate</a></h3>
<div class="level3">
<p>
This function will check the date of current request, and compare it to a start date and an end date. It returns 1 if this match, 0 else.
</p>
<p>
<p><div class="notetip">The <a href="../../documentation/1.3/authldap.html#schema_extension" class="wikilink1" title="documentation:1.3:authldap">LDAP schema extension</a> can be used to store these values
</div></p>
</p>
<p>
The date format is the <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> date syntax, for example for the 1st March 2009:
</p>
<pre class="code">
20090301000000Z
</pre>
<p>
Functions parameters:
</p>
<ul>
<li class="level1"><div class="li"> <strong>start</strong>: Start date (GMT)</div>
</li>
<li class="level1"><div class="li"> <strong>end</strong>: End date (GMT)</div>
</li>
<li class="level1"><div class="li"> <strong>default_access</strong> (optional): what result to return if <strong>start</strong> and <strong>end</strong> are empty</div>
</li>
</ul>
<p>
Simple usage example:
</p>
<pre class="code">
checkDate($ssoStartDate, $ssoEndDate)
</pre>
</div>
<!-- SECTION "checkDate" [2767-3394] -->
<h3><a name="basic" id="basic">basic</a></h3>
<div class="level3">
<p>
<p><div class="noteimportant">This function is not compliant with <a href="../../documentation/1.3/safejail.html" class="wikilink1" title="documentation:1.3:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div></p>
</p>
<p>
This function builds the <code>Authorization</code> <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> header used in <a href="../../documentation/1.3/applications/authbasic.html" class="wikilink1" title="documentation:1.3:applications:authbasic">HTTP Basic authentication scheme</a>. It will force conversion from UTF-8 to <acronym title="International Organization for Standardization">ISO</acronym>-8859-1 of user and password data.
</p>
<p>
Functions parameters:
</p>
<ul>
<li class="level1"><div class="li"> <strong>user</strong></div>
</li>
<li class="level1"><div class="li"> <strong>password</strong></div>
</li>
</ul>
<p>
Simple usage example:
</p>
<pre class="code">
basic($uid,$_password)
</pre>
</div>
<!-- SECTION "basic" [3395-3857] -->
<h3><a name="unicode2iso" id="unicode2iso">unicode2iso</a></h3>
<div class="level3">
<p>
<p><div class="noteimportant">This function is not compliant with <a href="../../documentation/1.3/safejail.html" class="wikilink1" title="documentation:1.3:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div></p>
</p>
<p>
This function convert a string from UTF-8 to <acronym title="International Organization for Standardization">ISO</acronym>-8859-1.
</p>
<p>
Functions parameters:
</p>
<ul>
<li class="level1"><div class="li"> <strong>string</strong></div>
</li>
</ul>
<p>
Simple usage example:
</p>
<pre class="code">
unicode2iso($name)
</pre>
</div>
<!-- SECTION "unicode2iso" [3858-4162] -->
<h3><a name="iso2unicode" id="iso2unicode">iso2unicode</a></h3>
<div class="level3">
<p>
<p><div class="noteimportant">This function is not compliant with <a href="../../documentation/1.3/safejail.html" class="wikilink1" title="documentation:1.3:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div></p>
</p>
<p>
This function convert a string from <acronym title="International Organization for Standardization">ISO</acronym>-8859-1 to UTF-8.
</p>
<p>
Functions parameters:
</p>
<ul>
<li class="level1"><div class="li"> <strong>string</strong></div>
</li>
</ul>
<p>
Simple usage example:
</p>
<pre class="code">
iso2unicode($name)
</pre>
</div>
<!-- SECTION "iso2unicode" [4163-] --></div><!-- closes <div class="dokuwiki export">-->
|
