snmp_pdu.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
3 *
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
7 */
8
9#ifndef SQUID_SNMP_PDU_H
10#define SQUID_SNMP_PDU_H
11
12/* required for oid typedef */
13#include "asn1.h"
14
15#if HAVE_NETINET_IN_H
16#include <netinet/in.h>
17#endif
18
19/**********************************************************************
20 *
21 * Copyright 1997 by Carnegie Mellon University
22 *
23 * All Rights Reserved
24 *
25 * Permission to use, copy, modify, and distribute this software and its
26 * documentation for any purpose and without fee is hereby granted,
27 * provided that the above copyright notice appear in all copies and that
28 * both that copyright notice and this permission notice appear in
29 * supporting documentation, and that the name of CMU not be
30 * used in advertising or publicity pertaining to distribution of the
31 * software without specific, written prior permission.
32 *
33 * CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
34 * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
35 * CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
36 * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
37 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
38 * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
39 * SOFTWARE.
40 *
41 * Author: Ryan Troll <ryan+@andrew.cmu.edu>
42 *
43 **********************************************************************/
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49/* An SNMP PDU */
50struct snmp_pdu {
51 int command; /* Type of this PDU */
52 struct sockaddr_in address; /* Address of peer */
53
54 int reqid; /* Integer32: Request id */
55 int errstat; /* INTEGER: Error status */
56 int errindex; /* INTEGER: Error index */
57
58 /* SNMPv2 Bulk Request */
59 int non_repeaters; /* INTEGER: */
60 int max_repetitions; /* INTEGER: */
61
62 struct variable_list *variables; /* Variable Bindings */
63
64 /* Trap information */
65 oid *enterprise; /* System OID */
67 struct sockaddr_in agent_addr; /* address of object generating trap */
68 int trap_type; /* generic trap type */
69 int specific_type; /* specific type */
70 u_int time; /* Uptime */
71};
72
73struct snmp_pdu *snmp_pdu_create(int);
74struct snmp_pdu *snmp_pdu_clone(struct snmp_pdu *);
75struct snmp_pdu *snmp_pdu_fix(struct snmp_pdu *, int);
76struct snmp_pdu *snmp_fix_pdu(struct snmp_pdu *, int);
77void snmp_free_pdu(struct snmp_pdu *);
78void snmp_pdu_free(struct snmp_pdu *);
79
80u_char *snmp_pdu_encode(u_char *, int *, struct snmp_pdu *);
81u_char *snmp_pdu_decode(u_char *, int *, struct snmp_pdu *);
82
83/* Add a NULL Variable to a PDU */
84void snmp_add_null_var(struct snmp_pdu *, oid *, int);
85
86/* RFC 1905: Protocol Operations for SNMPv2
87 *
88 * RFC 1157: A Simple Network Management Protocol (SNMP)
89 *
90 * PDU Types
91 */
92#define SNMP_PDU_GET (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x0)
93#define SNMP_PDU_GETNEXT (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x1)
94#define SNMP_PDU_RESPONSE (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x2)
95#define SNMP_PDU_GETBULK (ASN_CONTEXT | ASN_CONSTRUCTOR | 0x5)
96#define MAX_BINDINGS 2147483647 /* PDU Defaults */
97#define SNMP_DEFAULT_ERRSTAT -1
98#define SNMP_DEFAULT_ERRINDEX -1
99#define SNMP_DEFAULT_ADDRESS 0
100#define SNMP_DEFAULT_REQID 0
101
102#ifdef __cplusplus
103}
104#endif
105
106#endif /* SQUID_SNMP_PDU_H */
107
u_int oid
Definition: asn1.h:42
u_char * snmp_pdu_encode(u_char *, int *, struct snmp_pdu *)
Definition: snmp_pdu.c:350
struct snmp_pdu * snmp_pdu_clone(struct snmp_pdu *)
Definition: snmp_pdu.c:147
u_char * snmp_pdu_decode(u_char *, int *, struct snmp_pdu *)
Definition: snmp_pdu.c:486
void snmp_pdu_free(struct snmp_pdu *)
Definition: snmp_pdu.c:275
struct snmp_pdu * snmp_pdu_fix(struct snmp_pdu *, int)
Definition: snmp_pdu.c:181
void snmp_free_pdu(struct snmp_pdu *)
Definition: snmp_pdu.c:284
struct snmp_pdu * snmp_fix_pdu(struct snmp_pdu *, int)
Definition: snmp_pdu.c:186
struct snmp_pdu * snmp_pdu_create(int)
Definition: snmp_pdu.c:113
void snmp_add_null_var(struct snmp_pdu *, oid *, int)
Definition: snmp_pdu.c:637
struct sockaddr_in address
Definition: snmp_pdu.h:52
int non_repeaters
Definition: snmp_pdu.h:59
oid * enterprise
Definition: snmp_pdu.h:65
int enterprise_length
Definition: snmp_pdu.h:66
int trap_type
Definition: snmp_pdu.h:68
int errindex
Definition: snmp_pdu.h:56
int reqid
Definition: snmp_pdu.h:54
int command
Definition: snmp_pdu.h:51
struct variable_list * variables
Definition: snmp_pdu.h:62
int max_repetitions
Definition: snmp_pdu.h:60
struct sockaddr_in agent_addr
Definition: snmp_pdu.h:67
int errstat
Definition: snmp_pdu.h:55
int specific_type
Definition: snmp_pdu.h:69
u_int time
Definition: snmp_pdu.h:70

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors