-
Notifications
You must be signed in to change notification settings - Fork 11
/
combined.example.yaml
285 lines (284 loc) · 10.5 KB
/
combined.example.yaml
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
279
280
281
282
283
284
285
# Copyright 2023 - 2024 California Department of Motor Vehicles
# Copyright 2023 - 2024 Digital Bazaar, Inc.
#
# SPDX-License-Identifier: BSD-3-Clause
app:
# server:
# baseUri: https://evil-cows-return.loca.lt
opencred:
caStore:
- pem: |
-----BEGIN CERTIFICATE-----
<VALID CERTIFICATE>
-----END CERTIFICATE-----
signingKeys:
- type: ES256
privateKeyPem: |
-----BEGIN PRIVATE KEY-----
<VALID PRIVATE KEY>
-----END PRIVATE KEY-----
publicKeyPem: |
-----BEGIN PUBLIC KEY-----
<VALID PUBLIC KEY>
-----END PUBLIC KEY-----
purpose:
- authorization_request
relyingParties:
- name: "Test Relying Party (Native)"
clientId: "rp1"
clientSecret: "DeepestAndDarkest"
description: "Relying Party Test App"
primaryLogo: "https://placekitten.com/200/200"
primaryLink: "https://example.com"
secondaryLogo: "https://placekitten.com/200/200"
secondaryLink: "https://example2.com"
homeLink: "https://example.com"
explainerVideo:
id: "<YOUTUBE ID>"
provider: youtube
backgroundImage: "https://placekitten.com/800/200"
redirectUri: "http://localhost:3000"
idTokenExpirySeconds: 3600
claims:
- name: "dl_number"
path: "driversLicense.document_number"
brand:
cta: "#0B669D"
primary: "#045199"
header: "#0979c4"
scopes:
- name: "openid"
description: "Open ID Connect"
workflow:
type: native
id: z1A32xJZGqBeAEcMq56avmw2L
untrustedVariableAllowList:
- exampleParam
- exampleParam2
initialStep: default
steps:
default:
callback:
url: http://localhost:9000/callback
headersVariable: callbackHeaders
oauth:
issuer: http://example.com
token_url: http://example.com/token
client_secret: exampleClientSecret
client_id: exampleClientId
scope:
- default
createChallenge: true
verifiablePresentationRequest: >
{
"query": {
"type": "QueryByExample",
"credentialQuery": {
"reason": "Please present your VC.",
"example": {
"type": [
"Iso18013DriversLicenseCredential"
]
}
}
}
}
constraintsOverride: >
{
"fields": [
{
"path": [
"$.vc.type"
],
"filter": {
"type": "string",
"pattern": "Iso18013DriversLicenseCredential"
}
}
]
}
- name: "Test App"
# An example that uses a remove VC-API exchanger to connect with a wallet
# See Verifiable Credentials API Documentation: https://w3c-ccg.github.io/vc-api/
clientId: "32bb6cec384b"
clientSecret: "DeepestAndDarkest"
description: "Relying Party Test App"
icon: "https://placekitten.com/200/200"
backgroundImage: "https://placekitten.com/800/300"
idTokenExpirySeconds: 3600
brand:
cta: "#0B669D"
primary: "#045199"
header: "#0979c4"
redirectUri: "http://localhost:3000"
scopes:
- name: "openid"
description: "Open ID Connect"
claims:
- name: "email"
path: "email"
workflow:
type: vc-api
baseUrl: https://example.org/exchanges/123
capability: "example"
clientSecret: "example"
- clientId: 4e3a8b7b4b7b4b7b4b7b
# Microsoft Entra Verified Id workflow config
# Many of these config fields map to request fields in the APIs linked below:
# https://learn.microsoft.com/en-us/entra/verified-id/get-started-request-api
# https://learn.microsoft.com/en-us/entra/verified-id/presentation-request-api
caStore: false
configFrom: 32bb6cec384b # clientId of another relying party to serve as default values
trustedCredentialIssuers:
- did:web:example.com
workflow:
type: microsoft-entra-verified-id
apiBaseUrl: https://api.entra.microsoft.example.com/v1.0 # required (will generally be https://verifiedid.did.msidentity.com/v1.0)
apiLoginBaseUrl: https://login.entra.microsoft.example.com # required (will generally be https://login.microsoftonline.com)
apiClientId: "TODO" # required
apiClientSecret: "TODO" # required
apiTenantId: "TODO" # required
verifierDid: "TODO" # required
verifierName: "TODO" # required
credentialVerificationPurpose: "So that we can evaluate your permission to access the requested resource" # optional (default populated in middleware unless overridden here)
allowRevokedCredentials: false # optional (default populated in middleware unless overridden here)
validateLinkedDomain: false # optional (default populated in middleware unless overridden here)
includeQrCode: true # optional (default populated in middleware unless overridden here)
initialStep: default
steps:
default:
acceptedCredentialType: "TODO" # required
- name: "load-test"
clientId: "load-test"
clientSecret: "DeepestAndDarkest"
description: "Load Testing Profile"
icon: "https://imagedelivery.net/I-hc6FAYxquPgv-npvTcWQ/241cb0c9-d92c-40b7-1745-6d5e68a45d00/public"
backgroundImage: "https://imagedelivery.net/I-hc6FAYxquPgv-npvTcWQ/f7516576-f9d3-4a15-1b9e-e95281613700/public"
redirectUri: "http://localhost:3000"
idTokenExpirySeconds: 3600
claims:
- name: "dl_number"
path: "driversLicense.document_number"
brand:
cta: "#0B669D"
primary: "#045199"
header: "#0979c4"
scopes:
- name: "openid"
description: "Open ID Connect"
workflow:
type: native
id: load-test
initialStep: default
steps:
default:
createChallenge: true
verifiablePresentationRequest: >
{
"query": {
"type": "QueryByExample",
"credentialQuery": {
"reason": "Please present your VC.",
"example": {
"type": [
"DomainLinkageCredential"
]
}
}
}
}
constraintsOverride: >
{
"fields": [
{
"path": [
"$.vc.type"
],
"filter": {
"type": "string",
"pattern": "DomainLinkageCredential"
}
}
]
}
options:
exchangeProtocols:
- chapi
- openid4vp
defaultBrand:
cta: "#0B669D"
primary: "#045199"
header: "#0979c4"
audit:
enable: true
fields:
- type: text
id: given_name
name: First Name
path: "$.credentialSubject.given_name"
required: true
- type: text
id: family_name
name: Last Name
path: "$.credentialSubject.family_name"
required: false
- type: date
id: birth_date
name: Date of Birth
path: "$.credentialSubject.birth_date"
required: true
- type: number
id: height
name: Height (cm)
path: "$.credentialSubject.height"
required: false
- type: dropdown
id: sex
name: Sex
path: "$.credentialSubject.sex"
required: false
options:
"Male": 1
"Female": 2
- type: dropdown
id: senior_citizen
name: Are you a senior citizen?
path: "$.credentialSubject.senior_citizen"
required: true
options:
"Yes": 1
"No": null
default: "No"
reCaptcha:
enable: true
version: 2
siteKey: 6LcNDSjdAAAAAAAAIe2uy0gavf0reiuhfer12345
secretKey: 6LcNDSjdAAAAAAAAIe3uy1gavf1reiuhfer67890
pages:
- audit
exchangeActiveExpirySeconds: 300
defaultLanguage: en
translations:
en:
qrTitle: Login with your Wallet app
qrPageExplain: Scan the following QR Code using the Wallet app on your phone.
qrPageExplainHelp: (<a href="https://youtube.com">How do I do it?</a>)
qrFooter: "Note: Already on your phone with the Wallet app? Open the Wallet app, then come back and tap on the QR code above."
qrFooterHelp: Difficulty using the Wallet app to login? revert to using password <a href="#">here</a>
qrDisclaimer: If you don't have a Wallet app download it from the app store.
qrExplainerText: (How do I do it?)
chapiPageAnotherWay: "Looking for a QR code to scan with your wallet app instead?"
loginCta: "Login with your credential wallet"
loginExplain: "To login with your credential wallet, you will need to have the credential wallet app <with configurable URL to app stores> installed"
appInstallExplain: "If you don't have a credential wallet yet, you can get one by downloading the credential wallet app <with configurable URL to app stores>"
appCta: "Open wallet app"
copyright: "Powered by OpenCred"
pageTitle: "Login"
home: "Home"
verificationSuccess: "Success! Your credential has been shared."
exchangeActiveGoBack: Back
exchangeActiveExpiryMessage: "Please complete within the allotted time:"
exchangeErrorTitle: Exchange failed
exchangeErrorSubtitle: "Error details:"
exchangeResetTitle: Please try again.
exchangeReset: Retry exchange