Setting up SAML 1.1 for Polaris
SAML is an XML-based standard for exchanging authentication data between a service provider (such as Polaris) and an identity provider. It allows users to employ web browser single sign-on.
If you want to use SAML with Polaris and you aren’t already enrolled with a SAML identity provider, Replicon can provide you with one that you can set up on a server in your network. Follow the procedure given on this topic to set it up.
If you want to use a different identity provider, contact Replicon Support for information on how to configure your provider to work with Polaris.
Polaris also supports SAML 2.0, although Replicon does not host an identity provider for it.
For information on setting up SSO based on an OpenID Connect provider, refer to Setting up single sign-on.
For information on assigning SAML authentication settings to users, refer to Setting up users for single sign-on.
To set up your identity provider and enable SAML in Polaris:
- Extract the SAML identity provider files
- Set up IIS
- Set up the identity provider
- Set up Polaris
- Set up employees to use SAML
Extract the SAML identity provider files
- Download the SAMLIdentityProvider.zip file.
- Extract the zip file. We recommend extracting to one of these locations:
-
- C:\Program Files\Replicon Inc\SAML Identity Provider for 32 bit systems
- C:\Program Files(x86)\Replicon Inc\SAML Identity Provider for 64 bit systems
Set up IIS
Use your system’s Internet Information Services (IIS) Manager to carry out the following procedures.
Create a new IIS virtual directory pointing to the folder created
In IIS 6.0
Right-click the web site name, and select New > Virtual Directory. In the window that displays, in the Alias field, enter SAML; in the Path field, browse to and select the location of the SAML folder you created. Click Next.
Under Allow the following permissions, ensure Read and Execute permissions are enabled.
In IIS 7.0 and higher
Right-click the web site name, and select Add Virtual Directory. In the window that displays, in the Alias field, enter SAML; in the Physical Path field, browse to and select the location of the SAML folder you created. Click OK.
To assign permissions for the directory, in the Features View, select Handler Mappings. Right-click the ISAPI.dll and select Edit Feature Permissions. In the window that displays, enable Read and Execute permissions. Click OK.
Create an IIS application called SAML
In IIS 6.0
Right-click the SAML directory and select Properties. On the Virtual Directory tab, click the Create button located in the Application settings area. Select OK.
In IIS 7.0
First ensure that Connect As is set as Application user (pass-through authentication) and that DynamicCompressionModule and StaticCompressionModule are removed from the Modules section. Then, right-click the SAML directory and select Convert to Application, and select OK.
Select authentication settings:
In IIS 6.0:
- Right-click the Default.aspx file in the SAML application you created, and select Properties.
- On the File Security tab, select Edit…
- On the Authentication Methods page that displays, disable anonymous access, and ensure Integrated Windows Authentication is the only option enabled.
In IIS 7.0:
- Select the SAML application, select the Content View, right-click the Default.aspx file, select Switch to Features View.
- From the Default.aspx Home (Features View), select Authentication.
- Right-click each item that displays: enable Windows Authentication, and disable all the other authentication types.
- In the left menu, select Application Pools.
- Right-click on the application pool that corresponds to your SAML application, and select Advanced Settings.
- In the window that displays, find the Managed Pipeline Mode field, and set it to Classic mode.
- The application pool should ideally be on the Network Service.
Set up the identity provider
- Open the directory to which you extracted SAMLIdentityProvider.zip.
- Open the Web.config file in a text editor, such as Notepad.
- Find the following line of code:
<add key="ServiceProviderURL" value="https://service.url/path/saml.ashx" />
Modify the line to include your Polaris installation’s URL:
<add key="ServiceProviderURL" value="https://global.replicon.com/!/saml/CompanyKey" /> (1)
- Confirm that your SAML server is using official time. Refer to https://www.time.gov/ to set the time.
- In the directory to which you extracted SAMLIdentityProvider.zip:
-
- Open the bin sub-directory.
- Run Replicon.Security.CertificateGenerator.exe as an administrator.
It will create two new files in that sub-directory: private.pfx and public.cer
Enable SAML authentication in Polaris
- Log in to Polaris.
- Go to Administration > System and Security > Security Settings.
- From the Authentication Providers section, click the Add Authentication Provider link.
An Add Authentication Provider dialog displays.
- From the Provider Type drop-down in the dialog that displays, select SAML 1.1.
- Complete the two additional fields that display:
-
- Target URL
In this field, enter the full server:port number2 for the virtual directory you created. This URL must include the 'target' parameter. It should look something like this:
https://servername:portnumber/SAML?target={0}2
- Target URL
-
- Public key
In this field, upload the public.cer file from the bin directory you generated when setting up the identity provider.
- Public key
- Select Save.
Set up employees to use SAML
To set up users:
- Log in to Polaris.
- Go to Administration > Employees and Organization > Users.
- Select a user to edit.
- From the Authentication Type field, select SSO.
- Enter the user’s Windows/NT/AD user name in the Login Name field.
- Click Save User Profile.
These users can log in to Polaris at https://servername:portnumber/SAML. (2)
-------------------------
(1) Your CompanyKey is the name of your company (i.e. the name you used when you created your instance, and the name users enter in the Company field on the Polaris login page).
(2) The port number can be excluded if you are using port 80.
Related topics
Using SAML for single sign on
Setting up SAML 2.0 for Polaris
Using single sign on with Polaris
Setting up users for single sign on authentication