cups/testsnmp.c

   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  *
  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.
  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"
  32 #include "snmp-private.h"
  33
  34
  35 /*
  36  * Local functions...
  37  */
  38
  39 static void     print_packet(cups_snmp_t *packet, void *data);
  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);
  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 */
  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 */
  59
  60
  61   fputs("_cupsSNMPDefaultCommunity: ", stdout);
  62
  63   if ((community = _cupsSNMPDefaultCommunity()) == NULL)
  64   {
  65     puts("FAIL (NULL community name)");
  66     return (1);
  67   }
  68
  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"))
  86       _cupsSNMPSetDebug(10);
  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       {
  99         fputs("_cupsSNMPOpen: ", stdout);
 100
 101         if ((fd = _cupsSNMPOpen(host->addr.addr.sa_family)) < 0)
 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)
 119   {
 120     if (!show_oid(fd, community,  &(host->addr),
 121                   walk ? ".1.3.6.1.2.1.43" :
 122                          ".1.3.6.1.2.1.43.10.2.1.4.1.1", walk))
 123       return (1);
 124   }
 125
 126   return (0);
 127 }
 128
 129
 130 /*
 131  * 'print_packet()' - Print the contents of the response packet.
 132  */
 133
 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 */
 139   char  temp[1024];                     /* Temporary OID string */
 140
 141
 142   (void)data;
 143
 144   printf("%s = ", _cupsSNMPOIDToString(packet->object_name, temp, sizeof(temp)));
 145
 146   switch (packet->object_type)
 147   {
 148     case CUPS_ASN1_BOOLEAN :
 149         printf("BOOLEAN %s\n",
 150                packet->object_value.boolean ? "TRUE" : "FALSE");
 151         break;
 152
 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 :
 170         printf("OID %s\n", _cupsSNMPOIDToString(packet->object_value.oid,
 171                                                 temp, sizeof(temp)));
 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;
 201   }
 202 }
 203
 204
 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 */
 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? */
 215 {
 216   int           i;                      /* Looping var */
 217   int           oid[CUPS_SNMP_MAX_OID]; /* OID */
 218   cups_snmp_t   packet;                 /* SNMP packet */
 219   char          temp[1024];             /* Temporary OID string */
 220
 221
 222   if (!_cupsSNMPStringToOID(s, oid, sizeof(oid) / sizeof(oid[0])))
 223   {
 224     puts("testsnmp: Bad OID");
 225     return (0);
 226   }
 227
 228   if (walk)
 229   {
 230     printf("_cupsSNMPWalk(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));
 231
 232     if (_cupsSNMPWalk(fd, addr, CUPS_SNMP_VERSION_1, community, oid, 5.0,
 233                      print_packet, NULL) < 0)
 234     {
 235       printf("FAIL (%s)\n", strerror(errno));
 236       return (0);
 237     }
 238   }
 239   else
 240   {
 241     printf("_cupsSNMPWrite(%s): ", _cupsSNMPOIDToString(oid, temp, sizeof(temp)));
 242
 243     if (!_cupsSNMPWrite(fd, addr, CUPS_SNMP_VERSION_1, community,
 244                        CUPS_ASN1_GET_REQUEST, 1, oid))
 245     {
 246       printf("FAIL (%s)\n", strerror(errno));
 247       return (0);
 248     }
 249
 250     puts("PASS");
 251
 252     fputs("_cupsSNMPRead(5.0): ", stdout);
 253
 254     if (!_cupsSNMPRead(fd, &packet, 5.0))
 255     {
 256       puts("FAIL (timeout)");
 257       return (0);
 258     }
 259
 260     if (!_cupsSNMPIsOID(&packet, oid))
 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);
 278   }
 279
 280   return (1);
 281 }
 282
 283
 284 /*
 285  * 'usage()' - Show program usage and exit.
 286  */
 287
 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);
 300 }
 301
 302
 303 /*
 304  * End of "$Id$".
 305  */