Skip to content

Latest commit

 

History

History
302 lines (230 loc) · 9.26 KB

README.md

File metadata and controls

302 lines (230 loc) · 9.26 KB
Raw

Lemonldap::NG handler for Node.js

Beta Lemonldap::NG handler for node.js

SYNOPSIS

lemonldap-ng.ini

...
[node-handler]

nodeVhosts = test.example.com, test2.example.com

Express app

// Variables
var express = require('express');
var app = express();
var handler = require('lemonldap-ng-handler');

// initialize handler (optional args)
handler.init({
  configStorage: {
    "confFile":"test/lemonldap-ng.ini"
  }
});

// and load it
app.use(handler.run);

// Then simply use your express app
app.get('/', function(req, res) {
  return res.send('Hello ' + req.headers['Auth-User'] + ' !');
});
app.listen(3000, function() {
  return console.log('Example app listening on port 3000!');
});

Nginx authorization server

FastCGI server:

var handler = require('lemonldap-ng-handler');

handler.init({
  configStorage: {
    "confFile": "/path/to/lemonldap-ng.ini"
  }
});

handler.nginxServer({
  "mode": "fcgi",   // or "http", default: fcgi
  "port": 9090,     // default value
  "ip": 'localhost' // default value
});

Nginx configuration. For more, see Nginx configuration on LLNG website

server {
  listen 19876;
  server_name test.example.com;
  root /home/xavier/dev/lemonldap/e2e-tests/conf/site;

  # Internal authentication request
  location = /lmauth {
    internal;
    include /etc/nginx/fastcgi_params;
    fastcgi_pass localhost:9090;

    # Drop post datas
    fastcgi_pass_request_body  off;
    fastcgi_param CONTENT_LENGTH "";

    # Keep original hostname
    fastcgi_param HOST $http_host;

    # Keep original request (LLNG server will received /llauth)
    fastcgi_param X_ORIGINAL_URI  $request_uri;
  }

  # Client requests
  location / {
    auth_request /lmauth;
    auth_request_set $lmremote_user $upstream_http_lm_remote_user;
    auth_request_set $lmlocation $upstream_http_location;
    error_page 401 $lmlocation;
    include conf/nginx-lua-headers.conf;
  }

}

DESCRIPTION

Lemonldap::NG is a complete Web-SSO system that can run with reverse-proxies or directly on application webservers. It can be used in conjunction with OpenID-Connect, CAS and SAML systems as identity or service provider. It can also be used as proxy between those federation systems.

It manages both authentication and authorization and provides headers for accounting. So you can have a full AAA protection. Authorization are built by associating a regular expression and a rule. Regular expression is applied on the requested URL and the rule calculates if the user is authorized.

LLNG is designed in 3 kinds of elements:

  • a portal
  • a manager
  • some handlers for Apache, Plack family, Node.js
  • some FastCGI servers to provide Nginx handler or SSOaaS:
    • pure Perl (default)
    • uWSGI (Perl via uwsgi-psgi plugin)
    • this Node.js module

This module provide the Node.js handler and the FastCGI server.

See Lemonldap::NG website for more.

INSTALLATION

Of course, you must have a LemonLDAP::NG system installed in your organization. To install node handler, use simply:

npm install lemonldap-ng-handler

CONFIGURATION

Configuration file (lemonldap-ng.ini)

Node-lemonldap-ng-handler uses LemonLDAP::NG configuration file, sections [configuration] and [node-handler].

Sections [all] and [configuration]

Nothing to change, but lemonldap-ng-handler isn't compatible with all LLNG backends. See below.

Loggers

lemonldap-ng-handler is compatible with the following loggers:

  • Lemonldap::NG::Common::Logger::Std : use console.log
  • Lemonldap::NG::Common::Logger::Syslog : use Syslog (install modern-syslog to use it)
  • UWSGI : usable only under uwsgi V8 plugin. Override logger in section [nginx-handler] in your [lemonldap-ng.ini] file

New section [node-handler]

You can overwrite here LemonLDAP::NG configuration keys. You must set the list of virtual hosts handled by node.js in key nodeVhosts.

Example:

[node-handler]
nodeVhosts = test1.example.com, test2.example.com

Rules and headers must be written in Javascript, not in Perl. Example:

default: $uid == 'dwho'
^/deny : deny

You'll have a warning in the manager when saving this rules since Perl doesn't understand Javascript.

Note that handler section isn't read by lemonldap-ng-handler.

Configuration backends

Node-lemonldap-ng-handler is compatible with the following Lemonldap::NG backends:

  • File
  • YAMLFile
  • REST
  • LDAP
  • MongoDB (without authentication neither ssl for now)
  • CDBI / RDBI (MySQL, PostgreSQL and SQLite3 only). Note that you must install nodedbi and needed dependencies. Example with PostgreSQL (Debian):
$ sudo apt-get install libdbi-dev libdbd-pgsql
$ npm install nodedbi

Sessions backends

Node-lemonldap-ng-handler is compatible with the following Lemonldap::NG backends:

Note that fo SQL backends, you must install nodedbi and needed dependencies. Example with PostgreSQL (Debian/Ubuntu):

$ sudo apt-get install libdbi-dev libdbd-pgsql
$ npm install nodedbi

Special handlers

Node-lemonldap-ng-handler can be used as

You just have to specify "type":<type> in init() arguments. Example:

handler.init({
  "type": "DevOps",
  "configStorage": {
    "confFile": "/path/to/lemonldap-ng.ini"
  }
});

METHODS

init()

Takes an optional object argument with the following optional keys:

  • configStorage: object
  • type: special handler (see "Special handlers section")

run()

Used by express to handle requests. Arguments:

  • req: the express request
  • res: the express response
  • next: next function in stack

nginxServer

Launch Nginx compatible authorization server. Takes an optional object as argument. Keys:

  • mode: server mode, "fcgi" or "http", defult to "fcgi"
  • port: port to listen to
  • ip: ip address to listen to

TODO

  • Custom functions
  • Think to menu problem
  • REST backends

CHANGELOG

See CHANGELOG

BUG REPORT AND OTHER ISSUES

Use OW2 system to report bug or ask for features: LLNG OW2 GitLab

Note: uWGI isn't supported because V8 plugin for uWSGI isn't compatible with async

DOWNLOAD

Lemonldap::NG is available at https://gitlab.ow2.org/lemonldap-ng/lemonldap-ng/tags

This library is available at https://github.com/LemonLDAPNG/lemonldap-ng-handler

COPYRIGHT AND LICENSE

Copyright (C) 2016-2019 by Xavier Guimard

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.