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