idnits 2.17.1 draft-asciirfc-minimal-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (March 23, 2018) is 2223 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Outdated reference: A later version (-08) exists of draft-ribose-asciirfc-04 == Outdated reference: A later version (-10) exists of draft-ribose-cfrg-sm4-08 Summary: 0 errors (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group J. Carberry 3 Internet-Draft T. Grayson 4 Intended status: Informational Brown University 5 Expires: September 24, 2018 March 23, 2018 7 A Minimal Internet-Draft In AsciiRFC 8 draft-asciirfc-minimal-01 10 Abstract 12 This document provides a template on how to author (or migrate!) a 13 new Internet-Draft / RFC in AsciiRFC format. This template requires 14 usage of the "asciidoctor-rfc" Ruby gem. 16 Status of This Memo 18 This Internet-Draft is submitted in full conformance with the 19 provisions of BCP 78 and BCP 79. 21 Internet-Drafts are working documents of the Internet Engineering 22 Task Force (IETF). Note that other groups may also distribute 23 working documents as Internet-Drafts. The list of current Internet- 24 Drafts is at https://datatracker.ietf.org/drafts/current/. 26 Internet-Drafts are draft documents valid for a maximum of six months 27 and may be updated, replaced, or obsoleted by other documents at any 28 time. It is inappropriate to use Internet-Drafts as reference 29 material or to cite them other than as "work in progress." 31 This Internet-Draft will expire on September 24, 2018. 33 Copyright Notice 35 Copyright (c) 2018 IETF Trust and the persons identified as the 36 document authors. All rights reserved. 38 This document is subject to BCP 78 and the IETF Trust's Legal 39 Provisions Relating to IETF Documents 40 (https://trustee.ietf.org/license-info) in effect on the date of 41 publication of this document. Please review these documents 42 carefully, as they describe your rights and restrictions with respect 43 to this document. Code Components extracted from this document must 44 include Simplified BSD License text as described in Section 4.e of 45 the Trust Legal Provisions and are provided without warranty as 46 described in the Simplified BSD License. 48 Table of Contents 50 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 51 2. Terms and Definitions . . . . . . . . . . . . . . . . . . . . 2 52 3. Symbols And Abbreviations . . . . . . . . . . . . . . . . . . 2 53 3.1. Operators . . . . . . . . . . . . . . . . . . . . . . . . 2 54 4. Security Considerations . . . . . . . . . . . . . . . . . . . 2 55 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 3 56 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 3 57 6.1. Normative References . . . . . . . . . . . . . . . . . . 3 58 6.2. Informative References . . . . . . . . . . . . . . . . . 3 59 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 3 60 A.1. Example 1 . . . . . . . . . . . . . . . . . . . . . . . . 3 61 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 4 62 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 4 64 1. Introduction 66 AsciiRFC [I-D.ribose-asciirfc] is an extremely simple way to author 67 Internet-Drafts and RFCs without needing to manually craft RFC XML 68 [RFC7991]. 70 This is a template for authors to easily start with 71 [I-D.ribose-asciirfc]. 73 2. Terms and Definitions 75 The key words "*MUST*", "*MUST NOT*", "*REQUIRED*", "*SHALL*", 76 "*SHALL NOT*", "*SHOULD*", "*SHOULD NOT*", "*RECOMMENDED*", "*NOT 77 RECOMMENDED*", "*MAY*", and "*OPTIONAL*" in this document are to be 78 interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only 79 when, they appear in all capitals, as shown here. 81 3. Symbols And Abbreviations 83 3.1. Operators 85 AsciiRFC 86 As defined in [I-D.ribose-asciirfc]. 88 4. Security Considerations 90 o Please beware of implementation issues caused by Section 3.1. 92 o Here's how you include references [I-D.ribose-cfrg-sm4], 93 [RFC7253], [RNP]. 95 5. IANA Considerations 97 This document does not require any action by IANA. 99 6. References 101 6.1. Normative References 103 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 104 Requirement Levels", BCP 14, RFC 2119, 105 DOI 10.17487/RFC2119, March 1997, 106 . 108 [RFC7991] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary", 109 RFC 7991, DOI 10.17487/RFC7991, December 2016, 110 . 112 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 113 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 114 May 2017, . 116 6.2. Informative References 118 [I-D.ribose-asciirfc] 119 Tse, R., Nicholas, N., and P. Brasolin, "AsciiRFC: 120 Authoring Internet-Drafts And RFCs Using AsciiDoc", draft- 121 ribose-asciirfc-04 (work in progress), December 2017. 123 [I-D.ribose-cfrg-sm4] 124 Tse, R. and W. Wong, "The SM4 Blockcipher Algorithm And 125 Its Modes Of Operations", draft-ribose-cfrg-sm4-08 (work 126 in progress), December 2017. 128 [RFC7253] Krovetz, T. and P. Rogaway, "The OCB Authenticated- 129 Encryption Algorithm", RFC 7253, DOI 10.17487/RFC7253, May 130 2014, . 132 [RNP] Ribose Inc., "RNP: A C library approach to OpenPGP", 133 October 2017, . 135 Appendix A. Examples 137 A.1. Example 1 139 Here's an example. 141 { 142 "code": { 143 "encoding": "ascii", 144 "type": "rfc", 145 "authors": [ "Josiah Carberry", "Truman Grayson" ] 146 } 147 } 149 Appendix B. Acknowledgements 151 The authors would like to thank their families. 153 Authors' Addresses 155 Josiah Stinkney Carberry 156 Brown University 157 Box K, 69 Brown Street 158 Providence 02912 159 United States of America 161 Phone: +1 401 863 1000 162 Email: josiah.carberry@ribose.com 163 URI: https://www.brown.edu 165 Truman Grayson 166 Brown University 167 Box G, 69 Brown Street 168 Providence 02912 169 United States of America 171 Phone: +1 401 863 1000 172 Email: truman.grayson@ribose.com 173 URI: https://www.brown.edu