mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-31 20:39:37 +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,96 @@
|
||||
/*
|
||||
Copyright 2023 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 (
|
||||
"github.com/gravitational/trace"
|
||||
"github.com/mitchellh/mapstructure"
|
||||
)
|
||||
|
||||
// GitLab Workload Identity
|
||||
//
|
||||
// GL provides workloads with the ID token in an environment variable included
|
||||
// in the workflow config, with the specified audience:
|
||||
//
|
||||
// ```yaml
|
||||
// job-name:
|
||||
// id_tokens:
|
||||
// TBOT_GITLAB_JWT:
|
||||
// aud: https://teleport.example.com
|
||||
// ```
|
||||
//
|
||||
// We will require the user to configure this to be `TBOT_GITLAB_JWT` and to
|
||||
// set this value to the name of their Teleport cluster.
|
||||
//
|
||||
// Valuable reference:
|
||||
// - https://docs.gitlab.com/ee/ci/secrets/id_token_authentication.html
|
||||
// - https://docs.gitlab.com/ee/ci/cloud_services/
|
||||
// - https://docs.gitlab.com/ee/ci/yaml/index.html#id_tokens
|
||||
//
|
||||
// The GitLab issuer's well-known OIDC document is at
|
||||
// https://gitlab.com/.well-known/openid-configuration
|
||||
// For GitLab self-hosted servers, this will be at
|
||||
// https://$HOSTNAME/.well-known/openid-configuration
|
||||
|
||||
// IDTokenClaims is the structure of claims contained within a GitLab issued
|
||||
// ID token.
|
||||
//
|
||||
// See the following for the structure:
|
||||
// https://docs.gitlab.com/ee/ci/cloud_services/#how-it-works
|
||||
type IDTokenClaims struct {
|
||||
// Sub roughly uniquely identifies the workload. Example:
|
||||
// `project_path:mygroup/my-project:ref_type:branch:ref:main`
|
||||
// project_path:{group}/{project}:ref_type:{type}:ref:{branch_name}
|
||||
Sub string `json:"sub"`
|
||||
// Git ref for this job
|
||||
Ref string `json:"ref"`
|
||||
// Git ref type. Example:
|
||||
// `branch` or `tag`
|
||||
RefType string `json:"ref_type"`
|
||||
// Use this to scope to group or user level namespace by path. Example:
|
||||
// `mygroup`
|
||||
NamespacePath string `json:"namespace_path"`
|
||||
// Use this to scope to project by path. Example:
|
||||
// `mygroup/myproject`
|
||||
ProjectPath string `json:"project_path"`
|
||||
// Username of the user executing the job
|
||||
UserLogin string `json:"user_login"`
|
||||
// Pipeline source.
|
||||
// https://docs.gitlab.com/ee/ci/jobs/job_control.html#common-if-clauses-for-rules
|
||||
// Example: `web`
|
||||
PipelineSource string `json:"pipeline_source"`
|
||||
// Environment this job deploys to (if one is associated)
|
||||
Environment string `json:"environment"`
|
||||
}
|
||||
|
||||
// JoinAuditAttributes returns a series of attributes that can be inserted into
|
||||
// audit events related to a specific join.
|
||||
func (c *IDTokenClaims) JoinAuditAttributes() (map[string]interface{}, error) {
|
||||
res := map[string]interface{}{}
|
||||
d, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
|
||||
TagName: "json",
|
||||
Result: &res,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, trace.Wrap(err)
|
||||
}
|
||||
|
||||
if err := d.Decode(c); err != nil {
|
||||
return nil, trace.Wrap(err)
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
Reference in New Issue
Block a user