asciidoctor-rfc 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +5 -0
  3. data/.oss-guides.rubocop.yml +1077 -0
  4. data/.rspec +1 -0
  5. data/.rubocop.yml +19 -1063
  6. data/.travis.yml +3 -2
  7. data/Guardfile +22 -0
  8. data/README.adoc +1151 -0
  9. data/Rakefile +1 -1
  10. data/asciidoctor-rfc.gemspec +20 -3
  11. data/bin/asciidoctor-rfc2 +15 -0
  12. data/bin/asciidoctor-rfc3 +15 -0
  13. data/bin/rspec +0 -1
  14. data/lib/asciidoctor-rfc.rb +4 -0
  15. data/lib/asciidoctor/rfc/common/base.rb +218 -0
  16. data/lib/asciidoctor/rfc/common/front.rb +120 -0
  17. data/lib/asciidoctor/rfc/v2/base.rb +341 -0
  18. data/lib/asciidoctor/rfc/v2/blocks.rb +192 -0
  19. data/lib/asciidoctor/rfc/v2/converter.rb +64 -0
  20. data/lib/asciidoctor/rfc/v2/front.rb +69 -0
  21. data/lib/asciidoctor/rfc/v2/inline_anchor.rb +102 -0
  22. data/lib/asciidoctor/rfc/v2/lists.rb +134 -0
  23. data/lib/asciidoctor/rfc/v2/table.rb +112 -0
  24. data/lib/asciidoctor/rfc/v2/validate.rb +738 -0
  25. data/lib/asciidoctor/rfc/v2/validate2.rng +716 -0
  26. data/lib/asciidoctor/rfc/v3/base.rb +358 -0
  27. data/lib/asciidoctor/rfc/v3/blocks.rb +203 -0
  28. data/lib/asciidoctor/rfc/v3/converter.rb +64 -0
  29. data/lib/asciidoctor/rfc/v3/front.rb +115 -0
  30. data/lib/asciidoctor/rfc/v3/inline_anchor.rb +90 -0
  31. data/lib/asciidoctor/rfc/v3/lists.rb +190 -0
  32. data/lib/asciidoctor/rfc/v3/svg.rng +9081 -0
  33. data/lib/asciidoctor/rfc/v3/table.rb +65 -0
  34. data/lib/asciidoctor/rfc/v3/validate.rb +2168 -0
  35. data/lib/asciidoctor/rfc/v3/validate.rng +2143 -0
  36. data/lib/asciidoctor/rfc/version.rb +2 -2
  37. data/spec/asciidoctor/rfc/v2/appendix_spec.rb +124 -0
  38. data/spec/asciidoctor/rfc/v2/area_spec.rb +60 -0
  39. data/spec/asciidoctor/rfc/v2/author_spec.rb +444 -0
  40. data/spec/asciidoctor/rfc/v2/comments_spec.rb +316 -0
  41. data/spec/asciidoctor/rfc/v2/crossref_spec.rb +205 -0
  42. data/spec/asciidoctor/rfc/v2/date_spec.rb +166 -0
  43. data/spec/asciidoctor/rfc/v2/dlist_spec.rb +108 -0
  44. data/spec/asciidoctor/rfc/v2/document_spec.rb +161 -0
  45. data/spec/asciidoctor/rfc/v2/example_spec.rb +50 -0
  46. data/spec/asciidoctor/rfc/v2/front_spec.rb +75 -0
  47. data/spec/asciidoctor/rfc/v2/image_spec.rb +81 -0
  48. data/spec/asciidoctor/rfc/v2/indexterm_spec.rb +66 -0
  49. data/spec/asciidoctor/rfc/v2/inline_formatting_spec.rb +177 -0
  50. data/spec/asciidoctor/rfc/v2/keyword_spec.rb +63 -0
  51. data/spec/asciidoctor/rfc/v2/listing_spec.rb +59 -0
  52. data/spec/asciidoctor/rfc/v2/literal_spec.rb +53 -0
  53. data/spec/asciidoctor/rfc/v2/olist_spec.rb +147 -0
  54. data/spec/asciidoctor/rfc/v2/paragraph_spec.rb +68 -0
  55. data/spec/asciidoctor/rfc/v2/preamble_spec.rb +140 -0
  56. data/spec/asciidoctor/rfc/v2/quote_spec.rb +24 -0
  57. data/spec/asciidoctor/rfc/v2/references_spec.rb +96 -0
  58. data/spec/asciidoctor/rfc/v2/section_spec.rb +260 -0
  59. data/spec/asciidoctor/rfc/v2/sidebar_spec.rb +32 -0
  60. data/spec/asciidoctor/rfc/v2/table_spec.rb +293 -0
  61. data/spec/asciidoctor/rfc/v2/ulist_spec.rb +96 -0
  62. data/spec/asciidoctor/rfc/v2/workgroup_spec.rb +60 -0
  63. data/spec/asciidoctor/rfc/v3/appendix_spec.rb +130 -0
  64. data/spec/asciidoctor/rfc/v3/area_spec.rb +63 -0
  65. data/spec/asciidoctor/rfc/v3/author_spec.rb +540 -0
  66. data/spec/asciidoctor/rfc/v3/comments_spec.rb +308 -0
  67. data/spec/asciidoctor/rfc/v3/crossref_spec.rb +269 -0
  68. data/spec/asciidoctor/rfc/v3/date_spec.rb +149 -0
  69. data/spec/asciidoctor/rfc/v3/dlist_spec.rb +121 -0
  70. data/spec/asciidoctor/rfc/v3/document_spec.rb +109 -0
  71. data/spec/asciidoctor/rfc/v3/example_spec.rb +34 -0
  72. data/spec/asciidoctor/rfc/v3/front_spec.rb +43 -0
  73. data/spec/asciidoctor/rfc/v3/image_spec.rb +81 -0
  74. data/spec/asciidoctor/rfc/v3/indexterm_spec.rb +69 -0
  75. data/spec/asciidoctor/rfc/v3/inline_formatting_spec.rb +319 -0
  76. data/spec/asciidoctor/rfc/v3/keyword_spec.rb +33 -0
  77. data/spec/asciidoctor/rfc/v3/link_spec.rb +34 -0
  78. data/spec/asciidoctor/rfc/v3/listing_spec.rb +59 -0
  79. data/spec/asciidoctor/rfc/v3/literal_spec.rb +51 -0
  80. data/spec/asciidoctor/rfc/v3/olist_spec.rb +168 -0
  81. data/spec/asciidoctor/rfc/v3/paragraph_spec.rb +73 -0
  82. data/spec/asciidoctor/rfc/v3/preamble_spec.rb +112 -0
  83. data/spec/asciidoctor/rfc/v3/quote_spec.rb +91 -0
  84. data/spec/asciidoctor/rfc/v3/references_spec.rb +147 -0
  85. data/spec/asciidoctor/rfc/v3/section_spec.rb +198 -0
  86. data/spec/asciidoctor/rfc/v3/series_info_spec.rb +151 -0
  87. data/spec/asciidoctor/rfc/v3/sidebar_spec.rb +30 -0
  88. data/spec/asciidoctor/rfc/v3/table_spec.rb +275 -0
  89. data/spec/asciidoctor/rfc/v3/ulist_spec.rb +74 -0
  90. data/spec/asciidoctor/rfc/v3/workgroup_spec.rb +33 -0
  91. data/spec/examples/davies-template-bare-06.adoc +361 -0
  92. data/spec/examples/davies-template-bare-06.xml.orig +426 -0
  93. data/spec/examples/example-v2.adoc +181 -0
  94. data/spec/examples/example-v2.xml +675 -0
  95. data/spec/examples/example-v3.adoc +185 -0
  96. data/spec/examples/example-v3.xml +1009 -0
  97. data/spec/examples/mib-doc-template-xml-06.adoc +596 -0
  98. data/spec/examples/mib-doc-template-xml-06.xml.orig +654 -0
  99. data/spec/examples/rfc1149.md +76 -0
  100. data/spec/examples/rfc1149.md.2.xml +94 -0
  101. data/spec/examples/rfc1149.md.3.xml +93 -0
  102. data/spec/examples/rfc1149.md.adoc +65 -0
  103. data/spec/examples/rfc2100.md +149 -0
  104. data/spec/examples/rfc2100.md.2.xml +169 -0
  105. data/spec/examples/rfc2100.md.3.xml +163 -0
  106. data/spec/examples/rfc2100.md.adoc +136 -0
  107. data/spec/examples/rfc3514.md +203 -0
  108. data/spec/examples/rfc3514.md.2.xml +238 -0
  109. data/spec/examples/rfc3514.md.3.xml +258 -0
  110. data/spec/examples/rfc3514.md.adoc +324 -0
  111. data/spec/examples/rfc5841.md +342 -0
  112. data/spec/examples/rfc5841.md.2.xml +393 -0
  113. data/spec/examples/rfc5841.md.3.xml +449 -0
  114. data/spec/examples/rfc5841.md.adoc +414 -0
  115. data/spec/examples/rfc6350.adoc +3499 -0
  116. data/spec/examples/rfc6350.bib +763 -0
  117. data/spec/examples/rfc748.md +79 -0
  118. data/spec/examples/rfc748.md.2.xml +116 -0
  119. data/spec/examples/rfc748.md.3.xml +109 -0
  120. data/spec/examples/rfc748.md.adoc +80 -0
  121. data/spec/examples/rfc7511.md +257 -0
  122. data/spec/examples/rfc7511.md.2.xml +300 -0
  123. data/spec/examples/rfc7511.md.3.xml +347 -0
  124. data/spec/examples/rfc7511.md.adoc +417 -0
  125. data/spec/spec_helper.rb +115 -5
  126. metadata +274 -9
  127. data/.hound.yml +0 -3
  128. data/README.md +0 -84
  129. data/lib/asciidoctor/rfc.rb +0 -7
  130. data/spec/asciidoctor-rfc/.keep +0 -0
@@ -0,0 +1,596 @@
1
+ = Your MIB module document name
2
+ Editor name <Editor email>
3
+ :doctype: internet-draft
4
+ :status: historic
5
+ :name: Your MIB Document name here rev07
6
+ :ipr: trust200902
7
+ :abbrev: Your MIB Module document name
8
+ :fullname: Editor name
9
+ :forename_initials: Y
10
+ :role: editor
11
+ :surname: Name
12
+ :organization: Editor affiliation
13
+ :street: Editor affiliation address
14
+ :city: Editor affiliation address
15
+ :country: Editor affiliation address
16
+ :phone: Editor address
17
+ :email: Editor email
18
+ :revdate: 2008-01-01
19
+ :area: Operations & Management Area
20
+ :workgroup: Internet Engineering Task Force
21
+ :keyword: Network Management,Management Information Base,MIB,SMIv2
22
+ :smart-quotes: false
23
+
24
+ [abstract]
25
+
26
+ (In RFC XML v2, an absract cannot begin with a note!)
27
+
28
+ [[CREF1: This template is for authors of IETF specifications containing MIB
29
+ modules. This template can be used as a starting point to produce
30
+ specifications that comply with the Operations & Management Area
31
+ guidelines for MIB module internet drafts. Throughout the template, the marker "[TEMPLATE TODO]" is used as a placeholder to indicate an
32
+ element or text that requires replacement or removal. All the places with [TEMPLATE TODO] markers
33
+ should be replaced or removed before the document is submitted.]]
34
+
35
+ This memo defines a portion of the Management Information Base (MIB)
36
+ for use with network management protocols. In particular it defines
37
+ objects for managing [TEMPLATE TODO].
38
+
39
+
40
+ [[CREF2: [TEMPLATE TODO]: describe what functionality will be managed using this MIB
41
+ module. It can be good to mention the protocol being managed, and
42
+ whether there is a particular aspect of the protocol to be managed, or a
43
+ particular goal of the module. But keep it brief. Remember, don't put any citations
44
+ in the abstract, and expand your acronyms. ]]
45
+
46
+
47
+ [NOTE]
48
+ .Foreword to template users
49
+ ====
50
+ This template is intended to help authors write the surrounding text needed in a
51
+ MIB module internet draft, but does not provide a template for writing
52
+ the MIB module itself.
53
+
54
+ Throughout this template, the marker "[TEMPLATE TODO]" is used as a reminder
55
+ to the template user to indicate an element or text that requires
56
+ replacement or removal by the template user before submission to the
57
+ internet draft editor. All [TEMPLATE TODO] markers should be resolved and removed
58
+ before you submit your document to the internet-draft editor.
59
+
60
+ For updated information on MIB module guidelines and templates, see
61
+ <<RFC4181>> and the OPS Area web page and wiki.
62
+
63
+ For information on writing internet drafts or RFCs, see
64
+ http://www.ietf.org/ietf/1id-guidelines.txt and
65
+ RFC2223(bis) <<RFC2223>>, and look
66
+ at http://www.ietf.org/ID-Checklist.html for issues to note when writing
67
+ drafts.
68
+
69
+ This template is not meant to be a complete list of everything
70
+ needed to write MIB module internet drafts, but to summarize the often-needed
71
+ basic features to get a document containing a MIB module started. An
72
+ important purpose of the template is to aid authors in developing an
73
+ internet draft that is laid out in a manner consistent with other internet
74
+ drafts containing MIB modules. Internet drafts submitted for advancement
75
+ to the standards track typically require review by a MIB Doctor. This
76
+ template standardizes the layout and naming of sections, includes the
77
+ appropriate boilerplate text, and facilitates the development of tools
78
+ to automate the checking of MIB module internet drafts, to speed the WG
79
+ and IESG review processes.
80
+
81
+ An XML2RFC template is also available. For information on XML2RFC, see
82
+ RFC2629 <<RFC2629>>, and documentation available at
83
+ http://xml.resource.org. The XML2RFC version includes
84
+ advice describing how to fill in each section of the template. XML2RFC generates the
85
+ actual internet-draft from your information, and automatically handles getting up-to-date
86
+ boilerplates, references, and it handles many idnits issues.
87
+
88
+ Within the template, there is reference to a SAMPLE-MIB; all references
89
+ to SAMPLE-MIB should be removed from your internet draft, and should be
90
+ replaced by references to your MIB module, as appropriate.
91
+
92
+ [TEMPLATE TODO] THIS section, the complete section entitled "Note: Foreword to
93
+ template users" should be removed by the template user from their
94
+ document before submission.
95
+
96
+ [TEMPLATE TODO] Remove all page headings from the template document, and
97
+ replace them with the appropriate headings for your internet draft.
98
+ ====
99
+
100
+ [NOTE]
101
+ .Note to RFC Editor re: [TEMPLATE TODO] markers
102
+ ====
103
+ Note to RFC Editor: When a document is developed using this template, the editor of the
104
+ document should replace or remove all the places marked [TEMPLATE TODO] before submitting the document.
105
+ If there are still [TEMPLATE TODO] markers, please send the document back to the editor.
106
+ ====
107
+
108
+ == Introduction
109
+ This memo defines a portion of the Management Information Base (MIB)
110
+ for use with network management protocols. In particular it defines
111
+ objects for managing the [TEMPLATE TODO].
112
+
113
+ [[CREF3: [TEMPLATE TODO]: describe what functionality will be managed using this MIB
114
+ module. Include citations for protocol specifications, architectures, related MIB modules, and protocol-specific
115
+ management requirements. Provide an overview of why a MIB module is appropriate for this protocol, whether there is a
116
+ particular aspect of the protocol to be managed, and how the module is expected to be used to
117
+ achieve particular goals. Highlight anything 'different' about the module. For example,
118
+ a read-only MIB module.]]
119
+
120
+ == The Internet-Standard Management Framework
121
+ [[CREF4: The title and text for this section has been copied from the
122
+ official boilerplate, and should not be modified unless the official boilerplate text
123
+ from the OPS Area web site has changed. See RFC4818
124
+ section 3.1 for a discussion of the boilerplate section.]]
125
+
126
+ For a detailed overview of the documents that describe the current
127
+ Internet-Standard Management Framework, please refer to section 7 of RFC
128
+ 3410 <<RFC3410>>.
129
+
130
+ Managed objects are accessed via a virtual information store, termed
131
+ the Management Information Base or MIB. MIB objects are generally
132
+ accessed through the Simple Network Management Protocol (SNMP). Objects
133
+ in the MIB are defined using the mechanisms defined in the Structure of
134
+ Management Information (SMI). This memo specifies a MIB module that is
135
+ compliant to the SMIv2, which is described in STD 58, RFC 2578 <<RFC2578>>, STD 58, RFC 2579 <<RFC2579>> and STD 58, RFC 2580 <<RFC2580>>.
136
+
137
+ == Conventions
138
+ [[CREF5: [TEMPLATE TODO] This boilerplate should be used if the RFC2119 key words
139
+ are used in the internet draft. The text in this section has been
140
+ copied from the official boilerplate, and should not be modified. ]]
141
+
142
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
143
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
144
+ document are to be interpreted as described in BCP 14, RFC 2119 <<RFC2119>>.
145
+
146
+ == Overview
147
+ [[CREF6: [TEMPLATE TODO] The narrative part should include an overview section that
148
+ describes the scope and field of application of the MIB modules
149
+ defined by the specification. See RFC4181 section 3.2 for a
150
+ discussion of the Narrative section. ]]
151
+
152
+ == Structure of the MIB Module
153
+
154
+ [[CREF7: [TEMPLATE TODO] The narrative part SHOULD include one or more sections to
155
+ briefly describe the structure of the MIB modules defined in the
156
+ specification.]]
157
+
158
+
159
+ === Textual Conventions
160
+ [[CREF8: [TEMPLATE TODO] describe the textual conventions defined in the MIB
161
+ module, and their purpose. It may be helpful to highlight any textual conventions
162
+ imported from partner documents. Generic and Common Textual Conventions can be found summarized at
163
+ the OPS Area web site. If there are no textual conventions used in your MIB module,
164
+ this section should be removed.]]
165
+
166
+ === The [TEMPLATE TODO] Subtree
167
+ [[CREF9: [TEMPLATE TODO] copy this section for each subtree in the MIB module, and
168
+ describe the purpose of the subtree. For example, "The fooStats subtree
169
+ provides information for identifying fault conditions and performance
170
+ degradation of the foo functionality."]]
171
+
172
+ === The Notifications Subtree
173
+ [[CREF10: [TEMPLATE TODO] describe the notifications defined in the MIB module, and
174
+ their purpose. Include a discussion of congestion control. You might
175
+ want to discuss throttling as well. See RFC2914.]]
176
+
177
+ === The Table Structures
178
+ [[CREF11: [TEMPLATE TODO] Describe the tables in the MIB module, their purpose, and their
179
+ reltionship to each other. If the row in one table is related to a row in
180
+ another table, what happens when one of the rows is deleted? Should the
181
+ related row be deleted as well? Consider both directions.]]
182
+
183
+ == Relationship to Other MIB Modules
184
+ [[CREF12: [TEMPLATE TODO]: The narrative part should include a section that specifies the
185
+ relationship (if any) of the MIB modules contained in this internet drafts to
186
+ other standards, particularly to standards containing other MIB
187
+ modules. If the MIB modules defined by the specification import
188
+ definitions from other MIB modules or are always implemented in
189
+ conjunction with other MIB modules, then those facts should be noted in
190
+ the narrataive section, as should any special interpretations of objects
191
+ in other MIB modules. Note that citations may NOT be put into the MIB
192
+ module portions of the internet draft, but documents used for Imported items
193
+ are Normative references, so the citations should exist in the narrative
194
+ section of the internet draft. The preferred
195
+ way to fill in a REFERENCE clause in a MIB module is of the form: "Guidelines
196
+ for Writing an IANA Considerations Section in RFCs", RFC2434, section 2.3.]]
197
+
198
+ === Relationship to the [TEMPLATE TODO] MIB
199
+ [[CREF13: Example: The Interface MIB [RFC2863] requires that any
200
+ MIB module which is an adjunct of the Interface MIB clarify specific
201
+ areas within the Interface MIB. These areas were intentionally left
202
+ vague in the Interface MIB to avoid over-constraining the MIB, thereby
203
+ precluding management of certain media-types. Section 4 of [RFC2863] enumerates several
204
+ areas which a media-specific MIB must clarify. The implementor is
205
+ referred to [RFC2863] in order to understand the
206
+ general intent of these areas.]]
207
+
208
+ === MIB modules required for IMPORTS
209
+
210
+ [[CREF14: [TEMPLATE TODO]: Citations are not permitted within a MIB module, but any
211
+ module mentioned in an IMPORTS clause or document mentioned in a
212
+ REFERENCE clause is a Normative reference, and must be cited someplace
213
+ within the narrative sections. If there are imported items in the MIB
214
+ module, such as Textual Conventions, that are not already cited, they
215
+ can be cited in text here. Since relationships to other MIB modules
216
+ should be described in the narrative text, this section is typically
217
+ used to cite modules from which Textual Conventions are imported. Example: "The following MIB module IMPORTS objects from SNMPv2-SMI [RFC2578],
218
+ SNMPv2-TC [RFC2579],
219
+ SNMPv2-CONF [RFC2580], and IF-MIB [RFC2863]."]]
220
+
221
+ == Definitions
222
+ [[CREF15: This section contains the actual MIB module(s).
223
+ These MIB modules MUST be written in SMIv2 [RFC2578] [RFC2579]
224
+ [RFC2580]. See Section 4 of RFC 4181 for guidelines on SMIv2 usage.
225
+ See Appendix C of RFC 4181 for suggested naming conventions.]]
226
+
227
+ ....
228
+ [TEMPLATE TODO]: put your valid MIB module here.
229
+ A list of tools that can help automate the process of
230
+ checking MIB definitions can be found at the OPS
231
+ Area web site.
232
+ ....
233
+
234
+ == Security Considerations
235
+ [[CREF16: [TEMPLATE TODO] Each internet draft that defines one or more MIB modules MUST
236
+ contain a section that discusses security considerations relevant to
237
+ those modules. This section MUST be patterned after the latest approved
238
+ template (available at the OPS Area web site). ]]
239
+
240
+
241
+ [[CREF17: [TEMPLATE TODO] if you have any read-write and/or read-create objects, please
242
+ describe their specific sensitivity or vulnerability. RFC 2669 has a very good example. ]]
243
+
244
+ There are a number of management objects defined in this MIB module
245
+ with a MAX-ACCESS clause of read-write and/or read-create. Such objects
246
+ may be considered sensitive or vulnerable in some network environments.
247
+ The support for SET operations in a non-secure environment without
248
+ proper protection can have a negative effect on network operations.
249
+ These are the tables and objects and their
250
+ sensitivity/vulnerability:
251
+
252
+ * {blank}
253
+
254
+ [[CREF18: [TEMPLATE TODO] else if there are no read-write or read-create objects in your MIB module,
255
+ use the following boilerplate paragraph.]]
256
+
257
+ There are no management objects defined in this MIB module that have
258
+ a MAX-ACCESS clause of read-write and/or read-create. So, if this MIB
259
+ module is implemented correctly, then there is no risk that an intruder
260
+ can alter or create any management objects of this MIB module via direct
261
+ SNMP SET operations.
262
+
263
+ [[CREF19: For all MIB modules you must evaluate whether any readable objects
264
+ are sensitive or vulnerable (for instance, if they might reveal customer
265
+ information or violate personal privacy laws such as those of the
266
+ European Union if exposed to unathorized parties).]]
267
+
268
+ Some of the readable objects in this MIB module (i.e., objects with a
269
+ MAX-ACCESS other than not-accessible) may be considered sensitive or
270
+ vulnerable in some network environments. It is thus important to control
271
+ even GET and/or NOTIFY access to these objects and possibly to even
272
+ encrypt the values of these objects when sending them over the network
273
+ via SNMP. These are the tables and objects and their
274
+ sensitivity/vulnerability:
275
+
276
+ * {blank}
277
+
278
+ * [[CREF20: [TEMPLATE TODO] you should explicitly list by name any readable objects that
279
+ are sensitive or vulnerable and the associated security risks should
280
+ be spelled out.]]
281
+
282
+ [[CREF21: [TEMPLATE TODO] The following three boilerplate paragraphs
283
+ should not be changed without very good reason. Changes will almost
284
+ certainly require justification during IESG review.]]
285
+
286
+ SNMP versions prior to SNMPv3 did not include adequate security.
287
+ Even if the network itself is secure (for example by using IPsec),
288
+ there is no control as to who on the secure network is
289
+ allowed to access and GET/SET (read/change/create/delete) the objects
290
+ in this MIB module.
291
+
292
+ Implementations SHOULD provide the security features described by the
293
+ SNMPv3 framework (see [RFC3410]), and implementations claiming compliance
294
+ to the SNMPv3 standard MUST include full support for authentication and
295
+ privacy via the User-based Security Model (USM) [RFC3414] with the AES
296
+ cipher algorithm [RFC3826]. Implementations MAY also provide support for
297
+ the Transport Security Model (TSM) [RFC5591] in combination with a secure
298
+ transport such as SSH [RFC5592] or TLS/DTLS [RFC6353].
299
+
300
+ Further, deployment of SNMP versions prior to SNMPv3 is NOT
301
+ RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to enable
302
+ cryptographic security. It is then a customer/operator responsibility to
303
+ ensure that the SNMP entity giving access to an instance of this MIB
304
+ module is properly configured to give access to the objects only to
305
+ those principals (users) that have legitimate rights to indeed GET or
306
+ SET (change/create/delete) them.
307
+
308
+ == IANA Considerations
309
+ [[CREF22: [TEMPLATE TODO] In order to comply with IESG policy as set forth in
310
+ http://www.ietf.org/ID-Checklist.html, every Internet-Draft that is
311
+ submitted to the IESG for publication MUST contain an IANA
312
+ Considerations section. The requirements for this section vary depending
313
+ what actions are required of the IANA. See "Guidelines for Writing an IANA
314
+ Considerations Section in RFCs" [RFC2434]. and see RFC4181 section 3.5 for more
315
+ information on writing an IANA clause for a MIB module internet draft.]]
316
+
317
+ Option #1:
318
+
319
+ ....
320
+ The MIB module in this document uses the following IANA-assigned
321
+ OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
322
+
323
+ Descriptor OBJECT IDENTIFIER value
324
+ ---------- -----------------------
325
+ sampleMIB { mib-2 XXX }
326
+ ....
327
+
328
+ Option #2:
329
+
330
+ Editor's Note (to be removed prior to publication): the IANA is
331
+ requested to assign a value for "XXX" under the 'mib-2' subtree and to
332
+ record the assignment in the SMI Numbers registry. When the assignment
333
+ has been made, the RFC Editor is asked to replace "XXX" (here and in the
334
+ MIB module) with the assigned value and to remove this note.
335
+
336
+ Note well: prior to official assignment by the IANA, an internet
337
+ draft MUST use placeholders (such as "XXX" above) rather than actual
338
+ numbers. See RFC4181 Section 4.5 for an example of how this is done in
339
+ an internet draft MIB module.
340
+
341
+ Option #3:
342
+
343
+ This memo includes no request to IANA.
344
+
345
+ == Contributors
346
+ NOTE: [TEMPLATE TODO] This optional section can be used to mention contributors to your internet draft.
347
+
348
+ [bibliography]
349
+ == Normative References
350
+ ++++
351
+ <!-- [TEMPLATE TODO] rfc2119, 2578, 2579, and 2580 are required to support MIB
352
+ module boilerplate text. -->
353
+
354
+ <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
355
+ <front>
356
+ <title>
357
+ Key words for use in RFCs to Indicate Requirement Levels
358
+ </title>
359
+ <author initials="S." surname="Bradner" fullname="S. Bradner">
360
+ <organization/>
361
+ </author>
362
+ <date year="1997" month="March"/>
363
+ <abstract>
364
+ <t>
365
+ In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.
366
+ </t>
367
+ </abstract>
368
+ </front>
369
+ <seriesInfo name="BCP" value="14"/>
370
+ <seriesInfo name="RFC" value="2119"/>
371
+ <seriesInfo name="DOI" value="10.17487/RFC2119"/>
372
+ </reference>
373
+
374
+ <reference anchor="RFC2578" target="https://www.rfc-editor.org/info/rfc2578">
375
+ <front>
376
+ <title>
377
+ Structure of Management Information Version 2 (SMIv2)
378
+ </title>
379
+ <author initials="K." surname="McCloghrie" fullname="K. McCloghrie" role="editor">
380
+ <organization/>
381
+ </author>
382
+ <author initials="D." surname="Perkins" fullname="D. Perkins" role="editor">
383
+ <organization/>
384
+ </author>
385
+ <author initials="J." surname="Schoenwaelder" fullname="J. Schoenwaelder" role="editor">
386
+ <organization/>
387
+ </author>
388
+ <date year="1999" month="April"/>
389
+ <abstract>
390
+ <t>
391
+ It is the purpose of this document, the Structure of Management Information Version 2 (SMIv2), to define that adapted subset, and to assign a set of associated administrative values. [STANDARDS-TRACK]
392
+ </t>
393
+ </abstract>
394
+ </front>
395
+ <seriesInfo name="STD" value="58"/>
396
+ <seriesInfo name="RFC" value="2578"/>
397
+ <seriesInfo name="DOI" value="10.17487/RFC2578"/>
398
+ </reference>
399
+
400
+ <reference anchor="RFC2579" target="https://www.rfc-editor.org/info/rfc2579">
401
+ <front>
402
+ <title>Textual Conventions for SMIv2</title>
403
+ <author initials="K." surname="McCloghrie" fullname="K. McCloghrie" role="editor">
404
+ <organization/>
405
+ </author>
406
+ <author initials="D." surname="Perkins" fullname="D. Perkins" role="editor">
407
+ <organization/>
408
+ </author>
409
+ <author initials="J." surname="Schoenwaelder" fullname="J. Schoenwaelder" role="editor">
410
+ <organization/>
411
+ </author>
412
+ <date year="1999" month="April"/>
413
+ <abstract>
414
+ <t>
415
+ It is the purpose of this document to define the initial set of textual conventions available to all MIB modules. [STANDARDS-TRACK]
416
+ </t>
417
+ </abstract>
418
+ </front>
419
+ <seriesInfo name="STD" value="58"/>
420
+ <seriesInfo name="RFC" value="2579"/>
421
+ <seriesInfo name="DOI" value="10.17487/RFC2579"/>
422
+ </reference>
423
+
424
+ <reference anchor="RFC2580" target="https://www.rfc-editor.org/info/rfc2580">
425
+ <front>
426
+ <title>Conformance Statements for SMIv2</title>
427
+ <author initials="K." surname="McCloghrie" fullname="K. McCloghrie" role="editor">
428
+ <organization/>
429
+ </author>
430
+ <author initials="D." surname="Perkins" fullname="D. Perkins" role="editor">
431
+ <organization/>
432
+ </author>
433
+ <author initials="J." surname="Schoenwaelder" fullname="J. Schoenwaelder" role="editor">
434
+ <organization/>
435
+ </author>
436
+ <date year="1999" month="April"/>
437
+ <abstract>
438
+ <t>
439
+ Collections of related objects are defined in MIB modules. It may be useful to define the acceptable lower-bounds of implementation, along with the actual level of implementation achieved. It is the purpose of this document to define the notation used for these purposes. [STANDARDS-TRACK]
440
+ </t>
441
+ </abstract>
442
+ </front>
443
+ <seriesInfo name="STD" value="58"/>
444
+ <seriesInfo name="RFC" value="2580"/>
445
+ <seriesInfo name="DOI" value="10.17487/RFC2580"/>
446
+ </reference>
447
+ ++++
448
+
449
+ [bibliography]
450
+ == Informative References
451
+ ++++
452
+
453
+ <!-- RFC3410 is required to support the boilerplate text.-->
454
+ <reference anchor="RFC2223" target="https://www.rfc-editor.org/info/rfc2223">
455
+ <front>
456
+ <title>Instructions to RFC Authors</title>
457
+ <author initials="J." surname="Postel" fullname="J. Postel">
458
+ <organization/>
459
+ </author>
460
+ <author initials="J." surname="Reynolds" fullname="J. Reynolds">
461
+ <organization/>
462
+ </author>
463
+ <date year="1997" month="October"/>
464
+ <abstract>
465
+ <t>
466
+ This Request for Comments (RFC) provides information about the preparation of RFCs, and certain policies relating to the publication of RFCs. This memo provides information for the Internet community. This memo does not specify an Internet standard of any kind.
467
+ </t>
468
+ </abstract>
469
+ </front>
470
+ <seriesInfo name="RFC" value="2223"/>
471
+ <seriesInfo name="DOI" value="10.17487/RFC2223"/>
472
+ </reference>
473
+
474
+ <reference anchor="RFC3410" target="https://www.rfc-editor.org/info/rfc3410">
475
+ <front>
476
+ <title>
477
+ Introduction and Applicability Statements for Internet-Standard Management Framework
478
+ </title>
479
+ <author initials="J." surname="Case" fullname="J. Case">
480
+ <organization/>
481
+ </author>
482
+ <author initials="R." surname="Mundy" fullname="R. Mundy">
483
+ <organization/>
484
+ </author>
485
+ <author initials="D." surname="Partain" fullname="D. Partain">
486
+ <organization/>
487
+ </author>
488
+ <author initials="B." surname="Stewart" fullname="B. Stewart">
489
+ <organization/>
490
+ </author>
491
+ <date year="2002" month="December"/>
492
+ <abstract>
493
+ <t>
494
+ The purpose of this document is to provide an overview of the third version of the Internet-Standard Management Framework, termed the SNMP version 3 Framework (SNMPv3). This Framework is derived from and builds upon both the original Internet-Standard Management Framework (SNMPv1) and the second Internet-Standard Management Framework (SNMPv2). The architecture is designed to be modular to allow the evolution of the Framework over time. The document explains why using SNMPv3 instead of SNMPv1 or SNMPv2 is strongly recommended. The document also recommends that RFCs 1157, 1441, 1901, 1909 and 1910 be retired by moving them to Historic status. This document obsoletes RFC 2570. This memo provides information for the Internet community.
495
+ </t>
496
+ </abstract>
497
+ </front>
498
+ <seriesInfo name="RFC" value="3410"/>
499
+ <seriesInfo name="DOI" value="10.17487/RFC3410"/>
500
+ </reference>
501
+
502
+ <reference anchor="RFC2629" target="https://www.rfc-editor.org/info/rfc2629">
503
+ <front>
504
+ <title>Writing I-Ds and RFCs using XML</title>
505
+ <author initials="M." surname="Rose" fullname="M. Rose">
506
+ <organization/>
507
+ </author>
508
+ <date year="1999" month="June"/>
509
+ <abstract>
510
+ <t>
511
+ This memo presents a technique for using XML (Extensible Markup Language) as a source format for documents in the Internet-Drafts (I-Ds) and Request for Comments (RFC) series. This memo provides information for the Internet community.
512
+ </t>
513
+ </abstract>
514
+ </front>
515
+ <seriesInfo name="RFC" value="2629"/>
516
+ <seriesInfo name="DOI" value="10.17487/RFC2629"/>
517
+ </reference>
518
+
519
+ <reference anchor="RFC4181" target="https://www.rfc-editor.org/info/rfc4181">
520
+ <front>
521
+ <title>
522
+ Guidelines for Authors and Reviewers of MIB Documents
523
+ </title>
524
+ <author initials="C." surname="Heard" fullname="C. Heard" role="editor">
525
+ <organization/>
526
+ </author>
527
+ <date year="2005" month="September"/>
528
+ <abstract>
529
+ <t>
530
+ This memo provides guidelines for authors and reviewers of IETF standards-track specifications containing MIB modules. Applicable portions may be used as a basis for reviews of other MIB documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.
531
+ </t>
532
+ </abstract>
533
+ </front>
534
+ <seriesInfo name="BCP" value="111"/>
535
+ <seriesInfo name="RFC" value="4181"/>
536
+ <seriesInfo name="DOI" value="10.17487/RFC4181"/>
537
+ </reference>
538
+ ++++
539
+
540
+ [bibliography]
541
+ == URL References
542
+ ++++
543
+ <reference anchor="idguidelines">
544
+ <front>
545
+ <title>http://www.ietf.org/ietf/1id-guidelines.txt</title>
546
+ <author>
547
+ <organization>IETF Internet Drafts editor</organization>
548
+ </author>
549
+ <date year=""></date>
550
+ </front>
551
+ </reference>
552
+ <reference anchor="idnits">
553
+ <front>
554
+ <title>http://www.ietf.org/ID-Checklist.html</title>
555
+ <author>
556
+ <organization>IETF Internet Drafts editor</organization>
557
+ </author>
558
+ <date year=""></date>
559
+ </front>
560
+ </reference>
561
+ <reference anchor="xml2rfc">
562
+ <front>
563
+ <title>http://xml.resource.org</title>
564
+ <author>
565
+ <organization>XML2RFC tools and documentation</organization>
566
+ </author>
567
+ <date year=""></date>
568
+ </front>
569
+ </reference>
570
+ <reference anchor="ops">
571
+ <front>
572
+ <title>http://www.ops.ietf.org</title>
573
+ <author>
574
+ <organization>the IETF OPS Area</organization>
575
+ </author>
576
+ <date year=""></date>
577
+ </front>
578
+ </reference>
579
+ <reference anchor="ietf">
580
+ <front>
581
+ <title>http://tools.ietf.org</title>
582
+ <author>
583
+ <organization>IETF Tools Team</organization>
584
+ </author>
585
+ <date year=""></date>
586
+ </front>
587
+ </reference>
588
+ ++++
589
+
590
+ [[appendix]]
591
+ == Change Log
592
+ Note to RFC Editor: if this document does not obsolete an existing RFC,
593
+ please remove this appendix before publication as an RFC.
594
+
595
+ == Open Issues
596
+ Note to RFC Editor: please remove this appendix before publication as an RFC.