userapps/opensource/net-snmp/include/net-snmp/library/snmp.h

   1 #ifndef SNMP_H
   2 #define SNMP_H
   3
   4 #ifdef __cplusplus
   5 extern          "C" {
   6 #endif
   7     /*
   8      * Definitions for the Simple Network Management Protocol (RFC 1067).
   9      *
  10      *
  11      */
  12 /***********************************************************
  13         Copyright 1988, 1989 by Carnegie Mellon University
  14
  15                       All Rights Reserved
  16
  17 Permission to use, copy, modify, and distribute this software and its
  18 documentation for any purpose and without fee is hereby granted,
  19 provided that the above copyright notice appear in all copies and that
  20 both that copyright notice and this permission notice appear in
  21 supporting documentation, and that the name of CMU not be
  22 used in advertising or publicity pertaining to distribution of the
  23 software without specific, written prior permission.
  24
  25 CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  26 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  27 CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  28 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  29 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  30 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  31 SOFTWARE.
  32 ******************************************************************/
  33
  34
  35 #define SNMP_PORT           161 /* standard UDP port for SNMP agents
  36                                  * to receive requests messages */
  37 #define SNMP_TRAP_PORT      162 /* standard UDP port for SNMP
  38                                  * managers to receive notificaion
  39                                  * (trap and inform) messages */
  40
  41 #define SNMP_MAX_LEN        1500        /* typical maximum message size */
  42 #define SNMP_MIN_MAX_LEN    484 /* minimum maximum message size */
  43
  44     /*
  45      * SNMP versions
  46      */
  47     /*
  48      * There currently exists the following SNMP versions.
  49      * * (Note that only SNMPv1 is in widespread usage, and this code supports
  50      * *  only SNMPv1, SNMPv2c, and SNMPv3.
  51      * *
  52      * *  SNMPv1 - (full) the original version, defined by RFC 1157
  53      * *  SNMPsec - (historic) the first attempt to add strong security
  54      * *             to SNMPv1, defined by RFCs 1351, 1352, and 1353.
  55      * *  SNMPv2p - (historic) party-based SNMP, which was another
  56      * *             attempt to add strong security to SNMP, defined
  57      * *             by RFCs 1441, 1445, 1446, 1448, and 1449.
  58      * *  SNMPv2c - (experimental) community string-based SNMPv2,
  59      * *             which was an attempt to combine the protocol
  60      * *             operations of SNMPv2 with the security of
  61      * *             SNMPv1, defined by RFCs 1901, 1905, and 1906.
  62      * *  SNMPv2u - (experimental) user-based SNMPv2, which provided
  63      * *             security based on user names and protocol
  64      * *             operations of SNMPv2, defined by RFCs 1905,
  65      * *             1909, and 1910.
  66      * *  SNMPv2* (or SNMPv2star) - (experimental) an attempt to add the
  67      * *             best features of SNMPv2p and SNMPv2u, defined
  68      * *             by unpublished documents found at WEB site
  69      * *             owned by SNMP Research (a leading SNMP vendor)
  70      * *  SNMPv3 - the current attempt by the IETF working group to merge
  71      * *             the SNMPv2u and SNMPv2* proposals into a more widly
  72      * *             accepted SNMPv3.  It is defined by not yet published
  73      * *             documents of the IETF SNMPv3 WG.
  74      * *
  75      * * SNMPv1, SNMPv2c, SNMPv2u, and SNMPv3 messages have a common
  76      * * form, which is an ASN.1 sequence containing a message version
  77      * * field, followed by version dependent fields.
  78      * * SNMPsec, SNMPv2p, and SNMPv2* messages have a common form,
  79      * * which is a tagged ASN.1 context specific sequence containing
  80      * * message dependent fields.
  81      * *
  82      * * In the #defines for the message versions below, the value
  83      * * for SNMPv1, SNMPv2c, SNMPv2u, and SNMPv3 messages is the
  84      * * value of the message version field. Since SNMPsec, SNMPv2p,
  85      * * and SNMPv2* messages do not have a message version field,
  86      * * the value in the defines for them is choosen to be a large
  87      * * arbitrary number.
  88      * *
  89      * * Note that many of the version ID's are defined below purely for
  90      * * documentational purposes.  At this point the only protocol planned
  91      * * for future implementations is SNMP3, as the other v2 protocols will
  92      * * not be supported by the IETF (ie, v2u, v2sec, v2star) or used by
  93      * * the snmp community at large (at the time of this writing).
  94      */
  95
  96     /*
  97      * versions based on version field
  98      */
  99 #define SNMP_VERSION_1     0
 100 #define SNMP_VERSION_2c    1
 101 #define SNMP_VERSION_2u    2    /* not (will never be) supported by this code */
 102 #define SNMP_VERSION_3     3
 103
 104     /*
 105      * versions not based on a version field
 106      */
 107 #define SNMP_VERSION_sec   128  /* not (will never be) supported by this code */
 108 #define SNMP_VERSION_2p    129
 109 #define SNMP_VERSION_2star 130  /* not (will never be) supported by this code */
 110
 111     /*
 112      * PDU types in SNMPv1, SNMPsec, SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3
 113      */
 114 #define SNMP_MSG_GET        (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x0)
 115 #define SNMP_MSG_GETNEXT    (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x1)
 116 #define SNMP_MSG_RESPONSE   (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x2)
 117 #define SNMP_MSG_SET        (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x3)
 118
 119     /*
 120      * PDU types in SNMPv1 and SNMPsec
 121      */
 122 #define SNMP_MSG_TRAP       (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x4)       /* c4 = 196 */
 123
 124     /*
 125      * PDU types in SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3
 126      */
 127 #define SNMP_MSG_GETBULK    (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x5)       /* c5 = 197 */
 128 #define SNMP_MSG_INFORM     (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x6)       /* c6 = 198 */
 129 #define SNMP_MSG_TRAP2      (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x7)       /* c7 = 199 */
 130
 131     /*
 132      * PDU types in SNMPv2u, SNMPv2*, and SNMPv3
 133      */
 134 #define SNMP_MSG_REPORT     (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x8)       /* c8 = 200 */
 135
 136     /*
 137      * internal modes that should never be used by the protocol for the
 138      * pdu type.
 139      */
 140 #define SNMP_MSG_INTERNAL_SET_BEGIN        -1
 141 #define SNMP_MSG_INTERNAL_SET_RESERVE1     0    /* these should match snmp.h */
 142 #define SNMP_MSG_INTERNAL_SET_RESERVE2     1
 143 #define SNMP_MSG_INTERNAL_SET_ACTION       2
 144 #define SNMP_MSG_INTERNAL_SET_COMMIT       3
 145 #define SNMP_MSG_INTERNAL_SET_FREE         4
 146 #define SNMP_MSG_INTERNAL_SET_UNDO         5
 147
 148     /*
 149      * test for member of Confirmed Class i.e., reportable
 150      */
 151 #define SNMP_CMD_CONFIRMED(c) (c == SNMP_MSG_INFORM || c == SNMP_MSG_GETBULK ||\
 152                                c == SNMP_MSG_GETNEXT || c == SNMP_MSG_GET || \
 153                                c == SNMP_MSG_SET)
 154
 155     /*
 156      * Exception values for SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3
 157      */
 158 #define SNMP_NOSUCHOBJECT    (ASN_CONTEXT | ASN_PRIMITIVE | 0x0)        /* 80 = 128 */
 159 #define SNMP_NOSUCHINSTANCE  (ASN_CONTEXT | ASN_PRIMITIVE | 0x1)        /* 81 = 129 */
 160 #define SNMP_ENDOFMIBVIEW    (ASN_CONTEXT | ASN_PRIMITIVE | 0x2)        /* 82 = 130 */
 161
 162     /*
 163      * Error codes (the value of the field error-status in PDUs)
 164      */
 165
 166     /*
 167      * in SNMPv1, SNMPsec, SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs
 168      */
 169 #define SNMP_ERR_NOERROR                (0)     /* XXX  Used only for PDUs? */
 170 #define SNMP_ERR_TOOBIG                 (1)
 171 #define SNMP_ERR_NOSUCHNAME             (2)
 172 #define SNMP_ERR_BADVALUE               (3)
 173 #define SNMP_ERR_READONLY               (4)
 174 #define SNMP_ERR_GENERR                 (5)
 175
 176     /*
 177      * in SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs
 178      */
 179 #define SNMP_ERR_NOACCESS               (6)
 180 #define SNMP_ERR_WRONGTYPE              (7)
 181 #define SNMP_ERR_WRONGLENGTH            (8)
 182 #define SNMP_ERR_WRONGENCODING          (9)
 183 #define SNMP_ERR_WRONGVALUE             (10)
 184 #define SNMP_ERR_NOCREATION             (11)
 185 #define SNMP_ERR_INCONSISTENTVALUE      (12)
 186 #define SNMP_ERR_RESOURCEUNAVAILABLE    (13)
 187 #define SNMP_ERR_COMMITFAILED           (14)
 188 #define SNMP_ERR_UNDOFAILED             (15)
 189 #define SNMP_ERR_AUTHORIZATIONERROR     (16)
 190 #define SNMP_ERR_NOTWRITABLE            (17)
 191
 192     /*
 193      * in SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs
 194      */
 195 #define SNMP_ERR_INCONSISTENTNAME       (18)
 196
 197 #define MAX_SNMP_ERR    18
 198
 199
 200     /*
 201      * values of the generic-trap field in trap PDUs
 202      */
 203 #define SNMP_TRAP_COLDSTART             (0)
 204 #define SNMP_TRAP_WARMSTART             (1)
 205 #define SNMP_TRAP_LINKDOWN              (2)
 206 #define SNMP_TRAP_LINKUP                (3)
 207 #define SNMP_TRAP_AUTHFAIL              (4)
 208 #define SNMP_TRAP_EGPNEIGHBORLOSS       (5)
 209 #define SNMP_TRAP_ENTERPRISESPECIFIC    (6)
 210
 211     /*
 212      * row status values
 213      */
 214 #define SNMP_ROW_NONEXISTENT            0
 215 #define SNMP_ROW_ACTIVE                 1
 216 #define SNMP_ROW_NOTINSERVICE           2
 217 #define SNMP_ROW_NOTREADY               3
 218 #define SNMP_ROW_CREATEANDGO            4
 219 #define SNMP_ROW_CREATEANDWAIT          5
 220 #define SNMP_ROW_DESTROY                6
 221
 222     /*
 223      * row storage values
 224      */
 225 #define SNMP_STORAGE_NONE  0
 226 #define SNMP_STORAGE_OTHER              1
 227 #define SNMP_STORAGE_VOLATILE           2
 228 #define SNMP_STORAGE_NONVOLATILE        3
 229 #define SNMP_STORAGE_PERMANENT          4
 230 #define SNMP_STORAGE_READONLY           5
 231
 232     /*
 233      * message processing models
 234      */
 235 #define SNMP_MP_MODEL_SNMPv1            0
 236 #define SNMP_MP_MODEL_SNMPv2c           1
 237 #define SNMP_MP_MODEL_SNMPv2u           2
 238 #define SNMP_MP_MODEL_SNMPv3            3
 239 #define SNMP_MP_MODEL_SNMPv2p           256
 240
 241     /*
 242      * security values
 243      */
 244 #define SNMP_SEC_MODEL_ANY              0
 245 #define SNMP_SEC_MODEL_SNMPv1           1
 246 #define SNMP_SEC_MODEL_SNMPv2c          2
 247 #define SNMP_SEC_MODEL_USM              3
 248 #define SNMP_SEC_MODEL_SNMPv2p          256
 249
 250 #define SNMP_SEC_LEVEL_NOAUTH           1
 251 #define SNMP_SEC_LEVEL_AUTHNOPRIV       2
 252 #define SNMP_SEC_LEVEL_AUTHPRIV         3
 253
 254 #define SNMP_MSG_FLAG_AUTH_BIT          0x01
 255 #define SNMP_MSG_FLAG_PRIV_BIT          0x02
 256 #define SNMP_MSG_FLAG_RPRT_BIT          0x04
 257
 258     /*
 259      * control PDU handling characteristics
 260      */
 261 #define UCD_MSG_FLAG_RESPONSE_PDU            0x100
 262 #define UCD_MSG_FLAG_EXPECT_RESPONSE         0x200
 263 #define UCD_MSG_FLAG_FORCE_PDU_COPY          0x400
 264 #define UCD_MSG_FLAG_ALWAYS_IN_VIEW          0x800
 265 #define UCD_MSG_FLAG_PDU_TIMEOUT            0x1000
 266 #define UCD_MSG_FLAG_ONE_PASS_ONLY          0x2000
 267
 268     /*
 269      * view status
 270      */
 271 #define SNMP_VIEW_INCLUDED              1
 272 #define SNMP_VIEW_EXCLUDED              2
 273
 274     /*
 275      * basic oid values
 276      */
 277 #define SNMP_OID_INTERNET               1, 3, 6, 1
 278 #define SNMP_OID_ENTERPRISES            SNMP_OID_INTERNET, 4, 1
 279 #define SNMP_OID_MIB2                   SNMP_OID_INTERNET, 2, 1
 280 #define SNMP_OID_SNMPV2                 SNMP_OID_INTERNET, 6
 281 #define SNMP_OID_SNMPMODULES            SNMP_OID_SNMPV2, 3
 282
 283     /*
 284      * lengths as defined by TCs
 285      */
 286 #define SNMPADMINLENGTH 255
 287
 288
 289     char           *uptime_string(u_long, char *);
 290     void            xdump(const u_char *, size_t, const char *);
 291     u_char         *snmp_parse_var_op(u_char *, oid *, size_t *, u_char *,
 292                                       size_t *, u_char **, size_t *);
 293     u_char         *snmp_build_var_op(u_char *, oid *, size_t *, u_char,
 294                                       size_t, u_char *, size_t *);
 295
 296
 297 #ifdef USE_REVERSE_ASNENCODING
 298     int             snmp_realloc_rbuild_var_op(u_char ** pkt,
 299                                                size_t * pkt_len,
 300                                                size_t * offset,
 301                                                int allow_realloc,
 302                                                const oid * name,
 303                                                size_t * name_len,
 304                                                u_char value_type,
 305                                                u_char * value,
 306                                                size_t value_length);
 307 #endif
 308
 309 #ifdef __cplusplus
 310 }
 311 #endif
 312 #endif                          /* SNMP_H */