mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-02 14:59:53 +08:00
GitLab Delegated Joining (#22705)
* Add type for GitLab ProvisionToken * Add default behaviour for domain * Add IDTokenClaims for GitLab * Add gitlab token source and token validator * Thread GitLab support through auth and tbot packages * Adjust cluster name fetching in token validator * Initialize GitLab token validator in auth * Improve comment on `sub` * Working GitLab CI delegated joining * Add additional token rule fields * Add checking for new configuration fields * add additional test cases for validation of gitlab config struct * Add TestAuth_RegisterUsingToken_GitLab * Add tests for IDTokenSource * Fix imports * Add tests for GitLab Token Validator * Fix some comments that were incomplete * Add license headers
This commit is contained in:
@@ -0,0 +1,261 @@
|
||||
/*
|
||||
Copyright 2022 Gravitational, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package gitlab
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"crypto/rsa"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/jonboulle/clockwork"
|
||||
"github.com/stretchr/testify/require"
|
||||
"gopkg.in/square/go-jose.v2"
|
||||
"gopkg.in/square/go-jose.v2/jwt"
|
||||
|
||||
"github.com/gravitational/teleport/api/types"
|
||||
"github.com/gravitational/teleport/lib/services"
|
||||
)
|
||||
|
||||
type fakeIDP struct {
|
||||
t *testing.T
|
||||
signer jose.Signer
|
||||
privateKey *rsa.PrivateKey
|
||||
server *httptest.Server
|
||||
}
|
||||
|
||||
func newFakeIDP(t *testing.T) *fakeIDP {
|
||||
privateKey, err := rsa.GenerateKey(rand.Reader, 2048)
|
||||
require.NoError(t, err)
|
||||
|
||||
signer, err := jose.NewSigner(
|
||||
jose.SigningKey{Algorithm: jose.RS256, Key: privateKey},
|
||||
(&jose.SignerOptions{}).WithType("JWT"),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
f := &fakeIDP{
|
||||
signer: signer,
|
||||
privateKey: privateKey,
|
||||
t: t,
|
||||
}
|
||||
|
||||
providerMux := http.NewServeMux()
|
||||
providerMux.HandleFunc(
|
||||
"/.well-known/openid-configuration",
|
||||
f.handleOpenIDConfig,
|
||||
)
|
||||
providerMux.HandleFunc(
|
||||
"/oauth/discovery/keys",
|
||||
f.handleJWKSEndpoint,
|
||||
)
|
||||
|
||||
srv := httptest.NewServer(providerMux)
|
||||
t.Cleanup(srv.Close)
|
||||
f.server = srv
|
||||
return f
|
||||
}
|
||||
|
||||
func (f *fakeIDP) issuer() string {
|
||||
return f.server.URL
|
||||
}
|
||||
|
||||
func (f *fakeIDP) handleOpenIDConfig(w http.ResponseWriter, r *http.Request) {
|
||||
// mimic https://gitlab.com/.well-known/openid-configuration
|
||||
response := map[string]interface{}{
|
||||
"claims_supported": []string{
|
||||
"sub",
|
||||
"aud",
|
||||
"exp",
|
||||
"iat",
|
||||
"iss",
|
||||
"jti",
|
||||
"nbf",
|
||||
},
|
||||
"id_token_signing_alg_values_supported": []string{"RS256"},
|
||||
"issuer": f.issuer(),
|
||||
"jwks_uri": f.issuer() + "/oauth/discovery/keys",
|
||||
"response_types_supported": []string{"id_token"},
|
||||
"scopes_supported": []string{"openid"},
|
||||
"subject_types_supported": []string{"public"},
|
||||
}
|
||||
responseBytes, err := json.Marshal(response)
|
||||
require.NoError(f.t, err)
|
||||
_, err = w.Write(responseBytes)
|
||||
require.NoError(f.t, err)
|
||||
}
|
||||
|
||||
func (f *fakeIDP) handleJWKSEndpoint(w http.ResponseWriter, r *http.Request) {
|
||||
// mimic https://gitlab.com/oauth/discovery/keys
|
||||
// but with our own keys
|
||||
jwks := jose.JSONWebKeySet{
|
||||
Keys: []jose.JSONWebKey{
|
||||
{
|
||||
Key: &f.privateKey.PublicKey,
|
||||
},
|
||||
},
|
||||
}
|
||||
responseBytes, err := json.Marshal(jwks)
|
||||
require.NoError(f.t, err)
|
||||
_, err = w.Write(responseBytes)
|
||||
require.NoError(f.t, err)
|
||||
}
|
||||
|
||||
func (f *fakeIDP) issueToken(
|
||||
t *testing.T,
|
||||
issuer,
|
||||
audience,
|
||||
userLogin,
|
||||
sub string,
|
||||
issuedAt time.Time,
|
||||
expiry time.Time,
|
||||
) string {
|
||||
stdClaims := jwt.Claims{
|
||||
Issuer: issuer,
|
||||
Subject: sub,
|
||||
Audience: jwt.Audience{audience},
|
||||
IssuedAt: jwt.NewNumericDate(issuedAt),
|
||||
NotBefore: jwt.NewNumericDate(issuedAt),
|
||||
Expiry: jwt.NewNumericDate(expiry),
|
||||
}
|
||||
customClaims := map[string]interface{}{
|
||||
"user_login": userLogin,
|
||||
}
|
||||
token, err := jwt.Signed(f.signer).
|
||||
Claims(stdClaims).
|
||||
Claims(customClaims).
|
||||
CompactSerialize()
|
||||
require.NoError(t, err)
|
||||
|
||||
return token
|
||||
}
|
||||
|
||||
type mockClusterNameGetter string
|
||||
|
||||
func (m mockClusterNameGetter) GetClusterName(opts ...services.MarshalOption) (types.ClusterName, error) {
|
||||
return types.NewClusterName(types.ClusterNameSpecV2{
|
||||
ClusterID: uuid.NewString(),
|
||||
ClusterName: string(m),
|
||||
})
|
||||
}
|
||||
|
||||
func TestIDTokenValidator_Validate(t *testing.T) {
|
||||
t.Parallel()
|
||||
idp := newFakeIDP(t)
|
||||
teleportClusterName := "teleport.example.com"
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
assertError require.ErrorAssertionFunc
|
||||
want *IDTokenClaims
|
||||
token string
|
||||
}{
|
||||
{
|
||||
name: "success",
|
||||
assertError: require.NoError,
|
||||
token: idp.issueToken(
|
||||
t,
|
||||
idp.issuer(),
|
||||
teleportClusterName,
|
||||
"unpetitchien",
|
||||
"project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
time.Now().Add(-5*time.Minute),
|
||||
time.Now().Add(5*time.Minute),
|
||||
),
|
||||
want: &IDTokenClaims{
|
||||
UserLogin: "unpetitchien",
|
||||
Sub: "project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "expired",
|
||||
assertError: require.Error,
|
||||
token: idp.issueToken(
|
||||
t,
|
||||
idp.issuer(),
|
||||
teleportClusterName,
|
||||
"octocat",
|
||||
"project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
time.Now().Add(-15*time.Minute),
|
||||
time.Now().Add(-5*time.Minute),
|
||||
),
|
||||
},
|
||||
{
|
||||
name: "future",
|
||||
assertError: require.Error,
|
||||
token: idp.issueToken(
|
||||
t,
|
||||
idp.issuer(),
|
||||
teleportClusterName,
|
||||
"octocat",
|
||||
"project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
time.Now().Add(10*time.Minute),
|
||||
time.Now().Add(20*time.Minute),
|
||||
),
|
||||
},
|
||||
{
|
||||
name: "invalid audience",
|
||||
assertError: require.Error,
|
||||
token: idp.issueToken(
|
||||
t,
|
||||
idp.issuer(),
|
||||
"wrong-teleport.example.com",
|
||||
"octocat",
|
||||
"project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
time.Now().Add(-5*time.Minute),
|
||||
time.Now().Add(5*time.Minute),
|
||||
),
|
||||
},
|
||||
{
|
||||
name: "invalid issuer",
|
||||
assertError: require.Error,
|
||||
token: idp.issueToken(
|
||||
t,
|
||||
"https://the.wrong.issuer",
|
||||
teleportClusterName,
|
||||
"octocat",
|
||||
"project_path:mygroup/my-project:ref_type:branch:ref:main",
|
||||
time.Now().Add(-5*time.Minute),
|
||||
time.Now().Add(5*time.Minute),
|
||||
),
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
v, err := NewIDTokenValidator(IDTokenValidatorConfig{
|
||||
Clock: clockwork.NewRealClock(),
|
||||
insecure: true,
|
||||
ClusterNameGetter: mockClusterNameGetter(teleportClusterName),
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
claims, err := v.Validate(
|
||||
ctx,
|
||||
idp.server.Listener.Addr().String(),
|
||||
tt.token,
|
||||
)
|
||||
tt.assertError(t, err)
|
||||
require.Equal(t, tt.want, claims)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user