-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
well_known.go
241 lines (179 loc) · 9.04 KB
/
well_known.go
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
// Code generated by go-swagger; DO NOT EDIT.
package models
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
strfmt "github.com/go-openapi/strfmt"
"github.com/go-openapi/errors"
"github.com/go-openapi/swag"
"github.com/go-openapi/validate"
)
// WellKnown WellKnown represents important OpenID Connect discovery metadata
//
// It includes links to several endpoints (e.g. /oauth2/token) and exposes information on supported signature algorithms
// among others.
// swagger:model WellKnown
type WellKnown struct {
// URL of the OP's OAuth 2.0 Authorization Endpoint.
// Required: true
AuthURL *string `json:"authorization_endpoint"`
// Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP
// session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP
BackChannelLogoutSessionSupported bool `json:"backchannel_logout_session_supported,omitempty"`
// Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
BackChannelLogoutSupported bool `json:"backchannel_logout_supported,omitempty"`
// Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
ClaimsParameterSupported bool `json:"claims_parameter_supported,omitempty"`
// JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply
// values for. Note that for privacy or other reasons, this might not be an exhaustive list.
ClaimsSupported []string `json:"claims_supported"`
// URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
EndSessionEndpoint string `json:"end_session_endpoint,omitempty"`
// Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify
// the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also
// included in ID Tokens issued by the OP.
FrontChannelLogoutSessionSupported bool `json:"frontchannel_logout_session_supported,omitempty"`
// Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.
FrontChannelLogoutSupported bool `json:"frontchannel_logout_supported,omitempty"`
// JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
GrantTypesSupported []string `json:"grant_types_supported"`
// JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token
// to encode the Claims in a JWT.
// Required: true
IDTokenSigningAlgValuesSupported []string `json:"id_token_signing_alg_values_supported"`
// URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier.
// If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned
// by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.
// Required: true
Issuer *string `json:"issuer"`
// URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate
// signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs
// to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use)
// parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage.
// Although some algorithms allow the same key to be used for both signatures and encryption, doing so is
// NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of
// keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
// Required: true
JWKsURI *string `json:"jwks_uri"`
// URL of the OP's Dynamic Client Registration Endpoint.
RegistrationEndpoint string `json:"registration_endpoint,omitempty"`
// Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
RequestParameterSupported bool `json:"request_parameter_supported,omitempty"`
// Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
RequestURIParameterSupported bool `json:"request_uri_parameter_supported,omitempty"`
// Boolean value specifying whether the OP requires any request_uri values used to be pre-registered
// using the request_uris registration parameter.
RequireRequestURIRegistration bool `json:"require_request_uri_registration,omitempty"`
// JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
ResponseModesSupported []string `json:"response_modes_supported"`
// JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID
// Providers MUST support the code, id_token, and the token id_token Response Type values.
// Required: true
ResponseTypes []string `json:"response_types_supported"`
// URL of the authorization server's OAuth 2.0 revocation endpoint.
RevocationEndpoint string `json:"revocation_endpoint,omitempty"`
// SON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST
// support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used
ScopesSupported []string `json:"scopes_supported"`
// JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include
// pairwise and public.
// Required: true
SubjectTypes []string `json:"subject_types_supported"`
// JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are
// client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0
TokenEndpointAuthMethodsSupported []string `json:"token_endpoint_auth_methods_supported"`
// URL of the OP's OAuth 2.0 Token Endpoint
// Required: true
TokenURL *string `json:"token_endpoint"`
// URL of the OP's UserInfo Endpoint.
UserinfoEndpoint string `json:"userinfo_endpoint,omitempty"`
// JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
UserinfoSigningAlgValuesSupported []string `json:"userinfo_signing_alg_values_supported"`
}
// Validate validates this well known
func (m *WellKnown) Validate(formats strfmt.Registry) error {
var res []error
if err := m.validateAuthURL(formats); err != nil {
res = append(res, err)
}
if err := m.validateIDTokenSigningAlgValuesSupported(formats); err != nil {
res = append(res, err)
}
if err := m.validateIssuer(formats); err != nil {
res = append(res, err)
}
if err := m.validateJWKsURI(formats); err != nil {
res = append(res, err)
}
if err := m.validateResponseTypes(formats); err != nil {
res = append(res, err)
}
if err := m.validateSubjectTypes(formats); err != nil {
res = append(res, err)
}
if err := m.validateTokenURL(formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *WellKnown) validateAuthURL(formats strfmt.Registry) error {
if err := validate.Required("authorization_endpoint", "body", m.AuthURL); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateIDTokenSigningAlgValuesSupported(formats strfmt.Registry) error {
if err := validate.Required("id_token_signing_alg_values_supported", "body", m.IDTokenSigningAlgValuesSupported); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateIssuer(formats strfmt.Registry) error {
if err := validate.Required("issuer", "body", m.Issuer); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateJWKsURI(formats strfmt.Registry) error {
if err := validate.Required("jwks_uri", "body", m.JWKsURI); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateResponseTypes(formats strfmt.Registry) error {
if err := validate.Required("response_types_supported", "body", m.ResponseTypes); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateSubjectTypes(formats strfmt.Registry) error {
if err := validate.Required("subject_types_supported", "body", m.SubjectTypes); err != nil {
return err
}
return nil
}
func (m *WellKnown) validateTokenURL(formats strfmt.Registry) error {
if err := validate.Required("token_endpoint", "body", m.TokenURL); err != nil {
return err
}
return nil
}
// MarshalBinary interface implementation
func (m *WellKnown) MarshalBinary() ([]byte, error) {
if m == nil {
return nil, nil
}
return swag.WriteJSON(m)
}
// UnmarshalBinary interface implementation
func (m *WellKnown) UnmarshalBinary(b []byte) error {
var res WellKnown
if err := swag.ReadJSON(b, &res); err != nil {
return err
}
*m = res
return nil
}