# Google Workspace as SAML IDP for SSO

# Preamble

The EE server and client support the SAML protocol that allows you to configure an external service as IDP (identity provider) for SSO (single sign on). This guide here will explain how to configure Google Workspace as SAML IDP for SSO. We assume that Google Workspace can firewall / network wise access your server. In addition we assume that your webclient is running on https://example.com, the server is reachable with https://example.com/server (e.g. https://example.com/server/info/ shows you some nice json output). This is your first SAML provider that you want to configure (therefore we give him the ID "1").

TIP

This feature is only available in the Enterprise Edition.

# Google Workspace

As a first step we have to configure Google Workspace.

Sign in to Google Admin console

Sign in to Google Admin console (opens new window) with an account with super administrator privileges.
Go to Apps > Web and mobile apps

Click on "Add App" and choose "Add custom SAML app".
Configure "Name"

Enter a suitable name for your application and (optional) add a logo. Afterwards click on "continue"
Write down "Identity provider details"

Write down the following three parameters as we need them in a minute.
Configure "Service provider details"

Enter the details as shown below. Adjust the domain according to your setup.
Configure "Attribute mapping"

Configure both our required attributes as shown below
Configure "User Access"

Now we have to select the users (or groups) who will be allowed to login to Psono. Click on this "Arrow down" icon next to "User acces"

For our demo we select "Everyone" yet you can restrict access to certain groups if you want.a

# Server (settings.yaml)

During the installation of the server you have created a settings.yaml that needs to be adjusted now.

Generate SP certificate

You will need a certificate for your service provider (SP) later. You can generate one easily with:
```
openssl req -new -newkey rsa:2048 -x509 -days 3650 -nodes -sha256 -out sp_x509cert.crt -keyout sp_private_key.key
```
This will generate a private key (sp_private_key.key) and the public certificate (sp_x509cert.crt).

Change or add SAML configuration in to settings.yaml. Comments inside the config:

SAML_CONFIGURATIONS:
    1:
        idp:
            entityId: "REPLACE_WITH_ENTITY_ID"
            singleLogoutService:
                binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                url: "https://login.microsoftonline.com/common/wsfederation?wa=wsignout1.0"
            singleSignOnService:
                binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                url: "REPLACE_WITH_SSO_URL"
            x509cert: "CERT_FROM_IDENTITY_PROVIDER"
            groups_attribute: "groups"
            username_attribute: "username"
            email_attribute: "email"
            username_domain: "USER_DOMAIN"
            required_group: []
            is_adfs: true
            honor_multifactors: true
            max_session_lifetime: 43200
        sp:
            NameIDFormat: "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
            assertionConsumerService:
                binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
            attributeConsumingService:
                serviceName: "Psono"
                serviceDescription: "Psono password manager"
                requestedAttributes:
                    -
                        attributeValue: []
                        friendlyName: ""
                        isRequired: false
                        name: "username"
                        nameFormat: ""
            privateKey: "SP_PRIVATE_CERTIFICATE"
            singleLogoutService:
                binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
            x509cert: "SP_X509CERT"
            autoprovision_psono_folder: false
            autoprovision_psono_group: false
        strict: true
        security:
            requestedAuthnContext: false

Change serviceName to match the name of your Google Workspaces
Change USER_DOMAIN to match your domain.tld
Replace REPLACE_WITH_SSO_URL with the "SSO Url" from the Identity Provider details usually something like https://accounts.google.com/...
Replace REPLACE_WITH_ENTITY_ID with the "Entity ID" from the Identity Provider details usually something like https://accounts.google.com/...
Replace CERT_FROM_IDENTITY_PROVIDER with the "Certificate" from previous Identity Provider details configuration. (remove all line breaks)
Replace SP_PRIVATE_CERTIFICATE with the content of the previous generated "sp_private_key.key". (remove all line breaks)
Replace SP_X509CERT with the content of the previous generated "sp_x509cert.crt". (remove all line breaks)

Restart the server afterward

Adjust authentication methods

Make sure that SAML is part of the AUTHENTICATION_METHODS parameter in your settings.yaml e.g.
```
AUTHENTICATION_METHODS: ['SAML']
```
Restart the server afterward
(optional) Debug Mode

It is helpful in the later debugging to enable debug mode.
```
DEBUG: True
```
WARNING

Restart the server afterward and don't forget to remove it before going to production.

# Client (config.json)

Now you have to configure your client, so your users can use this configured IDP.

Basic

Update your config.json similar to the one shown below.
```
{
  ...
    "authentication_methods": ["SAML"],
    "saml_provider": [{
      "title": "SAML Login",
      "provider_id": 1,
      "button_name": "Login "
    }]
  ...
}
```
The variable authentication_methods restricts the allowed login methods. In the example above only SAML will be allowed and the normal login "hidden". The title and button_name can be adjusted however you like. The provider_id needs to match the one that you used on your server.
(optional) Automatic login

You may want to "automatically" click on the login button to initiate the login flow. You can accomplish this by modifying the config.json as shown below:
```
{
  ...
    "authentication_methods": ["SAML"],
    "auto_login": true,
  ...
}
```
WARNING

This will only work if you have just one provider configured with only one authentication method. Users won't be able to modify the server url nor choose to register or interact with the login form in any other way.

← SAML - Microsoft Entra ID (Azure AD) SAML - Keycloak →