cups/snmp-private.h

   1 /*
   2  * Private SNMP definitions for CUPS.
   3  *
   4  * Copyright 2007-2014 by Apple Inc.
   5  * Copyright 2006-2007 by Easy Software Products, all rights reserved.
   6  *
   7  * These coded instructions, statements, and computer programs are the
   8  * property of Apple Inc. and are protected by Federal copyright
   9  * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10  * "LICENSE" which should have been included with this file.  If this
  11  * file is missing or damaged, see the license at "http://www.cups.org/".
  12  *
  13  * This file is subject to the Apple OS-Developed Software exception.
  14  */
  15
  16 #ifndef _CUPS_SNMP_PRIVATE_H_
  17 #  define _CUPS_SNMP_PRIVATE_H_
  18
  19
  20 /*
  21  * Include necessary headers.
  22  */
  23
  24 #include <cups/http.h>
  25
  26
  27 /*
  28  * Constants...
  29  */
  30
  31 #define CUPS_SNMP_PORT          161     /* SNMP well-known port */
  32 #define CUPS_SNMP_MAX_COMMUNITY 512     /* Maximum size of community name */
  33 #define CUPS_SNMP_MAX_OID       128     /* Maximum number of OID numbers */
  34 #define CUPS_SNMP_MAX_PACKET    1472    /* Maximum size of SNMP packet */
  35 #define CUPS_SNMP_MAX_STRING    1024    /* Maximum size of string */
  36 #define CUPS_SNMP_VERSION_1     0       /* SNMPv1 */
  37
  38
  39 /*
  40  * Types...
  41  */
  42
  43 enum cups_asn1_e                        /**** ASN1 request/object types ****/
  44 {
  45   CUPS_ASN1_END_OF_CONTENTS = 0x00,     /* End-of-contents */
  46   CUPS_ASN1_BOOLEAN = 0x01,             /* BOOLEAN */
  47   CUPS_ASN1_INTEGER = 0x02,             /* INTEGER or ENUMERATION */
  48   CUPS_ASN1_BIT_STRING = 0x03,          /* BIT STRING */
  49   CUPS_ASN1_OCTET_STRING = 0x04,        /* OCTET STRING */
  50   CUPS_ASN1_NULL_VALUE = 0x05,          /* NULL VALUE */
  51   CUPS_ASN1_OID = 0x06,                 /* OBJECT IDENTIFIER */
  52   CUPS_ASN1_SEQUENCE = 0x30,            /* SEQUENCE */
  53   CUPS_ASN1_HEX_STRING = 0x40,          /* Binary string aka Hex-STRING */
  54   CUPS_ASN1_COUNTER = 0x41,             /* 32-bit unsigned aka Counter32 */
  55   CUPS_ASN1_GAUGE = 0x42,               /* 32-bit unsigned aka Gauge32 */
  56   CUPS_ASN1_TIMETICKS = 0x43,           /* 32-bit unsigned aka Timeticks32 */
  57   CUPS_ASN1_GET_REQUEST = 0xa0,         /* GetRequest-PDU */
  58   CUPS_ASN1_GET_NEXT_REQUEST = 0xa1,    /* GetNextRequest-PDU */
  59   CUPS_ASN1_GET_RESPONSE = 0xa2         /* GetResponse-PDU */
  60 };
  61 typedef enum cups_asn1_e cups_asn1_t;   /**** ASN1 request/object types ****/
  62
  63 typedef struct cups_snmp_string_s       /**** String value ****/
  64 {
  65   unsigned char bytes[CUPS_SNMP_MAX_STRING];
  66                                         /* Bytes in string */
  67   unsigned      num_bytes;              /* Number of bytes */
  68 } cups_snmp_string_t;
  69
  70 union cups_snmp_value_u                 /**** Object value ****/
  71 {
  72   int           boolean;                /* Boolean value */
  73   int           integer;                /* Integer value */
  74   int           counter;                /* Counter value */
  75   unsigned      gauge;                  /* Gauge value */
  76   unsigned      timeticks;              /* Timeticks  value */
  77   int           oid[CUPS_SNMP_MAX_OID]; /* OID value */
  78   cups_snmp_string_t string;            /* String value */
  79 };
  80
  81 typedef struct cups_snmp_s              /**** SNMP data packet ****/
  82 {
  83   const char    *error;                 /* Encode/decode error */
  84   http_addr_t   address;                /* Source address */
  85   int           version;                /* Version number */
  86   char          community[CUPS_SNMP_MAX_COMMUNITY];
  87                                         /* Community name */
  88   cups_asn1_t   request_type;           /* Request type */
  89   unsigned      request_id;             /* request-id value */
  90   int           error_status;           /* error-status value */
  91   int           error_index;            /* error-index value */
  92   int           object_name[CUPS_SNMP_MAX_OID];
  93                                         /* object-name value */
  94   cups_asn1_t   object_type;            /* object-value type */
  95   union cups_snmp_value_u
  96                 object_value;           /* object-value value */
  97 } cups_snmp_t;
  98
  99 typedef void (*cups_snmp_cb_t)(cups_snmp_t *packet, void *data);
 100
 101 /*
 102  * Prototypes...
 103  */
 104
 105 #  ifdef __cplusplus
 106 extern "C" {
 107 #  endif /* __cplusplus */
 108
 109 extern void             _cupsSNMPClose(int fd) _CUPS_API_1_4;
 110 extern int              *_cupsSNMPCopyOID(int *dst, const int *src, int dstsize)
 111                             _CUPS_API_1_4;
 112 extern const char       *_cupsSNMPDefaultCommunity(void) _CUPS_API_1_4;
 113 extern int              _cupsSNMPIsOID(cups_snmp_t *packet, const int *oid)
 114                             _CUPS_API_1_4;
 115 extern int              _cupsSNMPIsOIDPrefixed(cups_snmp_t *packet,
 116                                               const int *prefix) _CUPS_API_1_4;
 117 extern char             *_cupsSNMPOIDToString(const int *src, char *dst,
 118                                               size_t dstsize) _CUPS_API_1_4;
 119 extern int              _cupsSNMPOpen(int family) _CUPS_API_1_4;
 120 extern cups_snmp_t      *_cupsSNMPRead(int fd, cups_snmp_t *packet,
 121                                        double timeout) _CUPS_API_1_4;
 122 extern void             _cupsSNMPSetDebug(int level) _CUPS_API_1_4;
 123 extern int              *_cupsSNMPStringToOID(const char *src,
 124                                               int *dst, int dstsize)
 125                                               _CUPS_API_1_4;
 126 extern int              _cupsSNMPWalk(int fd, http_addr_t *address, int version,
 127                                       const char *community, const int *prefix,
 128                                       double timeout, cups_snmp_cb_t cb,
 129                                       void *data) _CUPS_API_1_4;
 130 extern int              _cupsSNMPWrite(int fd, http_addr_t *address, int version,
 131                                        const char *community,
 132                                        cups_asn1_t request_type,
 133                                        const unsigned request_id,
 134                                        const int *oid) _CUPS_API_1_4;
 135
 136 #  ifdef __cplusplus
 137 }
 138 #  endif /* __cplusplus */
 139 #endif /* !_CUPS_SNMP_PRIVATE_H_ */