# SAML Identity Provider

## Presentation

LL::NG can act as an SAML 2.0 Identity Provider, that can allow one to federate LL::NG with:

- Another LL::NG system configured with SAML authentication

- Any SAML Service Provider

## Configuration

### SAML Service

See SAML service configuration chapter.

### IssuerDB

Go in `General Parameters` » `Issuer modules` » `SAML` and configure:

- Activation: set to `On`.

- Path: keep `^/saml/` unless you have change SAML end points suffix in SAML service configuration.

- Use rule: a rule to allow user to use this module, set to `1` to always allow.

Tip

For example, to allow only users with a strong authentication level:

    $authenticationLevel > 2

### Register LemonLDAP::NG on partner Service Provider

After configuring SAML Service, you can export metadata to your partner Service Provider.

They are available at the Metadata URL, by default: http://auth.example.com/saml/metadata.

You can also use http://auth.example.com/saml/metadata/idp to have only IDP related metadata.

In both cases, the entityID of the LemonLDAP::NG server is http://auth.example.com/saml/metadata

### Register partner Service Provider on LemonLDAP::NG

In the Manager, select node SAML service providers and click on `Add SAML SP`.

The SP name is asked, enter it and click OK.

Now you have access to the SP parameters list.

#### Metadata

You must register SP metadata here. You can do it either by uploading the file, or get it from SP metadata URL (this require a network link between your server and the SP).

Tip

You can also edit the metadata directly in the textarea

#### Exported attributes

For each attribute, you can set:

- Variable name: name of the variable in LemonLDAP::NG session

- Attribute name: name of the SAML attribute that will be seen by applications

- Friendly Name: optional, friendly name of the SAML attribute seen by applications

- Mandatory: if set to “On”, then this attribute is required to build the SAML response, an error will displayed if there is no value for it. Optional attribute will be sent only if there is a value associated. Else it just will be sent through an attribute response, if explicitly requested in an attribute request.

- Format: optional, SAML attribute format.

#### Options

##### Authentication response

- Default NameID format: if no NameID format is requested, or the NameID format undefined, this NameID format will be used. If no value, the default NameID format is Email.

- Force NameID session key: if empty, the NameID mapping defined in SAML service configuration will be used. You can force here another session key that will be used as NameID content.

- One Time Use: set the OneTimeUse flag in authentication response (`<Condtions>`).

- sessionNotOnOrAfter duration: Time in seconds, added to authentication time, to define sessionNotOnOrAfter value in SAML response (`<AuthnStatement>`):

    <saml:AuthnStatement AuthnInstant="2014-07-21T11:47:08Z"
      SessionIndex="loVvqZX+Vja2dtgt/N+AymTmckGyITyVt+UJ6vUFSFkE78S8zg+aomXX7oZ9qX1UxOEHf6Q4DUstewSJh1uK1Q=="
      SessionNotOnOrAfter="2014-07-21T15:47:08Z">

- notOnOrAfter duration: Time in seconds, added to authentication time, to define notOnOrAfter value in SAML response (`<Condtions>` and `<SubjectConfirmationData>`):

    <saml:SubjectConfirmationData NotOnOrAfter="2014-07-21T12:47:08Z"
      Recipient="http://simplesamlphp.example.com/simplesamlphp/module.php/saml/sp/saml2-acs.php/default-sp"
      InResponseTo="_3cfa896ab05730ac81f413e1e13cc42aa529eceea1"/>

    <saml:Conditions NotBefore="2014-07-21T11:46:08Z"
      NotOnOrAfter="2014-07-21T12:48:08Z">

Attention

There is a time tolerance of 60 seconds in `<Conditions>`

- Force UTF-8: Activate to force UTF-8 decoding of values in SAML attributes. If set to 0, the value from the session is directly copied into SAML attribute.

##### Signature

These options override service signature options (see SAML service configuration).

- Signature method: the algorithm used to sign messages sent to this service

- Signing key name: Since `2.22.0`. If you want to use a specific signing key only for responses sent to this RP, indicate the name of a key from the key management section. If you specify multiple values separated by a comma, the first key will be used for signing responses, and the others will be published in metadata if you use the `/saml/metadata/idp?sp=<entityid>` endpoint

- Sign SSO message: Sign SSO message

- Check SSO message signature: “On” means that LemonLDAP::NG will verify signatures if IDP and SP metadata require it. “Off” will disable signature verification entirely.

- Sign SLO message: Sign SLO message

- Check SLO message signature

##### Security

- Encryption mode: set the encryption mode for this SP (None, NameID or Assertion).

- Enable use of IDP initiated URL: set to `On` to enable IDP Initiated URL on this SP.

- Required authentication level: required authentication level to access this SP. Since `2.21.0` this can be a Perl expression.

- Access rule: lets you specify a Perl rule to restrict access to this SP

##### Federation

See Connect to SAML Federations

##### Metadata URL

Store the URL that can be used to refresh metadata

##### Comment: set a comment

#### Macros

You can define here macros that will be only evaluated for this service, and not registered in the session of the user.

#### Extra variables

The following environment variables are available in SAML access rules and macros:

- `$env->{llng_saml_sp}` : entityID of the SAML service

- `$env->{llng_saml_spconfkey}` : configuration key of the SAML service

Added in version 2.0.10.

- `$env->{llng_saml_acs}` : AssertionConsumerServiceURL, if specified in the AuthnRequest

#### IDP Initiated mode

The IDP Initiated URL is the SSO SAML URL with GET parameters:

- `IDPInitiated`: `1`

- One of:

  - `sp`: Service Provider entity ID

  - `spConfKey`: Service Provider configuration key

For example: http://auth.example.com/saml/singleSignOn?IDPInitiated=1&spConfKey=simplesamlphp

- Optionally, if you may also specify, in addition to `sp` or `spConfKey`:

  - `spDest`: URL of Service Provider’s AssertionConsumerService

The URL specified in `spDest` must be present in the Service Provider metadata registered in LemonLDAP::NG. This is only useful if your Service Provider is reachable over multiple URLs.

## Known issues

Using both Issuer::SAML and Auth::SAML on the same LLNG may have some side-effects on single-logout.