/*********************************************************** Copyright 1989 by Carnegie Mellon University All Rights Reserved Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of CMU not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************/ /* * snmp_api.h - API for access to snmp. */ #ifndef _SNMP_API_H #define _SNMP_API_H #undef _ANSI_ARGS_ #if (defined(__STDC__) && ! defined(NO_PROTOTYPE)) || defined(USE_PROTOTYPE) # define _ANSI_ARGS_(x) x #else # define _ANSI_ARGS_(x) () #endif #include #include #include #ifdef HAVE_IPX # ifdef linux # include # endif #endif #if defined(sun) && !defined(__svr4__) typedef int ssize_t; #endif #include "asn1.h" typedef struct sockaddr_in ipaddr; #ifdef HAVE_IPX # ifdef linux typedef struct sockaddr_ipx ipxaddr; # endif #endif typedef struct { u_char securityModel; u_char qoS; u_char agentID[12]; u_long agentBoots; int agentTime; int MMS; int userLen; u_char userName[16]; int authLen; u_char authDigest[16]; u_char *authDigestPtr; int contextLen; u_char contextSelector[40]; } Parameters; /* * Set fields in session and pdu to the following to get a default or * unconfigured value. */ #define SNMP_DEFAULT_COMMUNITY_LEN 0 /* to get a default community name */ #define SNMP_DEFAULT_RETRIES -1 #define SNMP_DEFAULT_TIMEOUT -1 #define SNMP_DEFAULT_REMPORT 0 #define SNMP_DEFAULT_REQID 0 #define SNMP_DEFAULT_ERRSTAT -1 #define SNMP_DEFAULT_ERRINDEX -1 #define SNMP_DEFAULT_ADDRESS 0 #define SNMP_DEFAULT_PEERNAME NULL #define SNMP_DEFAULT_ENTERPRISE_LENGTH 0 #define SNMP_DEFAULT_TIME 0 /* * default initial timeout and default retries; * the timeout is doubled for every retry: * this gives: 0.3 + 0.6 + 1.2 + 2.4 + 4.8 = 9.3 (seconds) */ #define SNMP_API_DEFAULT_RETRIES 6 #define SNMP_API_DEFAULT_TIMEOUT 300000L extern int snmp_errno; /* Error return values */ #define SNMPERR_GENERR -1 #define SNMPERR_BAD_LOCPORT -2 /* local port was already in use */ #define SNMPERR_BAD_ADDRESS -3 #define SNMPERR_BAD_SESSION -4 #define SNMPERR_TOO_LONG -5 struct snmp_pdu { #ifdef HAVE_IPX struct sockaddr address; /* Address of peer (ip or ipx addr) */ #else ipaddr address; /* Address of peer (ip addr) */ #endif int command; /* Type of this PDU */ Parameters params; u_long reqid; /* Request id */ u_long errstat; /* Error status */ u_long errindex; /* Error index */ /* Trap information */ oid *enterprise;/* System OID */ int enterprise_length; ipaddr agent_addr; /* address of object generating trap */ int trap_type; /* trap type */ int specific_type; /* specific type */ u_long time; /* Uptime */ struct variable_list *variables; }; struct snmp_session { int retries; /* Number of retries before timeout. */ long timeout; /* Number of uS until first timeout, then exponential backoff */ char *peername; /* Domain name or dotted IP address or IPX address of default peer */ u_short remote_port; /* UDP port number of peer. */ u_short local_port; /* My UDP port number, 0 for default, picked randomly */ #ifdef HAVE_IPX u_short remote_port_ipx; /* IPX port number of peer. */ u_short local_port_ipx; /* My IPX port number, 0 for default, picked randomly */ #endif /* Authentication function or NULL if null authentication is used */ int (*authenticator)(); #if 1 /* Function to interpret incoming data */ int (*callback) _ANSI_ARGS_(( int operation, struct snmp_session *session, int reqid, struct snmp_pdu *response, void *magic, ... )); #else int (*callback)(); #endif /* Pointer to data that the callback function may consider important */ void *callback_magic; int version; /* SNMP version number */ /* fields to support SNMPv1 community model */ int community_len; u_char *community; /* the private keys to use for user-based security */ u_char authKey[16]; u_char privKey[16]; /* fields to support user-based security model in SNMPv2 */ Parameters params; u_char qoS; u_char agentID[16]; u_long agentBoots; int agentTime; /* the agentTime value */ int agentClock; /* the running agentClock */ int userLen; u_char userName[32]; int MMS; int contextLen; u_char contextSelector[64]; /* misc stuff */ int readView; int writeView; }; struct variable_list { struct variable_list *next_variable; /* NULL for last variable */ oid *name; /* Object identifier of variable */ int name_length; /* number of subid's in name */ u_char type; /* ASN type of variable */ union { /* value of variable */ long *integer; u_char *string; oid *objid; u_char *bitstring; struct counter64 *counter64; } val; int val_len; }; /* * struct snmp_session *snmp_open(session) * struct snmp_session *session; * * Sets up the session with the snmp_session information provided * by the user. Then opens and binds the necessary UDP port. * A handle to the created session is returned (this is different than * the pointer passed to snmp_open()). On any error, NULL is returned * and snmp_errno is set to the appropriate error code. */ struct snmp_session *snmp_open _ANSI_ARGS_((struct snmp_session *session)); /* * int snmp_close(session) * struct snmp_session *session; * * Close the input session. Frees all data allocated for the session, * dequeues any pending requests, and closes any sockets allocated for * the session. Returns 0 on error, 1 otherwise. */ int snmp_close _ANSI_ARGS_((struct snmp_session *session)); /* * int snmp_send(session, pdu) * struct snmp_session *session; * struct snmp_pdu *pdu; * * Sends the input pdu on the session after calling snmp_build to create * a serialized packet. If necessary, set some of the pdu data from the * session defaults. Add a request corresponding to this pdu to the list * of outstanding requests on this session, then send the pdu. * Returns the request id of the generated packet if applicable, otherwise 1. * On any error, 0 is returned. * The pdu is freed by snmp_send() unless a failure occured. */ int snmp_send _ANSI_ARGS_((struct snmp_session *session, struct snmp_pdu *pdu)); /* * void snmp_read(fdset) * fd_set *fdset; * * Checks to see if any of the fd's set in the fdset belong to * snmp. Each socket with it's fd set has a packet read from it * and snmp_parse is called on the packet received. The resulting pdu * is passed to the callback routine for that session. If the callback * routine returns successfully, the pdu and it's request are deleted. */ void snmp_read _ANSI_ARGS_((fd_set *fdset)); /* * void * snmp_free_pdu(pdu) * struct snmp_pdu *pdu; * * Frees the pdu and any malloc'd data associated with it. */ void snmp_free_pdu _ANSI_ARGS_((struct snmp_pdu *pdu)); /* * int snmp_select_info(numfds, fdset, timeout, block) * int *numfds; * fd_set *fdset; * struct timeval *timeout; * int *block; * * Returns info about what snmp requires from a select statement. * numfds is the number of fds in the list that are significant. * All file descriptors opened for SNMP are OR'd into the fdset. * If activity occurs on any of these file descriptors, snmp_read * should be called with that file descriptor set. * * The timeout is the latest time that SNMP can wait for a timeout. The * select should be done with the minimum time between timeout and any other * timeouts necessary. This should be checked upon each invocation of select. * If a timeout is received, snmp_timeout should be called to check if the * timeout was for SNMP. (snmp_timeout is idempotent) * * Block is 1 if the select is requested to block indefinitely, rather than time out. * If block is input as 1, the timeout value will be treated as undefined, but it must * be available for setting in snmp_select_info. On return, if block is true, the value * of timeout will be undefined. * * snmp_select_info returns the number of open sockets. (i.e. The number of sessions open) */ int snmp_select_info _ANSI_ARGS_((int *numfds, fd_set *fdset, struct timeval *timeout, int *block)); /* * void snmp_timeout(); * * snmp_timeout should be called whenever the timeout from snmp_select_info expires, * but it is idempotent, so snmp_timeout can be polled (probably a cpu expensive * proposition). snmp_timeout checks to see if any of the sessions have an * outstanding request that has timed out. If it finds one (or more), and that * pdu has more retries available, a new packet is formed from the pdu and is * resent. If there are no more retries available, the callback for the session * is used to alert the user of the timeout. */ void snmp_timeout _ANSI_ARGS_((void)); /* * This routine must be supplied by the application: * * u_char *authenticator(pdu, length, community, community_len) * u_char *pdu; The rest of the PDU to be authenticated * int *length; The length of the PDU (updated by the authenticator) * u_char *community; The community name to authenticate under. * int community_len The length of the community name. * * Returns the authenticated pdu, or NULL if authentication failed. * If null authentication is used, the authenticator in snmp_session can be * set to NULL(0). */ /* * This routine must be supplied by the application: * * int callback(operation, session, reqid, response, magic, request) * int operation; * struct snmp_session *session; The session authenticated under. * int reqid; The request id of this pdu (0 for TRAP) * struct snmp_pdu *response; The pdu information. * void *magic A link to the data for this routine. * struct snmp_pdu *request; The pdu information. * * note: the request parameter was added in cmu-snmp-linux-3.5. It should * not break old code, because it would be only a unused passed * parameter. * * Returns 1 if request was successful, 0 if it should be kept pending. * Any data in the pdu must be copied because it will be freed elsewhere. * Operations are defined below: */ #define RECEIVED_MESSAGE 1 #define TIMED_OUT 2 extern int snmp_dump_packet; #ifdef HAVE_IPX char *ipx_ntoa(ipxaddr *); int ipx_addr(const char *, ipxaddr *); #endif #endif /* _SNMP_API_H */