contrib/bind9/doc/rfc/rfc2119.txt

   1
   2
   3
   4
   5
   6
   7 Network Working Group                                         S. Bradner
   8 Request for Comments: 2119                            Harvard University
   9 BCP: 14                                                       March 1997
  10 Category: Best Current Practice
  11
  12
  13         Key words for use in RFCs to Indicate Requirement Levels
  14
  15 Status of this Memo
  16
  17    This document specifies an Internet Best Current Practices for the
  18    Internet Community, and requests discussion and suggestions for
  19    improvements.  Distribution of this memo is unlimited.
  20
  21 Abstract
  22
  23    In many standards track documents several words are used to signify
  24    the requirements in the specification.  These words are often
  25    capitalized.  This document defines these words as they should be
  26    interpreted in IETF documents.  Authors who follow these guidelines
  27    should incorporate this phrase near the beginning of their document:
  28
  29       The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
  30       NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
  31       "OPTIONAL" in this document are to be interpreted as described in
  32       RFC 2119.
  33
  34    Note that the force of these words is modified by the requirement
  35    level of the document in which they are used.
  36
  37 1. MUST   This word, or the terms "REQUIRED" or "SHALL", mean that the
  38    definition is an absolute requirement of the specification.
  39
  40 2. MUST NOT   This phrase, or the phrase "SHALL NOT", mean that the
  41    definition is an absolute prohibition of the specification.
  42
  43 3. SHOULD   This word, or the adjective "RECOMMENDED", mean that there
  44    may exist valid reasons in particular circumstances to ignore a
  45    particular item, but the full implications must be understood and
  46    carefully weighed before choosing a different course.
  47
  48 4. SHOULD NOT   This phrase, or the phrase "NOT RECOMMENDED" mean that
  49    there may exist valid reasons in particular circumstances when the
  50    particular behavior is acceptable or even useful, but the full
  51    implications should be understood and the case carefully weighed
  52    before implementing any behavior described with this label.
  53
  54
  55
  56
  57
  58 Bradner                  Best Current Practice                  [Page 1]
  59 \f
  60 RFC 2119                     RFC Key Words                    March 1997
  61
  62
  63 5. MAY   This word, or the adjective "OPTIONAL", mean that an item is
  64    truly optional.  One vendor may choose to include the item because a
  65    particular marketplace requires it or because the vendor feels that
  66    it enhances the product while another vendor may omit the same item.
  67    An implementation which does not include a particular option MUST be
  68    prepared to interoperate with another implementation which does
  69    include the option, though perhaps with reduced functionality. In the
  70    same vein an implementation which does include a particular option
  71    MUST be prepared to interoperate with another implementation which
  72    does not include the option (except, of course, for the feature the
  73    option provides.)
  74
  75 6. Guidance in the use of these Imperatives
  76
  77    Imperatives of the type defined in this memo must be used with care
  78    and sparingly.  In particular, they MUST only be used where it is
  79    actually required for interoperation or to limit behavior which has
  80    potential for causing harm (e.g., limiting retransmisssions)  For
  81    example, they must not be used to try to impose a particular method
  82    on implementors where the method is not required for
  83    interoperability.
  84
  85 7. Security Considerations
  86
  87    These terms are frequently used to specify behavior with security
  88    implications.  The effects on security of not implementing a MUST or
  89    SHOULD, or doing something the specification says MUST NOT or SHOULD
  90    NOT be done may be very subtle. Document authors should take the time
  91    to elaborate the security implications of not following
  92    recommendations or requirements as most implementors will not have
  93    had the benefit of the experience and discussion that produced the
  94    specification.
  95
  96 8. Acknowledgments
  97
  98    The definitions of these terms are an amalgam of definitions taken
  99    from a number of RFCs.  In addition, suggestions have been
 100    incorporated from a number of people including Robert Ullmann, Thomas
 101    Narten, Neal McBurnett, and Robert Elz.
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114 Bradner                  Best Current Practice                  [Page 2]
 115 \f
 116 RFC 2119                     RFC Key Words                    March 1997
 117
 118
 119 9. Author's Address
 120
 121       Scott Bradner
 122       Harvard University
 123       1350 Mass. Ave.
 124       Cambridge, MA 02138
 125
 126       phone - +1 617 495 3864
 127
 128       email - sob@harvard.edu
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170 Bradner                  Best Current Practice                  [Page 3]
 171 \f