Network Working Group M. Daniele Internet-Draft Compaq Computer Corporation Expires: November 27, 2000 J. Schoenwaelder TU Braunschweig May 29, 2000 Textual Conventions for Transport Addresses draft-ops-taddress-mib-00.txt Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." To view the entire list of Internet-Draft Shadow Directories, see http://www.ietf.org/shadow.html. The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/iid-abstracts.txt This Internet-Draft will expire on November 27, 2000. Copyright Notice Copyright (C) The Internet Society (2000). All Rights Reserved. Abstract This document contains a MIB module for commonly used transport layer addressing information. It defines a registry for identifiers that identify protocols and a set of textual conventions for representing addresses. This document also establishes IANA as the maintainer of this registry. This work is output from the Operations and Management Area "IPv6MIB" design team. Daniele & Schoenwaelder Expires November 27, 2000 [Page 1] Internet-Draft TCs for Transport Addresses May 2000 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. The SNMP Management Framework . . . . . . . . . . . . . . . . 3 3. Transport Domains and Addresses . . . . . . . . . . . . . . . 4 4. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 5 5. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 7. Security Considerations . . . . . . . . . . . . . . . . . . . 11 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 11 9. Intellectual Property Notice . . . . . . . . . . . . . . . . . 12 References . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 14 A. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 14 Full Copyright Statement . . . . . . . . . . . . . . . . . . . 15 Daniele & Schoenwaelder Expires November 27, 2000 [Page 2] Internet-Draft TCs for Transport Addresses May 2000 1. Introduction This MIB module contains definitions for commonly used transport layer addressing information. In particular, it defines a registry of OBJECT-IDENTIFIERs for transport protocols, and a set of textual conventions for representing transport layer endpoints. The former are intended to be widely used as values for MIB objects whose syntax is TDomain [7], the latter as values for MIB objects whose syntax is TAddress [7]. The purpose of this memo is to provide a single, well-known repository for transport layer address-related information. Further, this document establishes the Internet Assigned Numbers Authority (IANA) as the maintainer of these definitions (see Section 6). Without such a repository, each MIB module requiring addressing constructs is forced to either define its own, or attempt to locate and include similar definitions from other modules. The advantages of a repository are 1. there is a single set of definitions 2. all MIB developers know what to include, and where to look 3. multiple definitions of the same information is avoided 4. the definitions are independent and widely usable, not tied to a particular protocol, MIB module, or enterprise 5. this module can be updated independently, and hence much more rapidly, than if the information is defined in broader RFCs on the standards-track (for example, RFC 1906 [11]. This memo also defines a new textual convention IanaTAddressType for registering protocols using an enumerated INTEGER base type. The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT" and "MAY" in this document are to be interpreted as described in RFC 2119 [1]. 2. The SNMP Management Framework The SNMP Management Framework presently consists of five major components: o An overall architecture, described in RFC 2571 [2]. o Mechanisms for describing and naming objects and events for the purpose of management. The first version of this Structure of Management Information (SMI) is called SMIv1 and described in STD 16, RFC 1155 [3], STD 16, RFC 1212 [4] and RFC 1215 [5]. The second version, called SMIv2, is described in STD 58, RFC 2578 [6], STD 58, RFC 2579 [7] and STD 58, RFC 2580 [8]. o Message protocols for transferring management information. The first version of the SNMP message protocol is called SNMPv1 and described in STD 15, RFC 1157 [9]. A second version of the SNMP message protocol, which is not an Internet standards track Daniele & Schoenwaelder Expires November 27, 2000 [Page 3] Internet-Draft TCs for Transport Addresses May 2000 protocol, is called SNMPv2c and described in RFC 1901 [10] and RFC 1906 [11]. The third version of the message protocol is called SNMPv3 and described in RFC 1906 [11], RFC 2572 [12] and RFC 2574 [13]. o Protocol operations for accessing management information. The first set of protocol operations and associated PDU formats is described in STD 15, RFC 1157 [9]. A second set of protocol operations and associated PDU formats is described in RFC 1905 [14]. o A set of fundamental applications described in RFC 2573 [15] and the view-based access control mechanism described in RFC 2575 [16]. A more detailed introduction to the current SNMP Management Framework can be found in RFC 2570 [17]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. Objects in the MIB are defined using the mechanisms defined in the SMI. This memo specifies a MIB module that is compliant to the SMIv2. A MIB conforming to the SMIv1 can be produced through the appropriate translations. The resulting translated MIB must be semantically equivalent, except where objects or events are omitted because no translation is possible (use of Counter64). Some machine readable information in SMIv2 will be converted into textual descriptions in SMIv1 during the translation process. However, this loss of machine readable information is not considered to change the semantics of the MIB. 3. Transport Domains and Addresses The TDomain and TAddress textual conventions are defined in RFC 2579 [7], and are intended to be used in MIB modules to represent transport domains and addresses. Actual values for object definitions with these syntaxes are currently defined in RFC 1906 [11] and various other (enterprise-specific) modules. The transport domains defined in RFC 1906 [11] all contain "snmp" as the prefix in their name and are registered under `snmpDomains' (from RFC 2578 [6]). There has been some confusion as to whether these definitions are appropriate for designating transport endpoints for non-SNMP traffic. These definitions are also now incomplete, new transport addresses are needed currently to support (at least) TCP-over-IPv6, UDP-over-IPv6, and Posix Local IPC domain sockets (formerly known as UNIX domain sockets). This module defines a new set of generic transport domains and addresses. All assignments are administered by IANA. Daniele & Schoenwaelder Expires November 27, 2000 [Page 4] Internet-Draft TCs for Transport Addresses May 2000 This module does NOT define the transport mappings for any particular protocol. Rather, it defines a set of common identifiers and textual conventions that are intended to be used within various transport mappings documents. (Inclusion within transport mappings documents is just one possible use of these generic definitions.) 4. Definitions IANA-TADDRESS-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-IDENTITY, mib-2 FROM SNMPv2-SMI TEXTUAL-CONVENTION FROM SNMPv2-TC; ianaTAddressMIB MODULE-IDENTITY LAST-UPDATED "200005260000Z" ORGANIZATION "Internet Assigned Numbers Authority (IANA)" CONTACT-INFO "Internet Assigned Numbers Authority Internet Corporation for Assigned Names and Numbers 4676 Admiralty Way, Suite 330 Marina del Rey, CA 90292-6601 USA Phone: +1 310-823-9358 EMail: iana@iana.org" DESCRIPTION "This MIB module provides commonly-used transport address definitions." REVISION "200005260000Z" DESCRIPTION "Initial version, published as RFC XXXX." ::= { mib-2 XXXX } -- to be assigned by IANA -- -- Transport protocol domains: -- ianaTDomains OBJECT IDENTIFIER ::= { ianaTAddressMIB 1 } ianaTDomainUdpIpv4 OBJECT-IDENTITY STATUS current DESCRIPTION "The UDP over IPv4 transport domain. The corresponding transport address is of type IanaTAddressIPv4." ::= { ianaTDomains 1 } ianaTDomainUdpIpv6 OBJECT-IDENTITY Daniele & Schoenwaelder Expires November 27, 2000 [Page 5] Internet-Draft TCs for Transport Addresses May 2000 STATUS current DESCRIPTION "The UDP over IPv6 transport domain. The corresponding transport address is of type IanaTAddressIPv6 for global IPv6 addresses and IanaTAddressIPv6s for scoped IPv6 addresses." ::= { ianaTDomains 2 } ianaTDomainTcpIpv4 OBJECT-IDENTITY STATUS current DESCRIPTION "The TCP over IPv4 transport domain. The corresponding transport address is of type IanaTAddressIPv4." ::= { ianaTDomains 3 } ianaTDomainTcpIpv6 OBJECT-IDENTITY STATUS current DESCRIPTION "The TCP over IPv6 transport domain. The corresponding transport address is of type IanaTAddressIPv6 for global IPv6 addresses and IanaTAddressIPv6s for scoped IPv6 addresses." ::= { ianaTDomains 4 } ianaTDomainLocal OBJECT-IDENTITY STATUS current DESCRIPTION "The Posix Local IPC transport domain. The corresponding transport address is of type IanaTAddressLocal. The Posix Local IPC transport domain incorporates the well known UNIX domain sockets." ::= { ianaTDomains 5 } ianaTDomainClns OBJECT-IDENTITY STATUS current DESCRIPTION "The CLNS transport domain. The corresponding transport address is of type IanaTAddressOSI." ::= { ianaTDomains 6 } ianaTDomainCons OBJECT-IDENTITY STATUS current DESCRIPTION "The CONS transport domain. The corresponding transport address is of type IanaTAddressOSI." ::= { ianaTDomains 7 } ianaTDomainDdp OBJECT-IDENTITY Daniele & Schoenwaelder Expires November 27, 2000 [Page 6] Internet-Draft TCs for Transport Addresses May 2000 STATUS current DESCRIPTION "The DDP transport domain. The corresponding transport address is of type IanaTAddressNBP." ::= { ianaTDomains 8 } ianaTDomainIpx OBJECT-IDENTITY STATUS current DESCRIPTION "The IPX transport domain. The corresponding transport address is of type IanaTAddressIPX." ::= { ianaTDomains 9 } -- -- Textual convention for the transport address types/domains. -- -- The enumerated values of this textual convention SHOULD be -- identical to the last sub-identifier of the OID registered -- for the same domain. -- IanaTAddressType ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Denotes a kind of transport service. This is the enumerated version of the transport domain registrations in this MIB module. The enumerated values have the following meaning: unknown(0) An unknown transport address type. udpIpv4(1) UDP-over-IPv4 (ianaTDomainUdpIpv4) udpIpv6(2) UDP-over-IPv6 (ianaTDomainUdpIpv6) tcpIpv4(3) TCP-over-IPv4 (ianaTDomainTcpIpv4) tcpIpv6(4) TCP-over-IPv6 (ianaTDomainTcpIpv6) local(5) POSIX Local IPC (ianaTDomainLocal) clns(6) OSI CLNS (ianaTDomainClns) cons(7) OSI CONS (ianaTDomainCons) ddp(8) Appltalk DDP (ianaTDomainDdp) ipx(9) IPX (ianaTDomainIpx) Daniele & Schoenwaelder Expires November 27, 2000 [Page 7] Internet-Draft TCs for Transport Addresses May 2000 This textual convention can be used to represent transport domains in situations where a syntax of TDomain is unwieldy (for example, when used as an index)." SYNTAX INTEGER { other(0), udpIpv4(1), udpIpv6(2), tcpIpv4(3), tcpIpv6(4), local(5), clns(6), cons(7), ddp(8), ipx(9) } -- -- Textual conventions for transport endpoints: -- IanaTAddressIPv4 ::= TEXTUAL-CONVENTION DISPLAY-HINT "1d.1d.1d.1d:2d" STATUS current DESCRIPTION "Represents a TCP-over-IPv4 or a UDP-over-IPv4 transport address: octets contents encoding 1-4 IPv4 addres network-byte order 5-6 TCP or UDP port network-byte order" SYNTAX OCTET STRING (SIZE (6)) IanaTAddressIPv6 ::= TEXTUAL-CONVENTION DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x]0a:2d" STATUS current DESCRIPTION "Represents a TCP-over-IPv6 or a UDP-over-IPv6 transport address for global IPv6 addresses: octets contents encoding 1-16 IPv6 address network-byte order 17-18 TCP or UDP port network-byte order" REFERENCE "IP Version 6 Addressing Architecture (RFC 2373)" SYNTAX OCTET STRING (SIZE (18)) IanaTAddressIPv6s ::= TEXTUAL-CONVENTION DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x%4d]0a:2d" STATUS current Daniele & Schoenwaelder Expires November 27, 2000 [Page 8] Internet-Draft TCs for Transport Addresses May 2000 DESCRIPTION "Represents a TCP-over-IPv6 or a UDP-over-IPv6 transport address for scoped IPv6 addresses: octets contents encoding 1-16 IPv6 address network-byte order 17-20 scope identifier network-byte order 21-22 TCP or UDP port network-byte order" REFERENCE "IP Version 6 Addressing Architecture (RFC 2373)" SYNTAX OCTET STRING (SIZE (22)) IanaTAddressLocal ::= TEXTUAL-CONVENTION DISPLAY-HINT "1a" STATUS current DESCRIPTION "Represents a POSIX Local IPC transport address: octets contents encoding all POSIX Local IPC address string The Posix Local IPC transport domain subsumes UNIX domain sockets." REFERENCE "Protocol Independent Interfaces (IEEE POSIX 1003.1g)" SYNTAX OCTET STRING (SIZE (1..255)) IanaTAddressOSI ::= TEXTUAL-CONVENTION DISPLAY-HINT "*1x:/1x:" STATUS current DESCRIPTION "Represents an OSI transport-address: octets contents encoding 1 length of NSAP 'n' as an unsigned-integer (either 0 or from 3 to 20) 2..(n+1) NSAP concrete binary representation (n+2)..m TSEL string of (up to 64) octets" SYNTAX OCTET STRING (SIZE (1 | 4..85)) IanaTAddressNBP ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Represents an NBP name: octets contents encoding 1 length of object 'n' as an unsigned integer 2..(n+1) object string of (up to 32) octets n+2 length of type 'p' as an unsigned integer Daniele & Schoenwaelder Expires November 27, 2000 [Page 9] Internet-Draft TCs for Transport Addresses May 2000 (n+3)..(n+2+p) type string of (up to 32) octets n+3+p length of zone 'q' as an unsigned integer (n+4+p)..(n+3+p+q) zone string of (up to 32) octets For comparison purposes, strings are case-insensitive. All strings may contain any octet other than 255 (hex ff)." SYNTAX OCTET STRING (SIZE (3..99)) IanaTAddressIPX ::= TEXTUAL-CONVENTION DISPLAY-HINT "4x.1x:1x:1x:1x:1x:1x.2d" STATUS current DESCRIPTION "Represents an IPX address: octets contents encoding 1-4 network-number network-byte order 5-10 physical-address network-byte order 11-12 socket-number network-byte order" SYNTAX OCTET STRING (SIZE (12)) END 5. Examples This section shows some examples how transport addresses are encoded and rendered using some of the initial transport domain and address definitions. Daniele & Schoenwaelder Expires November 27, 2000 [Page 10] Internet-Draft TCs for Transport Addresses May 2000 Description: Unspecified IPv4 address on port 80. Encoding: 000000000050 Display: 0.0.0.0:80 Description: Global IPv4 address on port 80. Encoding: 86A922010050 Display: 134.169.34.1:80 Description: Unspecified IPv6 address on port 80. Encoding: 000000000000000000000000000000000050 Display: [0:0:0:0:0:0:0:0]:80 Description: Global IPv6 address on port 80. Encoding: 108000000000000000080800200C417A0050 Display: [1080:0:0:0:8:800:200C:417A]:80 Description: Scoped IPv6 address on port 80. Encoding: 3FFE04000090000200010000000002000000002A0050 Display: [3FFE:400:90:2:1:0:0:200%42]:80 Description: Posix Local IPC address (UNIX domain). Encoding: 2F612F676E786D7365 Display: /var/agentx/master 6. IANA Considerations It is intended that IANA will maintain this MIB module. Following the policies outlined in RFC 2434 [18], additions to this module MUST be reviewed by a Designated Expert. 7. Security Considerations This MIB module defines assigned values for commonly used transport addressing domains, and a set of textual conventions. It does not define any MIB objects that actually contain management information. As such, there are no security considerations for this MIB module. 8. Acknowledgments Some of the definitions in this module are taken directly from RFC 1906 [11]. The authors would like to thank Mark Ellison, Brian Haberman, and Bill Strahm for their comments and suggestions. Daniele & Schoenwaelder Expires November 27, 2000 [Page 11] Internet-Draft TCs for Transport Addresses May 2000 9. Intellectual Property Notice The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such propritary rights by implementors or users of this specification can be obtained from the IETF Secretariat. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. References [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [2] Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture for Describing SNMP Management Frameworks", RFC 2571, April 1999. [3] Rose, M. and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based Internets", STD 16, RFC 1155, May 1990. [4] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1212, March 1991. [5] Rose, M., "A Convention for Defining Traps for use with the SNMP", RFC 1215, March 1991. [6] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [7] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [8] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, Daniele & Schoenwaelder Expires November 27, 2000 [Page 12] Internet-Draft TCs for Transport Addresses May 2000 M. and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. [9] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "A Simple Network Management Protocol (SNMP)", STD 15, RFC 1157, May 1990. [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC 1901, January 1996. [11] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1906, January 1996. [12] Case, J., Harrington, D., Presuhn, R. and B. Wijnen, "Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)", RFC 2572, April 1999. [13] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 2574, April 1999. [14] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1905, January 1996. [15] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC 2573, April 1999. [16] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 2575, April 1999. [17] Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction to Version 3 of the Internet-standard Network Management Framework", RFC 2570, April 1999. [18] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs.", BCP 26, RFC 2434, October 1998. [19] Hinden, R. and S. Deering, "IP Version 6 Addressing Architecture", RFC 2373, July 1998. [20] IEEE, "Protocol Independent Interfaces", IEEE Std 1003.1g, DRAFT 6.6, March 1997. Daniele & Schoenwaelder Expires November 27, 2000 [Page 13] Internet-Draft TCs for Transport Addresses May 2000 Authors' Addresses Mike Daniele Compaq Computer Corporation 110 Spit Brook Rd Nashua, NH 03062 USA Phone: +1 603 884-1423 EMail: daniele@zk3.dec.com Juergen Schoenwaelder TU Braunschweig Bueltenweg 74/75 38106 Braunschweig Germany Phone: +49 531 391-3289 EMail: schoenw@ibr.cs.tu-bs.de Appendix A. Open Issues 1. Provide suitable domain and TC definitions for DNS names, e.g. www.tu-bs.de:80? 2. This version adopts a URL format wherever possible, e.g. 10.1.2.3:80 instead of 10.1.2.3/80 for IPv4 and [00:00:00:00:0A:01:02:03]:80 instead of 00:00:00:00:0A:01:02:03/80 for IPv6 (RFC 2732). Is this useful? Are the DISPLAY-HINT to achieve the desired output format acceptable? 3. Need to find experts to review the TC definitions for protocols we are not familiar with. 4. Add references and REFERENCE clauses for the various address formats? Probably copying stuff from RFC 1906? Are they still valid? 5. More explicit guidelines on the usage of the IanaTAddressType TC, similar to what is in the INET-ADDRESS-MIB document? 6. More precise guidelines for IANA and/or the designated expert on how to keep the various definitions in sync? 7. Keep the acknowledgements section updated. Daniele & Schoenwaelder Expires November 27, 2000 [Page 14] Internet-Draft TCs for Transport Addresses May 2000 Full Copyright Statement Copyright (C) The Internet Society (2000). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implmentation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Acknowledgement Funding for the RFC editor function is currently provided by the Internet Society. Daniele & Schoenwaelder Expires November 27, 2000 [Page 15]