-
Notifications
You must be signed in to change notification settings - Fork 1
/
draft-ietf-oauth-mtls.xml
1629 lines (1536 loc) · 82.1 KB
/
draft-ietf-oauth-mtls.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 SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="4"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" docName="draft-ietf-oauth-mtls-17" ipr="trust200902">
<front>
<title abbrev="OAuth Mutual TLS">OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens</title>
<author fullname="Brian Campbell" initials="B." surname="Campbell">
<organization>Ping Identity</organization>
<address><email>[email protected]</email></address>
</author>
<author fullname="John Bradley" initials="J." surname="Bradley">
<organization>Yubico</organization>
<address>
<email>[email protected]</email>
<uri>http://www.thread-safe.com/</uri>
</address>
</author>
<author fullname="Nat Sakimura" initials="N." surname="Sakimura">
<organization>Nomura Research Institute</organization>
<address>
<email>[email protected]</email>
<uri>https://nat.sakimura.org/</uri>
</address>
</author>
<author fullname="Torsten Lodderstedt" initials="T." surname="Lodderstedt">
<organization>YES.com AG</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date />
<area>Security</area>
<workgroup>OAuth Working Group</workgroup>
<keyword>JSON Web Token</keyword>
<keyword>JWT</keyword>
<keyword>MTLS</keyword>
<keyword>Mutual TLS</keyword>
<keyword>proof-of-possession</keyword>
<keyword>proof-of-possession access token</keyword>
<keyword>key confirmed access token</keyword>
<keyword>certificate-bound access token</keyword>
<keyword>client certificate</keyword>
<keyword>X.509 Client Certificate Authentication</keyword>
<keyword>key confirmation</keyword>
<keyword>confirmation method</keyword>
<keyword>holder-of-key</keyword>
<keyword>OAuth</keyword>
<abstract>
<t>
This document describes OAuth client authentication and certificate-bound access and refresh tokens using
mutual Transport Layer Security (TLS) authentication with X.509 certificates.
OAuth clients are provided a mechanism for authentication to the authorization
server using mutual TLS, based on either self-signed certificates or public key infrastructure (PKI).
OAuth authorization servers are provided a mechanism for binding access tokens to a client's
mutual-TLS certificate, and OAuth protected resources are provided a method for ensuring
that such an access token presented to it was issued to the client presenting the token.
</t>
</abstract>
</front>
<middle>
<section anchor="Introduction" title="Introduction">
<t>
The OAuth 2.0 Authorization Framework <xref target="RFC6749"/> enables third-party
client applications to obtain delegated access to protected resources.
In the prototypical abstract OAuth flow, illustrated in <xref target="protocol-flow-figure"/>,
the client obtains an access token from an entity known as an
authorization server and then uses that token when accessing protected resources,
such as HTTPS APIs.
</t>
<t>
<figure title='Abstract OAuth 2.0 Protocol Flow' anchor='protocol-flow-figure'>
<artwork><![CDATA[
+--------+ +---------------+
| | | |
| |<--(A)-- Get an access token --->| Authorization |
| | | Server |
| | | |
| | +---------------+
| | ^
| | |
| |
| | (C) |
| Client | Validate the
| | access token |
| |
| | |
| | v
| | +---------------+
| | | (C) |
| | | |
| |<--(B)-- Use the access token -->| Protected |
| | | Resource |
| | | |
+--------+ +---------------+
]]></artwork>
</figure>
</t>
<t>
The flow illustrated in <xref target="protocol-flow-figure"/> includes the following steps:
<list style='format (%C)'>
<t>
The client makes an HTTPS <spanx style='verb'>POST</spanx> request to
the authorization server and presents
a credential representing the authorization grant. For
certain types of clients (those that have been issued or otherwise established
a set of client credentials) the request must be authenticated.
In the response, the authorization server issues an access token to the client.
</t>
<t>
The client includes the access token when making a request to access a protected resource.
</t>
<t>
The protected resource validates the access token in order to authorize the request.
In some cases, such as when the token is self-contained and cryptographically secured,
the validation can be done locally by the protected resource. Other cases require
that the protected resource call out to the authorization server to determine the state
of the token and obtain meta-information about it.
</t>
</list>
</t>
<t>
Layering on the abstract flow above,
this document standardizes enhanced security options for OAuth 2.0 utilizing client-certificate-based mutual TLS.
<xref target="mtlsca"/> provides options for authenticating the request in step (A). Step (C) is supported
with semantics to express the binding of the token to the client certificate for both local and remote processing
in <xref target="x5t"/> and <xref target="introspect"/> respectively. This ensures that, as
described in <xref target="CertificateBoundAccessTokens"/>, protected resource
access in step (B) is only possible by the legitimate client using a certificate-bound token and
holding the private key corresponding to the certificate.
</t>
<t>
OAuth 2.0
defines a shared-secret method of client authentication but also
allows for definition and use of additional client authentication mechanisms
when interacting directly with the authorization server.
This document describes an additional mechanism of client authentication utilizing
mutual-TLS certificate-based authentication, which provides
better security characteristics than shared secrets.
While <xref target="RFC6749"/> documents client authentication for requests to the token endpoint,
extensions to OAuth 2.0 (such as <xref target="RFC7662">Introspection</xref>,
<xref target="RFC7009">Revocation</xref>, and the Backchannel Authentication Endpoint
in <xref target="OpenID.CIBA"/>) define endpoints that also utilize client authentication
and the mutual TLS methods defined herein are applicable to those endpoints as well.
</t>
<t>
Mutual-TLS certificate-bound access tokens ensure that
only the party in possession of the
private key corresponding to the certificate can utilize the token to
access the associated resources. Such a constraint is
sometimes referred to as key confirmation, proof-of-possession, or holder-of-key
and is unlike the case of the
bearer token described in <xref target="RFC6750"/>, where any party in
possession of the access token can use it to access the associated resources.
Binding an access token to the client's certificate
prevents the use of stolen access tokens or replay of access tokens
by unauthorized parties.
</t>
<t>
Mutual-TLS certificate-bound access tokens and mutual-TLS client authentication
are distinct mechanisms, which are complementary but don't necessarily need to be deployed or used together.
</t>
<t>
Additional client metadata parameters are introduced by this document in support of
certificate-bound access tokens and mutual-TLS client authentication.
The authorization server can obtain client metadata via the
<xref target="RFC7591">Dynamic Client Registration Protocol</xref>,
which defines mechanisms for dynamically registering
OAuth 2.0 client metadata with authorization servers.
Also the metadata defined by RFC7591, and registered extensions to
it, imply a general data model for clients that is useful for
authorization server implementations even when the Dynamic Client
Registration Protocol isn't in play. Such implementations will typically have
some sort of user interface available for managing client configuration.
</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
BCP 14 <xref target="RFC2119"/> <xref target="RFC8174"/>
when, and only when, they appear in all capitals, as shown here.
</t>
</section>
<section anchor="Terminology" title="Terminology">
<t>
Throughout this document the term "mutual TLS" refers to the process whereby, in addition to the normal TLS
server authentication with a certificate, a client presents its X.509 certificate
and proves possession of the corresponding private key to a server when negotiating a TLS session.
In contemporary versions of TLS <xref target="RFC8446"/> <xref target="RFC5246"/> this requires that the client send
the Certificate and CertificateVerify messages during the handshake and
for the server to verify the CertificateVerify and Finished messages.
</t>
</section>
</section>
<section anchor="mtlsca" title="Mutual TLS for OAuth Client Authentication">
<t>
This section defines, as an extension of
<xref target="RFC6749">OAuth 2.0, Section 2.3</xref>, two distinct methods of using
mutual-TLS X.509 client certificates as client credentials.
The requirement of mutual TLS for client authentication is determined by the authorization server
based on policy or configuration for the given client (regardless of whether the client was dynamically
registered, statically configured, or otherwise established).
</t>
<t>
In order to utilize TLS for OAuth client authentication, the TLS
connection between the client and the authorization server MUST have been established or reestablished
with mutual-TLS X.509 certificate authentication
(i.e. the Client Certificate and Certificate Verify messages are sent during the TLS Handshake).
</t>
<t>
For all requests to the authorization server utilizing mutual-TLS client authentication,
the client MUST include the <spanx style='verb'>client_id</spanx> parameter,
described in <xref target="RFC6749">OAuth 2.0, Section 2.2</xref>.
The presence of the <spanx style='verb'>client_id</spanx>
parameter enables the authorization server to easily identify the
client independently from the content of the certificate. The authorization server
can locate the client configuration using the client identifier and check the certificate
presented in the TLS Handshake against the expected credentials for that client.
The authorization server MUST enforce the
binding between client and certificate as described in either <xref target="pki_method"/> or
<xref target="self_signed_method"/> below.
If no certificate is presented or that which is presented doesn't match that which is expected for the given <spanx style='verb'>client_id</spanx>,
the authorization server returns a normal OAuth 2.0 error response per <xref target="RFC6749"> Section 5.2 of RFC6749</xref>
with the <spanx style='verb'>invalid_client</spanx> error code to indicate failed client authentication.
</t>
<section anchor="pki_method" title="PKI Mutual-TLS Method">
<t>
The PKI (public key infrastructure) method of mutual-TLS OAuth client authentication
adheres to the way in which X.509 certificates are traditionally used
for authentication. It relies on a validated certificate chain <xref target="RFC5280"/>
and a single subject distinguished name (DN) or a single
subject alternative name (SAN) to authenticate the client.
Only one subject name value of any type is used for each client.
The TLS handshake is utilized to validate the client's possession
of the private key corresponding to the public key in the certificate and to
validate the corresponding certificate chain. The client is successfully authenticated
if the subject information in the certificate matches the single expected subject configured or
registered for that particular client
(note that a predictable treatment of DN values, such as the distinguishedNameMatch
rule from <xref target="RFC4517"/>, is needed in comparing the
certificate's subject DN to the client's registered DN).
Revocation checking is possible with the PKI method but if and how to check a certificate's
revocation status is a deployment decision at the discretion of the authorization server.
Clients can rotate their X.509 certificates
without the need to modify the respective authentication data at the authorization
server by obtaining a new certificate with the same subject from a trusted certificate authority (CA).
</t>
<section anchor="metadata_auth_value_pki" title="PKI Method Metadata Value">
<t>
For the PKI method of mutual-TLS client authentication, this specification
defines and registers the following authentication method metadata
value into the "OAuth Token Endpoint Authentication Methods" registry
<xref target="IANA.OAuth.Parameters"/>.
</t>
<t>
<list style="hanging">
<t hangText="tls_client_auth">
<vspace/>
Indicates that client authentication to the authorization server will occur with
mutual TLS utilizing the PKI method of associating a certificate to a client.
</t>
</list>
</t>
</section>
<section anchor="client_metadata_pki" title="Client Registration Metadata">
<t>
In order to convey the expected subject of the certificate,
the following metadata
parameters are introduced for the
<xref target="RFC7591">OAuth 2.0 Dynamic Client Registration Protocol</xref> in support of
the PKI method of mutual-TLS client authentication.
A client using the <spanx style="verb">tls_client_auth</spanx> authentication method MUST use
exactly one of the below metadata parameters to indicate the certificate subject value that
the authorization server is to expect when authenticating the respective client.
<list style="hanging">
<t hangText="tls_client_auth_subject_dn"><vspace/>
An <xref target="RFC4514"/> string representation of the expected subject distinguished
name of the certificate, which the OAuth client will use in mutual-TLS authentication.
</t>
<t hangText="tls_client_auth_san_dns"><vspace/>
A string containing the value of an expected dNSName SAN entry
in the certificate, which the OAuth client will use in mutual-TLS
authentication.
</t>
<t hangText="tls_client_auth_san_uri"><vspace/>
A string containing the value of an expected
uniformResourceIdentifier SAN entry in the certificate, which
the OAuth client will use in mutual-TLS authentication.
</t>
<t hangText="tls_client_auth_san_ip"><vspace/>
A string representation of an IP address in either dotted decimal
notation (for IPv4) or colon-delimited hexadecimal (for IPv6, as
defined in <xref target="RFC5952"/>) that is expected to be present
as an iPAddress SAN entry in the certificate, which the OAuth
client will use in mutual-TLS authentication. Per section 8 of <xref target="RFC5952"/>
the IP address comparison of the value in this parameter and the SAN entry in the
certificate is to be done in binary format.
</t>
<t hangText="tls_client_auth_san_email"><vspace/>
A string containing the value of an expected rfc822Name SAN
entry in the certificate, which the OAuth client will use in
mutual-TLS authentication.
</t>
</list>
</t>
</section>
</section>
<section anchor="self_signed_method" title="Self-Signed Certificate Mutual-TLS Method">
<t>
This method of mutual-TLS OAuth client authentication
is intended to support client authentication using self-signed certificates.
As a prerequisite, the client registers its X.509 certificates
(using <spanx style="verb">jwks</spanx> defined in <xref target="RFC7591"/>) or a reference to a trusted source
for its X.509 certificates (using <spanx style="verb">jwks_uri</spanx> from <xref target="RFC7591"/>)
with the authorization server. During authentication,
TLS is utilized to validate the client's possession of the private key
corresponding to the public key presented within the certificate in the respective TLS handshake. In
contrast to the PKI method, the client's certificate chain is not validated by the server in this case.
The client is successfully authenticated if the
certificate that it presented during the handshake matches one of the certificates
configured or registered for that particular client.
The Self-Signed Certificate method allows the use of mutual TLS to authenticate clients without
the need to maintain a PKI. When used in conjunction with a <spanx style="verb">jwks_uri</spanx> for the
client, it also allows the client to rotate its X.509 certificates without the
need to change its respective authentication data directly with the authorization server.
</t>
<section anchor="metadata_auth_value_self_signed" title="Self-Signed Method Metadata Value">
<t>
For the Self-Signed Certificate method of mutual-TLS client authentication, this specification
defines and registers the following authentication method metadata
value into the "OAuth Token Endpoint Authentication Methods" registry
<xref target="IANA.OAuth.Parameters"/>.
</t>
<t>
<list style="hanging">
<t hangText="self_signed_tls_client_auth">
<vspace/>
Indicates that client authentication to the authorization server will occur using
mutual TLS with the client utilizing a self-signed certificate.
</t>
</list>
</t>
</section>
<section anchor="client_metadata_self_signed" title="Client Registration Metadata">
<t>
For the Self-Signed Certificate method of binding a certificate with a client using mutual
TLS client authentication, the existing
<spanx style="verb">jwks_uri</spanx> or <spanx style="verb">jwks</spanx>
metadata parameters from <xref target="RFC7591"/> are used to convey the client's
certificates via JSON Web Key (JWK) in a JWK Set (JWKS) <xref target="RFC7517"/>.
The <spanx style="verb">jwks</spanx> metadata parameter is a
JWK Set containing the client's public keys as an array of JWKs while
the <spanx style="verb">jwks_uri</spanx> parameter is a URL that references a client's JWK Set.
A certificate is represented with the <spanx style="verb">x5c</spanx> parameter of an individual JWK within
the set.
Note that the members of the JWK representing the public key (e.g. "n" and "e" for RSA,
"x" and "y" for EC) are required parameters per <xref target="RFC7518"/> so will be present
even though they are not utilized in this context. Also note that
that Section 4.7 of <xref target="RFC7517"/> requires that the key
in the first certificate of the <spanx style="verb">x5c</spanx> parameter match the public
key represented by those other members of the JWK.
</t>
</section>
</section>
</section>
<section anchor="CertificateBoundAccessTokens" title="Mutual-TLS Client Certificate-Bound Access Tokens">
<t>
When mutual TLS is used by the client on the connection to the token endpoint,
the authorization server is able to bind the issued access token to the client certificate.
Such a binding is accomplished by associating the certificate with the token in
a way that can be accessed by the protected resource, such as embedding the certificate
hash in the issued access token directly, using the syntax described in <xref target="x5t"/>,
or through token introspection as described in <xref target="introspect"/>.
Binding the access token to the client certificate in that fashion has the benefit of
decoupling that binding from the client's authentication with the
authorization server, which enables mutual TLS during protected resource access to
serve purely as a proof-of-possession mechanism.
Other methods of associating a certificate with an access token are possible,
per agreement by the authorization server and the protected resource, but are
beyond the scope of this specification.
</t>
<t>
In order for a resource server to use certificate-bound access tokens, it
must have advance knowledge that mutual TLS is to be used for some or all
resource accesses. In particular, the access token itself
cannot be used as input to the decision of whether or not to request mutual TLS,
since from the TLS perspective those are "Application Data", only exchanged
after the TLS handshake has been completed, and the initial
CertificateRequest occurs during the handshake, before the Application Data
is available. Although subsequent opportunities for a TLS client to
present a certificate may be available, e.g., via TLS 1.2 renegotiation
<xref target="RFC5246"/> or TLS 1.3 post-handshake authentication <xref target="RFC8446"/>, this document
makes no provision for their usage. It is expected to be common that a
mutual-TLS-using resource server will require mutual TLS for all resources hosted
thereupon, or will serve mutual-TLS-protected and regular resources on separate
hostname+port combinations, though other workflows are possible. How
resource server policy is synchronized with the AS is out of scope for this
document.
</t>
<t>
Within the scope of an mutual-TLS-protected resource-access flow,
the client makes protected resource requests as described in <xref target="RFC6750"/>,
however, those requests MUST be made over a mutually authenticated TLS connection
using the same certificate that was used for mutual TLS at the token endpoint.
</t>
<t>
The protected resource MUST obtain, from its TLS implementation layer, the client certificate
used for mutual TLS
and MUST verify that the certificate matches the
certificate associated with the access token. If they do not match,
the resource access attempt MUST be rejected with an error per <xref target="RFC6750"/>
using an HTTP 401 status code and the <spanx style="verb">invalid_token</spanx> error code.
</t>
<t>
Metadata to convey server and client capabilities for mutual-TLS client certificate-bound access tokens
is defined in <xref target="server_metadata_at"/> and <xref target="client_metadata_at"/> respectively.
</t>
<section anchor="x5t" title="JWT Certificate Thumbprint Confirmation Method">
<t>
When access tokens are represented as JSON Web Tokens (JWT)<xref target="RFC7519"/>,
the certificate hash information SHOULD be represented using
the <spanx style="verb">x5t#S256</spanx> confirmation method member defined herein.
</t>
<t>
To represent the hash of a certificate in a JWT,
this specification defines the new <xref target="RFC7800">JWT Confirmation Method</xref>
member <spanx style="verb">x5t#S256</spanx> for the X.509 Certificate SHA-256 Thumbprint.
The value of the <spanx style="verb">x5t#S256</spanx> member is a base64url-encoded <xref target="RFC4648"/>
SHA-256 <xref target="SHS"/> hash (a.k.a. thumbprint, fingerprint or digest) of the DER encoding <xref target="X690"/> of the X.509 certificate
<xref target="RFC5280"/>. The base64url-encoded value MUST omit all trailing pad '=' characters
and MUST NOT include any line breaks, whitespace, or other additional characters.
</t>
<t>
The following is an example of a JWT payload containing an <spanx style="verb">x5t#S256</spanx> certificate thumbprint
confirmation method. The new JWT content introduced by this specification is the <spanx style="verb">cnf</spanx>
confirmation method claim at the bottom of the example that has
the <spanx style="verb">x5t#S256</spanx> confirmation method member containing the value that is the hash
of the client certificate to which the access token is bound.
</t>
<figure anchor="eg_x5ts256jwt" title="Example JWT Claims Set with an X.509 Certificate Thumbprint Confirmation Method">
<artwork><![CDATA[
{
"iss": "https://server.example.com",
"sub": "[email protected]",
"exp": 1493726400,
"nbf": 1493722800,
"cnf":{
"x5t#S256": "bwcK0esc3ACC3DB2Y5_lESsXE8o9ltc05O89jdN-dg2"
}
}]]>
</artwork>
</figure>
</section>
<section anchor="introspect" title="Confirmation Method for Token Introspection">
<t>
<xref target="RFC7662">OAuth 2.0 Token Introspection</xref> defines a
method for a protected resource to query
an authorization server about the active state of an
access token as well as to determine meta-information about the token.
</t>
<t>
For a mutual-TLS client certificate-bound access token, the hash of the
certificate to which the token is bound
is conveyed to the protected resource as meta-information
in a token introspection response. The hash is conveyed using the same
<spanx style="verb">cnf</spanx> with <spanx style="verb">x5t#S256</spanx> member structure as the
certificate SHA-256 thumbprint confirmation method, described in
<xref target="x5t"/>, as a top-level member of the introspection response JSON.
The protected resource compares
that certificate hash to a hash of the client certificate used for
mutual-TLS authentication
and rejects the request, if they do not match.
</t>
<t>
The following is an example of an introspection response for an active token with
an <spanx style="verb">x5t#S256</spanx> certificate thumbprint
confirmation method. The new introspection response content introduced by this specification is the <spanx style="verb">cnf</spanx>
confirmation method at the bottom of the example that has
the <spanx style="verb">x5t#S256</spanx> confirmation method member containing the value that is the hash
of the client certificate to which the access token is bound.
</t>
<figure anchor="eg_x5ts256intro" title="Example Introspection Response for a Certificate-Bound Access Token">
<artwork><![CDATA[
HTTP/1.1 200 OK
Content-Type: application/json
{
"active": true,
"iss": "https://server.example.com",
"sub": "[email protected]",
"exp": 1493726400,
"nbf": 1493722800,
"cnf":{
"x5t#S256": "bwcK0esc3ACC3DB2Y5_lESsXE8o9ltc05O89jdN-dg2"
}
}]]>
</artwork>
</figure>
</section>
<section anchor="server_metadata_at" title="Authorization Server Metadata">
<t>This document introduces the following new authorization server
metadata <xref target="RFC8414"/> parameter to signal the server's capability to issue certificate
bound access tokens:
<list style="hanging">
<t hangText="tls_client_certificate_bound_access_tokens"><vspace/>
OPTIONAL. Boolean value indicating server support for
mutual-TLS client certificate-bound access tokens. If omitted, the
default value is <spanx style="verb">false</spanx>.
</t>
</list>
</t>
</section>
<section anchor="client_metadata_at" title="Client Registration Metadata">
<t>The following new client
metadata parameter is introduced to convey the client's intention to use certificate
bound access tokens:
<list style="hanging">
<t hangText="tls_client_certificate_bound_access_tokens"><vspace/>
OPTIONAL. Boolean value used to indicate the client's intention
to use mutual-TLS client certificate-bound access tokens.
If omitted, the default value is <spanx style="verb">false</spanx>.
</t>
</list>
Note that, if a client that has indicated the intention to use mutual-TLS client certificate-bound tokens
makes a request to the token endpoint over a non-mutual-TLS connection,
it is at the authorization server's discretion as to whether to return an error or issue an unbound token.
</t>
</section>
</section>
<section anchor="PubClient" title="Public Clients and Certificate-Bound Tokens">
<t>
Mutual-TLS OAuth client authentication and certificate-bound access tokens
can be used independently of each other.
Use of certificate-bound access tokens without mutual-TLS OAuth client authentication, for example,
is possible in support of binding access tokens to a TLS client certificate for public clients (those without
authentication credentials associated with the <spanx style="verb">client_id</spanx>).
The authorization server would configure the TLS stack in the same manner as for the Self-Signed Certificate method
such that it does not verify that the certificate presented by the client during the handshake is
signed by a trusted CA. Individual instances of a client would create a self-signed
certificate for mutual TLS with both the authorization server and resource server. The authorization
server would not use the mutual-TLS certificate to authenticate the client at the OAuth layer
but would bind the issued access token
to that certificate, for which the client has proven possession of the corresponding private key.
The access token is then bound to the certificate and can only be used by the client
possessing the certificate and corresponding private key and utilizing them to negotiate mutual TLS on
connections to the resource server.
When the authorization server issues a refresh token to such a client, it SHOULD also bind the refresh token
to the respective certificate. And check the binding when the refresh token is presented to get new
access tokens.
The implementation details of the binding the refresh token are at the discretion of the authorization
server.
</t>
</section>
<section anchor="endpointAliases" title="Metadata for Mutual-TLS Endpoint Aliases">
<t>
The process of negotiating client certificate-based mutual TLS involves a TLS server requesting a certificate
from the TLS client (the client does not provide one unsolicited). Although a server can be configured
such that client certificates are optional, meaning that the connection is allowed to continue when the client
does not provide a certificate, the act of a server requesting a certificate can result in undesirable
behavior from some clients. This is particularly true of web browsers as TLS clients, which will typically
present the end-user with an intrusive certificate selection interface when the server requests a certificate.
</t>
<t>
Authorization servers supporting both clients using mutual TLS and conventional clients MAY chose to
isolate the server side mutual-TLS behavior to only clients intending to do mutual TLS, thus
avoiding any undesirable effects it might have on conventional clients. The following authorization server
metadata parameter is introduced to facilitate such separation:
</t>
<t>
<list style="hanging">
<t hangText="mtls_endpoint_aliases">
<vspace/>OPTIONAL.
A JSON object containing alternative authorization server endpoints that,
when present, an OAuth client intending to do mutual TLS
uses in preference to the conventional endpoints.
The parameter value itself consists of one or more endpoint parameters,
such as <spanx style="verb">token_endpoint</spanx>,
<spanx style="verb">revocation_endpoint</spanx>,
<spanx style="verb">introspection_endpoint</spanx>, etc., conventionally defined for the
top-level of authorization server metadata.
An OAuth client intending to do mutual TLS
(for OAuth client authentication and/or to acquire or use certificate-bound tokens)
when making a request directly to the authorization server MUST
use the alias URL of the endpoint within the <spanx style="verb">mtls_endpoint_aliases</spanx>, when present,
in preference to the endpoint URL of the same name at top-level of metadata.
When an endpoint is not present in
<spanx style="verb">mtls_endpoint_aliases</spanx>, then the client uses the conventional endpoint URL
defined at the top-level of the authorization server metadata. Metadata parameters within
<spanx style="verb">mtls_endpoint_aliases</spanx> that do not define
endpoints to which an OAuth client makes a direct request have no meaning and SHOULD be ignored.
</t>
</list>
</t>
<t>
Below is an example of an authorization server metadata document with the
<spanx style="verb">mtls_endpoint_aliases</spanx> parameter, which indicates aliases for the
token, revocation, and introspection endpoints that an OAuth client intending to do mutual TLS
would in preference to the conventional token, revocation, and introspection endpoints.
Note that the endpoints in <spanx style="verb">mtls_endpoint_aliases</spanx> use a different
host than their conventional counterparts, which allows the authorization server
(via TLS <spanx style="verb">server_name</spanx> extension <xref target="RFC6066"/> or actual distinct hosts) to differentiate its TLS behavior as appropriate.
<figure title='Example Authorization Server Metadata with Mutual-TLS Endpoint Aliases' anchor='as-meta'>
<artwork><![CDATA[
{
"issuer": "https://server.example.com",
"authorization_endpoint": "https://server.example.com/authz",
"token_endpoint": "https://server.example.com/token",
"introspection_endpoint": "https://server.example.com/introspect",
"revocation_endpoint": "https://server.example.com/revo",
"jwks_uri": "https://server.example.com/jwks",
"response_types_supported": ["code"],
"response_modes_supported": ["fragment","query","form_post"],
"grant_types_supported": ["authorization_code", "refresh_token"],
"token_endpoint_auth_methods_supported":
["tls_client_auth","client_secret_basic","none"],
"tls_client_certificate_bound_access_tokens": true
"mtls_endpoint_aliases": {
"token_endpoint": "https://mtls.example.com/token",
"revocation_endpoint": "https://mtls.example.com/revo",
"introspection_endpoint": "https://mtls.example.com/introspect"
}
}
]]></artwork>
</figure>
</t>
</section>
<section anchor="Impl" title="Implementation Considerations">
<section anchor="ImplAS" title="Authorization Server">
<t>The authorization server needs to set up its TLS configuration appropriately
for the OAuth client authentication methods it supports.</t>
<t>An authorization server that supports mutual-TLS client authentication
and other client authentication methods or public clients in parallel would make mutual TLS
optional (i.e. allowing a handshake to continue after the server requests a client certificate
but the client does not send one).</t>
<t>In order to support the Self-Signed Certificate method alone, the authorization server
would configure the TLS stack in such a way that it does not verify whether the
certificate presented by the client during the handshake is signed by a trusted CA
certificate.</t>
<t>As described in <xref target="CertificateBoundAccessTokens"/>, the authorization server
binds the issued access token to the TLS client certificate, which means that it
will only issue certificate-bound tokens for a
certificate which the client has proven possession of the corresponding private key.</t>
<t>The authorization server may also consider hosting the token endpoint,
and other endpoints requiring client authentication, on
a separate host name or port in order to prevent unintended impact on the TLS behavior of
its other endpoints, e.g. the authorization endpoint. As described in <xref target="endpointAliases"/>,
it may further isolate any potential impact of the server requesting client certificates by
offering a distinct set of endpoints on a separate host or port, which are aliases for
the originals that a client intending to do mutual TLS will use in preference to the conventional endpoints.</t>
</section>
<section anchor="ImplRS" title="Resource Server">
<t>
OAuth divides the roles and responsibilities such that the resource server relies
on the authorization server to perform client authentication and obtain resource owner (end-user)
authorization. The resource server makes authorization decisions based on the access token
presented by the client but does not directly authenticate the client per se.
The manner in which an access token is bound to the client certificate and how a protected resource verifies the proof-of-possession
decouples that from the specific method that the client used to authenticate with the
authorization server. Mutual TLS during protected resource access can therefore
serve purely as a proof-of-possession mechanism.
As such, it is not necessary for the resource server to validate
the trust chain of the client's certificate in any of the methods
defined in this document.
The resource server would therefore configure the TLS stack
in a way that it does not verify whether the certificate presented by the client
during the handshake is signed by a trusted CA certificate.
</t>
</section>
<section anchor="ImplExp" title="Certificate Expiration and Bound Access Tokens">
<t>
As described in <xref target="CertificateBoundAccessTokens"/>,
an access token is bound to a specific client certificate, which means that
the same certificate must be used for mutual TLS on protected resource access.
It also implies that access tokens are invalidated when a client updates the certificate,
which can be handled similar to expired access tokens where the client
requests a new access token (typically with a refresh token) and retries the protected resource
request.
</t>
</section>
<section anchor="ImplImplicit" title="Implicit Grant Unsupported">
<t>
This document describes binding an access token to the
client certificate presented on the TLS connection from the client to the
authorization server's token endpoint,
however, such binding of access tokens issued directly from the authorization
endpoint via the implicit grant flow is explicitly out of scope.
End users interact directly with the authorization endpoint using a web browser
and the use of client certificates in user's browsers bring operational and
usability issues, which make it undesirable to support certificate-bound access
tokens issued in the implicit grant flow. Implementations wanting to employ
certificate-bound access tokens should utilize grant types
that involve the client making an access token request directly to the token endpoint
(e.g. the authorization code and refresh token grant types).
</t>
</section>
<section anchor="TTRP" title="TLS Termination">
<t>
An authorization server or resource server MAY choose to terminate TLS connections at a load balancer,
reverse proxy, or other network intermediary. How the client certificate metadata is securely
communicated between the intermediary and the application server in this case is out of scope of this specification.
</t>
</section>
</section>
<section anchor="Security" title="Security Considerations">
<section title="Certificate-Bound Refresh Tokens">
<t>The OAuth 2.0 Authorization Framework <xref target="RFC6749"/> requires that an authorization server
bind refresh tokens to the client to which they were issued and that confidential clients
(those having established authentication credentials with the authorization server) authenticate to
the AS when presenting a refresh token. As a result, refresh tokens are indirectly certificate-bound by way of the
client ID and the associated requirement for (certificate-based) authentication to the authorization server when
issued to clients utilizing the <spanx style="verb">tls_client_auth</spanx> or
<spanx style="verb">self_signed_tls_client_auth</spanx> methods of client authentication.
<xref target="PubClient"/> describes certificate-bound refresh tokens issued to public clients (those without
authentication credentials associated with the <spanx style="verb">client_id</spanx>).
</t>
</section>
<section title="Certificate Thumbprint Binding">
<t>
The binding between the certificate and access token specified in <xref target="x5t"/> uses
a cryptographic hash of the certificate. It relies on the hash function having sufficient
second-preimage resistance so as to make it computationally infeasible to
find or create another certificate that produces to the same hash output value.
The SHA-256 hash function was used because it meets the aforementioned requirement while being widely available.
If, in the future, certificate thumbprints need to be computed using
hash function(s) other than SHA-256, it is suggested that additional
related JWT confirmation methods members be defined for that purpose
and registered in the IANA "JWT Confirmation Methods" registry
<xref target="IANA.JWT.Claims"/>
for JWT <spanx style="verb">cnf</spanx> member values.
</t>
<t>
Community knowledge about the strength of various algorithms and
feasible attacks can change suddenly, and experience shows that a
document about security is a point-in-time
statement. Readers are advised to seek out any errata or updates
that apply to this document.
</t>
</section>
<section anchor="TLSV" title="TLS Versions and Best Practices">
<t>
In the abstract this document is applicable with any TLS version supporting certificate-based client authentication.
Both <xref target="RFC8446">TLS 1.3</xref> and <xref target="RFC5246">TLS 1.2</xref> are cited herein because,
at the time of writing, 1.3 is the newest version while 1.2 is the most widely deployed.
General implementation and security considerations for TLS, including version recommendations,
can be found in <xref target="BCP195"/>.
</t>
<t>
TLS certificate validation
(for both client and server certificates) requires a local database of
trusted certificate authorities (CAs). Decisions about what CAs to trust
and how to make such a determination of trust are out of scope for this
document.
</t>
</section>
<section anchor="certspoofing" title="X.509 Certificate Spoofing">
<t>
If the PKI method of client authentication is used, an attacker could try to impersonate a client using
a certificate with the same subject (DN or SAN) but issued by a different CA, which the authorization server trusts.
To cope with that threat, the authorization server SHOULD only accept as trust anchors
a limited number of CAs whose certificate issuance policy meets its security requirements.
There is an assumption then that the client and server agree out of band on the set
of trust anchors that the server uses to create and validate the
certificate chain. Without this assumption the use of a subject
to identify the client certificate would open the server up to
certificate spoofing attacks.
</t>
</section>
<section title="X.509 Certificate Parsing and Validation Complexity">
<t>
Parsing and validation of X.509 certificates and certificate chains is complex and implementation
mistakes have previously exposed security vulnerabilities.
Complexities of validation include (but are not limited to)
<xref target="CX5P"/> <xref target="DCW"/> <xref target="RFC5280"/>:
</t>
<t>
<list style="symbols">
<t>checking of Basic Constraints, basic and extended Key Usage constraints, validity periods, and critical extensions;</t>
<t>handling of embedded NUL bytes in ASN.1 counted-length strings, and non-canonical or non-normalized string representations in subject names;</t>
<t>handling of wildcard patterns in subject names;</t>
<t>recursive verification of certificate chains and checking certificate revocation.</t>
</list>
</t><t>
For these reasons, implementors SHOULD use an established and well-tested X.509 library
(such as one used by an established TLS library) for validation of X.509 certificate chains
and SHOULD NOT attempt to write their own X.509 certificate validation procedures.
</t>
</section>
</section>
<section anchor="Privacy" title="Privacy Considerations">
<t>
In TLS versions prior to 1.3, the client's certificate is sent unencrypted in the initial handshake and
can potentially be used by third parties to monitor, track, and correlate client activity.
This is likely of little concern for clients that act on behalf of a significant number of end-users because
individual user activity will not be discernible amidst the client activity as a whole.
However, clients that act on behalf of a single end-user, such as a native application on a mobile device,
should use TLS version 1.3 whenever possible or consider the potential privacy implications of using mutual TLS on
earlier versions.
</t>
</section>
<section anchor="IANA" title="IANA Considerations">
<section title="JWT Confirmation Methods Registration">
<t>
This specification requests registration of the following value
in the IANA "JWT Confirmation Methods" registry
<xref target="IANA.JWT.Claims"/>
for JWT <spanx style="verb">cnf</spanx> member values
established by <xref target="RFC7800"/>.
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Confirmation Method Value: <spanx style="verb">x5t#S256</spanx></t>
<t>Confirmation Method Description: X.509 Certificate SHA-256 Thumbprint</t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="x5t"/> of [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
</section>
<section title="Authorization Server Metadata Registration">
<t>
This specification requests registration of the following values
in the IANA "OAuth Authorization Server Metadata" registry
<xref target="IANA.OAuth.Parameters"/> established by <xref target="RFC8414"/>.
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Metadata Name: <spanx style="verb">tls_client_certificate_bound_access_tokens</spanx></t>
<t>Metadata Description: Indicates authorization server support for mutual-TLS client certificate-bound
access tokens.</t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="server_metadata_at"/> of [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Metadata Name: <spanx style="verb">mtls_endpoint_aliases</spanx></t>
<t>Metadata Description: JSON object containing alternative authorization server endpoints, which a client
intending to do mutual TLS will use in preference to the conventional endpoints.</t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="endpointAliases"/> of [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
</section>
<section title="Token Endpoint Authentication Method Registration">
<t>
This specification requests registration of the following values
in the IANA "OAuth Token Endpoint Authentication Methods" registry
<xref target="IANA.OAuth.Parameters"/> established by <xref target="RFC7591"/>.
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Token Endpoint Authentication Method Name: <spanx style="verb">tls_client_auth</spanx></t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="metadata_auth_value_pki"/> of [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Token Endpoint Authentication Method Name: <spanx style="verb">self_signed_tls_client_auth</spanx></t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="metadata_auth_value_self_signed"/> of [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
</section>
<section title="Token Introspection Response Registration">
<t>
<xref target="RFC7800">Proof-of-Possession Key Semantics for JSON Web Tokens</xref> defined the
<spanx style="verb">cnf</spanx> (confirmation) claim, which enables
confirmation key information to be carried in a JWT.
However, the same proof-of-possession semantics are also useful for introspected access tokens
whereby the protected resource obtains the confirmation key data as meta-information
of a token introspection response and uses that information in verifying proof-of-possession.
Therefore this specification defines and registers proof-of-possession semantics for
<xref target="RFC7662">OAuth 2.0 Token Introspection</xref> using the <spanx style="verb">cnf</spanx>
structure.
When included as a top-level member of an OAuth token introspection response, <spanx style="verb">cnf</spanx>
has the same semantics and format as the claim of the same name defined in <xref target="RFC7800"/>.
While this specification only explicitly uses the <spanx style="verb">x5t#S256</spanx>
confirmation method member (see <xref target="introspect"/>), it needs to define and register
the higher level <spanx style="verb">cnf</spanx>
structure as an introspection response member in order to define and use the more specific
certificate thumbprint confirmation method.
</t>
<t>
As such, this specification requests registration of the following value
in the IANA "OAuth Token Introspection Response" registry
<xref target="IANA.OAuth.Parameters"/>
established by <xref target="RFC7662"/>.
</t>
<t>
<?rfc subcompact="yes"?>
<list style='symbols'>
<t>Claim Name: <spanx style="verb">cnf</spanx></t>
<t>Claim Description: Confirmation</t>
<t>Change Controller: IESG</t>
<t>Specification Document(s): <xref target="RFC7800"/> and [[ this specification ]]</t>
</list>
<?rfc subcompact="no"?>
</t>
</section>
<section title="Dynamic Client Registration Metadata Registration">
<t>
This specification requests registration of the following client metadata definitions
in the IANA "OAuth Dynamic Client Registration Metadata" registry
<xref target="IANA.OAuth.Parameters"/>
established by <xref target="RFC7591"/>:
</t>
<t>
<?rfc subcompact="yes"?>
<list style="symbols">
<t>
Client Metadata Name: <spanx style="verb">tls_client_certificate_bound_access_tokens</spanx>
</t>
<t>
Client Metadata Description:
Indicates the client's intention to use mutual-TLS client certificate-bound
access tokens.
</t>