]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/snmp.c
Move debug printfs to internal usage only.
[thirdparty/cups.git] / cups / snmp.c
CommitLineData
91c84a35 1/*
87e98392 2 * SNMP functions for CUPS.
91c84a35 3 *
53f8d64f
MS
4 * Copyright © 2007-2014 by Apple Inc.
5 * Copyright © 2006-2007 by Easy Software Products, all rights reserved.
91c84a35 6 *
53f8d64f
MS
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
8 * information.
91c84a35
MS
9 */
10
11/*
12 * Include necessary headers.
13 */
14
71e16022 15#include "cups-private.h"
7a14d768 16#include "snmp-private.h"
fb863569 17#include "debug-internal.h"
91c84a35 18#ifdef HAVE_POLL
dcb445bc 19# include <poll.h>
91c84a35
MS
20#endif /* HAVE_POLL */
21
22
23/*
24 * Local functions...
25 */
26
91c84a35
MS
27static void asn1_debug(const char *prefix, unsigned char *buffer,
28 size_t len, int indent);
ac884b6a
MS
29static int asn1_decode_snmp(unsigned char *buffer, size_t len,
30 cups_snmp_t *packet);
91c84a35
MS
31static int asn1_encode_snmp(unsigned char *buffer, size_t len,
32 cups_snmp_t *packet);
33static int asn1_get_integer(unsigned char **buffer,
34 unsigned char *bufend,
7e86f2f6 35 unsigned length);
91c84a35
MS
36static int asn1_get_oid(unsigned char **buffer,
37 unsigned char *bufend,
7e86f2f6 38 unsigned length, int *oid, int oidsize);
91c84a35
MS
39static int asn1_get_packed(unsigned char **buffer,
40 unsigned char *bufend);
41static char *asn1_get_string(unsigned char **buffer,
42 unsigned char *bufend,
7e86f2f6
MS
43 unsigned length, char *string,
44 size_t strsize);
41681883 45static unsigned asn1_get_length(unsigned char **buffer,
91c84a35
MS
46 unsigned char *bufend);
47static int asn1_get_type(unsigned char **buffer,
48 unsigned char *bufend);
49static void asn1_set_integer(unsigned char **buffer,
50 int integer);
51static void asn1_set_length(unsigned char **buffer,
41681883 52 unsigned length);
91c84a35
MS
53static void asn1_set_oid(unsigned char **buffer,
54 const int *oid);
55static void asn1_set_packed(unsigned char **buffer,
56 int integer);
7e86f2f6
MS
57static unsigned asn1_size_integer(int integer);
58static unsigned asn1_size_length(unsigned length);
59static unsigned asn1_size_oid(const int *oid);
60static unsigned asn1_size_packed(int integer);
91c84a35
MS
61static void snmp_set_error(cups_snmp_t *packet,
62 const char *message);
63
64
65/*
7a14d768 66 * '_cupsSNMPClose()' - Close a SNMP socket.
91c84a35
MS
67 */
68
69void
7a14d768 70_cupsSNMPClose(int fd) /* I - SNMP socket file descriptor */
91c84a35 71{
e07d4801 72 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd));
969307f0 73
87e98392 74 httpAddrClose(NULL, fd);
91c84a35
MS
75}
76
77
78/*
7a14d768 79 * '_cupsSNMPCopyOID()' - Copy an OID.
ac884b6a
MS
80 *
81 * The array pointed to by "src" is terminated by the value -1.
91c84a35
MS
82 */
83
84int * /* O - New OID */
7a14d768
MS
85_cupsSNMPCopyOID(int *dst, /* I - Destination OID */
86 const int *src, /* I - Source OID */
87 int dstsize) /* I - Number of integers in dst */
91c84a35
MS
88{
89 int i; /* Looping var */
90
91
e07d4801 92 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst, src,
969307f0
MS
93 dstsize));
94
ac884b6a 95 for (i = 0, dstsize --; src[i] >= 0 && i < dstsize; i ++)
91c84a35
MS
96 dst[i] = src[i];
97
ac884b6a 98 dst[i] = -1;
91c84a35
MS
99
100 return (dst);
101}
102
103
ac884b6a 104/*
7a14d768 105 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
ac884b6a
MS
106 *
107 * The default community name is the first community name found in the
108 * snmp.conf file. If no community name is defined there, "public" is used.
ac884b6a
MS
109 */
110
111const char * /* O - Default community name */
7a14d768 112_cupsSNMPDefaultCommunity(void)
ac884b6a
MS
113{
114 cups_file_t *fp; /* snmp.conf file */
115 char line[1024], /* Line from file */
116 *value; /* Value from file */
117 int linenum; /* Line number in file */
118 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
119
120
e07d4801 121 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
969307f0 122
ac884b6a
MS
123 if (!cg->snmp_community[0])
124 {
125 strlcpy(cg->snmp_community, "public", sizeof(cg->snmp_community));
126
127 snprintf(line, sizeof(line), "%s/snmp.conf", cg->cups_serverroot);
128 if ((fp = cupsFileOpen(line, "r")) != NULL)
129 {
130 linenum = 0;
131 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
88f9aafc 132 if (!_cups_strcasecmp(line, "Community") && value)
ac884b6a
MS
133 {
134 strlcpy(cg->snmp_community, value, sizeof(cg->snmp_community));
135 break;
136 }
137
138 cupsFileClose(fp);
139 }
140 }
141
e07d4801 142 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
969307f0
MS
143 cg->snmp_community));
144
ac884b6a
MS
145 return (cg->snmp_community);
146}
147
148
91c84a35 149/*
7a14d768 150 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
91c84a35 151 *
ac884b6a 152 * The array pointed to by "oid" is terminated by the value -1.
91c84a35
MS
153 */
154
155int /* O - 1 if equal, 0 if not equal */
7a14d768
MS
156_cupsSNMPIsOID(cups_snmp_t *packet, /* I - Response packet */
157 const int *oid) /* I - OID */
91c84a35
MS
158{
159 int i; /* Looping var */
160
161
162 /*
163 * Range check input...
164 */
165
e07d4801 166 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet, oid));
969307f0 167
91c84a35 168 if (!packet || !oid)
969307f0 169 {
e07d4801 170 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
969307f0 171
91c84a35 172 return (0);
969307f0 173 }
91c84a35
MS
174
175 /*
176 * Compare OIDs...
177 */
178
ac884b6a
MS
179 for (i = 0;
180 i < CUPS_SNMP_MAX_OID && oid[i] >= 0 && packet->object_name[i] >= 0;
181 i ++)
91c84a35 182 if (oid[i] != packet->object_name[i])
969307f0 183 {
e07d4801 184 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
969307f0 185
91c84a35 186 return (0);
969307f0
MS
187 }
188
e07d4801 189 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
969307f0 190 i < CUPS_SNMP_MAX_OID && oid[i] == packet->object_name[i]));
91c84a35
MS
191
192 return (i < CUPS_SNMP_MAX_OID && oid[i] == packet->object_name[i]);
193}
194
195
196/*
7a14d768
MS
197 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
198 * OID prefix.
91c84a35 199 *
ac884b6a 200 * The array pointed to by "prefix" is terminated by the value -1.
91c84a35
MS
201 */
202
203int /* O - 1 if prefixed, 0 if not prefixed */
7a14d768 204_cupsSNMPIsOIDPrefixed(
91c84a35
MS
205 cups_snmp_t *packet, /* I - Response packet */
206 const int *prefix) /* I - OID prefix */
207{
208 int i; /* Looping var */
209
210
211 /*
212 * Range check input...
213 */
214
e07d4801 215 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet,
969307f0
MS
216 prefix));
217
91c84a35 218 if (!packet || !prefix)
969307f0 219 {
e07d4801 220 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
969307f0 221
91c84a35 222 return (0);
969307f0 223 }
91c84a35
MS
224
225 /*
226 * Compare OIDs...
227 */
228
229 for (i = 0;
ac884b6a 230 i < CUPS_SNMP_MAX_OID && prefix[i] >= 0 && packet->object_name[i] >= 0;
91c84a35
MS
231 i ++)
232 if (prefix[i] != packet->object_name[i])
969307f0 233 {
e07d4801 234 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
969307f0 235
91c84a35 236 return (0);
969307f0
MS
237 }
238
e07d4801 239 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
969307f0 240 i < CUPS_SNMP_MAX_OID));
91c84a35
MS
241
242 return (i < CUPS_SNMP_MAX_OID);
243}
244
245
20fbc903
MS
246/*
247 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
20fbc903
MS
248 */
249
250
251char * /* O - New string or @code NULL@ on error */
252_cupsSNMPOIDToString(const int *src, /* I - OID */
253 char *dst, /* I - String buffer */
254 size_t dstsize) /* I - Size of string buffer */
255{
256 char *dstptr, /* Pointer into string buffer */
257 *dstend; /* End of string buffer */
258
259
e07d4801 260 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT ")",
20fbc903
MS
261 src, dst, CUPS_LLCAST dstsize));
262
263 /*
264 * Range check input...
265 */
266
267 if (!src || !dst || dstsize < 4)
268 return (NULL);
269
270 /*
271 * Loop through the OID array and build a string...
272 */
273
274 for (dstptr = dst, dstend = dstptr + dstsize - 1;
275 *src >= 0 && dstptr < dstend;
276 src ++, dstptr += strlen(dstptr))
07623986 277 snprintf(dstptr, (size_t)(dstend - dstptr + 1), ".%d", *src);
20fbc903
MS
278
279 if (*src >= 0)
280 return (NULL);
281 else
282 return (dst);
283}
284
285
91c84a35 286/*
7a14d768 287 * '_cupsSNMPOpen()' - Open a SNMP socket.
91c84a35
MS
288 */
289
290int /* O - SNMP socket file descriptor */
7a14d768 291_cupsSNMPOpen(int family) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
91c84a35
MS
292{
293 int fd; /* SNMP socket file descriptor */
294 int val; /* Socket option value */
295
296
297 /*
298 * Create the SNMP socket...
299 */
300
e07d4801 301 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family));
969307f0 302
ac884b6a 303 if ((fd = socket(family, SOCK_DGRAM, 0)) < 0)
969307f0 304 {
e07d4801 305 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno)));
969307f0 306
91c84a35 307 return (-1);
969307f0 308 }
91c84a35
MS
309
310 /*
311 * Set the "broadcast" flag...
312 */
313
314 val = 1;
315
db8b865d 316 if (setsockopt(fd, SOL_SOCKET, SO_BROADCAST, CUPS_SOCAST &val, sizeof(val)))
91c84a35 317 {
e07d4801 318 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno)));
969307f0 319
91c84a35
MS
320 close(fd);
321
322 return (-1);
323 }
324
e07d4801 325 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd));
969307f0 326
91c84a35
MS
327 return (fd);
328}
329
330
331/*
7a14d768 332 * '_cupsSNMPRead()' - Read and parse a SNMP response.
91c84a35 333 *
7a14d768 334 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
91c84a35 335 * indefinitely.
91c84a35
MS
336 */
337
ac884b6a 338cups_snmp_t * /* O - SNMP packet or @code NULL@ if none */
7a14d768 339_cupsSNMPRead(int fd, /* I - SNMP socket file descriptor */
969307f0
MS
340 cups_snmp_t *packet, /* I - SNMP packet buffer */
341 double timeout) /* I - Timeout in seconds */
91c84a35
MS
342{
343 unsigned char buffer[CUPS_SNMP_MAX_PACKET];
344 /* Data packet */
7e86f2f6 345 ssize_t bytes; /* Number of bytes received */
91c84a35 346 socklen_t addrlen; /* Source address length */
ac884b6a 347 http_addr_t address; /* Source address */
91c84a35
MS
348
349
350 /*
351 * Range check input...
352 */
353
e07d4801 354 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd, packet,
969307f0
MS
355 timeout));
356
91c84a35 357 if (fd < 0 || !packet)
969307f0 358 {
e07d4801 359 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
969307f0 360
91c84a35 361 return (NULL);
969307f0 362 }
91c84a35
MS
363
364 /*
365 * Optionally wait for a response...
366 */
367
568fa3fa 368 if (timeout >= 0.0)
91c84a35
MS
369 {
370 int ready; /* Data ready on socket? */
371#ifdef HAVE_POLL
372 struct pollfd pfd; /* Polled file descriptor */
373
374 pfd.fd = fd;
375 pfd.events = POLLIN;
376
568fa3fa 377 while ((ready = poll(&pfd, 1, (int)(timeout * 1000.0))) < 0 &&
e07d4801 378 (errno == EINTR || errno == EAGAIN));
91c84a35
MS
379
380#else
381 fd_set input_set; /* select() input set */
568fa3fa 382 struct timeval stimeout; /* select() timeout */
91c84a35
MS
383
384 do
385 {
386 FD_ZERO(&input_set);
387 FD_SET(fd, &input_set);
388
568fa3fa 389 stimeout.tv_sec = (int)timeout;
536bc2c6 390 stimeout.tv_usec = (int)((timeout - stimeout.tv_sec) * 1000000);
91c84a35 391
568fa3fa 392 ready = select(fd + 1, &input_set, NULL, NULL, &stimeout);
91c84a35 393 }
19dc16f7 394# ifdef _WIN32
91c84a35
MS
395 while (ready < 0 && WSAGetLastError() == WSAEINTR);
396# else
e07d4801 397 while (ready < 0 && (errno == EINTR || errno == EAGAIN));
19dc16f7 398# endif /* _WIN32 */
91c84a35
MS
399#endif /* HAVE_POLL */
400
401 /*
402 * If we don't have any data ready, return right away...
403 */
404
405 if (ready <= 0)
969307f0 406 {
e07d4801 407 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
969307f0 408
91c84a35 409 return (NULL);
969307f0 410 }
91c84a35
MS
411 }
412
413 /*
414 * Read the response data...
415 */
416
ac884b6a 417 addrlen = sizeof(address);
91c84a35 418
ac884b6a
MS
419 if ((bytes = recvfrom(fd, buffer, sizeof(buffer), 0, (void *)&address,
420 &addrlen)) < 0)
969307f0 421 {
e07d4801 422 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno)));
969307f0 423
91c84a35 424 return (NULL);
969307f0 425 }
91c84a35
MS
426
427 /*
428 * Look for the response status code in the SNMP message header...
429 */
430
7e86f2f6 431 asn1_debug("DEBUG: IN ", buffer, (size_t)bytes, 0);
91c84a35 432
7e86f2f6 433 asn1_decode_snmp(buffer, (size_t)bytes, packet);
91c84a35 434
ac884b6a
MS
435 memcpy(&(packet->address), &address, sizeof(packet->address));
436
91c84a35
MS
437 /*
438 * Return decoded data packet...
439 */
440
e07d4801 441 DEBUG_puts("5_cupsSNMPRead: Returning packet");
969307f0 442
91c84a35
MS
443 return (packet);
444}
445
446
447/*
7a14d768 448 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
91c84a35
MS
449 */
450
451void
7a14d768 452_cupsSNMPSetDebug(int level) /* I - 1 to enable debug output, 0 otherwise */
91c84a35
MS
453{
454 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
455
456
e07d4801 457 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level));
969307f0 458
91c84a35
MS
459 cg->snmp_debug = level;
460}
461
462
20fbc903
MS
463/*
464 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
465 *
466 * This function converts a string of the form ".N.N.N.N.N" to the
467 * corresponding OID array terminated by -1.
468 *
469 * @code NULL@ is returned if the array is not large enough or the string is
470 * not a valid OID number.
20fbc903
MS
471 */
472
473int * /* O - Pointer to OID array or @code NULL@ on error */
474_cupsSNMPStringToOID(const char *src, /* I - OID string */
475 int *dst, /* I - OID array */
476 int dstsize)/* I - Number of integers in OID array */
477{
478 int *dstptr, /* Pointer into OID array */
479 *dstend; /* End of OID array */
480
481
e07d4801 482 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
20fbc903
MS
483 src, dst, dstsize));
484
485 /*
486 * Range check input...
487 */
488
489 if (!src || !dst || dstsize < 2)
490 return (NULL);
491
492 /*
493 * Skip leading "."...
494 */
495
496 if (*src == '.')
497 src ++;
498
499 /*
500 * Loop to the end of the string...
501 */
502
503 for (dstend = dst + dstsize - 1, dstptr = dst, *dstptr = 0;
504 *src && dstptr < dstend;
505 src ++)
506 {
507 if (*src == '.')
508 {
509 dstptr ++;
510 *dstptr = 0;
511 }
512 else if (isdigit(*src & 255))
513 *dstptr = *dstptr * 10 + *src - '0';
514 else
515 break;
516 }
517
518 if (*src)
519 return (NULL);
520
521 /*
522 * Terminate the end of the OID array and return...
523 */
524
525 dstptr[1] = -1;
526
527 return (dst);
528}
529
530
ac884b6a 531/*
7a14d768 532 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
ac884b6a
MS
533 *
534 * This function queries all of the OIDs with the specified OID prefix,
535 * calling the "cb" function for every response that is received.
536 *
537 * The array pointed to by "prefix" is terminated by the value -1.
538 *
7a14d768 539 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
568fa3fa 540 * indefinitely.
ac884b6a
MS
541 */
542
543int /* O - Number of OIDs found or -1 on error */
7a14d768
MS
544_cupsSNMPWalk(int fd, /* I - SNMP socket */
545 http_addr_t *address, /* I - Address to query */
546 int version, /* I - SNMP version */
547 const char *community,/* I - Community name */
548 const int *prefix, /* I - OID prefix */
549 double timeout, /* I - Timeout for each response in seconds */
550 cups_snmp_cb_t cb, /* I - Function to call for each response */
551 void *data) /* I - User data pointer that is passed to the callback function */
ac884b6a
MS
552{
553 int count = 0; /* Number of OIDs found */
7e86f2f6 554 unsigned request_id = 0; /* Current request ID */
ac884b6a 555 cups_snmp_t packet; /* Current response packet */
18ecb428
MS
556 int lastoid[CUPS_SNMP_MAX_OID];
557 /* Last OID we got */
ac884b6a
MS
558
559
560 /*
561 * Range check input...
562 */
563
e07d4801
MS
564 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
565 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
566 fd, address, version, community, prefix, timeout, cb, data));
969307f0 567
ac884b6a
MS
568 if (fd < 0 || !address || version != CUPS_SNMP_VERSION_1 || !community ||
569 !prefix || !cb)
969307f0 570 {
e07d4801 571 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
969307f0 572
ac884b6a 573 return (-1);
969307f0 574 }
ac884b6a
MS
575
576 /*
577 * Copy the OID prefix and then loop until we have no more OIDs...
578 */
579
7a14d768 580 _cupsSNMPCopyOID(packet.object_name, prefix, CUPS_SNMP_MAX_OID);
18ecb428 581 lastoid[0] = -1;
ac884b6a
MS
582
583 for (;;)
584 {
585 request_id ++;
586
7a14d768 587 if (!_cupsSNMPWrite(fd, address, version, community,
18ecb428
MS
588 CUPS_ASN1_GET_NEXT_REQUEST, request_id,
589 packet.object_name))
969307f0 590 {
e07d4801 591 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
969307f0 592
ac884b6a 593 return (-1);
969307f0 594 }
ac884b6a 595
7a14d768 596 if (!_cupsSNMPRead(fd, &packet, timeout))
969307f0 597 {
e07d4801 598 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
969307f0 599
ac884b6a 600 return (-1);
969307f0 601 }
ac884b6a 602
18ecb428
MS
603 if (!_cupsSNMPIsOIDPrefixed(&packet, prefix) ||
604 _cupsSNMPIsOID(&packet, lastoid))
969307f0 605 {
e07d4801 606 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count));
969307f0 607
ac884b6a 608 return (count);
969307f0 609 }
ac884b6a
MS
610
611 if (packet.error || packet.error_status)
969307f0 612 {
e07d4801 613 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count > 0 ? count : -1));
969307f0 614
ac884b6a 615 return (count > 0 ? count : -1);
969307f0 616 }
ac884b6a 617
18ecb428
MS
618 _cupsSNMPCopyOID(lastoid, packet.object_name, CUPS_SNMP_MAX_OID);
619
ac884b6a
MS
620 count ++;
621
622 (*cb)(&packet, data);
623 }
624}
625
626
91c84a35 627/*
7a14d768 628 * '_cupsSNMPWrite()' - Send an SNMP query packet.
91c84a35 629 *
ac884b6a 630 * The array pointed to by "oid" is terminated by the value -1.
91c84a35
MS
631 */
632
633int /* O - 1 on success, 0 on error */
7a14d768 634_cupsSNMPWrite(
91c84a35
MS
635 int fd, /* I - SNMP socket */
636 http_addr_t *address, /* I - Address to send to */
637 int version, /* I - SNMP version */
638 const char *community, /* I - Community name */
639 cups_asn1_t request_type, /* I - Request type */
640 const unsigned request_id, /* I - Request ID */
641 const int *oid) /* I - OID */
642{
643 int i; /* Looping var */
644 cups_snmp_t packet; /* SNMP message packet */
645 unsigned char buffer[CUPS_SNMP_MAX_PACKET];
646 /* SNMP message buffer */
7e86f2f6 647 ssize_t bytes; /* Size of message */
1ff0402e 648 http_addr_t temp; /* Copy of address */
91c84a35
MS
649
650
ac884b6a
MS
651 /*
652 * Range check input...
653 */
654
e07d4801
MS
655 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
656 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
657 fd, address, version, community, request_type, request_id, oid));
969307f0 658
ac884b6a
MS
659 if (fd < 0 || !address || version != CUPS_SNMP_VERSION_1 || !community ||
660 (request_type != CUPS_ASN1_GET_REQUEST &&
661 request_type != CUPS_ASN1_GET_NEXT_REQUEST) || request_id < 1 || !oid)
969307f0 662 {
e07d4801 663 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
969307f0 664
ac884b6a 665 return (0);
969307f0 666 }
ac884b6a 667
91c84a35
MS
668 /*
669 * Create the SNMP message...
670 */
671
672 memset(&packet, 0, sizeof(packet));
673
674 packet.version = version;
675 packet.request_type = request_type;
676 packet.request_id = request_id;
677 packet.object_type = CUPS_ASN1_NULL_VALUE;
88f9aafc 678
91c84a35
MS
679 strlcpy(packet.community, community, sizeof(packet.community));
680
ac884b6a 681 for (i = 0; oid[i] >= 0 && i < (CUPS_SNMP_MAX_OID - 1); i ++)
91c84a35 682 packet.object_name[i] = oid[i];
ac884b6a
MS
683 packet.object_name[i] = -1;
684
685 if (oid[i] >= 0)
686 {
e07d4801 687 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
969307f0 688
ac884b6a
MS
689 errno = E2BIG;
690 return (0);
691 }
91c84a35
MS
692
693 bytes = asn1_encode_snmp(buffer, sizeof(buffer), &packet);
694
695 if (bytes < 0)
696 {
e07d4801 697 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
969307f0 698
91c84a35 699 errno = E2BIG;
91c84a35
MS
700 return (0);
701 }
702
7e86f2f6 703 asn1_debug("DEBUG: OUT ", buffer, (size_t)bytes, 0);
91c84a35
MS
704
705 /*
706 * Send the message...
707 */
708
1ff0402e
MS
709 temp = *address;
710
22c9029b 711 _httpAddrSetPort(&temp, CUPS_SNMP_PORT);
91c84a35 712
7e86f2f6 713 return (sendto(fd, buffer, (size_t)bytes, 0, (void *)&temp, (socklen_t)httpAddrLength(&temp)) == bytes);
91c84a35
MS
714}
715
716
ac884b6a
MS
717/*
718 * 'asn1_debug()' - Decode an ASN1-encoded message.
719 */
720
721static void
722asn1_debug(const char *prefix, /* I - Prefix string */
723 unsigned char *buffer, /* I - Buffer */
724 size_t len, /* I - Length of buffer */
725 int indent) /* I - Indentation */
726{
7e86f2f6 727 size_t i; /* Looping var */
ac884b6a
MS
728 unsigned char *bufend; /* End of buffer */
729 int integer; /* Number value */
730 int oid[CUPS_SNMP_MAX_OID]; /* OID value */
731 char string[CUPS_SNMP_MAX_STRING];
732 /* String value */
733 unsigned char value_type; /* Type of value */
7e86f2f6 734 unsigned value_length; /* Length of value */
ac884b6a
MS
735 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
736
737
7f500d89
MS
738#ifdef __clang_analyzer__ /* Suppress bogus clang error */
739 memset(string, 0, sizeof(string));
740#endif /* __clang_analyzer__ */
741
ac884b6a
MS
742 if (cg->snmp_debug <= 0)
743 return;
744
745 if (cg->snmp_debug > 1 && indent == 0)
746 {
747 /*
748 * Do a hex dump of the packet...
749 */
750
7e86f2f6 751 size_t j;
ac884b6a
MS
752
753 fprintf(stderr, "%sHex Dump (%d bytes):\n", prefix, (int)len);
754
7e86f2f6 755 for (i = 0; i < len; i += 16)
ac884b6a 756 {
7e86f2f6 757 fprintf(stderr, "%s%04x:", prefix, (unsigned)i);
ac884b6a 758
7e86f2f6 759 for (j = 0; j < 16 && (i + j) < len; j ++)
ac884b6a
MS
760 {
761 if (j && !(j & 3))
762 fprintf(stderr, " %02x", buffer[i + j]);
763 else
764 fprintf(stderr, " %02x", buffer[i + j]);
765 }
766
767 while (j < 16)
768 {
769 if (j && !(j & 3))
770 fputs(" ", stderr);
771 else
772 fputs(" ", stderr);
773
774 j ++;
775 }
776
777 fputs(" ", stderr);
778
7e86f2f6 779 for (j = 0; j < 16 && (i + j) < len; j ++)
ac884b6a
MS
780 if (buffer[i + j] < ' ' || buffer[i + j] >= 0x7f)
781 putc('.', stderr);
782 else
783 putc(buffer[i + j], stderr);
784
785 putc('\n', stderr);
786 }
787 }
788
789 if (indent == 0)
790 fprintf(stderr, "%sMessage:\n", prefix);
791
792 bufend = buffer + len;
793
794 while (buffer < bufend)
795 {
796 /*
797 * Get value type...
798 */
799
7e86f2f6 800 value_type = (unsigned char)asn1_get_type(&buffer, bufend);
ac884b6a
MS
801 value_length = asn1_get_length(&buffer, bufend);
802
803 switch (value_type)
804 {
805 case CUPS_ASN1_BOOLEAN :
806 integer = asn1_get_integer(&buffer, bufend, value_length);
807
808 fprintf(stderr, "%s%*sBOOLEAN %d bytes %d\n", prefix, indent, "",
809 value_length, integer);
810 break;
811
812 case CUPS_ASN1_INTEGER :
813 integer = asn1_get_integer(&buffer, bufend, value_length);
814
815 fprintf(stderr, "%s%*sINTEGER %d bytes %d\n", prefix, indent, "",
816 value_length, integer);
817 break;
818
819 case CUPS_ASN1_COUNTER :
820 integer = asn1_get_integer(&buffer, bufend, value_length);
821
822 fprintf(stderr, "%s%*sCOUNTER %d bytes %u\n", prefix, indent, "",
823 value_length, (unsigned)integer);
824 break;
825
826 case CUPS_ASN1_GAUGE :
827 integer = asn1_get_integer(&buffer, bufend, value_length);
828
829 fprintf(stderr, "%s%*sGAUGE %d bytes %u\n", prefix, indent, "",
830 value_length, (unsigned)integer);
831 break;
832
833 case CUPS_ASN1_TIMETICKS :
834 integer = asn1_get_integer(&buffer, bufend, value_length);
835
836 fprintf(stderr, "%s%*sTIMETICKS %d bytes %u\n", prefix, indent, "",
837 value_length, (unsigned)integer);
838 break;
839
840 case CUPS_ASN1_OCTET_STRING :
841 fprintf(stderr, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix,
842 indent, "", value_length,
843 asn1_get_string(&buffer, bufend, value_length, string,
844 sizeof(string)));
845 break;
846
847 case CUPS_ASN1_HEX_STRING :
848 asn1_get_string(&buffer, bufend, value_length, string,
849 sizeof(string));
850 fprintf(stderr, "%s%*sHex-STRING %d bytes", prefix,
851 indent, "", value_length);
852 for (i = 0; i < value_length; i ++)
853 fprintf(stderr, " %02X", string[i] & 255);
854 putc('\n', stderr);
855 break;
856
857 case CUPS_ASN1_NULL_VALUE :
858 fprintf(stderr, "%s%*sNULL VALUE %d bytes\n", prefix, indent, "",
859 value_length);
860
861 buffer += value_length;
862 break;
863
864 case CUPS_ASN1_OID :
865 integer = asn1_get_oid(&buffer, bufend, value_length, oid,
866 CUPS_SNMP_MAX_OID);
867
868 fprintf(stderr, "%s%*sOID %d bytes ", prefix, indent, "",
869 value_length);
7e86f2f6 870 for (i = 0; i < (unsigned)integer; i ++)
ac884b6a
MS
871 fprintf(stderr, ".%d", oid[i]);
872 putc('\n', stderr);
873 break;
874
875 case CUPS_ASN1_SEQUENCE :
876 fprintf(stderr, "%s%*sSEQUENCE %d bytes\n", prefix, indent, "",
877 value_length);
878 asn1_debug(prefix, buffer, value_length, indent + 4);
879
880 buffer += value_length;
881 break;
882
883 case CUPS_ASN1_GET_NEXT_REQUEST :
884 fprintf(stderr, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix,
885 indent, "", value_length);
886 asn1_debug(prefix, buffer, value_length, indent + 4);
887
888 buffer += value_length;
889 break;
890
891 case CUPS_ASN1_GET_REQUEST :
892 fprintf(stderr, "%s%*sGet-Request-PDU %d bytes\n", prefix, indent, "",
893 value_length);
894 asn1_debug(prefix, buffer, value_length, indent + 4);
895
896 buffer += value_length;
897 break;
898
899 case CUPS_ASN1_GET_RESPONSE :
900 fprintf(stderr, "%s%*sGet-Response-PDU %d bytes\n", prefix, indent,
901 "", value_length);
902 asn1_debug(prefix, buffer, value_length, indent + 4);
903
904 buffer += value_length;
905 break;
906
907 default :
908 fprintf(stderr, "%s%*sUNKNOWN(%x) %d bytes\n", prefix, indent, "",
909 value_type, value_length);
910
911 buffer += value_length;
912 break;
913 }
914 }
915}
88f9aafc 916
ac884b6a 917
91c84a35
MS
918/*
919 * 'asn1_decode_snmp()' - Decode a SNMP packet.
920 */
921
922static int /* O - 0 on success, -1 on error */
923asn1_decode_snmp(unsigned char *buffer, /* I - Buffer */
924 size_t len, /* I - Size of buffer */
925 cups_snmp_t *packet) /* I - SNMP packet */
926{
927 unsigned char *bufptr, /* Pointer into the data */
928 *bufend; /* End of data */
7e86f2f6 929 unsigned length; /* Length of value */
91c84a35
MS
930
931
932 /*
933 * Initialize the decoding...
934 */
935
936 memset(packet, 0, sizeof(cups_snmp_t));
ac884b6a 937 packet->object_name[0] = -1;
91c84a35
MS
938
939 bufptr = buffer;
940 bufend = buffer + len;
941
942 if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_SEQUENCE)
943 snmp_set_error(packet, _("Packet does not start with SEQUENCE"));
944 else if (asn1_get_length(&bufptr, bufend) == 0)
945 snmp_set_error(packet, _("SEQUENCE uses indefinite length"));
946 else if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_INTEGER)
947 snmp_set_error(packet, _("No version number"));
948 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
949 snmp_set_error(packet, _("Version uses indefinite length"));
950 else if ((packet->version = asn1_get_integer(&bufptr, bufend, length))
951 != CUPS_SNMP_VERSION_1)
952 snmp_set_error(packet, _("Bad SNMP version number"));
953 else if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_OCTET_STRING)
954 snmp_set_error(packet, _("No community name"));
955 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
956 snmp_set_error(packet, _("Community name uses indefinite length"));
957 else
958 {
959 asn1_get_string(&bufptr, bufend, length, packet->community,
960 sizeof(packet->community));
961
7e86f2f6 962 if ((packet->request_type = (cups_asn1_t)asn1_get_type(&bufptr, bufend))
91c84a35
MS
963 != CUPS_ASN1_GET_RESPONSE)
964 snmp_set_error(packet, _("Packet does not contain a Get-Response-PDU"));
965 else if (asn1_get_length(&bufptr, bufend) == 0)
966 snmp_set_error(packet, _("Get-Response-PDU uses indefinite length"));
967 else if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_INTEGER)
968 snmp_set_error(packet, _("No request-id"));
969 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
970 snmp_set_error(packet, _("request-id uses indefinite length"));
971 else
972 {
7e86f2f6 973 packet->request_id = (unsigned)asn1_get_integer(&bufptr, bufend, length);
91c84a35
MS
974
975 if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_INTEGER)
976 snmp_set_error(packet, _("No error-status"));
977 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
978 snmp_set_error(packet, _("error-status uses indefinite length"));
979 else
980 {
981 packet->error_status = asn1_get_integer(&bufptr, bufend, length);
982
983 if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_INTEGER)
984 snmp_set_error(packet, _("No error-index"));
985 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
986 snmp_set_error(packet, _("error-index uses indefinite length"));
987 else
988 {
989 packet->error_index = asn1_get_integer(&bufptr, bufend, length);
990
991 if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_SEQUENCE)
992 snmp_set_error(packet, _("No variable-bindings SEQUENCE"));
993 else if (asn1_get_length(&bufptr, bufend) == 0)
994 snmp_set_error(packet,
995 _("variable-bindings uses indefinite length"));
996 else if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_SEQUENCE)
997 snmp_set_error(packet, _("No VarBind SEQUENCE"));
998 else if (asn1_get_length(&bufptr, bufend) == 0)
999 snmp_set_error(packet, _("VarBind uses indefinite length"));
1000 else if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_OID)
1001 snmp_set_error(packet, _("No name OID"));
1002 else if ((length = asn1_get_length(&bufptr, bufend)) == 0)
1003 snmp_set_error(packet, _("Name OID uses indefinite length"));
1004 else
1005 {
1006 asn1_get_oid(&bufptr, bufend, length, packet->object_name,
1007 CUPS_SNMP_MAX_OID);
1008
7e86f2f6 1009 packet->object_type = (cups_asn1_t)asn1_get_type(&bufptr, bufend);
91c84a35
MS
1010
1011 if ((length = asn1_get_length(&bufptr, bufend)) == 0 &&
1012 packet->object_type != CUPS_ASN1_NULL_VALUE &&
1013 packet->object_type != CUPS_ASN1_OCTET_STRING)
1014 snmp_set_error(packet, _("Value uses indefinite length"));
1015 else
1016 {
1017 switch (packet->object_type)
1018 {
1019 case CUPS_ASN1_BOOLEAN :
1020 packet->object_value.boolean =
1021 asn1_get_integer(&bufptr, bufend, length);
1022 break;
1023
1024 case CUPS_ASN1_INTEGER :
1025 packet->object_value.integer =
1026 asn1_get_integer(&bufptr, bufend, length);
1027 break;
1028
1029 case CUPS_ASN1_NULL_VALUE :
1030 break;
1031
1032 case CUPS_ASN1_OCTET_STRING :
d1c13e16
MS
1033 case CUPS_ASN1_BIT_STRING :
1034 case CUPS_ASN1_HEX_STRING :
1035 packet->object_value.string.num_bytes = length;
91c84a35 1036 asn1_get_string(&bufptr, bufend, length,
d1c13e16 1037 (char *)packet->object_value.string.bytes,
f3c17241 1038 sizeof(packet->object_value.string.bytes));
91c84a35
MS
1039 break;
1040
1041 case CUPS_ASN1_OID :
1042 asn1_get_oid(&bufptr, bufend, length,
1043 packet->object_value.oid, CUPS_SNMP_MAX_OID);
1044 break;
1045
1046 case CUPS_ASN1_COUNTER :
1047 packet->object_value.counter =
1048 asn1_get_integer(&bufptr, bufend, length);
1049 break;
1050
1051 case CUPS_ASN1_GAUGE :
1052 packet->object_value.gauge =
7e86f2f6 1053 (unsigned)asn1_get_integer(&bufptr, bufend, length);
91c84a35
MS
1054 break;
1055
ac884b6a
MS
1056 case CUPS_ASN1_TIMETICKS :
1057 packet->object_value.timeticks =
7e86f2f6 1058 (unsigned)asn1_get_integer(&bufptr, bufend, length);
ac884b6a
MS
1059 break;
1060
91c84a35
MS
1061 default :
1062 snmp_set_error(packet, _("Unsupported value type"));
1063 break;
1064 }
1065 }
1066 }
1067 }
1068 }
1069 }
1070 }
1071
1072 return (packet->error ? -1 : 0);
1073}
1074
1075
91c84a35
MS
1076/*
1077 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1078 */
1079
1080static int /* O - Length on success, -1 on error */
1081asn1_encode_snmp(unsigned char *buffer, /* I - Buffer */
1082 size_t bufsize, /* I - Size of buffer */
1083 cups_snmp_t *packet) /* I - SNMP packet */
1084{
1085 unsigned char *bufptr; /* Pointer into buffer */
7e86f2f6 1086 unsigned total, /* Total length */
91c84a35
MS
1087 msglen, /* Length of entire message */
1088 commlen, /* Length of community string */
1089 reqlen, /* Length of request */
1090 listlen, /* Length of variable list */
1091 varlen, /* Length of variable */
1092 namelen, /* Length of object name OID */
1093 valuelen; /* Length of object value */
1094
1095
1096 /*
1097 * Get the lengths of the community string, OID, and message...
1098 */
1099
ac884b6a 1100
91c84a35
MS
1101 namelen = asn1_size_oid(packet->object_name);
1102
1103 switch (packet->object_type)
1104 {
1105 case CUPS_ASN1_NULL_VALUE :
1106 valuelen = 0;
1107 break;
1108
1109 case CUPS_ASN1_BOOLEAN :
1110 valuelen = asn1_size_integer(packet->object_value.boolean);
1111 break;
1112
1113 case CUPS_ASN1_INTEGER :
1114 valuelen = asn1_size_integer(packet->object_value.integer);
1115 break;
1116
1117 case CUPS_ASN1_OCTET_STRING :
d1c13e16 1118 valuelen = packet->object_value.string.num_bytes;
91c84a35
MS
1119 break;
1120
1121 case CUPS_ASN1_OID :
1122 valuelen = asn1_size_oid(packet->object_value.oid);
1123 break;
1124
1125 default :
1126 packet->error = "Unknown object type";
1127 return (-1);
1128 }
1129
1130 varlen = 1 + asn1_size_length(namelen) + namelen +
1131 1 + asn1_size_length(valuelen) + valuelen;
1132 listlen = 1 + asn1_size_length(varlen) + varlen;
7e86f2f6 1133 reqlen = 2 + asn1_size_integer((int)packet->request_id) +
91c84a35
MS
1134 2 + asn1_size_integer(packet->error_status) +
1135 2 + asn1_size_integer(packet->error_index) +
1136 1 + asn1_size_length(listlen) + listlen;
7e86f2f6 1137 commlen = (unsigned)strlen(packet->community);
91c84a35
MS
1138 msglen = 2 + asn1_size_integer(packet->version) +
1139 1 + asn1_size_length(commlen) + commlen +
1140 1 + asn1_size_length(reqlen) + reqlen;
1141 total = 1 + asn1_size_length(msglen) + msglen;
1142
7e86f2f6 1143 if (total > bufsize)
91c84a35
MS
1144 {
1145 packet->error = "Message too large for buffer";
1146 return (-1);
1147 }
1148
1149 /*
1150 * Then format the message...
1151 */
1152
1153 bufptr = buffer;
1154
1155 *bufptr++ = CUPS_ASN1_SEQUENCE; /* SNMPv1 message header */
1156 asn1_set_length(&bufptr, msglen);
1157
1158 asn1_set_integer(&bufptr, packet->version);
1159 /* version */
1160
1161 *bufptr++ = CUPS_ASN1_OCTET_STRING; /* community */
1162 asn1_set_length(&bufptr, commlen);
1163 memcpy(bufptr, packet->community, commlen);
1164 bufptr += commlen;
1165
ac884b6a 1166 *bufptr++ = packet->request_type; /* Get-Request-PDU/Get-Next-Request-PDU */
91c84a35
MS
1167 asn1_set_length(&bufptr, reqlen);
1168
7e86f2f6 1169 asn1_set_integer(&bufptr, (int)packet->request_id);
91c84a35
MS
1170
1171 asn1_set_integer(&bufptr, packet->error_status);
1172
1173 asn1_set_integer(&bufptr, packet->error_index);
1174
1175 *bufptr++ = CUPS_ASN1_SEQUENCE; /* variable-bindings */
1176 asn1_set_length(&bufptr, listlen);
1177
1178 *bufptr++ = CUPS_ASN1_SEQUENCE; /* variable */
1179 asn1_set_length(&bufptr, varlen);
1180
1181 asn1_set_oid(&bufptr, packet->object_name);
1182 /* ObjectName */
1183
1184 switch (packet->object_type)
1185 {
1186 case CUPS_ASN1_NULL_VALUE :
1187 *bufptr++ = CUPS_ASN1_NULL_VALUE;
1188 /* ObjectValue */
1189 *bufptr++ = 0; /* Length */
1190 break;
1191
1192 case CUPS_ASN1_BOOLEAN :
1193 asn1_set_integer(&bufptr, packet->object_value.boolean);
1194 break;
1195
1196 case CUPS_ASN1_INTEGER :
1197 asn1_set_integer(&bufptr, packet->object_value.integer);
1198 break;
1199
1200 case CUPS_ASN1_OCTET_STRING :
1201 *bufptr++ = CUPS_ASN1_OCTET_STRING;
1202 asn1_set_length(&bufptr, valuelen);
d1c13e16 1203 memcpy(bufptr, packet->object_value.string.bytes, valuelen);
91c84a35
MS
1204 bufptr += valuelen;
1205 break;
1206
1207 case CUPS_ASN1_OID :
1208 asn1_set_oid(&bufptr, packet->object_value.oid);
1209 break;
1210
1211 default :
1212 break;
1213 }
1214
7e86f2f6 1215 return ((int)(bufptr - buffer));
91c84a35
MS
1216}
1217
1218
1219/*
1220 * 'asn1_get_integer()' - Get an integer value.
1221 */
1222
1223static int /* O - Integer value */
1224asn1_get_integer(
1225 unsigned char **buffer, /* IO - Pointer in buffer */
1226 unsigned char *bufend, /* I - End of buffer */
7e86f2f6 1227 unsigned length) /* I - Length of value */
91c84a35
MS
1228{
1229 int value; /* Integer value */
1230
1231
41681883
MS
1232 if (length > sizeof(int))
1233 {
1234 (*buffer) += length;
1235 return (0);
1236 }
1237
29bda83e 1238 for (value = (**buffer & 0x80) ? ~0 : 0;
91c84a35
MS
1239 length > 0 && *buffer < bufend;
1240 length --, (*buffer) ++)
29bda83e 1241 value = ((value & 0xffffff) << 8) | **buffer;
91c84a35
MS
1242
1243 return (value);
1244}
1245
1246
1247/*
1248 * 'asn1_get_length()' - Get a value length.
1249 */
1250
41681883 1251static unsigned /* O - Length */
91c84a35
MS
1252asn1_get_length(unsigned char **buffer, /* IO - Pointer in buffer */
1253 unsigned char *bufend) /* I - End of buffer */
1254{
41681883 1255 unsigned length; /* Length */
91c84a35
MS
1256
1257
1258 length = **buffer;
1259 (*buffer) ++;
1260
1261 if (length & 128)
41681883
MS
1262 {
1263 int count; /* Number of bytes for length */
1264
1265
1266 if ((count = length & 127) > sizeof(unsigned))
1267 {
1268 (*buffer) += count;
1269 return (0);
1270 }
1271
1272 for (length = 0;
1273 count > 0 && *buffer < bufend;
1274 count --, (*buffer) ++)
1275 length = (length << 8) | **buffer;
1276 }
91c84a35
MS
1277
1278 return (length);
1279}
1280
1281
1282/*
1283 * 'asn1_get_oid()' - Get an OID value.
1284 */
1285
ac884b6a 1286static int /* O - Number of OIDs */
91c84a35
MS
1287asn1_get_oid(
1288 unsigned char **buffer, /* IO - Pointer in buffer */
1289 unsigned char *bufend, /* I - End of buffer */
7e86f2f6 1290 unsigned length, /* I - Length of value */
91c84a35
MS
1291 int *oid, /* I - OID buffer */
1292 int oidsize) /* I - Size of OID buffer */
1293{
1294 unsigned char *valend; /* End of value */
ac884b6a
MS
1295 int *oidptr, /* Current OID */
1296 *oidend; /* End of OID buffer */
91c84a35
MS
1297 int number; /* OID number */
1298
1299
1300 valend = *buffer + length;
ac884b6a 1301 oidptr = oid;
91c84a35
MS
1302 oidend = oid + oidsize - 1;
1303
1304 if (valend > bufend)
1305 valend = bufend;
1306
1307 number = asn1_get_packed(buffer, bufend);
1308
1309 if (number < 80)
1310 {
ac884b6a
MS
1311 *oidptr++ = number / 40;
1312 number = number % 40;
1313 *oidptr++ = number;
91c84a35
MS
1314 }
1315 else
1316 {
ac884b6a
MS
1317 *oidptr++ = 2;
1318 number -= 80;
1319 *oidptr++ = number;
91c84a35
MS
1320 }
1321
1322 while (*buffer < valend)
1323 {
1324 number = asn1_get_packed(buffer, bufend);
1325
ac884b6a
MS
1326 if (oidptr < oidend)
1327 *oidptr++ = number;
91c84a35
MS
1328 }
1329
ac884b6a 1330 *oidptr = -1;
91c84a35 1331
7e86f2f6 1332 return ((int)(oidptr - oid));
91c84a35
MS
1333}
1334
1335
1336/*
1337 * 'asn1_get_packed()' - Get a packed integer value.
1338 */
1339
1340static int /* O - Value */
1341asn1_get_packed(
1342 unsigned char **buffer, /* IO - Pointer in buffer */
1343 unsigned char *bufend) /* I - End of buffer */
1344{
1345 int value; /* Value */
1346
1347
1348 value = 0;
1349
1350 while ((**buffer & 128) && *buffer < bufend)
1351 {
1352 value = (value << 7) | (**buffer & 127);
1353 (*buffer) ++;
1354 }
1355
1356 if (*buffer < bufend)
1357 {
1358 value = (value << 7) | **buffer;
1359 (*buffer) ++;
1360 }
1361
1362 return (value);
1363}
1364
1365
1366/*
1367 * 'asn1_get_string()' - Get a string value.
1368 */
1369
1370static char * /* O - String */
1371asn1_get_string(
1372 unsigned char **buffer, /* IO - Pointer in buffer */
1373 unsigned char *bufend, /* I - End of buffer */
7e86f2f6 1374 unsigned length, /* I - Value length */
91c84a35 1375 char *string, /* I - String buffer */
7e86f2f6 1376 size_t strsize) /* I - String buffer size */
91c84a35 1377{
7e86f2f6
MS
1378 if (length > (unsigned)(bufend - *buffer))
1379 length = (unsigned)(bufend - *buffer);
91c84a35 1380
7e86f2f6 1381 if (length < strsize)
91c84a35
MS
1382 {
1383 /*
1384 * String is smaller than the buffer...
1385 */
1386
1387 if (length > 0)
1388 memcpy(string, *buffer, length);
1389
1390 string[length] = '\0';
1391 }
1392 else
1393 {
1394 /*
1395 * String is larger than the buffer...
1396 */
1397
1398 memcpy(string, *buffer, strsize - 1);
1399 string[strsize - 1] = '\0';
1400 }
1401
1402 if (length > 0)
1403 (*buffer) += length;
1404
7e86f2f6 1405 return (string);
91c84a35
MS
1406}
1407
1408
1409/*
1410 * 'asn1_get_type()' - Get a value type.
1411 */
1412
1413static int /* O - Type */
1414asn1_get_type(unsigned char **buffer, /* IO - Pointer in buffer */
1415 unsigned char *bufend) /* I - End of buffer */
1416{
1417 int type; /* Type */
1418
1419
1420 type = **buffer;
1421 (*buffer) ++;
1422
1423 if ((type & 31) == 31)
1424 type = asn1_get_packed(buffer, bufend);
1425
1426 return (type);
1427}
1428
1429
1430/*
1431 * 'asn1_set_integer()' - Set an integer value.
1432 */
1433
1434static void
1435asn1_set_integer(unsigned char **buffer,/* IO - Pointer in buffer */
1436 int integer) /* I - Integer value */
1437{
1438 **buffer = CUPS_ASN1_INTEGER;
1439 (*buffer) ++;
1440
1441 if (integer > 0x7fffff || integer < -0x800000)
1442 {
1443 **buffer = 4;
1444 (*buffer) ++;
7e86f2f6 1445 **buffer = (unsigned char)(integer >> 24);
91c84a35 1446 (*buffer) ++;
7e86f2f6 1447 **buffer = (unsigned char)(integer >> 16);
91c84a35 1448 (*buffer) ++;
7e86f2f6 1449 **buffer = (unsigned char)(integer >> 8);
91c84a35 1450 (*buffer) ++;
7e86f2f6 1451 **buffer = (unsigned char)integer;
91c84a35
MS
1452 (*buffer) ++;
1453 }
1454 else if (integer > 0x7fff || integer < -0x8000)
1455 {
1456 **buffer = 3;
1457 (*buffer) ++;
7e86f2f6 1458 **buffer = (unsigned char)(integer >> 16);
91c84a35 1459 (*buffer) ++;
7e86f2f6 1460 **buffer = (unsigned char)(integer >> 8);
91c84a35 1461 (*buffer) ++;
7e86f2f6 1462 **buffer = (unsigned char)integer;
91c84a35
MS
1463 (*buffer) ++;
1464 }
1465 else if (integer > 0x7f || integer < -0x80)
1466 {
1467 **buffer = 2;
1468 (*buffer) ++;
7e86f2f6 1469 **buffer = (unsigned char)(integer >> 8);
91c84a35 1470 (*buffer) ++;
7e86f2f6 1471 **buffer = (unsigned char)integer;
91c84a35
MS
1472 (*buffer) ++;
1473 }
1474 else
1475 {
1476 **buffer = 1;
1477 (*buffer) ++;
7e86f2f6 1478 **buffer = (unsigned char)integer;
91c84a35
MS
1479 (*buffer) ++;
1480 }
1481}
1482
1483
1484/*
1485 * 'asn1_set_length()' - Set a value length.
1486 */
1487
1488static void
1489asn1_set_length(unsigned char **buffer, /* IO - Pointer in buffer */
41681883 1490 unsigned length) /* I - Length value */
91c84a35
MS
1491{
1492 if (length > 255)
1493 {
1494 **buffer = 0x82; /* 2-byte length */
1495 (*buffer) ++;
7e86f2f6 1496 **buffer = (unsigned char)(length >> 8);
91c84a35 1497 (*buffer) ++;
7e86f2f6 1498 **buffer = (unsigned char)length;
91c84a35
MS
1499 (*buffer) ++;
1500 }
1501 else if (length > 127)
1502 {
1503 **buffer = 0x81; /* 1-byte length */
1504 (*buffer) ++;
7e86f2f6 1505 **buffer = (unsigned char)length;
91c84a35
MS
1506 (*buffer) ++;
1507 }
1508 else
1509 {
7e86f2f6 1510 **buffer = (unsigned char)length; /* Length */
91c84a35
MS
1511 (*buffer) ++;
1512 }
1513}
1514
1515
1516/*
1517 * 'asn1_set_oid()' - Set an OID value.
1518 */
1519
1520static void
1521asn1_set_oid(unsigned char **buffer, /* IO - Pointer in buffer */
1522 const int *oid) /* I - OID value */
1523{
1524 **buffer = CUPS_ASN1_OID;
1525 (*buffer) ++;
1526
1527 asn1_set_length(buffer, asn1_size_oid(oid));
1528
ac884b6a
MS
1529 if (oid[1] < 0)
1530 {
1531 asn1_set_packed(buffer, oid[0] * 40);
1532 return;
1533 }
1534
91c84a35
MS
1535 asn1_set_packed(buffer, oid[0] * 40 + oid[1]);
1536
ac884b6a 1537 for (oid += 2; *oid >= 0; oid ++)
91c84a35
MS
1538 asn1_set_packed(buffer, *oid);
1539}
1540
1541
1542/*
1543 * 'asn1_set_packed()' - Set a packed integer value.
1544 */
1545
1546static void
1547asn1_set_packed(unsigned char **buffer, /* IO - Pointer in buffer */
1548 int integer) /* I - Integer value */
1549{
1550 if (integer > 0xfffffff)
1551 {
ac884b6a 1552 **buffer = ((integer >> 28) & 0x7f) | 0x80;
91c84a35
MS
1553 (*buffer) ++;
1554 }
1555
1556 if (integer > 0x1fffff)
1557 {
ac884b6a 1558 **buffer = ((integer >> 21) & 0x7f) | 0x80;
91c84a35
MS
1559 (*buffer) ++;
1560 }
1561
1562 if (integer > 0x3fff)
1563 {
ac884b6a 1564 **buffer = ((integer >> 14) & 0x7f) | 0x80;
91c84a35
MS
1565 (*buffer) ++;
1566 }
1567
1568 if (integer > 0x7f)
1569 {
ac884b6a 1570 **buffer = ((integer >> 7) & 0x7f) | 0x80;
91c84a35
MS
1571 (*buffer) ++;
1572 }
1573
1574 **buffer = integer & 0x7f;
1575 (*buffer) ++;
1576}
1577
1578
1579/*
1580 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1581 * integer value.
1582 */
1583
7e86f2f6 1584static unsigned /* O - Size in bytes */
91c84a35
MS
1585asn1_size_integer(int integer) /* I - Integer value */
1586{
1587 if (integer > 0x7fffff || integer < -0x800000)
1588 return (4);
1589 else if (integer > 0x7fff || integer < -0x8000)
1590 return (3);
1591 else if (integer > 0x7f || integer < -0x80)
1592 return (2);
1593 else
1594 return (1);
1595}
1596
1597
1598/*
1599 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1600 * length value.
1601 */
1602
7e86f2f6
MS
1603static unsigned /* O - Size in bytes */
1604asn1_size_length(unsigned length) /* I - Length value */
91c84a35
MS
1605{
1606 if (length > 0xff)
1607 return (3);
1608 else if (length > 0x7f)
1609 return (2);
1610 else
1611 return (1);
1612}
1613
1614
1615/*
9befde09 1616 * 'asn1_size_oid()' - Figure out the number of bytes needed for an
91c84a35
MS
1617 * OID value.
1618 */
1619
7e86f2f6 1620static unsigned /* O - Size in bytes */
91c84a35
MS
1621asn1_size_oid(const int *oid) /* I - OID value */
1622{
7e86f2f6 1623 unsigned length; /* Length of value */
91c84a35
MS
1624
1625
ac884b6a
MS
1626 if (oid[1] < 0)
1627 return (asn1_size_packed(oid[0] * 40));
1628
1629 for (length = asn1_size_packed(oid[0] * 40 + oid[1]), oid += 2;
1630 *oid >= 0;
1631 oid ++)
91c84a35
MS
1632 length += asn1_size_packed(*oid);
1633
1634 return (length);
1635}
1636
1637
1638/*
1639 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1640 * packed integer value.
1641 */
1642
7e86f2f6 1643static unsigned /* O - Size in bytes */
91c84a35
MS
1644asn1_size_packed(int integer) /* I - Integer value */
1645{
1646 if (integer > 0xfffffff)
1647 return (5);
1648 else if (integer > 0x1fffff)
1649 return (4);
1650 else if (integer > 0x3fff)
1651 return (3);
1652 else if (integer > 0x7f)
1653 return (2);
1654 else
1655 return (1);
1656}
1657
1658
1659/*
1660 * 'snmp_set_error()' - Set the localized error for a packet.
1661 */
1662
1663static void
1664snmp_set_error(cups_snmp_t *packet, /* I - Packet */
1665 const char *message) /* I - Error message */
1666{
1667 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
1668
1669
1670 if (!cg->lang_default)
1671 cg->lang_default = cupsLangDefault();
1672
1673 packet->error = _cupsLangString(cg->lang_default, message);
1674}