Skip to content
Connect2id

Deployment checklist

These are the minimum required steps to setup a Connect2id server for use in production:

  1. Set the Java system property env to prod, which will trigger several extra configuration security checks when the server starts up.

    -Denv=prod
    
  2. Generate an AES key to encrypt sensitive material in the Connect2id server key store (since v17.0). Deployments that choose to use the static key store mode must manually generate a new server JWK set with the provided tool.

  3. Set the URL which identifies the Connect2id server as an OpenID provider and OAuth 2.0 authorisation server.

  4. Set the URL of the login page for the Connect2id server.

  5. Set the URL of the logout page, if one is required.

  6. Generate master tokens for the Connect2id server web APIs and save their SHA-256 hashes in the configuration. Each token must consist of at least 32 random characters. On Linux you can generate a token with pwgen 32 and compute its hash with sha256sum

    Script to generate a 32 character token and compute its SHA-256 hash in hex:

    #! /bin/sh
    TOKEN=`pwgen 32 1`
    echo "Access token: $TOKEN"
    TOKEN_SHA256=`echo -n $TOKEN | sha256sum`
    echo "Access token SHA-256: $TOKEN_SHA256"
    
  7. Set the maximum expected length of the local user IDs, required for the computation of pairwise subject IDs.

  8. Set up a database for the Connect2id server to persist its own data, such as client registrations and authorisations.

  9. Connect one or more OpenID claims sources, required for the UserInfo endpoint. The Connect2id server comes with ready connectors for sourcing user attributes from an LDAP directory, an HTTP endpoint (web hook) or the user session object. To use a different source create your own connector.

  10. Deploy to a DMZ if the client applications are going to access the Connect2id server from the Internet (recommended).

To support a FAPI security profile a few additional configurations are needed.