forked from openid-foundation-japan/connect-spec-draft
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenid-connect-discovery-1_0.xml
executable file
·2054 lines (1805 loc) · 76.1 KB
/
openid-connect-discovery-1_0.xml
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="US-ASCII"?>
<?xml-stylesheet type='text/xsl' href='http://xml.resource.org/authoring/rfc2629.xslt' ?>
<!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN"
"http://xml.resource.org/authoring/rfc2629.dtd">
<rfc category="std" docName="openid-connect-discovery-1_0" ipr="trust200902">
<?rfc toc="yes" ?>
<?rfc tocdepth="5" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc strict="yes" ?>
<?rfc iprnotified="no" ?>
<?rfc private="Draft" ?>
<front>
<title abbrev="OpenID Connect Discovery 1.0">OpenID Connect Discovery 1.0 - draft 21</title>
<author fullname="Nat Sakimura" initials="N." surname="Sakimura">
<organization abbrev="NRI">Nomura Research Institute, Ltd.</organization>
<address>
<email>n-sakimura@nri.co.jp</email>
<uri>http://nat.sakimura.org/</uri>
</address>
</author>
<author fullname="John Bradley" initials="J." surname="Bradley">
<organization abbrev="Ping Identity">Ping Identity</organization>
<address>
<email>ve7jtb@ve7jtb.com</email>
<uri>http://www.thread-safe.com/</uri>
</address>
</author>
<author fullname="Michael B. Jones" initials="M.B." surname="Jones">
<organization abbrev="Microsoft">Microsoft</organization>
<address>
<email>mbj@microsoft.com</email>
<uri>http://self-issued.info/</uri>
</address>
</author>
<author fullname="Edmund Jay" initials="E." surname="Jay">
<organization abbrev="Illumila">Illumila</organization>
<address>
<email>ejay@mgi1.com</email>
</address>
</author>
<date day="19" month="December" year="2013" />
<workgroup>OpenID Connect Working Group</workgroup>
<abstract>
<t>OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0
protocol. It enables Clients to verify the identity of the End-User based
on the authentication performed by an Authorization Server, as well as to
obtain basic profile information about the End-User in an interoperable and
REST-like manner.</t>
<t>
This specification defines a mechanism for an OpenID Connect Relying Party
to discover the End-User's OpenID Provider
and obtain information needed to interact with it,
including its OAuth 2.0 endpoint locations.
</t>
</abstract>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t>
OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0
<xref target="RFC6749"/>
protocol. It enables Clients to verify the identity of the End-User based
on the authentication performed by an Authorization Server, as well as to
obtain basic profile information about the End-User in an interoperable and
REST-like manner.
</t>
<t>
In order for an OpenID Connect Relying Party to utilize OpenID Connect services for
an End-User, the RP needs to know where the OpenID Provider is.
OpenID Connect uses <xref target="RFC7033">WebFinger</xref> to locate
the OpenID Provider for an End-User.
This process is described in <xref target="IssuerDiscovery"/>.
</t>
<t>
Once the OpenID Provider has been identified,
the configuration information for that OP
is retrieved from a well-known location as a JSON document,
including its OAuth 2.0 endpoint locations.
This process is described in <xref target="ProviderConfig"/>.
</t>
<section anchor="rnc" title="Requirements Notation and Conventions">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref
target="RFC2119">RFC 2119</xref>.</t>
<t>
In the .txt version of this document,
values are quoted to indicate that they are to be taken literally.
When using these values in protocol messages,
the quotes MUST NOT be used as part of the value.
In the HTML version of this document,
values to be taken literally are indicated by
the use of <spanx style="verb">this fixed-width font</spanx>.
</t>
<t>
All uses of <xref target="JWS">JSON Web Signature (JWS)</xref>
and <xref target="JWE">JSON Web Encryption (JWE)</xref>
data structures in this specification utilize
the JWS Compact Serialization or the JWE Compact Serialization;
the JWS JSON Serialization and the JWE JSON Serialization are not used.
</t>
</section>
<section anchor="Terminology" title="Terminology">
<t>
This specification uses the terms "Access Token", "Authorization Code",
"Authorization Endpoint", "Authorization Grant", "Authorization Server",
"Client", "Client Authentication", "Client Identifier", "Client Secret",
"Grant Type", "Protected Resource", "Redirection URI", "Refresh Token",
"Resource Owner", "Resource Server", "Response Type", and "Token Endpoint"
defined by <xref target="RFC6749">OAuth 2.0</xref>,
the terms "Claim Name", "Claim Value", and "JSON Web Token (JWT)"
defined by <xref target="JWT">JSON Web Token (JWT)</xref>,
and the terms defined by
<xref target="OpenID.Core">OpenID Connect Core 1.0</xref> and
<xref target="OAuth.Responses">OAuth 2.0 Multiple Response Type Encoding Practices</xref>.
</t>
<t>
This specification also defines the following terms:
<list style="hanging">
<t hangText="Resource">
Entity that is the target of a request in WebFinger.
</t>
<t hangText="Host">
Server where a WebFinger service is hosted.
</t>
<t hangText="Identifier">
Value that uniquely characterizes an Entity in a specific context.
</t>
<t>
NOTE: this document defines various kinds of Identifiers, designed for use in different contexts.
Examples include URLs using the <spanx style="verb">https</spanx> scheme and e-mail addresses.
</t>
</list>
</t>
<t>
IMPORTANT NOTE TO READERS: The terminology definitions in
this section are a normative portion of this specification,
imposing requirements upon implementations. All the
capitalized words in the text of this specification, such as
"Identifier", reference these defined terms.
Whenever the reader encounters them, their definitions
found in this section must be followed.
</t>
</section>
</section>
<section anchor="IssuerDiscovery" title="OpenID Provider Issuer Discovery">
<t>
OpenID Provider Issuer discovery is the process of determining
the location of the OpenID Provider.
</t>
<t>
Issuer discovery is OPTIONAL; if a Relying Party knows the
OP's Issuer location through an out-of-band mechanism, it can skip this step
and proceed to <xref target="ProviderConfig"></xref>.
</t>
<t>
Issuer discovery requires the following information to make a
discovery request:
</t>
<t><list style="hanging">
<t hangText="resource">
Identifier for the target End-User that is the
subject of the discovery request.
</t>
<t hangText="host">
Server where a WebFinger service is hosted.
</t>
<t hangText="rel">
URI identifying the type of service whose location is being requested.
</t>
</list></t>
<t>OpenID Connect uses the following discoverable
<spanx style="verb">rel</spanx> value in
<xref target="RFC7033">WebFinger</xref>:</t>
<texttable align="center" style="all">
<ttcol>Rel Type</ttcol>
<ttcol>URI</ttcol>
<c>OpenID Connect Issuer</c>
<c>http://openid.net/specs/connect/1.0/issuer</c>
</texttable>
<t>To start discovery of OpenID endpoints, the End-User supplies an
Identifier to the Relying Party. The RP applies
normalization rules to the Identifier to determine the Resource and Host.
Then it makes an HTTP <spanx style="verb">GET</spanx> request to the Host's
<xref target="RFC7033">WebFinger</xref>
endpoint with the <spanx style="verb">resource</spanx> and <spanx
style="verb">rel</spanx> parameters to obtain the location of the
requested service.
All WebFinger communication MUST utilize TLS
in the manner described in <xref target="TLSRequirements"/>.
</t>
<t>
The Issuer location MUST be returned in the WebFinger response
as the value of the <spanx style="verb">href</spanx> member of
a <spanx style="verb">links</spanx> array element
with <spanx style="verb">rel</spanx> member value
<spanx style="verb">http://openid.net/specs/connect/1.0/issuer</spanx>.
(Per Section 7 of <xref target="RFC7033">WebFinger</xref>, obtaining the
WebFinger response may first involve following some redirects.)
</t>
<t>
The returned Issuer location MUST be a URI <xref target="RFC3986">RFC 3986</xref>
with a scheme component that MUST be <spanx style="verb">https</spanx>,
a host component, and optionally, port and path components
and no query or fragment components.
Note that since the Host and Resource values determined from
the user input Identifier,
as described in <xref target="IdentifierNormalization"/>,
are used as input to a WebFinger request,
which can return an Issuer value using a completely different
scheme, host, port, and path, no relationship can be assumed between
the user input Identifier string and the resulting Issuer location.
</t>
<section anchor="IdentifierNormalization" title="Identifier Normalization">
<t>
The purpose of Identifier normalization is to determine normalized
Resource and Host values from the user input Identifier.
These are then used as WebFinger request parameters
to discover the Issuer location.
</t>
<t>
The user input Identifier SHOULD be a URL or URI relative reference
defined in <xref target="RFC3986">RFC 3986</xref>.
The user input Identifier MUST
include the authority component.
</t>
<t>
NOTE: A URI relative reference includes a string that looks like
an e-mail address in the form of <spanx style="verb">userinfo@host</spanx>.
This is a valid authority component of a URI
but excludes various possible extra strings allowed in
<spanx style="verb">addr-spec</spanx> syntax of
<xref target="RFC5322">RFC 5322</xref>.
</t>
<t>
The Identifier normalization rules MAY be extended by
additional specifications to enable other identifier types
such as telephone numbers or <xref
target="XRI_Syntax_2.0">XRIs</xref> to also be used.
</t>
<section anchor="IdentifierTypes" title="User Input Identifier Types">
<t>
A user input Identifier can be categorized into the following
types, which require different normalization processes:
</t>
<t>
<list style="numbers">
<t>User input Identifiers starting with the <xref
target="XRI_Syntax_2.0">XRI</xref> global context
symbols ('=','@', and '!') are RESERVED. Processing of
these identifiers is out of scope for this
specification.</t>
<t>All other user input Identifiers MUST be treated as
a URI in one of the forms
<spanx style="verb">scheme "://" authority path-abempty [ "?" query ] [ "#" fragment ]</spanx>
or
<spanx style="verb">authority path-abempty [ "?" query ] [ "#" fragment ]</spanx>
or
<spanx style="verb">scheme ":" path-rootless</spanx>,
per <xref target="RFC3986">RFC 3986</xref>.
</t>
</list>
</t>
<t>
NOTE: The user input Identifier MAY be in the form
of <spanx style="verb">userinfo@host</spanx>.
For the End-User, this would normally be perceived as being an e-mail address.
However, it is also
a valid userpart "@" host section of an <spanx style="verb">acct</spanx> URI
<xref target="I-D.ietf-appsawg-acct-uri"/>,
and this specification
treats it such as to exclude various
extra strings allowed in <spanx style="verb">addr-spec</spanx> of
<xref target="RFC5322">RFC 5322</xref>.
</t>
</section>
<section anchor="NormalizationSteps" title="Normalization Steps">
<t>
A string of any other type is interpreted as
a URI in one of the forms
<spanx style="verb">scheme "://" authority path-abempty [ "?" query ] [ "#" fragment ]</spanx>
or
<spanx style="verb">authority path-abempty [ "?" query ] [ "#" fragment ]</spanx>
or
<spanx style="verb">scheme ":" path-rootless</spanx>
per <xref target="RFC3986">RFC 3986</xref>
and is normalized according to the following rules:
</t>
<t>
<list style="numbers">
<t>
If the user input Identifier does not have an
<xref target="RFC3986">RFC 3986</xref> scheme component,
the string is interpreted as
<spanx style="verb">[userinfo "@"] host [":" port] path-abempty [ "?" query ] [ "#" fragment ]</spanx>
per <xref target="RFC3986">RFC 3986</xref>.
Examples are
<spanx style="verb">example.com</spanx>,
<spanx style="verb">joe@example.com</spanx>,
<spanx style="verb">example.com/joe</spanx>, and
<spanx style="verb">example.com:8080</spanx>.
</t>
<t>
If the userinfo and host components are present and all of the
scheme, path, query, port, and fragment components are absent,
the <spanx style="verb">acct</spanx> scheme is assumed.
In this case, the normalized URI is formed by
prefixing <spanx style="verb">acct:</spanx> to the string as the scheme.
Per <xref target="I-D.ietf-appsawg-acct-uri">The 'acct' URI Scheme</xref>,
if there is an at-sign character ('@') in the userinfo component, it needs to be
percent-encoded, as described in <xref target="RFC3986">RFC 3986</xref>.
Examples are
<spanx style="verb">joe@example.com</spanx> and
<spanx style="verb">Jane.Doe@example.com</spanx>.
</t>
<t>
For all other inputs without a scheme component,
the <spanx style="verb">https</spanx> scheme is assumed,
and the normalized URI is formed by
prefixing <spanx style="verb">https://</spanx> to the string as the scheme.
Examples are
<spanx style="verb">example.com</spanx>,
<spanx style="verb">example.com/joe</spanx>,
<spanx style="verb">example.com:8080</spanx>, and
<spanx style="verb">joe@example.com:8080</spanx>.
</t>
<t>
When the input contains an explicit scheme such as
<spanx style="verb">acct</spanx> or <spanx style="verb">https</spanx>
that matches the RFC 3986
<spanx style="verb">scheme ":" path-rootless</spanx> syntax,
no input normalization is performed.
Examples are
<spanx style="verb">https://example.com</spanx>,
<spanx style="verb">https://example.com/joe</spanx>,
<spanx style="verb">https://joe@example.com:8080</spanx>, and
<spanx style="verb">acct:joe@example.com</spanx>.
</t>
<t>
If the resulting URI contains a fragment component, it MUST be
stripped off, together with the fragment delimiter
character "#".
</t>
</list>
</t>
<t>
The <xref target="RFC7033">WebFinger</xref> Resource
in this case is the resulting URI, and
the WebFinger Host is the authority component.
</t>
<t>
NOTE: Since the definition of <spanx style="verb">authority</spanx>
in <xref target="RFC3986">RFC 3986</xref>
is <spanx style="verb">[ userinfo "@" ] host [ ":" port ]</spanx>,
it is legal to have a user input identifier like
<spanx style="verb">userinfo@host:port</spanx>, e.g.,
<spanx style="verb">alice@example.com:8080</spanx>.
</t>
</section>
</section>
<section anchor="Examples" title="Non-Normative Examples">
<section anchor="EmailSyntax" title="User Input using E-Mail Address Syntax">
<t>To find the Issuer for the given user input
in the form of an e-mail address <spanx style="verb">joe@example.com</spanx>,
the WebFinger parameters are as follows:</t>
<texttable>
<ttcol>WebFinger Parameter</ttcol>
<ttcol>Value</ttcol>
<c>resource</c>
<c>acct:joe@example.com</c>
<c>host</c>
<c>example.com</c>
<c>rel</c>
<c>http://openid.net/specs/connect/1.0/issuer</c>
</texttable>
<t>
Note that in this case, the <spanx style="verb">acct:</spanx> scheme
<xref target="I-D.ietf-appsawg-acct-uri"/> is prepended to the Identifier.
</t>
<t>
<figure>
<preamble>The RP would make the
following WebFinger request to discover the Issuer location
(with line wraps within lines for display purposes only):</preamble>
<artwork><![CDATA[
GET /.well-known/webfinger
?resource=acct%3Ajoe%40example.com
&rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer
HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
Content-Type: application/jrd+json
{
"subject": "acct:joe@example.com",
"links":
[
{
"rel": "http://openid.net/specs/connect/1.0/issuer",
"href": "https://server.example.com"
}
]
}
]]></artwork>
</figure>
</t>
</section>
<section anchor="URLSyntax" title="User Input using URL Syntax">
<t>To find the Issuer for the given URL,
<spanx style="verb">https://example.com/joe</spanx>, the WebFinger
parameters are as follows:</t>
<texttable>
<ttcol>WebFinger Parameter</ttcol>
<ttcol>Value</ttcol>
<c>resource</c>
<c>https://example.com/joe</c>
<c>host</c>
<c>example.com</c>
<c>rel</c>
<c>http://openid.net/specs/connect/1.0/issuer</c>
</texttable>
<t><figure>
<preamble>The RP would make the
following WebFinger request to discover the Issuer location
(with line wraps within lines for display purposes only):</preamble>
<artwork><![CDATA[
GET /.well-known/webfinger
?resource=https%3A%2F%2Fexample.com%2Fjoe
&rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer
HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
Content-Type: application/jrd+json
{
"subject": "https://example.com/joe",
"links":
[
{
"rel": "http://openid.net/specs/connect/1.0/issuer",
"href": "https://server.example.com"
}
]
}
]]></artwork>
</figure></t>
</section>
<section anchor="HostPortExample" title="User Input using Hostname and Port Syntax">
<t>
If the user input is in the form of
<spanx style="verb">host:port</spanx>, e.g., example.com:8080,
then it is assumed as the authority component of the URL.
</t>
<t>To find the Issuer for the given
hostname, <spanx style="verb">example.com:8080</spanx>, the WebFinger
parameters are as follows:</t>
<texttable>
<ttcol>WebFinger Parameter</ttcol>
<ttcol>Value</ttcol>
<c>resource</c>
<c>https://example.com:8080/</c>
<c>host</c>
<c>example.com:8080</c>
<c>rel</c>
<c>http://openid.net/specs/connect/1.0/issuer</c>
</texttable>
<t><figure>
<preamble>The RP would make the
following WebFinger request to discover the Issuer location
(with line wraps within lines for display purposes only):</preamble>
<artwork><![CDATA[
GET /.well-known/webfinger
?resource=https%3A%2F%2Fexample.com%3A8080%2F
&rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer
HTTP/1.1
Host: example.com:8080
HTTP/1.1 200 OK
Content-Type: application/jrd+json
{
"subject": "https://example.com:8080/",
"links":
[
{
"rel": "http://openid.net/specs/connect/1.0/issuer",
"href": "https://server.example.com"
}
]
}
]]></artwork>
</figure></t>
</section>
<section anchor="AcctURISyntax" title='User Input using "acct" URI Syntax'>
<t>To find the Issuer for the given user input
in the form of an account URI
<spanx style="verb">acct:juliet%40capulet.example@shopping.example.com</spanx>,
the WebFinger parameters are as follows:</t>
<texttable>
<ttcol>WebFinger Parameter</ttcol>
<ttcol>Value</ttcol>
<c>resource</c>
<c>acct:juliet%40capulet.example@shopping.example.com</c>
<c>host</c>
<c>shopping.example.com</c>
<c>rel</c>
<c>http://openid.net/specs/connect/1.0/issuer</c>
</texttable>
<t>
<figure>
<preamble>The RP would make the
following WebFinger request to discover the Issuer location
(with line wraps within lines for display purposes only):</preamble>
<artwork><![CDATA[
GET /.well-known/webfinger
?resource=acct%3Ajuliet%2540capulet.example%40shopping.example.com
&rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer
HTTP/1.1
Host: shopping.example.com
HTTP/1.1 200 OK
Content-Type: application/jrd+json
{
"subject": "acct:juliet%40capulet.example@shopping.example.com",
"links":
[
{
"rel": "http://openid.net/specs/connect/1.0/issuer",
"href": "https://server.example.com"
}
]
}
]]></artwork>
</figure>
</t>
<t>
NOTE: It is common for sites to use e-mail addresses as local identifiers
for accounts at those sites, even though the domain in the e-mail address
one controlled by the site.
For instance, the site <spanx style="verb">example.org</spanx>
might have a local account named <spanx style="verb">joe@example.com</spanx>.
As of the time of this writing, a discussion is ongoing among WebFinger
contributors about the syntax that should be used when discovering
information about such accounts with WebFinger.
The current thinking seems to be that such accounts would be represented
by quoting the '@' character in the userinfo component of the account
identifier when constructing the <spanx style="verb">acct:</spanx> URI
representing the account.
Such an example is
<spanx style="verb">acct:joe%40example.com@example.org</spanx>.
In a future version of this specification, it is possible that
normalization rules will be defined allowing End-Users to input
values like <spanx style="verb">joe@example.com@example.org</spanx>
to initiate discovery on such accounts.
</t>
</section>
</section>
</section>
<section anchor="ProviderMetadata" title="OpenID Provider Metadata">
<t>
OpenID Providers have metadata describing their configuration.
These OpenID Provider Metadata values are used by OpenID Connect:
<list style="hanging">
<t hangText="issuer">REQUIRED.
URL using the <spanx style="verb">https</spanx> scheme with no query or fragment component that the OP asserts as its
Issuer Identifier.
If Issuer discovery is supported (see <xref target="IssuerDiscovery"/>),
this value MUST be identical to the issuer value returned by WebFinger.
This also MUST be identical to the <spanx style="verb">iss</spanx> Claim value
in ID Tokens issued from this Issuer.
</t>
<t hangText="authorization_endpoint">
REQUIRED.
URL of the OP's OAuth 2.0 Authorization Endpoint
<xref target="OpenID.Core"/>.
</t>
<t hangText="token_endpoint">
URL of the OP's OAuth 2.0 Token Endpoint
<xref target="OpenID.Core"/>.
This is REQUIRED unless only the Implicit Flow is used.
</t>
<t hangText="userinfo_endpoint">
RECOMMENDED.
URL of the OP's UserInfo Endpoint <xref target="OpenID.Core"/>.
This URL MUST use the <spanx style="verb">https</spanx> scheme and MAY contain
port, path, and query parameter components.
</t>
<t hangText="jwks_uri">
REQUIRED.
URL of the OP's JSON Web Key Set <xref target="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 <spanx style="verb">use</spanx> (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 <spanx style="verb">x5c</spanx> 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.
</t>
<t hangText="registration_endpoint">RECOMMENDED.
URL of the OP's Dynamic Client Registration Endpoint <xref
target="OpenID.Registration"></xref>.
</t>
<t hangText="scopes_supported">RECOMMENDED.
JSON array containing a list of the <xref
target="RFC6749">OAuth 2.0 </xref> scope values that this server
supports. The server MUST support the <spanx style="verb">openid</spanx>
scope value.
Servers MAY choose not to advertise some supported scope values
even when this parameter is used, although those defined in
<xref target="OpenID.Core"/> SHOULD be listed, if supported.
</t>
<t hangText="response_types_supported">REQUIRED.
JSON array containing a list of the OAuth 2.0
<spanx style="verb">response_type</spanx> values that this
OP supports.
Dynamic OpenID Providers MUST support the <spanx style="verb">code</spanx>,
<spanx style="verb">id_token</spanx>, and the <spanx style="verb">token id_token</spanx>
Response Type values.
</t>
<t hangText="response_modes_supported">
OPTIONAL.
JSON array containing a list of the OAuth 2.0
<spanx style="verb">response_mode</spanx> values that this
OP supports, as specified in
<xref target="OAuth.Responses">OAuth 2.0 Multiple Response Type Encoding Practices</xref>.
If omitted, the default for Dynamic OpenID Providers is
<spanx style="verb">["query", "fragment"]</spanx>.
</t>
<t hangText="grant_types_supported">
OPTIONAL.
JSON array containing a list of the OAuth 2.0
Grant Type values that this
OP supports. Dynamic OpenID Providers MUST support the
<spanx style="verb">authorization_code</spanx> and
<spanx style="verb">implicit</spanx> Grant Type values
and MAY support other Grant Types.
If omitted, the default value is
<spanx style="verb">["authorization_code", "implicit"]</spanx>.
</t>
<t hangText="acr_values_supported">OPTIONAL.
JSON array containing a list of the Authentication Context Class References
that this OP supports.
</t>
<t hangText="subject_types_supported">REQUIRED.
JSON array containing a list of the Subject Identifier types that
this OP supports. Valid types include
<spanx style="verb">pairwise</spanx> and
<spanx style="verb">public</spanx>.
</t>
<t hangText="id_token_signing_alg_values_supported">REQUIRED.
JSON array containing a list of the JWS signing algorithms
(<spanx style="verb">alg</spanx> values)
supported by the OP for the ID Token
to encode the Claims in a JWT <xref target="JWT" />.
The algorithm <spanx style="verb">RS256</spanx> MUST be included.
The value <spanx style="verb">none</spanx> MAY be supported,
but MUST NOT be used
unless the Response Type used returns no ID Token from the
Authorization Endpoint
(such as when using the Authorization Code Flow).
</t>
<t hangText="id_token_encryption_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWE encryption algorithms
(<spanx style="verb">alg</spanx> values)
supported by the OP for the ID Token
to encode the Claims in a JWT <xref target="JWT" />.
</t>
<t hangText="id_token_encryption_enc_values_supported">OPTIONAL.
JSON array containing a list of the JWE encryption algorithms
(<spanx style="verb">enc</spanx> values)
supported by the OP for the ID Token
to encode the Claims in a JWT <xref target="JWT" />.
</t>
<t hangText="userinfo_signing_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWS <xref target="JWS" /> signing algorithms
(<spanx style="verb">alg</spanx> values) <xref target="JWA" />
supported by the UserInfo Endpoint
to encode the Claims in a JWT <xref target="JWT" />.
The value <spanx style="verb">none</spanx> MAY be included.
</t>
<t hangText="userinfo_encryption_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWE <xref target="JWE" /> encryption algorithms
(<spanx style="verb">alg</spanx> values) <xref target="JWA" />
supported by the UserInfo Endpoint
to encode the Claims in a JWT <xref target="JWT" />.
</t>
<t hangText="userinfo_encryption_enc_values_supported">OPTIONAL.
JSON array containing a list of the JWE encryption algorithms
(<spanx style="verb">enc</spanx> values) <xref target="JWA" />
supported by the UserInfo Endpoint
to encode the Claims in a JWT <xref target="JWT" />.
</t>
<t hangText="request_object_signing_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWS signing algorithms
(<spanx style="verb">alg</spanx> values)
supported by the OP for Request Objects, which are described in
Section 6.1 of <xref target="OpenID.Core">OpenID Connect Core 1.0</xref>.
These algorithms are used both when the Request Object is passed by value
(using the <spanx style="verb">request</spanx> parameter)
and when it is passed by reference
(using the <spanx style="verb">request_uri</spanx> parameter).
Servers SHOULD support <spanx style="verb">none</spanx> and <spanx style="verb">RS256</spanx>.
</t>
<t hangText="request_object_encryption_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWE encryption algorithms
(<spanx style="verb">alg</spanx> values)
supported by the OP for Request Objects.
These algorithms are used both when the Request Object is passed by value
and when it is passed by reference.
</t>
<t hangText="request_object_encryption_enc_values_supported">OPTIONAL.
JSON array containing a list of the JWE encryption algorithms
(<spanx style="verb">enc</spanx> values)
supported by the OP for Request Objects.
These algorithms are used both when the Request Object is passed by value
and when it is passed by reference.
</t>
<t hangText="token_endpoint_auth_methods_supported">OPTIONAL.
JSON array containing a list of Client Authentication
methods supported by this Token Endpoint. The options are
<spanx style="verb">client_secret_post</spanx>,
<spanx style="verb">client_secret_basic</spanx>,
<spanx style="verb">client_secret_jwt</spanx>, and
<spanx style="verb">private_key_jwt</spanx>, as described in
Section 9 of <xref target="OpenID.Core">OpenID Connect Core 1.0</xref>.
Other authentication methods MAY be defined by extensions.
If omitted, the default is <spanx style="verb">client_secret_basic</spanx> --
the HTTP Basic Authentication Scheme specified in
Section 2.3.1 of <xref target="RFC6749">OAuth 2.0</xref>.
</t>
<t hangText="token_endpoint_auth_signing_alg_values_supported">OPTIONAL.
JSON array containing a list of the JWS signing algorithms
(<spanx style="verb">alg</spanx> values)
supported by the Token Endpoint for the signature on
the JWT <xref target="JWT" /> used to authenticate the Client
at the Token Endpoint for the <spanx style="verb">private_key_jwt</spanx>
and <spanx style="verb">client_secret_jwt</spanx> authentication methods.
Servers SHOULD support <spanx style="verb">RS256</spanx>.
The value <spanx style="verb">none</spanx> MUST NOT be used.
</t>
<t hangText="display_values_supported">OPTIONAL.
JSON array containing a list of the <spanx style="verb">display</spanx>
parameter values that the OpenID Provider supports.
These values are described in
Section 3.1.2.1 of <xref target="OpenID.Core">OpenID Connect Core 1.0</xref>.
</t>
<t hangText="claim_types_supported">OPTIONAL.
JSON array containing a list of the Claim Types
that the OpenID Provider supports.
These Claim Types are described in
Section 5.6 of <xref target="OpenID.Core">OpenID Connect Core 1.0</xref>.
Values defined by this specification are <spanx style="verb">normal</spanx>,
<spanx style="verb">aggregated</spanx>, and <spanx style="verb">distributed</spanx>.
If omitted, the implementation supports
only <spanx style="verb">normal</spanx> Claims.
</t>
<t hangText="claims_supported">RECOMMENDED.
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.
</t>
<t hangText="service_documentation">OPTIONAL.
URL of a page containing human-readable information that
developers might want or need to know when using the OpenID Provider.
In particular, if the OpenID Provider does not support Dynamic Client Registration,
then information on how to register Clients needs to be provided in this documentation.
</t>
<t hangText="claims_locales_supported">OPTIONAL.
Languages and scripts supported for values in Claims being returned,
represented as a JSON array of
<xref target="RFC5646">BCP47</xref> language tag values.
Not all languages and scripts are necessarily supported for all Claim values.
</t>
<t hangText="ui_locales_supported">OPTIONAL.
Languages and scripts supported for the user interface,
represented as a JSON array of
<xref target="RFC5646">BCP47</xref> language tag values.
</t>
<t hangText="claims_parameter_supported">
OPTIONAL.
Boolean value specifying whether the OP supports use of the
<spanx style="verb">claims</spanx> parameter,
with <spanx style="verb">true</spanx> indicating support.
If omitted, the default value is <spanx style="verb">false</spanx>.
</t>
<t hangText="request_parameter_supported">
OPTIONAL.
Boolean value specifying whether the OP supports use of the
<spanx style="verb">request</spanx> parameter,
with <spanx style="verb">true</spanx> indicating support.
If omitted, the default value is <spanx style="verb">false</spanx>.
</t>
<t hangText="request_uri_parameter_supported">
OPTIONAL.
Boolean value specifying whether the OP supports use of the
<spanx style="verb">request_uri</spanx> parameter,
with <spanx style="verb">true</spanx> indicating support.
If omitted, the default value is <spanx style="verb">true</spanx>.
</t>
<t hangText="require_request_uri_registration">
OPTIONAL.
Boolean value specifying whether the OP requires any
<spanx style="verb">request_uri</spanx> values used to be pre-registered
using the <spanx style="verb">request_uris</spanx> registration parameter.
Pre-registration is REQUIRED when the value is <spanx style="verb">true</spanx>.
If omitted, the default value is <spanx style="verb">false</spanx>.
</t>
<t hangText="op_policy_uri">
OPTIONAL.
URL that the OpenID Provider provides to the person registering
the Client to read about the OP's requirements on how
the Relying Party can use the data provided by the OP.
The registration process SHOULD display this
URL to the person registering the Client if it is given.
</t>
<t hangText="op_tos_uri">
OPTIONAL.
URL that the OpenID Provider provides to the person registering
the Client to read about OpenID Provider's terms of service.
The registration process SHOULD display this
URL to the person registering the Client if it is given.
</t>
</list>
</t>
<t>
Additional OpenID Provider Metadata parameters MAY also be used.
Some are defined by other specifications,
such as
<xref target="OpenID.Session">OpenID Connect Session Management 1.0</xref>.
</t>
</section>
<section anchor="ProviderConfig"
title="Obtaining OpenID Provider Configuration Information">
<t>
Using the Issuer location discovered
as described in <xref target="IssuerDiscovery"/> or by other means,
the OpenID Provider's configuration information can be retrieved.
</t>
<t>
OpenID Providers supporting Discovery
MUST make a JSON document available at the path formed by
concatenating the string
<spanx style="verb">/.well-known/openid-configuration</spanx> to the
Issuer.
The syntax and semantics of <spanx
style="verb">.well-known</spanx> are defined in <xref
target="RFC5785">RFC 5785</xref> and apply to the Issuer value
when it contains no path component. <spanx style="verb">openid-configuration</spanx>
MUST point to a JSON document compliant with this specification and
MUST be returned using the <spanx style="verb">application/json</spanx> content type.
</t>
<section anchor="ProviderConfigurationRequest"
title="OpenID Provider Configuration Request">
<t>
An OpenID Provider Configuration Document MUST be queried using an HTTP
<spanx style="verb">GET</spanx> request at the previously specified path.
</t>
<t>
The RP would make the following request to the
Issuer <spanx style="verb">https://example.com</spanx>
to obtain its Configuration information,
since the Issuer contains no path component:
</t>
<t>
<figure>
<artwork><![CDATA[
GET /.well-known/openid-configuration HTTP/1.1
Host: example.com
]]></artwork>
</figure>
</t>
<t>
If the
Issuer value contains a path component, any terminating
<spanx style="verb">/</spanx> MUST be removed before appending
<spanx style="verb">/.well-known/openid-configuration</spanx>.
The RP would make the following request to the
Issuer <spanx style="verb">https://example.com/issuer1</spanx>
to obtain its Configuration information,