Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into preauthkey-tags
- Loading branch information
Showing
27 changed files
with
959 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| package cli | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net" | ||
| "os" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "github.com/oauth2-proxy/mockoidc" | ||
| "github.com/rs/zerolog/log" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| const ( | ||
| errMockOidcClientIDNotDefined = Error("MOCKOIDC_CLIENT_ID not defined") | ||
| errMockOidcClientSecretNotDefined = Error("MOCKOIDC_CLIENT_SECRET not defined") | ||
| errMockOidcPortNotDefined = Error("MOCKOIDC_PORT not defined") | ||
| accessTTL = 10 * time.Minute | ||
| refreshTTL = 60 * time.Minute | ||
| ) | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(mockOidcCmd) | ||
| } | ||
|
|
||
| var mockOidcCmd = &cobra.Command{ | ||
| Use: "mockoidc", | ||
| Short: "Runs a mock OIDC server for testing", | ||
| Long: "This internal command runs a OpenID Connect for testing purposes", | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| err := mockOIDC() | ||
| if err != nil { | ||
| log.Error().Err(err).Msgf("Error running mock OIDC server") | ||
| os.Exit(1) | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| func mockOIDC() error { | ||
| clientID := os.Getenv("MOCKOIDC_CLIENT_ID") | ||
| if clientID == "" { | ||
| return errMockOidcClientIDNotDefined | ||
| } | ||
| clientSecret := os.Getenv("MOCKOIDC_CLIENT_SECRET") | ||
| if clientSecret == "" { | ||
| return errMockOidcClientSecretNotDefined | ||
| } | ||
| portStr := os.Getenv("MOCKOIDC_PORT") | ||
| if portStr == "" { | ||
| return errMockOidcPortNotDefined | ||
| } | ||
|
|
||
| port, err := strconv.Atoi(portStr) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| mock, err := getMockOIDC(clientID, clientSecret) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| listener, err := net.Listen("tcp", fmt.Sprintf("mockoidc:%d", port)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| err = mock.Start(listener, nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| log.Info().Msgf("Mock OIDC server listening on %s", listener.Addr().String()) | ||
| log.Info().Msgf("Issuer: %s", mock.Issuer()) | ||
| c := make(chan struct{}) | ||
| <-c | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func getMockOIDC(clientID string, clientSecret string) (*mockoidc.MockOIDC, error) { | ||
| keypair, err := mockoidc.NewKeypair(nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| mock := mockoidc.MockOIDC{ | ||
| ClientID: clientID, | ||
| ClientSecret: clientSecret, | ||
| AccessTTL: accessTTL, | ||
| RefreshTTL: refreshTTL, | ||
| CodeChallengeMethodsSupported: []string{"plain", "S256"}, | ||
| Keypair: keypair, | ||
| SessionStore: mockoidc.NewSessionStore(), | ||
| UserQueue: &mockoidc.UserQueue{}, | ||
| ErrorQueue: &mockoidc.ErrorQueue{}, | ||
| } | ||
|
|
||
| return &mock, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Running headscale behind a reverse proxy | ||
|
|
||
| Running headscale behind a reverse proxy is useful when running multiple applications on the same server, and you want to reuse the same external IP and port - usually tcp/443 for HTTPS. | ||
|
|
||
| ### WebSockets | ||
|
|
||
| The reverse proxy MUST be configured to support WebSockets, as it is needed for clients running Tailscale v1.30+. | ||
|
|
||
| WebSockets support is required when using the headscale embedded DERP server. In this case, you will also need to expose the UDP port used for STUN (by default, udp/3478). Please check our [config-example.yaml](https://github.com/juanfont/headscale/blob/main/config-example.yaml). | ||
|
|
||
| ### TLS | ||
|
|
||
| Headscale can be configured not to use TLS, leaving it to the reverse proxy to handle. Add the following configuration values to your headscale config file. | ||
|
|
||
| ```yaml | ||
| server_url: https://<YOUR_SERVER_NAME> # This should be the FQDN at which headscale will be served | ||
| listen_addr: 0.0.0.0:8080 | ||
| metrics_listen_addr: 0.0.0.0:9090 | ||
| tls_cert_path: "" | ||
| tls_key_path: "" | ||
| ``` | ||
|
|
||
| ## nginx | ||
|
|
||
| The following example configuration can be used in your nginx setup, substituting values as necessary. `<IP:PORT>` should be the IP address and port where headscale is running. In most cases, this will be `http://localhost:8080`. | ||
|
|
||
| ```Nginx | ||
| map $http_upgrade $connection_upgrade { | ||
| default keep-alive; | ||
| 'websocket' upgrade; | ||
| '' close; | ||
| } | ||
| server { | ||
| listen 80; | ||
| listen [::]:80; | ||
| listen 443 ssl http2; | ||
| listen [::]:443 ssl http2; | ||
| server_name <YOUR_SERVER_NAME>; | ||
| ssl_certificate <PATH_TO_CERT>; | ||
| ssl_certificate_key <PATH_CERT_KEY>; | ||
| ssl_protocols TLSv1.2 TLSv1.3; | ||
| location / { | ||
| proxy_pass http://<IP:PORT>; | ||
| proxy_http_version 1.1; | ||
| proxy_set_header Upgrade $http_upgrade; | ||
| proxy_set_header Connection $connection_upgrade; | ||
| proxy_set_header Host $server_name; | ||
| proxy_redirect http:// https://; | ||
| proxy_buffering off; | ||
| proxy_set_header X-Real-IP $remote_addr; | ||
| proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; | ||
| proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto; | ||
| add_header Strict-Transport-Security "max-age=15552000; includeSubDomains" always; | ||
| } | ||
| } | ||
| ``` |
Oops, something went wrong.