idnits 2.17.1 draft-fossati-svg-test-03.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 : ---------------------------------------------------------------------------- == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (13 March 2020) is 1503 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- No issues found here. Summary: 0 errors (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 None T. Fossati 3 Internet-Draft 13 March 2020 4 Intended status: Informational 5 Expires: 14 September 2020 7 SVG Fun with kramdown-rfc2629 8 draft-fossati-svg-test-03 10 Abstract 12 This memo is for experimenting with SVG in the context of RFC 13 production. 15 Status of This Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at https://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 This Internet-Draft will expire on 14 September 2020. 32 Copyright Notice 34 Copyright (c) 2020 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 39 license-info) in effect on the date of publication of this document. 40 Please review these documents carefully, as they describe your rights 41 and restrictions with respect to this document. Code Components 42 extracted from this document must include Simplified BSD License text 43 as described in Section 4.e of the Trust Legal Provisions and are 44 provided without warranty as described in the Simplified BSD License. 46 Table of Contents 48 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 49 1.1. Conventions used in this document . . . . . . . . . . . . 2 50 1.2. Tools . . . . . . . . . . . . . . . . . . . . . . . . . . 2 51 2. Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 52 3. Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3 54 4.1. Hello World . . . . . . . . . . . . . . . . . . . . . . . 3 55 4.2. An Inlined Sequence Diagram . . . . . . . . . . . . . . . 3 56 4.3. A Sourced "Box and Arrows" Diagram . . . . . . . . . . . 5 57 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 58 6. Security Considerations . . . . . . . . . . . . . . . . . . . 5 59 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 5 60 8. Normative References . . . . . . . . . . . . . . . . . . . . 5 61 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 63 1. Introduction 65 This memo is for experimenting with SVG in the context of RFC 66 production. 68 This document assumes a kramdown-rfc2629 based editing flow. 70 1.1. Conventions used in this document 72 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 73 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 74 "OPTIONAL" in this document are to be interpreted as described in 75 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 76 capitals, as shown here. 78 1.2. Tools 80 Install goat and svgcheck (Go and Python are obvious prerequisites): 82 $ go get github.com/blampe/goat 83 $ pip install svgcheck 85 Install kramdown-rfc2629 (at least 1.3.2): 87 $ gem install kramdown-rfc2629 -v '>= 1.3.2' 89 2. Draw 91 Two options: 93 * Either inline your ASCII / UTF-8 art: 95 ~~~ goat 96 .-. 97 |o o| 98 C| | |D 99 | - | 100 '___' 101 ~~~ 103 * Or source it from an external file: 105 ~~~ goat 106 {::include my-diagram.txt} 107 ~~~ 108 {: #dia-1 title="My Diagram"} 110 3. Build 112 To go from markdown to XML, HTML and TXT: 114 $ kdrfc -3h draft-fossati-svg-test.md 116 Before submitting to the datatracker the XML file needs to be 117 "prepped": 119 $ xml2rfc --preptool --v3 draft-fossati-svg-test.xml 121 The "prepped" file, draft-fossati-svg-test.prepped.xml in this case, 122 is what needs to be uploaded to the datatracker. 124 4. Examples 126 4.1. Hello World 128 / / 129 (\/_//`) 130 .---. / '/ 131 | | 0 0 \ 132 | Yo! | / \ 133 | | / __/ \ 134 '----. /, _/ \ \ 135 \_. `-./ ) | \ 136 ( | \ 138 4.2. An Inlined Sequence Diagram 139 .------. .---------------. .------. 140 | NDC | | IdO | | CA | 141 +--------+ +--------+--------+ +--------+ 142 | Client | | Server | Client | | Server | 143 '---+----' '----+---+---+----' '----+---' 144 | | | | 145 | Order | | | 146 | Signature | | | 147 o------------------->| | | 148 | | | | 149 | [ No identity ] | | | 150 | [ validation ] | | | 151 | | | | 152 | CSR | | | 153 | Signature | | | 154 o------------------->| | | 155 | Acknowledgement | | Order' | 156 |<-------------------o | Signature | 157 | | o------------------->| 158 | | | Required | 159 | | | Authorizations | 160 | | |<-------------------o 161 | | | Responses | 162 | | | Signature | 163 | | o------------------->| 164 | | | | 165 | | |<~~~~Validation~~~~>| 166 | | | | 167 | | | CSR | 168 | | | Signature | 169 | | o------------------->| 170 | | | Acknowledgement | 171 | | |<-------------------o 172 | | | | 173 |<~~Await issuance~->| |<~~Await issuance~~>| 174 | | 175 | (unauthenticated) GET STAR certificate | 176 o------------------------------------------------>| 177 | Certificate #1 | 178 |<------------------------------------------------o 179 | (unauthenticated) GET STAR certificate | 180 o------------------------------------------------>| 181 | Certificate #2 | 182 |<------------------------------------------------o 183 | [...] | 184 | (unauthenticated) GET STAR certificate | 185 o------------------------------------------------>| 186 | Certificate #n | 187 |<------------------------------------------------o 189 4.3. A Sourced "Box and Arrows" Diagram 191 .-------------------. 192 | .------.------. | 193 | | STAR | STAR |<--------------. 194 .-->| SP1 | dele | dele | | | 195 | | | srv | cli +-----. | 196 | | '----+-'------' | | 4 197 | '------^--|---------' 3 | 198 | | | | .----|-----. 199 | | 5 | | .---+--. | 200 | | | '--->| ACME | | 201 | | | | | STAR | C | 202 1 | | | +------| A | 203 | | | .--->| HTTP | | 204 | 2 | | | '---+--' | 205 | | | | '----|-----' 206 | .------|--v---------. 6 | 207 | | .-+----.------. | | 7 208 | | | STAR | +-----' | 209 '-->| SP2 | dele | HTTP | | | 210 | | cli | |<--------------' 211 | '----+-'-+----' | 212 '-------------------' 214 Figure 1: STIR Delegation Flow 216 5. IANA Considerations 218 No requests are made to IANA. 220 6. Security Considerations 222 There are none. 224 7. Acknowledgments 226 Yaron for pointing out the current limitations in the tooling and 227 providing the workaround. Carsten for working the kramdown magic. 229 8. Normative References 231 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 232 Requirement Levels", BCP 14, RFC 2119, 233 DOI 10.17487/RFC2119, March 1997, 234 . 236 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 237 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 238 May 2017, . 240 Author's Address 242 Thomas Fossati 244 Email: thomas.fossati@arm.com