draft-ietf-tsvwg-rsvp-user-error-spec-05.txt   draft-ietf-tsvwg-rsvp-user-error-spec-06.txt 
Network Working Group G. Swallow Network Working Group G. Swallow
Internet-Draft Cisco Systems, Inc. Internet-Draft Cisco Systems, Inc.
Category: Standards Track Category: Standards Track
Created: April 1, 2008 A. Farrel Created: April 5, 2008 A. Farrel
Expiration Date: October 1, 2008 Old Dog Consulting Expiration Date: October 5, 2008 Old Dog Consulting
User-Defined Errors for RSVP User-Defined Errors for RSVP
draft-ietf-tsvwg-rsvp-user-error-spec-05.txt draft-ietf-tsvwg-rsvp-user-error-spec-06.txt
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79. aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
skipping to change at page 2, line 9 skipping to change at page 2, line 9
defining new error codes. Further, no provision for user-defined defining new error codes. Further, no provision for user-defined
errors exists in RSVP. errors exists in RSVP.
This document defines a USER_ERROR_SPEC to be used in addition to the This document defines a USER_ERROR_SPEC to be used in addition to the
ERROR_SPEC to carry additional user information related to errors. ERROR_SPEC to carry additional user information related to errors.
0. Changes Since Last Revision 0. Changes Since Last Revision
[This section to be removed before publication as an RFC.] [This section to be removed before publication as an RFC.]
- Clarify that Error Description may be empty. - Add names to acknowledgments.
- Clarify that the Error Description String does not contain
information critical to network operation.
- Define an Error Value of zero to accompany the Error Code of
"User Error Spec".
1. Introduction 1. Introduction
The Resource ReserVation Protocol (RSVP) [RFC2205] defines an The Resource ReserVation Protocol (RSVP) [RFC2205] defines an
ERROR_SPEC object for communicating errors. That object has a ERROR_SPEC object for communicating errors. That object has a
defined format that permits the definition of 256 error codes. As defined format that permits the definition of 256 error codes. As
RSVP has been developed and extended, the convention has been to be RSVP has been developed and extended, the convention has been to be
conservative in communicating errors. Further no provision for user conservative in communicating errors. Further no provision for user
defined errors exists in RSVP. defined errors exists in RSVP.
skipping to change at page 3, line 12 skipping to change at page 3, line 12
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
2. User-Defined Error 2. User-Defined Error
A new Error Code is defined for use in an ERROR_SPEC object. A new Error Code is defined for use in an ERROR_SPEC object.
Error Code = <tba-xxx>: User Error Spec Error Code = <tba-xxx>: User Error Spec
This error code is used to signal the presence of a This error code is used to signal the presence of a
USER_ERROR_SPEC. No Error Values are defined. USER_ERROR_SPEC. One Error Value is defined as follows.
Error Value 0 = Further details in User Error Spec
Further error values may be defined in future specifications.
When sending this error code, a USER_ERROR_SPEC object MUST be When sending this error code, a USER_ERROR_SPEC object MUST be
included in the PathErr, ResvErr, or Notify message. included in the PathErr, ResvErr, or Notify message.
[RFC Editor's note: <tba-xxx> = to be assigned by IANA as per Section 5. [RFC Editor's note: <tba-xxx> = to be assigned by IANA as per Section 5.
Please replace <tba-xxx> with the number assigned by IANA and remove Please replace <tba-xxx> with the number assigned by IANA and remove
this note.] this note.]
3. USER_ERROR_SPEC Class 3. USER_ERROR_SPEC Class
skipping to change at page 4, line 32 skipping to change at page 4, line 37
A 16-bit integer. The meaning is specified by the A 16-bit integer. The meaning is specified by the
(sub-)organization indicated by the Enterprise Number and Sub (sub-)organization indicated by the Enterprise Number and Sub
Org fields. Org fields.
Error Description Error Description
A string of characters in US-ASCII padded with nulls (0x00) A string of characters in US-ASCII padded with nulls (0x00)
to a multiple of 4 bytes. If the Err Desc Len is zero then to a multiple of 4 bytes. If the Err Desc Len is zero then
no bytes are supplied. no bytes are supplied.
Note that the content of this field might not be shown to all
users in all implementations (because it is limited to
US-ASCII). Therefore, it SHOULD be limited to supplementary
information and SHOULD NOT contain information critical to
operating the network. Criticial information is present in the
User Error Value field.
User-Defined Subobjects User-Defined Subobjects
User-defined subobjects MAY be included. The generic format of User-defined subobjects MAY be included. The generic format of
subobjects is specified in Section 3.1. The semantics of a subobjects is specified in Section 3.1. The semantics of a
subobject is indicated by the Type field, but the semantics, subobject is indicated by the Type field, but the semantics,
format and contents of the Value field are specified by the format and contents of the Value field are specified by the
(sub-)organization indicated by the Enterprise Number and (sub-)organization indicated by the Enterprise Number and
Sub Org fields of this object. Sub Org fields of this object.
3.1. Subobjects 3.1. Subobjects
skipping to change at page 5, line 29 skipping to change at page 5, line 40
A USER_ERROR_SPEC object MAY be included in any PathErr, ResvErr, or A USER_ERROR_SPEC object MAY be included in any PathErr, ResvErr, or
Notify message for any defined error code. The Enterprise Number Notify message for any defined error code. The Enterprise Number
MUST be a valid value assigned by IANA. MUST be a valid value assigned by IANA.
As specified in [RFC2205] and [RFC3473], an ERROR_SPEC object with a As specified in [RFC2205] and [RFC3473], an ERROR_SPEC object with a
valid error code MUST be included in all PathErr, ResvErr, and Notify valid error code MUST be included in all PathErr, ResvErr, and Notify
messages. This rule is not changed by these procedures even when a messages. This rule is not changed by these procedures even when a
USER_ERROR_SPEC object is included. If no other error code applies, USER_ERROR_SPEC object is included. If no other error code applies,
the Error Code in the ERROR_SPEC object MUST be set to "User Error the Error Code in the ERROR_SPEC object MUST be set to "User Error
Spec" as defined in Section 2 of this document. Spec" as defined in Section 2 of this document. When the Error Code
in the ERROR_SPEC object is set to "User Error Spec", the Error Value
sub-code SHOULD be set to "Further details in User Error Spec" as
defined in Section 2, but further Error Value sub-codes may be
defined in future specifications.
4.2. Procedures for Receiving the User Error Spec 4.2. Procedures for Receiving the User Error Spec
It is RECOMMENDED that implementations that receive a PathErr, It is RECOMMENDED that implementations that receive a PathErr,
ResvErr, or Notify message carrying a USER_ERROR_SPEC object at a ResvErr, or Notify message carrying a USER_ERROR_SPEC object at a
minimum log the Enterprise Number, Sub-organization, User Error minimum log the Enterprise Number, Sub-organization, User Error
Value, and Error Description. Implementations capable of Value, and Error Description. Note that the Error Description is
provided in US-ASCII which means that it might not be suitable for
display of logging in all systems. Implementations capable of
interpreting the contents of the USER_ERROR_SPEC object should take interpreting the contents of the USER_ERROR_SPEC object should take
further action based on the reported error. further action based on the reported error.
If a message is received containing an ERROR_SPEC object using the If a message is received containing an ERROR_SPEC object using the
"User Error Spec" error code, but not containing a USER_ERROR_SPEC "User Error Spec" error code, but not containing a USER_ERROR_SPEC
object, the message MUST be treated as malformed and handled object, the message MUST be treated as malformed and handled
according to [RFC2205]. according to [RFC2205].
Implementations SHOULD ignore repeated occurences of USER_ERROR_SPEC Implementations SHOULD ignore repeated occurences of USER_ERROR_SPEC
objects, and SHOULD forward them unchanged on any messages that they objects, and SHOULD forward them unchanged on any messages that they
forward. This provides for forward compatiblity. forward. This provides for forward compatiblity.
Implementations receiving a USER_ERROR_SPEC object on some message Implementations receiving a USER_ERROR_SPEC object on some message
other than a PathErr, ResvErr, or Notify message MUST treat the other than a PathErr, ResvErr, or Notify message MUST treat the
error as a malformed message and process according to [RFC2205]. error as a malformed message and process according to [RFC2205].
5. IANA Considerations 5. IANA Considerations
5.1. RSVP Error Codes
This document makes the following assignments from the RSVP Error This document makes the following assignments from the RSVP Error
Codes and Globally-Defined Error Value Sub-Codes registry (pending Codes and Globally-Defined Error Value Sub-Codes registry (pending
IANA action): IANA action):
Value Name Error Code Meaning
<tba-xxx> User Error Spec <tba-xxx> User Error Spec
One Error Value sub-code is defined for use with this Error Code as
follows:
0 = Further details in User Error Spec
5.2. RSVP Objects
This document makes the following assignments from the RSVP Class This document makes the following assignments from the RSVP Class
Names, Class Numbers, and Class Types registry (pending IANA action): Names, Class Numbers, and Class Types registry (pending IANA action):
Number Space Value Name Number Space Value Name
Class Numbers <tba-yyy>* User Error Spec Class Numbers <tba-yyy>* User Error Spec
Class Type 1 User-Defined Error Class Type 1 User-Defined Error
* Assignment is requested from the range 192 through 247 * Assignment is requested from the range 192 through 247
skipping to change at page 6, line 40 skipping to change at page 7, line 19
number of error messages sent in cases where messages were previously number of error messages sent in cases where messages were previously
silently dropped due to the lack of an appropriate error code. silently dropped due to the lack of an appropriate error code.
The mechanisms defined in this document may be used by The mechanisms defined in this document may be used by
implementations to report additional error conditions and information implementations to report additional error conditions and information
arising from security issues and attacks on the RSVP network. arising from security issues and attacks on the RSVP network.
7. Acknowledgments 7. Acknowledgments
The authors would like to thank Elisheva Halevy for motivating this The authors would like to thank Elisheva Halevy for motivating this
document. Thanks to Tom Nadeau, Magnus Westerlund, and Hannes document. Thanks to Tom Nadeau, Magnus Westerlund, Hannes
Tschofenig for their review and comments. Tschofenig, Bruce Davie, Jukka Manner, Francois Le Faucheur, and Lars
Eggert for their review and comments.
8. References 8. References
8.1. Normative References 8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2205] Braden, R., Zhang, L., Berson, S., Herzog, S., and S. [RFC2205] Braden, R., Zhang, L., Berson, S., Herzog, S., and S.
Jamin, "Resource ReSerVation Protocol (RSVP) -- Version 1 Jamin, "Resource ReSerVation Protocol (RSVP) -- Version 1
 End of changes. 11 change blocks. 
10 lines changed or deleted 41 lines changed or added

This html diff was produced by rfcdiff 1.34. The latest version is available from http://tools.ietf.org/tools/rfcdiff/