File: example.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 (99 lines) | stat: -rw-r--r-- 2,822 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
// 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 gitlab_example

import (
	"context"
	"encoding/base64"
	"fmt"

	"github.com/openpubkey/openpubkey/client"
	"github.com/openpubkey/openpubkey/providers"
	"github.com/openpubkey/openpubkey/verifier"
)

type Opts struct {
	altOp providers.OpenIdProvider
}

func SignWithGitlab(opts ...Opts) error {
	var op providers.OpenIdProvider

	// If an alternative OP is provided, use that instead of the default.
	// Currently only used for testing where a mockOP is provided.
	if len(opts) > 0 && opts[0].altOp != nil {
		op = opts[0].altOp
	} else {
		// Creates OpenID Provider (OP) configuration, this will be used to request the ID Token from Gitlab
		op = providers.NewGitlabCiOpFromEnvironment("OPENPUBKEY_JWT")
	}

	// Creates a new OpenPubkey client
	opkClient, err := client.New(op)
	if err != nil {
		return err
	}

	// Generates a PK Token by authorizing to the OpenID Provider
	pkt, err := opkClient.Auth(context.Background())
	if err != nil {
		return err
	}

	// Serialize the PK Token to JSON so we can print it. Typically this
	// serialization of the PK Token would be sent with the signed message
	pktJson, err := pkt.MarshalJSON()
	if err != nil {
		return err
	}
	fmt.Println("pkt:", string(pktJson))

	pktCom, _ := pkt.Compact()
	b64pktCom := base64.StdEncoding.EncodeToString(pktCom)
	fmt.Println("pkt compact:", string(b64pktCom))

	// Create a verifier to check that the PK Token is well formed
	// The OPK client does this as well, but for the purposes of the
	// example we show how a relying party might verify a PK Token
	verifier, err := verifier.New(op)
	if err != nil {
		return err
	}

	// Verify the PK Token. We supply the OP (gitlab) we wish to verify against
	err = verifier.VerifyPKToken(context.Background(), pkt)
	if err != nil {
		return err
	}

	// Sign a message over the user's public key in the PK Token
	msg := []byte("All is discovered - flee at once")
	signedMsg, err := pkt.NewSignedMessage(msg, opkClient.GetSigner())
	if err != nil {
		return err
	}
	fmt.Println("signedMsg:", string(signedMsg))

	// Verify the signed message
	_, err = pkt.VerifySignedMessage(signedMsg)
	if err != nil {
		return err
	}

	fmt.Println("Success!")
	return nil
}