opkssh

Tested Versions#

• Authelia
  • v4.39.4
• opkssh
  • v0.7.0

Before You Begin#

Common Notes#

1. The OpenID Connect 1.0 client_id parameter:
   1. This must be a unique value for every client.
   2. The value used in this guide is merely for readability and demonstration purposes and you should not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ. We recommend 64 random characters but you can use any arbitrary value that meets the other criteria.
   3. This must only contain RFC3986 Unreserved Characters.
   4. This must be no more than 100 characters in length.
2. The OpenID Connect 1.0 client_secret parameter:
   1. The value used in this guide is merely for demonstration purposes and you should absolutely not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ.
   2. This string may be stored as plaintext in the Authelia configuration but this behaviour is deprecated and is not guaranteed to be supported in the future. See the Plaintext guide for more information.
   3. When the secret is stored in hashed form in the Authelia configuration (heavily recommended), the cost of hashing can, if too great, cause timeouts for clients. See the Tuning the work factors guide for more information.
3. The configuration example for Authelia:
   1. Only contains an example configuration for the client registration and you MUST also configure the required elements from the OpenID Connect 1.0 Provider Configuration guide.
   2. Only contains a small portion of all of the available options for a registered client and users may wish to configure portions that are not part of this guide or configure them differently, as such it’s important to both familiarize yourself with the other options available and the effect of each of the options configured in this section by looking at the OpenID Connect 1.0 Clients Configuration guide.

Assumptions#

This example makes the following assumptions:

• Authelia Root URL: https://auth.example.com/
• Client ID: opkssh

Some of the values presented in this guide can automatically be replaced with documentation variables.

Set Documentation Variables

Configuration#

Authelia#

The following YAML configuration is an example Authelia client configuration for use with opkssh which will operate with the application example:

identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'opkssh'
        client_name: 'opkssh'
        public: true
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - 'http://localhost:3000/login-callback'
          - 'http://localhost:10001/login-callback'
          - 'http://localhost:11110/login-callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'offline_access'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
          - 'refresh_token'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'none'

Configuration Escape Hatch#

The following is an example of adaptation to the above configuration that works around the fact this client does not support OpenID Connect 1.0:

identity_providers:
  oidc:
    claims_policies:
      opkssh:
        id_token: ['email']
    clients:
      - client_id: 'opkssh'
        claims_policy: 'opkssh'

Application#

To configure opkssh to utilize Authelia as an OpenID Connect 1.0 Provider:

Server#

To configure opkssh there is one method, using the Configuration File.

Configuration File#

To configure opkssh to utilize Authelia as an OpenID Connect 1.0 Provider, use the following configuration:

https://auth.example.com/ opkssh 24h

In addition to above, the CLI will need to be used to map users manually.

For example allow the user john@example.com to login as root :

opkssh add root john@example.com https://auth.example.com/

Client#

To log in using Authelia run:

opkssh login --provider=https://auth.example.com/,opkssh

Configuration File#

To create a persistent configuration, generate a new configuration file by running the following command:

opkssh login --create-config

Then add Authelia to the existing providers:

providers:
  - alias: authelia
    issuer: https://auth.example.com
    client_id: opkssh
    scopes: openid offline_access profile email
    access_type: offline
    prompt: consent
    redirect_uris:
      - http://localhost:3000/login-callback
      - http://localhost:10001/login-callback
      - http://localhost:11110/login-callback

You can now run opkssh login to login.

See Also#

• opkssh Custom OpenID Providers