include/snmp_vars.h

   1 #ifndef SQUID_SNMP_VARS_H
   2 #define SQUID_SNMP_VARS_H
   3
   4 /**********************************************************************
   5  *
   6  *           Copyright 1997 by Carnegie Mellon University
   7  *
   8  *                       All Rights Reserved
   9  *
  10  * Permission to use, copy, modify, and distribute this software and its
  11  * documentation for any purpose and without fee is hereby granted,
  12  * provided that the above copyright notice appear in all copies and that
  13  * both that copyright notice and this permission notice appear in
  14  * supporting documentation, and that the name of CMU not be
  15  * used in advertising or publicity pertaining to distribution of the
  16  * software without specific, written prior permission.
  17  *
  18  * CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  19  * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  20  * CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  21  * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  22  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  23  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  24  * SOFTWARE.
  25  *
  26  * Author: Ryan Troll <ryan+@andrew.cmu.edu>
  27  *
  28  * $Id: snmp_vars.h,v 1.14 2007/12/14 23:11:44 amosjeffries Exp $
  29  *
  30  **********************************************************************/
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct variable_list {
  37     struct variable_list *next_variable;        /* NULL for last variable */
  38     oid *name;                  /* Object identifier of variable */
  39     int name_length;            /* number of subid's in name */
  40     u_char type;                /* ASN type of variable */
  41     union {                     /* value of variable */
  42         int *integer;
  43         u_char *string;
  44         oid *objid;
  45     } val;
  46     int val_len;
  47 };
  48
  49 struct variable_list *snmp_var_new(oid *, int);
  50 struct variable_list *snmp_var_new_integer(oid *, int, int, unsigned char);
  51 struct variable_list *snmp_var_clone(struct variable_list *);
  52 void snmp_var_free(struct variable_list *);
  53
  54 u_char *snmp_var_EncodeVarBind(u_char *, int *, struct variable_list *, int);
  55 u_char *snmp_var_DecodeVarBind(u_char *, int *, struct variable_list **, int);
  56
  57 #define MAX_NAME_LEN    64      /* number of subid's in a objid */
  58
  59 /* RFC 1902: Structure of Management Information for SNMPv2
  60  *
  61  * Defined Types
  62  */
  63 #define SMI_INTEGER     ASN_INTEGER
  64 #define SMI_STRING      ASN_OCTET_STR
  65 #define SMI_OBJID       ASN_OBJECT_ID
  66 #define SMI_NULLOBJ     ASN_NULL
  67 #define SMI_IPADDRESS  (ASN_APPLICATION | 0)    /* OCTET STRING, net byte order */
  68 #define SMI_COUNTER32  (ASN_APPLICATION | 1)    /* INTEGER */
  69 #define SMI_GAUGE32    (ASN_APPLICATION | 2)    /* INTEGER */
  70 #define SMI_UNSIGNED32 SMI_GAUGE32
  71 #define SMI_TIMETICKS  (ASN_APPLICATION | 3)    /* INTEGER */
  72 #define SMI_OPAQUE     (ASN_APPLICATION | 4)    /* OCTET STRING */
  73 #define SMI_COUNTER64  (ASN_APPLICATION | 6)    /* INTEGER */
  74
  75
  76 /* constants for enums for the MIB nodes
  77  * cachePeerAddressType (InetAddressType / ASN_INTEGER)
  78  * cacheClientAddressType (InetAddressType / ASN_INTEGER)
  79  * Defined Types
  80  */
  81
  82 #ifndef INETADDRESSTYPE_ENUMS
  83 #define INETADDRESSTYPE_ENUMS
  84
  85 #define INETADDRESSTYPE_UNKNOWN  0
  86 #define INETADDRESSTYPE_IPV4  1
  87 #define INETADDRESSTYPE_IPV6  2
  88 #define INETADDRESSTYPE_IPV4Z  3
  89 #define INETADDRESSTYPE_IPV6Z  4
  90 #define INETADDRESSTYPE_DNS  16
  91
  92 #endif                          /* INETADDRESSTYPE_ENUMS */
  93
  94
  95 /*
  96  * RFC 1905: Protocol Operations for SNMPv2
  97  *
  98  * Variable binding.
  99  *
 100  * VarBind ::=
 101  *   SEQUENCE {
 102  *     name ObjectName
 103  *     CHOICE {
 104  *       value ObjectSyntax
 105  *       unSpecified NULL
 106  *       noSuchObject[0] NULL
 107  *       noSuchInstance[1] NULL
 108  *       endOfMibView[2] NULL
 109  *     }
 110  *   }
 111  */
 112 #define SMI_NOSUCHOBJECT   (ASN_CONTEXT | ASN_PRIMITIVE | 0x0) /* noSuchObject[0] */
 113 #define SMI_NOSUCHINSTANCE (ASN_CONTEXT | ASN_PRIMITIVE | 0x1) /* noSuchInstance[1] */
 114 #define SMI_ENDOFMIBVIEW   (ASN_CONTEXT | ASN_PRIMITIVE | 0x2) /* endOfMibView[2] */
 115 typedef struct variable variable;
 116 typedef struct variable_list variable_list;
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif /* SQUID_SNMP_VARS_H */