[thirdparty/cups.git] / cups / testsnmp.c

/*
 * "$Id$"
 *
 *   SNMP test program for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2008 by Apple Inc.
 *
 *   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"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 *
 * Contents:
 *
 *   main()     - Main entry.
 *   scan_oid() - Scan an OID value.
 *   show_oid() - Show the specified OID.
 *   usage()    - Show program usage and exit.
 */

/*
 * Include necessary headers...
 */

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include "string.h"
#include "snmp-private.h"


/*
 * Local functions...
 */

static void	print_packet(cups_snmp_t *packet, void *data);
static int	show_oid(int fd, const char *community,
		         http_addr_t *addr, const char *s, int walk);
static void	usage(void);


/*
 * 'main()' - Main entry.
 */

int					/* O - Exit status */
main(int  argc,				/* I - Number of command-line args */
     char *argv[])			/* I - Command-line arguments */
{
  int			i;		/* Looping var */
  int			fd = -1;	/* SNMP socket */
  http_addrlist_t	*host = NULL;	/* Address of host */
  int			walk = 0;	/* Walk OIDs? */
  char			*oid = NULL;	/* Last OID shown */
  const char		*community;	/* Community name */


  fputs("_cupsSNMPDefaultCommunity: ", stdout);

  if ((community = _cupsSNMPDefaultCommunity()) == NULL)
  {
    puts("FAIL (NULL community name)");
    return (1);
  }

  printf("PASS (%s)\n", community);

 /*
  * Query OIDs from the command-line...
  */

  for (i = 1; i < argc; i ++)
    if (!strcmp(argv[i], "-c"))
    {
      i ++;

      if (i >= argc)
        usage();
      else
        community = argv[i];
    }
    else if (!strcmp(argv[i], "-d"))
      _cupsSNMPSetDebug(10);
    else if (!strcmp(argv[i], "-w"))
      walk = 1;
    else if (!host)
    {
      if ((host = httpAddrGetList(argv[i], AF_UNSPEC, "161")) == NULL)
      {
	printf("testsnmp: Unable to find \"%s\"!\n", argv[1]);
	return (1);
      }

      if (fd < 0)
      {
	fputs("_cupsSNMPOpen: ", stdout);

	if ((fd = _cupsSNMPOpen(host->addr.addr.sa_family)) < 0)
	{
	  printf("FAIL (%s)\n", strerror(errno));
	  return (1);
	}

	puts("PASS");
      }
    }
    else if (!show_oid(fd, community, &(host->addr), argv[i], walk))
      return (1);
    else
      oid = argv[i];

  if (!host)
    usage();

  if (!oid)
  {
    if (!show_oid(fd, community,  &(host->addr),
                  walk ? ".1.3.6.1.2.1.43" :
		         ".1.3.6.1.2.1.43.10.2.1.4.1.1", walk))
      return (1);
  }
  
  return (0);
}


/*
 * 'print_packet()' - Print the contents of the response packet.
 */

static void
print_packet(cups_snmp_t *packet,	/* I - SNMP response packet */
             void        *data)		/* I - User data pointer (not used) */
{
  int	i;				/* Looping var */
  char	temp[1024];			/* Temporary OID string */


  (void)data;

  printf("%s = ", _cupsSNMPOIDToString(packet->object_name, temp, sizeof(temp)));

  switch (packet->object_type)
  {
    case CUPS_ASN1_BOOLEAN :
	printf("BOOLEAN %s\n",
	       packet->object_value.boolean ? "TRUE" : "FALSE");
	break;

    case CUPS_ASN1_INTEGER :
	printf("INTEGER %d\n", packet->object_value.integer);
	break;

    case CUPS_ASN1_BIT_STRING :
	printf("BIT-STRING \"%s\"\n", packet->object_value.string);
	break;

    case CUPS_ASN1_OCTET_STRING :
	printf("OCTET-STRING \"%s\"\n", packet->object_value.string);
	break;

    case CUPS_ASN1_NULL_VALUE :
	puts("NULL-VALUE");
	break;

    case CUPS_ASN1_OID :
	printf("OID %s\n", _cupsSNMPOIDToString(packet->object_value.oid,
	                                        temp, sizeof(temp)));
	break;

    case CUPS_ASN1_HEX_STRING :
	fputs("Hex-STRING", stdout);
	for (i = 0; i < packet->object_value.hex_string.num_bytes; i ++)
	  printf(" %02X", packet->object_value.hex_string.bytes[i]);
	putchar('\n');
	break;

    case CUPS_ASN1_COUNTER :
	printf("Counter %d\n", packet->object_value.counter);
	break;

    case CUPS_ASN1_GAUGE :
	printf("Gauge %u\n", packet->object_value.gauge);
	break;

    case CUPS_ASN1_TIMETICKS :
	printf("Timeticks %u days, %u:%02u:%02u.%02u\n",
	       packet->object_value.timeticks / 8640000,
	       (packet->object_value.timeticks / 360000) % 24,
	       (packet->object_value.timeticks / 6000) % 60,
	       (packet->object_value.timeticks / 100) % 60,
	       packet->object_value.timeticks % 100);
	break;

    default :
	printf("Unknown-%X\n", packet->object_type);
	break;
  }
}


/*
 * 'show_oid()' - Show the specified OID.
 */

static int				/* O - 1 on success, 0 on error */
show_oid(int         fd,		/* I - SNMP socket */
         const char  *community,	/* I - Community name */
	 http_addr_t *addr,		/* I - Address to query */
         const char  *s,		/* I - OID to query */
	 int         walk)		/* I - Walk OIDs? */
{
  int		i;			/* Looping var */
  int		oid[CUPS_SNMP_MAX_OID];	/* OID */
  cups_snmp_t	packet;			/* SNMP packet */
  char		temp[1024];		/* Temporary OID string */


  if (!_cupsSNMPStringToOID(s, oid, sizeof(oid) / sizeof(oid[0])))
  {
    puts("testsnmp: Bad OID");
    return (0);
  }

  if (walk)
  {
    printf("_cupsSNMPWalk(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));

    if (_cupsSNMPWalk(fd, addr, CUPS_SNMP_VERSION_1, community, oid, 5.0,
                     print_packet, NULL) < 0)
    {
      printf("FAIL (%s)\n", strerror(errno));
      return (0);
    }
  }
  else
  {
    printf("_cupsSNMPWrite(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));

    if (!_cupsSNMPWrite(fd, addr, CUPS_SNMP_VERSION_1, community,
		       CUPS_ASN1_GET_REQUEST, 1, oid))
    {
      printf("FAIL (%s)\n", strerror(errno));
      return (0);
    }

    puts("PASS");

    fputs("_cupsSNMPRead(5.0): ", stdout);

    if (!_cupsSNMPRead(fd, &packet, 5.0))
    {
      puts("FAIL (timeout)");
      return (0);
    }

    if (!_cupsSNMPIsOID(&packet, oid))
    {
      printf("FAIL (bad OID %d", packet.object_name[0]);
      for (i = 1; packet.object_name[i] >= 0; i ++)
	printf(".%d", packet.object_name[i]);
      puts(")");
      return (0);
    }

    if (packet.error)
    {
      printf("FAIL (%s)\n", packet.error);
      return (0);
    }

    puts("PASS");

    print_packet(&packet, NULL);
  }

  return (1);
}


/*
 * 'usage()' - Show program usage and exit.
 */

static void
usage(void)
{
  puts("Usage: testsnmp [options] host-or-ip [oid ...]");
  puts("");
  puts("Options:");
  puts("");
  puts("  -c community    Set community name");
  puts("  -d              Enable debugging");
  puts("  -w              Walk all OIDs under the specified one");

  exit (1);
}


/*
 * End of "$Id$".
 */
Commit	Line	Data
91c84a35 MS	1	/*
	2	* "$Id$"
	3	*
	4	* SNMP test program for the Common UNIX Printing System (CUPS).
	5	*
	6	* Copyright 2008 by Apple Inc.
	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Apple Inc. and are protected by Federal copyright
	10	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	11	* which should have been included with this file. If this file is
	12	* file is missing or damaged, see the license at "http://www.cups.org/".
	13	*
	14	* This file is subject to the Apple OS-Developed Software exception.
	15	*
	16	* Contents:
	17	*
ac884b6a MS	18	* main() - Main entry.
	19	* scan_oid() - Scan an OID value.
	20	* show_oid() - Show the specified OID.
	21	* usage() - Show program usage and exit.
91c84a35 MS	22	*/
	23
	24	/*
	25	* Include necessary headers...
	26	*/
	27
	28	#include <stdio.h>
	29	#include <stdlib.h>
	30	#include <errno.h>
	31	#include "string.h"
7a14d768	32	#include "snmp-private.h"
91c84a35 MS	33
	34
	35	/*
	36	* Local functions...
	37	*/
	38
ac884b6a	39	static void print_packet(cups_snmp_t packet, void data);
ac884b6a MS	40	static int show_oid(int fd, const char *community,
	41	http_addr_t addr, const char s, int walk);
	42	static void usage(void);
91c84a35 MS	43
	44
	45	/*
	46	* 'main()' - Main entry.
	47	*/
	48
	49	int /* O - Exit status */
	50	main(int argc, /* I - Number of command-line args */
	51	char argv[]) / I - Command-line arguments */
	52	{
	53	int i; /* Looping var */
ac884b6a MS	54	int fd = -1; /* SNMP socket */
	55	http_addrlist_t host = NULL; / Address of host */
	56	int walk = 0; /* Walk OIDs? */
	57	char oid = NULL; / Last OID shown */
	58	const char community; / Community name */
91c84a35 MS	59
91c84a35 MS	60
7a14d768	61	fputs("_cupsSNMPDefaultCommunity: ", stdout);
ac884b6a	62
7a14d768	63	if ((community = _cupsSNMPDefaultCommunity()) == NULL)
91c84a35	64	{
ac884b6a	65	puts("FAIL (NULL community name)");
91c84a35 MS	66	return (1);
	67	}
	68
ac884b6a MS	69	printf("PASS (%s)\n", community);
	70
	71	/*
	72	* Query OIDs from the command-line...
	73	*/
	74
	75	for (i = 1; i < argc; i ++)
	76	if (!strcmp(argv[i], "-c"))
	77	{
	78	i ++;
	79
	80	if (i >= argc)
	81	usage();
	82	else
	83	community = argv[i];
	84	}
	85	else if (!strcmp(argv[i], "-d"))
7a14d768	86	_cupsSNMPSetDebug(10);
ac884b6a MS	87	else if (!strcmp(argv[i], "-w"))
	88	walk = 1;
	89	else if (!host)
	90	{
	91	if ((host = httpAddrGetList(argv[i], AF_UNSPEC, "161")) == NULL)
	92	{
	93	printf("testsnmp: Unable to find \"%s\"!\n", argv[1]);
	94	return (1);
	95	}
	96
	97	if (fd < 0)
	98	{
7a14d768	99	fputs("_cupsSNMPOpen: ", stdout);
ac884b6a	100
7a14d768	101	if ((fd = _cupsSNMPOpen(host->addr.addr.sa_family)) < 0)
ac884b6a MS	102	{
	103	printf("FAIL (%s)\n", strerror(errno));
	104	return (1);
	105	}
	106
	107	puts("PASS");
	108	}
	109	}
	110	else if (!show_oid(fd, community, &(host->addr), argv[i], walk))
	111	return (1);
	112	else
	113	oid = argv[i];
	114
	115	if (!host)
	116	usage();
	117
	118	if (!oid)
91c84a35	119	{
ac884b6a	120	if (!show_oid(fd, community, &(host->addr),
20fbc903 MS	121	walk ? ".1.3.6.1.2.1.43" :
20fbc903 MS	122	".1.3.6.1.2.1.43.10.2.1.4.1.1", walk))
ac884b6a	123	return (1);
91c84a35	124	}
ac884b6a MS	125
	126	return (0);
	127	}
91c84a35	128
91c84a35	129
ac884b6a MS	130	/*
	131	* 'print_packet()' - Print the contents of the response packet.
	132	*/
91c84a35	133
ac884b6a MS	134	static void
	135	print_packet(cups_snmp_t packet, / I - SNMP response packet */
	136	void data) / I - User data pointer (not used) */
	137	{
	138	int i; /* Looping var */
20fbc903	139	char temp[1024]; /* Temporary OID string */
91c84a35	140
ac884b6a MS	141
	142	(void)data;
	143
20fbc903	144	printf("%s = ", _cupsSNMPOIDToString(packet->object_name, temp, sizeof(temp)));
ac884b6a MS	145
ac884b6a MS	146	switch (packet->object_type)
91c84a35	147	{
ac884b6a MS	148	case CUPS_ASN1_BOOLEAN :
	149	printf("BOOLEAN %s\n",
	150	packet->object_value.boolean ? "TRUE" : "FALSE");
	151	break;
91c84a35	152
ac884b6a MS	153	case CUPS_ASN1_INTEGER :
	154	printf("INTEGER %d\n", packet->object_value.integer);
	155	break;
	156
	157	case CUPS_ASN1_BIT_STRING :
	158	printf("BIT-STRING \"%s\"\n", packet->object_value.string);
	159	break;
	160
	161	case CUPS_ASN1_OCTET_STRING :
	162	printf("OCTET-STRING \"%s\"\n", packet->object_value.string);
	163	break;
	164
	165	case CUPS_ASN1_NULL_VALUE :
	166	puts("NULL-VALUE");
	167	break;
	168
	169	case CUPS_ASN1_OID :
20fbc903 MS	170	printf("OID %s\n", _cupsSNMPOIDToString(packet->object_value.oid,
20fbc903 MS	171	temp, sizeof(temp)));
ac884b6a MS	172	break;
	173
	174	case CUPS_ASN1_HEX_STRING :
	175	fputs("Hex-STRING", stdout);
	176	for (i = 0; i < packet->object_value.hex_string.num_bytes; i ++)
	177	printf(" %02X", packet->object_value.hex_string.bytes[i]);
	178	putchar('\n');
	179	break;
	180
	181	case CUPS_ASN1_COUNTER :
	182	printf("Counter %d\n", packet->object_value.counter);
	183	break;
	184
	185	case CUPS_ASN1_GAUGE :
	186	printf("Gauge %u\n", packet->object_value.gauge);
	187	break;
	188
	189	case CUPS_ASN1_TIMETICKS :
	190	printf("Timeticks %u days, %u:%02u:%02u.%02u\n",
	191	packet->object_value.timeticks / 8640000,
	192	(packet->object_value.timeticks / 360000) % 24,
	193	(packet->object_value.timeticks / 6000) % 60,
	194	(packet->object_value.timeticks / 100) % 60,
	195	packet->object_value.timeticks % 100);
	196	break;
	197
	198	default :
	199	printf("Unknown-%X\n", packet->object_type);
	200	break;
91c84a35	201	}
91c84a35 MS	202	}
	203
	204
91c84a35 MS	205	/*
	206	* 'show_oid()' - Show the specified OID.
	207	*/
	208
	209	static int /* O - 1 on success, 0 on error */
	210	show_oid(int fd, /* I - SNMP socket */
ac884b6a MS	211	const char community, / I - Community name */
	212	http_addr_t addr, / I - Address to query */
	213	const char s, / I - OID to query */
	214	int walk) /* I - Walk OIDs? */
91c84a35 MS	215	{
91c84a35 MS	216	int i; /* Looping var */
ac884b6a	217	int oid[CUPS_SNMP_MAX_OID]; /* OID */
91c84a35	218	cups_snmp_t packet; /* SNMP packet */
20fbc903	219	char temp[1024]; /* Temporary OID string */
91c84a35 MS	220
91c84a35 MS	221
20fbc903	222	if (!_cupsSNMPStringToOID(s, oid, sizeof(oid) / sizeof(oid[0])))
91c84a35	223	{
ac884b6a	224	puts("testsnmp: Bad OID");
91c84a35 MS	225	return (0);
	226	}
	227
ac884b6a	228	if (walk)
91c84a35	229	{
20fbc903	230	printf("_cupsSNMPWalk(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));
ac884b6a	231
7a14d768	232	if (_cupsSNMPWalk(fd, addr, CUPS_SNMP_VERSION_1, community, oid, 5.0,
ac884b6a MS	233	print_packet, NULL) < 0)
	234	{
	235	printf("FAIL (%s)\n", strerror(errno));
	236	return (0);
	237	}
91c84a35	238	}
ac884b6a	239	else
91c84a35	240	{
20fbc903	241	printf("_cupsSNMPWrite(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));
ac884b6a	242
7a14d768	243	if (!_cupsSNMPWrite(fd, addr, CUPS_SNMP_VERSION_1, community,
ac884b6a MS	244	CUPS_ASN1_GET_REQUEST, 1, oid))
	245	{
	246	printf("FAIL (%s)\n", strerror(errno));
	247	return (0);
	248	}
	249
	250	puts("PASS");
	251
7a14d768	252	fputs("_cupsSNMPRead(5.0): ", stdout);
ac884b6a	253
7a14d768	254	if (!_cupsSNMPRead(fd, &packet, 5.0))
ac884b6a MS	255	{
	256	puts("FAIL (timeout)");
	257	return (0);
	258	}
	259
7a14d768	260	if (!_cupsSNMPIsOID(&packet, oid))
ac884b6a MS	261	{
	262	printf("FAIL (bad OID %d", packet.object_name[0]);
	263	for (i = 1; packet.object_name[i] >= 0; i ++)
	264	printf(".%d", packet.object_name[i]);
	265	puts(")");
	266	return (0);
	267	}
	268
	269	if (packet.error)
	270	{
	271	printf("FAIL (%s)\n", packet.error);
	272	return (0);
	273	}
	274
	275	puts("PASS");
	276
	277	print_packet(&packet, NULL);
91c84a35 MS	278	}
91c84a35 MS	279
ac884b6a MS	280	return (1);
ac884b6a MS	281	}
91c84a35	282
91c84a35	283
ac884b6a MS	284	/*
	285	* 'usage()' - Show program usage and exit.
	286	*/
91c84a35	287
ac884b6a MS	288	static void
	289	usage(void)
	290	{
	291	puts("Usage: testsnmp [options] host-or-ip [oid ...]");
	292	puts("");
	293	puts("Options:");
	294	puts("");
	295	puts(" -c community Set community name");
	296	puts(" -d Enable debugging");
	297	puts(" -w Walk all OIDs under the specified one");
	298
	299	exit (1);
91c84a35 MS	300	}
	301
	302
	303	/*
	304	* End of "$Id$".
	305	*/