Tailscale
Tested Versions
Before You Begin
Common Notes
- The OpenID Connect 1.0
client_id
parameter:- This must be a unique value for every client.
- The value used in this guide is merely for demonstration purposes and you can theoretically use nearly any alphanumeric string.
- The OpenID Connect 1.0
secret
parameter:- The value used in this guide is merely for demonstration purposes and you should absolutely not use this in production and should instead utilize the How Do I Generate Client Secrets FAQ.
- 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.
- The Configuration example for Authelia is only a portion of the required configuration and it should be used as a guide in conjunction with the standard OpenID Connect 1.0 Configuration guide.
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:
- Your domain will need to reply to a WebFinger request for your Authelia account
- Your domain root is
example.com
and the Authelia account in question isuser@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` - 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"
}]
}
- 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
oruser3@example.com
) - 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:
Note: Even though the WebFinger URL displayed ishttps://example.com/.well-known/webfinger
, the actual GET request will be including request parameters, most importantlyresource
. - 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 sethref
tohttps://auth.example.com/.well-known/openid-configuration
.
Note: Make sure that thehref
URL matches theissuer
URL returned from the Authelia OIDC discovery endpoint - 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:
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 SSO
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
- Tailscale Custom OIDC providers KB article
- RFC7033 Section 3.1 WebFinger: Identity Provider Discovery for OpenID Connect
- WebFinger example implementations