snmp.h
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:13k
源码类别:

SNMP编程

开发平台:

Unix_Linux

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