Skip to content
This repository has been archived by the owner on Jun 29, 2023. It is now read-only.
/ fleet Public archive
forked from kolide/fleet

Latest commit

 

History

History
69 lines (45 loc) · 3.5 KB

single-sign-on.md

File metadata and controls

69 lines (45 loc) · 3.5 KB
Raw

Configuring Single Sign On

Fleet supports SAML single sign on capability. This feature is convenient for users and offloads responsibility for user authentication to a third party identity provider such as Salesforce or Onelogin. Fleet supports the SAML Web Browser SSO Profile using the HTTP Redirect Binding.

Identity Provider (IDP) Configuration

Several items are required to configure an IDP to provide SSO services to Fleet. Note that the names of these items may vary from provider to provider and may not conform to the SAML spec. Individual users must also be setup on the IDP before they can sign in to Fleet. The particulars of setting up the connected application (Fleet) and users will vary for different identity providers but will generally require the following information.

  • Assertion Consumer Service - This is the call back URL that the identity provider will use to send security assertions to Fleet. The value that you supply will be a fully qualified URL consisting of your Fleet web address and the callback path /api/v1/kolide/sso/callback. For example, if your Fleet web address is https://fleet.acme.org, then the value you would use in the identity provider configuration would be:

    https://fleet.acme.org/api/v1/kolide/sso/callback

  • Entity ID - This value is a URI that you define. It identifies your Fleet instance as the service provider that issues authorization requests. The value must exactly match the Entity ID that you define in the Fleet SSO configuration.

  • Name ID Format - The value should be urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress. This may be shortened in the IDP setup to email or similar.

  • Subject Type - username.

    Example IDP Configuration

    Example IDP Configuration

The IDP will generate an issuer URI and a metadata URL that will be used to configure Fleet as a service provider.

Fleet SSO Configuration

A user must be an admin to configure Fleet for SSO. The SSO configuration is found in App Settings. The following values are required.

  • Identity Provider Name - A human friendly name of the IDP.

  • Entity ID - A URI that identifies your Fleet instance as the issuer of authorization requests. Assuming your company name is Acme, an example might be fleet.acme.org although the value could be anything as long as it is unique to Fleet as a service provider and matches the entity provider value used in the IDP configuration.

  • Issuer URI - This value is obtained from the IDP.

  • Metadata URL - This value is obtained from the IDP and is used by Fleet to issue authorization requests to the IDP.

  • Metadata - If the IDP does not provide a metadata URL, the metadata must be obtained from the IDP and entered. Note that the metadata URL is preferred if the IDP provides metadata in both forms.

Example Fleet SSO Configuration

Example SSO Configuration

Creating SSO Users in Fleet

When an admin invites a new user to Fleet, they may select the Enable SSO option. The SSO enabled users will not be able to sign in with a regular user ID and password. It is strongly recommended that at least one admin user is set up to use the traditional password based log in so that there is a 'back door' to log into Fleet and modify the SSO configuration in the event of problems.

SAML Bindings

SAML Profiles