Roundcube

Roundcube

This integration guide is community supported. It's not guaranteed to be complete, accurate, or up-to-date. It's likely that if this integration guide does not work for you that changes occurred with a third-party application.

Important Note: This documentation is version specific. Make sure you check the section outlining the tested versions.

Important Note: We always recommend users read the third-party documentation as part of the integration process to ensure configuration elements matches their needs. As such the See Also section is likely to have important links.

Important Note: If you find an error in this documentation please make a Pull Request, start a Discussion, or contact us on a Chat Room.

Tested Versions

Before You Begin

Important Reading

This section contains important elements that you should carefully consider before configuration of an OpenID Connect 1.0 Registered Client.

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:

  • Application Root URL: https://roundcube.example.com/
  • Authelia Root URL: https://auth.example.com/
  • Client ID: roundcube
  • Client Secret: insecure_secret

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

Configuration

Authelia

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

configuration.yml
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: 'roundcube'
        client_name: 'Roundcube'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        redirect_uris:
          - 'https://roundcube.example.com/oauth/callback/'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_post'

Application

Configure Roundcube OAuth2 to use Authelia as an OpenID Connect 1.0 Provider. Edit your Roundcube /etc/roundcube/config.inc.php configuration file and add the following:

// Most probably you need this
$config['use_https'] = true;

$config['oauth_provider'] = 'generic';
$config['oauth_provider_name'] = 'Authelia OIDC';
$config['oauth_client_id'] = 'roundcube';
$config['oauth_client_secret'] = 'insecure_secret';
$config['oauth_auth_uri'] = 'https://auth.example.com/api/oidc/authorization';
$config['oauth_token_uri'] = 'https://auth.example.com/api/oidc/token';
$config['oauth_identity_uri'] = 'https://auth.example.com/api/oidc/userinfo';
$config['oauth_identity_fields'] = ['email'];
$config['oauth_scope'] = 'email openid profile';
// Optionally, skip Roundcube's login page
// $config['oauth_login_redirect'] = true;

Important Note

Roundcube’s redirect URI is not configurable, but is dynamically built with bits coming from the FCGI environment: <scheme>://<fqdn>[:<port>]/.... Specifically, the FQDN comes from the HTTP_HOST header. With Authelia, non-localhost HTTP redirection is not allowed, thus you might want to force HTTPS via Roundcube’s conf flag use_https. However, the redirection breaks when the upstream application is listening on a explicit port, because the resulting redirect URI would be something like https://<fqdn>:<port>/.... Thus, to obtain the correct redirect URI https://<fqdn>/..., your reverse proxy’s fastcgi parameter SERVER_PORT should be unset.

IMAP and SMTP backend configuration:

  • For an IMAP instance on localhost, the default conf should be enough. Otherwise, set the corresponding SSL/TLS options via ‘imap_host’ and ‘imap_conn_options’;
  • For a SMTP instance on localhost, no auth would be required. However Roundcube OAuth enforces ‘smtp_auth_type’ = ‘XOAUTH2’ plus credentials, thus you must use TLS or SSL via smtp_host and smtp_conn_options!

Dovecot

Dovecot OAuth2 configuration goes into two files.

Common configuration

Normally in file /etc/dovecot/dovecot.conf or one of its ancillary files in /etc/dovecot/conf.d/:

auth_mechanisms = $auth_mechanisms oauthbearer xoauth2

passdb {
  args = /etc/dovecot/dovecot-oauth2.conf.ext
  driver = oauth2
  mechanisms = xoauth2 oauthbearer
}

# Optional for Postfix SASL on smtpd/submission
service auth {
  unix_listener /var/spool/postfix/private/auth {
    group = postfix
    mode = 0666
    user = postfix
  }
}

Backend configuration

As defined above, in file, /etc/dovecot/dovecot-oauth2.conf.ext:

introspection_mode = post
introspection_url = https://roundcube:insecure_secret@auth.example.com/api/oidc/introspection
username_attribute = username

Important Note

The client ID and secret must figure as credentials in the introspection_url.

Postfix

Even though no authentication would be required when your Postfix instance is on the same host, Roundcube OAuth2 enforces ‘XOAUTH2’ auth type plus credentials and gives up the SMTP + SSL/TLS handshaking as no auth options would be offered from Postfix. Thus, Postfix must be configured with (Dovecot-type) SASL on port 25 (smtpd) or 587 (submission), with the following minimum set of options:

smtpd_sasl_auth_enable = yes
smtpd_sasl_path = private/auth
smtpd_sasl_security_options = noanonymous, noplaintext
smtpd_sasl_tls_security_options = noanonymous
smtpd_sasl_type = dovecot

See Also