net-snmp 5.7
|
00001 #ifndef SNMP_H 00002 #define SNMP_H 00003 00004 #ifdef __cplusplus 00005 extern "C" { 00006 #endif 00007 /* 00008 * Definitions for the Simple Network Management Protocol (RFC 1067). 00009 * 00010 * 00011 */ 00012 /*********************************************************** 00013 Copyright 1988, 1989 by Carnegie Mellon University 00014 00015 All Rights Reserved 00016 00017 Permission to use, copy, modify, and distribute this software and its 00018 documentation for any purpose and without fee is hereby granted, 00019 provided that the above copyright notice appear in all copies and that 00020 both that copyright notice and this permission notice appear in 00021 supporting documentation, and that the name of CMU not be 00022 used in advertising or publicity pertaining to distribution of the 00023 software without specific, written prior permission. 00024 00025 CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 00026 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 00027 CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR 00028 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 00029 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 00030 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 00031 SOFTWARE. 00032 ******************************************************************/ 00033 00034 00035 #define SNMP_PORT 161 /* standard UDP port for SNMP agents 00036 * to receive requests messages */ 00037 #define SNMP_TRAP_PORT 162 /* standard UDP port for SNMP 00038 * managers to receive notificaion 00039 * (trap and inform) messages */ 00040 00041 #define SNMP_MAX_LEN 1500 /* typical maximum message size */ 00042 #define SNMP_MIN_MAX_LEN 484 /* minimum maximum message size */ 00043 00044 /* 00045 * SNMP versions 00046 */ 00047 /* 00048 * There currently exists the following SNMP versions. 00049 * * (Note that only SNMPv1 is in widespread usage, and this code supports 00050 * * only SNMPv1, SNMPv2c, and SNMPv3. 00051 * * 00052 * * SNMPv1 - (full) the original version, defined by RFC 1157 00053 * * SNMPsec - (historic) the first attempt to add strong security 00054 * * to SNMPv1, defined by RFCs 1351, 1352, and 1353. 00055 * * SNMPv2p - (historic) party-based SNMP, which was another 00056 * * attempt to add strong security to SNMP, defined 00057 * * by RFCs 1441, 1445, 1446, 1448, and 1449. 00058 * * SNMPv2c - (experimental) community string-based SNMPv2, 00059 * * which was an attempt to combine the protocol 00060 * * operations of SNMPv2 with the security of 00061 * * SNMPv1, defined by RFCs 1901, 1905, and 1906. 00062 * * SNMPv2u - (experimental) user-based SNMPv2, which provided 00063 * * security based on user names and protocol 00064 * * operations of SNMPv2, defined by RFCs 1905, 00065 * * 1909, and 1910. 00066 * * SNMPv2* (or SNMPv2star) - (experimental) an attempt to add the 00067 * * best features of SNMPv2p and SNMPv2u, defined 00068 * * by unpublished documents found at WEB site 00069 * * owned by SNMP Research (a leading SNMP vendor) 00070 * * SNMPv3 - the current attempt by the IETF working group to merge 00071 * * the SNMPv2u and SNMPv2* proposals into a more widly 00072 * * accepted SNMPv3. It is defined by not yet published 00073 * * documents of the IETF SNMPv3 WG. 00074 * * 00075 * * SNMPv1, SNMPv2c, SNMPv2u, and SNMPv3 messages have a common 00076 * * form, which is an ASN.1 sequence containing a message version 00077 * * field, followed by version dependent fields. 00078 * * SNMPsec, SNMPv2p, and SNMPv2* messages have a common form, 00079 * * which is a tagged ASN.1 context specific sequence containing 00080 * * message dependent fields. 00081 * * 00082 * * In the #defines for the message versions below, the value 00083 * * for SNMPv1, SNMPv2c, SNMPv2u, and SNMPv3 messages is the 00084 * * value of the message version field. Since SNMPsec, SNMPv2p, 00085 * * and SNMPv2* messages do not have a message version field, 00086 * * the value in the defines for them is choosen to be a large 00087 * * arbitrary number. 00088 * * 00089 * * Note that many of the version ID's are defined below purely for 00090 * * documentational purposes. At this point the only protocol planned 00091 * * for future implementations is SNMP3, as the other v2 protocols will 00092 * * not be supported by the IETF (ie, v2u, v2sec, v2star) or used by 00093 * * the snmp community at large (at the time of this writing). 00094 */ 00095 00096 /* 00097 * versions based on version field 00098 */ 00099 #ifndef NETSNMP_DISABLE_SNMPV1 00100 #define SNMP_VERSION_1 0 00101 #endif 00102 #ifndef NETSNMP_DISABLE_SNMPV2C 00103 #define SNMP_VERSION_2c 1 00104 #endif 00105 #define SNMP_VERSION_2u 2 /* not (will never be) supported by this code */ 00106 #define SNMP_VERSION_3 3 00107 00108 /* 00109 * versions not based on a version field 00110 */ 00111 #define SNMP_VERSION_sec 128 /* not (will never be) supported by this code */ 00112 #define SNMP_VERSION_2p 129 /* no longer supported by this code (> 4.0) */ 00113 #define SNMP_VERSION_2star 130 /* not (will never be) supported by this code */ 00114 00115 /* 00116 * PDU types in SNMPv1, SNMPsec, SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 00117 */ 00118 #define SNMP_MSG_GET (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x0) /* a0=160 */ 00119 #define SNMP_MSG_GETNEXT (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x1) /* a1=161 */ 00120 #define SNMP_MSG_RESPONSE (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x2) /* a2=162 */ 00121 #ifndef NETSNMP_NO_WRITE_SUPPORT 00122 #define SNMP_MSG_SET (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x3) /* a3=163 */ 00123 #endif /* !NETSNMP_NO_WRITE_SUPPORT */ 00124 00125 /* 00126 * PDU types in SNMPv1 and SNMPsec 00127 */ 00128 #define SNMP_MSG_TRAP (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x4) /* a4=164 */ 00129 00130 /* 00131 * PDU types in SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 00132 */ 00133 #define SNMP_MSG_GETBULK (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x5) /* a5=165 */ 00134 #define SNMP_MSG_INFORM (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x6) /* a6=166 */ 00135 #define SNMP_MSG_TRAP2 (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x7) /* a7=167 */ 00136 00137 /* 00138 * PDU types in SNMPv2u, SNMPv2*, and SNMPv3 00139 */ 00140 #define SNMP_MSG_REPORT (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x8) /* a8=168 */ 00141 00142 #ifndef NETSNMP_NO_WRITE_SUPPORT 00143 /* 00144 * internal modes that should never be used by the protocol for the 00145 * pdu type. 00146 * 00147 * All modes < 128 are reserved for SET requests. 00148 */ 00149 #define SNMP_MSG_INTERNAL_SET_BEGIN -1 00150 #define SNMP_MSG_INTERNAL_SET_RESERVE1 0 /* these should match snmp.h */ 00151 #define SNMP_MSG_INTERNAL_SET_RESERVE2 1 00152 #define SNMP_MSG_INTERNAL_SET_ACTION 2 00153 #define SNMP_MSG_INTERNAL_SET_COMMIT 3 00154 #define SNMP_MSG_INTERNAL_SET_FREE 4 00155 #define SNMP_MSG_INTERNAL_SET_UNDO 5 00156 #define SNMP_MSG_INTERNAL_SET_MAX 6 00157 00158 #define SNMP_MSG_INTERNAL_CHECK_VALUE 17 00159 #define SNMP_MSG_INTERNAL_ROW_CREATE 18 00160 #define SNMP_MSG_INTERNAL_UNDO_SETUP 19 00161 #define SNMP_MSG_INTERNAL_SET_VALUE 20 00162 #define SNMP_MSG_INTERNAL_CHECK_CONSISTENCY 21 00163 #define SNMP_MSG_INTERNAL_UNDO_SET 22 00164 #define SNMP_MSG_INTERNAL_COMMIT 23 00165 #define SNMP_MSG_INTERNAL_UNDO_COMMIT 24 00166 #define SNMP_MSG_INTERNAL_IRREVERSIBLE_COMMIT 25 00167 #define SNMP_MSG_INTERNAL_UNDO_CLEANUP 26 00168 #endif /* !NETSNMP_NO_WRITE_SUPPORT */ 00169 00170 /* 00171 * modes > 128 for non sets. 00172 * Note that 160-168 overlap with SNMP ASN1 pdu types 00173 */ 00174 #define SNMP_MSG_INTERNAL_PRE_REQUEST 128 00175 #define SNMP_MSG_INTERNAL_OBJECT_LOOKUP 129 00176 #define SNMP_MSG_INTERNAL_POST_REQUEST 130 00177 #define SNMP_MSG_INTERNAL_GET_STASH 131 00178 00179 /* 00180 * test for member of Confirmed Class i.e., reportable 00181 */ 00182 #ifdef NETSNMP_NO_WRITE_SUPPORT 00183 #define SNMP_CMD_CONFIRMED(c) (c == SNMP_MSG_INFORM || c == SNMP_MSG_GETBULK ||\ 00184 c == SNMP_MSG_GETNEXT || c == SNMP_MSG_GET ) 00185 #else /* !NETSNMP_NO_WRITE_SUPPORT */ 00186 #define SNMP_CMD_CONFIRMED(c) (c == SNMP_MSG_INFORM || c == SNMP_MSG_GETBULK ||\ 00187 c == SNMP_MSG_GETNEXT || c == SNMP_MSG_GET || \ 00188 c == SNMP_MSG_SET ) 00189 #endif /* !NETSNMP_NO_WRITE_SUPPORT */ 00190 00191 /* 00192 * Exception values for SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 00193 */ 00194 #define SNMP_NOSUCHOBJECT (ASN_CONTEXT | ASN_PRIMITIVE | 0x0) /* 80=128 */ 00195 #define SNMP_NOSUCHINSTANCE (ASN_CONTEXT | ASN_PRIMITIVE | 0x1) /* 81=129 */ 00196 #define SNMP_ENDOFMIBVIEW (ASN_CONTEXT | ASN_PRIMITIVE | 0x2) /* 82=130 */ 00197 00198 /* 00199 * Error codes (the value of the field error-status in PDUs) 00200 */ 00201 00202 /* 00203 * in SNMPv1, SNMPsec, SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs 00204 */ 00205 #define SNMP_ERR_NOERROR (0) /* XXX Used only for PDUs? */ 00206 #define SNMP_ERR_TOOBIG (1) 00207 #define SNMP_ERR_NOSUCHNAME (2) 00208 #define SNMP_ERR_BADVALUE (3) 00209 #define SNMP_ERR_READONLY (4) 00210 #define SNMP_ERR_GENERR (5) 00211 00212 /* 00213 * in SNMPv2p, SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs 00214 */ 00215 #define SNMP_ERR_NOACCESS (6) 00216 #define SNMP_ERR_WRONGTYPE (7) 00217 #define SNMP_ERR_WRONGLENGTH (8) 00218 #define SNMP_ERR_WRONGENCODING (9) 00219 #define SNMP_ERR_WRONGVALUE (10) 00220 #define SNMP_ERR_NOCREATION (11) 00221 #define SNMP_ERR_INCONSISTENTVALUE (12) 00222 #define SNMP_ERR_RESOURCEUNAVAILABLE (13) 00223 #define SNMP_ERR_COMMITFAILED (14) 00224 #define SNMP_ERR_UNDOFAILED (15) 00225 #define SNMP_ERR_AUTHORIZATIONERROR (16) 00226 #define SNMP_ERR_NOTWRITABLE (17) 00227 00228 /* 00229 * in SNMPv2c, SNMPv2u, SNMPv2*, and SNMPv3 PDUs 00230 */ 00231 #define SNMP_ERR_INCONSISTENTNAME (18) 00232 00233 #define MAX_SNMP_ERR 18 00234 00235 #define SNMP_VALIDATE_ERR(x) ( (x > MAX_SNMP_ERR) ? \ 00236 SNMP_ERR_GENERR : \ 00237 (x < SNMP_ERR_NOERROR) ? \ 00238 SNMP_ERR_GENERR : \ 00239 x ) 00240 00241 /* 00242 * values of the generic-trap field in trap PDUs 00243 */ 00244 #define SNMP_TRAP_COLDSTART (0) 00245 #define SNMP_TRAP_WARMSTART (1) 00246 #define SNMP_TRAP_LINKDOWN (2) 00247 #define SNMP_TRAP_LINKUP (3) 00248 #define SNMP_TRAP_AUTHFAIL (4) 00249 #define SNMP_TRAP_EGPNEIGHBORLOSS (5) 00250 #define SNMP_TRAP_ENTERPRISESPECIFIC (6) 00251 00252 /* 00253 * row status values 00254 */ 00255 #define SNMP_ROW_NONEXISTENT 0 00256 #define SNMP_ROW_ACTIVE 1 00257 #define SNMP_ROW_NOTINSERVICE 2 00258 #define SNMP_ROW_NOTREADY 3 00259 #define SNMP_ROW_CREATEANDGO 4 00260 #define SNMP_ROW_CREATEANDWAIT 5 00261 #define SNMP_ROW_DESTROY 6 00262 00263 /* 00264 * row storage values 00265 */ 00266 #define SNMP_STORAGE_NONE 0 00267 #define SNMP_STORAGE_OTHER 1 00268 #define SNMP_STORAGE_VOLATILE 2 00269 #define SNMP_STORAGE_NONVOLATILE 3 00270 #define SNMP_STORAGE_PERMANENT 4 00271 #define SNMP_STORAGE_READONLY 5 00272 00273 /* 00274 * message processing models 00275 */ 00276 #define SNMP_MP_MODEL_SNMPv1 0 00277 #define SNMP_MP_MODEL_SNMPv2c 1 00278 #define SNMP_MP_MODEL_SNMPv2u 2 00279 #define SNMP_MP_MODEL_SNMPv3 3 00280 #define SNMP_MP_MODEL_SNMPv2p 256 00281 00282 /* 00283 * security values 00284 */ 00285 #define SNMP_SEC_MODEL_ANY 0 00286 #define SNMP_SEC_MODEL_SNMPv1 1 00287 #define SNMP_SEC_MODEL_SNMPv2c 2 00288 #define SNMP_SEC_MODEL_USM 3 00289 #define SNMP_SEC_MODEL_TSM 4 00290 #define SNMP_SEC_MODEL_SNMPv2p 256 00291 00292 #define SNMP_SEC_LEVEL_NOAUTH 1 00293 #define SNMP_SEC_LEVEL_AUTHNOPRIV 2 00294 #define SNMP_SEC_LEVEL_AUTHPRIV 3 00295 00296 #define SNMP_MSG_FLAG_AUTH_BIT 0x01 00297 #define SNMP_MSG_FLAG_PRIV_BIT 0x02 00298 #define SNMP_MSG_FLAG_RPRT_BIT 0x04 00299 00300 /* 00301 * control PDU handling characteristics 00302 */ 00303 #define UCD_MSG_FLAG_RESPONSE_PDU 0x100 00304 #define UCD_MSG_FLAG_EXPECT_RESPONSE 0x200 00305 #define UCD_MSG_FLAG_FORCE_PDU_COPY 0x400 00306 #define UCD_MSG_FLAG_ALWAYS_IN_VIEW 0x800 00307 #define UCD_MSG_FLAG_PDU_TIMEOUT 0x1000 00308 #define UCD_MSG_FLAG_ONE_PASS_ONLY 0x2000 00309 #define UCD_MSG_FLAG_TUNNELED 0x4000 00310 00311 /* 00312 * view status 00313 */ 00314 #define SNMP_VIEW_INCLUDED 1 00315 #define SNMP_VIEW_EXCLUDED 2 00316 00317 /* 00318 * basic oid values 00319 */ 00320 #define SNMP_OID_INTERNET 1, 3, 6, 1 00321 #define SNMP_OID_ENTERPRISES SNMP_OID_INTERNET, 4, 1 00322 #define SNMP_OID_MIB2 SNMP_OID_INTERNET, 2, 1 00323 #define SNMP_OID_SNMPV2 SNMP_OID_INTERNET, 6 00324 #define SNMP_OID_SNMPMODULES SNMP_OID_SNMPV2, 3 00325 00326 /* 00327 * lengths as defined by TCs 00328 */ 00329 #define SNMPADMINLENGTH 255 00330 00331 00332 NETSNMP_IMPORT 00333 char *uptime_string(u_long, char *); 00334 char *uptime_string_n(u_long, char *, size_t); 00335 NETSNMP_IMPORT 00336 void xdump(const void *, size_t, const char *); 00337 NETSNMP_IMPORT 00338 u_char *snmp_parse_var_op(u_char *, oid *, size_t *, u_char *, 00339 size_t *, u_char **, size_t *); 00340 NETSNMP_IMPORT 00341 u_char *snmp_build_var_op(u_char *, oid *, size_t *, u_char, 00342 size_t, u_char *, size_t *); 00343 00344 00345 #ifdef NETSNMP_USE_REVERSE_ASNENCODING 00346 int snmp_realloc_rbuild_var_op(u_char ** pkt, 00347 size_t * pkt_len, 00348 size_t * offset, 00349 int allow_realloc, 00350 const oid * name, 00351 size_t * name_len, 00352 u_char value_type, 00353 u_char * value, 00354 size_t value_length); 00355 #endif 00356 00357 #ifdef __cplusplus 00358 } 00359 #endif 00360 #endif /* SNMP_H */