File: extendedfunctions.html

package info (click to toggle)
lemonldap-ng 1.9.7-3%2Bdeb9u2
links: PTS, VCS
area: main
in suites: stretch
size: 39,024 kB
sloc: perl: 37,552; makefile: 922; sh: 472; sql: 5
file content (363 lines) | stat: -rw-r--r-- 14,889 bytes
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
  <meta charset="utf-8" />
  <title>documentation:1.9:extendedfunctions</title>
<meta name="generator" content="DokuWiki"/>
<meta name="robots" content="index,follow"/>
<meta name="keywords" content="documentation,1.9,extendedfunctions"/>
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/>
<link rel="start" href="extendedfunctions.html"/>
<link rel="contents" href="extendedfunctions.html" title="Sitemap"/>
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/>
<!-- //if:usedebianlibs
  <link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" />
//elsif:useexternallibs
  <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script>
//elsif:cssminified
  <link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" />
//else -->
  <link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" />
<!-- //endif -->
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:1.9';var JSINFO = {"id":"documentation:1.9:extendedfunctions","namespace":"documentation:1.9"};
/*!]]>*/</script>
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script>
<!-- //if:usedebianlibs
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script>
//elsif:useexternallibs
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script>
//elsif:jsminified
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script>
//else -->
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script>
<!-- //endif -->
<!-- //if:usedebianlibs
  <script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script>
//elsif:useexternallibs
  <script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script>
//elsif:jsminified
  <script type="text/javascript" src="/lib/scripts/jquery-ui.min.js"></script>
//else -->
  <script type="text/javascript" src="/lib/scripts/jquery-ui.js"></script>
<!-- //endif -->
</head>
<body>
<div class="dokuwiki export container">
<!-- TOC START -->
<div id="dw__toc">
<h3 class="toggle">Table of Contents</h3>
<div>

<ul class="toc">
<li class="level1"><div class="li"><a href="#presentation">Presentation</a></div></li>
<li class="level1"><div class="li"><a href="#request_informations">Request informations</a></div></li>
<li class="level1"><div class="li"><a href="#extended_functions_list">Extended Functions List</a></div>
<ul class="toc">
<li class="level2"><div class="li"><a href="#date">date</a></div></li>
<li class="level2"><div class="li"><a href="#checklogonhours">checkLogonHours</a></div></li>
<li class="level2"><div class="li"><a href="#checkdate">checkDate</a></div></li>
<li class="level2"><div class="li"><a href="#basic">basic</a></div></li>
<li class="level2"><div class="li"><a href="#unicode2iso">unicode2iso</a></div></li>
<li class="level2"><div class="li"><a href="#iso2unicode">iso2unicode</a></div></li>
<li class="level2"><div class="li"><a href="#groupmatch">groupMatch</a></div></li>
</ul></li>
</ul>
</div>
</div>
<!-- TOC END -->

<h1 class="sectionedit1" id="extended_functions">Extended functions</h1>
<div class="level1">

</div>
<!-- EDIT1 SECTION "Extended functions" [1-34] -->
<h2 class="sectionedit2" id="presentation">Presentation</h2>
<div class="level2">

<p>
When <a href="writingrulesand_headers.html" class="wikilink1" title="documentation:1.9:writingrulesand_headers">writing rules and headers</a>, you can use Perl 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="portalmenu.html#menu_modules" class="wikilink1" title="documentation:1.9:portalmenu">Menu modules activation rules</a></div>
</li>
<li class="level1"><div class="li"> <a href="formreplay.html" class="wikilink1" title="documentation:1.9: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 Perl subroutines (split, pop, map, etc.)</div>
</li>
<li class="level1"><div class="li"> <a href="customfunctions.html" class="wikilink1" title="documentation:1.9: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 <em>(be careful with it: you must add an empty string as second argument to avoid inserting “newline” codes)</em></div>
</li>
<li class="level1"><div class="li"> Environment variables, in some cases (through %ENV)</div>
</li>
<li class="level1"><div class="li"> <a href="#request_informations" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">Informations about current request</a></div>
</li>
<li class="level1"><div class="li"> <a href="#extended_functions_list" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">Extended functions</a>:</div>
<ul>
<li class="level2"><div class="li"> <a href="#date" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">date</a></div>
</li>
<li class="level2"><div class="li"> <a href="#checklogonhours" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">checkLogonHours</a></div>
</li>
<li class="level2"><div class="li"> <a href="#checkdate" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">checkDate</a></div>
</li>
<li class="level2"><div class="li"> <a href="#basic" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">basic</a></div>
</li>
<li class="level2"><div class="li"> <a href="#unicode2iso" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">unicode2iso</a></div>
</li>
<li class="level2"><div class="li"> <a href="#iso2unicode" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">iso2unicode</a></div>
</li>
<li class="level2"><div class="li"> <a href="#groupmatch" title="documentation:1.9:extendedfunctions ↵" class="wikilink1">groupMatch</a></div>
</li>
</ul>
</li>
</ul>
<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>
</div>
<!-- EDIT2 SECTION "Presentation" [35-1217] -->
<h2 class="sectionedit3" id="request_informations">Request informations</h2>
<div class="level2">

<p>
The following data about the current request are available through functions :
</p>
<ul>
<li class="level1"><div class="li"> hostname</div>
</li>
<li class="level1"><div class="li"> remote_ip: the client <abbr title="Internet Protocol">IP</abbr> address</div>
</li>
<li class="level1"><div class="li"> uri: <abbr title="Uniform Resource Locator">URL</abbr> path</div>
</li>
<li class="level1"><div class="li"> uri_with_args: <abbr title="Uniform Resource Locator">URL</abbr> path with query string</div>
</li>
<li class="level1"><div class="li"> unparsed_uri: <abbr title="Uniform Resource Locator">URL</abbr> path, before <abbr title="Uniform Resource Locator">URL</abbr> decoding</div>
</li>
<li class="level1"><div class="li"> args: the query string</div>
</li>
<li class="level1"><div class="li"> method: the request method (GET, POST etc.)</div>
</li>
<li class="level1"><div class="li"> header_in(“Your-Request-Header”): any request header</div>
</li>
</ul>

</div>
<!-- EDIT3 SECTION "Request informations" [1218-1624] -->
<h2 class="sectionedit4" id="extended_functions_list">Extended Functions List</h2>
<div class="level2">

</div>
<!-- EDIT4 SECTION "Extended Functions List" [1625-1661] -->
<h3 class="sectionedit5" id="date">date</h3>
<div class="level3">

<p>
Returns the date, in format YYYYMMDDHHMMSS, local time by default, GMT by calling 
</p>
<pre class="code">date(1)</pre>

</div>
<!-- EDIT5 SECTION "date" [1662-1781] -->
<h3 class="sectionedit6" id="checklogonhours">checkLogonHours</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.
All e
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>
<div class="notetip">The <a href="authldap.html#schema_extension" class="wikilink1" title="documentation:1.9: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>
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">All e
checkLogonHours($ssoLogonHours, &#039;octetstring&#039;)</pre>

<p>
You can also configure jetlag (if all of your users use the same timezone):
</p>
<pre class="code">checkLogonHours($ssoLogonHours, &#039;&#039;, &#039;+2&#039;)</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, &#039;&#039;, $_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, &#039;&#039;, &#039;&#039;, &#039;1&#039;)</pre>

</div>
<!-- EDIT6 SECTION "checkLogonHours" [1782-3719] -->
<h3 class="sectionedit7" id="checkdate">checkDate</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>
<div class="notetip">The <a href="authldap.html#schema_extension" class="wikilink1" title="documentation:1.9:authldap">LDAP schema extension</a> can be used to store these values
</div>
<p>
The date format is the LDAP 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>
<!-- EDIT7 SECTION "checkDate" [3720-4347] -->
<h3 class="sectionedit8" id="basic">basic</h3>
<div class="level3">
<div class="noteimportant">This function is not compliant with <a href="safejail.html" class="wikilink1" title="documentation:1.9:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div>
<p>
This function builds the <code>Authorization</code> HTTP header used in <a href="applications/authbasic.html" class="wikilink1" title="documentation:1.9:applications:authbasic">HTTP Basic authentication scheme</a>. It will force conversion from UTF-8 to ISO-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>
<!-- EDIT8 SECTION "basic" [4348-4810] -->
<h3 class="sectionedit9" id="unicode2iso">unicode2iso</h3>
<div class="level3">
<div class="noteimportant">This function is not compliant with <a href="safejail.html" class="wikilink1" title="documentation:1.9:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div>
<p>
This function convert a string from UTF-8 to ISO-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>
<!-- EDIT9 SECTION "unicode2iso" [4811-5115] -->
<h3 class="sectionedit10" id="iso2unicode">iso2unicode</h3>
<div class="level3">
<div class="noteimportant">This function is not compliant with <a href="safejail.html" class="wikilink1" title="documentation:1.9:safejail">Safe jail</a>, you will need to disable the jail to use it.
</div>
<p>
This function convert a string from ISO-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>
<!-- EDIT10 SECTION "iso2unicode" [5116-5420] -->
<h3 class="sectionedit11" id="groupmatch">groupMatch</h3>
<div class="level3">

<p>
this function allows to parse the <code>$hGroups</code> variable to check if a value is present inside a group attribute.
</p>

<p>
Function parameter:
</p>
<ul>
<li class="level1"><div class="li"> <strong>groups</strong>: <code>$hGroups</code> variable</div>
</li>
<li class="level1"><div class="li"> <strong>attribute</strong>: Name of group attribute</div>
</li>
<li class="level1"><div class="li"> <strong>value</strong>: Value to check</div>
</li>
</ul>

<p>
Simple usage example:
</p>
<pre class="code">groupMatch($hGroups, &#039;description&#039;, &#039;Service 1&#039;)</pre>

</div>
<!-- EDIT11 SECTION "groupMatch" [5421-] --></div>
</body>
</html>