2 * Copyright (c) 2001-2003
3 * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
6 * Author: Harti Brandt <harti@freebsd.org>
8 * Copyright (c) 2010 The FreeBSD Foundation
11 * Portions of this software were developed by Shteryana Sotirova Shopova
12 * under sponsorship from the FreeBSD Foundation.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * $Begemot: bsnmp/snmpd/snmpmod.h,v 1.32 2006/02/14 09:04:20 brandt_h Exp $
37 * SNMP daemon data and functions exported to modules.
42 #include <sys/types.h>
43 #include <sys/socket.h>
45 #include <netinet/in.h>
48 #include "snmpagent.h"
50 #define MAX_MOD_ARGS 16
53 * These macros help to handle object lists for SNMP tables. They use
54 * tail queues to hold the objects in ascending order in the list.
55 * ordering can be done either on an integer/unsigned field, an asn_oid
56 * or an ordering function.
58 #define INSERT_OBJECT_OID_LINK_INDEX(PTR, LIST, LINK, INDEX) do { \
59 __typeof (PTR) _lelem; \
61 TAILQ_FOREACH(_lelem, (LIST), LINK) \
62 if (asn_compare_oid(&_lelem->INDEX, &(PTR)->INDEX) > 0) \
65 TAILQ_INSERT_TAIL((LIST), (PTR), LINK); \
67 TAILQ_INSERT_BEFORE(_lelem, (PTR), LINK); \
70 #define INSERT_OBJECT_INT_LINK_INDEX(PTR, LIST, LINK, INDEX) do { \
71 __typeof (PTR) _lelem; \
73 TAILQ_FOREACH(_lelem, (LIST), LINK) \
74 if ((asn_subid_t)_lelem->INDEX > (asn_subid_t)(PTR)->INDEX)\
77 TAILQ_INSERT_TAIL((LIST), (PTR), LINK); \
79 TAILQ_INSERT_BEFORE(_lelem, (PTR), LINK); \
82 #define INSERT_OBJECT_FUNC_LINK(PTR, LIST, LINK, FUNC) do { \
83 __typeof (PTR) _lelem; \
85 TAILQ_FOREACH(_lelem, (LIST), LINK) \
86 if ((FUNC)(_lelem, (PTR)) > 0) \
89 TAILQ_INSERT_TAIL((LIST), (PTR), LINK); \
91 TAILQ_INSERT_BEFORE(_lelem, (PTR), LINK); \
94 #define INSERT_OBJECT_FUNC_LINK_REV(PTR, LIST, HEAD, LINK, FUNC) do { \
95 __typeof (PTR) _lelem; \
97 TAILQ_FOREACH_REVERSE(_lelem, (LIST), HEAD, LINK) \
98 if ((FUNC)(_lelem, (PTR)) < 0) \
100 if (_lelem == NULL) \
101 TAILQ_INSERT_HEAD((LIST), (PTR), LINK); \
103 TAILQ_INSERT_AFTER((LIST), _lelem, (PTR), LINK); \
106 #define FIND_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, LINK, INDEX) ({ \
107 __typeof (TAILQ_FIRST(LIST)) _lelem; \
109 TAILQ_FOREACH(_lelem, (LIST), LINK) \
110 if (index_compare(OID, SUB, &_lelem->INDEX) == 0) \
115 #define NEXT_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, LINK, INDEX) ({ \
116 __typeof (TAILQ_FIRST(LIST)) _lelem; \
118 TAILQ_FOREACH(_lelem, (LIST), LINK) \
119 if (index_compare(OID, SUB, &_lelem->INDEX) < 0) \
124 #define FIND_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, LINK, INDEX) ({ \
125 __typeof (TAILQ_FIRST(LIST)) _lelem; \
127 if ((OID)->len - SUB != 1) \
130 TAILQ_FOREACH(_lelem, (LIST), LINK) \
131 if ((OID)->subs[SUB] == (asn_subid_t)_lelem->INDEX)\
136 #define NEXT_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, LINK, INDEX) ({ \
137 __typeof (TAILQ_FIRST(LIST)) _lelem; \
139 if ((OID)->len - SUB == 0) \
140 _lelem = TAILQ_FIRST(LIST); \
142 TAILQ_FOREACH(_lelem, (LIST), LINK) \
143 if ((OID)->subs[SUB] < (asn_subid_t)_lelem->INDEX)\
148 #define FIND_OBJECT_FUNC_LINK(LIST, OID, SUB, LINK, FUNC) ({ \
149 __typeof (TAILQ_FIRST(LIST)) _lelem; \
151 TAILQ_FOREACH(_lelem, (LIST), LINK) \
152 if ((FUNC)(OID, SUB, _lelem) == 0) \
157 #define NEXT_OBJECT_FUNC_LINK(LIST, OID, SUB, LINK, FUNC) ({ \
158 __typeof (TAILQ_FIRST(LIST)) _lelem; \
160 TAILQ_FOREACH(_lelem, (LIST), LINK) \
161 if ((FUNC)(OID, SUB, _lelem) < 0) \
167 * Macros for the case where the index field is called 'index'
169 #define INSERT_OBJECT_OID_LINK(PTR, LIST, LINK) \
170 INSERT_OBJECT_OID_LINK_INDEX(PTR, LIST, LINK, index)
172 #define INSERT_OBJECT_INT_LINK(PTR, LIST, LINK) do { \
173 INSERT_OBJECT_INT_LINK_INDEX(PTR, LIST, LINK, index)
175 #define FIND_OBJECT_OID_LINK(LIST, OID, SUB, LINK) \
176 FIND_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, LINK, index)
178 #define NEXT_OBJECT_OID_LINK(LIST, OID, SUB, LINK) \
179 NEXT_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, LINK, index)
181 #define FIND_OBJECT_INT_LINK(LIST, OID, SUB, LINK) \
182 FIND_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, LINK, index)
184 #define NEXT_OBJECT_INT_LINK(LIST, OID, SUB, LINK) \
185 NEXT_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, LINK, index)
188 * Macros for the case where the index field is called 'index' and the
191 #define INSERT_OBJECT_OID(PTR, LIST) \
192 INSERT_OBJECT_OID_LINK_INDEX(PTR, LIST, link, index)
194 #define INSERT_OBJECT_INT(PTR, LIST) \
195 INSERT_OBJECT_INT_LINK_INDEX(PTR, LIST, link, index)
197 #define INSERT_OBJECT_FUNC_REV(PTR, LIST, HEAD, FUNC) \
198 INSERT_OBJECT_FUNC_LINK_REV(PTR, LIST, HEAD, link, FUNC)
200 #define FIND_OBJECT_OID(LIST, OID, SUB) \
201 FIND_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, link, index)
203 #define FIND_OBJECT_INT(LIST, OID, SUB) \
204 FIND_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, link, index)
206 #define FIND_OBJECT_FUNC(LIST, OID, SUB, FUNC) \
207 FIND_OBJECT_FUNC_LINK(LIST, OID, SUB, link, FUNC)
209 #define NEXT_OBJECT_OID(LIST, OID, SUB) \
210 NEXT_OBJECT_OID_LINK_INDEX(LIST, OID, SUB, link, index)
212 #define NEXT_OBJECT_INT(LIST, OID, SUB) \
213 NEXT_OBJECT_INT_LINK_INDEX(LIST, OID, SUB, link, index)
215 #define NEXT_OBJECT_FUNC(LIST, OID, SUB, FUNC) \
216 NEXT_OBJECT_FUNC_LINK(LIST, OID, SUB, link, FUNC)
220 /* The tick when the program was started. This is the absolute time of
221 * the start in 100th of a second. */
222 extern uint64_t start_tick;
224 /* The tick when the current packet was received. This is the absolute
225 * time in 100th of second. */
226 extern uint64_t this_tick;
228 /* Get the current absolute time in 100th of a second. */
229 uint64_t get_ticks(void);
232 * Return code for proxy function
234 enum snmpd_proxy_err {
235 /* proxy code will process the PDU */
237 /* proxy code does not process PDU */
241 /* drop because of bad community */
243 /* drop because of bad community use */
244 SNMPD_PROXY_BADCOMMUSE
250 enum snmpd_input_err {
251 /* proceed with packet */
253 /* fatal error in packet, ignore it */
255 /* value encoding has wrong length in a SET operation */
256 SNMPD_INPUT_VALBADLEN,
257 /* value encoding is out of range */
258 SNMPD_INPUT_VALRANGE,
259 /* value has bad encoding */
260 SNMPD_INPUT_VALBADENC,
261 /* need more data (truncated packet) */
263 /* unknown community */
264 SNMPD_INPUT_BAD_COMM,
268 * Every loadable module must have one of this structures with
269 * the external name 'config'.
272 /* a comment describing what this module implements */
275 /* the initialization function */
276 int (*init)(struct lmodule *, int argc, char *argv[]);
278 /* the finalisation function */
281 /* the idle function */
284 /* the dump function */
287 /* re-configuration function */
288 void (*config)(void);
290 /* start operation */
294 enum snmpd_proxy_err (*proxy)(struct snmp_pdu *, void *,
295 const struct asn_oid *, const struct sockaddr *, socklen_t,
296 enum snmpd_input_err, int32_t, int);
298 /* the tree this module is going to server */
299 const struct snmp_node *tree;
302 /* function called, when another module was unloaded/loaded */
303 void (*loading)(const struct lmodule *, int);
307 * Stuff exported to modules
315 struct asn_oid object_id;
320 u_int32_t or_last_change;
322 extern struct systemg systemg;
327 * We have 2 fixed communities for SNMP read and write access. Modules
328 * can create their communities dynamically. They are deleted automatically
329 * if the module is unloaded.
331 #define COMM_INITIALIZE 0
335 u_int comm_define(u_int, const char *descr, struct lmodule *, const char *str);
336 const char * comm_string(u_int);
338 /* community for current packet */
339 extern u_int community;
342 * SNMP User-based Security Model data. Modified via the snmp_usm(3) module.
344 struct snmpd_usmstat {
345 uint32_t unsupported_seclevels;
346 uint32_t not_in_time_windows;
347 uint32_t unknown_users;
348 uint32_t unknown_engine_ids;
349 uint32_t wrong_digests;
350 uint32_t decrypt_errors;
353 extern struct snmpd_usmstat snmpd_usmstats;
354 struct snmpd_usmstat *bsnmpd_get_usm_stats(void);
355 void bsnmpd_reset_usm_stats(void);
358 struct snmp_user suser;
359 uint8_t user_engine_id[SNMP_ENGINE_ID_SIZ];
360 uint32_t user_engine_len;
361 char user_public[SNMP_ADM_STR32_SIZ];
362 uint32_t user_public_len;
365 SLIST_ENTRY(usm_user) up;
368 SLIST_HEAD(usm_userlist, usm_user);
369 struct usm_user *usm_first_user(void);
370 struct usm_user *usm_next_user(struct usm_user *);
371 struct usm_user *usm_find_user(uint8_t *, uint32_t, char *);
372 struct usm_user *usm_new_user(uint8_t *, uint32_t, char *);
373 void usm_delete_user(struct usm_user *);
374 void usm_flush_users(void);
376 /* USM user for current packet */
377 extern struct usm_user *usm_user;
380 * SNMP View-based Access Control Model data. Modified via the snmp_vacm(3) module.
385 /* Security user name from USM */
386 char secname[SNMP_ADM_STR32_SIZ];
388 /* Back pointer to user assigned group name */
389 struct vacm_group *group;
392 SLIST_ENTRY(vacm_user) vvu;
393 SLIST_ENTRY(vacm_user) vvg;
396 SLIST_HEAD(vacm_userlist, vacm_user);
399 char groupname[SNMP_ADM_STR32_SIZ];
400 struct vacm_userlist group_users;
401 SLIST_ENTRY(vacm_group) vge;
404 SLIST_HEAD(vacm_grouplist, vacm_group);
407 /* The group name is index, not a column in the table */
408 struct vacm_group *group;
409 char ctx_prefix[SNMP_ADM_STR32_SIZ];
413 struct vacm_view *read_view;
414 struct vacm_view *write_view;
415 struct vacm_view *notify_view;
418 TAILQ_ENTRY(vacm_access) vva;
421 TAILQ_HEAD(vacm_accesslist, vacm_access);
424 char viewname[SNMP_ADM_STR32_SIZ]; /* key */
425 struct asn_oid subtree; /* key */
430 SLIST_ENTRY(vacm_view) vvl;
433 SLIST_HEAD(vacm_viewlist, vacm_view);
435 struct vacm_context {
436 /* The ID of the module that registered this context */
438 char ctxname[SNMP_ADM_STR32_SIZ];
439 SLIST_ENTRY(vacm_context) vcl;
442 SLIST_HEAD(vacm_contextlist, vacm_context);
444 void vacm_groups_init(void);
445 struct vacm_user *vacm_first_user(void);
446 struct vacm_user *vacm_next_user(struct vacm_user *);
447 struct vacm_user *vacm_new_user(int32_t, char *);
448 int vacm_delete_user(struct vacm_user *);
449 int vacm_user_set_group(struct vacm_user *, u_char *, u_int);
450 struct vacm_access *vacm_first_access_rule(void);
451 struct vacm_access *vacm_next_access_rule(struct vacm_access *);
452 struct vacm_access *vacm_new_access_rule(char *, char *, int32_t, int32_t);
453 int vacm_delete_access_rule(struct vacm_access *);
454 struct vacm_view *vacm_first_view(void);
455 struct vacm_view *vacm_next_view(struct vacm_view *);
456 struct vacm_view *vacm_new_view(char *, struct asn_oid *);
457 int vacm_delete_view(struct vacm_view *);
458 struct vacm_context *vacm_first_context(void);
459 struct vacm_context *vacm_next_context(struct vacm_context *);
460 struct vacm_context *vacm_add_context(char *, int32_t);
461 void vacm_flush_contexts(int32_t);
464 * RFC 3413 SNMP Management Target & Notification MIB
467 struct snmpd_target_stats {
468 uint32_t unavail_contexts;
469 uint32_t unknown_contexts;
472 #define SNMP_UDP_ADDR_SIZ 6
473 #define SNMP_TAG_SIZ (255 + 1)
475 struct target_address {
476 char name[SNMP_ADM_STR32_SIZ];
477 uint8_t address[SNMP_UDP_ADDR_SIZ];
480 char taglist[SNMP_TAG_SIZ];
481 char paramname[SNMP_ADM_STR32_SIZ];
485 SLIST_ENTRY(target_address) ta;
488 SLIST_HEAD(target_addresslist, target_address);
490 struct target_param {
491 char name[SNMP_ADM_STR32_SIZ];
494 char secname[SNMP_ADM_STR32_SIZ];
495 enum snmp_usm_level sec_level;
498 SLIST_ENTRY(target_param) tp;
501 SLIST_HEAD(target_paramlist, target_param);
503 struct target_notify {
504 char name[SNMP_ADM_STR32_SIZ];
505 char taglist[SNMP_TAG_SIZ];
509 SLIST_ENTRY(target_notify) tn;
512 SLIST_HEAD(target_notifylist, target_notify);
514 extern struct snmpd_target_stats snmpd_target_stats;
515 struct snmpd_target_stats *bsnmpd_get_target_stats(void);
516 struct target_address *target_first_address(void);
517 struct target_address *target_next_address(struct target_address *);
518 struct target_address *target_new_address(char *);
519 int target_activate_address(struct target_address *);
520 int target_delete_address(struct target_address *);
521 struct target_param *target_first_param(void);
522 struct target_param *target_next_param(struct target_param *);
523 struct target_param *target_new_param(char *);
524 int target_delete_param(struct target_param *);
525 struct target_notify *target_first_notify(void);
526 struct target_notify *target_next_notify(struct target_notify *);
527 struct target_notify *target_new_notify(char *);
528 int target_delete_notify (struct target_notify *);
529 void target_flush_all(void);
534 extern const struct asn_oid oid_zeroDotZero;
536 /* SNMPv3 Engine Discovery */
537 extern const struct asn_oid oid_usmUnknownEngineIDs;
538 extern const struct asn_oid oid_usmNotInTimeWindows;
543 * A module can request a range of request ids and associate them with a
544 * type field. All ranges are deleted if a module is unloaded.
546 u_int reqid_allocate(int size, struct lmodule *);
547 int32_t reqid_next(u_int type);
548 int32_t reqid_base(u_int type);
549 int reqid_istype(int32_t reqid, u_int type);
550 u_int reqid_type(int32_t reqid);
555 void *timer_start(u_int, void (*)(void *), void *, struct lmodule *);
556 void *timer_start_repeat(u_int, u_int, void (*)(void *), void *,
558 void timer_stop(void *);
563 void *fd_select(int, void (*)(int, void *), void *, struct lmodule *);
564 void fd_deselect(void *);
565 void fd_suspend(void *);
566 int fd_resume(void *);
571 u_int or_register(const struct asn_oid *, const char *, struct lmodule *);
572 void or_unregister(u_int);
577 void *buf_alloc(int tx);
578 size_t buf_size(int tx);
580 /* decode PDU and find community */
581 enum snmpd_input_err snmp_input_start(const u_char *, size_t, const char *,
582 struct snmp_pdu *, int32_t *, size_t *);
584 /* process the pdu. returns either _OK or _FAILED */
585 enum snmpd_input_err snmp_input_finish(struct snmp_pdu *, const u_char *,
586 size_t, u_char *, size_t *, const char *, enum snmpd_input_err, int32_t,
589 void snmp_output(struct snmp_pdu *, u_char *, size_t *, const char *);
590 void snmp_send_port(void *, const struct asn_oid *, struct snmp_pdu *,
591 const struct sockaddr *, socklen_t);
592 enum snmp_code snmp_pdu_auth_access(struct snmp_pdu *, int32_t *);
595 void snmp_send_trap(const struct asn_oid *, ...);
600 int string_save(struct snmp_value *, struct snmp_context *, ssize_t, u_char **);
601 void string_commit(struct snmp_context *);
602 void string_rollback(struct snmp_context *, u_char **);
603 int string_get(struct snmp_value *, const u_char *, ssize_t);
604 int string_get_max(struct snmp_value *, const u_char *, ssize_t, size_t);
605 void string_free(struct snmp_context *);
607 int ip_save(struct snmp_value *, struct snmp_context *, u_char *);
608 void ip_rollback(struct snmp_context *, u_char *);
609 void ip_commit(struct snmp_context *);
610 int ip_get(struct snmp_value *, u_char *);
612 int oid_save(struct snmp_value *, struct snmp_context *, struct asn_oid *);
613 void oid_rollback(struct snmp_context *, struct asn_oid *);
614 void oid_commit(struct snmp_context *);
615 int oid_get(struct snmp_value *, const struct asn_oid *);
617 int index_decode(const struct asn_oid *oid, u_int sub, u_int code, ...);
618 int index_compare(const struct asn_oid *, u_int, const struct asn_oid *);
619 int index_compare_off(const struct asn_oid *, u_int, const struct asn_oid *,
621 void index_append(struct asn_oid *, u_int, const struct asn_oid *);
622 void index_append_off(struct asn_oid *, u_int, const struct asn_oid *, u_int);