Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.36 KB

README.md

File metadata and controls

85 lines (63 loc) · 2.36 KB
Raw

fastcgi-authz-client

Express module to query a FastCGI authorization server

SYNOPSIS

var express = require('express');
var app = express();
var FcgiAuthz = require('fastcgi-authz-client');
var handler = FcgiAuthz({
  host: '127.0.0.1',
  port: 9090
});

app.use(handler);

app.get('/', function(req, res) {
  return res.send('Hello ' + req.upstreamHeaders['auth-user'] + ' !');
});
app.listen(3000, function() {
  return console.log('Example app listening on port 3000!');
});

DESCRIPTION

fastcgi-authz-client is an Express handler that verify upon an upstream FastCGI server if client is authorizated to get this URL (like Nginx auth_request).

This can be used with LemonLDAP::NG in a SSO-as-a-Service (SSOaaS) system.

PARAMETERS

fastcgi-authz-client gives any parameters (except PARAMS) to fastcgi-client. See its documentation for more.

PARAMS parameter

This parameter can be used to add a custom parameter in FastCGI request. For example to give RULES_URL to Lemonldap::NG SSOaaS server:

var express = require('express');
var app = express();
var FcgiAuthz = require('fastcgi-authz-client');
var handler = FcgiAuthz({
  host: '127.0.0.1',
  port: 9090,
  PARAMS: {
    RULES_URL: 'http://my-server/rules.json'
  }
});

app.use(handler);
...

RESPONSE HEADERS

fastcgi-authz-client stores FastCGI response header in req.upstreamHeaders (keys in lower case). You can so use them in Express application (see synopsis)

COPYRIGHT AND LICENSE

Copyright (C) 2018 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/.