Skip to content

fix!: add audience validation for jwt tokens #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix!: add audience validation for jwt tokens #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ JWT allow granting access to a state for a given time (the token lifetime). The
NOTE: `state` value can be set to `*` to allow accessing all project states

### Config
| Environment Variable | Type | Example | Description |
|--------------------------|------|----------------------------------------------|-----------------------------------------------------------------------------------|
| AUTH_JWT_OIDC_ISSUER_URL | bool | `https://vault.example.com/v1/identity/oidc` | Issuer URL which is used to validate token (if not defined, JWT auth is disabled) |
| Environment Variable | Type | Example | Description |
|--------------------------|--------|----------------------------------------------|-----------------------------------------------------------------------------------|
| AUTH_JWT_OIDC_ISSUER_URL | bool | `https://vault.example.com/v1/identity/oidc` | Issuer URL which is used to validate token (if not defined, JWT auth is disabled) |
| AUTH_JWT_OIDC_CLIENT_ID | string | `terraform-backend` (Default) | Client ID (string or URI) used for validating token audience claim |


**Example Terraform backend configuration**
Expand Down
4 changes: 3 additions & 1 deletion pkg/auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ func Authenticate(req *http.Request, s *terraform.State) (ok bool, err error) {
authenticator = basic.NewBasicAuth()
case jwt.Name:
issuerURL := viper.GetString("auth_jwt_oidc_issuer_url")
viper.SetDefault("auth_jwt_oidc_client_id", "terraform-backend")
clientID := viper.GetString("auth_jwt_oidc_client_id")
if addr := viper.GetString("vault_addr"); issuerURL != "" && addr != "" {
issuerURL = fmt.Sprintf("%s/v1/identity/oidc", addr)
} else {
return false, fmt.Errorf("jwt auth is not enabled")
}
authenticator = jwt.NewJWTAuth(issuerURL)
authenticator = jwt.NewJWTAuth(issuerURL, clientID)
default:
err = fmt.Errorf("backend is not implemented")
}
Expand Down
6 changes: 4 additions & 2 deletions pkg/auth/jwt/jwt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ const Name = "jwt"

type JWTAuth struct {
issuerURL string
clientID string
}

func NewJWTAuth(issuerURL string) *JWTAuth {
func NewJWTAuth(issuerURL string, clientID string) *JWTAuth {
return &JWTAuth{
issuerURL: issuerURL,
clientID: clientID,
}
}

Expand All @@ -31,7 +33,7 @@ func (b *JWTAuth) Authenticate(secret string, s *terraform.State) (bool, error)
}

verifier := provider.Verifier(&oidc.Config{
SkipClientIDCheck: true,
ClientID: b.clientID,
})

token, err := verifier.Verify(context.Background(), secret)
Expand Down
Loading