forked from KantaraInitiative/wg-uma
-
Notifications
You must be signed in to change notification settings - Fork 0
/
draft-uma-core.xml
executable file
·2028 lines (1687 loc) · 98.4 KB
/
draft-uma-core.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"?>
<!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN"
"http://xml.resource.org/authoring/rfc2629.dtd" [
<!ENTITY RFC2119 PUBLIC "" "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC2617 PUBLIC "" "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2617.xml">
<!ENTITY UMA PUBLIC "" "http://kantarainitiative.org/confluence/display/uma/Home">
<!ENTITY UMAreqs PUBLIC "" "http://kantarainitiative.org/confluence/display/uma/UMA+Requirements">
<!ENTITY RFC3552 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3552.xml">
<!ENTITY RFC4627 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4627.xml">
]>
<rfc category="std" docName="draft-hardjono-oauth-umacore-11"
ipr="trust200902">
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc toc='yes' ?>
<?rfc tocdepth='4' ?>
<?rfc symrefs='yes' ?>
<?rfc sortrefs='yes' ?>
<?rfc compact='yes' ?>
<?rfc subcompact='no' ?>
<front>
<title abbrev="UMA Core">User-Managed Access (UMA) Profile of OAuth
2.0</title>
<author fullname="Thomas Hardjono" initials="T" role="editor"
surname="Hardjono">
<organization>MIT</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date day="23" month="October" year="2014" />
<abstract>
<t>User-Managed Access (UMA) is a profile of OAuth 2.0. UMA defines how
resource owners can control protected-resource access by clients
operated by arbitrary requesting parties, where the resources reside on
any number of resource servers, and where a centralized authorization
server governs access based on resource owner policy. This revision of
the specification is part of the "candidate V1.0" process.</t>
</abstract>
</front>
<middle>
<section anchor="introduction" title="Introduction">
<t>User-Managed Access (UMA) is a profile of OAuth 2.0 <xref
target="OAuth2"></xref>. UMA defines how resource owners can control
protected-resource access by clients operated by arbitrary requesting
parties, where the resources reside on any number of resource servers,
and where a centralized authorization server governs access based on
resource owner policy. Resource owners configure authorization servers
with access policies that serve as implicit authorization grants. Thus,
the UMA profile of OAuth can be considered to encompass an authorization
grant flow.</t>
<t>UMA serves numerous use cases where a resource owner outsources
authorization for access to their resources, potentially even without
the run-time presence of the resource owner. A typical example is the
following: a web user (an end-user resource owner) can authorize a web
app (client) to gain one-time or ongoing access to a protected resource
containing his home address stored at a "personal data store" service
(resource server), by telling the resource server to respect access
entitlements issued by his chosen cloud-based authorization service
(authorization server). The requesting party operating the client might
be the resource owner himself, using a web or native app run by an
e-commerce company that needs to know where to ship a purchased item, or
it might be his friend who is using an online address book service to
collect contact information, or it might be a survey company that uses
an autonomous web service to compile population demographics. A variety
of scenarios and use cases can be found in <xref
target="UMA-usecases"></xref> and <xref
target="UMA-casestudies"></xref>.</t>
<t>Practical control of access among loosely coupled parties requires
more than just messaging protocols. This specification defines only the
technical "contract" between UMA-conforming entities; its companion
Binding Obligations specification <xref target="UMA-obligations"></xref>
defines the expected behaviors of parties operating and using these
entities. Parties operating entities that claim to be UMA-conforming
MUST provide documentation affirmatively stating their acceptance of the
binding obligations contractual framework defined in the Binding
Obligations specification.</t>
<t>In enterprise settings, application access management sometimes
involves letting back-office applications serve only as policy
enforcement points (PEPs), depending entirely on access decisions coming
from a central policy decision point (PDP) to govern the access they
give to requesters. This separation eases auditing and allows policy
administration to scale in several dimensions. UMA makes use of a
separation similar to this, letting the resource owner serve as a policy
administrator crafting authorization strategies for resources under
their control.</t>
<t>In order to increase interoperable communication among the
authorization server, resource server, and client, UMA defines several
purpose-built APIs related to the outsourcing of authorization,
themselves protected by OAuth in embedded fashion.</t>
<t>The UMA protocol has three broad phases, as shown in <xref
target="UMA-phases"></xref>.</t>
<figure align="center" anchor="UMA-phases">
<preamble>The Three Phases of the UMA Profile of OAuth</preamble>
<artwork align="left"
src="http://docs.kantarainitiative.org/uma/three-phases.svg"><![CDATA[ +--------------+
| resource |
+---------manage (A)------------ | owner |
| +--------------+
| Phase 1: |
| protect a control (B)
| resource |
v v
+------------+ +----------+--------------+
| | |protection| |
| resource | | API | authorization|
| server |<-protect (C)--| (needs | server |
| | | PAT) | |
+------------+ +----------+--------------+
| protected | | authorization|
| resource | | API |
|(needs RPT) | | (needs AAT) |
+------------+ +--------------+
^ |
| Phases 2 and 3: authorize (D)
| get authorization, |
| access a resource v
| +--------------+
+---------access (E)-------------| client |
+--------------+
requesting party
]]></artwork>
</figure>
<t>The phases work as follows: <list style="hanging">
<t hangText="Protect a resource">(Described in <xref
target="protecting-a-resource"></xref>.) The resource owner, who
manages online resources at the resource server ("A"), introduces it
to the authorization server so that the latter can begin controlling
the resources' protection. To accomplish this protection, the
authorization server presents a protection API ("C") to the resource
server. This API is OAuth-protected and requires a protection API
token (PAT) for access. Out of band, the resource owner configures
the authorization server with policies associated with the
registered resource sets ("B").</t>
<t hangText="Get authorization">(Described in <xref
target="getting-authz-accessing-resource"></xref>.) The client
approaches the resource server seeking access to an UMA-protected
resource. In order to access it successfully, the client must first
use the authorization server's authorization API ("D") to obtain a
requesting party token (RPT) on behalf of its requesting party, and
the requesting party must supply to the authorization server any
identity claims needed in order for the server to associate
sufficient authorization data with that RPT. The API is
OAuth-protected and requires an authorization API token (AAT) for
access.</t>
<t hangText="Access a resource">(Described along with Phase 2 in
<xref target="getting-authz-accessing-resource"></xref>.) The client
successfully presents an RPT that has sufficient authorization data
associated with it to the resource server, gaining access to the
desired resource ("E"). In this sense, this phase is the "happy
path" within phase 2. The nature of the authorization data varies
according to the RPT profile in use.</t>
</list></t>
<t>Implementers have the oportunity to develop profiles (see <xref
target="profiles"></xref>) that specify and restrict various UMA
protocol, RPT, and identity claim options, according to deployment and
usage conditions.</t>
<section title="Notational 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"></xref>.</t>
<t>Unless otherwise noted, all the protocol properties and values are
case sensitive.</t>
</section>
<section anchor="terminology" title="Terminology">
<t>UMA introduces the following new terms and enhancements of OAuth
term definitions.<list hangIndent="6" style="hanging">
<t hangText="resource owner"><vspace />An OAuth resource that is
the "user" in User-Managed Access. This is typically an end-user
(a natural person) but it can also be a corporation or other legal
person.</t>
<t hangText="requesting party"><vspace />An end-user, or a
corporation or other legal person, that uses a client to seek
access to a protected resource. The requesting party may or may
not be the same party as the resource owner.</t>
<t hangText="client"><vspace />An application making protected
resource requests with the resource owner's authorization and on
the requesting party's behalf.</t>
<t hangText="claim"><vspace />A statement of the value or values
of one or more identity attributes of a requesting party. A
requesting party may need to provide claims to an authorization
server in order to satisfy policy and gain permission for access
to a protected resource.</t>
<t hangText="resource set">A set of one or more protected
resources. In authorization policy terminology, a resource set is
the "object" being protected.</t>
<t hangText="scope">A bounded extent of access that is possible to
perform on a resource set. In authorization policy terminology, a
scope is one of the potentially many "verbs" that can logically
apply to a resource set ("object"). UMA associates scopes with
labeled resource sets.</t>
<t hangText="authorization data">Data associated with a requesting
party token that enables some combination of the authorization
server and resource server to determine the correct extent of
access to allow to a client. Authorization data is a key part of
the definition of an RPT profile.</t>
<t hangText="permission">A scope of access over a particular
resource set at a particular resource server that is being
requested by, or granted to, a requesting party. In authorization
policy terminology, a permission is an entitlement that includes a
"subject" (requesting party), "verbs" (one or more scopes of
access), and an "object" (resource set). A permission is one
example of authorization data that an authorization server may add
to a requesting party token.</t>
<t hangText="permission ticket">A correlation handle that is
conveyed from an authorization server to a resource server, from a
resource server to a client, and ultimately from a client to an
authorization server, to enable the authorization server to assess
the correct resource owner policies to apply to a request for an
authorization grant.</t>
</list></t>
</section>
<section anchor="endpoint-discussion"
title="Achieving Distributed Protection Through APIs and Tokens">
<t>The software components that fill the roles of UMA authorization
servers, resource servers, and clients respectively are intended to
work in an interoperable fashion when each is operated by an entirely
separate party (for example, different organizations). For this
reason, UMA specifies communications channels that the authorization
server MUST implement as HTTP-based APIs that MUST use TLS and OAuth
protection, and that the resource server MUST implement as an
HTTP-based interface. UMA's use of TLS transport-layer security is
governed by Section 1.6 of <xref target="OAuth2"></xref>, which
discusses deployment and adoption characteristics of different TLS
versions. Three different types of access tokens are issued and used
for a variety of purposes as part of these inter-role
interactions.</t>
<t>It is also REQUIRED, in turn, for resource servers and clients on
the requesting side of UMA interactions to use these channels, unless
a profile is being used that enables API extensibility. Profiles that
enable such alternatives are described in <xref
target="comms-profiles"></xref>.</t>
<section anchor="protection-api" title="Protection API">
<t>The authorization server MUST present a TLS- and OAuth-protected,
HTTP-based protection API for use by resource servers. The
authorization server thus has an OAuth token endpoint and user
authorization endpoint, and has the option to issue an OAuth refresh
token along with any access tokens issued for these APIs. The
authorization server MUST declare all of its protection API
endpoints in its configuration data (see <xref
target="am-endpoints"></xref>).</t>
<t>The protection API consists of three endpoints:<list
style="symbols">
<t>OAuth resource set registration endpoint as defined by <xref
target="OAuth-resource-reg"></xref></t>
<t>Endpoint for registering client-requested permissions</t>
<t>OAuth token introspection endpoint as defined by <xref
target="OAuth-introspection"></xref> and <xref
target="token-introspection"></xref></t>
</list></t>
<t>An entity seeking protection API access MUST have the scope
"http://docs.kantarainitiative.org/uma/scopes/prot.json". (This URI
resolves to a JSON-encoded scope description, as defined in <xref
target="OAuth-resource-reg"></xref>. The description is
non-normative for UMA purposes.) An access token with at least this
scope is called a protection API token (PAT) and an entity with this
scope is definitionally a resource server. A single entity can serve
in both resource server and client roles if it has the appropriate
OAuth scopes. If a request to an endpoint fails due to an invalid,
missing, or expired PAT, or requires higher privileges at this
endpoint than provided by the PAT, the authorization server responds
with an OAuth error.</t>
<t>The authorization server MUST support the OAuth bearer token
profile for PAT issuance, and MAY support other OAuth token profiles
(for example, the SAML bearer token grant type <xref
target="OAuth-SAML"></xref>). It MUST declare all supported token
profiles and grant types for PAT issuance in its configuration
data.</t>
<t>A PAT binds a resource owner, a resource server the owner uses
for resource management, and an authorization server the owner uses
for protection of resources at this resource server. It is not
specific to any client or requesting party. The issuance of a PAT
represents the approval of the resource owner for this resource
server to trust this authorization server for protecting its
resources belonging to this resource owner.</t>
</section>
<section anchor="authorization-api" title="Authorization API">
<t>The authorization server MUST present a TLS- and OAuth-protected,
HTTP-based authorization API for use by clients. The authorization
server thus has an OAuth token endpoint and user authorization
endpoint, and has the option to issue an OAuth refresh token along
with any access tokens issued for these APIs. The authorization
server MUST declare all of its authorization API endpoints in its
configuration data (see <xref target="am-endpoints"></xref>).</t>
<t>The authorization API consists of two endpoints:<list
style="symbols">
<t>Endpoint for RPT issuance</t>
<t>Endpoint for requesting authorization</t>
</list></t>
<t>An entity seeking authorization API access MUST have the scope
"http://docs.kantarainitiative.org/uma/scopes/authz.json". (This URI
resolves to a JSON-encoded scope description, as defined in <xref
target="OAuth-resource-reg"></xref>. The description is
non-normative for UMA purposes.) An access token with at least this
scope is called an authorization API token (AAT) and an entity with
this scope is definitionally a client. A single entity can serve in
both resource server and client roles if it has the appropriate
OAuth scopes. If a request to an endpoint fails due to an invalid,
missing, or expired AAT, or requires higher privileges at this
endpoint than provided by the AAT, the authorization server responds
with an OAuth error.</t>
<t>The authorization server MUST support the OAuth bearer token
profile for AAT issuance, and MAY support other OAuth token profiles
(for example, the SAML bearer token grant type <xref
target="OAuth-SAML"></xref>). It MUST declare all supported token
profiles and grant types for AAT issuance in its configuration
data.</t>
<t>An AAT binds a requesting party, a client being used by that
party, and an authorization server that protects resources this
client is seeking access to on this requesting party's behalf. It is
not specific to any resource server or resource owner. The issuance
of an AAT represents the approval of this requesting party for this
client to engage with this authorization server to supply claims,
ask for authorization, and perform any other tasks needed for
obtaining authorization for access to resources at all resource
servers that use this authorization server. The authorization server
is able to manage future processes of authorization and
claims-caching efficiently for this client/requesting party pair
across all resource servers they try to access; however, these
management processes are outside the scope of this
specification.</t>
</section>
<section anchor="resource-api" title="Protected Resource Interface">
<t>The resource server MAY present to clients whatever HTTP-based
APIs or endpoints it wishes. To protect any of its resources
available in this fashion using UMA, it MUST require a requesting
party token (RPT) with sufficient authorization data for access.</t>
<t>This specification defines one RPT profile, call "bearer" (see
<xref target="uma-bearer-token-profile"></xref>), which the
authorization server MUST support. It MAY support additional RPT
profiles, and MUST declare all supported RPT profiles in its
configuration data (see <xref target="am-endpoints"></xref>).</t>
<t>An RPT binds a requesting party, the client being used by that
party, the resource server at which protected resources of interest
reside, and the authorization server that protects those resources.
It is not specific to a single resource owner, though its internal
components are likely to be bound to individual resource owners,
depending on the RPT profile in use.</t>
</section>
<section title="Time-to-Live Considerations">
<t>The authorization server has the opportunity to manage the
validity periods of access tokens that it issues, their
corresponding refresh tokens where applicable, the individual data
components associated with RPTs where applicable, and even the
client credentials that it issues. Different time-to-live strategies
may be suitable for different resources and scopes of access, and
the authorization server has the opportunity to give the resource
owner control over lifetimes of tokens and authorization data issued
on their behalf through policy. These options are all outside the
scope of this specification.</t>
</section>
</section>
<section anchor="am-endpoints"
title="Authorization Server Configuration Data">
<t>The authorization server MUST provide configuration data in a JSON
<xref format="default" target="RFC4627"></xref> document that resides
in an /uma-configuration directory at its hostmeta <xref
target="hostmeta"></xref> location. The configuration data documents
conformance options and endpoints supported by the authorization
server. (At the appropriate time, this section will instead profile
whatever self-describing metadata specification OAuth adopts, for
example, <xref target="OAuth-linktypes"></xref> or <xref
target="OAuth-meta"></xref>.)</t>
<t>The configuration data has the following properties.<list
hangIndent="6" style="hanging">
<t hangText="version"><vspace />REQUIRED. The version of the UMA
core protocol to which this authorization server conforms. The
value MUST be the string "1.0".</t>
<t hangText="issuer"><vspace />REQUIRED. A URI indicating the
party operating the authorization server.</t>
<t hangText="pat_profiles_supported"><vspace />REQUIRED. OAuth
access token profiles supported by this authorization server for
PAT issuance. The property value is an array of string values,
where each string value is either a reserved keyword defined in
this specification or a URI identifying an access token profile
defined elsewhere. The reserved keyword "bearer" as a value for
this property stands for the OAuth bearer token profile <xref
target="OAuth-bearer"></xref>. The authorization server is
REQUIRED to support this profile, and to supply this string value
explicitly. The authorization server MAY declare its support for
additional access token profiles for PATs.</t>
<t hangText="aat_profiles_supported"><vspace />REQUIRED. OAuth
access token profiles supported by this authorization server for
AAT issuance. The property value is an array of string values,
where each string value is either a reserved keyword defined in
this specification or a URI identifying an access token profile
defined elsewhere. The reserved keyword "bearer" as a value for
this property stands for the OAuth bearer token profile <xref
target="OAuth-bearer"></xref>. The authorization server is
REQUIRED to support this profile, and to supply this string value
explicitly. The authorization server MAY declare its support for
additional access token profiles for AATs.</t>
<t hangText="rpt_profiles_supported"><vspace />REQUIRED. UMA RPT
profiles supported by this authorization server for RPT issuance.
The property value is an array of string values, where each string
value is either a reserved keyword defined in this specification
or a URI identifying an RPT profile defined elsewhere. The
reserved keyword "bearer" as a value for this property stands for
the UMA bearer RPT profile defined in <xref
target="uma-bearer-token-profile"></xref>. The authorization
server is REQUIRED to support this profile, and to supply this
string value explicitly. The authorization server MAY declare its
support for additional RPT profiles.</t>
<t hangText="pat_grant_types_supported"><vspace />REQUIRED. OAuth
grant types supported by this authorization server in issuing
PATs. The property value is an array of string values. Each string
value MUST be one of the grant_type values defined in <xref
target="OAuth2"></xref>, or alternatively a URI identifying a
grant type defined elsewhere.</t>
<t hangText="aat_grant_types_supported"><vspace />REQUIRED. OAuth
grant types supported by this authorization server in issuing
AATs. The property value is an array of string values. Each string
value MUST be one of the grant_type values defined in <xref
target="OAuth2"></xref>, or alternatively a URI identifying a
grant type defined elsewhere.</t>
<t hangText="claim_profiles_supported"><vspace />OPTIONAL. Claim
formats and associated sub-protocols for gathering claims from
requesting parties, as supported by this authorization server. The
property value is an array of string values, which each string
value is either a reserved keyword defined in this specification
or a URI identifying a claim profile defined elsewhere.</t>
<t hangText="uma_profiles_supported"><vspace />OPTIONAL. UMA
profiles supported by this authorization server. The property
value is an array of string values, which each string value is
either a reserved keyword defined in this specification or a URI
identifying an UMA profile defined elsewhere. The reserved
keywords "prot-ext", "authz-ext", and "rsrc-ext" as values for
this property stand for the extensibility profiles defined,
respectively, in <xref target="comms-profiles"></xref>.</t>
<t hangText="dynamic_client_endpoint"><vspace />OPTIONAL. The
endpoint to use for performing dynamic client registration. Usage
of this endpoint is defined by <xref
target="DynClientReg"></xref>. The presence of this property
indicates authorization server support for the dynamic client
registration feature and its absence indicates a lack of
support.</t>
<t hangText="token_endpoint"><vspace />REQUIRED. The endpoint URI
at which the resource server or client asks the authorization
server for a PAT or AAT, respectively. A requested scope of
"http://docs.kantarainitiative.org/uma/scopes/prot.json" results
in a PAT. A requested scope of
"http://docs.kantarainitiative.org/uma/scopes/authz.json" results
in an AAT. Usage of this endpoint is defined by <xref
target="OAuth2"></xref>.</t>
<t hangText="user_endpoint"><vspace />REQUIRED. The endpoint URI
at which the resource server gathers the consent of the end-user
resource owner or the client gathers the consent of the end-user
requesting party, if the "authorization_code" grant type is used.
Usage of this endpoint is defined by <xref
target="OAuth2"></xref>.</t>
<t hangText="introspection_endpoint"><vspace />REQUIRED. The
endpoint URI at which the resource server introspects an RPT
presented to it by a client. Usage of this endpoint is defined by
<xref target="OAuth-introspection"></xref> and <xref
target="token-introspection"></xref>. A valid PAT MUST accompany
requests to this protected endpoint.</t>
<t
hangText="resource_set_registration_endpoint"><vspace />REQUIRED.
The endpoint URI at which the resource server registers resource
sets to put them under authorization manager protection. Usage of
this endpoint is defined by <xref
target="OAuth-resource-reg"></xref> and <xref
target="protecting-a-resource"></xref>. A valid PAT MUST accompany
requests to this protected endpoint.</t>
<t hangText="permission_registration_endpoint"><vspace />REQUIRED.
The endpoint URI at which the resource server registers a
client-requested permission with the authorization server. Usage
of this endpoint is defined by <xref
target="h-am-register-permission"></xref>. A valid PAT MUST
accompany requests to this protected endpoint.</t>
<t hangText="authorization_request_endpoint"><vspace />REQUIRED.
The endpoint URI at which the client asks for authorization data.
Usage of this endpoint is defined in <xref
target="r-am-obtain-permission"></xref>. A valid AAT and a
permission ticket MUST, and an RPT MAY, accompany requests to this
protected endpoint.</t>
</list></t>
<figure>
<preamble>Example of authorization server configuration data that
resides at https://example.com/.well-known/uma-configuration (note
the use of https: for endpoints throughout):</preamble>
<artwork><![CDATA[{
"version":"1.0",
"issuer":"https://example.com",
"pat_profiles_supported":["bearer"],
"aat_profiles_supported":["bearer"],
"rpt_profiles_supported":["bearer"],
"pat_grant_types_supported":["authorization_code"],
"aat_grant_types_supported":["authorization_code"],
"claim_profiles_supported":["openid"],
"dynamic_client_endpoint":"https://as.example.com/dyn_client_reg_uri",
"token_endpoint":"https://as.example.com/token_uri",
"user_endpoint":"https://as.example.com/user_uri",
"resource_set_registration_endpoint":"https://as.example.com/rs/rsrc_uri",
"introspection_endpoint":"https://as.example.com/rs/status_uri",
"permission_registration_endpoint":"https://as.example.com/rs/perm_uri",
"authorization_request_endpoint":"https://as.example.com/client/perm_uri"
}]]></artwork>
</figure>
<t>Authorization server configuration data MAY contain extension
properties that are not defined in this specification. Extension names
that are unprotected from collisions are outside the scope of this
specification.</t>
</section>
</section>
<section anchor="protecting-a-resource" title="Protecting a Resource">
<t>The resource owner, resource server, and authorization server perform
the following actions to put resources under protection. This list
assumes that the resource server has discovered the authorization
server's configuration data and endpoints as needed.<list
style="numbers">
<t>The authorization server issues client credentials to the
resource server. It is OPTIONAL for the client credentials to be
provided dynamically through <xref target="DynClientReg"></xref>;
alternatively, they MAY use a static process.</t>
<t>The resource server acquires a PAT from the authorization server.
It is OPTIONAL for the resource owner to introduce the resource
server to the authorization server dynamically (for example, through
a "NASCAR"-style user interface where the resource owner selects a
chosen authorization server); alternatively, they MAY use a static
process that may or may not directly involve the resource owner at
introduction time.</t>
<t>In an ongoing fashion, the resource server registers any resource
sets with the authorization server for which it intends to outsource
protection, using the resource set registration endpoint of the
protection API (see <xref target="OAuth-resource-reg"></xref>).</t>
</list></t>
<t>Note: The resource server is free to offer the option to protect any
subset of the resource owner's resources using different authorization
servers or other means entirely, or to protect some resources and not
others. Additionally, the choice of protection regimes can be made
explicitly by the resource owner or implicitly by the resource server.
Any such partitioning by the resource server or owner is outside the
scope of this specification.</t>
<t>Once a resource set has been placed under authorization server
protection through the registration of a resource set description for
it, and until such a description's deletion by the resource server, the
resource server MUST limit access to corresponding resources, requiring
sufficient authorization data associated with client-presented RPTs by
the authorization server (see <xref
target="client-presents-rpt"></xref>).</t>
</section>
<section anchor="getting-authz-accessing-resource"
title="Getting Authorization and Accessing a Resource">
<t>An authorization server orchestrates and controls clients' access (on
their requesting parties' behalf) to a resource owner's protected
resources at a resource server, under conditions dictated by that
resource owner.</t>
<t>The process of getting authorization and accessing a resource always
begins with the client attempting access at a protected resource
endpoint at the resource server. How the client came to learn about this
endpoint is out of scope for this specification. The resource owner
might, for example, have advertised its availability publicly on a blog
or other website, listed it in a discovery service, or emailed a link to
a particular intended requesting party.</t>
<t>The resource server responds to the client's access request with
whatever its application-specific resource interface defines as a
success response, either immediately or having first performed one or
more embedded interactions with the authorization server. Depending on
the nature of the resource server's response to an failed access
attempt, the client and its requesting party engage in embedded
interactions with the authorization server before re-attempting
access.</t>
<t>The interactions are as follows. The recipient of each request
message SHOULD respond unless it detects a security concern, such as a
suspected denial of service attack that can be mitigated by rate
limiting.<list style="symbols">
<t>The client attempts to access a protected resource.<list
style="symbols">
<t>If the access attempt is unaccompanied by an RPT, the
resource server registers a suitable requested permission at the
authorization server, and then responds with an HTTP 403
(Forbidden) response, a permission ticket, and instructions on
where to go to obtain an RPT and authorization data.</t>
<t>If the access attempt is accompanied by an RPT, the resource
server checks the RPT's status.<list style="symbols">
<t>If the RPT is invalid, or if the RPT is valid but has
insufficient authorization data, the resource server
registers a suitable requested permission at the
authorization server, and then responds with an HTTP 403
(Forbidden) response, a permission ticket, and instructions
on where to go to obtain a valid RPT and authorization data
for it.</t>
<t>If the RPT is valid, and if the authorization data
associated with the token is sufficient for allowing access,
the resource server responds with an HTTP 2xx (Success)
response.</t>
</list></t>
</list></t>
<t>IIf the client received a 403 response and a permission ticket,
it asks the authorization server for authorization data that matches
the ticket using the authorization request endpoint of the
authorization API. If the authorization server needs requesting
party claims in order to assess this client's authorization, it
engages in a claims-gathering flow.</t>
<t>If the client does not already have an AAT at the appropriate
authorization server to be able to use its authorization API, it
first obtains one.<list style="symbols">
<t>If the client does not already have an AAT at the appropriate
authorization server to be able to use its authorization API, it
first obtains one.</t>
</list></t>
</list></t>
<t>The interactions are described in detail in the following
sections.</t>
<section anchor="r-h-attempt-access"
title="Client Attempts to Access Protected Resource">
<t>This interaction assumes that the resource server has previously
registered one or more resource sets that correspond to the resource
to which access is being attempted.</t>
<t>The client attempts to access a protected resource (for example,
when an end-user requesting party clicks on a thumbnail representation
of the resource to retrieve a larger version). It is expected to
discover, or be provisioned or configured with, knowledge of the
protected resource and its location out of band. Further, the client
is expected to acquire its own knowledge about the
application-specific methods made available by the resource server for
operating on this protected resource (such as viewing it with a GET
method, or transforming it with some complex API call).</t>
<t>The access attempt either is or is not accompanied by an RPT.</t>
<section anchor="no-rpt" title="Client Presents No RPT">
<figure>
<preamble>Example of a request carrying no RPT:</preamble>
<artwork><![CDATA[
GET /album/photo.jpg HTTP/1.1
Host: photoz.example.com
...
]]></artwork>
</figure>
<t>If the client does not present an RPT with the request, the
resource server uses the protection API to register a requested
permission with the authorization server that would suffice for that
scope of access (see <xref
target="h-am-register-permission"></xref>). It then responds with
the HTTP 403 (Forbidden) status code, providing the authorization
server's URI in an "as_uri" property in the header and the
permission ticket it just received from the authorization server in
the body in a JSON-encoded "ticket" property.</t>
<figure>
<preamble>For example:</preamble>
<artwork><![CDATA[
HTTP/1.1 403 Forbidden
WWW-Authenticate: UMA realm="example",
as_uri="https://as.example.com"
{
"ticket": "016f84e8-f9b9-11e0-bd6f-0021cc6004de"
}
...
]]></artwork>
</figure>
</section>
<section anchor="client-presents-rpt" title="Client Presents RPT">
<figure>
<preamble>Example of a request carrying an RPT using the UMA
bearer RPT profile:</preamble>
<artwork><![CDATA[
GET /album/photo.jpg HTTP/1.1
Authorization: Bearer vF9dft4qmT
Host: photoz.example.com
...
]]></artwork>
</figure>
<t>If the client presents an RPT with its request, the resource
server MUST determine the RPT's status (see <xref
target="h-am-rpt-status"></xref>) before responding.</t>
<t>If the RPT is invalid, or if the RPT is valid but has
insufficient authorization data for the type of access sought, the
resource server uses the protection API to register a requested
permission with the authorization server that would suffice for that
scope of access (see <xref
target="h-am-register-permission"></xref>). It then responds with
the HTTP 403 (Forbidden) status code and providing the authorization
server's URI in an "as_uri" property in the header and the
permission ticket it just received from the authorization server in
the body in a JSON-encoded "ticket" property.</t>
<figure>
<preamble>Example of the resource server's response after having
registered a requested permission and received a
ticket:</preamble>
<artwork><![CDATA[
HTTP/1.1 403 Forbidden
WWW-Authenticate: UMA realm="example",
as_uri="https://as.example.com"
error="insufficient_scope"
{
"ticket": "016f84e8-f9b9-11e0-bd6f-0021cc6004de"
}
]]></artwork>
</figure>
<t>If the RPT's status is associated with authorization data that is
sufficient for the access sought by the client, the resource server
MUST give access to the desired resource.</t>
<figure>
<preamble>Example of the resource server's response after having
determined that the RPT is valid and associated with sufficient
authorization data:</preamble>
<artwork><![CDATA[
HTTP/1.1 200 OK
Content-Type: image/jpeg
...
/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja
3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf
/bAIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAo
KCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwb
]]></artwork>
</figure>
<t>The resource server MUST NOT give access where the token's status
is not associated with sufficient authorization data for the
attempted scope of access.</t>
</section>
</section>
<section anchor="h-am-register-permission"
title="Resource Server Registers Requested Permission With Authorization Server">
<t>The resource server uses the protection API's permission
registration endpoint to register a requested permission with the
authorization server that would be sufficient for the type of access
sought. The authorization server returns a permission ticket for the
resource server to give to the client in its response. The PAT
provided in the API request implicitly identifies the resource owner
("subject") to which the permission applies.</t>
<t>Note: The resource server is free to choose the extent of the
requested permission that it registers, as long as it minimally
suffices for the type of access attempted by the client. For example,
it can choose to register a permission that covers several scopes or a
resource set that is greater in extent than the specific resource that
the client attempted to access.</t>
<t>The resource server uses the POST method at the endpoint. The body
of the HTTP request message contains a JSON object providing the
requested permission, using a format derived from the scope
description format specified in <xref
target="OAuth-resource-reg"></xref>, as follows. The object has the
following properties:<list style="hanging">
<t hangText="resource_set_id">REQUIRED. The identifier for a
resource set to which this client is seeking access. The
identifier MUST correspond to a resource set that was previously
registered.</t>
<t hangText="scopes">REQUIRED. An array referencing one or more
identifiers of scopes to which access is needed for this resource
set. Each scope identifier MUST correspond to a scope that was
registered by this resource server for the referenced resource
set.</t>
</list></t>
<figure>
<preamble>Example of an HTTP request that registers a requested
permission at the authorization server's permission registration
endpoint:</preamble>
<artwork><![CDATA[
POST /host/scope_reg_uri/photoz.example.com HTTP/1.1
Content-Type: application/json
Host: as.example.com
{
"resource_set_id": "112210f47de98100",
"scopes": [
"http://photoz.example.com/dev/actions/view",
"http://photoz.example.com/dev/actions/all"
]
}
]]></artwork>
</figure>
<t>If the registration request is successful, the authorization server
responds with an HTTP 201 (Created) status code and includes the
Location header in its response as well as the "ticket" property in
the JSON-formatted body.</t>
<t>The permission ticket is a short-lived opaque structure whose form
is determined by the authorization server. The ticket value MUST be
securely random (for example, not merely part of a predictable
sequential series), to avoid denial-of-service attacks. Since the
ticket is an opaque structure from the point of view of the client,
the authorization server is free to include information regarding
expiration time within the opaque ticket for its own consumption. When
the client subsequently uses the authorization API to ask the
authorization server for authorization data to be associated with its
RPT, it will submit this ticket to the authorization server.</t>
<figure>
<preamble>For example:</preamble>
<artwork><![CDATA[
HTTP/1.1 201 Created
Content-Type: application/json
Location: https://as.example.com/permreg/host/photoz.example.com/5454345rdsaa4543
...
{
"ticket": "016f84e8-f9b9-11e0-bd6f-0021cc6004de"
}
]]></artwork>
</figure>
<t>If the registration request is authenticated properly but fails due
to other reasons, the authorization server responds with an HTTP 400
(Bad Request) status code and includes one of the following UMA error
codes (see <xref target="uma-error-response"></xref>):<list
style="hanging">
<t hangText="invalid_resource_set_id">The provided resource set
identifier was not found at the authorization server.</t>
<t hangText="invalid_scope">At least one of the scopes included in
the request was not registered previously by this resource
server.</t>
</list></t>
</section>
<section anchor="h-am-rpt-status"
title="Resource Server Determines RPT's Status">
<t>The resource server MUST determine a received RPT's status,
including both its validity and, if valid, its associated
authorization data, before giving or refusing access to the client. An
RPT is associated with a set of authorization data that governs
whether the client is authorized for access. The token's nature and
format are dictated by its profile; the profile might allow it to be
self-contained, such that the resource server is able to determine its
status locally, or might require or allow the resource server to make
a run-time introspection request of the authorization server that
issued the token.</t>
<t>This specification makes one type of RPT REQUIRED for the
authorization server to support: the UMA bearer token profile, as
defined in <xref target="uma-bearer-token-profile"></xref>.
Implementers MAY define and use other RPT profiles.</t>
<section anchor="token-introspection" title="Token Introspection">
<t>Within any RPT profile, when a resource server needs to
introspect a token in a non-self-contained way to determine its
status, it MAY require, allow, or prohibit use of the OAuth token
introspection endpoint (defined by <xref
target="OAuth-introspection"></xref>) that is part of the protection
API, and MAY profile its usage. The resource server MUST use the
POST method in interacting with the endpoint, not the GET method
also defined by <xref target="OAuth-introspection"></xref>.</t>
</section>
<section anchor="uma-bearer-token-profile" title="RPT Profile: Bearer">
<t>This section defines the UMA bearer token profile. Following is a
summary:<list style="symbols">
<t>Identifying URI:
http://docs.kantarainitiative.org/uma/profiles/uma-token-bearer-1.0</t>
<t>Profile author and contact information: Thomas Hardjono
([email protected])</t>
<t>Updates or obsoletes: None; this profile is new.</t>
<t>Keyword in HTTP Authorization header: "Bearer".</t>
<t>Syntax and semantics of token data: As defined below. The
token data format mainly involves time-bounded permissions.</t>
<t>Token data association: The data associated to the
on-the-wire token by reference and retrieved at run time by the
resource server through profiled use of the OAuth token
introspection endpoint <xref
target="OAuth-introspection"></xref>, as defined below.</t>
<t>Token data processing: As defined in this section and
throughout <xref
target="getting-authz-accessing-resource"></xref> of this
specification.</t>
<t>Grant type restrictions: None.</t>
<t>Error states: As defined below.</t>
<t>Security and privacy considerations: As defined in this
section and throughout <xref
target="getting-authz-accessing-resource"></xref> of this
specification.</t>
<t>Binding obligations: Because this RPT profile is mandatory
for authorization servers to implement, binding obligations
related to the use of this token profile are documented in <xref
target="UMA-obligations"></xref>.</t>
</list></t>
<t>On receiving an RPT of the "Bearer" type in an authorization
header from a client making an access attempt, the resource server
introspects the token by using the token introspection endpoint of
the protection API. The PAT used by the resource server to make the
introspection request provides resource-owner context to the
authorization server.</t>
<t>The authorization server responds with a JSON object with the