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

/*
 * "$Id$"
 *
 * SNMP test program for CUPS.
 *
 * Copyright 2008-2014 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.
 */

/*
 * Include necessary headers...
 */

#include "cups-private.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) __attribute__((noreturn));


/*
 * '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) */
{
  unsigned	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",
	       (char *)packet->object_value.string.bytes);
	break;

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