xo-server-auth-saml

SAML authentication plugin for XO-Server

This plugin allows SAML users to authenticate to Xen-Orchestra.

The first time a user signs in, XO will create a new XO user with the same identifier.

Install

Installation of the npm package:

> npm install --global xo-server-auth-saml

Usage

This plugin is based on passport-saml, see its documentation for more information about the configuration.

To enable this plugin you have to add the following lines into the configuration file of XO-Server:

plugins:

  auth-saml:
      # Server certificate used to validate in Base64 (no comments, no line breaks).
      cert: 'MIIFBjCCAu4CCQDBMhqko5KQODANBgkqhkiG9w0BAQ ...'

      # Identity provider entry point (sign in URL).
      entryPoint: 'https://saml.example.org/signin/'

      # Issuer string to supply the identity provider.
      issuer: 'xen-orchestra'

      # Field to use as the name of the user.
      #
      # Default: uid.
      usernameField: 'uid'

Important: When registering your instance to your identity provider, you must configure its callback URL to http://xo.company.net/signin/saml/callback!

Development

Installing dependencies

> npm install

Compilation

The sources files are watched and automatically recompiled on changes.

> npm run dev

Tests

> npm run test-dev

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

report any issue you've encountered;
fork and create a pull request.

1.9 KiB Raw Blame History