mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-31 12:06:26 +08:00
d653229ab9
* Add support for `include_enterprise_slug` in `github` joining * Correct assertiosn in github validator token test * Remove `want` in TestIDTokenValidator_Validate * Fix missing `should` in docs Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com> * Fix spelling of customize in docs * Update operator CRDs * Regen protos * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Try both under same header * Try H4 * Remove spurious period * Use bold rather than heading --------- Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
116 lines
3.2 KiB
Go
116 lines
3.2 KiB
Go
/*
|
|
* Teleport
|
|
* Copyright (C) 2023 Gravitational, Inc.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package githubactions
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/coreos/go-oidc"
|
|
"github.com/gravitational/trace"
|
|
"github.com/jonboulle/clockwork"
|
|
|
|
"github.com/gravitational/teleport/lib/jwt"
|
|
)
|
|
|
|
type IDTokenValidatorConfig struct {
|
|
// Clock is used by the validator when checking expiry and issuer times of
|
|
// tokens. If omitted, a real clock will be used.
|
|
Clock clockwork.Clock
|
|
// GitHubIssuerHost is the host of the Issuer for tokens issued by
|
|
// GitHub's cloud hosted version. If no GHESHost override is provided to
|
|
// the call to Validate, then this will be used as the host.
|
|
GitHubIssuerHost string
|
|
// insecure configures the validator to use HTTP rather than HTTPS. This
|
|
// is not exported as this is only used in the test for now.
|
|
insecure bool
|
|
}
|
|
|
|
type IDTokenValidator struct {
|
|
IDTokenValidatorConfig
|
|
}
|
|
|
|
func NewIDTokenValidator(cfg IDTokenValidatorConfig) *IDTokenValidator {
|
|
if cfg.GitHubIssuerHost == "" {
|
|
cfg.GitHubIssuerHost = DefaultIssuerHost
|
|
}
|
|
if cfg.Clock == nil {
|
|
cfg.Clock = clockwork.NewRealClock()
|
|
}
|
|
|
|
return &IDTokenValidator{
|
|
IDTokenValidatorConfig: cfg,
|
|
}
|
|
}
|
|
|
|
func (id *IDTokenValidator) issuerURL(
|
|
GHESHost string, enterpriseSlug string,
|
|
) string {
|
|
scheme := "https"
|
|
if id.insecure {
|
|
scheme = "http"
|
|
}
|
|
|
|
if GHESHost == "" {
|
|
url := fmt.Sprintf("%s://%s", scheme, id.GitHubIssuerHost)
|
|
// Support custom enterprise slugs, as per:
|
|
// https://docs.github.com/en/enterprise-cloud@latest/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-issuer-value-for-an-enterprise
|
|
if enterpriseSlug != "" {
|
|
url = fmt.Sprintf("%s/%s", url, enterpriseSlug)
|
|
}
|
|
return url
|
|
}
|
|
return fmt.Sprintf("%s://%s/_services/token", scheme, GHESHost)
|
|
}
|
|
|
|
func (id *IDTokenValidator) Validate(
|
|
ctx context.Context, GHESHost string, enterpriseSlug string, token string,
|
|
) (*IDTokenClaims, error) {
|
|
p, err := oidc.NewProvider(
|
|
ctx,
|
|
id.issuerURL(GHESHost, enterpriseSlug),
|
|
)
|
|
if err != nil {
|
|
return nil, trace.Wrap(err)
|
|
}
|
|
|
|
verifier := p.Verifier(&oidc.Config{
|
|
ClientID: "teleport.cluster.local",
|
|
Now: id.Clock.Now,
|
|
})
|
|
|
|
idToken, err := verifier.Verify(ctx, token)
|
|
if err != nil {
|
|
return nil, trace.Wrap(err)
|
|
}
|
|
|
|
// `go-oidc` does not implement not before check, so we need to manually
|
|
// perform this
|
|
if err := jwt.CheckNotBefore(id.Clock.Now(), time.Minute*2, idToken); err != nil {
|
|
return nil, trace.Wrap(err)
|
|
}
|
|
|
|
claims := IDTokenClaims{}
|
|
if err := idToken.Claims(&claims); err != nil {
|
|
return nil, trace.Wrap(err)
|
|
}
|
|
return &claims, nil
|
|
}
|