SAML SSO

SAML SSO Configuration

To use SAML-based SSO: 

1. Login to the system with administrator privileges. 

2. In the Administration module, go to Authentication Providers | SAML SSO. 

   JFrog Cloud New Interface (Beta)

   On the taskbar, click(Platform Configurations), and select User Authentication > SAML SSO. To learn more, click here. 

3. Enable the SAML integration by checking the Enable SAML Integration checkbox. 

4. Enable or disable Auto Create Artifactory Users (Using SAML login). If enabled, new users will persist in the database. 

5. Enable or disable Allow Created Users Access to Profile Page. If enabled users will be able to access their profile without having to provide a password.

6. Provide the SAML Login URL and SAML Logout URL.

   SAML Logout URL

   To simultaneously logout from your SAML provider and the JFrog Platform, you need to correctly set your provider's logout URL SAML Logout URL field. Setting this incorrectly will keep your users logged in with the SAML provider even after logging out from the system.

7. Provide the service provider name (Platform name in SAML federation)

8. Provide the X.509 certificate that contains the public key. The public key can use either the DSA or RSA algorithms. The Platform uses this key to verify SAML response origin and integrity. Make sure to match the embedded public key in the X.509 certificate with the private key used to sign the SAML response.

SAML SSO Configuration with Okta

To use SAML SSO with Okta:

1. Log in to Okta with administrator privileges.
2. In the Administration module, select Add Application | Create New App | SAML 2.0.
   
   
3. Enter the App name: <desired_app_name>, and click Next.
4. In the SAML Settings enter the following:

   • Single Sign-On URL for Artifactory 6.X version.
     

     https://${ARTIFACTORY_URL}/webapp/saml/loginResponse

     Example

     https://yourcompany.jfrog.io/yourcompany/webapp/saml/loginResponse

   • Single Sign-On URL for Artifactory 7.X version.

       https://${ARTIFACTORY_URL}/ui/api/v1/auth/saml/loginResponse

     Example

      https://yourcompany.jfrog.io/ui/api/v1/auth/saml/loginResponse  

   • Audience URI (SP Entity ID).  

     https://${ARTIFACTORY_URL}

     Example

     https://yourcompany.jfrog.io/yourcompany

   • Name ID Format: Unspecified
     
   • Application username: Okta username

     

     You can log into Artifactory with Okta by using the username of a user's email address (i.e. "admin" from "admin@company.com"). Choose Custom instead of Okta username and add String.substringBefore(user.email, "@") into the Custom Rule. 

5. Click Next and then click Finish.
   A SAML 2.0 frame is displayed under the Settings frame.
   
6. Click View Setup Instructions.
7. Copy the data from the text boxes and paste them in Artifactory's SAML SSO settings.

To use SAML SSO with Artifactory: 

1.  Log into Artifactory with administrator privileges.

2.  From Administration |  Authentication Providers | SAML Integration define the fields in below. 

   Okta	Artifactory
   Identity Provider Single Sign-On URL	SAML Login URL
   https://<Account_Name>.okta.com	SAML Logout URL
   Identity Provider Issuer	SAML Service Provider Name
   X.509 Certificate	SAML Certificate

3. Click Save.
4. Logout from Artifactory and go to the Login page.
5. Click SSO Login.

SAML-Based SSO Login Process

1. The user attempts to reach a hosted JFrog Platform, Home Page. 

2. The Platform generates a SAML authentication request. 

3. The SAML request is encoded and embedded into the identity provider URL. 

4. The Platform sends a redirect to the user's browser. The redirect URL includes the encoded SAML authentication request that should be submitted to the identity provider. 

5. The identity provider decodes the SAML message and  authenticates the user. The authentication process can proceed by asking for valid login credentials or by checking for valid session cookies. 

6. The identity provider  generates a SAML response that contains the authenticated user's username. In accordance with the SAML 2.0 specification, this response is digitally signed with the identity provider’s private DSA/RSA keys. 

7. The identity provider encodes the SAML response and returns that information to the user's browser. The identity provider redirects back to the Platform with the signed response. 

8. The Platform’s ACS verifies the SAML response using the partner's public key. If the response is successfully verified, the ACS redirects the user to the destination URL. 

9. The user has been redirected to the destination URL and is logged in to the Platform. 

   

   
   

SAML-Based SSO Logout Process

1. The user attempts to reach a hosted JFrog Platform logout link. 
2. The Platform logs the client out and generates a SAML logout request. 
3. The Platform redirects to the identity provider with the encoded SAML logout request.
   
4. The identity provider decodes the SAML message and logs the user out.
5. The user is redirected to the configured URL in the identity provider. 

Profiles and Bindings

The JFrog Platform currently supports the Web Browser SSO and Single Logout Profiles. 

The Web Browser SSO Profile uses HTTP redirect binding to send the AuthnRequest from the service provider to the identity provider, and HTTP POST to send the authentication response from the identity provider to the service provider. 

Similar to the previous profile, the Single Logout Profile uses HTTP redirect binding to send the LogoutRequest from the service provider to the identity provider and HTTP POST to send the logout response from the identity provider to the service provider. 

If your IDP supports uploading service provider metadata, you can use the following metadata XML:

<ns2:EntityDescriptor xmlns="http://www.w3.org/2000/09/xmldsig#" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:metadata"  	entityID="<SP_NAME_IN_FEDERATION>">    	      			  
	<ns2:SPSSODescriptor WantAssertionsSigned="true" AuthnRequestsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"> 
		<ns2:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</ns2:NameIDFormat> 
		<ns2:AssertionConsumerService index="1" Location="<PLATFORM_URL>/artifactory/webapp/saml/loginResponse" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
	</ns2:SPSSODescriptor> 
</ns2:EntityDescriptor>

To use the service provider metadata:

Do not forget to update the following fields in the service provider metadata XML. 

• entityID: the Platform ID in the federation. Must match SAML Service Provider Name in the Platform's SAML configuration page.
• Location: the Platform home URLAfter SAML Setup

Using SAML, the Platform automatically redirects the request to IDP which Authenticates the user and after a successful login redirects back to the Platform. 

If Anonymous User is enabled, the Platform doesn’t have to authenticate the user therefore it doesn’t redirect to the IDP. If the user still wants to sign in through SAML, they can do so by clicking the SSO login link in the login page.

Login Failure

In case of IDP failover or bad configuration, the JFrog Platform allows you to bypass SAML login by using the JFrog Platform login page:

http://<SERVER_HOSTNAME>:8082/ui/login

This URL can be used by internal users who need to log in directly to the JFrog Platform.

Using API Key with SAML Users

While SAML provides access to the JFrog Platform UI, it is also possible for SAML users to generate an API Key that can be used instead of a password for basic authentication or in a dedicated REST API header, this is very useful when working with different clients, e.g. Docker, npm, Maven, etc. or using REST API.

In order to allow SAML users access to an API key you will need to make sure that the Auto Create Artifactory Users and Allow Created Users Access To Profile Page check boxes are checked. This means that SAML users are also saved in the Platform database and can access their User Profile in order to generate, retrieve and revoke their API key.