| 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 |
1x
1x
1x
| /**
* Local dependencies
*/
const {JWTSchema} = require('@trust/jose')
/**
* IDToken Schema
*/
const IDTokenSchema = JWTSchema.extend({
properties: {
/**
* header
* http://openid.net/specs/openid-connect-core-1_0.html#IDToken
* ID Tokens SHOULD NOT use the JWS or JWE x5u, x5c, jku, or jwk Header
* Parameter fields. Instead, references to keys used are communicated in
* advance using Discovery and Registration parameters, per Section 10.
*/
header: {
//not: { required: ['x5u', 'x5c', 'jku', 'jwk'] }
},
/**
* payload
*/
payload: {
properties: {
/**
* iss
*
* REQUIRED. Issuer Identifier for the Issuer of the response.
* The iss value is a case sensitive URL using the https scheme
* that contains scheme, host, and optionally, port number and
* path components and no query or fragment components.
*/
iss: { type: 'string', format: 'uri' },
/**
* sub
*
* REQUIRED. Subject Identifier. A locally unique and never
* reassigned identifier within the Issuer for the End-User, which
* is intended to be consumed by the Client, e.g., 24400320 or
* AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4. It MUST NOT exceed 255
* ASCII characters in length. The sub value is a case sensitive
* string.
*/
sub: { type: 'string', maxLength: 255 },
/**
* aud
*
* REQUIRED. Audience(s) that this ID Token is intended for. It
* MUST contain the OAuth 2.0 client_id of the Relying Party as an
* audience value. It MAY also contain identifiers for other audiences.
* In the general case, the aud value is an array of case sensitive
* strings. In the common special case when there is one audience,
* the aud value MAY be a single case sensitive string.
*/
// inherited from JWTClaimsSetSchema
/**
* exp
*
* REQUIRED. Expiration time on or after which the ID Token MUST NOT
* be accepted for processing. The processing of this parameter
* requires that the current date/time MUST be before the expiration
* date/time listed in the value. Implementers MAY provide for some
* small leeway, usually no more than a few minutes, to account for
* clock skew. Its value is a JSON number representing the number of
* seconds from 1970-01-01T0:0:0Z as measured in UTC until the
* date/time. See RFC 3339 [RFC3339] for details regarding date/times
* in general and UTC in particular.
*/
// inherited from JWTClaimsSetSchema
/**
* iat
*
* REQUIRED. Time at which the JWT was issued. Its value is a
* JSON number representing the number of seconds from
* 1970-01-01T0:0:0Z as measured in UTC until the date/time.
*/
// inherited from JWTClaimsSetSchema
/**
* auth_time
*
* Time when the End-User authentication occurred. Its value is a
* JSON number representing the number of seconds from
* 1970-01-01T0:0:0Z as measured in UTC until the date/time. When a
* max_age request is made or when auth_time is requested as an
* Essential Claim, then this Claim is REQUIRED; otherwise, its
* inclusion is OPTIONAL. (The auth_time Claim semantically
* corresponds to the OpenID 2.0 PAPE [OpenID.PAPE] auth_time
* response parameter.)
*/
auth_time: { type: 'integer', format: 'NumericDate' },
/**
* nonce
*
* String value used to associate a Client session with an ID Token,
* and to mitigate replay attacks. The value is passed through
* unmodified from the Authentication Request to the ID Token. If
* present in the ID Token, Clients MUST verify that the nonce Claim
* Value is equal to the value of the nonce parameter sent in the
* Authentication Request. If present in the Authentication Request,
* Authorization Servers MUST include a nonce Claim in the ID Token
* with the Claim Value being the nonce value sent in the
* Authentication Request. Authorization Servers SHOULD perform no
* other processing on nonce values used. The nonce value is a case
* sensitive string.
*/
nonce: { type: 'string' },
/**
* acr
*
* OPTIONAL. Authentication Context Class Reference. String
* specifying an Authentication Context Class Reference value that
* identifies the Authentication Context Class that the authentication
* performed satisfied. The value "0" indicates the End-User
* authentication did not meet the requirements of ISO/IEC 29115
* [ISO29115] level 1. Authentication using a long-lived browser
* cookie, for instance, is one example where the use of "level 0" is
* appropriate. Authentications with level 0 SHOULD NOT be used to
* authorize access to any resource of any monetary value. (This
* corresponds to the OpenID 2.0 PAPE [OpenID.PAPE] nist_auth_level
* 0.) An absolute URI or an RFC 6711 [RFC6711] registered name
* SHOULD be used as the acr value; registered names MUST NOT be used
* with a different meaning than that which is registered. Parties
* using this claim will need to agree upon the meanings of the
* values used, which may be context-specific. The acr value is a
* case sensitive string.
*/
acr: { type: 'string' },
/**
* amr
* OPTIONAL. Authentication Methods References. JSON array of strings
* that are identifiers for authentication methods used in the
* authentication. For instance, values might indicate that both
* password and OTP authentication methods were used. The definition
* of particular values to be used in the amr Claim is beyond the
* scope of this specification. Parties using this claim will need to
* agree upon the meanings of the values used, which may be context-
* specific. The amr value is an array of case sensitive strings.
*/
amr: { type: 'array', items: { type: 'string' } },
/**
* azp
* OPTIONAL. Authorized party - the party to which the ID Token was
* issued. If present, it MUST contain the OAuth 2.0 Client ID of this
* party. This Claim is only needed when the ID Token has a single
* audience value and that audience is different than the authorized
* party. It MAY be included even when the authorized party is the
* same as the sole audience. The azp value is a case sensitive string
* containing a StringOrURI value.
*/
azp: { type: 'string', format: 'StringOrURI' },
/**
* at_hash
* Access Token hash value. Its value is the base64url encoding of the
* left-most half of the hash of the octets of the ASCII representation
* of the access_token value, where the hash algorithm used is the hash
* algorithm used in the alg Header Parameter of the ID Token's JOSE
* Header. For instance, if the alg is RS256, hash the access_token value
* with SHA-256, then take the left-most 128 bits and base64url encode
* them. The at_hash value is a case sensitive string.
* If the ID Token is issued from the Authorization Endpoint with an
* access_token value, which is the case for the response_type value code
* id_token token, this is REQUIRED; otherwise, its inclusion is
* OPTIONAL.
*/
at_hash: { type: 'string' },
/**
* c_hash
* Code hash value. Its value is the base64url encoding of the left-most
* half of the hash of the octets of the ASCII representation of the code
* value, where the hash algorithm used is the hash algorithm used in the
* alg Header Parameter of the ID Token's JOSE Header. For instance, if
* the alg is HS512, hash the code value with SHA-512, then take the left-
* most 256 bits and base64url encode them. The c_hash value is a case
* sensitive string.
* If the ID Token is issued from the Authorization Endpoint with a code,
* which is the case for the response_type values code id_token and code
* id_token token, this is REQUIRED; otherwise, its inclusion is OPTIONAL.
*/
c_hash: { type: 'string' }
},
/**
* Required Claims
*/
required: ['iss', 'sub', 'aud', 'exp', 'iat']
}
}
})
/**
* Export
*/
module.exports = IDTokenSchema
|