-
Notifications
You must be signed in to change notification settings - Fork 1
/
openid-connect-core-1_0.xml
8952 lines (7930 loc) · 376 KB
/
openid-connect-core-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://xml2rfc.tools.ietf.org/authoring/rfc2629.xslt' ?>
<!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN"
"http://xml2rfc.tools.ietf.org/authoring/rfc2629.dtd">
<!--
NOTE: This XML file is input used to produce the authoritative copy of an
OpenID Foundation specification. The authoritative copy is the HTML output.
This XML source file is not authoritative. The statement ipr="none" is
present only to satisfy the document compilation tool and is not indicative
of the IPR status of this specification. The IPR for this specification is
described in the "Notices" section. This is a public OpenID Foundation
document and not a private document, as the private="..." declaration could
be taken to indicate.
-->
<rfc category="std" docName="openid-connect-core-1_0" ipr="none">
<?rfc toc="yes" ?>
<?rfc tocdepth="5" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc strict="yes" ?>
<?rfc iprnotified="no" ?>
<?rfc private="Final" ?>
<front>
<title abbrev="OpenID Connect Core 1.0">OpenID Connect Core 1.0 incorporating errata set 1</title>
<author fullname="Nat Sakimura" initials="N." surname="Sakimura">
<organization abbrev="NRI">Nomura Research Institute, Ltd.</organization>
<address>
<email>[email protected]</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>[email protected]</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>[email protected]</email>
<uri>http://self-issued.info/</uri>
</address>
</author>
<author fullname="Breno de Medeiros" initials="B." surname="de Medeiros">
<organization abbrev="Google">Google</organization>
<address>
<email>[email protected]</email>
<uri>http://stackoverflow.com/users/311376/breno</uri>
</address>
</author>
<author fullname="Chuck Mortimore" initials="C." surname="Mortimore">
<organization abbrev="Salesforce">Salesforce</organization>
<address>
<email>[email protected]</email>
<uri>https://twitter.com/cmort</uri>
</address>
</author>
<date day="8" month="November" year="2014" />
<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
the core OpenID Connect functionality:
authentication built on top of OAuth 2.0 and
the use of Claims to communicate information about the End-User.
It also describes the security and privacy considerations for using OpenID Connect.
</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>
The OpenID Connect Core 1.0 specification defines
the core OpenID Connect functionality:
authentication built on top of OAuth 2.0 and
the use of Claims to communicate information about the End-User.
It also describes the security and privacy considerations for using OpenID Connect.
</t>
<t>
As background,
the <xref target="RFC6749">OAuth 2.0 Authorization Framework</xref>
and <xref target="RFC6750">OAuth 2.0 Bearer Token Usage</xref>
specifications provide a general framework for third-party applications
to obtain and use limited access to HTTP resources. They define
mechanisms to obtain and use Access Tokens to access resources but
do not define standard methods to provide identity information.
Notably, without profiling OAuth 2.0, it is incapable of
providing information about the authentication of an End-User.
Readers are expected to be familiar with these specifications.
</t>
<t>
OpenID Connect implements authentication as an extension to the
OAuth 2.0 authorization process.
Use of this extension is requested by Clients by including
the <spanx style="verb">openid</spanx> scope value
in the Authorization Request.
Information about the authentication performed is returned
in a <xref target="JWT">JSON Web Token (JWT)</xref>
called an ID Token (see <xref target="IDToken"/>).
OAuth 2.0 Authentication Servers implementing OpenID Connect
are also referred to as OpenID Providers (OPs).
OAuth 2.0 Clients using OpenID Connect
are also referred to as Relying Parties (RPs).
</t>
<t>
This specification assumes that the Relying Party has already obtained
configuration information about the OpenID Provider, including its
Authorization Endpoint and Token Endpoint locations.
This information is normally obtained via Discovery,
as described in <xref target="OpenID.Discovery">OpenID Connect Discovery 1.0</xref>,
or may be obtained via other mechanisms.
</t>
<t>
Likewise, this specification assumes that the Relying Party has already obtained
sufficient credentials and provided information needed to use the OpenID Provider.
This is normally done via Dynamic Registration,
as described in
<xref target="OpenID.Registration">OpenID Connect Dynamic Client Registration 1.0</xref>,
or may be obtained via other mechanisms.
</t>
<section anchor="rnc" title="Requirements Notation and Conventions">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "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", "JSON Web Token (JWT)",
"JWT Claims Set", and "Nested JWT"
defined by <xref target="JWT">JSON Web Token (JWT)</xref>,
the terms "Header Parameter" and "JOSE Header"
defined by <xref target="JWS">JSON Web Signature (JWS)</xref>,
the term "User Agent" defined by <xref target="RFC2616">RFC 2616</xref>,
and the term "Response Mode" defined by
<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="Authentication">
<vspace/>
Process used to achieve sufficient confidence in the binding
between the Entity and the presented Identity.
</t>
<t hangText="Authentication Request">
<vspace/>
OAuth 2.0 Authorization Request using extension parameters and scopes
defined by OpenID Connect to request that the End-User be authenticated
by the Authorization Server, which is an OpenID Connect Provider,
to the Client, which is an OpenID Connect Relying Party.
</t>
<t hangText="Authentication Context">
<vspace/>
Information that the Relying Party can require before it makes an
entitlement decision with respect to an authentication response.
Such context can include, but is not limited to, the actual
authentication method used or level of assurance such as
<xref target="ISO29115">ISO/IEC 29115</xref>
entity authentication assurance level.
</t>
<t hangText="Authentication Context Class">
<vspace/>
Set of authentication methods or procedures that are considered
to be equivalent to each other in a particular context.
</t>
<t hangText="Authentication Context Class Reference">
<vspace/>
Identifier for an Authentication Context Class.
</t>
<t hangText="Authorization Code Flow">
<vspace/>
OAuth 2.0 flow in which
an Authorization Code is returned from the Authorization Endpoint and
all tokens are returned from the Token Endpoint.
</t>
<t hangText="Authorization Request">
<vspace/>
OAuth 2.0 Authorization Request as defined by <xref target="RFC6749"/>.
</t>
<t hangText="Claim">
<vspace/>
Piece of information asserted about an Entity.
</t>
<t hangText="Claim Type">
<vspace/>
Syntax used for representing a Claim Value.
This specification defines Normal, Aggregated, and Distributed Claim Types.
</t>
<t hangText="Claims Provider">
<vspace/>
Server that can return Claims about an Entity.
</t>
<t hangText="Credential">
<vspace/>
Data presented as evidence of the right to use an identity
or other resources.
</t>
<t hangText="End-User">
<vspace/>
Human participant.
</t>
<t hangText="Entity">
<vspace/>
Something that has a separate and distinct existence and that can be
identified in a context. An End-User is one example of an Entity.
</t>
<t hangText="Essential Claim">
<vspace/>
Claim specified by the Client as being necessary to ensure a smooth
authorization experience for the specific task requested by the End-User.
</t>
<t hangText="Hybrid Flow">
<vspace/>
OAuth 2.0 flow in which
an Authorization Code is returned from the Authorization Endpoint,
some tokens are returned from the Authorization Endpoint,
and others are returned from the Token Endpoint.
</t>
<t hangText="ID Token">
<vspace/>
<xref target="JWT">JSON Web Token (JWT)</xref> that contains Claims about the Authentication event.
It MAY contain other Claims.
</t>
<t hangText="Identifier">
<vspace/>
Value that uniquely characterizes an Entity in a specific context.
</t>
<t hangText="Identity">
<vspace/>
Set of attributes related to an Entity.
</t>
<t hangText="Implicit Flow">
<vspace/>
OAuth 2.0 flow in which all tokens are returned from the Authorization Endpoint
and neither the Token Endpoint nor an Authorization Code are used.
</t>
<t hangText="Issuer">
<vspace/>
Entity that issues a set of Claims.
</t>
<t hangText="Issuer Identifier">
<vspace/>
Verifiable Identifier for an Issuer.
An Issuer Identifier is a case sensitive URL
using the <spanx style="verb">https</spanx> scheme that
contains scheme, host, and optionally, port number and path
components and no query or fragment components.
</t>
<t hangText="Message">
<vspace/>
Request or a response between an OpenID
Relying Party and an OpenID Provider.
</t>
<t hangText="OpenID Provider (OP)">
<vspace/>
OAuth 2.0 Authorization Server that is capable of
Authenticating the End-User and
providing Claims to a Relying Party
about the Authentication event and the End-User.
</t>
<t hangText="Request Object">
<vspace/>
JWT that contains a set of request parameters as its Claims.
</t>
<t hangText="Request URI">
<vspace/>
URL that references a resource containing a Request Object.
The Request URI contents MUST be retrievable by the
Authorization Server.
</t>
<t hangText="Pairwise Pseudonymous Identifier (PPID)">
<vspace/>
Identifier that identifies the Entity to a Relying Party that cannot be correlated
with the Entity's PPID at another Relying Party.
</t>
<t hangText="Personally Identifiable Information (PII)">
<vspace/>
Information that (a) can be used to identify the natural person
to whom such information relates, or
(b) is or might be directly or indirectly linked to a
natural person to whom such information relates.
</t>
<t hangText="Relying Party (RP)">
<vspace/>
OAuth 2.0 Client application requiring End-User Authentication
and Claims from an OpenID Provider.
</t>
<t hangText="Sector Identifier">
<vspace/>
Host component of a URL used by the Relying Party's organization
that is an input to the computation of pairwise Subject Identifiers
for that Relying Party.
</t>
<t hangText="Self-Issued OpenID Provider">
<vspace/>
Personal, self-hosted OpenID Provider that issues self-signed ID Tokens.
</t>
<t hangText="Subject Identifier">
<vspace/>
Locally unique and never
reassigned identifier within the Issuer for the End-User,
which is intended to be consumed by the Client.
</t>
<t hangText="UserInfo Endpoint">
<vspace/>
Protected Resource that, when presented with an Access Token by the Client,
returns authorized information about the End-User represented by the corresponding
Authorization Grant.
The UserInfo Endpoint
URL MUST use the <spanx style="verb">https</spanx> scheme and MAY contain
port, path, and query parameter components.
</t>
<t hangText="Validation">
<vspace/>
Process intended to establish the soundness or correctness of a construct.
</t>
<t hangText="Verification">
<vspace/>
Process intended to test or prove the truth or accuracy of a fact or value.
</t>
<t hangText="Voluntary Claim">
<vspace/>
Claim specified by the Client as being useful but not Essential
for the specific task requested by the End-User.
</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
"Issuer Identifier", reference these defined terms.
Whenever the reader encounters them, their definitions
found in this section must be followed.
</t>
<t>
For more background on some of the terminology used,
see <xref target="RFC4949">Internet Security Glossary, Version 2</xref>,
<xref target="ISO29115">ISO/IEC 29115 Entity Authentication Assurance</xref>,
and <xref target="X.1252">ITU-T X.1252</xref>.
</t>
</section>
<section anchor="Overview" title="Overview">
<t>The OpenID Connect protocol, in abstract, follows the following
steps.</t>
<t>
<list style="numbers">
<t>The RP (Client) sends a request to the OpenID Provider (OP).</t>
<t>The OP authenticates the End-User and obtains authorization.</t>
<t>The OP responds with an ID Token and usually an Access Token.</t>
<t>The RP can send a request with the Access Token to the UserInfo Endpoint.</t>
<t>The UserInfo Endpoint returns Claims about the End-User.</t>
</list>
</t>
<figure>
<preamble>
These steps are illustrated in the following diagram:
</preamble>
<artwork><![CDATA[
+--------+ +--------+
| | | |
| |---------(1) AuthN Request-------->| |
| | | |
| | +--------+ | |
| | | | | |
| | | End- |<--(2) AuthN & AuthZ-->| |
| | | User | | |
| RP | | | | OP |
| | +--------+ | |
| | | |
| |<--------(3) AuthN Response--------| |
| | | |
| |---------(4) UserInfo Request----->| |
| | | |
| |<--------(5) UserInfo Response-----| |
| | | |
+--------+ +--------+
]]></artwork>
</figure>
</section>
</section>
<section anchor="IDToken" title="ID Token">
<t>
The primary extension that OpenID Connect makes to OAuth 2.0
to enable End-Users to be Authenticated
is the ID Token data structure.
The ID Token is a security token that contains Claims about the
Authentication of an End-User by an Authorization Server when using a Client,
and potentially other requested Claims.
The ID Token is represented as a
<xref target="JWT">JSON Web Token (JWT)</xref>.
</t>
<t>
The following Claims are used within the ID Token
for all OAuth 2.0 flows used by OpenID Connect:
</t>
<t>
<list style="hanging">
<t hangText="iss">
<vspace/>
REQUIRED.
Issuer Identifier for the Issuer of the response.
The <spanx style="verb">iss</spanx> value is a case sensitive URL
using the <spanx style="verb">https</spanx> scheme that
contains scheme, host, and optionally, port number and path
components and no query or fragment components.
</t>
<t hangText="sub">
<vspace/>
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., <spanx style="verb">24400320</spanx>
or <spanx style="verb">AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4</spanx>.
It MUST NOT exceed 255 ASCII characters in length.
The <spanx style="verb">sub</spanx> value is a case sensitive string.
</t>
<t hangText="aud">
<vspace/>
REQUIRED.
Audience(s) that this ID Token is intended for.
It MUST contain the OAuth 2.0 <spanx style="verb">client_id</spanx>
of the Relying Party as an audience value.
It MAY also contain identifiers for other audiences.
In the general case,
the <spanx style="verb">aud</spanx> value is an array of
case sensitive strings.
In the common special case when there is one audience,
the <spanx style="verb">aud</spanx> value MAY be a single
case sensitive string.
</t>
<t hangText="exp">
<vspace/>
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 <xref target="RFC3339">RFC 3339</xref>
for details regarding date/times in general and UTC in
particular.
</t>
<t hangText="iat">
<vspace/>
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.
</t>
<t hangText="auth_time">
<vspace/>
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 <spanx style="verb">max_age</spanx> request is made
or when <spanx style="verb">auth_time</spanx> is requested
as an Essential Claim,
then this Claim is REQUIRED; otherwise, its inclusion is OPTIONAL.
(The <spanx style="verb">auth_time</spanx> Claim semantically
corresponds to the OpenID 2.0 <xref target="OpenID.PAPE">PAPE</xref>
<spanx style="verb">auth_time</spanx> response parameter.)
</t>
<t hangText="nonce">
<vspace/>
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 <spanx style="verb">nonce</spanx> Claim Value is equal to
the value of the <spanx style="verb">nonce</spanx>
parameter sent in the Authentication Request.
If present in the Authentication Request, Authorization Servers
MUST include a <spanx style="verb">nonce</spanx> 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 <spanx style="verb">nonce</spanx> values used.
The <spanx style="verb">nonce</spanx> value is a case sensitive string.
</t>
<t hangText="acr">
<vspace/>
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
<xref target="ISO29115">ISO/IEC 29115</xref> 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
<xref target="OpenID.PAPE">PAPE</xref>
<spanx style="verb">nist_auth_level</spanx> 0.)
An absolute URI or an <xref target="RFC6711">RFC 6711</xref>
registered name
SHOULD be used as the <spanx style="verb">acr</spanx> 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 <spanx style="verb">acr</spanx> value is a case sensitive string.
</t>
<t hangText="amr">
<vspace/>
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
<spanx style="verb">amr</spanx> 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 <spanx style="verb">amr</spanx> value is an array of
case sensitive strings.
</t>
<t hangText="azp">
<vspace/>
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 <spanx style="verb">azp</spanx> value is a case sensitive string
containing a StringOrURI value.
</t>
</list>
</t>
<t>
ID Tokens MAY contain other Claims.
Any Claims used that are not understood MUST be ignored.
See Sections
<xref target="CodeIDToken" format="counter"/>,
<xref target="HybridIDToken" format="counter"/>,
<xref target="StandardClaims" format="counter"/>, and
<xref target="SelfIssuedResponse" format="counter"/>
for additional Claims defined by this specification.
</t>
<t>
ID Tokens MUST be signed using <xref
target="JWS">JWS</xref> and optionally both signed and then
encrypted using <xref target="JWS">JWS</xref> and <xref
target="JWE">JWE</xref> respectively, thereby providing
authentication, integrity,
non-repudiation, and optionally, confidentiality,
per <xref target="SigningOrder"/>.
If the ID Token is encrypted, it MUST be signed then encrypted,
with the result being a Nested JWT, as defined in <xref target="JWT"/>.
ID Tokens MUST NOT use <spanx style="verb">none</spanx>
as the <spanx style="verb">alg</spanx> value
unless the Response Type used returns no ID Token from the
Authorization Endpoint
(such as when using the Authorization Code Flow)
and the Client explicitly requested the use of
<spanx style="verb">none</spanx> at Registration time.
</t>
<t>
ID Tokens SHOULD NOT use the JWS or JWE
<spanx style="verb">x5u</spanx>,
<spanx style="verb">x5c</spanx>,
<spanx style="verb">jku</spanx>, or
<spanx style="verb">jwk</spanx>
Header Parameter fields.
Instead, references to keys used are
communicated in advance using Discovery and Registration parameters,
per <xref target="SigEnc"/>.
</t>
<figure>
<preamble>
The following is a non-normative example of
the set of Claims (the JWT Claims Set) in an ID Token:
</preamble>
<artwork><![CDATA[
{
"iss": "https://server.example.com",
"sub": "24400320",
"aud": "s6BhdRkqt3",
"nonce": "n-0S6_WzA2Mj",
"exp": 1311281970,
"iat": 1311280970,
"auth_time": 1311280969,
"acr": "urn:mace:incommon:iap:silver"
}
]]></artwork>
</figure>
</section>
<section anchor="Authentication" title="Authentication">
<t>
OpenID Connect performs authentication to log in the End-User
or to determine that the End-User is already logged in.
OpenID Connect returns the result of the Authentication
performed by the Server to the Client in a secure manner
so that the Client can rely on it.
For this reason, the Client is called Relying Party (RP) in this case.
</t>
<t>
The Authentication result is returned in an
ID Token, as defined in <xref target="IDToken"/>.
It has Claims expressing such information as the Issuer,
the Subject Identifier, when the authentication expires, etc.
</t>
<t>
Authentication can follow one of three paths:
the Authorization Code Flow (<spanx style="verb">response_type=code</spanx>),
the Implicit Flow (<spanx style="verb">response_type=id_token token</spanx>
or <spanx style="verb">response_type=id_token</spanx>), or
the Hybrid Flow (using other Response Type values defined in
<xref target="OAuth.Responses">OAuth 2.0 Multiple Response Type Encoding Practices</xref>).
The flows determine how the ID Token and Access Token
are returned to the Client.
</t>
<t>
The characteristics of the three flows are summarized
in the following non-normative table.
The table is intended to provide some guidance on which flow to choose
in particular contexts.
</t>
<texttable title="OpenID Connect Authentication Flows">
<ttcol>Property</ttcol>
<ttcol>Authorization Code Flow</ttcol>
<ttcol>Implicit Flow</ttcol>
<ttcol>Hybrid Flow</ttcol>
<c>All tokens returned from Authorization Endpoint</c>
<c>no</c>
<c>yes</c>
<c>no</c>
<c>All tokens returned from Token Endpoint</c>
<c>yes</c>
<c>no</c>
<c>no</c>
<c>Tokens not revealed to User Agent</c>
<c>yes</c>
<c>no</c>
<c>no</c>
<c>Client can be authenticated</c>
<c>yes</c>
<c>no</c>
<c>yes</c>
<c>Refresh Token possible</c>
<c>yes</c>
<c>no</c>
<c>yes</c>
<c>Communication in one round trip</c>
<c>no</c>
<c>yes</c>
<c>no</c>
<c>Most communication server-to-server</c>
<c>yes</c>
<c>no</c>
<c>varies</c>
</texttable>
<t>
The flow used is determined by the <spanx style="verb">response_type</spanx>
value contained in the Authorization Request.
These <spanx style="verb">response_type</spanx> values select
these flows:
</t>
<texttable title='OpenID Connect "response_type" Values'>
<ttcol>"response_type" value</ttcol>
<ttcol>Flow</ttcol>
<c><spanx style="verb">code</spanx></c>
<c>Authorization Code Flow</c>
<c><spanx style="verb">id_token</spanx></c>
<c>Implicit Flow</c>
<c><spanx style="verb">id_token token</spanx></c>
<c>Implicit Flow</c>
<c><spanx style="verb">code id_token</spanx></c>
<c>Hybrid Flow</c>
<c><spanx style="verb">code token</spanx></c>
<c>Hybrid Flow</c>
<c><spanx style="verb">code id_token token</spanx></c>
<c>Hybrid Flow</c>
</texttable>
<t>
All but the <spanx style="verb">code</spanx> Response Type value,
which is defined by <xref target="RFC6749">OAuth 2.0</xref>,
are defined in the
<xref target="OAuth.Responses">OAuth 2.0 Multiple Response Type Encoding Practices</xref>
specification.
NOTE: While OAuth 2.0 also defines the
<spanx style="verb">token</spanx> Response Type value
for the Implicit Flow, OpenID Connect does not use this Response Type,
since no ID Token would be returned.
</t>
<section anchor="CodeFlowAuth" title="Authentication using the Authorization Code Flow">
<t>
This section describes how to perform authentication using the Authorization Code Flow.
When using the Authorization Code Flow,
all tokens are returned from the Token Endpoint.
</t>
<t>The Authorization Code Flow returns an Authorization Code to the
Client, which can then exchange it for an ID Token and an Access Token directly.
This provides the benefit of not exposing any tokens to the
User Agent and possibly other malicious applications with access
to the User Agent.
The Authorization Server can also
authenticate the Client before exchanging the Authorization Code for an
Access Token. The Authorization Code flow is suitable for Clients that
can securely maintain a Client Secret between themselves and the
Authorization Server.</t>
<section anchor="CodeFlowSteps" title="Authorization Code Flow Steps">
<t>The Authorization Code Flow goes through the following
steps.</t>
<t>
<list style="numbers">
<t>Client prepares an Authentication Request containing the desired
request parameters.</t>
<t>Client sends the request to the Authorization Server.</t>
<t>Authorization Server Authenticates the End-User.</t>
<t>Authorization Server obtains End-User Consent/Authorization.</t>
<t>Authorization Server sends the End-User back to the Client with
an Authorization Code.</t>
<t>Client requests a response using the Authorization Code at the
Token Endpoint.</t>
<t>Client receives a response that contains an ID Token
and Access Token in the response body.</t>
<t>Client validates the ID token and retrieves the End-User's
Subject Identifier.</t>
</list>
</t>
</section>
<section anchor="AuthorizationEndpoint" title="Authorization Endpoint">
<t>
The Authorization Endpoint performs Authentication of the
End-User.
This is done by sending the User Agent to
the Authorization Server's Authorization Endpoint for Authentication and
Authorization, using request parameters defined by OAuth 2.0 and
additional parameters and parameter values defined by OpenID Connect.
</t>
<t>
Communication with the Authorization Endpoint MUST utilize TLS.
See <xref target="TLSRequirements"/> for more information on using TLS.
</t>
<section anchor="AuthRequest" title="Authentication Request">
<t>
An Authentication Request is
an OAuth 2.0 Authorization Request that requests that the End-User
be authenticated by the Authorization Server.
</t>
<t>Authorization Servers MUST support the use of the HTTP <spanx style="verb">GET</spanx> and
<spanx style="verb">POST</spanx> methods defined in <xref target="RFC2616">RFC 2616</xref> at the
Authorization Endpoint.
Clients MAY use the HTTP <spanx style="verb">GET</spanx> or
<spanx style="verb">POST</spanx> methods to send the
Authorization Request to the Authorization Server. If using the HTTP
<spanx style="verb">GET</spanx> method, the request parameters are serialized using
URI Query String Serialization, per <xref target="QuerySerialization"/>.
If using the HTTP <spanx style="verb">POST</spanx>
method, the request parameters are serialized using
Form Serialization, per <xref target="FormSerialization"/>.</t>
<t>
OpenID Connect uses the following OAuth 2.0 request parameters with
the Authorization Code Flow:
</t>
<t>
<list style="hanging">
<t hangText="scope">
<vspace/>
REQUIRED.
OpenID Connect requests MUST contain the <spanx style="verb">openid</spanx> scope value.
If the <spanx style="verb">openid</spanx> scope value is not present,
the behavior is entirely unspecified.
Other scope values MAY be present.
Scope values used that are not understood by an implementation SHOULD be ignored.
See Sections <xref target="ScopeClaims" format="counter"/>
and <xref target="OfflineAccess" format="counter"/>
for additional scope values defined by this specification.
</t>
<t hangText="response_type">
<vspace/>
REQUIRED.
OAuth 2.0 Response Type value that determines
the authorization processing flow to be used,
including what parameters are returned from the endpoints used.
When using the Authorization Code Flow, this value is
<spanx style="verb">code</spanx>.
</t>
<t hangText="client_id">
<vspace/>
REQUIRED.
OAuth 2.0 Client Identifier
valid at the Authorization Server.
</t>
<t hangText="redirect_uri">
<vspace/>
REQUIRED.
Redirection URI to which the response will be sent.
This URI MUST exactly match one of the Redirection URI values
for the Client pre-registered at the OpenID Provider,
with the matching performed as described in
Section 6.2.1 of <xref target="RFC3986"/> (Simple String Comparison).
When using this flow, the Redirection URI
SHOULD use the <spanx style="verb">https</spanx> scheme;
however, it MAY use the <spanx style="verb">http</spanx> scheme,
provided that the Client Type is
<spanx style="verb">confidential</spanx>,
as defined in Section 2.1 of OAuth 2.0, and
provided the OP allows the use of
<spanx style="verb">http</spanx> Redirection URIs in this case.
The Redirection URI MAY use an alternate scheme,
such as one that is intended to identify a callback into a native application.
</t>
<t hangText="state">
<vspace/>
RECOMMENDED.
Opaque value used
to maintain state between the request and the callback.
Typically, Cross-Site Request Forgery (CSRF, XSRF)
mitigation is done by cryptographically binding the value of
this parameter with a browser cookie.
</t>
</list>
</t>
<t>
OpenID Connect also uses the following OAuth 2.0 request parameter,
which is defined in
<xref target="OAuth.Responses">OAuth 2.0 Multiple Response Type Encoding Practices</xref>:
</t>
<t>
<list style="hanging">
<t hangText="response_mode">
<vspace/>
OPTIONAL.
Informs the Authorization Server of the mechanism to be used