customfunctions.html 8.01 KB
Newer Older
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
1 2 3 4 5 6
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
  <meta charset="utf-8" />
  <title>documentation:2.0:customfunctions</title>
<meta name="generator" content="DokuWiki"/>
Xavier Guimard's avatar
Xavier Guimard committed
7
<meta name="robots" content="index,follow"/>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
8 9 10 11 12
<meta name="keywords" content="documentation,2.0,customfunctions"/>
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/>
<link rel="start" href="customfunctions.html"/>
<link rel="contents" href="customfunctions.html" title="Sitemap"/>
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/>
Xavier Guimard's avatar
Xavier Guimard committed
13 14 15 16 17 18 19 20 21
<!-- //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 -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
22 23 24
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:2.0';var JSINFO = {"id":"documentation:2.0:customfunctions","namespace":"documentation:2.0"};
/*!]]>*/</script>
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script>
Xavier Guimard's avatar
Xavier Guimard committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38
<!-- //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
Xavier Guimard's avatar
Xavier Guimard committed
39
  <script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.min.js"></script>
Xavier Guimard's avatar
Xavier Guimard committed
40
//else -->
Xavier Guimard's avatar
Xavier Guimard committed
41
  <script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.js"></script>
Xavier Guimard's avatar
Xavier Guimard committed
42
<!-- //endif -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56
</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="#write_custom_functions_library">Write custom functions library</a></div></li>
<li class="level1"><div class="li"><a href="#import_custom_functions_in_lemonldapng">Import custom functions in LemonLDAP::NG</a></div>
<ul class="toc">
<li class="level2"><div class="li"><a href="#declare_module_in_handler_server">Declare module in handler server</a></div>
<ul class="toc">
Xavier Guimard's avatar
Xavier Guimard committed
57 58
<li class="level3"><div class="li"><a href="#new_method">New method</a></div></li>
<li class="level3"><div class="li"><a href="#old_method">Old method</a></div></li>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
</ul>
</li>
<li class="level2"><div class="li"><a href="#declare_custom_functions">Declare custom functions</a></div></li>
</ul>
</li>
<li class="level1"><div class="li"><a href="#use_it">Use it</a></div></li>
</ul>
</div>
</div>
<!-- TOC END -->

<h1 class="sectionedit1" id="custom_functions">Custom functions</h1>
<div class="level1">

<p>
Xavier Guimard's avatar
Xavier Guimard committed
74
Custom functions allow one to extend <abbr title="LemonLDAP::NG">LL::NG</abbr>, they can be used in <a href="writingrulesand_headers.html#headers" class="wikilink1" title="documentation:2.0:writingrulesand_headers">headers</a>, <a href="writingrulesand_headers.html#rules" class="wikilink1" title="documentation:2.0:writingrulesand_headers">rules</a> or <a href="formreplay.html" class="wikilink1" title="documentation:2.0:formreplay">form replay data</a>.
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
75 76 77
</p>

</div>
Xavier Guimard's avatar
Xavier Guimard committed
78
<!-- EDIT1 SECTION "Custom functions" [1-219] -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
79 80 81 82 83 84 85 86 87 88
<h2 class="sectionedit2" id="write_custom_functions_library">Write custom functions library</h2>
<div class="level2">

<p>
Create your Perl module with custom functions. You can name your module as you want, for example <code>SSOExtensions.pm</code>:
</p>
<pre class="code">vi /root/SSOExtensions.pm</pre>
<pre class="code file perl"><a href="http://perldoc.perl.org/functions/package.html"><span class="kw3">package</span></a> SSOExtensions<span class="sy0">;</span>
&nbsp;
<span class="kw2">sub</span> function1 <span class="br0">&#123;</span>
Xavier Guimard's avatar
Xavier Guimard committed
89
  <span class="kw1">my</span> <span class="br0">&#40;</span><span class="re0">@args</span><span class="br0">&#41;</span> <span class="sy0">=</span> <span class="co5">@_</span><span class="sy0">;</span>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
90 91
&nbsp;
  <span class="co1"># Your nice code here</span>
Xavier Guimard's avatar
Xavier Guimard committed
92
  <a href="http://perldoc.perl.org/functions/return.html"><span class="kw3">return</span></a> <span class="re0">$result</span><span class="sy0">;</span>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
93 94 95 96 97
<span class="br0">&#125;</span>
&nbsp;
<span class="nu0">1</span><span class="sy0">;</span></pre>

</div>
Xavier Guimard's avatar
Xavier Guimard committed
98
<!-- EDIT2 SECTION "Write custom functions library" [220-554] -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
99 100 101 102
<h2 class="sectionedit3" id="import_custom_functions_in_lemonldapng">Import custom functions in LemonLDAP::NG</h2>
<div class="level2">

</div>
Xavier Guimard's avatar
Xavier Guimard committed
103
<!-- EDIT3 SECTION "Import custom functions in LemonLDAP::NG" [555-608] -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
104 105 106 107 108
<h3 class="sectionedit4" id="declare_module_in_handler_server">Declare module in handler server</h3>
<div class="level3">

</div>

Xavier Guimard's avatar
Xavier Guimard committed
109
<h4 id="new_method">New method</h4>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
110 111
<div class="level4">

Xavier Guimard's avatar
Xavier Guimard committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
<p>
Just declare files or Perl module that must be loaded:
</p>
<pre class="code file :ini"><span class="re0"><span class="br0">&#91;</span>all<span class="br0">&#93;</span></span>
<span class="re1">require</span> <span class="sy0">=</span><span class="re2"> /path/to/functions.pl, /path/to/func2.pm</span>
# OR
<span class="re1">require</span> <span class="sy0">=</span><span class="re2"> My::Func1, My::Func2</span></pre>

</div>

<h4 id="old_method">Old method</h4>
<div class="level4">
<div class="notewarning">This method is available but unusable by Portal under Apache. So if your rule may be used by the menu, use the new method.
</div>
</div>

<h5 id="apache">Apache</h5>
<div class="level5">

Clément OUDOT's avatar
New doc  
Clément OUDOT committed
131 132 133 134 135 136 137 138 139 140
<p>
Your module has to be loaded by Apache (for example after Handler load):
</p>
<pre class="code file apache"><span class="co1"># Perl environment</span>
PerlRequire Lemonldap::NG::Handler
PerlRequire /root/SSOExtensions.pm
PerlOptions +GlobalRequest</pre>

</div>

Xavier Guimard's avatar
Xavier Guimard committed
141 142
<h5 id="fastcgi_server_nginx">FastCGI server (Nginx)</h5>
<div class="level5">
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

<p>
You&#039;ve just to incicate to <a href="fastcgiserver.html" class="wikilink1" title="documentation:2.0:fastcgiserver">LLNG FastCGI server</a> the file to read using either <code>-f</code> option or <code>CUSTOM_FUNCTIONS_FILE</code> environment variable. Using packages, you just have to modify your <code>/etc/default/llng-fastcgi-server</code> (or <code>/etc/default/lemonldap-ng-fastcgi-server</code>) file:
</p>
<pre class="code file sh"># Number of process (default: 7)
#NPROC = 7
&nbsp;
# Unix socket to listen to
SOCKET=/var/run/llng-fastcgi-server/llng-fastcgi.sock
&nbsp;
# Pid file
PID=/var/run/llng-fastcgi-server/llng-fastcgi-server.pid
&nbsp;
# User and GROUP
USER=www-data
GROUP=www-data
&nbsp;
# Custom functions file
CUSTOM_FUNCTIONS_FILE=/root/SSOExtensions.pm</pre>

</div>
Xavier Guimard's avatar
Xavier Guimard committed
164
<!-- EDIT4 SECTION "Declare module in handler server" [609-1892] -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
165 166 167 168 169 170 171 172 173 174
<h3 class="sectionedit5" id="declare_custom_functions">Declare custom functions</h3>
<div class="level3">

<p>
Go in Manager, <code>General Parameters</code> » <code>Advanced Parameters</code> » <code>Custom functions</code> and set:
</p>
<pre class="code">SSOExtensions::function1</pre>
<div class="noteimportant">If your function is not compliant with <a href="safejail.html" class="wikilink1" title="documentation:2.0:safejail">Safe jail</a>, you will need to disable the jail.
</div>
</div>
Xavier Guimard's avatar
Xavier Guimard committed
175
<!-- EDIT5 SECTION "Declare custom functions" [1893-2189] -->
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
176 177 178 179 180 181
<h2 class="sectionedit6" id="use_it">Use it</h2>
<div class="level2">

<p>
You can now use your function in a macro, an header or an access rule, for example:
</p>
Xavier Guimard's avatar
Xavier Guimard committed
182
<pre class="code">Custom-Header =&gt; function1( $uid, $ENV{REMOTE_ADDR} )</pre>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
183 184

</div>
Xavier Guimard's avatar
Xavier Guimard committed
185
<!-- EDIT6 SECTION "Use it" [2190-] --></div>
Clément OUDOT's avatar
New doc  
Clément OUDOT committed
186 187
</body>
</html>