asciidoctor-rfc 0.9.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,280 @@
1
+
2
+
3
+
4
+
5
+ Imaginary WG C. Smith
6
+ Internet-Draft EC
7
+ Updates: 1234, 5678 (if approved) K. Jones
8
+ Intended status: Standards Track September 2014
9
+ Expires: March 5, 2015
10
+
11
+
12
+ An Example of Using XML for an Internet Draft
13
+ draft-example-of-xml-00
14
+
15
+ Abstract
16
+
17
+ This is an example of an abstract. It is a short paragraph that
18
+ gives an overview of the document in order to help the reader
19
+ determine whether or not they are interested in reading further.
20
+
21
+ Disclaimer
22
+
23
+ This isn't a real RFC, just an example.
24
+
25
+ Status of This Memo
26
+
27
+ This Internet-Draft is submitted in full conformance with the
28
+ provisions of BCP 78 and BCP 79.
29
+
30
+ Internet-Drafts are working documents of the Internet Engineering
31
+ Task Force (IETF). Note that other groups may also distribute
32
+ working documents as Internet-Drafts. The list of current Internet-
33
+ Drafts is at http://datatracker.ietf.org/drafts/current/.
34
+
35
+ Internet-Drafts are draft documents valid for a maximum of six months
36
+ and may be updated, replaced, or obsoleted by other documents at any
37
+ time. It is inappropriate to use Internet-Drafts as reference
38
+ material or to cite them other than as "work in progress."
39
+
40
+ This Internet-Draft will expire on March 5, 2015.
41
+
42
+ Copyright Notice
43
+
44
+ Copyright (c) 2014 IETF Trust and the persons identified as the
45
+ document authors. All rights reserved.
46
+
47
+ This document is subject to BCP 78 and the IETF Trust's Legal
48
+ Provisions Relating to IETF Documents
49
+ (http://trustee.ietf.org/license-info) in effect on the date of
50
+ publication of this document. Please review these documents
51
+ carefully, as they describe your rights and restrictions with respect
52
+ to this document. Code Components extracted from this document must
53
+
54
+
55
+
56
+ Smith & Jones Expires March 5, 2015 [Page 1]
57
+
58
+ Internet-Draft XML Example September 2014
59
+
60
+
61
+ include Simplified BSD License text as described in Section 4.e of
62
+ the Trust Legal Provisions and are provided without warranty as
63
+ described in the Simplified BSD License.
64
+
65
+ 1. Introduction
66
+
67
+ This is the first paragraph of the introduction to this document.
68
+ This introduction is probably much shorter than it would be for a
69
+ real Internet Draft.
70
+
71
+ Something to note about this paragraph is that it has a pointer to
72
+ Section 2, and one to Figure 1, both of which appear later in the
73
+ document.
74
+
75
+ 1.1. Terminology
76
+
77
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
78
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
79
+ document are to be interpreted as described in [RFC2119].
80
+
81
+ 2. The Protocol Being Described
82
+
83
+ This is a reference to [RFC6949]. Actually, the reference itself is
84
+ not all that interesting, but the way that the reference is
85
+ incorporated is. Note that the inclusion of RFC 2119 was done at the
86
+ top of the XML, while the information for RFC 6949 is done directly
87
+ in the references section.
88
+
89
+ The IETF web site [1] is _quite_ *nice*, "isn't it"? Unlike other
90
+ web sites, it doesn't use
91
+
92
+
93
+ gratuitous vertical space.
94
+
95
+ 3. Basic Lists
96
+
97
+ Bulleted lists are good for items that are not ordered:
98
+
99
+ o This is the first item.
100
+
101
+ o This is the second item. Here comes a sub-list:
102
+
103
+ * This is the first sub-item.
104
+
105
+ * This is the second sub-item
106
+ and some more detail on the second sub-item.
107
+
108
+ o This is the item after the sub-list.
109
+
110
+
111
+
112
+ Smith & Jones Expires March 5, 2015 [Page 2]
113
+
114
+ Internet-Draft XML Example September 2014
115
+
116
+
117
+ Numbered lists are good for items that are ordered:
118
+
119
+ 1. This is the first item.
120
+
121
+ 2. This is the second item. Here comes a sub-list, but with
122
+ letters:
123
+
124
+ A. This is the first sub-item.
125
+
126
+ B. This is the second sub-item
127
+
128
+ 3. This is the item after the sub-list.
129
+
130
+ And an example of hanging indent.
131
+
132
+ Trees These are bigger plants
133
+
134
+ Lichen These are smaller plants
135
+
136
+ And the always-interesting "format" for lists.
137
+
138
+ --1-- An element that gets a funny bullet.
139
+
140
+ 4. Figures
141
+
142
+ The following is a figure with a caption. Also, it uses the
143
+ ampersand (&) and less than (<) characters in the example text.
144
+
145
+ The ampersand (&) and
146
+ less than (<) are two characters
147
+ that need escaping.
148
+
149
+ Figure 1: This could be haiku
150
+
151
+ Here are two short figures with no titles and with odd alignment.
152
+
153
+ This might appear in the center.
154
+
155
+ This might appear right-aligned.
156
+
157
+ Here is a figure that is actually pulled from somewhere else.
158
+
159
+ 5. Tables
160
+
161
+ The following is a table example.
162
+
163
+
164
+
165
+
166
+
167
+
168
+ Smith & Jones Expires March 5, 2015 [Page 3]
169
+
170
+ Internet-Draft XML Example September 2014
171
+
172
+
173
+ These are sometimes called "inert" gasses.
174
+
175
+ +---------+--------------------------------+---------------+
176
+ | Name | Symbol | Atomic Number |
177
+ +---------+--------------------------------+---------------+
178
+ | Helium | He | 2 |
179
+ | | | |
180
+ | Neon | Ne | 10 |
181
+ | | | |
182
+ | Argon | Ar | 18 |
183
+ | | | |
184
+ | Krypton | Kr | 36 |
185
+ | | | |
186
+ | Xenon | Xe | 54 |
187
+ | | | |
188
+ | Radon | Rn | 86 |
189
+ +---------+--------------------------------+---------------+
190
+
191
+ Source: Chemistry 101
192
+
193
+ The Noble Gases
194
+
195
+ The following is a right-aligned table with "full" (but not "all")
196
+ lines between cells.
197
+
198
+ +-----------+--------+
199
+ | Time | Mood |
200
+ +-----------+--------+
201
+ | Morning | Happy! |
202
+ | | |
203
+ | Afternoon | Happy! |
204
+ | | |
205
+ | Evening | Somber |
206
+ +-----------+--------+
207
+
208
+ 6. IANA Considerations
209
+
210
+ None.
211
+
212
+ 7. Security Considerations
213
+
214
+ There are no security considerations for an imaginary Internet Draft.
215
+
216
+ 8. Acknowledgements
217
+
218
+ Some of the things included in this draft came from Elwyn Davies'
219
+ templates.
220
+
221
+
222
+
223
+
224
+ Smith & Jones Expires March 5, 2015 [Page 4]
225
+
226
+ Internet-Draft XML Example September 2014
227
+
228
+
229
+ 9. References
230
+
231
+ 9.1. Normative References
232
+
233
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
234
+ Requirement Levels", BCP 14, RFC 2119,
235
+ DOI 10.17487/RFC2119, March 1997,
236
+ <https://www.rfc-editor.org/info/rfc2119>.
237
+
238
+ 9.2. Informative References
239
+
240
+ [RED] Floyd, S. and V. Jacobson, "Random Early Detection (RED)
241
+ gateways for Congestion Avoidance", IEEE/ACM Transactions
242
+ on Networking 1(4) 397--413, August 1993,
243
+ <http://www.aciri.org/floyd/papers/early.pdf>.
244
+
245
+ [RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
246
+ Requirements and Future Development", RFC 6949, May 2013.
247
+
248
+ This is a primary reference work.
249
+
250
+ 9.3. URIs
251
+
252
+ [1] http://www.ietf.org
253
+
254
+ Index
255
+
256
+ I
257
+ Introduction
258
+ verbiage 2
259
+
260
+ Authors' Addresses
261
+
262
+ Chris Smith
263
+ ExampleCorp
264
+ 123 Exemplar Way
265
+ Anytown, California 95060
266
+ US
267
+
268
+ Phone: +1 123-456-7890
269
+ Fax: +1 123-456-7890
270
+ Email: chrissmith@example.com
271
+ URI: http://www.example.com/corporate/
272
+
273
+
274
+ Kim Jones
275
+
276
+ Email: jk@lmn.op
277
+
278
+
279
+
280
+ Smith & Jones Expires March 5, 2015 [Page 5]
@@ -0,0 +1,672 @@
1
+
2
+
3
+
4
+
5
+ Internet Engineering Task Force Y. Name, Ed.
6
+ Internet-Draft Editor affiliation
7
+ Intended status: Historic January 1, 2008
8
+ Expires: July 4, 2008
9
+
10
+
11
+ Your MIB module document name
12
+ Your MIB Document name here rev07
13
+
14
+ Abstract
15
+
16
+ [[CREF1: This template is for authors of IETF specifications
17
+ containing MIB modules. This template can be used as a starting
18
+ point to produce specifications that comply with the Operations &
19
+ Management Area guidelines for MIB module internet drafts.
20
+ Throughout the template, the marker "[TEMPLATE TODO]" is used as a
21
+ placeholder to indicate an element or text that requires replacement
22
+ or removal. All the places with [TEMPLATE TODO] markers should be
23
+ replaced or removed before the document is submitted.]]
24
+
25
+ This memo defines a portion of the Management Information Base (MIB)
26
+ for use with network management protocols. In particular it defines
27
+ objects for managing [TEMPLATE TODO].
28
+
29
+ [[CREF2: [TEMPLATE TODO]: describe what functionality will be managed
30
+ using this MIB module. It can be good to mention the protocol being
31
+ managed, and whether there is a particular aspect of the protocol to
32
+ be managed, or a particular goal of the module. But keep it brief.
33
+ Remember, don't put any citations in the abstract, and expand your
34
+ acronyms. ]]
35
+
36
+ Foreword to template users
37
+
38
+ This template is intended to help authors write the surrounding text
39
+ needed in a MIB module internet draft, but does not provide a
40
+ template for writing the MIB module itself.
41
+
42
+ Throughout this template, the marker "[TEMPLATE TODO]" is used as a
43
+ reminder to the template user to indicate an element or text that
44
+ requires replacement or removal by the template user before
45
+ submission to the internet draft editor. All [TEMPLATE TODO] markers
46
+ should be resolved and removed before you submit your document to the
47
+ internet-draft editor.
48
+
49
+ For updated information on MIB module guidelines and templates, see
50
+ [RFC4181] and the OPS Area web page and wiki.
51
+
52
+
53
+
54
+
55
+
56
+ Name Expires July 4, 2008 [Page 1]
57
+
58
+ Internet-Draft Your MIB Module document name January 2008
59
+
60
+
61
+ For information on writing internet drafts or RFCs, see
62
+ http://www.ietf.org/ietf/1id-guidelines.txt and RFC2223(bis)
63
+ [RFC2223], and look at http://www.ietf.org/ID-Checklist.html for
64
+ issues to note when writing drafts.
65
+
66
+ This template is not meant to be a complete list of everything needed
67
+ to write MIB module internet drafts, but to summarize the often-
68
+ needed basic features to get a document containing a MIB module
69
+ started. An important purpose of the template is to aid authors in
70
+ developing an internet draft that is laid out in a manner consistent
71
+ with other internet drafts containing MIB modules. Internet drafts
72
+ submitted for advancement to the standards track typically require
73
+ review by a MIB Doctor. This template standardizes the layout and
74
+ naming of sections, includes the appropriate boilerplate text, and
75
+ facilitates the development of tools to automate the checking of MIB
76
+ module internet drafts, to speed the WG and IESG review processes.
77
+
78
+ An XML2RFC template is also available. For information on XML2RFC,
79
+ see RFC2629 [RFC2629], and documentation available at
80
+ http://xml.resource.org. The XML2RFC version includes advice
81
+ describing how to fill in each section of the template. XML2RFC
82
+ generates the actual internet-draft from your information, and
83
+ automatically handles getting up-to-date boilerplates, references,
84
+ and it handles many idnits issues.
85
+
86
+ Within the template, there is reference to a SAMPLE-MIB; all
87
+ references to SAMPLE-MIB should be removed from your internet draft,
88
+ and should be replaced by references to your MIB module, as
89
+ appropriate.
90
+
91
+ [TEMPLATE TODO] THIS section, the complete section entitled "Note:
92
+ Foreword to template users" should be removed by the template user
93
+ from their document before submission.
94
+
95
+ [TEMPLATE TODO] Remove all page headings from the template document,
96
+ and replace them with the appropriate headings for your internet
97
+ draft.
98
+
99
+ Note to RFC Editor re: [TEMPLATE TODO] markers
100
+
101
+ Note to RFC Editor: When a document is developed using this template,
102
+ the editor of the document should replace or remove all the places
103
+ marked [TEMPLATE TODO] before submitting the document. If there are
104
+ still [TEMPLATE TODO] markers, please send the document back to the
105
+ editor.
106
+
107
+
108
+
109
+
110
+
111
+
112
+ Name Expires July 4, 2008 [Page 2]
113
+
114
+ Internet-Draft Your MIB Module document name January 2008
115
+
116
+
117
+ Status of This Memo
118
+
119
+ This Internet-Draft is submitted in full conformance with the
120
+ provisions of BCP 78 and BCP 79.
121
+
122
+ Internet-Drafts are working documents of the Internet Engineering
123
+ Task Force (IETF). Note that other groups may also distribute
124
+ working documents as Internet-Drafts. The list of current Internet-
125
+ Drafts is at http://datatracker.ietf.org/drafts/current/.
126
+
127
+ Internet-Drafts are draft documents valid for a maximum of six months
128
+ and may be updated, replaced, or obsoleted by other documents at any
129
+ time. It is inappropriate to use Internet-Drafts as reference
130
+ material or to cite them other than as "work in progress."
131
+
132
+ This Internet-Draft will expire on July 4, 2008.
133
+
134
+ Copyright Notice
135
+
136
+ Copyright (c) 2008 IETF Trust and the persons identified as the
137
+ document authors. All rights reserved.
138
+
139
+ This document is subject to BCP 78 and the IETF Trust's Legal
140
+ Provisions Relating to IETF Documents
141
+ (http://trustee.ietf.org/license-info) in effect on the date of
142
+ publication of this document. Please review these documents
143
+ carefully, as they describe your rights and restrictions with respect
144
+ to this document. Code Components extracted from this document must
145
+ include Simplified BSD License text as described in Section 4.e of
146
+ the Trust Legal Provisions and are provided without warranty as
147
+ described in the Simplified BSD License.
148
+
149
+ Table of Contents
150
+
151
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
152
+ 2. The Internet-Standard Management Framework . . . . . . . . . 4
153
+ 3. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
154
+ 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 5
155
+ 5. Structure of the MIB Module . . . . . . . . . . . . . . . . . 5
156
+ 5.1. Textual Conventions . . . . . . . . . . . . . . . . . . . 5
157
+ 5.2. The [TEMPLATE TODO] Subtree . . . . . . . . . . . . . . . 5
158
+ 5.3. The Notifications Subtree . . . . . . . . . . . . . . . . 5
159
+ 5.4. The Table Structures . . . . . . . . . . . . . . . . . . 6
160
+ 6. Relationship to Other MIB Modules . . . . . . . . . . . . . . 6
161
+ 6.1. Relationship to the [TEMPLATE TODO] MIB . . . . . . . . . 6
162
+ 6.2. MIB modules required for IMPORTS . . . . . . . . . . . . 6
163
+ 7. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 7
164
+ 8. Security Considerations . . . . . . . . . . . . . . . . . . . 7
165
+
166
+
167
+
168
+ Name Expires July 4, 2008 [Page 3]
169
+
170
+ Internet-Draft Your MIB Module document name January 2008
171
+
172
+
173
+ 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
174
+ 10. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 9
175
+ 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
176
+ 11.1. Normative References . . . . . . . . . . . . . . . . . . 9
177
+ 11.2. Informative References . . . . . . . . . . . . . . . . . 10
178
+ 11.3. URL References . . . . . . . . . . . . . . . . . . . . . 10
179
+ Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
180
+ Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 12
181
+ Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 12
182
+
183
+ 1. Introduction
184
+
185
+ This memo defines a portion of the Management Information Base (MIB)
186
+ for use with network management protocols. In particular it defines
187
+ objects for managing the [TEMPLATE TODO].
188
+
189
+ [[CREF3: [TEMPLATE TODO]: describe what functionality will be managed
190
+ using this MIB module. Include citations for protocol
191
+ specifications, architectures, related MIB modules, and protocol-
192
+ specific management requirements. Provide an overview of why a MIB
193
+ module is appropriate for this protocol, whether there is a
194
+ particular aspect of the protocol to be managed, and how the module
195
+ is expected to be used to achieve particular goals. Highlight
196
+ anything 'different' about the module. For example, a read-only MIB
197
+ module.]]
198
+
199
+ 2. The Internet-Standard Management Framework
200
+
201
+ [[CREF4: The title and text for this section has been copied from the
202
+ official boilerplate, and should not be modified unless the official
203
+ boilerplate text from the OPS Area web site has changed. See RFC4818
204
+ section 3.1 for a discussion of the boilerplate section.]]
205
+
206
+ For a detailed overview of the documents that describe the current
207
+ Internet-Standard Management Framework, please refer to section 7 of
208
+ RFC 3410 [RFC3410].
209
+
210
+ Managed objects are accessed via a virtual information store, termed
211
+ the Management Information Base or MIB. MIB objects are generally
212
+ accessed through the Simple Network Management Protocol (SNMP).
213
+ Objects in the MIB are defined using the mechanisms defined in the
214
+ Structure of Management Information (SMI). This memo specifies a MIB
215
+ module that is compliant to the SMIv2, which is described in STD 58,
216
+ RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
217
+ [RFC2580].
218
+
219
+
220
+
221
+
222
+
223
+
224
+ Name Expires July 4, 2008 [Page 4]
225
+
226
+ Internet-Draft Your MIB Module document name January 2008
227
+
228
+
229
+ 3. Conventions
230
+
231
+ [[CREF5: [TEMPLATE TODO] This boilerplate should be used if the
232
+ RFC2119 key words are used in the internet draft. The text in this
233
+ section has been copied from the official boilerplate, and should not
234
+ be modified. ]]
235
+
236
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
237
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
238
+ document are to be interpreted as described in BCP 14, RFC 2119
239
+ [RFC2119].
240
+
241
+ 4. Overview
242
+
243
+ [[CREF6: [TEMPLATE TODO] The narrative part should include an
244
+ overview section that describes the scope and field of application of
245
+ the MIB modules defined by the specification. See RFC4181 section
246
+ 3.2 for a discussion of the Narrative section. ]]
247
+
248
+ 5. Structure of the MIB Module
249
+
250
+ [[CREF7: [TEMPLATE TODO] The narrative part SHOULD include one or
251
+ more sections to briefly describe the structure of the MIB modules
252
+ defined in the specification.]]
253
+
254
+ 5.1. Textual Conventions
255
+
256
+ [[CREF8: [TEMPLATE TODO] describe the textual conventions defined in
257
+ the MIB module, and their purpose. It may be helpful to highlight
258
+ any textual conventions imported from partner documents. Generic and
259
+ Common Textual Conventions can be found summarized at the OPS Area
260
+ web site. If there are no textual conventions used in your MIB
261
+ module, this section should be removed.]]
262
+
263
+ 5.2. The [TEMPLATE TODO] Subtree
264
+
265
+ [[CREF9: [TEMPLATE TODO] copy this section for each subtree in the
266
+ MIB module, and describe the purpose of the subtree. For example,
267
+ "The fooStats subtree provides information for identifying fault
268
+ conditions and performance degradation of the foo functionality."]]
269
+
270
+ 5.3. The Notifications Subtree
271
+
272
+ [[CREF10: [TEMPLATE TODO] describe the notifications defined in the
273
+ MIB module, and their purpose. Include a discussion of congestion
274
+ control. You might want to discuss throttling as well. See
275
+ RFC2914.]]
276
+
277
+
278
+
279
+
280
+ Name Expires July 4, 2008 [Page 5]
281
+
282
+ Internet-Draft Your MIB Module document name January 2008
283
+
284
+
285
+ 5.4. The Table Structures
286
+
287
+ [[CREF11: [TEMPLATE TODO] Describe the tables in the MIB module,
288
+ their purpose, and their reltionship to each other. If the row in
289
+ one table is related to a row in another table, what happens when one
290
+ of the rows is deleted? Should the related row be deleted as well?
291
+ Consider both directions.]]
292
+
293
+ 6. Relationship to Other MIB Modules
294
+
295
+ [[CREF12: [TEMPLATE TODO]: The narrative part should include a
296
+ section that specifies the relationship (if any) of the MIB modules
297
+ contained in this internet drafts to other standards, particularly to
298
+ standards containing other MIB modules. If the MIB modules defined
299
+ by the specification import definitions from other MIB modules or are
300
+ always implemented in conjunction with other MIB modules, then those
301
+ facts should be noted in the narrataive section, as should any
302
+ special interpretations of objects in other MIB modules. Note that
303
+ citations may NOT be put into the MIB module portions of the internet
304
+ draft, but documents used for Imported items are Normative
305
+ references, so the citations should exist in the narrative section of
306
+ the internet draft. The preferred way to fill in a REFERENCE clause
307
+ in a MIB module is of the form: "Guidelines for Writing an IANA
308
+ Considerations Section in RFCs", RFC2434, section 2.3.]]
309
+
310
+ 6.1. Relationship to the [TEMPLATE TODO] MIB
311
+
312
+ [[CREF13: Example: The Interface MIB [RFC2863] requires that any MIB
313
+ module which is an adjunct of the Interface MIB clarify specific
314
+ areas within the Interface MIB. These areas were intentionally left
315
+ vague in the Interface MIB to avoid over-constraining the MIB,
316
+ thereby precluding management of certain media-types. Section 4 of
317
+ [RFC2863] enumerates several areas which a media-specific MIB must
318
+ clarify. The implementor is referred to [RFC2863] in order to
319
+ understand the general intent of these areas.]]
320
+
321
+ 6.2. MIB modules required for IMPORTS
322
+
323
+ [[CREF14: [TEMPLATE TODO]: Citations are not permitted within a MIB
324
+ module, but any module mentioned in an IMPORTS clause or document
325
+ mentioned in a REFERENCE clause is a Normative reference, and must be
326
+ cited someplace within the narrative sections. If there are imported
327
+ items in the MIB module, such as Textual Conventions, that are not
328
+ already cited, they can be cited in text here. Since relationships
329
+ to other MIB modules should be described in the narrative text, this
330
+ section is typically used to cite modules from which Textual
331
+ Conventions are imported. Example: "The following MIB module IMPORTS
332
+
333
+
334
+
335
+
336
+ Name Expires July 4, 2008 [Page 6]
337
+
338
+ Internet-Draft Your MIB Module document name January 2008
339
+
340
+
341
+ objects from SNMPv2-SMI [RFC2578], SNMPv2-TC [RFC2579], SNMPv2-CONF
342
+ [RFC2580], and IF-MIB [RFC2863]."]]
343
+
344
+ 7. Definitions
345
+
346
+ [[CREF15: This section contains the actual MIB module(s). These MIB
347
+ modules MUST be written in SMIv2 [RFC2578] [RFC2579] [RFC2580]. See
348
+ Section 4 of RFC 4181 for guidelines on SMIv2 usage. See Appendix C
349
+ of RFC 4181 for suggested naming conventions.]]
350
+
351
+ [TEMPLATE TODO]: put your valid MIB module here.
352
+ A list of tools that can help automate the process of
353
+ checking MIB definitions can be found at the OPS
354
+ Area web site.
355
+
356
+ 8. Security Considerations
357
+
358
+ [[CREF16: [TEMPLATE TODO] Each internet draft that defines one or
359
+ more MIB modules MUST contain a section that discusses security
360
+ considerations relevant to those modules. This section MUST be
361
+ patterned after the latest approved template (available at the OPS
362
+ Area web site). ]]
363
+
364
+ [[CREF17: [TEMPLATE TODO] if you have any read-write and/or read-
365
+ create objects, please describe their specific sensitivity or
366
+ vulnerability. RFC 2669 has a very good example. ]]
367
+
368
+ There are a number of management objects defined in this MIB module
369
+ with a MAX-ACCESS clause of read-write and/or read-create. Such
370
+ objects may be considered sensitive or vulnerable in some network
371
+ environments. The support for SET operations in a non-secure
372
+ environment without proper protection can have a negative effect on
373
+ network operations. These are the tables and objects and their
374
+ sensitivity/vulnerability:
375
+
376
+ o
377
+
378
+ [[CREF18: [TEMPLATE TODO] else if there are no read-write or read-
379
+ create objects in your MIB module, use the following boilerplate
380
+ paragraph.]]
381
+
382
+ There are no management objects defined in this MIB module that have
383
+ a MAX-ACCESS clause of read-write and/or read-create. So, if this
384
+ MIB module is implemented correctly, then there is no risk that an
385
+ intruder can alter or create any management objects of this MIB
386
+ module via direct SNMP SET operations.
387
+
388
+
389
+
390
+
391
+
392
+ Name Expires July 4, 2008 [Page 7]
393
+
394
+ Internet-Draft Your MIB Module document name January 2008
395
+
396
+
397
+ [[CREF19: For all MIB modules you must evaluate whether any readable
398
+ objects are sensitive or vulnerable (for instance, if they might
399
+ reveal customer information or violate personal privacy laws such as
400
+ those of the European Union if exposed to unathorized parties).]]
401
+
402
+ Some of the readable objects in this MIB module (i.e., objects with a
403
+ MAX-ACCESS other than not-accessible) may be considered sensitive or
404
+ vulnerable in some network environments. It is thus important to
405
+ control even GET and/or NOTIFY access to these objects and possibly
406
+ to even encrypt the values of these objects when sending them over
407
+ the network via SNMP. These are the tables and objects and their
408
+ sensitivity/vulnerability:
409
+
410
+ o
411
+
412
+ o [[CREF20: [TEMPLATE TODO] you should explicitly list by name any
413
+ readable objects that are sensitive or vulnerable and the
414
+ associated security risks should be spelled out.]]
415
+
416
+ [[CREF21: [TEMPLATE TODO] The following three boilerplate paragraphs
417
+ should not be changed without very good reason. Changes will almost
418
+ certainly require justification during IESG review.]]
419
+
420
+ SNMP versions prior to SNMPv3 did not include adequate security.
421
+ Even if the network itself is secure (for example by using IPsec),
422
+ there is no control as to who on the secure network is allowed to
423
+ access and GET/SET (read/change/create/delete) the objects in this
424
+ MIB module.
425
+
426
+ Implementations SHOULD provide the security features described by the
427
+ SNMPv3 framework (see [RFC3410]), and implementations claiming
428
+ compliance to the SNMPv3 standard MUST include full support for
429
+ authentication and privacy via the User-based Security Model (USM)
430
+ [RFC3414] with the AES cipher algorithm [RFC3826]. Implementations
431
+ MAY also provide support for the Transport Security Model (TSM)
432
+ [RFC5591] in combination with a secure transport such as SSH
433
+ [RFC5592] or TLS/DTLS [RFC6353].
434
+
435
+ Further, deployment of SNMP versions prior to SNMPv3 is NOT
436
+ RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to
437
+ enable cryptographic security. It is then a customer/operator
438
+ responsibility to ensure that the SNMP entity giving access to an
439
+ instance of this MIB module is properly configured to give access to
440
+ the objects only to those principals (users) that have legitimate
441
+ rights to indeed GET or SET (change/create/delete) them.
442
+
443
+
444
+
445
+
446
+
447
+
448
+ Name Expires July 4, 2008 [Page 8]
449
+
450
+ Internet-Draft Your MIB Module document name January 2008
451
+
452
+
453
+ 9. IANA Considerations
454
+
455
+ [[CREF22: [TEMPLATE TODO] In order to comply with IESG policy as set
456
+ forth in http://www.ietf.org/ID-Checklist.html, every Internet-Draft
457
+ that is submitted to the IESG for publication MUST contain an IANA
458
+ Considerations section. The requirements for this section vary
459
+ depending what actions are required of the IANA. See "Guidelines for
460
+ Writing an IANA Considerations Section in RFCs" [RFC2434]. and see
461
+ RFC4181 section 3.5 for more information on writing an IANA clause
462
+ for a MIB module internet draft.]]
463
+
464
+ Option #1:
465
+
466
+ The MIB module in this document uses the following IANA-assigned
467
+ OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
468
+
469
+ Descriptor OBJECT IDENTIFIER value
470
+ ---------- -----------------------
471
+ sampleMIB { mib-2 XXX }
472
+
473
+ Option #2:
474
+
475
+ Editor's Note (to be removed prior to publication): the IANA is
476
+ requested to assign a value for "XXX" under the 'mib-2' subtree and
477
+ to record the assignment in the SMI Numbers registry. When the
478
+ assignment has been made, the RFC Editor is asked to replace "XXX"
479
+ (here and in the MIB module) with the assigned value and to remove
480
+ this note.
481
+
482
+ Note well: prior to official assignment by the IANA, an internet
483
+ draft MUST use placeholders (such as "XXX" above) rather than actual
484
+ numbers. See RFC4181 Section 4.5 for an example of how this is done
485
+ in an internet draft MIB module.
486
+
487
+ Option #3:
488
+
489
+ This memo includes no request to IANA.
490
+
491
+ 10. Contributors
492
+
493
+ 11. References
494
+
495
+ 11.1. Normative References
496
+
497
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
498
+ Requirement Levels", BCP 14, RFC 2119,
499
+ DOI 10.17487/RFC2119, March 1997,
500
+ <https://www.rfc-editor.org/info/rfc2119>.
501
+
502
+
503
+
504
+ Name Expires July 4, 2008 [Page 9]
505
+
506
+ Internet-Draft Your MIB Module document name January 2008
507
+
508
+
509
+ [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J.
510
+ Schoenwaelder, Ed., "Structure of Management Information
511
+ Version 2 (SMIv2)", STD 58, RFC 2578,
512
+ DOI 10.17487/RFC2578, April 1999,
513
+ <https://www.rfc-editor.org/info/rfc2578>.
514
+
515
+ [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J.
516
+ Schoenwaelder, Ed., "Textual Conventions for SMIv2",
517
+ STD 58, RFC 2579, DOI 10.17487/RFC2579, April 1999,
518
+ <https://www.rfc-editor.org/info/rfc2579>.
519
+
520
+ [RFC2580] McCloghrie, K., Ed., Perkins, D., Ed., and J.
521
+ Schoenwaelder, Ed., "Conformance Statements for SMIv2",
522
+ STD 58, RFC 2580, DOI 10.17487/RFC2580, April 1999,
523
+ <https://www.rfc-editor.org/info/rfc2580>.
524
+
525
+ 11.2. Informative References
526
+
527
+ [RFC2223] Postel, J. and J. Reynolds, "Instructions to RFC Authors",
528
+ RFC 2223, DOI 10.17487/RFC2223, October 1997,
529
+ <https://www.rfc-editor.org/info/rfc2223>.
530
+
531
+ [RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629,
532
+ DOI 10.17487/RFC2629, June 1999,
533
+ <https://www.rfc-editor.org/info/rfc2629>.
534
+
535
+ [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart,
536
+ "Introduction and Applicability Statements for Internet-
537
+ Standard Management Framework", RFC 3410,
538
+ DOI 10.17487/RFC3410, December 2002,
539
+ <https://www.rfc-editor.org/info/rfc3410>.
540
+
541
+ [RFC4181] Heard, C., Ed., "Guidelines for Authors and Reviewers of
542
+ MIB Documents", BCP 111, RFC 4181, DOI 10.17487/RFC4181,
543
+ September 2005, <https://www.rfc-editor.org/info/rfc4181>.
544
+
545
+ 11.3. URL References
546
+
547
+ [idguidelines]
548
+ IETF Internet Drafts editor,
549
+ "http://www.ietf.org/ietf/1id-guidelines.txt".
550
+
551
+ [idnits] IETF Internet Drafts editor,
552
+ "http://www.ietf.org/ID-Checklist.html".
553
+
554
+ [ietf] IETF Tools Team, "http://tools.ietf.org".
555
+
556
+ [ops] the IETF OPS Area, "http://www.ops.ietf.org".
557
+
558
+
559
+
560
+ Name Expires July 4, 2008 [Page 10]
561
+
562
+ Internet-Draft Your MIB Module document name January 2008
563
+
564
+
565
+ [xml2rfc] XML2RFC tools and documentation,
566
+ "http://xml.resource.org".
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
+ Name Expires July 4, 2008 [Page 11]
617
+
618
+ Internet-Draft Your MIB Module document name January 2008
619
+
620
+
621
+ Appendix A. Change Log
622
+
623
+ Note to RFC Editor: if this document does not obsolete an existing
624
+ RFC, please remove this appendix before publication as an RFC.
625
+
626
+ Appendix B. Open Issues
627
+
628
+ Note to RFC Editor: please remove this appendix before publication as
629
+ an RFC.
630
+
631
+ Author's Address
632
+
633
+ Editor Name (editor)
634
+ Editor affiliation
635
+ Editor affiliation address
636
+ Editor affiliation address
637
+ Editor affiliation address
638
+
639
+ Phone: Editor address
640
+ EMail: Editor email
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
+ Name Expires July 4, 2008 [Page 12]