Files
teleport/lib/join/azuredevops/token_validator.go
T
Nic Klaassen 2fa88f4a86 azure devops support in new join service (#61545)
* azure devops support in new join service

* return proper error on failed gRPC Send

* fix lint

* add comments

* elaborate in comment
2025-11-21 17:13:10 +00:00

132 lines
3.5 KiB
Go

/*
* Teleport
* Copyright (C) 2025 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 azuredevops
import (
"context"
"net/url"
"strings"
"github.com/gravitational/trace"
"github.com/gravitational/teleport/lib/oidc"
)
// audience is the static value that Azure DevOps uses for the `aud` claim in
// issued ID Tokens. Unfortunately, this cannot be changed.
const audience = "api://AzureADTokenExchange"
func issuerURL(
organizationID string,
overrideHost string,
insecure bool,
) string {
scheme := "https"
if insecure {
scheme = "http"
}
host := "vstoken.dev.azure.com"
if overrideHost != "" {
host = overrideHost
}
issuerURL := url.URL{
Scheme: scheme,
Host: host,
}
return issuerURL.JoinPath(organizationID).String()
}
// IDTokenValidator validates an Azure Devops issued ID Token.
type IDTokenValidator struct {
insecureDiscovery bool
overrideDiscoveryHost string
}
// NewIDTokenValidator returns an initialized IDTokenValidator
func NewIDTokenValidator() *IDTokenValidator {
return &IDTokenValidator{}
}
// Validate validates an Azure Devops issued ID token.
func (id *IDTokenValidator) Validate(
ctx context.Context, organizationID, token string,
) (*IDTokenClaims, error) {
issuer := issuerURL(
organizationID, id.overrideDiscoveryHost, id.insecureDiscovery,
)
claims, err := oidc.ValidateToken[*IDTokenClaims](ctx, issuer, audience, token)
if err != nil {
return nil, trace.Wrap(err, "validating token")
}
parsed, err := parseSubClaim(claims.Sub)
if err != nil {
return nil, trace.Wrap(err, "parsing sub claim")
}
claims.OrganizationName = parsed.organizationName
claims.ProjectName = parsed.projectName
claims.PipelineName = parsed.pipelineName
if claims.OrganizationID != organizationID {
return nil, trace.BadParameter(
"organization ID in token (%s) does not match configured (%s)",
claims.OrganizationID, organizationID,
)
}
return claims, nil
}
type parsedSubClaim struct {
organizationName string
projectName string
pipelineName string
}
func parseSubClaim(sub string) (parsedSubClaim, error) {
parsed, err := url.Parse(sub)
if err != nil {
return parsedSubClaim{}, trace.Wrap(err, "parsing as url")
}
// Special p:// scheme indicates this is a Pipeline ID token rather than
// a service connection ID token (which starts sc://).
if parsed.Scheme != "p" {
return parsedSubClaim{}, trace.BadParameter(
"id token is not of pipeline kind (sub: %q)", sub,
)
}
out := parsedSubClaim{organizationName: parsed.Host}
// Now we need to handle the path, which is something like
// /project-name/pipeline-name
path, _ := strings.CutPrefix(parsed.Path, "/")
split := strings.Split(path, "/")
if len(split) != 2 {
return parsedSubClaim{}, trace.BadParameter(
"subject malformed, expected 2 path elements (sub: %q)", sub,
)
}
out.projectName = split[0]
out.pipelineName = split[1]
return out, nil
}