docs/auth/auth-saml-onelogin.rst

.. _config-saml-onelogin-ref:


SAML 2.0 with One Login
-----------------------

**This plugin is available only in EE Edition.**

|RCE| supports SAML 2.0 Authentication with OneLogin provider. This allows
users to log-in to RhodeCode via SSO mechanism of external identity provider
such as OneLogin. The login can be triggered either by the external IDP, or internally
by clicking specific authentication button on the log-in page.


Configuration steps
^^^^^^^^^^^^^^^^^^^

To configure OneLogin SAML authentication, use the following steps:

1. From the |RCE| interface, select
   :menuselection:`Admin --> Authentication`
2. Activate the `OneLogin` plugin and select :guilabel:`Save`
3. Go to newly available menu option called `OneLogin` on the left side.
4. Check the `enabled` check box in the plugin configuration section,
   and fill in the required SAML information and :guilabel:`Save`, for more details,
   see :ref:`config-saml-onelogin`


.. _config-saml-onelogin:


Example SAML OneLogin configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Example configuration for SAML 2.0 with OneLogin provider::

    *option*: `enabled` => `True`
    # Enable or disable this authentication plugin.

    *option*: `cache_ttl` => `0`
    # Amount of seconds to cache the authentication and permissions check response call for this plugin.
    # Useful for expensive calls like LDAP to improve the performance of the system (0 means disabled).

    *option*: `debug` => `True`
    # Enable or disable debug mode that shows SAML errors in the RhodeCode logs.

    *option*: `entity_id` => `https://app.onelogin.com/saml/metadata/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
    # Identity Provider entity/metadata URI.
    # E.g. https://app.onelogin.com/saml/metadata/<onelogin_connector_id>

    *option*: `sso_service_url` => `https://customer-domain.onelogin.com/trust/saml2/http-post/sso/xxxxxx`
    # SSO (SingleSignOn) endpoint URL of the IdP. This can be used to initialize login
    # E.g. https://app.onelogin.com/trust/saml2/http-post/sso/<onelogin_connector_id>

    *option*: `slo_service_url` => `https://customer-domain.onelogin.com/trust/saml2/http-redirect/slo/xxxxxx`
    # SLO (SingleLogout) endpoint URL of the IdP.
    # E.g. https://app.onelogin.com/trust/saml2/http-redirect/slo/<onelogin_connector_id>

    *option*: `x509cert` => `<CERTIFICATE_STRING>`
    # Identity provider public x509 certificate. It will be converted to single-line format without headers

    *option*: `name_id_format` => `sha-1`
    # The format that specifies how the NameID is sent to the service provider.

    *option*: `signature_algo` => `sha-256`
    # Type of Algorithm to use for verification of SAML signature on Identity provider side

    *option*: `digest_algo` => `sha-256`
    # Type of Algorithm to use for verification of SAML digest on Identity provider side

    *option*: `cert_dir` => `/etc/saml/`
    # Optional directory to store service provider certificate and private keys.
    # Expected certs for the SP should be stored in this folder as:
    #  * sp.key     Private Key
    #  * sp.crt     Public cert
    #  * sp_new.crt Future Public cert
    #
    # Also you can use other cert to sign the metadata of the SP using the:
    #  * metadata.key
    #  * metadata.crt

    *option*: `user_id_attribute` => `PersonImmutableID`
    # User ID Attribute name. This defines which attribute in SAML response will be used to link accounts via unique id.
    # Ensure this is returned from OneLogin for example via Internal ID

    *option*: `username_attribute` => `User.username`
    # Username Attribute name. This defines which attribute in SAML response will map to an username.

    *option*: `email_attribute` => `User.email`
    # Email Attribute name. This defines which attribute in SAML response will map to an email address.



Below is example setup that can be used with OneLogin SAML authentication that can be used with above config..

.. image:: ../images/saml-onelogin-config-example.png
   :alt: OneLogin SAML setup example
   :scale: 50 %


Below is an example attribute mapping set for IDP provider required by the above config.


.. image:: ../images/saml-onelogin-attributes-example.png
   :alt: OneLogin SAML setup example
   :scale: 50 %