Search…
⌃K

Installation - Windows

Install and configuration of Keeper SSO Connect on Windows Server environments.

Install Java Runtime - Required

As described in the System Requirements page, make sure to install a compatible version of the Java runtime.
We recommend installing the OpenJDK 11.0.12 version linked below:
After finishing the Java openJDK installation, you MUST restart windows.
After the reboot, check the java installation version: 1. Open an Administrator Command Prompt. 2. Type java -version. 3. Verify the java version installed is found.
C:\Users\Administrator>java -version
openjdk version "11.0.12" 2021-07-20 LTS
OpenJDK Runtime Environment 18.9 (build 11.0.12+7-LTS)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.12+7-LTS, mixed mode)
Note: If you had a different version of Java installed, we recommend completely uninstalling all Java versions prior to installing the OpenJDK 11.0 or Oracle Java SE 11.0.

Java Issues?

If Java isn't recognized on the command line, follow the steps below.
  • Open 'Advanced system settings'
  • Click Environment Variables. In the section System variables, find thePATH environment variable and select it. Click Edit. If the PATH environment variable does not exist, click New.
  • In the Edit System Variable (or New System Variable) window, specify the value of the PATH environment variable. Click OK. Close all remaining windows by clicking OK.

SSL Certificate

Keeper SSO Connect requires a valid signed SSL certificate that has been signed by a public certificate authority. Self-signed certificates may work for testing however most client applications will fail to connect.
You can obtain an SSL certificate from your web hosting company, or you can utilize one of the no-cost options available such as ZeroSSL. You can also have more control over the steps by using OpenSSL.
There is a known compatibility issue between certificates generated on OpenSSL 3.0 and Java 11. So if you want to use OpenSSL, use the latest 1.1.1 which is 1.1.1s as of November 2022.

Download SSO Connect

To get the download link, in the Keeper admin console under provisioning (in your SSO node), add method "SSO Connect On-Prem".
After adding the provisioning, you will see a button to download Keeper SSO Connect.
Copy the downloaded file to the SSO Connect server.
Download SSO Connect

Download Metadata Files and SSL Certificate

Installation of SSO Connect requires the creation of an SSL certificate file that is utilized for the endpoint. Generate the SSL certificate and download the SSL certificate file (.pfx, .p12, or .jks) and your IDP's SAML XML metadata file to the server.

Installation - Windows

Extract the Keeper SSO Connect installer file.
Run KeeperSSOConnect as Administrator.
The new desktop icon "Keeper SSO Connect" will launch a browser for configuration (we recommend using Google Chrome to perform the initial setup).
If you receive an error connecting to the Keeper SSO Connect service, you need to reboot the server. Also, you need to ensure that your web browser is able to connect to keepersecurity.com over port 443. Keeper SSO Connect does not support the use of proxy servers or firewalls that perform SSL packet inspection.

SSO Connect Web UI Configuration

Login to the SSO Connect Web UI, with a Keeper Administrator Master Password account, by navigating to http://127.0.0.1:8080/config or by utilizing the Keeper SSO Connect Desktop Icon.
NOTE: Utilizing Internet Explorer, to navigate to the SSO Connect Web UI, is NOT recommended. Please utilize a different Web Browser such as Chrome, Edge Chromium, Firefox, etc.
In order to successfully login to the SSO Connect Web UI, you must utilize a Keeper Administrator account in which meet several requirements:
  1. 1.
    The account MUST be a Master Password Authentication account.
  2. 2.
    The account can not live within the SSO provisioning node.
  3. 3.
    The account must be in an Administrative Role in which has Manage Bridge/SSO permissions over the node.
Enter a Two Factor Authentication code if prompted.
Select the SSO Connection (Enterprise Domain).
Once you successfully authenticate Keeper SSO Connect to your Admin Console you will see the status tab:
Select on the Configuration link to begin the setup.
SSO Connect Configuration
Enter the Advertised Hostname or IP Address. This address is what the Keeper client applications navigate to in order to initiate the SSO authentication process. If installing Keeper SSO Connect in an HA (High Availability) configuration, this is the address the that points to the load balancer. This address can be either an IP or a hostname.
Bound IP Address. This is the physical IP address of the NIC on the server. If a hostname is not used and if there is only one address associated with the server this entry will be the same as the Hostname or IP Address field.
In the example above, "sso-1.test-keeper.com" is the Advertised Hostname that gets routed to the local address 10.1.0.4. The Keeper SSO Connect service binds to the Private IP address.
The IP/Hostname must be accessible by users who will be accessing Keeper. You may need to update your firewall to allow access over the IP and port.

SSO Connect SSL Key and Certificate

The Keeper SSO Connect service requires an SSL Certificate. It is recommend to use a proper SSL Certificate signed by a Certificate Authority (CA). The SSL cert can be one generated specifically for the SSO Connect server (hostname or IP address) or a wild card certificate that matches your domain (*.yourcompany.com).
Self-signed certificates will generate security errors for your users on most browsers and mobile devices.
The certificate file type must be .pfx or .p12 for a PKCS 12 certificate or .jks for a Java Key Store certificate. Most Certificate Authorities have instructions on their sites on how to convert to these file type if they did not initially issue these specific formats. For assistance in generating a SSL certificate, please refer to the section on Creating a Certificate.
Note: SSL Certificates may expire annually or quarterly. Please set a reminder to renew your certificate prior to the expiration date to prevent unexpected outages.
PKCS 12 Passphrase
For SSO Connect version prior to 14.1.0 please enter the password in both fields
Select your specific IDP. If your IDP is not in the pull-down menu, select Default.

IdP Metadata

Select your IdP Provider. If your provider is not listed select Default.
The next step is to upload the IdP SAML metadata file. This file can be downloaded from your IdP.

Identity Provider Attribute Mappings

Attribute Mappings do not require any changes. Select Save.

SSO Connect Status

Reasons the Status might be listed as Stopped:
  • Your SSL Certificate is missing or incorrect.
  • The hostname in the SSL certificate doesn’t match the hostname in SSO Connect. A wildcard SSL certificate can be used or you can use a certificate created for the specific hostname. (i.e. if your hostname is Keeper.DOMAIN.com your cert should be set up for *.DOMAIN.com).
  • By default the Use Certificate to Decrypt and Sign SAML Response/Request should be selected.
See the Appendix on creating a self-signed SSL cert if you need to create one for testing or troubleshooting your SSL certificate.

Restarting the Keeper SSO Connect Service on Windows

The Keeper SSO Connect runs as a service on Windows. Closing out the web interface does not stop the service. The service can be stopped and started from the Service MMC in windows.