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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
// 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"
"strings"
"testing"
"github.com/openpubkey/openpubkey/providers/mocks"
"github.com/openpubkey/openpubkey/util"
"github.com/stretchr/testify/require"
)
func TestProviderVerifier(t *testing.T) {
NONCE_CLAIM := CommitTypesEnum.NONCE_CLAIM
AUD_CLAIM := CommitTypesEnum.AUD_CLAIM
GQ_BOUND := CommitTypesEnum.GQ_BOUND
EMPTY_COMMIT := CommitType{
Claim: "",
GQCommitment: false,
}
correctAud := AudPrefixForGQCommitment
clientID := "test-client-id"
issuer := "mockIssuer"
testCases := []struct {
name string
aud string
clientID string
expError string
pvGQSign bool
pvGQOnly bool
tokenGQSign bool
providerAlg string
tokenCommitType CommitType
pvCommitType CommitType
SkipClientIDCheck bool
IssuedAtClaim int64
correctCicHash bool
}{
{name: "Claim Commitment happy case (RS256)", aud: clientID, clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
expError: "",
correctCicHash: true},
{name: "Claim Commitment happy case (ES256)", aud: clientID, clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "ES256",
expError: "",
correctCicHash: true},
{name: "Claim Commitment (aud) happy case",
tokenCommitType: AUD_CLAIM, pvCommitType: AUD_CLAIM, providerAlg: "RS256",
expError: "",
SkipClientIDCheck: true, correctCicHash: true},
{name: "Claim Commitment wrong audience", aud: "wrong clientID", clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
expError: "audience does not contain clientID",
correctCicHash: true},
{name: "Claim Commitment no commitment claim", aud: clientID, clientID: clientID,
tokenCommitType: EMPTY_COMMIT, pvCommitType: EMPTY_COMMIT, providerAlg: "RS256",
expError: "verifier configured with empty commitment claim",
tokenGQSign: false, correctCicHash: true},
{name: "Claim Commitment wrong CIC", aud: clientID, clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
expError: "commitment claim doesn't match",
tokenGQSign: false, correctCicHash: false},
{name: "Claim Commitment GQ happy case", aud: clientID, clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
expError: "", tokenGQSign: true, correctCicHash: true},
{name: "Claim Commitment GQ wrong CIC", aud: clientID, clientID: clientID,
tokenCommitType: NONCE_CLAIM, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
expError: "commitment claim doesn't match", tokenGQSign: true, correctCicHash: false},
{name: "GQ Commitment happy case", aud: correctAud,
expError: "",
tokenCommitType: GQ_BOUND, pvCommitType: GQ_BOUND, providerAlg: "RS256",
tokenGQSign: true, pvGQOnly: true,
SkipClientIDCheck: true, correctCicHash: true},
{name: "GQ Commitment wrong aud prefix", aud: "bad value",
expError: "audience claim in PK Token's GQCommitment must be prefixed by",
tokenCommitType: GQ_BOUND, pvCommitType: GQ_BOUND, providerAlg: "RS256",
tokenGQSign: true, pvGQOnly: true,
SkipClientIDCheck: true, correctCicHash: true},
{name: "GQ Commitment providerVerifier not using GQ Commitment", aud: correctAud,
expError: "commitment claim doesn't match",
tokenCommitType: GQ_BOUND, pvCommitType: NONCE_CLAIM, providerAlg: "RS256",
tokenGQSign: true, pvGQOnly: true,
SkipClientIDCheck: true, correctCicHash: true},
{name: "GQ Commitment wrong CIC", aud: correctAud,
expError: "commitment claim doesn't match",
tokenCommitType: GQ_BOUND, pvCommitType: GQ_BOUND, providerAlg: "RS256",
tokenGQSign: true, pvGQOnly: true,
SkipClientIDCheck: true, correctCicHash: false},
{name: "GQ Commitment check client id", aud: correctAud,
expError: "GQCommitment requires that audience (aud) is not set to client-id",
tokenCommitType: GQ_BOUND, pvCommitType: GQ_BOUND, providerAlg: "RS256",
tokenGQSign: true, pvGQOnly: true},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
idtTemplate := mocks.IDTokenTemplate{
Issuer: issuer,
Nonce: "empty",
NoNonce: false,
Aud: "empty",
Alg: tc.providerAlg,
NoAlg: false,
ExtraClaims: map[string]any{},
}
switch tc.tokenCommitType.Claim {
case "nonce":
idtTemplate.CommitFunc = mocks.AddNonceCommit
case "aud":
idtTemplate.CommitFunc = mocks.AddAudCommit
default:
idtTemplate.CommitFunc = mocks.NoClaimCommit
}
if tc.aud != "" {
idtTemplate.Aud = tc.aud
}
if tc.IssuedAtClaim != 0 {
idtTemplate.ExtraClaims["iat"] = tc.IssuedAtClaim
}
cic := GenCICExtra(t, map[string]any{})
// Set gqOnly to gqCommitment since gqCommitment requires gqOnly
pvGQOnly := tc.tokenCommitType.GQCommitment
skipClientIDCheck := false //TODO: This should be taken from the testcase
providerOpts := MockProviderOpts{
Issuer: issuer,
Alg: tc.providerAlg,
ClientID: clientID,
GQSign: tc.tokenGQSign,
NumKeys: 2,
CommitType: tc.tokenCommitType,
VerifierOpts: ProviderVerifierOpts{
CommitType: tc.pvCommitType,
ClientID: clientID,
SkipClientIDCheck: skipClientIDCheck,
GQOnly: pvGQOnly,
},
}
op, backendMock, _, err := NewMockProvider(providerOpts)
require.NoError(t, err)
opSignKey, keyID, _ := backendMock.RandomSigningKey()
idtTemplate.KeyID = keyID
idtTemplate.SigningKey = opSignKey
backendMock.SetIDTokenTemplate(&idtTemplate)
tokens, err := op.RequestTokens(context.Background(), cic)
require.NoError(t, err)
idToken := tokens.IDToken
if tc.name == "GQ Commitment happy case" {
fmt.Println("here")
}
pv := NewProviderVerifier(issuer,
ProviderVerifierOpts{
CommitType: tc.pvCommitType,
DiscoverPublicKey: &backendMock.PublicKeyFinder,
GQOnly: tc.pvGQOnly,
ClientID: tc.clientID,
SkipClientIDCheck: tc.SkipClientIDCheck,
})
// Change the CIC we test against so it doesn't match the commitment
if !tc.correctCicHash {
// overwrite the cic with a new cic with a different hash
cic = GenCICExtra(t, map[string]any{"cause": "differentCicHash"})
}
err = pv.VerifyIDToken(context.Background(), idToken, cic)
if tc.expError != "" {
require.ErrorContains(t, err, tc.expError)
} else {
require.NoError(t, err)
}
})
}
}
func TestRejectUnexpectedAlg(t *testing.T) {
// This test ensures that we correctly handle the case where
// the protected header has an unexpected alg claim.
clientID := "test-client-id"
issuer := "mockIssuer"
idtTemplate := mocks.IDTokenTemplate{
Issuer: issuer,
Nonce: "empty",
NoNonce: false,
Aud: "empty",
Alg: "RS256",
NoAlg: false,
ExtraClaims: map[string]any{},
}
idtTemplate.CommitFunc = mocks.AddNonceCommit
idtTemplate.Aud = clientID
cic := GenCICExtra(t, map[string]any{})
providerOpts := MockProviderOpts{
Issuer: issuer,
ClientID: clientID,
GQSign: false,
NumKeys: 2,
CommitType: CommitTypesEnum.NONCE_CLAIM,
VerifierOpts: ProviderVerifierOpts{
CommitType: CommitTypesEnum.NONCE_CLAIM,
ClientID: clientID,
},
}
op, backendMock, _, err := NewMockProvider(providerOpts)
require.NoError(t, err)
opSignKey, keyID, _ := backendMock.RandomSigningKey()
idtTemplate.KeyID = keyID
idtTemplate.SigningKey = opSignKey
backendMock.SetIDTokenTemplate(&idtTemplate)
tokens, err := op.RequestTokens(context.Background(), cic)
require.NoError(t, err)
idToken := tokens.IDToken
pv := NewProviderVerifier(issuer,
ProviderVerifierOpts{
CommitType: CommitTypesEnum.NONCE_CLAIM,
DiscoverPublicKey: &backendMock.PublicKeyFinder,
GQOnly: false,
ClientID: clientID,
SkipClientIDCheck: false,
})
phBase64 := strings.Split(string(idToken), ".")[0]
payloadBase64 := strings.Split(string(idToken), ".")[1]
sigBase64 := strings.Split(string(idToken), ".")[2]
goodPh := util.Base64EncodeForJWT([]byte(`{"alg":"RS256","kid":"kid-1","typ":"JWT"}`))
idTokenGood := []byte(fmt.Sprintf("%s.%s.%s", phBase64, payloadBase64, sigBase64))
err = pv.VerifyIDToken(context.Background(), idTokenGood, cic)
require.NoError(t, err)
idTokenBad := []byte(fmt.Sprintf("%s.%s.%s", goodPh, payloadBase64, "bad"))
err = pv.VerifyIDToken(context.Background(), idTokenBad, cic)
require.Error(t, err)
// Use unexpected alg HS256 in the protected header
wrongAlgPh := util.Base64EncodeForJWT([]byte(`{"alg":"HS256","kid":"kid-1","typ":"JWT"}`))
idTokenBadAlgPh := []byte(fmt.Sprintf("%s.%s.%s", wrongAlgPh, payloadBase64, "bad"))
err = pv.VerifyIDToken(context.Background(), idTokenBadAlgPh, cic)
require.Error(t, err)
}
|
