[thirdparty/cups.git] / cups / snmp-private.h

/*
 * Private SNMP definitions for CUPS.
 *
 * Copyright 2007-2014 by Apple Inc.
 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
 *
 * These coded instructions, statements, and computer programs are the
 * property of Apple Inc. and are protected by Federal copyright
 * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 * "LICENSE" which should have been included with this file.  If this
 * file is missing or damaged, see the license at "http://www.cups.org/".
 *
 * This file is subject to the Apple OS-Developed Software exception.
 */

#ifndef _CUPS_SNMP_PRIVATE_H_
#  define _CUPS_SNMP_PRIVATE_H_


/*
 * Include necessary headers.
 */

#include <cups/http.h>


/*
 * Constants...
 */

#define CUPS_SNMP_PORT		161	/* SNMP well-known port */
#define CUPS_SNMP_MAX_COMMUNITY	512	/* Maximum size of community name */
#define CUPS_SNMP_MAX_OID	128	/* Maximum number of OID numbers */
#define CUPS_SNMP_MAX_PACKET	1472	/* Maximum size of SNMP packet */
#define CUPS_SNMP_MAX_STRING	1024	/* Maximum size of string */
#define CUPS_SNMP_VERSION_1	0	/* SNMPv1 */


/*
 * Types...
 */

enum cups_asn1_e			/**** ASN1 request/object types ****/
{
  CUPS_ASN1_END_OF_CONTENTS = 0x00,	/* End-of-contents */
  CUPS_ASN1_BOOLEAN = 0x01,		/* BOOLEAN */
  CUPS_ASN1_INTEGER = 0x02,		/* INTEGER or ENUMERATION */
  CUPS_ASN1_BIT_STRING = 0x03,		/* BIT STRING */
  CUPS_ASN1_OCTET_STRING = 0x04,	/* OCTET STRING */
  CUPS_ASN1_NULL_VALUE = 0x05,		/* NULL VALUE */
  CUPS_ASN1_OID = 0x06,			/* OBJECT IDENTIFIER */
  CUPS_ASN1_SEQUENCE = 0x30,		/* SEQUENCE */
  CUPS_ASN1_HEX_STRING = 0x40,		/* Binary string aka Hex-STRING */
  CUPS_ASN1_COUNTER = 0x41,		/* 32-bit unsigned aka Counter32 */
  CUPS_ASN1_GAUGE = 0x42,		/* 32-bit unsigned aka Gauge32 */
  CUPS_ASN1_TIMETICKS = 0x43,		/* 32-bit unsigned aka Timeticks32 */
  CUPS_ASN1_GET_REQUEST = 0xa0,		/* GetRequest-PDU */
  CUPS_ASN1_GET_NEXT_REQUEST = 0xa1,	/* GetNextRequest-PDU */
  CUPS_ASN1_GET_RESPONSE = 0xa2		/* GetResponse-PDU */
};
typedef enum cups_asn1_e cups_asn1_t;	/**** ASN1 request/object types ****/

typedef struct cups_snmp_string_s	/**** String value ****/
{
  unsigned char	bytes[CUPS_SNMP_MAX_STRING];
					/* Bytes in string */
  unsigned	num_bytes;		/* Number of bytes */
} cups_snmp_string_t;

union cups_snmp_value_u			/**** Object value ****/
{
  int		boolean;		/* Boolean value */
  int		integer;		/* Integer value */
  int		counter;		/* Counter value */
  unsigned	gauge;			/* Gauge value */
  unsigned	timeticks;		/* Timeticks  value */
  int		oid[CUPS_SNMP_MAX_OID];	/* OID value */
  cups_snmp_string_t string;		/* String value */
};

typedef struct cups_snmp_s		/**** SNMP data packet ****/
{
  const char	*error;			/* Encode/decode error */
  http_addr_t	address;		/* Source address */
  int		version;		/* Version number */
  char		community[CUPS_SNMP_MAX_COMMUNITY];
					/* Community name */
  cups_asn1_t	request_type;		/* Request type */
  unsigned	request_id;		/* request-id value */
  int		error_status;		/* error-status value */
  int		error_index;		/* error-index value */
  int		object_name[CUPS_SNMP_MAX_OID];
					/* object-name value */
  cups_asn1_t	object_type;		/* object-value type */
  union cups_snmp_value_u
		object_value;		/* object-value value */
} cups_snmp_t;

typedef void (*cups_snmp_cb_t)(cups_snmp_t *packet, void *data);

/*
 * Prototypes...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */

extern void		_cupsSNMPClose(int fd) _CUPS_API_1_4;
extern int		*_cupsSNMPCopyOID(int *dst, const int *src, int dstsize)
			    _CUPS_API_1_4;
extern const char	*_cupsSNMPDefaultCommunity(void) _CUPS_API_1_4;
extern int		_cupsSNMPIsOID(cups_snmp_t *packet, const int *oid)
			    _CUPS_API_1_4;
extern int		_cupsSNMPIsOIDPrefixed(cups_snmp_t *packet,
			                      const int *prefix) _CUPS_API_1_4;
extern char		*_cupsSNMPOIDToString(const int *src, char *dst,
			                      size_t dstsize) _CUPS_API_1_4;
extern int		_cupsSNMPOpen(int family) _CUPS_API_1_4;
extern cups_snmp_t	*_cupsSNMPRead(int fd, cups_snmp_t *packet,
			               double timeout) _CUPS_API_1_4;
extern void		_cupsSNMPSetDebug(int level) _CUPS_API_1_4;
extern int		*_cupsSNMPStringToOID(const char *src,
			                      int *dst, int dstsize)
					      _CUPS_API_1_4;
extern int		_cupsSNMPWalk(int fd, http_addr_t *address, int version,
			              const char *community, const int *prefix,
				      double timeout, cups_snmp_cb_t cb,
				      void *data) _CUPS_API_1_4;
extern int		_cupsSNMPWrite(int fd, http_addr_t *address, int version,
				       const char *community,
				       cups_asn1_t request_type,
				       const unsigned request_id,
				       const int *oid) _CUPS_API_1_4;

#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_SNMP_PRIVATE_H_ */
Commit	Line	Data
7a14d768	1	/*
7e86f2f6	2	* Private SNMP definitions for CUPS.
7a14d768	3	*
7e86f2f6 MS	4	* Copyright 2007-2014 by Apple Inc.
7e86f2f6 MS	5	* Copyright 2006-2007 by Easy Software Products, all rights reserved.
7a14d768	6	*
7e86f2f6 MS	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/".
7a14d768	12	*
7e86f2f6	13	* This file is subject to the Apple OS-Developed Software exception.
7a14d768 MS	14	*/
7a14d768 MS	15
71e16022 MS	16	#ifndef _CUPS_SNMP_PRIVATE_H_
71e16022 MS	17	# define _CUPS_SNMP_PRIVATE_H_
7a14d768 MS	18
	19
	20	/*
	21	* Include necessary headers.
	22	*/
	23
71e16022	24	#include <cups/http.h>
7a14d768 MS	25
	26
	27	/*
	28	* Constants...
	29	*/
	30
	31	#define CUPS_SNMP_PORT 161 /* SNMP well-known port */
82cc1f9a	32	#define CUPS_SNMP_MAX_COMMUNITY 512 /* Maximum size of community name */
7a14d768 MS	33	#define CUPS_SNMP_MAX_OID 128 /* Maximum number of OID numbers */
7a14d768 MS	34	#define CUPS_SNMP_MAX_PACKET 1472 /* Maximum size of SNMP packet */
f3c17241	35	#define CUPS_SNMP_MAX_STRING 1024 /* Maximum size of string */
7a14d768 MS	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
d1c13e16	63	typedef struct cups_snmp_string_s /** String value **/
7a14d768 MS	64	{
	65	unsigned char bytes[CUPS_SNMP_MAX_STRING];
	66	/* Bytes in string */
7e86f2f6	67	unsigned num_bytes; /* Number of bytes */
d1c13e16	68	} cups_snmp_string_t;
7a14d768 MS	69
	70	union cups_snmp_value_u /** Object value **/
	71	{
	72	int boolean; /* Boolean value */
	73	int integer; /* Integer value */
7e86f2f6	74	int counter; /* Counter value */
7a14d768 MS	75	unsigned gauge; /* Gauge value */
	76	unsigned timeticks; /* Timeticks value */
	77	int oid[CUPS_SNMP_MAX_OID]; /* OID value */
d1c13e16	78	cups_snmp_string_t string; /* String value */
7a14d768 MS	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 */
82cc1f9a	86	char community[CUPS_SNMP_MAX_COMMUNITY];
7a14d768 MS	87	/* Community name */
7a14d768 MS	88	cups_asn1_t request_type; /* Request type */
7e86f2f6	89	unsigned request_id; /* request-id value */
7a14d768 MS	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;
20fbc903 MS	117	extern char _cupsSNMPOIDToString(const int src, char *dst,
20fbc903 MS	118	size_t dstsize) _CUPS_API_1_4;
7a14d768 MS	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;
20fbc903 MS	123	extern int _cupsSNMPStringToOID(const char src,
	124	int *dst, int dstsize)
	125	_CUPS_API_1_4;
7a14d768 MS	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 */
71e16022	139	#endif /* !_CUPS_SNMP_PRIVATE_H_ */