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
|
<pre>Internet Engineering Task Force (IETF) J. Gould
Request for Comments: 8495 VeriSign, Inc.
Category: Standards Track K. Feher
ISSN: 2070-1721 Neustar
November 2018
<span class="h1">Allocation Token Extension</span>
<span class="h1">for the Extensible Provisioning Protocol (EPP)</span>
Abstract
This document describes an Extensible Provisioning Protocol (EPP)
extension for including an Allocation Token in "query" and
"transform" commands. The Allocation Token is used as a credential
that authorizes a client to request the allocation of a specific
object from the server using one of the EPP transform commands,
including "create" and "transfer".
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="https://www.rfc-editor.org/info/rfc8495">https://www.rfc-editor.org/info/rfc8495</a>.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Gould & Feher Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-1.1">1.1</a>. Conventions Used in This Document . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-2">2</a>. Object Attributes . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-2.1">2.1</a>. Allocation Token . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3">3</a>. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.1">3.1</a>. EPP Query Commands . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.1.1">3.1.1</a>. EPP <check> Command . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.1.2">3.1.2</a>. EPP <info> Command . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-3.1.3">3.1.3</a>. EPP <transfer> Query Command . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-3.2">3.2</a>. EPP Transform Commands . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-3.2.1">3.2.1</a>. EPP <create> Command . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-3.2.2">3.2.2</a>. EPP <delete> Command . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-3.2.3">3.2.3</a>. EPP <renew> Command . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-3.2.4">3.2.4</a>. EPP <transfer> Command . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-3.2.5">3.2.5</a>. EPP <update> Command . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-4">4</a>. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-4.1">4.1</a>. Allocation Token Extension Schema . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-5">5</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-5.1">5.1</a>. XML Namespace . . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-5.2">5.2</a>. EPP Extension Registry . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-6">6</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-7">7</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-7.1">7.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-7.2">7.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document describes an extension mapping for version 1.0 of the
Extensible Provisioning Protocol (EPP) [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>]. This mapping,
which is an extension to EPP object mappings similar to the EPP
domain name mapping [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>], supports passing an Allocation Token
as a credential that authorizes a client to request the allocation of
a specific object from the server using one of the EPP transform
commands, including "create" and "transfer".
Allocation is when a server assigns the sponsoring client of an
object based on the use of an Allocation Token credential. Examples
include allocating a registration based on a pre-eligibility
Allocation Token, allocating a premium domain name registration based
on an auction Allocation Token, allocating a registration based on a
founders Allocation Token, and allocating an existing domain name
held by the server or by a different sponsoring client based on an
Allocation Token that is passed with a transfer command.
<span class="grey">Gould & Feher Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
Clients pass an Allocation Token to the server for validation, and
the server determines if the supplied Allocation Token is one
supported by the server. It is up to server policy which EPP
transform commands and which objects require the Allocation Token.
The Allocation Token MAY be returned to an authorized client for
passing out-of-band to a client that uses it with an EPP transform
command.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Conventions Used in This Document</span>
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
<a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all
capitals, as shown here.
XML is case sensitive. Unless stated otherwise, XML specifications
and examples provided in this document MUST be interpreted in the
character case presented in order to develop a conforming
implementation.
In examples, "C:" represents lines sent by a protocol client and "S:"
represents lines returned by a protocol server. Indentation and
white space in the examples are provided only to illustrate element
relationships and are not REQUIRED in the protocol.
The XML namespace prefix "allocationToken" is used for the namespace
"urn:ietf:params:xml:ns:allocationToken-1.0", but implementations
MUST NOT depend on it and instead employ a proper namespace-aware XML
parser and serializer to interpret and output the XML documents.
The "abc123" token value is used as a placeholder value in the
examples. The server MUST support token values that follow the
Security Considerations (<a href="#section-6">Section 6</a>).
The domain-object attribute values, including the "2fooBAR"
<domain:pw> value, in the examples are provided for illustration
purposes only. Refer to [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>] for details on the domain-object
attributes.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Object Attributes</span>
This extension adds additional elements to EPP object mappings
similar to the EPP domain name mapping [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>]. Only those new
elements are described here.
<span class="grey">Gould & Feher Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Allocation Token</span>
The Allocation Token is a simple XML "token" type. The exact format
of the Allocation Token is up to server policy. The server MAY have
the Allocation Token for each object to match against the Allocation
Token passed by the client to authorize the allocation of the object.
The <allocationToken:allocationToken> element is used for all of the
supported EPP commands as well as the info response. If the supplied
Allocation Token passed to the server does not apply to the object,
the server MUST return an EPP error result code of 2201.
Authorization information, similar to what is defined in the EPP
domain name mapping [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>], is associated with objects to
facilitate transfer operations. The authorization information is
assigned when an object is created. The Allocation Token and the
authorization information are both credentials but are used for
different purposes and in different ways. The Allocation Token is
used to facilitate the allocation of an object instead of
transferring the sponsorship of the object. The Allocation Token is
not managed by the client but is validated by the server to authorize
assigning the initial sponsoring client of the object.
An example <allocationToken:allocationToken> element with value of
"abc123":
<allocationToken:allocationToken xmlns:allocationToken=
"urn:ietf:params:xml:ns:allocationToken-1.0">
abc123
</allocationToken:allocationToken>
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. EPP Command Mapping</span>
A detailed description of the EPP syntax and semantics can be found
in the EPP core protocol specification [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. EPP Query Commands</span>
EPP provides three commands to retrieve object information: <check>
to determine if an object can be provisioned, <info> to retrieve
information associated with an object, and <transfer> to retrieve
object-transfer status information.
<span class="h4"><a class="selflink" id="section-3.1.1" href="#section-3.1.1">3.1.1</a>. EPP <check> Command</span>
This extension defines additional elements to extend the EPP <check>
command of an object mapping similar to the mapping specified in
[<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>].
<span class="grey">Gould & Feher Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
This extension allows clients to check the availability of an object
with an Allocation Token, as described in <a href="#section-2.1">Section 2.1</a>. Clients can
check if an object can be created using the Allocation Token. The
Allocation Token is applied to all object names included in the EPP
<check> command.
The following is an example <check> command for the
allocation.example domain name using the
<allocationToken:allocationToken> extension with the allocation token
of 'abc123':
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <check>
C: <domain:check
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C: <domain:name>allocation.example</domain:name>
C: </domain:check>
C: </check>
C: <extension>
C: <allocationToken:allocationToken
C: xmlns:allocationToken=
C: "urn:ietf:params:xml:ns:allocationToken-1.0">
C: abc123
C: </allocationToken:allocationToken>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
If the query was successful, the server replies with a <check>
response providing the availability status of the queried object
based on the following Allocation Token cases where the object is
otherwise available:
1. If an object requires an Allocation Token and the Allocation
Token does apply to the object, then the server MUST return the
availability status as available (e.g., the "avail" attribute is
"1" or "true").
2. If an object requires an Allocation Token and the Allocation
Token does not apply to the object, then the server SHOULD return
the availability status as unavailable (e.g., the "avail"
attribute is "0" or "false").
3. If an object does not require an Allocation Token, the server MAY
return the availability status as available (e.g., the "avail"
attribute is "1" or "true").
<span class="grey">Gould & Feher Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The following is an example <check> domain response for a <check>
command using the <allocationToken:allocationToken> extension:
S:<?xml version="1.0" encoding="UTF-8"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en-US">Command completed successfully</msg>
S: </result>
S: <resData>
S: <domain:chkData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:cd>
S: <domain:name avail="1">allocation.example</domain:name>
S: </domain:cd>
S: </domain:chkData>
S: </resData>
S: <trID>
S: <clTRID>ABC-DEF-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
<span class="grey">Gould & Feher Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The following is an example <check> command with the
<allocationToken:allocationToken> extension for the
allocation.example and allocation2.example domain names.
Availability of allocation.example and allocation2.example domain
names are based on the Allocation Token 'abc123':
C:<?xml version="1.0" encoding="UTF-8"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <check>
C: <domain:check
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C: <domain:name>allocation.example</domain:name>
C: <domain:name>allocation2.example</domain:name>
C: </domain:check>
C: </check>
C: <extension>
C: <allocationToken:allocationToken
C: xmlns:allocationToken=
C: "urn:ietf:params:xml:ns:allocationToken-1.0">
C: abc123
C: </allocationToken:allocationToken>
C: </extension>
C: <clTRID>ABC-DEF-12345</clTRID>
C: </command>
C:</epp>
<span class="grey">Gould & Feher Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The following is an example <check> domain response for multiple
domain names in the <check> command using the
<allocationToken:allocationToken> extension, where the Allocation
Token 'abc123' matches allocation.example but does not match
allocation2.example:
S:<?xml version="1.0" encoding="UTF-8"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en-US">Command completed successfully</msg>
S: </result>
S: <resData>
S: <domain:chkData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:cd>
S: <domain:name avail="1">allocation.example</domain:name>
S: </domain:cd>
S: <domain:cd>
S: <domain:name avail="0">allocation2.example</domain:name>
S: <domain:reason>Allocation Token mismatch</domain:reason>
S: </domain:cd>
S: </domain:chkData>
S: </resData>
S: <trID>
S: <clTRID>ABC-DEF-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
This extension does not add any elements to the EPP <check> response
described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h4"><a class="selflink" id="section-3.1.2" href="#section-3.1.2">3.1.2</a>. EPP <info> Command</span>
This extension defines additional elements to extend the EPP <info>
command of an object mapping similar to the mapping specified in
[<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>].
The EPP <info> command allows a client to request information
associated with an existing object. Authorized clients MAY retrieve
the Allocation Token (<a href="#section-2.1">Section 2.1</a>) along with the other object
information by supplying the <allocationToken:info> element in the
command. The <allocationToken:info> element is an empty element that
serves as a marker to the server to return the
<allocationToken:allocationToken> element in the info response. If
the client is not authorized to receive the Allocation Token, the
<span class="grey">Gould & Feher Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
server MUST return an EPP error result code of 2201. If the client
is authorized to receive the Allocation Token, but there is no
Allocation Token associated with the object, the server MUST return
an EPP error result code of 2303. The authorization is subject to
server policy.
The following is an example <info> command with the
allocationToken:info extension for the allocation.example domain
name:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <info>
C: <domain:info
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C: <domain:name>allocation.example</domain:name>
C: </domain:info>
C: </info>
C: <extension>
C: <allocationToken:info
C: xmlns:allocationToken=
C: "urn:ietf:params:xml:ns:allocationToken-1.0"/>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
If the query was successful, the server replies with an
<allocationToken:allocationToken> element along with the regular EPP
<resData>. The <allocationToken:allocationToken> element is
described in <a href="#section-2.1">Section 2.1</a>.
<span class="grey">Gould & Feher Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The following is an example <info> domain response using the
<allocationToken:allocationToken> extension:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg>Command completed successfully</msg>
S: </result>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>allocation.example</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:status s="pendingCreate"/>
S: <domain:registrant>jd1234</domain:registrant>
S: <domain:contact type="admin">sh8013</domain:contact>
S: <domain:contact type="tech">sh8013</domain:contact>
S: <domain:clID>ClientX</domain:clID>
S: <domain:crID>ClientY</domain:crID>
S: <domain:crDate>2012-04-03T22:00:00.0Z</domain:crDate>
S: <domain:authInfo>
S: <domain:pw>2fooBAR</domain:pw>
S: </domain:authInfo>
S: </domain:infData>
S: </resData>
S: <extension>
S: <allocationToken:allocationToken
S: xmlns:allocationToken=
S: "urn:ietf:params:xml:ns:allocationToken-1.0">
S: abc123
S: </allocationToken:allocationToken>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
<span class="h4"><a class="selflink" id="section-3.1.3" href="#section-3.1.3">3.1.3</a>. EPP <transfer> Query Command</span>
This extension does not add any elements to the EPP <transfer> query
command or <transfer> query response described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="grey">Gould & Feher Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. EPP Transform Commands</span>
EPP provides five commands to transform objects: <create> to create
an instance of an object, <delete> to delete an instance of an
object, <renew> to extend the validity period of an object,
<transfer> to manage object sponsorship changes, and <update> to
change information associated with an object.
<span class="h4"><a class="selflink" id="section-3.2.1" href="#section-3.2.1">3.2.1</a>. EPP <create> Command</span>
This extension defines additional elements to extend the EPP <create>
command of an object mapping similar to the mapping specified in
[<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>].
The EPP <create> command provides a transform operation that allows a
client to create an instance of an object. In addition to the EPP
command elements described in an object mapping similar to the
mapping specified in [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>], the command MUST contain a child
<allocationToken:allocationToken> element for the client to be
authorized to create and allocate the object. If the Allocation
Token does not apply to the object, the server MUST return an EPP
error result code of 2201.
<span class="grey">Gould & Feher Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The following is an example <create> command to create a domain
object with an Allocation Token:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <create>
C: <domain:create
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C: <domain:name>allocation.example</domain:name>
C: <domain:registrant>jd1234</domain:registrant>
C: <domain:contact type="admin">sh8013</domain:contact>
C: <domain:contact type="tech">sh8013</domain:contact>
C: <domain:authInfo>
C: <domain:pw>2fooBAR</domain:pw>
C: </domain:authInfo>
C: </domain:create>
C: </create>
C: <extension>
C: <allocationToken:allocationToken
C: xmlns:allocationToken=
C: "urn:ietf:params:xml:ns:allocationToken-1.0">
C: abc123
C: </allocationToken:allocationToken>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
This extension does not add any elements to the EPP <create> response
described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h4"><a class="selflink" id="section-3.2.2" href="#section-3.2.2">3.2.2</a>. EPP <delete> Command</span>
This extension does not add any elements to the EPP <delete> command
or <delete> response described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h4"><a class="selflink" id="section-3.2.3" href="#section-3.2.3">3.2.3</a>. EPP <renew> Command</span>
This extension does not add any elements to the EPP <renew> command
or <renew> response described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h4"><a class="selflink" id="section-3.2.4" href="#section-3.2.4">3.2.4</a>. EPP <transfer> Command</span>
This extension defines additional elements to extend the EPP
<transfer> command of an object mapping similar to the mapping
specified in [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>].
<span class="grey">Gould & Feher Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The EPP <transfer> command provides a transform operation that allows
a client to request the transfer of an object. In addition to the
EPP command elements described in an object mapping similar to the
mapping specified in [<a href="./rfc5731" title=""Extensible Provisioning Protocol (EPP) Domain Name Mapping"">RFC5731</a>], the command MUST contain a child
<allocationToken:allocationToken> element for the client to be
authorized to transfer and allocate the object. The authorization
associated with the Allocation Token is in addition to, and does not
replace, the authorization mechanism defined for the object's
<transfer> command. If the Allocation Token is invalid or not
required for the object, the server MUST return an EPP error result
code of 2201.
The following is an example <transfer> command to allocate the domain
object with the Allocation Token:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <transfer op="request">
C: <domain:transfer
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C: <domain:name>example1.tld</domain:name>
C: <domain:period unit="y">1</domain:period>
C: <domain:authInfo>
C: <domain:pw>2fooBAR</domain:pw>
C: </domain:authInfo>
C: </domain:transfer>
C: </transfer>
C: <extension>
C: <allocationToken:allocationToken
C: xmlns:allocationToken=
C: "urn:ietf:params:xml:ns:allocationToken-1.0">
C: abc123
C: </allocationToken:allocationToken>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
This extension does not add any elements to the EPP <transfer>
response described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="h4"><a class="selflink" id="section-3.2.5" href="#section-3.2.5">3.2.5</a>. EPP <update> Command</span>
This extension does not add any elements to the EPP <update> command
or <update> response described in [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>].
<span class="grey">Gould & Feher Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Formal Syntax</span>
One schema is presented here: the EPP Allocation Token Extension
schema.
The formal syntax presented here is a complete schema representation
of the object mapping suitable for automated validation of EPP XML
instances. The BEGIN and END tags are not part of the schema; they
are used to note the beginning and ending of the schema for URI
registration purposes.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Allocation Token Extension Schema</span>
BEGIN
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:allocationToken="urn:ietf:params:xml:ns:allocationToken-1.0"
targetNamespace="urn:ietf:params:xml:ns:allocationToken-1.0"
elementFormDefault="qualified">
<annotation>
<documentation>
Extensible Provisioning Protocol v1.0
Allocation Token Extension
</documentation>
</annotation>
<!-- Element used in info command to get allocation token. -->
<element name="info">
<complexType>
<complexContent>
<restriction base="anyType" />
</complexContent>
</complexType>
</element>
<!-- Allocation Token used in transform
commands and info response -->
<element name="allocationToken"
type="allocationToken:allocationTokenType" />
<simpleType name="allocationTokenType">
<restriction base="token">
<minLength value="1" />
</restriction>
</simpleType>
<!-- End of schema. -->
</schema>
END
<span class="grey">Gould & Feher Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. XML Namespace</span>
This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in [<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>].
The allocationToken namespace has been registered as follows.
URI: urn:ietf:params:xml:ns:allocationToken-1.0
Registrant Contact: IESG
XML: None. Namespace URIs do not represent an XML specification.
The allocationToken XML schema has been registered as follows.
URI: urn:ietf:params:xml:schema:allocationToken-1.0
Registrant Contact: IESG
XML: See the "Formal Syntax" section of this document.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. EPP Extension Registry</span>
The following entry has been added to the Extensions for the
Extensible Provisioning Protocol (EPP) registry, as described in
[<a href="./rfc7451" title=""Extension Registry for the Extensible Provisioning Protocol"">RFC7451</a>].
Name of Extension: Allocation Token Extension for the Extensible
Provisioning Protocol (EPP)
Document Status: Standards Track
Reference: <a href="./rfc8495">RFC 8495</a>
Registrant: IESG <iesg@ietf.org>
TLDs: Any
IPR Disclosure: None
Status: Active
Notes: None
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
The mapping described in this document does not provide any security
services beyond those described by EPP [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>] and protocol layers
used by EPP. The security considerations described in these other
specifications apply to this specification as well.
<span class="grey">Gould & Feher Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
The mapping acts as a conduit for the passing of Allocation Tokens
between a client and a server. The definition of the Allocation
Token SHOULD be defined outside of this mapping. The following are
security considerations in the definition and use of an Allocation
Token:
1. An Allocation Token should be considered secret information by
the client; it SHOULD be protected at rest and MUST be protected
in transit.
2. An Allocation Token should be single use, meaning it should be
unique per object and per allocation operation.
3. An Allocation Token should have a limited life with some form of
expiry in the Allocation Token, if generated by a trusted third
party, or with a server-side expiry, if generated by the server.
4. An Allocation Token should use a strong random value if it is
based on an unsigned code.
5. An Allocation Token should leverage digital signatures to confirm
its authenticity if generated by a trusted third party.
6. An Allocation Token that is signed XML should be encoded (e.g.,
base64 [<a href="./rfc4648" title=""The Base16, Base32, and Base64 Data Encodings"">RFC4648</a>]) to mitigate server validation issues.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
DOI 10.17487/RFC3688, January 2004,
<<a href="https://www.rfc-editor.org/info/rfc3688">https://www.rfc-editor.org/info/rfc3688</a>>.
[<a id="ref-RFC5730">RFC5730</a>] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
STD 69, <a href="./rfc5730">RFC 5730</a>, DOI 10.17487/RFC5730, August 2009,
<<a href="https://www.rfc-editor.org/info/rfc5730">https://www.rfc-editor.org/info/rfc5730</a>>.
[<a id="ref-RFC5731">RFC5731</a>] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Domain Name Mapping", STD 69, <a href="./rfc5731">RFC 5731</a>,
DOI 10.17487/RFC5731, August 2009,
<<a href="https://www.rfc-editor.org/info/rfc5731">https://www.rfc-editor.org/info/rfc5731</a>>.
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a>
<a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174,
May 2017, <<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>.
<span class="grey">Gould & Feher Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8495">RFC 8495</a> Allocation Token November 2018</span>
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
[<a id="ref-RFC4648">RFC4648</a>] Josefsson, S., "The Base16, Base32, and Base64 Data
Encodings", <a href="./rfc4648">RFC 4648</a>, DOI 10.17487/RFC4648, October 2006,
<<a href="https://www.rfc-editor.org/info/rfc4648">https://www.rfc-editor.org/info/rfc4648</a>>.
[<a id="ref-RFC7451">RFC7451</a>] Hollenbeck, S., "Extension Registry for the Extensible
Provisioning Protocol", <a href="./rfc7451">RFC 7451</a>, DOI 10.17487/RFC7451,
February 2015, <<a href="https://www.rfc-editor.org/info/rfc7451">https://www.rfc-editor.org/info/rfc7451</a>>.
Acknowledgements
The authors wish to acknowledge the original concept for this
document and the efforts in the initial draft versions of this
document by Trung Tran and Sharon Wodjenski.
Special suggestions that have been incorporated into this document
were provided by Ben Campbell, Scott Hollenbeck, Benjamin Kaduk,
Mirja Kuehlewind, Rubens Kuhl, Alexander Mayrhofer, Patrick Mevzek,
Eric Rescoria, and Adam Roach.
Authors' Addresses
James Gould
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: jgould@verisign.com
URI: <a href="http://www.verisign.com">http://www.verisign.com</a>
Kal Feher
Neustar
lvl 8/10 Queens Road
Melbourne, VIC 3004
Australia
Email: ietf@feherfamily.org
URI: <a href="http://www.neustar.biz">http://www.neustar.biz</a>
Gould & Feher Standards Track [Page 17]
</pre>
|
