authelia/docs/content/en/integration/openid-connect/tailscale/index.md

5.2 KiB

title description lead date draft images menu weight toc community
Tailscale Integrating Tailscale with the Authelia OpenID Connect 1.0 Provider. 2023-04-23T10:06:28+10:00 false
integration
parent
openid-connect
620 true true

Tested Versions

Before You Begin

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Domain Root URL: https://example.com
  • Authelia Root URL: https://auth.example.com
  • Authelia Account: user@example.com
  • Client ID: tailscale
  • Client Secret: insecure_secret

Configuration

The configuration in Authelia is straight forward, Tailscale is just another identity_provider/oidc entry. Tailscale also requires a WebFinger reply for your domain - see the following Application section.

Application

To configure Tailscale to utilize Authelia as a OpenID Connect 1.0 Provider, you will need a public WebFinger reply for your domain (see RFC7033 Section 3.1) and point it to Authelia. The steps necessary are outlined in the Tailscale documentation on Custom OIDC providers KB article. This WebFinger reply is not generated by Authelia, so your external webserver hosted at the root of your domain will need to generate the response (Check See also for example implementations). The following steps are necessary to get Tailscale working with Authelia:

  1. Your domain will need to reply to a WebFinger request for your Authelia account
  2. Your domain root is example.com and the Authelia account in question is user@example.com the WebFinger request will be: https://example.com/.well-known/webfinger/?resource=acct:user@example.com the complete request is https://example.com/.well-known/webfinger?rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer&resource=acct%3Auser%40example.com`
  3. The WebFinger request needs to be answered with the following example reply:
{
  "subject": "acct:user@example.com",
  "links": [{
    "rel": "http://openid.net/specs/connect/1.0/issuer",
    "href": "https://auth.example.com"
  }]
}
  1. For any other users that you want to add to Tailscale, you will need to provide similar WebFinger replies (e.g. for user2@example.com or user3@example.com)
  2. Once you have the WebFinger reply set up and your Authelia OpenID Connect Discovery endpoint is working (e.g. https://auth.example.com/.well-known/openid-configuration), you can sign up for a new Tailnet (migration can only be done if the Tailnet is associated with a custom domain) via the link: Sign up with OIDC where you will see the following screen:
    {{< figure src="tailscale_signup_1.png" alt="Tailscale Signup Screen 1" width="300" >}}
    Note: Even though the WebFinger URL displayed is https://example.com/.well-known/webfinger, the actual GET request will be including request parameters, most importantly resource.
  3. After clicking on Get OIDC Issuer, Tailscale will fetch the WebFinger reply via https://example.com/.well-known/webfinger/?resource=acct:user@example.com and follow the set href to https://auth.example.com/.well-known/openid-configuration.
    Note: Make sure that the href URL matches the issuer URL returned from the Authelia OIDC discovery endpoint
  4. On the next screen you will need to add your client ID & secret configured in Authelia to finish the OIDC provider registration in Tailscale. See the following example screenshot:
    {{< figure src="tailscale_signup_2.png" alt="Tailscale Signup Screen 2" width="300" >}}

Authelia

The following YAML configuration is an example Authelia client configuration for use with Tailscale which will operate with the above 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:
    - id: 'tailscale'
      description: 'Tailscale'
      secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
      redirect_uris:
        - 'https://login.tailscale.com/a/oauth_response'
      scopes:
        - 'openid'
        - 'email'
        - 'profile'

See Also