Skip to content
tnganPublic

Repository files navigation

samlify

Build Status npm version NPM Coverage

Node.js library for SAML SSO

Installation

npm install samlify

Schema validation

samlify validates every incoming SAML message against the XML schema, so register a schema validator before anything else. Pick one of the validator modules:

import * as samlify from 'samlify';
import * as validator from '@authenio/samlify-xsd-schema-validator'; // requires Java
// import * as validator from '@authenio/samlify-validate-with-xmllint'; // requires xmllint
// import * as validator from '@authenio/samlify-node-xmllint';

samlify.setSchemaValidator(validator);

You can also supply your own validator. Skipping validation means accepting messages that may be malicious, so only do this if you understand the risk:

samlify.setSchemaValidator({
  validate: (response: string) => {
    /* implement your own, or always resolve to skip validation */
    return Promise.resolve('skipped');
  }
});

Get Started

const saml = require('samlify');

See the full documentation here.

Example

samlify-starter — starter example for getting up and running with samlify

Development

yarn
yarn test

PRs are welcome, as are links to examples that use samlify with other frameworks. See CONTRIBUTING.md.

Talks

An introduction to Single Sign On

License

MIT

Copyright

Copyright (C) 2016-present Tony Ngan, released under the MIT License.

Releases

Sponsor this project

Packages

Used by

Contributors

Languages