4 * SNMP functions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2008 by Apple Inc.
7 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * cupsSNMPClose() - Close a SNMP socket.
20 * cupsSNMPCopyOID() - Copy an OID.
21 * cupsSNMPDefaultCommunity() - Get the default SNMP community name.
22 * cupsSNMPIsOID() - Test whether a SNMP response contains the
24 * cupsSNMPIsOIDPrefixed() - Test whether a SNMP response uses the
25 * specified OID prefix.
26 * cupsSNMPOpen() - Open a SNMP socket.
27 * cupsSNMPRead() - Read and parse a SNMP response.
28 * cupsSNMPSetDebug() - Enable/disable debug logging to stderr.
29 * cupsSNMPWalk() - Enumerate a group of OIDs.
30 * cupsSNMPWrite() - Send an SNMP query packet.
31 * asn1_debug() - Decode an ASN1-encoded message.
32 * asn1_decode_snmp() - Decode a SNMP packet.
33 * asn1_encode_snmp() - Encode a SNMP packet.
34 * asn1_get_integer() - Get an integer value.
35 * asn1_get_length() - Get a value length.
36 * asn1_get_oid() - Get an OID value.
37 * asn1_get_packed() - Get a packed integer value.
38 * asn1_get_string() - Get a string value.
39 * asn1_get_type() - Get a value type.
40 * asn1_set_integer() - Set an integer value.
41 * asn1_set_length() - Set a value length.
42 * asn1_set_oid() - Set an OID value.
43 * asn1_set_packed() - Set a packed integer value.
44 * asn1_size_integer() - Figure out the number of bytes needed for an
46 * asn1_size_length() - Figure out the number of bytes needed for a
48 * asn1_size_oid() - Figure out the numebr of bytes needed for an
50 * asn1_size_packed() - Figure out the number of bytes needed for a
51 * packed integer value.
52 * snmp_set_error() - Set the localized error for a packet.
56 * Include necessary headers.
63 # include <sys/poll.h>
64 #endif /* HAVE_POLL */
71 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
72 size_t len
, int indent
);
73 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
75 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
77 static int asn1_get_integer(unsigned char **buffer
,
78 unsigned char *bufend
,
80 static int asn1_get_oid(unsigned char **buffer
,
81 unsigned char *bufend
,
82 int length
, int *oid
, int oidsize
);
83 static int asn1_get_packed(unsigned char **buffer
,
84 unsigned char *bufend
);
85 static char *asn1_get_string(unsigned char **buffer
,
86 unsigned char *bufend
,
87 int length
, char *string
,
89 static int asn1_get_length(unsigned char **buffer
,
90 unsigned char *bufend
);
91 static int asn1_get_type(unsigned char **buffer
,
92 unsigned char *bufend
);
93 static void asn1_set_integer(unsigned char **buffer
,
95 static void asn1_set_length(unsigned char **buffer
,
97 static void asn1_set_oid(unsigned char **buffer
,
99 static void asn1_set_packed(unsigned char **buffer
,
101 static int asn1_size_integer(int integer
);
102 static int asn1_size_length(int length
);
103 static int asn1_size_oid(const int *oid
);
104 static int asn1_size_packed(int integer
);
105 static void snmp_set_error(cups_snmp_t
*packet
,
106 const char *message
);
110 * 'cupsSNMPClose()' - Close a SNMP socket.
116 cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
127 * 'cupsSNMPCopyOID()' - Copy an OID.
129 * The array pointed to by "src" is terminated by the value -1.
134 int * /* O - New OID */
135 cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
136 const int *src
, /* I - Source OID */
137 int dstsize
) /* I - Number of integers in dst */
139 int i
; /* Looping var */
142 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
152 * 'cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
154 * The default community name is the first community name found in the
155 * snmp.conf file. If no community name is defined there, "public" is used.
160 const char * /* O - Default community name */
161 cupsSNMPDefaultCommunity(void)
163 cups_file_t
*fp
; /* snmp.conf file */
164 char line
[1024], /* Line from file */
165 *value
; /* Value from file */
166 int linenum
; /* Line number in file */
167 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
170 if (!cg
->snmp_community
[0])
172 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
174 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
175 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
178 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
179 if (!strcasecmp(line
, "Community") && value
)
181 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
189 return (cg
->snmp_community
);
194 * 'cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
196 * The array pointed to by "oid" is terminated by the value -1.
201 int /* O - 1 if equal, 0 if not equal */
202 cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
203 const int *oid
) /* I - OID */
205 int i
; /* Looping var */
209 * Range check input...
220 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
222 if (oid
[i
] != packet
->object_name
[i
])
225 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
230 * 'cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
233 * The array pointed to by "prefix" is terminated by the value -1.
238 int /* O - 1 if prefixed, 0 if not prefixed */
239 cupsSNMPIsOIDPrefixed(
240 cups_snmp_t
*packet
, /* I - Response packet */
241 const int *prefix
) /* I - OID prefix */
243 int i
; /* Looping var */
247 * Range check input...
250 if (!packet
|| !prefix
)
258 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
260 if (prefix
[i
] != packet
->object_name
[i
])
263 return (i
< CUPS_SNMP_MAX_OID
);
268 * 'cupsSNMPOpen()' - Open a SNMP socket.
273 int /* O - SNMP socket file descriptor */
274 cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
276 int fd
; /* SNMP socket file descriptor */
277 int val
; /* Socket option value */
281 * Create the SNMP socket...
284 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
288 * Set the "broadcast" flag...
293 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, &val
, sizeof(val
)))
305 * 'cupsSNMPRead()' - Read and parse a SNMP response.
307 * If "timeout" is negative, @code cupsSNMPRead@ will wait for a response
313 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
314 cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
315 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
316 int msec
) /* I - Timeout in milliseconds */
318 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
320 int bytes
; /* Number of bytes received */
321 socklen_t addrlen
; /* Source address length */
322 http_addr_t address
; /* Source address */
326 * Range check input...
329 if (fd
< 0 || !packet
)
333 * Optionally wait for a response...
338 int ready
; /* Data ready on socket? */
340 struct pollfd pfd
; /* Polled file descriptor */
345 while ((ready
= poll(&pfd
, 1, msec
)) < 0 && errno
== EINTR
);
348 fd_set input_set
; /* select() input set */
349 struct timeval timeout
; /* select() timeout */
354 FD_SET(fd
, &input_set
);
356 timeout
.tv_sec
= msec
/ 1000;
357 timeout
.tv_usec
= (msec
% 1000) * 1000;
359 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &timeout
);
362 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
364 while (ready
< 0 && errno
== EINTR
);
366 #endif /* HAVE_POLL */
369 * If we don't have any data ready, return right away...
377 * Read the response data...
380 addrlen
= sizeof(address
);
382 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
387 * Look for the response status code in the SNMP message header...
390 asn1_debug("DEBUG: IN ", buffer
, bytes
, 0);
392 asn1_decode_snmp(buffer
, bytes
, packet
);
394 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
397 * Return decoded data packet...
405 * 'cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
411 cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
413 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
416 cg
->snmp_debug
= level
;
421 * 'cupsSNMPWalk()' - Enumerate a group of OIDs.
423 * This function queries all of the OIDs with the specified OID prefix,
424 * calling the "cb" function for every response that is received.
426 * The array pointed to by "prefix" is terminated by the value -1.
431 int /* O - Number of OIDs found or -1 on error */
432 cupsSNMPWalk(int fd
, /* I - SNMP socket */
433 http_addr_t
*address
, /* I - Address to query */
434 int version
, /* I - SNMP version */
435 const char *community
, /* I - Community name */
436 const int *prefix
, /* I - OID prefix */
437 int msec
, /* I - Timeout for each response in milliseconds */
438 cups_snmp_cb_t cb
, /* I - Function to call for each response */
439 void *data
) /* I - User data pointer that is passed to the callback function */
441 int count
= 0; /* Number of OIDs found */
442 int request_id
= 0; /* Current request ID */
443 cups_snmp_t packet
; /* Current response packet */
447 * Range check input...
450 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
455 * Copy the OID prefix and then loop until we have no more OIDs...
458 cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
464 if (!cupsSNMPWrite(fd
, address
, version
, community
,
465 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
469 if (!cupsSNMPRead(fd
, &packet
, msec
))
472 if (!cupsSNMPIsOIDPrefixed(&packet
, prefix
))
475 if (packet
.error
|| packet
.error_status
)
476 return (count
> 0 ? count
: -1);
480 (*cb
)(&packet
, data
);
486 * 'cupsSNMPWrite()' - Send an SNMP query packet.
488 * The array pointed to by "oid" is terminated by the value -1.
493 int /* O - 1 on success, 0 on error */
495 int fd
, /* I - SNMP socket */
496 http_addr_t
*address
, /* I - Address to send to */
497 int version
, /* I - SNMP version */
498 const char *community
, /* I - Community name */
499 cups_asn1_t request_type
, /* I - Request type */
500 const unsigned request_id
, /* I - Request ID */
501 const int *oid
) /* I - OID */
503 int i
; /* Looping var */
504 cups_snmp_t packet
; /* SNMP message packet */
505 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
506 /* SNMP message buffer */
507 int bytes
; /* Size of message */
511 * Range check input...
514 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
515 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
516 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
520 * Create the SNMP message...
523 memset(&packet
, 0, sizeof(packet
));
525 packet
.version
= version
;
526 packet
.request_type
= request_type
;
527 packet
.request_id
= request_id
;
528 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
530 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
532 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
533 packet
.object_name
[i
] = oid
[i
];
534 packet
.object_name
[i
] = -1;
542 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
550 asn1_debug("DEBUG: OUT ", buffer
, bytes
, 0);
553 * Send the message...
557 if (address
->addr
.sa_family
== AF_INET6
)
558 address
->ipv6
.sin6_port
= htons(CUPS_SNMP_PORT
);
560 #endif /* AF_INET6 */
561 address
->ipv4
.sin_port
= htons(CUPS_SNMP_PORT
);
563 return (sendto(fd
, buffer
, bytes
, 0, (void *)address
,
564 httpAddrLength(address
)) == bytes
);
569 * 'asn1_debug()' - Decode an ASN1-encoded message.
573 asn1_debug(const char *prefix
, /* I - Prefix string */
574 unsigned char *buffer
, /* I - Buffer */
575 size_t len
, /* I - Length of buffer */
576 int indent
) /* I - Indentation */
578 int i
; /* Looping var */
579 unsigned char *bufend
; /* End of buffer */
580 int integer
; /* Number value */
581 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
582 char string
[CUPS_SNMP_MAX_STRING
];
584 unsigned char value_type
; /* Type of value */
585 int value_length
; /* Length of value */
586 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
589 if (cg
->snmp_debug
<= 0)
592 if (cg
->snmp_debug
> 1 && indent
== 0)
595 * Do a hex dump of the packet...
600 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
602 for (i
= 0; i
< len
; i
+= 16)
604 fprintf(stderr
, "%s%04x:", prefix
, i
);
606 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
609 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
611 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
626 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
627 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
630 putc(buffer
[i
+ j
], stderr
);
637 fprintf(stderr
, "%sMessage:\n", prefix
);
639 bufend
= buffer
+ len
;
641 while (buffer
< bufend
)
647 value_type
= asn1_get_type(&buffer
, bufend
);
648 value_length
= asn1_get_length(&buffer
, bufend
);
652 case CUPS_ASN1_BOOLEAN
:
653 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
655 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
656 value_length
, integer
);
659 case CUPS_ASN1_INTEGER
:
660 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
662 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
663 value_length
, integer
);
666 case CUPS_ASN1_COUNTER
:
667 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
669 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
670 value_length
, (unsigned)integer
);
673 case CUPS_ASN1_GAUGE
:
674 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
676 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
677 value_length
, (unsigned)integer
);
680 case CUPS_ASN1_TIMETICKS
:
681 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
683 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
684 value_length
, (unsigned)integer
);
687 case CUPS_ASN1_OCTET_STRING
:
688 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
689 indent
, "", value_length
,
690 asn1_get_string(&buffer
, bufend
, value_length
, string
,
694 case CUPS_ASN1_HEX_STRING
:
695 asn1_get_string(&buffer
, bufend
, value_length
, string
,
697 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
698 indent
, "", value_length
);
699 for (i
= 0; i
< value_length
; i
++)
700 fprintf(stderr
, " %02X", string
[i
] & 255);
704 case CUPS_ASN1_NULL_VALUE
:
705 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
708 buffer
+= value_length
;
712 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
715 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
717 for (i
= 0; i
< integer
; i
++)
718 fprintf(stderr
, ".%d", oid
[i
]);
722 case CUPS_ASN1_SEQUENCE
:
723 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
725 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
727 buffer
+= value_length
;
730 case CUPS_ASN1_GET_NEXT_REQUEST
:
731 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
732 indent
, "", value_length
);
733 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
735 buffer
+= value_length
;
738 case CUPS_ASN1_GET_REQUEST
:
739 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
741 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
743 buffer
+= value_length
;
746 case CUPS_ASN1_GET_RESPONSE
:
747 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
749 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
751 buffer
+= value_length
;
755 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
756 value_type
, value_length
);
758 buffer
+= value_length
;
766 * 'asn1_decode_snmp()' - Decode a SNMP packet.
769 static int /* O - 0 on success, -1 on error */
770 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
771 size_t len
, /* I - Size of buffer */
772 cups_snmp_t
*packet
) /* I - SNMP packet */
774 unsigned char *bufptr
, /* Pointer into the data */
775 *bufend
; /* End of data */
776 int length
; /* Length of value */
780 * Initialize the decoding...
783 memset(packet
, 0, sizeof(cups_snmp_t
));
784 packet
->object_name
[0] = -1;
787 bufend
= buffer
+ len
;
789 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
790 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
791 else if (asn1_get_length(&bufptr
, bufend
) == 0)
792 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
793 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
794 snmp_set_error(packet
, _("No version number"));
795 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
796 snmp_set_error(packet
, _("Version uses indefinite length"));
797 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
798 != CUPS_SNMP_VERSION_1
)
799 snmp_set_error(packet
, _("Bad SNMP version number"));
800 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
801 snmp_set_error(packet
, _("No community name"));
802 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
803 snmp_set_error(packet
, _("Community name uses indefinite length"));
806 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
807 sizeof(packet
->community
));
809 if ((packet
->request_type
= asn1_get_type(&bufptr
, bufend
))
810 != CUPS_ASN1_GET_RESPONSE
)
811 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
812 else if (asn1_get_length(&bufptr
, bufend
) == 0)
813 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
814 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
815 snmp_set_error(packet
, _("No request-id"));
816 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
817 snmp_set_error(packet
, _("request-id uses indefinite length"));
820 packet
->request_id
= asn1_get_integer(&bufptr
, bufend
, length
);
822 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
823 snmp_set_error(packet
, _("No error-status"));
824 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
825 snmp_set_error(packet
, _("error-status uses indefinite length"));
828 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
830 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
831 snmp_set_error(packet
, _("No error-index"));
832 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
833 snmp_set_error(packet
, _("error-index uses indefinite length"));
836 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
838 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
839 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
840 else if (asn1_get_length(&bufptr
, bufend
) == 0)
841 snmp_set_error(packet
,
842 _("variable-bindings uses indefinite length"));
843 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
844 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
845 else if (asn1_get_length(&bufptr
, bufend
) == 0)
846 snmp_set_error(packet
, _("VarBind uses indefinite length"));
847 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
848 snmp_set_error(packet
, _("No name OID"));
849 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
850 snmp_set_error(packet
, _("Name OID uses indefinite length"));
853 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
856 packet
->object_type
= asn1_get_type(&bufptr
, bufend
);
858 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
859 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
860 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
861 snmp_set_error(packet
, _("Value uses indefinite length"));
864 switch (packet
->object_type
)
866 case CUPS_ASN1_BOOLEAN
:
867 packet
->object_value
.boolean
=
868 asn1_get_integer(&bufptr
, bufend
, length
);
871 case CUPS_ASN1_INTEGER
:
872 packet
->object_value
.integer
=
873 asn1_get_integer(&bufptr
, bufend
, length
);
876 case CUPS_ASN1_NULL_VALUE
:
879 case CUPS_ASN1_OCTET_STRING
:
880 asn1_get_string(&bufptr
, bufend
, length
,
881 packet
->object_value
.string
,
882 CUPS_SNMP_MAX_STRING
);
886 asn1_get_oid(&bufptr
, bufend
, length
,
887 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
890 case CUPS_ASN1_HEX_STRING
:
891 packet
->object_value
.hex_string
.num_bytes
= length
;
893 asn1_get_string(&bufptr
, bufend
, length
,
894 (char *)packet
->object_value
.hex_string
.bytes
,
895 CUPS_SNMP_MAX_STRING
);
898 case CUPS_ASN1_COUNTER
:
899 packet
->object_value
.counter
=
900 asn1_get_integer(&bufptr
, bufend
, length
);
903 case CUPS_ASN1_GAUGE
:
904 packet
->object_value
.gauge
=
905 asn1_get_integer(&bufptr
, bufend
, length
);
908 case CUPS_ASN1_TIMETICKS
:
909 packet
->object_value
.timeticks
=
910 asn1_get_integer(&bufptr
, bufend
, length
);
914 snmp_set_error(packet
, _("Unsupported value type"));
924 return (packet
->error
? -1 : 0);
929 * 'asn1_encode_snmp()' - Encode a SNMP packet.
932 static int /* O - Length on success, -1 on error */
933 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
934 size_t bufsize
, /* I - Size of buffer */
935 cups_snmp_t
*packet
) /* I - SNMP packet */
937 unsigned char *bufptr
; /* Pointer into buffer */
938 int total
, /* Total length */
939 msglen
, /* Length of entire message */
940 commlen
, /* Length of community string */
941 reqlen
, /* Length of request */
942 listlen
, /* Length of variable list */
943 varlen
, /* Length of variable */
944 namelen
, /* Length of object name OID */
945 valuelen
; /* Length of object value */
949 * Get the lengths of the community string, OID, and message...
953 namelen
= asn1_size_oid(packet
->object_name
);
955 switch (packet
->object_type
)
957 case CUPS_ASN1_NULL_VALUE
:
961 case CUPS_ASN1_BOOLEAN
:
962 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
965 case CUPS_ASN1_INTEGER
:
966 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
969 case CUPS_ASN1_OCTET_STRING
:
970 valuelen
= strlen(packet
->object_value
.string
);
974 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
978 packet
->error
= "Unknown object type";
982 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
983 1 + asn1_size_length(valuelen
) + valuelen
;
984 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
985 reqlen
= 2 + asn1_size_integer(packet
->request_id
) +
986 2 + asn1_size_integer(packet
->error_status
) +
987 2 + asn1_size_integer(packet
->error_index
) +
988 1 + asn1_size_length(listlen
) + listlen
;
989 commlen
= strlen(packet
->community
);
990 msglen
= 2 + asn1_size_integer(packet
->version
) +
991 1 + asn1_size_length(commlen
) + commlen
+
992 1 + asn1_size_length(reqlen
) + reqlen
;
993 total
= 1 + asn1_size_length(msglen
) + msglen
;
997 packet
->error
= "Message too large for buffer";
1002 * Then format the message...
1007 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1008 asn1_set_length(&bufptr
, msglen
);
1010 asn1_set_integer(&bufptr
, packet
->version
);
1013 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1014 asn1_set_length(&bufptr
, commlen
);
1015 memcpy(bufptr
, packet
->community
, commlen
);
1018 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1019 asn1_set_length(&bufptr
, reqlen
);
1021 asn1_set_integer(&bufptr
, packet
->request_id
);
1023 asn1_set_integer(&bufptr
, packet
->error_status
);
1025 asn1_set_integer(&bufptr
, packet
->error_index
);
1027 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1028 asn1_set_length(&bufptr
, listlen
);
1030 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1031 asn1_set_length(&bufptr
, varlen
);
1033 asn1_set_oid(&bufptr
, packet
->object_name
);
1036 switch (packet
->object_type
)
1038 case CUPS_ASN1_NULL_VALUE
:
1039 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1041 *bufptr
++ = 0; /* Length */
1044 case CUPS_ASN1_BOOLEAN
:
1045 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1048 case CUPS_ASN1_INTEGER
:
1049 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1052 case CUPS_ASN1_OCTET_STRING
:
1053 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1054 asn1_set_length(&bufptr
, valuelen
);
1055 memcpy(bufptr
, packet
->object_value
.string
, valuelen
);
1059 case CUPS_ASN1_OID
:
1060 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1067 return (bufptr
- buffer
);
1072 * 'asn1_get_integer()' - Get an integer value.
1075 static int /* O - Integer value */
1077 unsigned char **buffer
, /* IO - Pointer in buffer */
1078 unsigned char *bufend
, /* I - End of buffer */
1079 int length
) /* I - Length of value */
1081 int value
; /* Integer value */
1085 length
> 0 && *buffer
< bufend
;
1086 length
--, (*buffer
) ++)
1087 value
= (value
<< 8) | **buffer
;
1094 * 'asn1_get_length()' - Get a value length.
1097 static int /* O - Length */
1098 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1099 unsigned char *bufend
) /* I - End of buffer */
1101 int length
; /* Length */
1108 length
= asn1_get_integer(buffer
, bufend
, length
& 127);
1115 * 'asn1_get_oid()' - Get an OID value.
1118 static int /* O - Number of OIDs */
1120 unsigned char **buffer
, /* IO - Pointer in buffer */
1121 unsigned char *bufend
, /* I - End of buffer */
1122 int length
, /* I - Length of value */
1123 int *oid
, /* I - OID buffer */
1124 int oidsize
) /* I - Size of OID buffer */
1126 unsigned char *valend
; /* End of value */
1127 int *oidptr
, /* Current OID */
1128 *oidend
; /* End of OID buffer */
1129 int number
; /* OID number */
1132 valend
= *buffer
+ length
;
1134 oidend
= oid
+ oidsize
- 1;
1136 if (valend
> bufend
)
1139 number
= asn1_get_packed(buffer
, bufend
);
1143 *oidptr
++ = number
/ 40;
1144 number
= number
% 40;
1154 while (*buffer
< valend
)
1156 number
= asn1_get_packed(buffer
, bufend
);
1158 if (oidptr
< oidend
)
1164 return (oidptr
- oid
);
1169 * 'asn1_get_packed()' - Get a packed integer value.
1172 static int /* O - Value */
1174 unsigned char **buffer
, /* IO - Pointer in buffer */
1175 unsigned char *bufend
) /* I - End of buffer */
1177 int value
; /* Value */
1182 while ((**buffer
& 128) && *buffer
< bufend
)
1184 value
= (value
<< 7) | (**buffer
& 127);
1188 if (*buffer
< bufend
)
1190 value
= (value
<< 7) | **buffer
;
1199 * 'asn1_get_string()' - Get a string value.
1202 static char * /* O - String */
1204 unsigned char **buffer
, /* IO - Pointer in buffer */
1205 unsigned char *bufend
, /* I - End of buffer */
1206 int length
, /* I - Value length */
1207 char *string
, /* I - String buffer */
1208 int strsize
) /* I - String buffer size */
1213 * Disallow negative lengths!
1218 else if (length
< strsize
)
1221 * String is smaller than the buffer...
1225 memcpy(string
, *buffer
, length
);
1227 string
[length
] = '\0';
1232 * String is larger than the buffer...
1235 memcpy(string
, *buffer
, strsize
- 1);
1236 string
[strsize
- 1] = '\0';
1240 (*buffer
) += length
;
1242 return (length
< 0 ? NULL
: string
);
1247 * 'asn1_get_type()' - Get a value type.
1250 static int /* O - Type */
1251 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1252 unsigned char *bufend
) /* I - End of buffer */
1254 int type
; /* Type */
1260 if ((type
& 31) == 31)
1261 type
= asn1_get_packed(buffer
, bufend
);
1268 * 'asn1_set_integer()' - Set an integer value.
1272 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1273 int integer
) /* I - Integer value */
1275 **buffer
= CUPS_ASN1_INTEGER
;
1278 if (integer
> 0x7fffff || integer
< -0x800000)
1282 **buffer
= integer
>> 24;
1284 **buffer
= integer
>> 16;
1286 **buffer
= integer
>> 8;
1291 else if (integer
> 0x7fff || integer
< -0x8000)
1295 **buffer
= integer
>> 16;
1297 **buffer
= integer
>> 8;
1302 else if (integer
> 0x7f || integer
< -0x80)
1306 **buffer
= integer
>> 8;
1322 * 'asn1_set_length()' - Set a value length.
1326 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1327 int length
) /* I - Length value */
1331 **buffer
= 0x82; /* 2-byte length */
1333 **buffer
= length
>> 8;
1338 else if (length
> 127)
1340 **buffer
= 0x81; /* 1-byte length */
1347 **buffer
= length
; /* Length */
1354 * 'asn1_set_oid()' - Set an OID value.
1358 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1359 const int *oid
) /* I - OID value */
1361 **buffer
= CUPS_ASN1_OID
;
1364 asn1_set_length(buffer
, asn1_size_oid(oid
));
1368 asn1_set_packed(buffer
, oid
[0] * 40);
1372 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1374 for (oid
+= 2; *oid
>= 0; oid
++)
1375 asn1_set_packed(buffer
, *oid
);
1380 * 'asn1_set_packed()' - Set a packed integer value.
1384 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1385 int integer
) /* I - Integer value */
1387 if (integer
> 0xfffffff)
1389 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1393 if (integer
> 0x1fffff)
1395 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1399 if (integer
> 0x3fff)
1401 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1407 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1411 **buffer
= integer
& 0x7f;
1417 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1421 static int /* O - Size in bytes */
1422 asn1_size_integer(int integer
) /* I - Integer value */
1424 if (integer
> 0x7fffff || integer
< -0x800000)
1426 else if (integer
> 0x7fff || integer
< -0x8000)
1428 else if (integer
> 0x7f || integer
< -0x80)
1436 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1440 static int /* O - Size in bytes */
1441 asn1_size_length(int length
) /* I - Length value */
1445 else if (length
> 0x7f)
1453 * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
1457 static int /* O - Size in bytes */
1458 asn1_size_oid(const int *oid
) /* I - OID value */
1460 int length
; /* Length of value */
1464 return (asn1_size_packed(oid
[0] * 40));
1466 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1469 length
+= asn1_size_packed(*oid
);
1476 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1477 * packed integer value.
1480 static int /* O - Size in bytes */
1481 asn1_size_packed(int integer
) /* I - Integer value */
1483 if (integer
> 0xfffffff)
1485 else if (integer
> 0x1fffff)
1487 else if (integer
> 0x3fff)
1489 else if (integer
> 0x7f)
1497 * 'snmp_set_error()' - Set the localized error for a packet.
1501 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1502 const char *message
) /* I - Error message */
1504 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1507 if (!cg
->lang_default
)
1508 cg
->lang_default
= cupsLangDefault();
1510 packet
->error
= _cupsLangString(cg
->lang_default
, message
);