@maderaunified/musd-saml
Madera Unified SAML Implementation
Last updated a month ago by maderaunified .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @maderaunified/musd-saml 
SYNC missed versions from official npm registry.

@maderaunified/musd-saml

Madera Unified SAML Implementation

Install

$ npm install @maderaunified/musd-saml

Usage

const musdSAML = require("@maderaunified/musd-saml");

const app = express();

// Express Setup

musdSAML.init( app );

// Create Server, etc.

Methods

init( app, [userModel] )

Use init to instantiate all routes and initiate SAML strategies. Profile is object returned to service provider. Application can define it's own object to send to the client

const userModel = ( profile, done ) => 
    done( null, {
        email          : profile.nameID,
        employeeType   : profile.employeeType,
        employeeNumber : profile.employeeNumber
    } );

musdSAML.init( app, userModel );

isAuth( req )

Returns boolean value as to whether the user is logged in

router.get(
    '/route',
    ( req, res ) => {
        if ( isAuth( req ) ) {
            res.render(
                config.routes.appView,
                {
                    user : req.user
                }
            );
        }
        else {
            res.render(
                config.routes.appView,
                {
                    user : null
                }
            );
        }
    }
);

Environment Variables

Required

  • APP_ROUTE - Home page route for application ( Can be url if API and Client are separate )
    • default : '/'
  • SAML_ISSUER - Accessing URL. Change to be application specific
  • HOST - URL for callback
  • PROTOCOL - Protocol for callback
    • default - http://
  • KEY_PATH - local path to Madera Certificate Key
  • PUB_KEY_PATH - local path to Madera Public Certificate
  • LDAP_PATH - URL to Madera AD Server
  • LDAP_BASEDN - BASE DN for Madera LDAP Server
  • LDAP_USERNAME - User with access to Madera LDAP Server
  • LDAP_PASSWORD - Password for user to Madera LDAP Server

Optional

  • APP_VIEW - view to load for app route

    • default : 'index'
  • LOGIN_ROUTE - Route for login. Recommend not change

    • default : '/login'
  • LOGOUT_ROUTE - Route used for logout. Recommend not change

    • default : '/logout'
  • USER_ROUTE - Route to access user information

    • default : '/user'
  • USER_VIEW - View to load for user route

    • default : 'user'
  • SAML_PATH - Callback point for SAML provider. Recommend not change

    • default : '/login/callback'
  • SAML_ENTRY_POINT - Identity Provider Entry Point. Recommend not change

  • SAML_LOGOUT_URL - Identity Provider Logout Point. Recommend not change

  • IDENTIFIER_FORMAT - nameID format. Recommend not change

    • default : 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'

Current Tags

  • 3.0.2                                ...           latest (a month ago)

34 Versions

  • 3.0.2                                ...           a month ago
  • 3.0.1                                ...           a month ago
  • 3.0.0                                ...           a month ago
  • 2.1.6                                ...           3 months ago
  • 2.1.5                                ...           3 months ago
  • 2.1.4                                ...           3 months ago
  • 2.1.3                                ...           3 months ago
  • 2.1.2                                ...           3 months ago
  • 2.0.3                                ...           3 months ago
  • 2.0.2                                ...           3 months ago
  • 2.0.1                                ...           3 months ago
  • 2.0.0                                ...           5 months ago
  • 1.1.2                                ...           5 months ago
  • 1.1.1                                ...           5 months ago
  • 1.1.0                                ...           5 months ago
  • 1.0.18                                ...           5 months ago
  • 1.0.17                                ...           5 months ago
  • 1.0.16                                ...           5 months ago
  • 1.0.15                                ...           5 months ago
  • 1.0.14                                ...           5 months ago
  • 1.0.13                                ...           5 months ago
  • 1.0.12                                ...           6 months ago
  • 1.0.11                                ...           6 months ago
  • 1.0.10                                ...           6 months ago
  • 1.0.9                                ...           6 months ago
  • 1.0.8                                ...           6 months ago
  • 1.0.7                                ...           6 months ago
  • 1.0.6                                ...           6 months ago
  • 1.0.5                                ...           6 months ago
  • 1.0.4                                ...           6 months ago
  • 1.0.3                                ...           6 months ago
  • 1.0.2                                ...           6 months ago
  • 1.0.1                                ...           6 months ago
  • 1.0.0                                ...           6 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 905
Dependencies (10)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |