File: gitlab_ci.go

package info (click to toggle)
golang-github-openpubkey-openpubkey 0.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 964 kB
  • sloc: makefile: 10
file content (108 lines) | stat: -rw-r--r-- 3,651 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright 2024 OpenPubkey
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0

package providers

import (
	"context"
	"fmt"

	"github.com/awnumar/memguard"
	"github.com/openpubkey/openpubkey/discover"
	simpleoidc "github.com/openpubkey/openpubkey/oidc"
	"github.com/openpubkey/openpubkey/pktoken/clientinstance"
)

const gitlabIssuer = "https://gitlab.com"

type GitlabCiOp struct {
	issuer                    string // Change issuer to point this to a test issuer
	publicKeyFinder           discover.PublicKeyFinder
	tokenEnvVar               string
	requestTokensOverrideFunc func(string) (*simpleoidc.Tokens, error)
}

func NewGitlabCiOpFromEnvironmentDefault() *GitlabCiOp {
	return NewGitlabCiOpFromEnvironment("OPENPUBKEY_JWT")
}

func NewGitlabCiOpFromEnvironment(tokenEnvVar string) *GitlabCiOp {
	return NewGitlabCiOp(gitlabIssuer, tokenEnvVar)
}

func NewGitlabCiOp(issuer string, tokenEnvVar string) *GitlabCiOp {
	op := &GitlabCiOp{
		issuer:                    issuer,
		publicKeyFinder:           *discover.DefaultPubkeyFinder(),
		tokenEnvVar:               tokenEnvVar,
		requestTokensOverrideFunc: nil,
	}
	return op
}

func (g *GitlabCiOp) PublicKeyByToken(ctx context.Context, token []byte) (*discover.PublicKeyRecord, error) {
	return g.publicKeyFinder.ByToken(ctx, g.issuer, token)
}

func (g *GitlabCiOp) PublicKeyByKeyId(ctx context.Context, keyID string) (*discover.PublicKeyRecord, error) {
	return g.publicKeyFinder.ByKeyID(ctx, g.issuer, keyID)
}

func (g *GitlabCiOp) RequestTokens(ctx context.Context, cic *clientinstance.Claims) (*simpleoidc.Tokens, error) {
	// Define our commitment as the hash of the client instance claims
	cicHash, err := cic.Hash()
	if err != nil {
		return nil, fmt.Errorf("error calculating client instance claim commitment: %w", err)
	}

	var idToken []byte
	if g.requestTokensOverrideFunc != nil {
		noCicHashInIDToken := ""
		if tokens, err := g.requestTokensOverrideFunc(noCicHashInIDToken); err != nil {
			return nil, fmt.Errorf("error requesting ID Token: %w", err)
		} else {
			idToken = tokens.IDToken
		}
	} else {
		idTokenStr, err := getEnvVar(g.tokenEnvVar)
		if err != nil {
			return nil, fmt.Errorf("error requesting ID Token: %w", err)
		}
		idToken = []byte(idTokenStr)
	}
	// idTokenLB is the ID Token in a memguard LockedBuffer, this is done
	// because the ID Token contains the OPs RSA signature which is a secret
	// in GQ signatures. For non-GQ signatures OPs RSA signature is considered
	// a public value.
	idTokenLB := memguard.NewBufferFromBytes([]byte(idToken))
	defer idTokenLB.Destroy()
	gqToken, err := CreateGQBoundToken(ctx, idTokenLB.Bytes(), g, string(cicHash))
	if err != nil {
		return nil, err
	}
	return &simpleoidc.Tokens{IDToken: []byte(gqToken)}, nil
}

func (g *GitlabCiOp) Issuer() string {
	return g.issuer
}

func (g *GitlabCiOp) VerifyIDToken(ctx context.Context, idt []byte, cic *clientinstance.Claims) error {
	vp := NewProviderVerifier(g.issuer,
		ProviderVerifierOpts{CommitType: CommitTypesEnum.GQ_BOUND, GQOnly: true, SkipClientIDCheck: true},
	)
	return vp.VerifyIDToken(ctx, idt, cic)
}