home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / drafts / draft_ietf_q_t / draft-ietf-snmpv3-v3mpc-model-04.txt < prev    next >
Text File  |  1997-10-01  |  100KB  |  2,850 lines
  1.  
  2.  
  3. INTERNET-DRAFT                                                   J. Case
  4.                                                      SNMP Research, Inc.
  5.                                                            D. Harrington
  6.                                                  Cabletron Systems, Inc.
  7.                                                               R. Presuhn
  8.                                                       BMC Software, Inc.
  9.                                                                B. Wijnen
  10.                                                IBM T. J. Watson Research
  11.                                                        30 September 1997
  12.  
  13.  
  14.                Message Processing and Dispatching for the
  15.                Simple Network Management Protocol (SNMP)
  16.                   <draft-ietf-snmpv3-mpc-model-04.txt>
  17.  
  18. Status of this Memo
  19.  
  20.    This document is an Internet-Draft.  Internet-Drafts are working
  21.    documents of the Internet Engineering Task Force (IETF), its areas,
  22.    and its working groups.  Note that other groups may also distribute
  23.    working documents as Internet-Drafts.
  24.  
  25.    Internet-Drafts are draft documents valid for a maximum of six months
  26.    and may be updated, replaced, or obsoleted by other documents at any
  27.    time.  It is inappropriate to use Internet-Drafts as reference
  28.    material or to cite them other than as ``work in progress.''
  29.  
  30.    To learn the current status of any Internet-Draft, please check the
  31.    ``1id-abstracts.txt'' listing contained in the Internet-Drafts Shadow
  32.    Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
  33.    munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
  34.    ftp.isi.edu (US West Coast).
  35.  
  36. Abstract
  37.  
  38.    This document describes the Message Processing and Dispatching for
  39.    SNMP messages within the SNMP architecture [SNMP-ARCH].  It defines
  40.    the procedures for dispatching potentially multiple versions of SNMP
  41.    messages to the proper SNMP Message Processing Models, and for
  42.    dispatching PDUs to SNMP applications.  This document also describes
  43.    one Message Processing Model - the SNMPv3 Message Processing Model.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54. SNMPv3 Working Group       Expires March 1998                   [Page 1]
  55.  
  56. Internet Draft     Message Processing and Dispatching  30 September 1997
  57.  
  58.  
  59. 1.  Introduction
  60.  
  61.    The Architecture for describing Internet Management Frameworks
  62.    [SNMP-ARCH] describes that an SNMP engine is composed of:
  63.  
  64.         1) a Dispatcher
  65.         2) a Message Processing Subsystem,
  66.         3) a Security Subsystem, and
  67.         4) an Access Control Subsystem.
  68.  
  69.    Applications make use of the services of these subsystems.
  70.  
  71.    It is important to understand the SNMP architecture and its
  72.    terminology to understand where the Message Processing Subsystem and
  73.    Dispatcher described in this document fit into the architecture and
  74.    interact with other subsystems within the architecture.  The reader
  75.    is expected to have read and understood the description of the SNMP
  76.    architecture, defined in [SNMP-ARCH].
  77.  
  78.    The Dispatcher in the SNMP engine sends and receives SNMP messages.
  79.    It also dispatches SNMP PDUs to SNMP applications. When an SNMP
  80.    message needs to be prepared or when data needs to be extracted from
  81.    an SNMP message, the Dispatcher delegates these tasks to a message
  82.    version-specific Message Processing Model within the Message
  83.    Processing Subsystem.
  84.  
  85.    A Message Processing Model is responsibile for processing a SNMP
  86.    version-specific message and for coordinating the interaction with
  87.    the Security Subsystem to ensure proper security is applied to the
  88.    SNMP message being handled.
  89.  
  90.    Interactions between the Dispatcher, the Message Processing
  91.    Subsystem, and applications are modelled using abstract data elements
  92.    and abstract service interface primitives defined by the SNMP
  93.    architecture.
  94.  
  95.    Similarly, interactions between the Message Processing Subsystem and
  96.    the Security Subsystem are modelled using abstract data elements and
  97.    abstract service interface primitives as defined by the SNMP
  98.    architecture.
  99.  
  100.    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  101.    "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this
  102.    document are to be interpreted as described in RFC 2119.
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110. SNMPv3 Working Group       Expires March 1998                   [Page 2]
  111.  
  112. Internet Draft     Message Processing and Dispatching  30 September 1997
  113.  
  114.  
  115.  
  116. 2.  Overview
  117.  
  118.    The following illustration depicts the Message Processing in relation
  119.    to  SNMP applications, the Security Subsystem and Transport Mappings.
  120.  
  121.    +-------------------------------------------------------------------+
  122.    | SNMP Entity                                                       |
  123.    |                                                                   |
  124.    | +---------------------------------------------------------------+ |
  125.    | | Applications                                                  | |
  126.    | | +-----------+  +--------------+                               | |
  127.    | | | Command   |  | Notification |                               | |
  128.    | | | Generator |  | Originator   | +-----------+ +--------------+| |
  129.    | | +-----------+  +--------------+ | Proxy     | | Other         | |
  130.    | | +-----------+  +--------------+ | Forwarder | |Application(s)|| |
  131.    | | | Command   |  | Notification | +-----------+ +--------------+| |
  132.    | | | Responder |  | Receiver     |                               | |
  133.    | | +-----------+  +--------------+                               | |
  134.    | +---------------------------------------------------------------+ |
  135.    |        ^                ^               ^           ^             |
  136.    |        |                |               |           |             |
  137.    |        v                v               v           v             |
  138.    |        +--------+-------+---------------+-----------+             |
  139.    |                 ^                                                 |
  140.    |                 |    +---------------------+  +-----------------+ |
  141.    |                 |    | Message Processing  |  | Security        | |
  142.    | Dispatcher      v    | Subsystem           |  | Subsystem       | |
  143.    | +------------------+ |     +------------+  |  |                 | |
  144.    | | PDU Dispatcher   | |  +->| v1MP     * |<--->| +-------------+ | |
  145.    | |                  | |  |  +------------+  |  | | Other       | | |
  146.    | |                  | |  |  +------------+  |  | | Security    | | |
  147.    | |                  | |  +->| v2cMP    * |<--->| | Model       | | |
  148.    | | Message          | |  |  +------------+  |  | +-------------+ | |
  149.    | | Dispatcher  <-------->+                  |  |                 | |
  150.    | |                  | |  |  +------------+  |  | +-------------+ | |
  151.    | |                  | |  +->| v3MP     * |<--->| | User-based  | | |
  152.    | | Transport        | |  |  +------------+  |  | | Security    | | |
  153.    | | Mapping          | |  |  +------------+  |  | | Model       | | |
  154.    | | (e.g RFC1906)    | |  +->| otherMP  * |<--->| +-------------+ | |
  155.    | +------------------+ |     +------------+  |  |                 | |
  156.    |          ^           +---------------------+  +-----------------+ |
  157.    |          |                                                        |
  158.    +----------|--------------------------------------------------------+
  159.               v
  160.      +------------------+
  161.      |   Network        |
  162.      +------------------+
  163.  
  164.  
  165.  
  166. SNMPv3 Working Group       Expires March 1998                   [Page 3]
  167.  
  168. Internet Draft     Message Processing and Dispatching  30 September 1997
  169.  
  170.  
  171.  
  172. 2.1.  The Dispatcher.
  173.  
  174.    The Dispatcher is a key piece of an SNMP engine. There is only one in
  175.    an SNMP engine, and its job is to dispatch tasks to the multiple ver-
  176.    sion-specific Message Processing Models, and to dispatch PDUs to var-
  177.    ious applications.
  178.  
  179.    For outgoing messages, an application provides a PDU to be sent, plus
  180.    the data needed to prepare and send the message, and the application
  181.    specifies which version-specific Message Processing Model will be
  182.    used to prepare the message with the desired security processing.
  183.    Once the message is prepared, the Dispatcher sends the message.
  184.  
  185.    For incoming messages, the Dispatcher determines the SNMP version of
  186.    the incoming message and passes the message to the version-specific
  187.    Message Processing Model to extract the components of the message and
  188.    to coordinate the processing of security services for the message.
  189.    After version-specific processing, the PDU Dispatcher determines
  190.    which application, if any, should receive the PDU for processing and
  191.    forwards it accordingly.
  192.  
  193.    The Dispatcher, while sending and receiving SNMP messages, collects
  194.    statistics about SNMP messages and the behavior of the SNMP engine in
  195.    managed objects to make them accessible to remote SNMP entities.
  196.    This document defines these managed objects, the MIB module which
  197.    contains them, and how these managed objects might be used to provide
  198.    useful management.
  199.  
  200. 2.2.  Message Processing Subsystem
  201.  
  202.    The SNMP Message Processing Subsystem is the part of an SNMP engine
  203.    which interacts with the Dispatcher to handle the version-specific
  204.    SNMP messages. It contains one or more Message Processing Models.
  205.  
  206.    This document describes one Message Processing Model, the SNMPv3
  207.    Message Processing Model, in Section 6. The SNMPv3 Message Processing
  208.    Model is defined in a separate section to show that multiple
  209.    (independent) Message Processing Models can exist at the same time
  210.    and that such Models can be described in different documents. The
  211.    SNMPv3 Message Processing Model can be replaced or supplemented with
  212.    other Message Processing Models in the future. Two Message Processing
  213.    Models which are expected to be developed in the future are the
  214.    SNMPv1 message format [RFC1157] and the SNMPv2c message format
  215.    [RFC1901].  Others may be developed as needed.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222. SNMPv3 Working Group       Expires March 1998                   [Page 4]
  223.  
  224. Internet Draft     Message Processing and Dispatching  30 September 1997
  225.  
  226.  
  227.  
  228. 3.  Elements of Message Processing and Dispatching
  229.  
  230.    See [SNMP-ARCH] for the definitions of
  231.            contextEngineID
  232.            contextName
  233.            scopedPDU
  234.            maxSizeResponseScopedPDU
  235.            securityModel
  236.            securityName
  237.            securityLevel
  238.            messageProcessingModel
  239.  
  240.    For incoming messages, a version-specific message processing module
  241.    provides these values to the Dispatcher. For outgoing messages, an
  242.    application provides these values to the Dispatcher.
  243.  
  244.    For some version-specific processing, the values may be extracted
  245.    from received messages; for other versions, the values may be
  246.    determined by algorithm, or by an implementation-defined mechanism.
  247.    The mechanism by which the value is determined is irrelevant to the
  248.    Dispatcher.
  249.  
  250.    The following additional or expanded definitions are for use within
  251.    the Dispatcher.
  252.  
  253. 3.1.  messageProcessingModel
  254.  
  255.    The value of messageProcessingModel identifies a Message Processing
  256.    Model.  A Message Processing Model describes the version-specific
  257.    procedures for extracting data from messages, generating messages,
  258.    calling upon a securityModel to apply its security services to mes-
  259.    sages, for converting data from a version-specific message format in-
  260.    to a generic format usable by the Dispatcher, and for converting data
  261.    from Dispatcher format into a version-specific message format.
  262.  
  263. 3.2.  pduVersion
  264.  
  265.    The value of pduVersion represents a specific version of protocol
  266.    operation and its associated PDU formats, such as SNMPv1 or SNMPv2
  267.    [RFC1905].  The values of pduVersion are specific to the version of
  268.    the PDU contained in a message, and the PDUs processed by
  269.    applications. The Dispatcher does not use the value of pduVersion
  270.    directly.
  271.  
  272.    An application specifies the pduVersion when it requests the PDU
  273.    Dispatcher to send a PDU to another SNMP engine. The Dispatcher
  274.    passes the pduVersion to a Message Processing Model, so it knows how
  275.  
  276.  
  277.  
  278. SNMPv3 Working Group       Expires March 1998                   [Page 5]
  279.  
  280. Internet Draft     Message Processing and Dispatching  30 September 1997
  281.  
  282.  
  283.    to handle the PDU properly.
  284.  
  285.    For incoming messages, pduVersion is provided to the Dispatcher by a
  286.    version-specific Message Processing module. The PDU Dispatcher passes
  287.    the pduVersion to the application so it knows how to handle the PDU
  288.    properly.  For example, a command responder application needs to know
  289.    whether to use [RFC1905] elements of procedure and syntax instead of
  290.    those specified for SNMPv1.
  291.  
  292. 3.3.  pduType
  293.  
  294.    A value of pduType represents a specific type of protocol operation.
  295.    The values of pduType are specific to the version of the PDU
  296.    contained in a message.
  297.  
  298.    Applications register to support particular pduTypes for particular
  299.    contextEngineIDs.
  300.  
  301.    For incoming messages, pduType is provided to the Dispatcher by a
  302.    version-specific Message Processing module. It is subsequently used
  303.    to dispatch the PDU to the application which registered for the
  304.    pduType for the contextEngineID of the associated scopedPDU.
  305.  
  306. 3.4.  sendPduHandle
  307.  
  308.    This handle is generated for coordinating the processing of requests
  309.    and responses between the SNMP engine and an application. The handle
  310.    must be unique across all version-specific Message Processing Models,
  311.    and is of local significance only.
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. SNMPv3 Working Group       Expires March 1998                   [Page 6]
  335.  
  336. Internet Draft     Message Processing and Dispatching  30 September 1997
  337.  
  338.  
  339. 4.  Dispatcher Elements of Procedure
  340.  
  341.    This section describes the procedures followed by the Dispatcher when
  342.    generating and processing SNMP messages.
  343.  
  344. 4.1.  Sending an SNMP Message to the Network
  345.  
  346.    This section describes the procedure followed by an SNMP engine
  347.    whenever it sends an SNMP message.
  348.  
  349. 4.1.1.  Sending a Request or Notification
  350.  
  351.    The following procedures are followed by the Dispatcher when an
  352.    application wants to send an SNMP PDU to another (remote)
  353.    application, i.e., to initiate a communication by originating a
  354.    message, such as one containing a request or a trap.
  355.  
  356.    1) The application requests this using the abstract service
  357.       primitive:
  358.  
  359.        statusInformation =              -- sendPduHandle if success
  360.                                         -- errorIndication if failure
  361.          sendPdu(
  362.          IN   transportDomain           -- transport domain to be used
  363.          IN   transportAddress          -- destination network address
  364.          IN   messageProcessingModel    -- typically, SNMP version
  365.          IN   securityModel             -- Security Model to use
  366.          IN   securityName              -- on behalf of this principal
  367.          IN   securityLevel             -- Level of Security requested
  368.          IN   contextEngineID           -- data from/at this entity
  369.          IN   contextName               -- data from/in this context
  370.          IN   pduVersion                -- the version of the PDU
  371.          IN   PDU                       -- SNMP Protocol Data Unit
  372.          IN   expectResponse            -- TRUE or FALSE
  373.               )
  374.  
  375.    2) If the messageProcessingModel value does not represent a Message
  376.       Processing Model known to the Dispatcher, then an errorIndication
  377.       (implementation-dependent) is returned to the calling application.
  378.       No further processing is performed.
  379.  
  380.    3) The Dispatcher generates a sendPduHandle to coordinate subsequent
  381.       processing.
  382.  
  383.    4) The Message Dispatcher sends the request to the version-specific
  384.       Message Processing module identified by messageProcessingModel
  385.       using the abstract service primitive:
  386.  
  387.  
  388.  
  389.  
  390. SNMPv3 Working Group       Expires March 1998                   [Page 7]
  391.  
  392. Internet Draft     Message Processing and Dispatching  30 September 1997
  393.  
  394.  
  395.       statusInformation =              - success or error indication
  396.         prepareOutgoingMessage(
  397.         IN   transportDomain           -- as specified by application
  398.         IN   transportAddress          -- as specified by application
  399.         IN   messageProcessingModel    -- as specified by application
  400.         IN   securityModel             -- as specified by application
  401.         IN   securityName              -- as specified by application
  402.         IN   securityLevel             -- as specified by application
  403.         IN   contextEngineID           -- as specified by application
  404.         IN   contextName               -- as specified by application
  405.         IN   pduVersion                -- the version of the PDU
  406.         IN   PDU                       -- as specified by application
  407.         IN   expectResponse            -- as specified by application
  408.         IN   sendPduHandle             -- as determined in step 3.
  409.         OUT  destTransportDomain       -- destination transport domain
  410.         OUT  destTransportAddress      -- destination transport address
  411.         OUT  outgoingMessage           -- the message to send
  412.         OUT  outgoingMessageLength     -- the message length
  413.              )
  414.  
  415.    5) If the statusInformation indicates an error, the errorIndication
  416.       is returned to the calling application.  No further processing is
  417.       performed.
  418.  
  419.    6) If the statusInformation indicates success, the sendPduHandle is
  420.       returned to the application, and the outgoingMessage is sent via
  421.       the transport specified by the transportDomain to the address
  422.       specified by the transportAddress.
  423.  
  424.    Outgoing Message Processing is complete.
  425.  
  426.  
  427. 4.1.2.  Sending a Response to the Network
  428.  
  429.    The following procedure is followed when an application wants to
  430.    return a response back to the originator of an SNMP Request.
  431.  
  432.    1) An application can request this using the abstract service
  433.       primitive:
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446. SNMPv3 Working Group       Expires March 1998                   [Page 8]
  447.  
  448. Internet Draft     Message Processing and Dispatching  30 September 1997
  449.  
  450.  
  451.       returnResponsePDU(
  452.        IN   messageProcessingModel   -- typically, SNMP version
  453.        IN   securityModel            -- Security Model in use
  454.        IN   securityName             -- on behalf of this principal
  455.        IN   securityLevel            -- same as on incoming request
  456.        IN   contextEngineID          -- data from/at this SNMP entity
  457.        IN   contextName              -- data from/in this context
  458.        IN   pduVersion               -- the version of the PDU
  459.        IN   PDU                      -- SNMP Protocol Data Unit
  460.        IN   maxSizeResponseScopedPDU -- maximum size of Response PDU
  461.        IN   stateReference           -- reference to state information
  462.                                      -- as presented with the request
  463.        IN   statusInformation        -- success or errorIndication
  464.        )                             -- (error counter OID and value
  465.                                      -- when errorIndication)
  466.  
  467.    2) The Message Dispatcher sends the request to the appropriate
  468.       Message Processing Model indicated by the received value of
  469.       messageProcessingModel using the abstract service primitive:
  470.  
  471.       result =                        -- SUCCESS or errorIndication
  472.        prepareResponseMessage(
  473.        IN   messageProcessingModel   -- specified by application
  474.        IN   securityModel            -- specified by application
  475.        IN   securityName             -- specified by application
  476.        IN   securityLevel            -- specified by application
  477.        IN   contextEngineID          -- specified by application
  478.        IN   contextName              -- specified by application
  479.        IN   pduVersion               -- specified by application
  480.        IN   PDU                      -- specified by application
  481.        IN   maxSizeResponseScopedPDU -- specified by application
  482.        IN   stateReference           -- specified by application
  483.        IN   statusInformation        -- specified by application
  484.        OUT  destTransportDomain      -- destination transport domain
  485.        OUT  destTransportAddress     -- destination transport address
  486.        OUT  outgoingMessage          -- the message to send
  487.        OUT  outgoingMessageLength    -- the message length
  488.             )
  489.  
  490.    3) If the result is an errorIndication, the errorIndication is
  491.       returned to the calling application.  No further processing is
  492.       performed.
  493.  
  494.    4) If the result is success, the outgoingMessage is sent over the
  495.       transport specified by the transportDomain to the address
  496.       specified by the transportAddress.
  497.  
  498.    Message Processing is complete.
  499.  
  500.  
  501.  
  502. SNMPv3 Working Group       Expires March 1998                   [Page 9]
  503.  
  504. Internet Draft     Message Processing and Dispatching  30 September 1997
  505.  
  506.  
  507. 4.2.  Receiving an SNMP Message from the Network
  508.  
  509.    This section describes the procedure followed by an SNMP engine
  510.    whenever it receives an SNMP message.
  511.  
  512.    Please note, that for the sake of clarity and to prevent the text
  513.    from being even longer and more complicated, some details were
  514.    omitted from the steps below.  In particular, The elements of
  515.    procedure do not always explicitly indicate when state information
  516.    needs to be released. The general rule is that if state information
  517.    is available when a message is to be "discarded without further
  518.    processing", then the state information must also be released at that
  519.    same time.
  520.  
  521. 4.2.1.  Message Dispatching of received SNMP Messages
  522.  
  523.    1) The snmpInPkts counter [RFC1907] is incremented.
  524.  
  525.    2) The version of the SNMP message is determined in an
  526.       implementation-dependent manner.  If the packet cannot be
  527.       sufficiently parsed to determine the version of the SNMP message,
  528.       then the snmpInASNParseErrs [RFC1907] counter is incremented, and
  529.       the message is discarded without further processing.  If the
  530.       version is not supported, then the snmpInBadVersions [RFC1907]
  531.       counter is incremented, and the message is discarded without
  532.       further processing.
  533.  
  534.    3) The origin transportDomain and origin transportAddress are
  535.       determined.
  536.  
  537.    4) The message is passed to the version-specific Message Processing
  538.       Model which returns the abstract data elements required by the
  539.       Dispatcher.  This is performed using the abstract service
  540.       primitive:
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558. SNMPv3 Working Group       Expires March 1998                  [Page 10]
  559.  
  560. Internet Draft     Message Processing and Dispatching  30 September 1997
  561.  
  562.  
  563.       result =                        -- SUCCESS or errorIndication
  564.         prepareDataElements(
  565.         IN   transportDomain          -- origin as determined in step 3.
  566.         IN   transportAddress         -- origin as determined in step 3.
  567.         IN   wholeMsg                 -- as received from the network
  568.         IN   wholeMsgLength           -- as received from the network
  569.         OUT  messageProcessingModel   -- typically, SNMP version
  570.         OUT  securityModel            -- Security Model to use
  571.         OUT  securityName             -- on behalf of this principal
  572.         OUT  securityLevel            -- Level of Security requested
  573.         OUT  contextEngineID          -- data from/at this entity
  574.         OUT  contextName              -- data from/in this context
  575.         OUT  pduVersion               -- the version of the PDU
  576.         OUT  PDU                      -- SNMP Protocol Data Unit
  577.         OUT  pduType                  -- SNMP PDU type
  578.         OUT  sendPduHandle            -- handle for a matched request
  579.         OUT  maxSizeResponseScopedPDU -- maximum size of Response PDU
  580.         OUT  statusInformation        -- success or errorIndication
  581.                                       -- (error counter OID and value
  582.                                       -- when errorIndication)
  583.         OUT  stateReference           -- reference to state information
  584.                                       -- to be used for a possible
  585.              )                        -- Response
  586.  
  587.    5) If the result is a FAILURE errorIndication, the message is
  588.       discarded without further processing.
  589.  
  590.    6) At this point, the abstract data elements have been prepared and
  591.       processing continues as described in Section 4.2.2, PDU
  592.       Dispatching for Incoming Messages.
  593.  
  594. 4.2.2.  PDU Dispatching for Incoming Messages
  595.  
  596.    The elements of procedure for the dispatching of PDUs depends on the
  597.    value of sendPduHandle.  If the value of sendPduHandle is <none>,
  598.    then this is a request or notification and the procedures specified
  599.    in Section 4.2.2.1 apply.  If the value of snmpPduHandle is not
  600.    <none>, then this is a response and the procedures specified in
  601.    Section 4.2.2.2 apply.
  602.  
  603. 4.2.2.1.  PDU Dispatching for Incoming Messages: Requests and
  604. Notifications
  605.  
  606.    The following procedures are followed for the dispatching of PDUs
  607.    when the value of sendPduHandle is <none>, indicating this is a
  608.    request or notification.
  609.  
  610.    1) The combination of contextEngineID and pduType is used to
  611.  
  612.  
  613.  
  614. SNMPv3 Working Group       Expires March 1998                  [Page 11]
  615.  
  616. Internet Draft     Message Processing and Dispatching  30 September 1997
  617.  
  618.  
  619.       determine which application has registered for this request or
  620.       notification.
  621.  
  622.    2) If no application has registered for the combination, then
  623.  
  624.       a) The snmpUnknownPDUHandlers counter is incremented.
  625.  
  626.       b) A Response message is generated using the abstract service
  627.          primitive:
  628.  
  629.          result =                         -- SUCCESS or FAILURE
  630.          prepareResponseMessage(
  631.          IN   messageProcessingModel    -- as provided by MP module
  632.          IN   securityModel             -- as provided by MP module
  633.          IN   securityName              -- as provided by MP module
  634.          IN   securityLevel             -- as provided by MP module
  635.          IN   contextEngineID           -- as provided by MP module
  636.          IN   contextName               -- as provided by MP module
  637.          IN   pduVersion                -- as provided by MP module
  638.          IN   PDU                       -- as provided by MP module
  639.          IN   maxSizeResponseScopedPDU  -- as provided by MP module
  640.          IN   stateReference            -- as provided by MP module
  641.          IN   statusInformation         -- errorIndication plus
  642.                                         -- snmpUnknownPDUHandlers OID
  643.                                         -- value pair.
  644.          OUT  transportDomain           -- destination transportDomain
  645.          OUT  transportAddress          -- destination transportAddress
  646.          OUT  outgoingMessage           -- the message to send
  647.          OUT  outgoingMessageLength     -- its length
  648.          )
  649.  
  650.       c) If the result is SUCCESS, then the prepared message is sent to
  651.          the originator of the request as identified by the
  652.          transportDomain and transportAddress.
  653.  
  654.       d) The incoming message is discarded without further processing.
  655.          Message Processing for this message is complete.
  656.  
  657.    3) The PDU is dispatched to the application, using the abstract
  658.       service primitive:
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670. SNMPv3 Working Group       Expires March 1998                  [Page 12]
  671.  
  672. Internet Draft     Message Processing and Dispatching  30 September 1997
  673.  
  674.  
  675.       processPdu(                     -- process Request/Notification
  676.         IN   messageProcessingModel   -- as provided by MP module
  677.         IN   securityModel            -- as provided by MP module
  678.         IN   securityName             -- as provided by MP module
  679.         IN   securityLevel            -- as provided by MP module
  680.         IN   contextEngineID          -- as provided by MP module
  681.         IN   contextName              -- as provided by MP module
  682.         IN   pduVersion               -- as provided by MP module
  683.         IN   PDU                      -- as provided by MP module
  684.         IN   maxSizeResponseScopedPDU -- as provided by MP module
  685.         IN   stateReference           -- as provided by MP module
  686.                                       -- needed when sending response
  687.              )
  688.  
  689.       Message processing for this message is complete.
  690.  
  691. 4.2.2.2.  PDU Dispatching for Incoming Messages:  Responses
  692.  
  693.    The following procedures are followed for the dispatching of PDUs
  694.    when the value of sendPduHandle is not <none>, indicating this is a
  695.    response.
  696.  
  697.       1) The value of sendPduHandle is used to determine, in an
  698.          implementation-defined manner, which application is waiting for
  699.          a response PDU associated with this sendPduHandle.
  700.  
  701.       2) If no waiting application is found, the message is discarded
  702.          without further processing, and the stateReference is released.
  703.          The snmpUnknownPDUHandlers counter is incremented.  Message
  704.          Processing is complete for this message.
  705.  
  706.       3) Any cached information, including stateReference, about the
  707.          message is discarded.
  708.  
  709.       4) The response is dispatched to the application using the
  710.          abstract service primitive:
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726. SNMPv3 Working Group       Expires March 1998                  [Page 13]
  727.  
  728. Internet Draft     Message Processing and Dispatching  30 September 1997
  729.  
  730.  
  731.          processResponsePdu(              -- process Response PDU
  732.            IN   messageProcessingModel    -- provided by the MP module
  733.            IN   securityModel             -- provided by the MP module
  734.            IN   securityName              -- provided by the MP module
  735.            IN   securityLevel             -- provided by the MP module
  736.            IN   contextEngineID           -- provided by the MP module
  737.            IN   contextName               -- provided by the MP module
  738.            IN   pduVersion                -- provided by the MP module
  739.            IN   PDU                       -- provided by the MP module
  740.            IN   statusInformation         -- provided by the MP module
  741.            IN   sendPduHandle             -- provided by the MP module
  742.                 )
  743.  
  744.          Message Processing is complete for this message.
  745.  
  746. 4.3.  Application Registration for Handling PDU types
  747.  
  748.    Applications that want to process certain PDUs must register with the
  749.    PDU Dispatcher. Applications specify the combination of
  750.    contextEngineID and pduType(s) for which they want to take
  751.    responsibility
  752.  
  753.    1) An application registers according to the abstract interface
  754.       primitive:
  755.  
  756.       statusInformation =           -- success or errorIndication
  757.         registerContextEngineID(
  758.         IN   contextEngineID        -- take responsibility for this one
  759.         IN   pduType                -- the pduType(s) to be registered
  760.              )
  761.  
  762.       Note: implementations may provide a means of requesting
  763.       registration for simultaneous multiple contextEngineID values,
  764.       e.g., all contextEngineID values, and may also provide means for
  765.       requesting simultaneous registration for multiple values of
  766.       pduType.
  767.  
  768.    2) The parameters may be checked for validity; if they are not, then
  769.       an errorIndication (invalidParameter) is returned to the
  770.       application.
  771.  
  772.    3) Each combination of contextEngineID and pduType can be registered
  773.       only once.  If another application has already registered for the
  774.       specified combination, then an errorIndication (alreadyRegistered)
  775.       is returned to the application.
  776.  
  777.    4) Otherwise, the registration is saved so that SNMP PDUs can be
  778.       dispatched to this application.
  779.  
  780.  
  781.  
  782. SNMPv3 Working Group       Expires March 1998                  [Page 14]
  783.  
  784. Internet Draft     Message Processing and Dispatching  30 September 1997
  785.  
  786.  
  787. 4.4.  Application Unregistration for Handling PDU Types
  788.  
  789.    Applications that no longer want to process certain PDUs must
  790.    unregister with the PDU Dispatcher.
  791.  
  792.    1) An application unregisters using the abstract service primitive:
  793.  
  794.       unregisterContextEngineID(
  795.        IN   contextEngineID        -- give up responsibility for this
  796.        IN   pduType                -- the pduType(s) to be unregistered
  797.              )
  798.       Note: implementations may provide means for requesting
  799.       unregistration for simultaneous multiple contextEngineID values,
  800.       e.g., all contextEngineID values, and may also provide means for
  801.       requesting simultaneous unregistration for multiple values of
  802.       pduType.
  803.  
  804.    2) If the contextEngineID and pduType combination has been
  805.       registered, then the registration is deleted.
  806.  
  807.       If no such registration exists, then the request is ignored.
  808.  
  809. 5.  Definitions
  810.  
  811. 5.1.  Definitions for SNMP Message Processing and Dispatching
  812.  
  813.  
  814.    SNMP-MPD-MIB DEFINITIONS ::= BEGIN
  815.  
  816.    IMPORTS
  817.        MODULE-COMPLIANCE, OBJECT-GROUP         FROM SNMPv2-CONF
  818.        MODULE-IDENTITY, OBJECT-TYPE,
  819.        snmpModules, Counter32                  FROM SNMPv2-SMI;
  820.  
  821.    snmpMPDMIB MODULE-IDENTITY
  822.        LAST-UPDATED "9709300000Z"              -- 30 September 1997
  823.        ORGANIZATION "SNMPv3 Working Group"
  824.        CONTACT-INFO "WG-email:   snmpv3@tis.com
  825.                      Subscribe:  majordomo@tis.com
  826.                                  In message body:  subscribe snmpv3
  827.  
  828.                      Chair:      Russ Mundy
  829.                                  Trusted Information Systems
  830.                      postal:     3060 Washington Road
  831.                                  Glenwood, MD 21738
  832.                                  USA
  833.                      email:      mundy@tis.com
  834.                      phone:      +1 301-854-6889
  835.  
  836.  
  837.  
  838. SNMPv3 Working Group       Expires March 1998                  [Page 15]
  839.  
  840. Internet Draft     Message Processing and Dispatching  30 September 1997
  841.  
  842.  
  843.                      Co-editor:  Jeffrey Case
  844.                                  SNMP Research, Inc.
  845.                      postal:     3001 Kimberlin Heights Road
  846.                                  Knoxville, TN 37920-9716
  847.                                  USA
  848.                      email:      case@snmp.com
  849.                      phone:      +1 423-573-1434
  850.  
  851.                      Co-editor   Dave Harrington
  852.                                  Cabletron Systems, Inc.
  853.                      postal:     Post Office Box 5005
  854.                                  MailStop: Durham
  855.                                  35 Industrial Way
  856.                                  Rochester, NH 03867-5005
  857.                                  USA
  858.                      email:      dbh@cabletron.com
  859.                      phone:      +1 603-337-7357
  860.  
  861.                      Co-editor:  Randy Presuhn
  862.                                  BMC Software, Inc.
  863.                      postal:     1190 Saratoga Ave, Suite 190
  864.                                  San Jose, CA 95120
  865.                                  USA
  866.                      email:      rpresuhn@bmc.com
  867.                      phone:      +1 408-556-0720
  868.  
  869.                      Co-editor:  Bert Wijnen
  870.                                  IBM T. J. Watson Research
  871.                      postal:     Schagen 33
  872.                                  3461 GL Linschoten
  873.                                  Netherlands
  874.                      email:      wijnen@vnet.ibm.com
  875.                      phone:      +31 348-432-794
  876.  
  877.                     "
  878.        DESCRIPTION  "The MIB for Message Processing and Dispatching"
  879.        ::= { snmpModules 8 }  -- check if assignment is OK
  880.  
  881.    -- Administrative assignments ***************************************
  882.  
  883.    snmpMPDAdmin           OBJECT IDENTIFIER ::= { snmpMPDMIB 1 }
  884.    snmpMPDMIBObjects      OBJECT IDENTIFIER ::= { snmpMPDMIB 2 }
  885.    snmpMPDMIBConformance  OBJECT IDENTIFIER ::= { snmpMPDMIB 3 }
  886.  
  887.    -- Statistics for SNMP Messages *************************************
  888.  
  889.    snmpMPDStats           OBJECT IDENTIFIER ::= { snmpMPDMIBObjects 1 }
  890.  
  891.  
  892.  
  893.  
  894. SNMPv3 Working Group       Expires March 1998                  [Page 16]
  895.  
  896. Internet Draft     Message Processing and Dispatching  30 September 1997
  897.  
  898.  
  899.    snmpUnknownSecurityModels OBJECT-TYPE
  900.        SYNTAX       Counter32
  901.        MAX-ACCESS   read-only
  902.        STATUS       current
  903.        DESCRIPTION "The total number of packets received by the SNMP
  904.                     engine which were dropped because they referenced a
  905.                     securityModel that was not known to or supported by
  906.                     the SNMP engine.
  907.                    "
  908.        ::= { snmpMPDStats 1 }
  909.  
  910.    snmpInvalidMsgs OBJECT-TYPE
  911.        SYNTAX       Counter32
  912.        MAX-ACCESS   read-only
  913.        STATUS       current
  914.        DESCRIPTION "The total number of packets received by the SNMP
  915.                     engine which were dropped because there were invalid
  916.                     or inconsistent components in the SNMP message.
  917.                    "
  918.        ::= { snmpMPDStats 2 }
  919.  
  920.    snmpUnknownPDUHandlers OBJECT-TYPE
  921.        SYNTAX       Counter32
  922.        MAX-ACCESS   read-only
  923.        STATUS       current
  924.        DESCRIPTION "The total number of packets received by the SNMP
  925.                     engine which were dropped because the PDU contained
  926.                     in the packet could not be passed to an application
  927.                     responsible for handling the pduType, e.g. no SNMP
  928.                     application had registered for the proper
  929.                     combination of the contextEngineID and the pduType.
  930.                    "
  931.        ::= { snmpMPDStats 3 }
  932.  
  933.    -- Conformance information ******************************************
  934.  
  935.    snmpMPDMIBCompliances OBJECT IDENTIFIER ::= {snmpMPDMIBConformance 1}
  936.    snmpMPDMIBGroups      OBJECT IDENTIFIER ::= {snmpMPDMIBConformance 2}
  937.  
  938.    -- Compliance statements
  939.  
  940.    snmpMPDCompliance MODULE-COMPLIANCE
  941.        STATUS       current
  942.        DESCRIPTION "The compliance statement for SNMP entities which
  943.                     implement the SNMP-MPD-MIB.
  944.                    "
  945.  
  946.        MODULE    -- this module
  947.  
  948.  
  949.  
  950. SNMPv3 Working Group       Expires March 1998                  [Page 17]
  951.  
  952. Internet Draft     Message Processing and Dispatching  30 September 1997
  953.  
  954.  
  955.            MANDATORY-GROUPS { snmpMPDGroup }
  956.  
  957.        ::= { snmpMPDMIBCompliances 1 }
  958.  
  959.    snmpMPDGroup OBJECT-GROUP
  960.        OBJECTS {
  961.                  snmpUnknownSecurityModels,
  962.                  snmpInvalidMsgs,
  963.                  snmpUnknownPDUHandlers
  964.                }
  965.        STATUS       current
  966.        DESCRIPTION "A collection of objects providing for remote
  967.                     monitoring of the SNMP Message Processing and
  968.                     Dispatching process.
  969.                    "
  970.        ::= { snmpMPDMIBGroups 1 }
  971.  
  972.    END
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006. SNMPv3 Working Group       Expires March 1998                  [Page 18]
  1007.  
  1008. Internet Draft     Message Processing and Dispatching  30 September 1997
  1009.  
  1010.  
  1011. 6.  The SNMPv3 Message Format
  1012.  
  1013.    This section defines the SNMPv3 message format and the corresponding
  1014.    SNMP version 3 Message Processing Model (v3MP).
  1015.  
  1016.    SNMPv3MessageSyntax DEFINITIONS IMPLICIT TAGS ::= BEGIN
  1017.  
  1018.        SNMPv3Message ::= SEQUENCE {
  1019.            -- identify the layout of the SNMPv3Message
  1020.            -- this element is in same position as in SNMPv1
  1021.            -- and SNMPv2c, allowing recognition
  1022.            msgVersion INTEGER { snmpv3 (3) },
  1023.            -- administrative parameters
  1024.            msgGlobalData HeaderData,
  1025.  
  1026.            -- security model-specific parameters
  1027.            -- format defined by Security Model
  1028.            msgSecurityParameters OCTET STRING,
  1029.  
  1030.            msgData  ScopedPduData
  1031.        }
  1032.  
  1033.        HeaderData ::= SEQUENCE {
  1034.            msgID      INTEGER (0..2147483647),
  1035.            msgMaxSize INTEGER (484..2147483647),
  1036.  
  1037.            msgFlags   OCTET STRING (SIZE(1)),
  1038.                       --  .... ...1   authFlag
  1039.                       --  .... ..1.   privFlag
  1040.                       --  .... .1..   reportableFlag
  1041.                       --
  1042.                       --              Please observe:
  1043.                       --  .... ..00   is OK, means noAuthNoPriv
  1044.                       --  .... ..01   is OK, means authNoPriv
  1045.                       --  .... ..10   reserved, must NOT be used.
  1046.                       --  .... ..11   is OK, means authPriv
  1047.  
  1048.            msgSecurityModel INTEGER (0..2147483647)
  1049.        }
  1050.  
  1051.        ScopedPduData ::= CHOICE {
  1052.            plaintext    ScopedPDU,
  1053.            encryptedPDU OCTET STRING  -- encrypted scopedPDU value
  1054.        }
  1055.  
  1056.        ScopedPDU ::= SEQUENCE {
  1057.            contextEngineID  OCTET STRING,
  1058.            contextName      OCTET STRING,
  1059.  
  1060.  
  1061.  
  1062. SNMPv3 Working Group       Expires March 1998                  [Page 19]
  1063.  
  1064. Internet Draft     Message Processing and Dispatching  30 September 1997
  1065.  
  1066.  
  1067.            data             ANY -- e.g., PDUs as defined in RFC1905
  1068.        }
  1069.    END
  1070.  
  1071. 6.1.  msgVersion
  1072.  
  1073.    The msgVersion field is set to snmpv3(3) and identifies the message
  1074.    as an SNMP version 3 Message.
  1075.  
  1076. 6.2.  msgID
  1077.  
  1078.    The msgID is used between two SNMP entities to coordinate request
  1079.    messages and responses, and by the v3MP to coordinate the processing
  1080.    of the message by different subsystem models within the architecture.
  1081.  
  1082.    Values for msgID should be generated in a manner that avoids re-use
  1083.    of any outstanding values.  Doing so provides protection against some
  1084.    replay attacks.  One possible implementation strategy would be to use
  1085.    the low-order bits of snmpEngineBoots [SNMP-ARCH] as the high-order
  1086.    portion of the msgID value and a monotonically increasing integer for
  1087.    the low-order portion of msgID.
  1088.  
  1089.    Note that the request-id in a PDU is used by SNMP applications to
  1090.    identify the PDU; the msgID is used by the engine to identify the
  1091.    message which carries a PDU. The engine may need to identify the
  1092.    message even if decrypting of the PDU (and request-id) fails. No
  1093.    assumption should be made that the value of the msgID and the value
  1094.    of the request-id are equivalent.
  1095.  
  1096. 6.3.  msgMaxSize
  1097.  
  1098.    The msgMaxSize field of the message conveys the maximum message size
  1099.    supported by the sender of the message, i.e., the maximum message
  1100.    size that the sender can accept when another SNMP engine sends an
  1101.    SNMP message (be it a response or any other message) to the sender of
  1102.    this message.
  1103.  
  1104.    When an SNMP message is being generated, the msgMaxSize is provided
  1105.    by the SNMP engine which generates the message.  At the receiving
  1106.    SNMP engine, the msgMaxSize is used to determine how big the Response
  1107.    to a Request message can be.
  1108.  
  1109. 6.4.  msgFlags
  1110.  
  1111.    The msgFlags field of the message contains several bit fields which
  1112.    control processing of the message.
  1113.  
  1114.    When the reportableFlag is one, a Report PDU must be returned to the
  1115.  
  1116.  
  1117.  
  1118. SNMPv3 Working Group       Expires March 1998                  [Page 20]
  1119.  
  1120. Internet Draft     Message Processing and Dispatching  30 September 1997
  1121.  
  1122.  
  1123.    sender under those conditions which can cause the generation of
  1124.    Report PDUs.  When the reportableFlag is zero, then a Report PDU must
  1125.    not be sent.  The reportableFlag must always be zero when the message
  1126.    contains a Report PDU, a response-type PDU (such as a Response PDU),
  1127.    or an unacknowledged notification-type PDU (such as an SNMPv2-trap
  1128.    PDU).  The reportableFlag must always be one for a request-type PDU
  1129.    (such as a Get PDU) and an acknowledged notification-type PDU (such
  1130.    as an Inform PDU).
  1131.  
  1132.    If the reportableFlag is set to one for a message containing a Report
  1133.    PDU, a response-type PDU (such as a Response PDU), or an
  1134.    unacknowledged notification-type PDU (such as an SNMPv2-trap PDU),
  1135.    then the receiver of that message must process it as though the
  1136.    reportableFlag had been set to zero.
  1137.  
  1138.    If the reportableFlag is set to zero for a message containing a
  1139.    request-type PDU (such as a Get PDU) or an acknowledged notification-
  1140.    type PDU (such as an Inform PDU), then the receiver of that message
  1141.    must process it as though the reportableFlag had been set to one.
  1142.  
  1143.    Report PDUs are engine-to-engine communications and are processed
  1144.    directly by the SNMPv3 Message Processing Model, and are generally
  1145.    not passed to applications for processing, unlike all other PDU
  1146.    types.
  1147.  
  1148.    Note that the reportableFlag is a secondary aid in determining
  1149.    whether a Report PDU must be sent.  It is only used in cases where
  1150.    the PDU portion of a message cannot be decoded, due to, for example,
  1151.    an incorrect ecryption key.  If the PDU can be decoded, the PDU type
  1152.    forms the basis for decisions on sending Report PDUs.
  1153.  
  1154.    The authFlag and privFlag portions of the msgFlags field are set by
  1155.    the sender to indicate the securityLevel that was applied to the
  1156.    message before it was sent on the wire.  The receiver of the message
  1157.    must apply the same securityLevel when the message is received and
  1158.    the contents are being processed.
  1159.  
  1160.    There are three securityLevels, namely noAuthNoPriv, which is less
  1161.    than authNoPriv, which is in turn less than authPriv.  See the SNMP
  1162.    architecture document [SNMP-ARCH] for details about the
  1163.    securityLevel.
  1164.  
  1165.    a) authFlag
  1166.  
  1167.       If the authFlag is set to one, then the securityModel used by the
  1168.       SNMP engine which sent the message must identify the securityName
  1169.       on whose behalf the SNMP message was generated and must provide,
  1170.       in a securityModel-specific manner, sufficient data for the
  1171.  
  1172.  
  1173.  
  1174. SNMPv3 Working Group       Expires March 1998                  [Page 21]
  1175.  
  1176. Internet Draft     Message Processing and Dispatching  30 September 1997
  1177.  
  1178.  
  1179.       receiver of the message to be able to authenticate that
  1180.       identification.  In general, this authentication will allow the
  1181.       receiver to determine with reasonable certainty that the message
  1182.       was:
  1183.  
  1184.       -  sent on behalf of the principal associated with the
  1185.          securityName,
  1186.  
  1187.       -  was not redirected,
  1188.  
  1189.       -  was not modified in transit, and
  1190.  
  1191.       -  was not replayed.
  1192.  
  1193.       If the authFlag is zero, then the securityModel used by the SNMP
  1194.       engine which sent the message must identify the securityName on
  1195.       whose behalf the SNMP message was generated but it does not need
  1196.       to provide sufficient data for the receiver of the message to
  1197.       authenticate the identification, as there is no need to
  1198.       authenticate the message in this case.
  1199.  
  1200.    b) privFlag
  1201.  
  1202.       If the privFlag is set, then the securityModel used by the SNMP
  1203.       engine which sent the message must also protect the scopedPDU in
  1204.       an SNMP message from disclosure, i.e., must encrypt/decrypt the
  1205.       scopedPDU. If the privFlag is zero, then the securityModel in use
  1206.       does not need to protect the data from disclosure.
  1207.  
  1208.       It is an explicit requirement of the SNMP architecture that if
  1209.       privacy is selected, then authentication is also required.  That
  1210.       means that if the privFlag is set, then the authFlag must also be
  1211.       set to one.
  1212.  
  1213.       The combination of the authFlag and the privFlag comprises a Level
  1214.       of Security as follows:
  1215.          authFlag zero, privFlag zero -> securityLevel is noAuthNoPriv
  1216.          authFlag zero, privFlag one  -> invalid combination
  1217.          authFlag one,  privFlag zero -> securityLevel is authNoPriv
  1218.          authFlag one,  privFlag one  -> securityLevel is authPriv
  1219.  
  1220. 6.5.  msgSecurityModel
  1221.  
  1222.    The v3MP supports the concurrent existence of multiple Security
  1223.    Models to provide security services for SNMPv3 messages.  The
  1224.    msgSecurityModel field in an SNMPv3 Message identifies which Security
  1225.    Model was used by the sender to generate the message and therefore
  1226.    which securityModel must be used by the receiver to perform security
  1227.  
  1228.  
  1229.  
  1230. SNMPv3 Working Group       Expires March 1998                  [Page 22]
  1231.  
  1232. Internet Draft     Message Processing and Dispatching  30 September 1997
  1233.  
  1234.  
  1235.    processing for the message.  The mapping to the appropriate
  1236.    securityModel implementation within an SNMP engine is accomplished in
  1237.    an implementation-dependent manner.
  1238.  
  1239. 6.6.  msgSecurityParameters
  1240.  
  1241.    The msgSecurityParameters field of the SNMPv3 Message is used for
  1242.    communication between the Security Model modules in the sending and
  1243.    receiving SNMP engines. The data in the msgSecurityParameters field
  1244.    is used exclusively by the Security Model, and the contents and
  1245.    format of the data is defined by the Security Model.  This OCTET
  1246.    STRING is not interpreted by the v3MP, but is passed to the local
  1247.    implementation of the Security Model indicated by the
  1248.    msgSecurityModel field in the message.
  1249.  
  1250. 6.7.  scopedPduData
  1251.  
  1252.    The scopedPduData field represents either the plain text scopedPDU if
  1253.    the privFlag in the msgFlags is zero, or it represents an
  1254.    encryptedPDU (encoded as an OCTET STRING) which must be decrypted by
  1255.    the securityModel in use to produce a plaintext scopedPDU.
  1256.  
  1257. 6.8.  scopedPDU
  1258.  
  1259.    The scopedPDU contains information to identify an administratively
  1260.    unique context and a PDU. The object identifiers in the PDU refer to
  1261.    managed objects which are (expected to be) accessible within the
  1262.    specified context.
  1263.  
  1264. 6.8.1.  contextEngineID
  1265.  
  1266.    The contextEngineID in the SNMPv3 message, uniquely identifies,
  1267.    within an administrative domain, an SNMP entity that may realize an
  1268.    instance of a context with a particular contextName.
  1269.  
  1270.    For incoming messages, the contextEngineID is used to determine to
  1271.    which application the scopedPDU will be sent for processing.
  1272.  
  1273.    For outgoing messages, the v3MP sets the contextEngineID to the value
  1274.    provided by the application in the request for a message to be sent.
  1275.  
  1276. 6.8.2.  contextName
  1277.  
  1278.    The contextName field in an SNMPv3 message, in conjunction with the
  1279.    contextEngineID field, identifies the particular context associated
  1280.    with the management information contained in the PDU portion of the
  1281.    message.  The contextName is unique within the SNMP entity specified
  1282.    by the contextEngineID, which may realize the managed objects
  1283.  
  1284.  
  1285.  
  1286. SNMPv3 Working Group       Expires March 1998                  [Page 23]
  1287.  
  1288. Internet Draft     Message Processing and Dispatching  30 September 1997
  1289.  
  1290.  
  1291.    referenced within the PDU.  An application which originates a message
  1292.    provides the value for the contextName field and this value may be
  1293.    used during processing by an application at the receiving SNMP
  1294.    Engine.
  1295.  
  1296. 6.8.3.  data
  1297.  
  1298.    The data field of the SNMPv3 Message contains the PDU.  Among other
  1299.    things, the PDU contains the PDU type that is used by the v3MP to
  1300.    determine the type of the incoming SNMP message.  The v3MP specifies
  1301.    that the PDU must be one of those specified in [RFC1905].
  1302.  
  1303. 7.  Elements of Procedure for v3MP
  1304.  
  1305.    This section describes the procedures followed by an SNMP engine when
  1306.    generating and processing SNMP messages according to the SNMPv3
  1307.    Message Processing Model.
  1308.  
  1309.    Please note, that for the sake of clarity and to prevent the text
  1310.    from being even longer and more complicated, some details were
  1311.    omitted from the steps below.
  1312.  
  1313.       a) Some steps specify that when some error conditions are
  1314.          encountered when processing a received message, a message
  1315.          containing a Report PDU is generated and the received message
  1316.          is discarded without further processing.  However, a Report-PDU
  1317.          must not be generated unless the reportableFlag is set in the
  1318.          received message.
  1319.  
  1320.       b) The elements of procedure do not always explicitly indicate
  1321.          when state information needs to be released. The general rule
  1322.          is that if state information is available when a message is to
  1323.          be "discarded without further processing", then the state
  1324.          information must also be released at that same time.
  1325.  
  1326. 7.1.  Prepare an Outgoing SNMP Message
  1327.  
  1328.    This section describes the procedure followed to prepare an SNMPv3
  1329.    message from the data elements passed by the Message Dispatcher.
  1330.  
  1331.    1) The Message Dispatcher may request that an SNMPv3 message
  1332.       containing a GetRequest-PDU, a GetNextRequest-PDU, a
  1333.       GetBulkRequest-PDU, a SetRequest-PDU, an InformRequest-PDU, or an
  1334.       SNMPv2-Trap-PDU be prepared for sending.
  1335.  
  1336.  
  1337.  
  1338.  
  1339.  
  1340.  
  1341.  
  1342. SNMPv3 Working Group       Expires March 1998                  [Page 24]
  1343.  
  1344. Internet Draft     Message Processing and Dispatching  30 September 1997
  1345.  
  1346.  
  1347.  
  1348.       a) It makes such a request according to the abstract service
  1349.          primitive:
  1350.  
  1351.          statusInformation =           -- success or errorIndication
  1352.            prepareOutgoingMessage(
  1353.            IN   transportDomain        -- requested transport domain
  1354.            IN   transportAddress       -- requested destination address
  1355.            IN   messageProcessingModel -- typically, SNMP version
  1356.            IN   securityModel          -- Security Model to use
  1357.            IN   securityName           -- on behalf of this principal
  1358.            IN   securityLevel          -- Level of Security requested
  1359.            IN   contextEngineID        -- data from/at this entity
  1360.            IN   contextName            -- data from/in this context
  1361.            IN   pduVersion             -- version of the PDU
  1362.            IN   PDU                    -- SNMP Protocol Data Unit
  1363.            IN   expectResponse         -- TRUE or FALSE
  1364.            IN   sendPduHandle          -- the handle for matching
  1365.                                        -- incoming responses
  1366.            OUT  destTransportDomain    -- destination transport domain
  1367.            OUT  destTransportAddress   -- destination transport address
  1368.            OUT  outgoingMessage        -- the message to send
  1369.            OUT  outgoingMessageLength  -- the length of the message
  1370.            )
  1371.  
  1372.  
  1373.       b) A unique msgID is generated.  The number used for msgID should
  1374.          not have been used recently, and must not be the same as was
  1375.          used for any outstanding request.
  1376.  
  1377.          * SNMPv3 does not use the values of expectResponse or
  1378.          pduVersion.
  1379.  
  1380.    2) The Message Dispatcher may request that an SNMPv3 message
  1381.       containing a Response-PDU or a Report-PDU be prepared for sending.
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389.  
  1390.  
  1391.  
  1392.  
  1393.  
  1394.  
  1395.  
  1396.  
  1397.  
  1398. SNMPv3 Working Group       Expires March 1998                  [Page 25]
  1399.  
  1400. Internet Draft     Message Processing and Dispatching  30 September 1997
  1401.  
  1402.  
  1403.  
  1404.       a) It makes such a request according to the abstract service
  1405.          primitive:
  1406.  
  1407.          result =                        -- SUCCESS or FAILURE
  1408.          prepareResponseMessage(
  1409.           IN   messageProcessingModel   -- typically, SNMP version
  1410.           IN   securityModel            -- same as on incoming request
  1411.           IN   securityName             -- same as on incoming request
  1412.           IN   securityLevel            -- same as on incoming request
  1413.           IN   contextEngineID          -- data from/at this SNMP entity
  1414.           IN   contextName              -- data from/in this context
  1415.           IN   pduVersion               -- version of the PDU
  1416.           IN   PDU                      -- SNMP Protocol Data Unit
  1417.           IN   maxSizeResponseScopedPDU -- maximum size of Response PDU
  1418.           IN   stateReference           -- reference to state
  1419.                                         -- information presented with
  1420.                                         -- the request
  1421.           IN   statusInformation        -- success or errorIndication
  1422.                                         -- error counter OID and value
  1423.                                         -- when errorIndication
  1424.           OUT  transportDomain          -- destination transport domain
  1425.           OUT  transportAddress         -- destination transport address
  1426.           OUT  outgoingMessage          -- the message to send
  1427.           OUT  outgoingMessageLength    -- the length of the message
  1428.           )
  1429.  
  1430.       b) The cached information for the original request is retrieved
  1431.          via the stateReference, including
  1432.  
  1433.                   - msgID,
  1434.                   - contextEngineID,
  1435.                   - contextName,
  1436.                   - securityModel,
  1437.                   - securityName,
  1438.                   - securityLevel,
  1439.                   - securityStateReference,
  1440.                   - reportableFlag,
  1441.                   - transportDomain, and
  1442.                   - transportAddress.
  1443.  
  1444.          The SNMPv3 Message Processing Model does not allow cached data
  1445.          to be overridden by specified parameters.
  1446.  
  1447.    3) If statusInformation contains values for an OID/value combination,
  1448.       then
  1449.  
  1450.       a) If reportableFlag is zero, then the original message is
  1451.  
  1452.  
  1453.  
  1454. SNMPv3 Working Group       Expires March 1998                  [Page 26]
  1455.  
  1456. Internet Draft     Message Processing and Dispatching  30 September 1997
  1457.  
  1458.  
  1459.          discarded, and no further processing is done. A result of
  1460.          FAILURE is returned. SNMPv3 Message Processing is complete.
  1461.  
  1462.       b) If a PDU is provided, it is the PDU from the original request.
  1463.          If possible, extract the request-id.
  1464.  
  1465.       c) A Report PDU is prepared:
  1466.  
  1467.          1) the varBindList is set to contain the OID and value from the
  1468.             statusInformation
  1469.  
  1470.          2) error-status is set to 0
  1471.  
  1472.          3) error-index is set to 0.
  1473.  
  1474.          4) request-id is set to the value extracted in step b)
  1475.             Otherwise, request-id is set to 0
  1476.  
  1477.       d) If the errorIndication is accompanied by a requested Level of
  1478.          Security, then the securityLevel is set to that value.
  1479.          Otherwise, securityLevel is set to noAuthNoPriv.
  1480.  
  1481.       e) PDU is set to refer to the new Report-PDU. The old PDU is
  1482.          discarded.
  1483.  
  1484.       f) contextEngineID is set to the value of this entity's
  1485.          snmpEngineID
  1486.  
  1487.       g) contextName is set to the default contextName
  1488.  
  1489.       h) processing continues with step 6) below.
  1490.  
  1491.    4) If contextEngineID is not yet determined, then the contextEngineID
  1492.       is determined, in an implementation-dependent manner, possibly
  1493.       using the transportDomain and transportAddress.
  1494.  
  1495.    5) If the contextName is not yet determined, the contextName is set
  1496.       to the default context.
  1497.  
  1498.    6) A scopedPDU is prepared from the contextEngineID, contextName, and
  1499.       PDU.
  1500.  
  1501.    7) msgGlobalData is constructed as follows
  1502.  
  1503.       a) The msgVersion field is set to snmpv3(3).
  1504.  
  1505.       b) msgID is set as determined in step 1 or 2.
  1506.  
  1507.  
  1508.  
  1509.  
  1510. SNMPv3 Working Group       Expires March 1998                  [Page 27]
  1511.  
  1512. Internet Draft     Message Processing and Dispatching  30 September 1997
  1513.  
  1514.  
  1515.       c) msgMaxSize is set to an implementation-dependent value.
  1516.  
  1517.       d) msgFlags are set as follows:
  1518.  
  1519.          -  If securityLevel specifies noAuthNoPriv, then authFlag and
  1520.             privFlag are both set to zero.
  1521.  
  1522.          -  If securityLevel specifies authNoPriv, then authFlag is set
  1523.             to one and privFlag is set to zero.
  1524.  
  1525.          -  If securityLevel specifies authPriv, then authFlag is set to
  1526.             one and privFlag is set to one.
  1527.  
  1528.          -  If the PDU is a Response-PDU, a Report-PDU or an
  1529.             SNMPv2-Trap-PDU, then the reportableFlag is set to zero;
  1530.  
  1531.          -  If the PDU is a GetRequest-PDU, a GetNextRequest-PDU, a
  1532.             GetBulkRequest-PDU, a SetRequest-PDU, or an InformRequest-
  1533.             PDU then the reportableFlag is set to one.
  1534.  
  1535.          -  All other msgFlags bits are set to zero.
  1536.  
  1537.       e) msgSecurityModel is set to the value of securityModel
  1538.  
  1539.    8) If the PDU is a Response-PDU or a Report-PDU, then
  1540.  
  1541.       a) The specified Security Model is called to generate the message
  1542.          according to the primitive:
  1543.  
  1544.          statusInformation =
  1545.            generateResponseMsg(
  1546.            IN   messageProcessingModel -- SNMPv3 Message Processing
  1547.                                        -- Model
  1548.            IN   globalData             -- msgGlobalData from step 7
  1549.            IN   maxMessageSize         -- from msgMaxSize (step 7c)
  1550.            IN   securityModel          -- as determined in step 7e
  1551.            IN   securityEngineID       -- the value of snmpEngineID
  1552.            IN   securityName           -- on behalf of this principal
  1553.            IN   securityLevel          -- for the outgoing message
  1554.            IN   scopedPDU              -- as prepared in step 6)
  1555.            IN   securityStateReference -- as determined in step 2
  1556.            OUT  securityParameters     -- filled in by Security Module
  1557.            OUT  wholeMsg               -- complete generated message
  1558.            OUT  wholeMsgLength         -- length of generated message
  1559.            )
  1560.  
  1561.          If, upon return from the Security Model, the statusInformation
  1562.          includes an errorIndication, then any cached information about
  1563.  
  1564.  
  1565.  
  1566. SNMPv3 Working Group       Expires March 1998                  [Page 28]
  1567.  
  1568. Internet Draft     Message Processing and Dispatching  30 September 1997
  1569.  
  1570.  
  1571.          the outstanding request message is discarded, and an
  1572.          errorIndication is returned, so it can be returned to the
  1573.          calling application. SNMPv3 Message Processing is complete.
  1574.  
  1575.       b) A SUCCESS result is returned. SNMPv3 Message Processing is
  1576.          complete.
  1577.  
  1578.    9) If the PDU is a GetRequest-PDU, a GetNextRequest-PDU, a
  1579.       GetBulkRequest-PDU, a SetRequest-PDU, an InformRequest-PDU, or or
  1580.       an SNMPv2-Trap-PDU, then
  1581.  
  1582.       a) If the PDU is an SNMPv2-Trap-PDU, then securityEngineID is set
  1583.          to the value of this entity's snmpEngineID.
  1584.  
  1585.          Otherwise, the snmpEngineID of the target entity is determined,
  1586.          in an implementation-dependent manner, possibly using
  1587.          transportDomain and transportAddress.  The value of
  1588.          securityEngineID is set to the value of the target entity's
  1589.          snmpEngineID.
  1590.  
  1591.       b) The specified Security Model is called to generate the message
  1592.          according to the primitive:
  1593.  
  1594.          statusInformation =
  1595.           generateRequestMsg(
  1596.           IN  messageProcessingModel -- SNMPv3 Message Processing Model
  1597.           IN  globalData             -- msgGlobalData, from step 7
  1598.           IN  maxMessageSize         -- from msgMaxSize in step 7 c)
  1599.           IN  securityModel          -- as provided by caller
  1600.           IN  securityEngineID       -- authoritative SNMP entity
  1601.           IN  securityName           -- as provided by caller
  1602.           IN  securityLevel          -- as provided by caller
  1603.           IN  snmpEngineID           -- as determined in step 9 a)
  1604.           IN  scopedPDU              -- as prepared in step 6
  1605.           OUT securityParameters     -- filled in by Security Module
  1606.           OUT wholeMsg               -- complete generated message
  1607.           OUT wholeMsgLength         -- length of the generated message
  1608.           )
  1609.  
  1610.          If, upon return from the Security Model, the statusInformation
  1611.          includes an errorIndication, then the message is discarded, and
  1612.          the errorIndication is returned, so it can be returned to the
  1613.          calling application, and no further processing is done.
  1614.          SNMPv3 Message Processing is complete.
  1615.  
  1616.       c) Information about the outgoing message is cached, and a
  1617.          stateReference is created (implementation-specific).
  1618.          Information to be cached includes the values of:
  1619.  
  1620.  
  1621.  
  1622. SNMPv3 Working Group       Expires March 1998                  [Page 29]
  1623.  
  1624. Internet Draft     Message Processing and Dispatching  30 September 1997
  1625.  
  1626.  
  1627.                       - sendPduHandle
  1628.                       - msgID
  1629.                       - snmpEngineID
  1630.                       - securityModel
  1631.                       - securityName
  1632.                       - securityLevel
  1633.                       - contextEngineID
  1634.                       - contextName
  1635.  
  1636.       d) A SUCCESS result is returned.  SNMPv3 Message Processing is
  1637.          complete.
  1638.  
  1639. 7.2.  Prepare Data Elements from an Incoming SNMP Message
  1640.  
  1641.    This section describes the procedure followed to extract data from an
  1642.    SNMPv3 message, and to prepare the data elements required for further
  1643.    processing of the message by the Message Dispatcher.
  1644.  
  1645.    1)  The message is passed in from the Message Dispatcher according to
  1646.        the abstract service primitive:
  1647.  
  1648.        result =                         -- SUCCESS or errorIndication
  1649.          prepareDataElements(
  1650.          IN  transportDomain          -- origin transport domain
  1651.          IN  transportAddress         -- origin transport address
  1652.          IN  wholeMsg                 -- as received from the network
  1653.          IN  wholeMsgLength           -- as received from the network
  1654.          OUT messageProcessingModel   -- typically, SNMP version
  1655.          OUT securityModel            -- Security Model to use
  1656.          OUT securityName             -- on behalf of this principal
  1657.          OUT securityLevel            -- Level of Security requested
  1658.          OUT contextEngineID          -- data from/at this entity
  1659.          OUT contextName              -- data from/in this context
  1660.          OUT pduVersion               -- version of the PDU
  1661.          OUT PDU                      -- SNMP Protocol Data Unit
  1662.          OUT pduType                  -- SNMP PDU type
  1663.          OUT sendPduHandle            -- handle for matched request
  1664.          OUT maxSizeResponseScopedPDU -- maximum size of Response PDU
  1665.          OUT statusInformation        -- success or errorIndication
  1666.                                       -- error counter OID and value
  1667.                                       -- when errorIndication
  1668.          OUT stateReference           -- reference to state information
  1669.                                       -- to be used for a possible
  1670.          )                            -- Response
  1671.  
  1672.    2)  If the received message is not the serialization (according to
  1673.        the conventions of [RFC1906]) of an SNMPv3Message value, then the
  1674.        snmpInASNParseErrs counter [RFC1907] is incremented, the message
  1675.  
  1676.  
  1677.  
  1678. SNMPv3 Working Group       Expires March 1998                  [Page 30]
  1679.  
  1680. Internet Draft     Message Processing and Dispatching  30 September 1997
  1681.  
  1682.  
  1683.        is discarded without further processing, and a FAILURE result is
  1684.        returned. SNMPv3 Message Processing is complete.
  1685.  
  1686.    3)  The values for msgVersion, msgID, msgMaxSize, msgFlags,
  1687.        msgSecurityModel, msgSecurityParameters, and msgData are
  1688.        extracted from the message.
  1689.  
  1690.    4)  If the value of the msgSecurityModel component does not match a
  1691.        supported securityModel, then the snmpUnknownSecurityModels
  1692.        counter is incremented, a Report PDU is generated, the message is
  1693.        discarded without further processing, and a FAILURE result is
  1694.        returned. SNMPv3 Message Processing is complete.
  1695.  
  1696.    5)  The securityLevel is determined from the authFlag and the
  1697.        privFlag bits of the msgFlags component as follows:
  1698.  
  1699.        a) If the authFlag is not set and the privFlag is not set, then
  1700.           securityLevel is set to noAuthNoPriv.
  1701.  
  1702.        b) If the authFlag is set and the privFlag is not set, then
  1703.           securityLevel is set to authNoPriv.
  1704.  
  1705.        c) If the authFlag is set and the privFlag is set, then
  1706.           securityLevel is set to authPriv.
  1707.  
  1708.        d) If the authFlag is not set and privFlag is set, then the
  1709.           snmpInvalidMsgs counter is incremented, a Report PDU is
  1710.           generated, the message is discarded without further
  1711.           processing, and a FAILURE result is returned. SNMPv3 Message
  1712.           Processing is complete.
  1713.  
  1714.    6)  The security module implementing the Security Model as specified
  1715.        by the securityModel component is called for authentication and
  1716.        privacy services.  This is done according to the abstract service
  1717.        primitive:
  1718.  
  1719.        statusInformation =            -- errorIndication or success
  1720.                                       -- error counter OID and
  1721.                                       -- value if error
  1722.          processIncomingMsg(
  1723.          IN  messageProcessingModel   -- SNMPv3 Message Processing Model
  1724.          IN  expectResponse           -- TRUE or FALSE
  1725.          IN  maxMessageSize           -- of the sending SNMP entity
  1726.          IN  securityParameters       -- for the received message
  1727.          IN  securityModel            -- for the received message
  1728.          IN  securityLevel            -- Level of Security
  1729.          IN  wholeMsg                 -- as received on the wire
  1730.          IN  wholeMsgLength           -- length as received on the wire
  1731.  
  1732.  
  1733.  
  1734. SNMPv3 Working Group       Expires March 1998                  [Page 31]
  1735.  
  1736. Internet Draft     Message Processing and Dispatching  30 September 1997
  1737.  
  1738.  
  1739.          OUT securityEngineID         -- authoritative SNMP entity
  1740.          OUT securityName             -- identification of the principal
  1741.          OUT scopedPDU,               -- message (plaintext) payload
  1742.          OUT maxSizeResponseScopedPDU -- maximum size of Response PDU
  1743.          OUT securityStateReference   -- reference to security state
  1744.          )                            -- information, needed for
  1745.                                       -- response
  1746.  
  1747.        If an errorIndication is returned by the security module, then
  1748.  
  1749.        a) If statusInformation contains values for an OID/value pair,
  1750.           then a Report PDU is generated.
  1751.  
  1752.           1) If the scopedPDU has been returned from ProcessIncomingMsg
  1753.              then determine contextEngineID, contextName, and PDU.
  1754.  
  1755.           2) Information about the message is cached and a
  1756.              stateReference is created (implementation-specific).
  1757.              Information to be cached includes the values of:
  1758.  
  1759.                           msgVersion,
  1760.                           msgID,
  1761.                           securityLevel,
  1762.                           msgFlags,
  1763.                           msgMaxSize,
  1764.                           securityModel,
  1765.                           maxSizeResponseScopedPDU,
  1766.                           securityStateReference
  1767.  
  1768.           3) Request that a Report-PDU be prepared and sent, according
  1769.              to the abstract service primitive:
  1770.  
  1771.              result =                     -- SUCCESS or FAILURE
  1772.              returnResponsePDU(
  1773.              IN  messageProcessingModel   -- SNMPv3(3)
  1774.              IN  securityModel            -- same as on incoming request
  1775.              IN  securityName             -- from ProcessIncomingMsg
  1776.              IN  securityLevel            -- same as on incoming request
  1777.              IN  contextEngineID          -- from step 6 a) 1)
  1778.              IN  contextName              -- from step 6 a) 1)
  1779.              IN  pduVersion               -- SNMPv2-PDU
  1780.              IN  PDU                      -- from step 6 a) 1)
  1781.              IN  maxSizeResponseScopedPDU -- from ProcessIncomingMsg
  1782.              IN  stateReference           -- from step 6 a) 2)
  1783.              IN  statusInformation        -- from ProcessIncomingMsg
  1784.              OUT transportDomain          -- destination's transport
  1785.                                           -- domain
  1786.              OUT transportAddress         -- destination's transport
  1787.  
  1788.  
  1789.  
  1790. SNMPv3 Working Group       Expires March 1998                  [Page 32]
  1791.  
  1792. Internet Draft     Message Processing and Dispatching  30 September 1997
  1793.  
  1794.  
  1795.                                           -- address
  1796.              OUT outgoingMessage          -- the message to send
  1797.              OUT outgoingMessageLength    -- the length of the message
  1798.              )
  1799.  
  1800.        b) The incoming message is discarded without further processing,
  1801.           and a FAILURE result is returned. SNMPv3 Message Processing is
  1802.           complete.
  1803.  
  1804.    7)  The scopedPDU is parsed to extract the contextEngineID, the
  1805.        contextName and the PDU.  If any parse error occurs, then the
  1806.        snmpInASNParseErrs counter [RFC1907] is incremented, the security
  1807.        state information is discarded, the message is discarded without
  1808.        further processing, and a FAILURE result is returned. SNMPv3
  1809.        Message Processing is complete.
  1810.  
  1811.    8)  The pduVersion is set to an SNMPv2-PDU.
  1812.  
  1813.    9)  The pduType is determined, in an implementation-dependent manner,
  1814.        to be:
  1815.  
  1816.                - a GetRequest-PDU,
  1817.                - a GetNextRequest-PDU,
  1818.                - a GetBulkRequest-PDU,
  1819.                - a SetRequest-PDU,
  1820.                - an InformRequest-PDU,
  1821.                - an SNMPv2-Trap-PDU,
  1822.                - a Response-PDU, or
  1823.                - a Report-PDU.
  1824.  
  1825.    10) If the pduType is a Response-PDU or a Report-PDU, then
  1826.  
  1827.        a) The value of the msgID component is used to find the cached
  1828.           information for a corresponding outstanding Request message.
  1829.           If no such outstanding Request message is found, then the
  1830.           security state information is discarded, the message is
  1831.           discarded without further processing, and a FAILURE result is
  1832.           returned. SNMPv3 Message Processing is complete.
  1833.  
  1834.        b) sendPduHandle is retrieved from the cached information.
  1835.  
  1836.        Otherwise, sendPduHandle is set to <none>, an implementation
  1837.        defined value.
  1838.  
  1839.     11) If the pduType is a Report-PDU, then
  1840.  
  1841.         a) statusInformation is created using the contents of the
  1842.            Report-PDU, in an implementation-dependent manner. This
  1843.  
  1844.  
  1845.  
  1846. SNMPv3 Working Group       Expires March 1998                  [Page 33]
  1847.  
  1848. Internet Draft     Message Processing and Dispatching  30 September 1997
  1849.  
  1850.  
  1851.            statusInformation will be forwarded to the application
  1852.            associated with the sendPduHandle.
  1853.  
  1854.         b) Any cached information about the outstanding Request message
  1855.            message is discarded.
  1856.  
  1857.         c) The security state information for this incoming message is
  1858.            discarded.
  1859.  
  1860.         d) stateReference is set to <none>
  1861.  
  1862.         e) A SUCCESS result is returned. SNMPv3 Message Processing is
  1863.            complete.
  1864.  
  1865.     12) If the pduType is a Response-PDU, then
  1866.  
  1867.         a) The cached data for the outstanding request, referred to by
  1868.            stateReference, is retrieved, including
  1869.  
  1870.                        - snmpEngineID
  1871.                        - securityModel
  1872.                        - securityName
  1873.                        - securityLevel
  1874.                        - contextEngineID
  1875.                        - contextName
  1876.  
  1877.         b) If the values extracted from the incoming message differ from
  1878.            the cached data, then the security state information is
  1879.            discarded, any cached information about the outstanding
  1880.            Request message is discarded, the incoming message is
  1881.            discarded without further processing, and a FAILURE result is
  1882.            returned.  SNMPv3 Message Processing is complete.
  1883.  
  1884.         c) Otherwise, any cached information about the outstanding
  1885.            Request message is discarded, and stateReference is set to
  1886.            <none>.
  1887.  
  1888.         d) A SUCCESS result is returned. SNMPv3 Message Processing is
  1889.            complete.
  1890.  
  1891.     13) If the pduType is a GetRequest-PDU, a GetNextRequest-PDU, a
  1892.         GetBulkRequest-PDU, a SetRequest-PDU, or an InformRequest-PDU,
  1893.         then
  1894.  
  1895.         a) If the value of securityEngineID is not equal to the value of
  1896.            snmpEngineID, then the security state information is
  1897.            discarded, any cached information about the outstanding
  1898.            Request message is discarded, the incoming message is
  1899.  
  1900.  
  1901.  
  1902. SNMPv3 Working Group       Expires March 1998                  [Page 34]
  1903.  
  1904. Internet Draft     Message Processing and Dispatching  30 September 1997
  1905.  
  1906.  
  1907.            discarded without further processing, and a FAILURE result is
  1908.            returned.  SNMPv3 Message Processing is complete.
  1909.  
  1910.         b) Information about the message is cached and a stateReference
  1911.            is created (implementation-specific).  Information to be
  1912.            cached includes the values of:
  1913.  
  1914.                         msgVersion,
  1915.                         msgID,
  1916.                         securityLevel,
  1917.                         msgFlags,
  1918.                         msgMaxSize,
  1919.                         securityModel,
  1920.                         maxSizeResponseScopedPDU,
  1921.                         securityStateReference
  1922.  
  1923.         c) A SUCCESS result is returned. SNMPv3 Message Processing is
  1924.            complete.
  1925.  
  1926.     14) If the pduType is an SNMPv2-Trap-PDU, then A SUCCESS result is
  1927.         returned. SNMPv3 Message Processing is complete.
  1928.  
  1929.  
  1930. 8.  Security Considerations
  1931.  
  1932.    The Dispatcher coordinates the processing of messages to provide a
  1933.    level of security for management messages and to direct the SNMP PDUs
  1934.    to the proper SNMP application(s).
  1935.  
  1936.    A Message Processing Model, and in particular the V3MP defined in
  1937.    this document, interacts as part of the Message Processing with
  1938.    Security Models in the Security Subsystem via the abstract service
  1939.    interface primitives defined in [SNMP-ARCH] and elaborated above.
  1940.  
  1941.    The level of security actually provided is primarily determined by
  1942.    the specific Security Model implementation(s) and the specific SNMP
  1943.    application implementation(s) incorporated into this framework.
  1944.    Applications have access to data which is not secured. Applications
  1945.    should take reasonable steps to protect the data from disclosure, and
  1946.    when they send data across the network, they should obey the
  1947.    securityLevel and call upon the services of an Access Control Model
  1948.    as they apply access control.
  1949.  
  1950.    The values for the msgID element used in communication between SNMP
  1951.    entities must be chosen to avoid replay attacks.  The values do not
  1952.    need to be unpredictable; it is sufficient that they not repeat.
  1953.  
  1954.  
  1955.  
  1956.  
  1957.  
  1958. SNMPv3 Working Group       Expires March 1998                  [Page 35]
  1959.  
  1960. Internet Draft     Message Processing and Dispatching  30 September 1997
  1961.  
  1962.  
  1963. 9.  Editors' Addresses
  1964.  
  1965.       Co-editor: Jeffrey Case
  1966.                  SNMP Research, Inc.
  1967.       postal:    3001 Kimberlin Heights Road
  1968.                  Knoxville, TN 37920-9716
  1969.                  USA
  1970.       email:     case@snmp.com
  1971.       phone:     +1 423-573-1434
  1972.  
  1973.  
  1974.       Co-editor   Dave Harrington
  1975.                   Cabletron Systems, Inc
  1976.       postal:     Post Office Box 5005
  1977.                   Mail Stop: Durham
  1978.                   35 Industrial Way
  1979.                   Rochester, NH 03867-5005
  1980.                   USA
  1981.       email:      dbh@cabletron.com
  1982.       phone:      +1 603-337-7357
  1983.  
  1984.  
  1985.       Co-editor:  Randy Presuhn
  1986.                   BMC Software, Inc.
  1987.       postal:     1190 Saratoga Avenue
  1988.                   Suite 130
  1989.                   San Jose, CA 95129
  1990.                   USA
  1991.       email:      rpresuhn@bmc.com
  1992.       phone:      +1 408-556-0720
  1993.  
  1994.  
  1995.       Co-editor:  Bert Wijnen
  1996.                   IBM T. J. Watson Research
  1997.       postal:     Schagen 33
  1998.                   3461 GL Linschoten
  1999.                   Netherlands
  2000.       email:      wijnen@vnet.ibm.com
  2001.       phone:      +31 348-432-794
  2002.  
  2003.  
  2004.  
  2005. 10.  Acknowledgements
  2006.  
  2007.    This document is the result of the efforts of the SNMPv3 Working
  2008.    Group.  Some special thanks are in order to the following SNMPv3 WG
  2009.    members:
  2010.  
  2011.  
  2012.  
  2013.  
  2014. SNMPv3 Working Group       Expires March 1998                  [Page 36]
  2015.  
  2016. Internet Draft     Message Processing and Dispatching  30 September 1997
  2017.  
  2018.  
  2019.        Dave Battle (SNMP Research, Inc.)
  2020.        Uri Blumenthal (IBM T.J. Watson Research Center)
  2021.        Jeff Case (SNMP Research, Inc.)
  2022.        John Curran (BBN)
  2023.        T. Max Devlin (Hi-TECH Connections)
  2024.        John Flick (Hewlett Packard)
  2025.        David Harrington (Cabletron Systems Inc.)
  2026.        N.C. Hien (IBM T.J. Watson Research Center)
  2027.        Dave Levi (SNMP Research, Inc.)
  2028.        Louis A Mamakos (UUNET Technologies Inc.)
  2029.        Paul Meyer (Secure Computing Corporation)
  2030.        Keith McCloghrie (Cisco Systems)
  2031.        Russ Mundy (Trusted Information Systems, Inc.)
  2032.        Bob Natale (ACE*COMM Corporation)
  2033.        Mike O'Dell (UUNET Technologies Inc.)
  2034.        Dave Perkins (DeskTalk)
  2035.        Peter Polkinghorne (Brunel University)
  2036.        Randy Presuhn (BMC Software, Inc.)
  2037.        David Reid (SNMP Research, Inc.)
  2038.        Shawn Routhier (Epilogue)
  2039.        Juergen Schoenwaelder (TU Braunschweig)
  2040.        Bob Stewart (Cisco Systems)
  2041.        Bert Wijnen (IBM T.J. Watson Research Center)
  2042.  
  2043.    The document is based on recommendations of the IETF Security and
  2044.    Administrative Framework Evolution for SNMP Advisory Team.  Members
  2045.    of that Advisory Team were:
  2046.  
  2047.        David Harrington (Cabletron Systems Inc.)
  2048.        Jeff Johnson (Cisco Systems)
  2049.        David Levi (SNMP Research Inc.)
  2050.        John Linn (Openvision)
  2051.        Russ Mundy (Trusted Information Systems) chair
  2052.        Shawn Routhier (Epilogue)
  2053.        Glenn Waters (Nortel)
  2054.        Bert Wijnen (IBM T. J. Watson Research Center)
  2055.  
  2056.  
  2057.  
  2058.  
  2059.  
  2060.  
  2061.  
  2062.  
  2063.  
  2064.  
  2065.  
  2066.  
  2067.  
  2068.  
  2069.  
  2070. SNMPv3 Working Group       Expires March 1998                  [Page 37]
  2071.  
  2072. Internet Draft     Message Processing and Dispatching  30 September 1997
  2073.  
  2074.  
  2075.  
  2076.    As recommended by the Advisory Team and the SNMPv3 Working Group
  2077.    Charter, the design incorporates as much as practical from previous
  2078.    RFCs and drafts. As a result, special thanks are due to the authors
  2079.    of previous designs known as SNMPv2u and SNMPv2*:
  2080.  
  2081.        Jeff Case (SNMP Research, Inc.)
  2082.        David Harrington (Cabletron Systems Inc.)
  2083.        David Levi (SNMP Research, Inc.)
  2084.        Keith McCloghrie (Cisco Systems)
  2085.        Brian O'Keefe (Hewlett Packard)
  2086.        Marshall T. Rose (Dover Beach Consulting)
  2087.        Jon Saperia (BGS Systems Inc.)
  2088.        Steve Waldbusser (International Network Services)
  2089.        Glenn W. Waters (Bell-Northern Research Ltd.)
  2090.  
  2091.  
  2092. 11.  References
  2093.  
  2094.  
  2095. [RFC1901] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2096.      and S., Waldbusser, "Introduction to Community-based SNMPv2", RFC
  2097.      1901, January 1996.
  2098.  
  2099. [RFC1902] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2100.      and S., Waldbusser, "Structure of Management Information for
  2101.      Version  2 of the Simple Network Management Protocol (SNMPv2)", RFC
  2102.      1902, January 1996.
  2103.  
  2104. [RFC1905] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2105.      and S., Waldbusser, "Protocol Operations for Version 2 of the
  2106.      Simple Network Management Protocol (SNMPv2)", RFC 1905, January
  2107.      1996.
  2108.  
  2109. [RFC1906] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2110.      and S. Waldbusser, "Transport Mappings for Version 2 of the Simple
  2111.      Network Management Protocol (SNMPv2)", RFC 1906, January 1996.
  2112.  
  2113. [RFC1907] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2114.      and S. Waldbusser, "Management Information Base for Version 2 of
  2115.      the Simple Network Management Protocol (SNMPv2)", RFC 1907 January
  2116.      1996.
  2117.  
  2118. [RFC1908] The SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
  2119.      and S. Waldbusser, "Coexistence between Version 1 and Version 2 of
  2120.      the Internet-standard Network Management Framework", RFC 1908,
  2121.      January 1996.
  2122.  
  2123.  
  2124.  
  2125.  
  2126. SNMPv3 Working Group       Expires March 1998                  [Page 38]
  2127.  
  2128. Internet Draft     Message Processing and Dispatching  30 September 1997
  2129.  
  2130.  
  2131.  
  2132. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
  2133.      Requirement Levels", RFC 2119, BCP 14, March 1997.
  2134.  
  2135. [SNMP-ARCH] The SNMPv3 Working Group, Harrington, D., Presuhn, R.,
  2136.      Wijnen, B., "An Architecture for describing SNMP Management
  2137.      Frameworks", <draft-ietf-snmpv3-next-gen-arch-04.txt>, August 1997.
  2138.  
  2139. [SNMP-USM] The SNMPv3 Working Group, Blumenthal, U., Wijnen, B., "The
  2140.      User-Based Security Model for Version 3 of the Simple Network
  2141.      Management Protocol (SNMPv3)", <draft-ietf-snmpv3-usm-01.txt>,
  2142.      August 1997.
  2143.  
  2144. [SNMP-ACM] The SNMPv3 Working Group, Wijnen, B., Presuhn, R.,
  2145.      McCloghrie, K., "View-based Access Control Model for the Simple
  2146.      Network Management Protocol (SNMP)",
  2147.      <draft-ietf-snmpv3-acm-02.txt>, August 1997.
  2148.  
  2149. [SNMP-APPL] The SNMPv3 Working Group, Levi, D. B., Meyer, P., Stewart,
  2150.      B., "SNMPv3 Applications", <draft-ietf-snmpv3-appl-01.txt>, August
  2151.      1997
  2152.  
  2153.  
  2154.  
  2155.  
  2156.  
  2157.  
  2158.  
  2159.  
  2160.  
  2161.  
  2162.  
  2163.  
  2164.  
  2165.  
  2166.  
  2167.  
  2168.  
  2169.  
  2170.  
  2171.  
  2172.  
  2173.  
  2174.  
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180.  
  2181.  
  2182. SNMPv3 Working Group       Expires March 1998                  [Page 39]
  2183.  
  2184. Internet Draft     Message Processing and Dispatching  30 September 1997
  2185.  
  2186.  
  2187.  
  2188. 12.  Issues
  2189.  
  2190.    The revision history in this section will be deleted when this
  2191.    material is submitted for last call.  The remaining material in this
  2192.    section will be deleted in the transition from internet-draft to RFC.
  2193.  
  2194. 12.1.  Open Issues
  2195.  
  2196.    The following open issues need to be resolved.
  2197.  
  2198.       -  The more precise specification of the handling of the
  2199.          reportableFlag begs the question of what an engine is supposed
  2200.          to do when it receives a message with an illegal combination of
  2201.          the reportableFlag and PDU type.
  2202.  
  2203.          The paragraph beginning with "Report PDUs are engine-to-engine
  2204.          communications...."  has been deleted.  The old text was a bit
  2205.          of an overspecification, but in the past the first part of that
  2206.          paragraph has proven valuable in explaining to people just what
  2207.          report PDUs are for.
  2208.  
  2209. 12.2.  Resolved Issues
  2210.  
  2211.       The more precise specification of reportFlag begged the question
  2212.       of what an engine is supposed to do when it receives a message
  2213.       with an illegal combination of the reportFlag and PDU type.  This
  2214.       question became moot when the reportFlag was removed.
  2215.  
  2216.    -  contextEngineID in reportPDU = snmpEngineID of report generator
  2217.       (this is not what we decided ... we decided that the
  2218.       contextEngineID in a reportPDU is = snmpEngineID associated with
  2219.       the data in the varbind list which is often, but not always the
  2220.       snmpEngineID of the report generator)
  2221.  
  2222.    -  returnResponsePDU - are all parameters needed? overrides allowed?
  2223.       all parameters kept for future flexibility
  2224.       overrides not supported by SNMPv3
  2225.  
  2226.    -  use of IN/OUT indicators in primitives accepted
  2227.  
  2228.    -  NT/Unix-like access control - can be defined as future model
  2229.  
  2230.    -  user-friendly names? yes, but with limits
  2231.  
  2232.    -  SnmpAdminString as index? yes, but restrict sizes
  2233.  
  2234.    -  need both MMS and maxSizeResponseScopedPDU? yes.
  2235.  
  2236.  
  2237.  
  2238. SNMPv3 Working Group       Expires March 1998                  [Page 40]
  2239.  
  2240. Internet Draft     Message Processing and Dispatching  30 September 1997
  2241.  
  2242.  
  2243.    -  synchronous vs. asynchronous primitives? synchronous preferred
  2244.  
  2245.    -  should we change MIB naming? no, it is acceptable
  2246.  
  2247.    -  is it ok that USM is bound to SNMPv3? while undesirable, it is
  2248.       acceptable. A cleaner model may be defined in the future.
  2249.  
  2250.    -  should securityModel "any" be supported? for ACM use, not SNMPv3
  2251.  
  2252.    -  what defines SNMPv3? a document will be published after Munich
  2253.  
  2254.    -  Is an application-level handle needed for request/response
  2255.       matching?  yes. create sendPduhandle
  2256.  
  2257.    -  Is wildcard contextEngineID/pduType registration needed? No. This
  2258.       is an internal interface, and wildcarding can be supported by an
  2259.       implementation, but is not required in the standard.
  2260.  
  2261.    -  Should indices be integers or SnmpAdminStrings? SnmpAdminStrings
  2262.       is the consensus.
  2263.  
  2264.    -  Should protocols be identified as OIDs or Integers? OIDs
  2265.  
  2266.    -  terminology:
  2267.       securityLevel rather than LoS
  2268.       msgXXXX to identify message fields in SNMPv3
  2269.  
  2270. 12.3.  Change Log
  2271.  
  2272.    The following change log records major changes.  The version
  2273.    identifiers are for the convenience of the document's editors.
  2274.  
  2275.       [Current]
  2276.  
  2277.          -  modified step 7.1 d) to reflect Munich discussions on
  2278.             security of reports.
  2279.  
  2280.          -  Changed snmpVersion to messageProcessingModel
  2281.  
  2282.          -  Added increment of snmpUnknownPDUHandlers for orphan
  2283.             responses.
  2284.  
  2285.          -  Added reference to snmpInASNParseErrs in message processing.
  2286.  
  2287.          -  filled in missing steps in message processing sections
  2288.  
  2289.          -  deleted "implementation hint" on the use of msgID for
  2290.             sendPduHandle.
  2291.  
  2292.  
  2293.  
  2294. SNMPv3 Working Group       Expires March 1998                  [Page 41]
  2295.  
  2296. Internet Draft     Message Processing and Dispatching  30 September 1997
  2297.  
  2298.  
  2299.          -  moved msgVersion from HeaderData into SNMPv3Message.
  2300.  
  2301.          -  removed "multi-lingual" from security considerations, put in
  2302.             first-pass replacement text
  2303.  
  2304.          -  reconciled inconsistent text on generation of msgID values
  2305.  
  2306.          -  fixed ASN.1 module syntax defining SNMPv3 message format
  2307.  
  2308.          -  fixed description of snmpUnknownSecurityModels
  2309.  
  2310.          -  cleaned up wording, minor editorial fixes
  2311.  
  2312.          -  Added RFC 2119 magic incantation.
  2313.  
  2314.          -  Added text on reportableFlag to accomodate Bert Wijnen and
  2315.             Mike Daniele's on-list comments.
  2316.  
  2317.          -  Removed reportFlag.
  2318.  
  2319.          -  Replaced text describing the reportableFlag with text
  2320.             developed on the snmpv3 mailing list.
  2321.  
  2322.          -  Replaced text describing the reportFlag with text developed
  2323.             on the snmpv3 mailing list.
  2324.  
  2325.          -  Converted to nroff, with minor changes to layout and
  2326.             editorial fix-ups.
  2327.  
  2328.       [version 4.12]
  2329.  
  2330.          -  formatting
  2331.  
  2332.          -  pagination
  2333.  
  2334.       [version 4.11]
  2335.  
  2336.          -  moved Issues to resolved following consensus, as listed
  2337.             above
  2338.  
  2339.          -  remove expectResponse from processIncomingMsg (it doesn't
  2340.             work)
  2341.  
  2342.          -  add securityEngineID
  2343.  
  2344.          -  acknowledgements
  2345.  
  2346.          -  references
  2347.  
  2348.  
  2349.  
  2350. SNMPv3 Working Group       Expires March 1998                  [Page 42]
  2351.  
  2352. Internet Draft     Message Processing and Dispatching  30 September 1997
  2353.  
  2354.  
  2355.          -  ordered security, editors, acknowledgements, references
  2356.             sections
  2357.  
  2358.          -  checked line lengths
  2359.  
  2360.       [version 4.10]
  2361.  
  2362.          -  deTab
  2363.  
  2364.          -  checked MIB using SMICng
  2365.  
  2366.       [version 4.9]
  2367.  
  2368.          -  editorial changes
  2369.  
  2370.          -  rename processMsg to processIncomingMsg
  2371.  
  2372.          -  returnResponsePDU - to allow application to override cache
  2373.             (futures)
  2374.  
  2375.          -  generateResponseMsg passes globalData to reduce binding
  2376.             between MP and SEC
  2377.  
  2378.          -  generateRequestMsg passes globalData to reduce binding
  2379.             between MP and SEC
  2380.  
  2381.          -  expectResponse in processIncomingMessage to address Levi
  2382.             concern
  2383.  
  2384.          -  acknowledgements
  2385.  
  2386.          -  posted to snmpv3 mailing list
  2387.  
  2388.       [version 4.8]
  2389.  
  2390.          -  spell checking
  2391.  
  2392.          -  corrected SNMPv3 Message Processing Model
  2393.  
  2394.       [version 4.7]
  2395.  
  2396.          -  editorial changes (dbh)
  2397.  
  2398.       [version 4.4]
  2399.  
  2400.          -  editorial changes (bert)
  2401.  
  2402.          -  renamed document to Message Processing and Dispatching for
  2403.  
  2404.  
  2405.  
  2406. SNMPv3 Working Group       Expires March 1998                  [Page 43]
  2407.  
  2408. Internet Draft     Message Processing and Dispatching  30 September 1997
  2409.  
  2410.  
  2411.             SNMP
  2412.  
  2413.          -  reworked Multi-Lingual Model into Dispatcher and Message
  2414.             Processing
  2415.  
  2416.          -  Adapted Primitives to latest set defined in ARCH
  2417.  
  2418.       [version 4.3]
  2419.  
  2420.          -  removed tabs
  2421.  
  2422.       [version 4.2]
  2423.  
  2424.          -  modified elements of procedure for Multi-Lingual Model
  2425.  
  2426.       [version 4.0]
  2427.  
  2428.          -  Multi-Lingual Message Processing Model initial version
  2429.  
  2430.       [version 3.6]
  2431.  
  2432.          -  editorial fix-ups by jdc
  2433.  
  2434.          -  corrected overview diagram
  2435.  
  2436.          -  changed Message definition to SNMPv3Message
  2437.  
  2438.       [version 3.5]
  2439.  
  2440.          -  change LoS to securityLevel
  2441.  
  2442.       [version 3.4]
  2443.  
  2444.          -  engine, not Message Processing, interacts with network
  2445.  
  2446.          -  editorial changes
  2447.  
  2448.          -  registration is per PDU type
  2449.  
  2450.          -  fields in MsgFlags modified and discussed
  2451.  
  2452.          -  Changes as to address comments by dbh
  2453.  
  2454.          -  Changes to get Primitives inline with latest list
  2455.  
  2456.          -  ran MIB through SMICng
  2457.  
  2458.          -  updated picture in Overview
  2459.  
  2460.  
  2461.  
  2462. SNMPv3 Working Group       Expires March 1998                  [Page 44]
  2463.  
  2464. Internet Draft     Message Processing and Dispatching  30 September 1997
  2465.  
  2466.  
  2467.          -  update primitives to match editors' discussions
  2468.  
  2469.          -  updates addresses to international format
  2470.  
  2471.          -  removed editors' notes as appropriate
  2472.  
  2473.          -  converted editors' notes into Issues as appropriate
  2474.  
  2475.          -  modified text as per editors' discussions
  2476.  
  2477.          -  posted to snmpv3 mailing list
  2478.  
  2479.       [version 3.3]
  2480.  
  2481.          -  spelling changes
  2482.  
  2483.          -  elements of procedure expanded
  2484.  
  2485.          -  changes snmpMPCxxxx to snmpV3xxxx in MIB
  2486.  
  2487.       [version 3.2]
  2488.  
  2489.          -  updated change log
  2490.  
  2491.       [version 3.1]
  2492.  
  2493.          -  changes as a result of 2nd interim meeting
  2494.  
  2495.             -  adopt to new abstract service interface primitives
  2496.  
  2497.             -  use new agreed upon names for things
  2498.  
  2499.             -  add a new overview of Message Processing Subsystem
  2500.  
  2501.             -  Remove MP Model selection descriptions
  2502.  
  2503.             -  Remove Multiplexing layer descriptions
  2504.  
  2505.             -  Rewrite all the elements of procedure
  2506.  
  2507.             -  Redo the SNMPv3-MIB
  2508.  
  2509.             -  Removed security threats section.
  2510.  
  2511.             -  Did a quick spell check on AIX
  2512.  
  2513.          -  Message Processing and Control changed to Message Processing
  2514.  
  2515.  
  2516.  
  2517.  
  2518. SNMPv3 Working Group       Expires March 1998                  [Page 45]
  2519.  
  2520. Internet Draft     Message Processing and Dispatching  30 September 1997
  2521.  
  2522.  
  2523.          -  change orangelets to applications
  2524.  
  2525.          -  stats counters should be in the module where they make sense
  2526.  
  2527.          -  statistics counters moved between documents on a case-by-
  2528.             case basic, according to where they make the most sense
  2529.  
  2530.          -  modified to match consistent terminology
  2531.  
  2532.          -  improved pictures
  2533.  
  2534.          -  added elements of procedure
  2535.  
  2536.          -  changed snmpv3Message to Message
  2537.  
  2538.          -  modified naming of msgFlags
  2539.  
  2540.          -  securityParameters size limitation removed
  2541.  
  2542.          -  removed limits on lengths of contextEngineID and contextName
  2543.  
  2544.          -  new names for the application types
  2545.  
  2546.          -  more bullets to make it easier to read
  2547.  
  2548.          -  primitives have consistent format with expanded comments
  2549.  
  2550.          -  glossary (not filled in) removed
  2551.  
  2552.       [version 3.0]
  2553.  
  2554.          -  published as draft-ietf-snmpv3-mpc-model-01.txt
  2555.  
  2556.       [version 2.1]
  2557.  
  2558.          -  ?? not sure if there were any changes
  2559.  
  2560.       [version 2.0]
  2561.  
  2562.          -  changes as a result of 1st interim meeting
  2563.  
  2564.          -  some new wording in introduction
  2565.  
  2566.          -  reword in overview with a drawing
  2567.  
  2568.          -  added reportFlag to msgFlags
  2569.  
  2570.          -  describe overall MPC model: MPC Selection mechanism
  2571.  
  2572.  
  2573.  
  2574. SNMPv3 Working Group       Expires March 1998                  [Page 46]
  2575.  
  2576. Internet Draft     Message Processing and Dispatching  30 September 1997
  2577.  
  2578.  
  2579.          -  describe overall MPC model: MPC Multiplexing Layer
  2580.  
  2581.          -  describe v3MPC model.
  2582.  
  2583.          -  added the abstract interface definitions for interacting
  2584.             with SNMPv3 USEC Model
  2585.  
  2586.          -  added the abstract interface definitions for interacting
  2587.             with applications
  2588.  
  2589.          -  added MIB definitions for error Counters (statistics)
  2590.  
  2591.          -  removed references to LPM and Access Control
  2592.  
  2593.       [version 1.2]
  2594.  
  2595.          -  add text regarding security threats
  2596.  
  2597.          -  add text regarding access control
  2598.  
  2599.          -  remove text regarding agent installation of views
  2600.  
  2601.          -  removed Naming-Scope
  2602.  
  2603.          -  removed discussion of MPC determining to which application a
  2604.             message/request should be forwarded.
  2605.  
  2606.          -  added Issues section
  2607.  
  2608.          -  added sending a notification for an application
  2609.  
  2610.          -  spell-check, renumber, paginate
  2611.  
  2612.       [version 1.1]
  2613.  
  2614.          -  separated architecture from Message Processing and Control
  2615.             Model for SNMPv3
  2616.  
  2617.          -  clarified snmpV3Message definition
  2618.  
  2619.          -  rewrote introduction and overviews
  2620.  
  2621.          -  wrote transport mappings
  2622.  
  2623.          -  documented snmpV3Message format
  2624.  
  2625.          -  changed Quality of Service (QoS) to Level of Security (LoS)
  2626.  
  2627.  
  2628.  
  2629.  
  2630. SNMPv3 Working Group       Expires March 1998                  [Page 47]
  2631.  
  2632. Internet Draft     Message Processing and Dispatching  30 September 1997
  2633.  
  2634.  
  2635.          -  changed end-user to security entity
  2636.  
  2637.          -  Tried to clarify MMS of engine versus MMS of message.
  2638.  
  2639.          -  change security entity to securityIdentity
  2640.  
  2641.       [version 1.0]
  2642.  
  2643.          -  Initial document, with SNMPng architecture and MPCv3 merged.
  2644.  
  2645.  
  2646.  
  2647.  
  2648.  
  2649.  
  2650.  
  2651.  
  2652.  
  2653.  
  2654.  
  2655.  
  2656.  
  2657.  
  2658.  
  2659.  
  2660.  
  2661.  
  2662.  
  2663.  
  2664.  
  2665.  
  2666.  
  2667.  
  2668.  
  2669.  
  2670.  
  2671.  
  2672.  
  2673.  
  2674.  
  2675.  
  2676.  
  2677.  
  2678.  
  2679.  
  2680.  
  2681.  
  2682.  
  2683.  
  2684.  
  2685.  
  2686. SNMPv3 Working Group       Expires March 1998                  [Page 48]
  2687.  
  2688.                             Table of Contents
  2689.  
  2690.  
  2691.  
  2692.  
  2693. 1. Introduction ...................................................    2
  2694.  
  2695. 2. Overview .......................................................    2
  2696.  
  2697. 2.1. The Dispatcher.  .............................................    4
  2698.  
  2699. 2.2. Message Processing Subsystem .................................    4
  2700.  
  2701. 3. Elements of Message Processing and Dispatching .................    4
  2702.  
  2703. 3.1. messageProcessingModel .......................................    5
  2704.  
  2705. 3.2. pduVersion ...................................................    5
  2706.  
  2707. 3.3. pduType ......................................................    6
  2708.  
  2709. 3.4. sendPduHandle ................................................    6
  2710.  
  2711. 4. Dispatcher Elements of Procedure ...............................    7
  2712.  
  2713. 4.1. Sending an SNMP Message to the Network .......................    7
  2714.  
  2715. 4.1.1. Sending a Request or Notification ..........................    7
  2716.  
  2717. 4.1.2. Sending a Response to the Network ..........................    8
  2718.  
  2719. 4.2. Receiving an SNMP Message from the Network ...................   10
  2720.  
  2721. 4.2.1. Message Dispatching of received SNMP Messages ..............   10
  2722.  
  2723. 4.2.2. PDU Dispatching for Incoming Messages ......................   11
  2724.  
  2725. 4.2.2.1. PDU Dispatching for Incoming Messages: Requests and
  2726. Notifications .....................................................   11
  2727.  
  2728. 4.2.2.2. PDU Dispatching for Incoming Messages:  Responses ........   13
  2729.  
  2730. 4.3. Application Registration for Handling PDU types ..............   14
  2731.  
  2732. 4.4. Application Unregistration for Handling PDU Types ............   15
  2733.  
  2734.  
  2735.  
  2736. SNMPv3 Working Group       Expires March 1998                   [Page 1]
  2737.  
  2738. Internet Draft     Message Processing and Dispatching  30 September 1997
  2739.  
  2740.  
  2741. 5. Definitions ....................................................   15
  2742.  
  2743. 5.1. Definitions for SNMP Message Processing and Dispatching ......   15
  2744.  
  2745. 6. The SNMPv3 Message Format ......................................   19
  2746.  
  2747. 6.1. msgVersion ...................................................   20
  2748.  
  2749. 6.2. msgID ........................................................   20
  2750.  
  2751. 6.3. msgMaxSize ...................................................   20
  2752.  
  2753. 6.4. msgFlags .....................................................   20
  2754.  
  2755. 6.5. msgSecurityModel .............................................   22
  2756.  
  2757. 6.6. msgSecurityParameters ........................................   23
  2758.  
  2759. 6.7. scopedPduData ................................................   23
  2760.  
  2761. 6.8. scopedPDU ....................................................   23
  2762.  
  2763. 6.8.1. contextEngineID ............................................   23
  2764.  
  2765. 6.8.2. contextName ................................................   23
  2766.  
  2767. 6.8.3. data .......................................................   24
  2768.  
  2769. 7. Elements of Procedure for v3MP .................................   24
  2770.  
  2771. 7.1. Prepare an Outgoing SNMP Message .............................   24
  2772.  
  2773. 7.2. Prepare Data Elements from an Incoming SNMP Message ..........   30
  2774.  
  2775. 8. Security Considerations ........................................   35
  2776.  
  2777. 9. Editors' Addresses .............................................   36
  2778.  
  2779. 10. Acknowledgements ..............................................   36
  2780.  
  2781. 11. References ....................................................   38
  2782.  
  2783. 12. Issues ........................................................   40
  2784.  
  2785. 12.1. Open Issues .................................................   40
  2786.  
  2787. 12.2. Resolved Issues .............................................   40
  2788.  
  2789.  
  2790.  
  2791.  
  2792. SNMPv3 Working Group       Expires March 1998                   [Page 2]
  2793.  
  2794. Internet Draft     Message Processing and Dispatching  30 September 1997
  2795.  
  2796.  
  2797. 12.3. Change Log ..................................................   41
  2798.  
  2799.  
  2800.  
  2801.  
  2802.  
  2803.  
  2804.  
  2805.  
  2806.  
  2807.  
  2808.  
  2809.  
  2810.  
  2811.  
  2812.  
  2813.  
  2814.  
  2815.  
  2816.  
  2817.  
  2818.  
  2819.  
  2820.  
  2821.  
  2822.  
  2823.  
  2824.  
  2825.  
  2826.  
  2827.  
  2828.  
  2829.  
  2830.  
  2831.  
  2832.  
  2833.  
  2834.  
  2835.  
  2836.  
  2837.  
  2838.  
  2839.  
  2840.  
  2841.  
  2842.  
  2843.  
  2844.  
  2845.  
  2846.  
  2847.  
  2848. SNMPv3 Working Group       Expires March 1998                   [Page 3]
  2849.  
  2850.