-
Notifications
You must be signed in to change notification settings - Fork 6
/
draft-ietf-oauth-v2.txt
3528 lines (2475 loc) · 141 KB
/
draft-ietf-oauth-v2.txt
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
Network Working Group E. Hammer-Lahav, Ed.
Internet-Draft Yahoo!
Obsoletes: 5849 (if approved) D. Recordon
Intended status: Standards Track Facebook
Expires: March 25, 2012 D. Hardt
Microsoft
September 22, 2011
The OAuth 2.0 Authorization Protocol
draft-ietf-oauth-v2-22
Abstract
The OAuth 2.0 authorization protocol enables a third-party
application to obtain limited access to an HTTP service, either on
behalf of a resource owner by orchestrating an approval interaction
between the resource owner and the HTTP service, or by allowing the
third-party application to obtain access on its own behalf. This
specification replaces and obsoletes the OAuth 1.0 protocol described
in RFC 5849.
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 25, 2012.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
Hammer-Lahav, et al. Expires March 25, 2012 [Page 1]
Internet-Draft OAuth 2.0 September 2011
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Roles . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2. Protocol Flow . . . . . . . . . . . . . . . . . . . . . . 6
1.3. Authorization Grant . . . . . . . . . . . . . . . . . . . 7
1.3.1. Authorization Code . . . . . . . . . . . . . . . . . . 7
1.3.2. Implicit . . . . . . . . . . . . . . . . . . . . . . . 8
1.3.3. Resource Owner Password Credentials . . . . . . . . . 8
1.3.4. Client Credentials . . . . . . . . . . . . . . . . . . 8
1.4. Access Token . . . . . . . . . . . . . . . . . . . . . . 9
1.5. Refresh Token . . . . . . . . . . . . . . . . . . . . . . 9
1.6. Notational Conventions . . . . . . . . . . . . . . . . . 11
2. Client Registration . . . . . . . . . . . . . . . . . . . . . 11
2.1. Client Types . . . . . . . . . . . . . . . . . . . . . . 12
2.2. Client Identifier . . . . . . . . . . . . . . . . . . . . 13
2.3. Client Authentication . . . . . . . . . . . . . . . . . . 13
2.3.1. Client Password . . . . . . . . . . . . . . . . . . . 13
2.3.2. Other Authentication Methods . . . . . . . . . . . . . 14
2.4. Unregistered Clients . . . . . . . . . . . . . . . . . . 15
3. Protocol Endpoints . . . . . . . . . . . . . . . . . . . . . . 15
3.1. Authorization Endpoint . . . . . . . . . . . . . . . . . 15
3.1.1. Response Type . . . . . . . . . . . . . . . . . . . . 16
3.1.2. Redirection Endpoint . . . . . . . . . . . . . . . . . 16
3.2. Token Endpoint . . . . . . . . . . . . . . . . . . . . . 18
3.2.1. Client Authentication . . . . . . . . . . . . . . . . 19
3.3. Access Token Scope . . . . . . . . . . . . . . . . . . . 20
4. Obtaining Authorization . . . . . . . . . . . . . . . . . . . 20
4.1. Authorization Code . . . . . . . . . . . . . . . . . . . 20
4.1.1. Authorization Request . . . . . . . . . . . . . . . . 22
4.1.2. Authorization Response . . . . . . . . . . . . . . . . 23
4.1.3. Access Token Request . . . . . . . . . . . . . . . . . 25
4.1.4. Access Token Response . . . . . . . . . . . . . . . . 26
4.2. Implicit Grant . . . . . . . . . . . . . . . . . . . . . 26
4.2.1. Authorization Request . . . . . . . . . . . . . . . . 28
4.2.2. Access Token Response . . . . . . . . . . . . . . . . 29
4.3. Resource Owner Password Credentials . . . . . . . . . . . 32
4.3.1. Authorization Request and Response . . . . . . . . . . 33
4.3.2. Access Token Request . . . . . . . . . . . . . . . . . 33
4.3.3. Access Token Response . . . . . . . . . . . . . . . . 34
4.4. Client Credentials . . . . . . . . . . . . . . . . . . . 34
Hammer-Lahav, et al. Expires March 25, 2012 [Page 2]
Internet-Draft OAuth 2.0 September 2011
4.4.1. Authorization Request and Response . . . . . . . . . . 35
4.4.2. Access Token Request . . . . . . . . . . . . . . . . . 35
4.4.3. Access Token Response . . . . . . . . . . . . . . . . 36
4.5. Extensions . . . . . . . . . . . . . . . . . . . . . . . 36
5. Issuing an Access Token . . . . . . . . . . . . . . . . . . . 37
5.1. Successful Response . . . . . . . . . . . . . . . . . . . 37
5.2. Error Response . . . . . . . . . . . . . . . . . . . . . 38
6. Refreshing an Access Token . . . . . . . . . . . . . . . . . . 40
7. Accessing Protected Resources . . . . . . . . . . . . . . . . 41
7.1. Access Token Types . . . . . . . . . . . . . . . . . . . 41
8. Extensibility . . . . . . . . . . . . . . . . . . . . . . . . 42
8.1. Defining Access Token Types . . . . . . . . . . . . . . . 42
8.2. Defining New Endpoint Parameters . . . . . . . . . . . . 43
8.3. Defining New Authorization Grant Types . . . . . . . . . 43
8.4. Defining New Authorization Endpoint Response Types . . . 43
8.5. Defining Additional Error Codes . . . . . . . . . . . . . 44
9. Native Applications . . . . . . . . . . . . . . . . . . . . . 44
10. Security Considerations . . . . . . . . . . . . . . . . . . . 45
10.1. Client Authentication . . . . . . . . . . . . . . . . . . 46
10.2. Client Impersonation . . . . . . . . . . . . . . . . . . 46
10.3. Access Tokens . . . . . . . . . . . . . . . . . . . . . . 47
10.4. Refresh Tokens . . . . . . . . . . . . . . . . . . . . . 47
10.5. Authorization Codes . . . . . . . . . . . . . . . . . . . 48
10.6. Authorization Code Redirection URI Manipulation . . . . . 48
10.7. Resource Owner Password Credentials . . . . . . . . . . . 49
10.8. Request Confidentiality . . . . . . . . . . . . . . . . . 50
10.9. Endpoints Authenticity . . . . . . . . . . . . . . . . . 50
10.10. Credentials Guessing Attacks . . . . . . . . . . . . . . 50
10.11. Phishing Attacks . . . . . . . . . . . . . . . . . . . . 50
10.12. Cross-Site Request Forgery . . . . . . . . . . . . . . . 51
10.13. Clickjacking . . . . . . . . . . . . . . . . . . . . . . 52
10.14. Code Injection and Input Validation . . . . . . . . . . . 52
10.15. Open Redirectors . . . . . . . . . . . . . . . . . . . . 52
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 53
11.1. The OAuth Access Token Type Registry . . . . . . . . . . 53
11.1.1. Registration Template . . . . . . . . . . . . . . . . 53
11.2. The OAuth Parameters Registry . . . . . . . . . . . . . . 54
11.2.1. Registration Template . . . . . . . . . . . . . . . . 55
11.2.2. Initial Registry Contents . . . . . . . . . . . . . . 55
11.3. The OAuth Authorization Endpoint Response Type
Registry . . . . . . . . . . . . . . . . . . . . . . . . 57
11.3.1. Registration Template . . . . . . . . . . . . . . . . 58
11.3.2. Initial Registry Contents . . . . . . . . . . . . . . 58
11.4. The OAuth Extensions Error Registry . . . . . . . . . . . 58
11.4.1. Registration Template . . . . . . . . . . . . . . . . 59
12. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 60
Appendix A. Editor's Notes . . . . . . . . . . . . . . . . . . . 60
13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Hammer-Lahav, et al. Expires March 25, 2012 [Page 3]
Internet-Draft OAuth 2.0 September 2011
13.1. Normative References . . . . . . . . . . . . . . . . . . 61
13.2. Informative References . . . . . . . . . . . . . . . . . 62
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 63
Hammer-Lahav, et al. Expires March 25, 2012 [Page 4]
Internet-Draft OAuth 2.0 September 2011
1. Introduction
In the traditional client-server authentication model, the client
requests an access restricted resource (protected resource) on the
server by authenticating with the server using the resource owner's
credentials. In order to provide third-party applications access to
restricted resources, the resource owner shares its credentials with
the third-party. This creates several problems and limitations:
o Third-party applications are required to store the resource
owner's credentials for future use, typically a password in clear-
text.
o Servers are required to support password authentication, despite
the security weaknesses created by passwords.
o Third-party applications gain overly broad access to the resource
owner's protected resources, leaving resource owners without any
ability to restrict duration or access to a limited subset of
resources.
o Resource owners cannot revoke access to an individual third-party
without revoking access to all third-parties, and must do so by
changing their password.
o Compromise of any third-party application results in compromise of
the end-user's password and all of the data protected by that
password.
OAuth addresses these issues by introducing an authorization layer
and separating the role of the client from that of the resource
owner. In OAuth, the client requests access to resources controlled
by the resource owner and hosted by the resource server, and is
issued a different set of credentials than those of the resource
owner.
Instead of using the resource owner's credentials to access protected
resources, the client obtains an access token - a string denoting a
specific scope, lifetime, and other access attributes. Access tokens
are issued to third-party clients by an authorization server with the
approval of the resource owner. The client uses the access token to
access the protected resources hosted by the resource server.
For example, an end-user (resource owner) can grant a printing
service (client) access to her protected photos stored at a photo
sharing service (resource server), without sharing her username and
password with the printing service. Instead, she authenticates
directly with a server trusted by the photo sharing service
(authorization server) which issues the printing service delegation-
specific credentials (access token).
This specification is designed for use with HTTP [RFC2616]. The use
Hammer-Lahav, et al. Expires March 25, 2012 [Page 5]
Internet-Draft OAuth 2.0 September 2011
of OAuth with any transport protocol other than HTTP is undefined.
1.1. Roles
OAuth defines four roles:
resource owner
An entity capable of granting access to a protected resource (e.g.
end-user).
resource server
The server hosting the protected resources, capable of accepting
and responding to protected resource requests using access tokens.
client
An application making protected resource requests on behalf of the
resource owner and with its authorization.
authorization server
The server issuing access tokens to the client after successfully
authenticating the resource owner and obtaining authorization.
The interaction between the authorization server and resource server
is beyond the scope of this specification. The authorization server
may be the same server as the resource server or a separate entity.
A single authorization server may issue access tokens accepted by
multiple resource servers.
1.2. Protocol Flow
+--------+ +---------------+
| |--(A)- Authorization Request ->| Resource |
| | | Owner |
| |<-(B)-- Authorization Grant ---| |
| | +---------------+
| |
| | +---------------+
| |--(C)-- Authorization Grant -->| Authorization |
| Client | | Server |
| |<-(D)----- Access Token -------| |
| | +---------------+
| |
| | +---------------+
| |--(E)----- Access Token ------>| Resource |
| | | Server |
| |<-(F)--- Protected Resource ---| |
+--------+ +---------------+
Figure 1: Abstract Protocol Flow
Hammer-Lahav, et al. Expires March 25, 2012 [Page 6]
Internet-Draft OAuth 2.0 September 2011
The abstract flow illustrated in Figure 1 describes the interaction
between the four roles and includes the following steps:
(A) The client requests authorization from the resource owner. The
authorization request can be made directly to the resource owner
(as shown), or preferably indirectly via the authorization
server as an intermediary.
(B) The client receives an authorization grant which is a credential
representing the resource owner's authorization, expressed using
one of four grant types defined in this specification or using
an extension grant type. The authorization grant type depends
on the method used by the client to request authorization and
the types supported by the authorization server.
(C) The client requests an access token by authenticating with the
authorization server and presenting the authorization grant.
(D) The authorization server authenticates the client and validates
the authorization grant, and if valid issues an access token.
(E) The client requests the protected resource from the resource
server and authenticates by presenting the access token.
(F) The resource server validates the access token, and if valid,
serves the request.
1.3. Authorization Grant
An authorization grant is a credential representing the resource
owner's authorization (to access its protected resources) used by the
client to obtain an access token. This specification defines four
grant types: authorization code, implicit, resource owner password
credentials, and client credentials, as well as an extensibility
mechanism for defining additional types.
1.3.1. Authorization Code
The authorization code is obtained by using an authorization server
as an intermediary between the client and resource owner. Instead of
requesting authorization directly from the resource owner, the client
directs the resource owner to an authorization server (via its user-
agent as defined in [RFC2616]), which in turn directs the resource
owner back to the client with the authorization code.
Before directing the resource owner back to the client with the
authorization code, the authorization server authenticates the
resource owner and obtains authorization. Because the resource owner
only authenticates with the authorization server, the resource
owner's credentials are never shared with the client.
The authorization code provides a few important security benefits
such as the ability to authenticate the client, and the transmission
Hammer-Lahav, et al. Expires March 25, 2012 [Page 7]
Internet-Draft OAuth 2.0 September 2011
of the access token directly to the client without passing it through
the resource owner's user-agent, potentially exposing it to others,
including the resource owner.
1.3.2. Implicit
The implicit grant is a simplified authorization code flow optimized
for clients implemented in a browser using a scripting language such
as JavaScript. In the implicit flow, instead of issuing the client
an authorization code, the client is issued an access token directly
(as the result of the resource owner authorization). The grant type
is implicit as no intermediate credentials (such as an authorization
code) are issued (and later used to obtain an access token).
When issuing an implicit grant, the authorization server does not
authenticate the client. In some cases, the client identity can be
verified via the redirection URI used to deliver the access token to
the client. The access token may be exposed to the resource owner or
other applications with access to the resource owner's user-agent.
Implicit grants improve the responsiveness and efficiency of some
clients (such as a client implemented as an in-browser application)
since it reduces the number of round trips required to obtain an
access token. However, this convenience should be weighed against
the security implications of using implicit grants, especially when
the authorization code grant type is available.
1.3.3. Resource Owner Password Credentials
The resource owner password credentials (i.e. username and password)
can be used directly as an authorization grant to obtain an access
token. The credentials should only be used when there is a high
degree of trust between the resource owner and the client (e.g. its
device operating system or a highly privileged application), and when
other authorization grant types are not available (such as an
authorization code).
Even though this grant type requires direct client access to the
resource owner credentials, the resource owner credentials are used
for a single request and are exchanged for an access token. This
grant type can eliminate the need for the client to store the
resource owner credentials for future use, by exchanging the
credentials with a long-lived access token or refresh token.
1.3.4. Client Credentials
The client credentials (or other forms of client authentication) can
be used as an authorization grant when the authorization scope is
Hammer-Lahav, et al. Expires March 25, 2012 [Page 8]
Internet-Draft OAuth 2.0 September 2011
limited to the protected resources under the control of the client,
or to protected resources previously arranged with the authorization
server. Client credentials are used as an authorization grant
typically when the client is acting on its own behalf (the client is
also the resource owner), or is requesting access to protected
resources based on an authorization previously arranged with the
authorization server.
1.4. Access Token
Access tokens are credentials used to access protected resources. An
access token is a string representing an authorization issued to the
client. The string is usually opaque to the client. Tokens
represent specific scopes and durations of access, granted by the
resource owner, and enforced by the resource server and authorization
server.
The token may denote an identifier used to retrieve the authorization
information, or self-contain the authorization information in a
verifiable manner (i.e. a token string consisting of some data and a
signature). Additional authentication credentials, which are beyond
the scope of this specification, may be required in order for the
client to use a token.
The access token provides an abstraction layer, replacing different
authorization constructs (e.g. username and password) with a single
token understood by the resource server. This abstraction enables
issuing access tokens more restrictive than the authorization grant
used to obtain them, as well as removing the resource server's need
to understand a wide range of authentication methods.
Access tokens can have different formats, structures, and methods of
utilization (e.g. cryptographic properties) based on the resource
server security requirements. Access token attributes and the
methods used to access protected resources are beyond the scope of
this specification and are defined by companion specifications.
1.5. Refresh Token
Refresh tokens are credentials used to obtain access tokens. Refresh
tokens are issued to the client by the authorization server and are
used to obtain a new access token when the current access token
becomes invalid or expires, or to obtain additional access tokens
with identical or narrower scope (access tokens may have a shorter
lifetime and fewer permissions than authorized by the resource
owner). Issuing a refresh token is optional. If the authorization
server issues a refresh token, it is included when issuing an access
token.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 9]
Internet-Draft OAuth 2.0 September 2011
A refresh token is a string representing the authorization granted to
the client by the resource owner. The string is usually opaque to
the client. The token denotes an identifier used to retrieve the
authorization information. Unlike access tokens, refresh tokens are
intended for use only with authorization servers and are never sent
to resource servers.
+--------+ +---------------+
| |--(A)------- Authorization Grant --------->| |
| | | |
| |<-(B)----------- Access Token -------------| |
| | & Refresh Token | |
| | | |
| | +----------+ | |
| |--(C)---- Access Token ---->| | | |
| | | | | |
| |<-(D)- Protected Resource --| Resource | | Authorization |
| Client | | Server | | Server |
| |--(E)---- Access Token ---->| | | |
| | | | | |
| |<-(F)- Invalid Token Error -| | | |
| | +----------+ | |
| | | |
| |--(G)----------- Refresh Token ----------->| |
| | | |
| |<-(H)----------- Access Token -------------| |
+--------+ & Optional Refresh Token +---------------+
Figure 2: Refreshing an Expired Access Token
The flow illustrated in Figure 2 includes the following steps:
(A) The client requests an access token by authenticating with the
authorization server, and presenting an authorization grant.
(B) The authorization server authenticates the client and validates
the authorization grant, and if valid issues an access token and
a refresh token.
(C) The client makes a protected resource request to the resource
server by presenting the access token.
(D) The resource server validates the access token, and if valid,
serves the request.
(E) Steps (C) and (D) repeat until the access token expires. If the
client knows the access token expired, it skips to step (G),
otherwise it makes another protected resource request.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 10]
Internet-Draft OAuth 2.0 September 2011
(F) Since the access token is invalid, the resource server returns
an invalid token error.
(G) The client requests a new access token by authenticating with
the authorization server and presenting the refresh token. The
client authentication requirements are based on the client type
and on the authorization server policies.
(H) The authorization server authenticates the client and validates
the refresh token, and if valid issues a new access token (and
optionally, a new refresh token).
1.6. Notational Conventions
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT',
'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in this
specification are to be interpreted as described in [RFC2119].
This specification uses the Augmented Backus-Naur Form (ABNF)
notation of [RFC5234].
Certain security-related terms are to be understood in the sense
defined in [RFC4949]. These terms include, but are not limited to,
'attack', 'authentication', 'authorization', 'certificate',
'confidentiality', 'credential', 'encryption', 'identity', 'sign',
'signature', 'trust', 'validate', and 'verify'.
Unless otherwise noted, all the protocol parameter names and values
are case sensitive.
2. Client Registration
Before initiating the protocol, the client registers with the
authorization server. The means through which the client registers
with the authorization server are beyond the scope of this
specification, but typically involve end-user interaction with an
HTML registration form.
Client registration does not require a direct interaction between the
client and the authorization server. When supported by the
authorization server, registration can rely on other means for
establishing trust and obtaining the required client properties (e.g.
redirection URI, client type). For example, registration can be
accomplished using a self-issued or third-party-issued assertion, or
by the authorization server performing client discovery using a
trusted channel.
When registering a client, the client developer:
Hammer-Lahav, et al. Expires March 25, 2012 [Page 11]
Internet-Draft OAuth 2.0 September 2011
o specifies the client type as described in Section 2.1,
o provides its client redirection URIs as described in
Section 3.1.2, and
o includes any other information required by the authorization
server (e.g. application name, website, description, logo image,
the acceptance of legal terms).
2.1. Client Types
OAuth defines two client types, based on their ability to
authenticate securely with the authorization server (i.e. ability to
maintain the confidentiality of their client credentials):
confidential
Clients capable of maintaining the confidentiality of their
credentials (e.g. client implemented on a secure server with
restricted access to the client credentials), or capable of secure
client authentication using other means.
public
Clients incapable of maintaining the confidentiality of their
credentials (e.g. clients executing on the resource owner's device
such as an installed native application or a web browser-based
application), and incapable of secure client authentication via
any other means.
The client type designation is based on the authorization server's
definition of secure authentication and its acceptable exposure
levels of client credentials.
This specification has been designed around the following client
profiles:
web application
A web application is a confidential client running on a web
server. Resource owners access the client via an HTML user
interface rendered in a user-agent on the resource owner's device.
The client credentials as well as any access token issued to the
client are stored on the web server and are not exposed to or
accessible by the resource owner.
user-agent-based application
A user-agent-based application is a public client in which the
client code is downloaded from a web server and executes within a
user-agent (e.g. web browser) on the resource owner's device.
Protocol data and credentials are easily accessible (and often
visible) to the resource owner. Since such applications reside
within the user-agent, they can make seamless use of the user-
agent capabilities when requesting authorization.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 12]
Internet-Draft OAuth 2.0 September 2011
native application
A native application is a public client installed and executed on
the resource owner's device. Protocol data and credentials are
accessible to the resource owner. It is assumed that any client
authentication credentials included in the application can be
extracted. On the other hand, dynamically issued credentials such
access tokens or refresh tokens can receive an acceptable level of
protection. At a minimum, these credentials are protected from
hostile servers which the application may interact with. On some
platform these credentials might be protected from other
applications residing on the same device.
2.2. Client Identifier
The authorization server issues the registered client a client
identifier - a unique string representing the registration
information provided by the client. The client identifier is not a
secret, it is exposed to the resource owner, and MUST NOT be used
alone for client authentication.
2.3. Client Authentication
If the client type is confidential, the client and authorization
server establish a client authentication method suitable for the
security requirements of the authorization server. The authorization
server MAY accept any form of client authentication meeting its
security requirements.
Confidential clients are typically issued (or establish) a set of
client credentials used for authenticating with the authorization
server (e.g. password, public/private key pair).
The authorization server SHOULD NOT make assumptions about the client
type or accept the type information provided without establishing
trust with the client or its developer. The authorization server MAY
establish a client authentication method with public clients.
However, the authorization server MUST NOT rely on public client
authentication for the purpose of identifying the client.
The client MUST NOT use more than one authentication method in each
request.
2.3.1. Client Password
Clients in possession of a client password MAY use the HTTP Basic
authentication scheme as defined in [RFC2617] to authenticate with
the authorization server. The client identifier is used as the
username, and the client password is used as the password.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 13]
Internet-Draft OAuth 2.0 September 2011
For example (extra line breaks are for display purposes only):
Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
Alternatively, the authorization server MAY allow including the
client credentials in the request body using the following
parameters:
client_id
REQUIRED. The client identifier issued to the client during
the registration process described by Section 2.2.
client_secret
REQUIRED. The client secret. The client MAY omit the
parameter if the client secret is an empty string.
Including the client credentials in the request body using the two
parameters is NOT RECOMMENDED, and should be limited to clients
unable to directly utilize the HTTP Basic authentication scheme (or
other password-based HTTP authentication schemes).
For example, requesting to refresh an access token (Section 6) using
the body parameters (extra line breaks are for display purposes
only):
POST /token HTTP/1.1
Host: server.example.com
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
&client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
The authorization server MUST require the use of a transport-layer
security mechanism when sending requests to the token endpoint, as
requests using this authentication method result in the transmission
of clear-text credentials.
Since this client authentication method involves a password, the
authorization server MUST protect any endpoint utilizing it against
brute force attacks.
2.3.2. Other Authentication Methods
The authorization server MAY support any suitable HTTP authentication
scheme matching its security requirements. When using other
Hammer-Lahav, et al. Expires March 25, 2012 [Page 14]
Internet-Draft OAuth 2.0 September 2011
authentication methods, the authorization server MUST define a
mapping between the client identifier (registration record) and
authentication scheme.
2.4. Unregistered Clients
This specification does not exclude the use of unregistered clients.
However, the use with such clients is beyond the scope of this
specification, and requires additional security analysis and review
of its interoperability impact.
3. Protocol Endpoints
The authorization process utilizes two endpoints (HTTP resources):
o Authorization endpoint - used to obtain authorization from the
resource owner via user-agent redirection.
o Token endpoint - used to exchange an authorization grant for an
access token, typically with client authentication.
Not every authorization grant type utilizes both endpoints.
Extension grant types MAY define additional endpoints as needed.
3.1. Authorization Endpoint
The authorization endpoint is used to interact with the resource
owner and obtain an authorization grant. The authorization server
MUST first verify the identity of the resource owner. The way in
which the authorization server authenticates the resource owner (e.g.
username and password login, session cookies) is beyond the scope of
this specification.
The means through which the client obtains the location of the
authorization endpoint are beyond the scope of this specification,
but the location is typically provided in the service documentation.
The endpoint URI MAY include an "application/x-www-form-urlencoded"
formatted ([W3C.REC-html401-19991224]) query component ([RFC3986]
section 3.4), which MUST be retained when adding additional query
parameters. The endpoint URI MUST NOT include a fragment component.
Since requests to the authorization endpoint result in user
authentication and the transmission of clear-text credentials (in the
HTTP response), the authorization server MUST require the use of a
transport-layer security mechanism when sending requests to the
authorization endpoint. The authorization server MUST support TLS
1.0 ([RFC2246]), SHOULD support TLS 1.2 ([RFC5246]) and its future
Hammer-Lahav, et al. Expires March 25, 2012 [Page 15]
Internet-Draft OAuth 2.0 September 2011
replacements, and MAY support additional transport-layer mechanisms
meeting its security requirements.
The authorization server MUST support the use of the HTTP "GET"
method [RFC2616] for the authorization endpoint, and MAY support the
use of the "POST" method as well.
Parameters sent without a value MUST be treated as if they were
omitted from the request. The authorization server SHOULD ignore
unrecognized request parameters. Request and response parameters
MUST NOT be included more than once.
3.1.1. Response Type
The authorization endpoint is used by the authorization code grant
type and implicit grant type flows. The client informs the
authorization server of the desired grant type using the following
parameter:
response_type
REQUIRED. The value MUST be one of "code" for requesting an
authorization code as described by Section 4.1.1, "token" for
requesting an access token (implicit grant) as described by
Section 4.2.1, or a registered extension value as described by
Section 8.4. If the response type contains one or more space
characters (%x20), it is interpreted as a space-delimited list
of values, where the order of values does not matter (e.g. "a
b" is the same as "b a").
If an authorization request is missing the "response_type" parameter,
the authorization server SHOULD return an error response as described
in Section 4.1.2.1.
3.1.2. Redirection Endpoint
After completing its interaction with the resource owner, the
authorization server directs the resource owner's user-agent back to
the client. The authorization server redirects the user-agent to the
client's redirection endpoint previously established with the
authorization server during the client registration process or when
making the authorization request.
The redirection endpoint URI MUST be an absolute URI as defined by
[RFC3986] section 4.3. The endpoint URI MAY include an
"application/x-www-form-urlencoded" formatted
([W3C.REC-html401-19991224]) query component ([RFC3986] section 3.4),
which MUST be retained when adding additional query parameters. The
endpoint URI MUST NOT include a fragment component.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 16]
Internet-Draft OAuth 2.0 September 2011
3.1.2.1. Endpoint Request Confidentiality
If a redirection request will result in the transmission of an
authorization code or access token over an open network (between the
resource owner's user-agent and the client), the client SHOULD
require the use of a transport-layer security mechanism.
Lack of transport-layer security can have a severe impact on the
security of the client and the protected resources it is authorized
to access. The use of transport-layer security is particularly
critical when the authorization process is used as a form of
delegated end-user authentication by the client (e.g. third-party
sign-in service).
3.1.2.2. Registration Requirements
The authorization server SHOULD require all clients to register their
redirection URI prior to using the authorization endpoint, and MUST
require the following clients to register their redirection URI:
o Public clients.
o Confidential clients utilizing the implicit grant type.
The authorization server SHOULD require the client to provide the
complete redirection URI (the client MAY use the "state" request
parameter to achieve per-request customization). The authorization
server MAY allow the client to register multiple redirection URIs.
If requiring the registration of the complete redirection URI is not
possible, the authorization server SHOULD require the registration of
the URI scheme, authority, and path (allowing the client to
dynamically change only the query component of the redirection URI
when requesting authorization).
3.1.2.3. Dynamic Configuration
If multiple redirection URIs have been registered, if only part of
the redirection URI has been registered, or if no redirection URI has
been registered, the client MUST include a redirection URI with the
authorization request using the "redirect_uri" request parameter.
When a redirection URI is included in an authorization request, the
authorization server MUST compare and match the value received
against at least one of the registered redirection URIs (or URI
components) as defined in [RFC3986] section 6, if any redirection
URIs were registered. If the client registration included the full
redirection URI, the authorization server MUST compare the two URIs
using simple string comparison as defined in [RFC3986] section 6.2.1.
Hammer-Lahav, et al. Expires March 25, 2012 [Page 17]
Internet-Draft OAuth 2.0 September 2011
If the authorization server allows the client to dynamically change
the query component of the redirection URI, the client MUST ensure
that manipulation of the query component by an attacker cannot lead
to an abuse of the redirection endpoint as described in
Section 10.15.
3.1.2.4. Invalid Endpoint
If an authorization request fails validation due to a missing,
invalid, or mismatching redirection URI, the authorization server
SHOULD inform the resource owner of the error, and MUST NOT
automatically redirect the user-agent to the invalid redirection URI.
The authorization server SHOULD NOT redirect the user-agent to
unregistered or untrusted URIs to prevent the authorization endpoint
from being used as an open redirector.
3.1.2.5. Endpoint Content
The redirection request to the client's endpoint typically results in
an HTML document response, processed by the user-agent. If the HTML
response is served directly as the result of the redirection request,
any script included in the HTML document will execute with full
access to the redirection URI and the credentials it contains.
The client MUST NOT include any untrusted third-party scripts in the
redirection endpoint response (e.g. third-party analytics, social
plug-ins, ad networks) without first ensuring that its own scripts
used to extract and remove the credentials from the URI will execute
first.
The client SHOULD NOT include any third-party scripts in the
redirection endpoint response. Instead, it should extract the
credentials from the URI and redirect the user-agent again to another
endpoint without the credentials in the URI.
3.2. Token Endpoint
The token endpoint is used by the client to obtain an access token by
presenting its authorization grant or refresh token. The token
endpoint is used with every authorization grant except for the
implicit grant type (since an access token is issued directly).
The means through which the client obtains the location of the token
endpoint are beyond the scope of this specification but is typically