1
2
3
4
5
6
7Internet Engineering Task Force (IETF) J. Gould
8Request for Comments: 8056 VeriSign, Inc.
9Category: Standards Track January 2017
10ISSN: 2070-1721
11
12
13 Extensible Provisioning Protocol (EPP)
14 and Registration Data Access Protocol (RDAP) Status Mapping
15
16Abstract
17
18 This document describes the mapping of the Extensible Provisioning
19 Protocol (EPP) statuses with the statuses registered for use in the
20 Registration Data Access Protocol (RDAP). This document identifies
21 gaps in the mapping, and registers RDAP statuses to fill those gaps
22 to ensure that all of the EPP statuses specified in RFCs are
23 supported in RDAP.
24
25Status of This Memo
26
27 This is an Internet Standards Track document.
28
29 This document is a product of the Internet Engineering Task Force
30 (IETF). It represents the consensus of the IETF community. It has
31 received public review and has been approved for publication by the
32 Internet Engineering Steering Group (IESG). Further information on
33 Internet Standards is available in Section 2 of RFC 7841.
34
35 Information about the current status of this document, any errata,
36 and how to provide feedback on it may be obtained at
37 http://www.rfc-editor.org/info/rfc8056.
38
39Copyright Notice
40
41 Copyright (c) 2017 IETF Trust and the persons identified as the
42 document authors. All rights reserved.
43
44 This document is subject to BCP 78 and the IETF Trust's Legal
45 Provisions Relating to IETF Documents
46 (http://trustee.ietf.org/license-info) in effect on the date of
47 publication of this document. Please review these documents
48 carefully, as they describe your rights and restrictions with respect
49 to this document. Code Components extracted from this document must
50 include Simplified BSD License text as described in Section 4.e of
51 the Trust Legal Provisions and are provided without warranty as
52 described in the Simplified BSD License.
53
54
55
56
57
58Gould Standards Track [Page 1]
59
60RFC 8056 EPP RDAP Status Mapping January 2017
61
62
63Table of Contents
64
65 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
66 1.1. Conventions Used in This Document . . . . . . . . . . . . 2
67 2. EPP-to-RDAP Status Mapping . . . . . . . . . . . . . . . . . 2
68 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
69 3.1. JSON Values Registry . . . . . . . . . . . . . . . . . . 6
70 4. Security Considerations . . . . . . . . . . . . . . . . . . . 10
71 5. Normative References . . . . . . . . . . . . . . . . . . . . 10
72 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 11
73 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 11
74
751. Introduction
76
77 This document maps the statuses defined in the Extensible
78 Provisioning Protocol (EPP) RFCs to the list of statuses registered
79 for use in the Registration Data Access Protocol (RDAP), in the "RDAP
80 JSON Values" registry [rdap-json-values].
81
82 The "RDAP JSON Values" registry is described in Section 10.2 of
83 [RFC7483] and is available in the "RDAP JSON Values" registry
84 [rdap-json-values].
85
86 The EPP statuses used as the source of the mapping include
87 Section 2.3 of the Extensible Provisioning Protocol (EPP) Domain Name
88 Mapping [RFC5731], Section 2.3 of "Extensible Provisioning Protocol
89 (EPP) Host Mapping" [RFC5732], Section 2.2 of "Extensible
90 Provisioning Protocol (EPP) Contact Mapping" [RFC5733], and
91 Section 3.1 of "Domain Registry Grace Period Mapping for the
92 Extensible Provisioning Protocol (EPP)" [RFC3915].
93
94 Each EPP status MUST map to a single RDAP status to ensure that data
95 in the Domain Name Registries (DNRs) that use EPP can be accurately
96 presented in RDAP.
97
981.1. Conventions Used in This Document
99
100 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
101 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
102 document are to be interpreted as described in RFC 2119 [RFC2119].
103
1042. EPP-to-RDAP Status Mapping
105
106 Below is a list of EPP statuses from the EPP RFCs ([RFC5731],
107 [RFC5732], [RFC5733], and [RFC3915]) mapped to the RDAP statuses
108 registered in the "RDAP JSON Values" registry [rdap-json-values],
109 with the format <EPP Status> '=' <RDAP Status>, where a blank <RDAP
110 Status> indicates a gap in the mapping.
111
112
113
114Gould Standards Track [Page 2]
115
116RFC 8056 EPP RDAP Status Mapping January 2017
117
118
119 addPeriod =
120 autoRenewPeriod =
121 clientDeleteProhibited =
122 clientHold =
123 clientRenewProhibited =
124 clientTransferProhibited =
125 clientUpdateProhibited =
126 inactive = inactive
127 linked = associated
128 ok = active
129 pendingCreate = pending create
130 pendingDelete = pending delete
131 pendingRenew = pending renew
132 pendingRestore =
133 pendingTransfer = pending transfer
134 pendingUpdate = pending update
135 redemptionPeriod =
136 renewPeriod =
137 serverDeleteProhibited =
138 serverRenewProhibited =
139 serverTransferProhibited =
140 serverUpdateProhibited =
141 serverHold =
142 transferPeriod =
143
144 The "RDAP JSON Values" registry [rdap-json-values] does have a set of
145 prohibited statuses including "renew prohibited", "update
146 prohibited", "transfer prohibited", and "delete prohibited", but
147 these statuses do not directly map to the EPP prohibited statuses.
148 EPP provides status codes that allow distinguishing the case that an
149 action is prohibited because of server policy from the case that an
150 action is prohibited because of a client request. The ability to
151 make this distinction needs to be preserved in RDAP.
152
153 Each of the EPP status values that don't map directly to an RDAP
154 status value is described below. Each EPP status value includes a
155 proposed new RDAP status value and a description of the value. The
156 RDAP status value is derived from the EPP status value by converting
157 the EPP "camelCase" representation to lowercase with a space
158 character inserted between word boundaries.
159
160 addPeriod = add period; This grace period is provided after the
161 initial registration of the object. If the object is deleted by
162 the client during this period, the server provides a credit to
163 the client for the cost of the registration.
164
165
166
167
168
169
170Gould Standards Track [Page 3]
171
172RFC 8056 EPP RDAP Status Mapping January 2017
173
174
175 autoRenewPeriod = auto renew period; This grace period is provided
176 after an object registration period expires and is extended
177 (renewed) automatically by the server. If the object is deleted
178 by the client during this period, the server provides a credit to
179 the client for the cost of the auto renewal.
180
181 clientDeleteProhibited = client delete prohibited; The client
182 requested that requests to delete the object MUST be rejected.
183
184 clientHold = client hold; The client requested that the DNS
185 delegation information MUST NOT be published for the object.
186
187 clientRenewProhibited = client renew prohibited; The client
188 requested that requests to renew the object MUST be rejected.
189
190 clientTransferProhibited = client transfer prohibited; The client
191 requested that requests to transfer the object MUST be rejected.
192
193 clientUpdateProhibited = client update prohibited; The client
194 requested that requests to update the object (other than to
195 remove this status) MUST be rejected.
196
197 pendingRestore = pending restore; An object is in the process of
198 being restored after being in the redemption period state.
199
200 redemptionPeriod = redemption period; A delete has been received,
201 but the object has not yet been purged because an opportunity
202 exists to restore the object and abort the deletion process.
203
204 renewPeriod = renew period; This grace period is provided after an
205 object registration period is explicitly extended (renewed) by
206 the client. If the object is deleted by the client during this
207 period, the server provides a credit to the client for the cost
208 of the renewal.
209
210 serverDeleteProhibited = server delete prohibited; The server set
211 the status so that requests to delete the object MUST be
212 rejected.
213
214 serverRenewProhibited = server renew prohibited; The server set the
215 status so that requests to renew the object MUST be rejected.
216
217 serverTransferProhibited = server transfer prohibited; The server
218 set the status so that requests to transfer the object MUST be
219 rejected.
220
221
222
223
224
225
226Gould Standards Track [Page 4]
227
228RFC 8056 EPP RDAP Status Mapping January 2017
229
230
231 serverUpdateProhibited = server update prohibited; The server set
232 the status so that requests to update the object (other than to
233 remove this status) MUST be rejected.
234 serverHold = server hold; The server set the status so that DNS
235 delegation information MUST NOT be published for the object.
236
237 transferPeriod = transfer period; This grace period is provided
238 after the successful transfer of object registration sponsorship
239 from one client to another client. If the object is deleted by
240 the client during this period, the server provides a credit to
241 the client for the cost of the transfer.
242
243 The resulting mapping after registering the new RDAP statuses is:
244
245 addPeriod = add period
246 autoRenewPeriod = auto renew period
247 clientDeleteProhibited = client delete prohibited
248 clientHold = client hold
249 clientRenewProhibited = client renew prohibited
250 clientTransferProhibited = client transfer prohibited
251 clientUpdateProhibited = client update prohibited
252 inactive = inactive
253 linked = associated
254 ok = active
255 pendingCreate = pending create
256 pendingDelete = pending delete
257 pendingRenew = pending renew
258 pendingRestore = pending restore
259 pendingTransfer = pending transfer
260 pendingUpdate = pending update
261 redemptionPeriod = redemption period
262 renewPeriod = renew period
263 serverDeleteProhibited = server delete prohibited
264 serverRenewProhibited = server renew prohibited
265 serverTransferProhibited = server transfer prohibited
266 serverUpdateProhibited = server update prohibited
267 serverHold = server hold
268 transferPeriod = transfer period
269
270
271
272
273
274
275
276
277
278
279
280
281
282Gould Standards Track [Page 5]
283
284RFC 8056 EPP RDAP Status Mapping January 2017
285
286
2873. IANA Considerations
288
2893.1. JSON Values Registry
290
291 The following values have been registered by the IANA in the "RDAP
292 JSON Values" registry described in [RFC7483]:
293
294 Value: add period
295 Type: status
296 Description: This grace period is provided after the initial
297 registration of the object. If the object is deleted by the
298 client during this period, the server provides a credit to the
299 client for the cost of the registration. This maps to the Domain
300 Registry Grace Period Mapping for the Extensible Provisioning
301 Protocol (EPP) [RFC3915] 'addPeriod' status.
302 Registrant Name: IESG
303 Registrant Contact Information: iesg@ietf.org
304
305 Value: auto renew period
306 Type: status
307 Description: This grace period is provided after an object
308 registration period expires and is extended (renewed)
309 automatically by the server. If the object is deleted by the
310 client during this period, the server provides a credit to the
311 client for the cost of the auto renewal. This maps to the Domain
312 Registry Grace Period Mapping for the Extensible Provisioning
313 Protocol (EPP) [RFC3915] 'autoRenewPeriod' status.
314 Registrant Name: IESG
315 Registrant Contact Information: iesg@ietf.org
316
317 Value: client delete prohibited
318 Type: status
319 Description: The client requested that requests to delete the
320 object MUST be rejected. This maps to the Extensible Provisioning
321 Protocol (EPP) Domain Name Mapping [RFC5731], Extensible
322 Provisioning Protocol (EPP) Host Mapping [RFC5732], and Extensible
323 Provisioning Protocol (EPP) Contact Mapping [RFC5733]
324 'clientDeleteProhibited' status.
325 Registrant Name: IESG
326 Registrant Contact Information: iesg@ietf.org
327
328
329
330
331
332
333
334
335
336
337
338Gould Standards Track [Page 6]
339
340RFC 8056 EPP RDAP Status Mapping January 2017
341
342
343 Value: client hold
344 Type: status
345 Description: The client requested that the DNS delegation
346 information MUST NOT be published for the object. This maps to
347 the Extensible Provisioning Protocol (EPP) Domain Name Mapping
348 [RFC5731] 'clientHold' status.
349 Registrant Name: IESG
350 Registrant Contact Information: iesg@ietf.org
351
352 Value: client renew prohibited
353 Type: status
354 Description: The client requested that requests to renew the
355 object MUST be rejected. This maps to the Extensible Provisioning
356 Protocol (EPP) Domain Name Mapping [RFC5731]
357 'clientRenewProhibited' status.
358 Registrant Name: IESG
359 Registrant Contact Information: iesg@ietf.org
360
361 Value: client transfer prohibited
362 Type: status
363 Description: The client requested that requests to transfer the
364 object MUST be rejected. This maps to the Extensible Provisioning
365 Protocol (EPP) Domain Name Mapping [RFC5731] and Extensible
366 Provisioning Protocol (EPP) Contact Mapping [RFC5733]
367 'clientTransferProhibited' status.
368 Registrant Name: IESG
369 Registrant Contact Information: iesg@ietf.org
370
371 Value: client update prohibited
372 Type: status
373 Description: The client requested that requests to update the
374 object (other than to remove this status) MUST be rejected. This
375 maps to the Extensible Provisioning Protocol (EPP) Domain Name
376 Mapping [RFC5731], Extensible Provisioning Protocol (EPP) Host
377 Mapping [RFC5732], and Extensible Provisioning Protocol (EPP)
378 Contact Mapping [RFC5733] 'clientUpdateProhibited' status.
379 Registrant Name: IESG
380 Registrant Contact Information: iesg@ietf.org
381
382 Value: pending restore
383 Type: status
384 Description: An object is in the process of being restored after
385 being in the redemption period state. This maps to the Domain
386 Registry Grace Period Mapping for the Extensible Provisioning
387 Protocol (EPP) [RFC3915] 'pendingRestore' status.
388 Registrant Name: IESG
389 Registrant Contact Information: iesg@ietf.org
390
391
392
393
394Gould Standards Track [Page 7]
395
396RFC 8056 EPP RDAP Status Mapping January 2017
397
398
399 Value: redemption period
400 Type: status
401 Description: A delete has been received, but the object has not
402 yet been purged because an opportunity exists to restore the
403 object and abort the deletion process. This maps to the Domain
404 Registry Grace Period Mapping for the Extensible Provisioning
405 Protocol (EPP) [RFC3915] 'redemptionPeriod' status.
406 Registrant Name: IESG
407 Registrant Contact Information: iesg@ietf.org
408
409 Value: renew period
410 Type: status
411 Description: This grace period is provided after an object
412 registration period is explicitly extended (renewed) by the
413 client. If the object is deleted by the client during this
414 period, the server provides a credit to the client for the cost of
415 the renewal. This maps to the Domain Registry Grace Period
416 Mapping for the Extensible Provisioning Protocol (EPP) [RFC3915]
417 'renewPeriod' status.
418 Registrant Name: IESG
419 Registrant Contact Information: iesg@ietf.org
420
421 Value: server delete prohibited
422 Type: status
423 Description: The server set the status so that requests to delete
424 the object MUST be rejected. This maps to the Extensible
425 Provisioning Protocol (EPP) Domain Name Mapping [RFC5731],
426 Extensible Provisioning Protocol (EPP) Host Mapping [RFC5732], and
427 Extensible Provisioning Protocol (EPP) Contact Mapping [RFC5733]
428 'serverDeleteProhibited' status.
429 Registrant Name: IESG
430 Registrant Contact Information: iesg@ietf.org
431
432 Value: server renew prohibited
433 Type: status
434 Description: The server set the status so that requests to renew
435 the object MUST be rejected. This maps to the Extensible
436 Provisioning Protocol (EPP) Domain Name Mapping [RFC5731]
437 'serverRenewProhibited' status.
438 Registrant Name: IESG
439 Registrant Contact Information: iesg@ietf.org
440
441
442
443
444
445
446
447
448
449
450Gould Standards Track [Page 8]
451
452RFC 8056 EPP RDAP Status Mapping January 2017
453
454
455 Value: server transfer prohibited
456 Type: status
457 Description: The server set the status so that requests to
458 transfer the object MUST be rejected. This maps to the Extensible
459 Provisioning Protocol (EPP) Domain Name Mapping [RFC5731] and
460 Extensible Provisioning Protocol (EPP) Contact Mapping [RFC5733]
461 'serverTransferProhibited' status.
462 Registrant Name: IESG
463 Registrant Contact Information: iesg@ietf.org
464
465 Value: server update prohibited
466 Type: status
467 Description: The server set the status so that requests to update
468 the object (other than to remove this status) MUST be rejected.
469 This maps to the Extensible Provisioning Protocol (EPP) Domain
470 Name Mapping [RFC5731], Extensible Provisioning Protocol (EPP)
471 Host Mapping [RFC5732], and Extensible Provisioning Protocol (EPP)
472 Contact Mapping [RFC5733] 'serverUpdateProhibited' status.
473 Registrant Name: IESG
474 Registrant Contact Information: iesg@ietf.org
475
476 Value: server hold
477 Type: status
478 Description: The server set the status so that DNS delegation
479 information MUST NOT be published for the object. This maps to
480 the Extensible Provisioning Protocol (EPP) Domain Name Mapping
481 [RFC5731] 'serverHold' status.
482 Registrant Name: IESG
483 Registrant Contact Information: iesg@ietf.org
484
485 Value: transfer period
486 Type: status
487 Description: This grace period is provided after the successful
488 transfer of object registration sponsorship from one client to
489 another client. If the object is deleted by the client during
490 this period, the server provides a credit to the client for the
491 cost of the transfer. This maps to the Domain Registry Grace
492 Period Mapping for the Extensible Provisioning Protocol (EPP)
493 [RFC3915] 'transferPeriod' status.
494 Registrant Name: IESG
495 Registrant Contact Information: iesg@ietf.org
496
497
498
499
500
501
502
503
504
505
506Gould Standards Track [Page 9]
507
508RFC 8056 EPP RDAP Status Mapping January 2017
509
510
5114. Security Considerations
512
513 The status values described in this document can be subject to
514 server-side information disclosure policies that restrict display of
515 the values to authorized clients. Implementers may wish to review
516 [RFC7481] for a description of the RDAP security services that can be
517 used to implement information disclosure policies.
518
5195. Normative References
520
521 [rdap-json-values]
522 IANA, "RDAP JSON Values",
523 <https://www.iana.org/assignments/rdap-json-values/>.
524
525 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
526 Requirement Levels", BCP 14, RFC 2119,
527 DOI 10.17487/RFC2119, March 1997,
528 <http://www.rfc-editor.org/info/rfc2119>.
529
530 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for
531 the Extensible Provisioning Protocol (EPP)", RFC 3915,
532 DOI 10.17487/RFC3915, September 2004,
533 <http://www.rfc-editor.org/info/rfc3915>.
534
535 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
536 Domain Name Mapping", STD 69, RFC 5731,
537 DOI 10.17487/RFC5731, August 2009,
538 <http://www.rfc-editor.org/info/rfc5731>.
539
540 [RFC5732] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
541 Host Mapping", STD 69, RFC 5732, DOI 10.17487/RFC5732,
542 August 2009, <http://www.rfc-editor.org/info/rfc5732>.
543
544 [RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
545 Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733,
546 August 2009, <http://www.rfc-editor.org/info/rfc5733>.
547
548 [RFC7481] Hollenbeck, S. and N. Kong, "Security Services for the
549 Registration Data Access Protocol (RDAP)", RFC 7481,
550 DOI 10.17487/RFC7481, March 2015,
551 <http://www.rfc-editor.org/info/rfc7481>.
552
553 [RFC7483] Newton, A. and S. Hollenbeck, "JSON Responses for the
554 Registration Data Access Protocol (RDAP)", RFC 7483,
555 DOI 10.17487/RFC7483, March 2015,
556 <http://www.rfc-editor.org/info/rfc7483>.
557
558
559
560
561
562Gould Standards Track [Page 10]
563
564RFC 8056 EPP RDAP Status Mapping January 2017
565
566
567Acknowledgements
568
569 Suggestions that have been incorporated into this document were
570 provided by Andrew Newton, Scott Hollenbeck, Jim Galvin, Gustavo
571 Lozano, and Robert Sparks.
572
573Author's Address
574
575 James Gould
576 VeriSign, Inc.
577 12061 Bluemont Way
578 Reston, VA 20190
579 United States of America
580
581 Email: jgould@verisign.com
582 URI: http://www.verisign.com
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
618Gould Standards Track [Page 11]
619
620