/contrib/bsnmp/lib/snmpclient.h

https://bitbucket.org/freebsd/freebsd-head/ · C++ Header · 201 lines · 83 code · 41 blank · 77 comment · 1 complexity · 8b75169b1b8bb96435aec75c13f40a67 MD5 · raw file

  1. /*
  2. * Copyright (c) 2001-2003
  3. * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
  4. * All rights reserved.
  5. *
  6. * Author: Harti Brandt <harti@freebsd.org>
  7. * Kendy Kutzner
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. * 2. Redistributions in binary form must reproduce the above copyright
  15. * notice, this list of conditions and the following disclaimer in the
  16. * documentation and/or other materials provided with the distribution.
  17. *
  18. * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21. * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  22. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28. * SUCH DAMAGE.
  29. *
  30. * $Begemot: bsnmp/lib/snmpclient.h,v 1.19 2005/05/23 11:10:14 brandt_h Exp $
  31. */
  32. #ifndef _BSNMP_SNMPCLIENT_H
  33. #define _BSNMP_SNMPCLIENT_H
  34. #include <sys/types.h>
  35. #include <sys/socket.h>
  36. #include <sys/time.h>
  37. #include <netinet/in.h>
  38. #include <stddef.h>
  39. #define SNMP_STRERROR_LEN 200
  40. #define SNMP_LOCAL_PATH "/tmp/snmpXXXXXXXXXXXXXX"
  41. /*
  42. * transport methods
  43. */
  44. #define SNMP_TRANS_UDP 0
  45. #define SNMP_TRANS_LOC_DGRAM 1
  46. #define SNMP_TRANS_LOC_STREAM 2
  47. /* type of callback function for responses
  48. * this callback function is responsible for free() any memory associated with
  49. * any of the PDUs. Therefor it may call snmp_pdu_free() */
  50. typedef void (*snmp_send_cb_f)(struct snmp_pdu *, struct snmp_pdu *, void *);
  51. /* type of callback function for timeouts */
  52. typedef void (*snmp_timeout_cb_f)(void * );
  53. /* timeout start function */
  54. typedef void *(*snmp_timeout_start_f)(struct timeval *timeout,
  55. snmp_timeout_cb_f callback, void *);
  56. /* timeout stop function */
  57. typedef void (*snmp_timeout_stop_f)(void *timeout_id);
  58. /*
  59. * Client context.
  60. */
  61. struct snmp_client {
  62. enum snmp_version version;
  63. int trans; /* which transport to use */
  64. /* these two are read-only for the application */
  65. char *cport; /* port number as string */
  66. char *chost; /* host name or IP address as string */
  67. char read_community[SNMP_COMMUNITY_MAXLEN + 1];
  68. char write_community[SNMP_COMMUNITY_MAXLEN + 1];
  69. /* SNMPv3 specific fields */
  70. int32_t identifier;
  71. int32_t security_model;
  72. struct snmp_engine engine;
  73. struct snmp_user user;
  74. /* SNMPv3 Access control - VACM*/
  75. uint32_t clen;
  76. uint8_t cengine[SNMP_ENGINE_ID_SIZ];
  77. char cname[SNMP_CONTEXT_NAME_SIZ];
  78. struct timeval timeout;
  79. u_int retries;
  80. int dump_pdus;
  81. size_t txbuflen;
  82. size_t rxbuflen;
  83. int fd;
  84. int32_t next_reqid;
  85. int32_t max_reqid;
  86. int32_t min_reqid;
  87. char error[SNMP_STRERROR_LEN];
  88. snmp_timeout_start_f timeout_start;
  89. snmp_timeout_stop_f timeout_stop;
  90. char local_path[sizeof(SNMP_LOCAL_PATH)];
  91. };
  92. /* the global context */
  93. extern struct snmp_client snmp_client;
  94. /* initizialies a snmp_client structure */
  95. void snmp_client_init(struct snmp_client *);
  96. /* initialize fields */
  97. int snmp_client_set_host(struct snmp_client *, const char *);
  98. int snmp_client_set_port(struct snmp_client *, const char *);
  99. /* open connection to snmp server (hostname or portname can be NULL) */
  100. int snmp_open(const char *_hostname, const char *_portname,
  101. const char *_read_community, const char *_write_community);
  102. /* close connection */
  103. void snmp_close(void);
  104. /* initialize a snmp_pdu structure */
  105. void snmp_pdu_create(struct snmp_pdu *, u_int _op);
  106. /* add pairs of (struct asn_oid *, enum snmp_syntax) to an existing pdu */
  107. int snmp_add_binding(struct snmp_pdu *, ...);
  108. /* check wheater the answer is valid or not */
  109. int snmp_pdu_check(const struct snmp_pdu *_req, const struct snmp_pdu *_resp);
  110. int32_t snmp_pdu_send(struct snmp_pdu *_pdu, snmp_send_cb_f _func, void *_arg);
  111. /* append an index to an oid */
  112. int snmp_oid_append(struct asn_oid *_oid, const char *_fmt, ...);
  113. /* receive a packet */
  114. int snmp_receive(int _blocking);
  115. /*
  116. * This structure is used to describe an SNMP table that is to be fetched.
  117. * The C-structure that is produced by the fetch function must start with
  118. * a TAILQ_ENTRY and an u_int64_t.
  119. */
  120. struct snmp_table {
  121. /* base OID of the table */
  122. struct asn_oid table;
  123. /* type OID of the LastChange variable for the table if any */
  124. struct asn_oid last_change;
  125. /* maximum number of iterations if table has changed */
  126. u_int max_iter;
  127. /* size of the C-structure */
  128. size_t entry_size;
  129. /* number of index fields */
  130. u_int index_size;
  131. /* bit mask of required fields */
  132. uint64_t req_mask;
  133. /* indexes and columns to fetch. Ended by a NULL syntax entry */
  134. struct snmp_table_entry {
  135. /* the column sub-oid, ignored for index fields */
  136. asn_subid_t subid;
  137. /* the syntax of the column or index */
  138. enum snmp_syntax syntax;
  139. /* offset of the field into the C-structure. For octet strings
  140. * this points to an u_char * followed by a size_t */
  141. off_t offset;
  142. #if defined(__GNUC__) && __GNUC__ < 3
  143. } entries[0];
  144. #else
  145. } entries[];
  146. #endif
  147. };
  148. /* callback type for table fetch */
  149. typedef void (*snmp_table_cb_f)(void *_list, void *_arg, int _res);
  150. /* fetch a table. The argument points to a TAILQ_HEAD */
  151. int snmp_table_fetch(const struct snmp_table *descr, void *);
  152. int snmp_table_fetch_async(const struct snmp_table *, void *,
  153. snmp_table_cb_f, void *);
  154. /* send a request and wait for the response */
  155. int snmp_dialog(struct snmp_pdu *_req, struct snmp_pdu *_resp);
  156. /* discover an authorative snmpEngineId */
  157. int snmp_discover_engine(char *);
  158. /* parse a server specification */
  159. int snmp_parse_server(struct snmp_client *, const char *);
  160. #endif /* _BSNMP_SNMPCLIENT_H */