LL::NG manages applications by their hostname (Apache Virtual Hosts or Nginx Block Servers). Rules are used for protecting applications, and HTTP headers are appended to each request for sending data to protected applications (for logs, profiles,...).
Attention
Note that variables designed by $xx correspond to the name of the exported variables or macro names except for $ENV{<cgi-header>} which correspond to CGI headers ($ENV{REMOTE_ADDR} for example).
The %ENV hash provides:
See also extended functions.
Tip
You can use %ENV hash or $env hash ref. Both syntaxes are available for compatibity.
$ENV{REMOTE_ADDR} and $env->{REMOTE_ADDR} are similar.
A rule associates a regular expression to a Perl boolean expression or a keyword.
Examples:
Goal | Regular expression | Rule |
---|---|---|
Restrict /admin/ directory to user bart.simpson | ^/admin/ | |
Restrict /js/ and /css/ directory to authenticated users | ^/(css|js)/ | accept |
Deny access to /config/ directory | ^/config/ | deny |
Do not restrict /public/ | ^/public/ | skip |
Do not restrict /skip/ and restrict other to authenticated users | ^/skip/ | $ENV{REQUEST_URI} =~ /skip/ ? skip : 1 |
Makes authentication optional, but authenticated users are seen as such (that is, user data are sent to the app through HTTP headers) | ^/forum/ | unprotect |
Restrict access to the whole site to users that have the LDAP description field set to “LDAP administrator” (must be set in exported variables) | default |
The “default” access rule is used if none rule matches the current URL.
Tip
See the rule examples page for few common use cases
Tip
Rules can also be used for intercepting logout URL:
Goal | Regular expression | Rule |
---|---|---|
Logout user from Lemonldap::NG and redirect it to http://intranet/ | ^/index.php\?logout | logout_sso http://intranet/ |
Logout user from current application and redirect it to the menu (Apache only) | ^/index.php\?logout | logout_app https://auth.example.com/ |
Logout user from current application and from Lemonldap::NG and redirect it to http://intranet/ (Apache only) | ^/index.php\?logout | logout_app_sso http://intranet/ |
Danger
For logout_app and logout_app_sso rules to work with Nginx, you need lua module, and you must enable nginx-lua-headers.conf. Also, make sure the header_filter_by_lua and corresponding error_page directives are present in the appropriate “location” section. See test-nginx.conf for more information.
By default, users will be redirected to the Portal if no URL is defined, or to the specified URL if exists.
Attention
Only current application is concerned by logout_app* targets. Be careful with some applications which does not check headers sent by LL::NG after having created their own application cookies. If so, you can redirect users to a HTML page that explain that it is better to close browser after logout.
LL::NG set an “authentication level” during authentication process. This level depends on authentication backend used by this user. Default values are:
There are three ways to impose users a higher authentication level:
Tip
Instead of returning a 403 code, “minimum level” returns users to a form that explains that a higher level is required and propose to reauthenticate himself.
Headers are associations between an header name and a perl expression that returns a value. Headers are used for sending user data to protected applications.
Examples:
Goal | Header name | Header value |
---|---|---|
Give the uid (for accounting) | Auth-User | $uid |
Give a static value | Some-Thing | “static-value” |
Give display name | Display-Name | “$givenName $surName” |
Give a non ASCII data | Display-Name |
As described in performances chapter, you can use macros, local macros,...
Attention
Tip
By default, SSO cookie is hidden. So protected applications cannot retrieve SSO session key. But you can forward this key if absolutely needed (NOT recommanded because can be a security issue):
Session-ID => $_session_id
In addition to macros and name, you can use some functions in rules and headers:
Since 2.0, a wildcard can be used in virtualhost name (not in
aliases !): *.example.com matches all hostnames that belong to
example.com domain. Version 2.0.9 improves this and allows better
wildcards such as test-*.example.com or test-%.example.com. The
% wilcard doesn’t match subdomains.
Even if a wildcard exists, if a VirtualHost is explicitly declared, this rule will be applied. Example with precedence order for test.sub.example.com: