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 * _cupsSNMPOIDToString() - Convert an OID to a string.
27 * _cupsSNMPOpen() - Open a SNMP socket.
28 * _cupsSNMPRead() - Read and parse a SNMP response.
29 * _cupsSNMPSetDebug() - Enable/disable debug logging to stderr.
30 * _cupsSNMPStringToOID() - Convert a numeric OID string to an OID array.
31 * _cupsSNMPWalk() - Enumerate a group of OIDs.
32 * _cupsSNMPWrite() - Send an SNMP query packet.
33 * asn1_debug() - Decode an ASN1-encoded message.
34 * asn1_decode_snmp() - Decode a SNMP packet.
35 * asn1_encode_snmp() - Encode a SNMP packet.
36 * asn1_get_integer() - Get an integer value.
37 * asn1_get_length() - Get a value length.
38 * asn1_get_oid() - Get an OID value.
39 * asn1_get_packed() - Get a packed integer value.
40 * asn1_get_string() - Get a string value.
41 * asn1_get_type() - Get a value type.
42 * asn1_set_integer() - Set an integer value.
43 * asn1_set_length() - Set a value length.
44 * asn1_set_oid() - Set an OID value.
45 * asn1_set_packed() - Set a packed integer value.
46 * asn1_size_integer() - Figure out the number of bytes needed for an
48 * asn1_size_length() - Figure out the number of bytes needed for a
50 * asn1_size_oid() - Figure out the numebr of bytes needed for an
52 * asn1_size_packed() - Figure out the number of bytes needed for a
53 * packed integer value.
54 * snmp_set_error() - Set the localized error for a packet.
58 * Include necessary headers.
63 #include "snmp-private.h"
66 # include <sys/poll.h>
67 #endif /* HAVE_POLL */
74 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
75 size_t len
, int indent
);
76 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
78 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
80 static int asn1_get_integer(unsigned char **buffer
,
81 unsigned char *bufend
,
83 static int asn1_get_oid(unsigned char **buffer
,
84 unsigned char *bufend
,
85 int length
, int *oid
, int oidsize
);
86 static int asn1_get_packed(unsigned char **buffer
,
87 unsigned char *bufend
);
88 static char *asn1_get_string(unsigned char **buffer
,
89 unsigned char *bufend
,
90 int length
, char *string
,
92 static int asn1_get_length(unsigned char **buffer
,
93 unsigned char *bufend
);
94 static int asn1_get_type(unsigned char **buffer
,
95 unsigned char *bufend
);
96 static void asn1_set_integer(unsigned char **buffer
,
98 static void asn1_set_length(unsigned char **buffer
,
100 static void asn1_set_oid(unsigned char **buffer
,
102 static void asn1_set_packed(unsigned char **buffer
,
104 static int asn1_size_integer(int integer
);
105 static int asn1_size_length(int length
);
106 static int asn1_size_oid(const int *oid
);
107 static int asn1_size_packed(int integer
);
108 static void snmp_set_error(cups_snmp_t
*packet
,
109 const char *message
);
113 * '_cupsSNMPClose()' - Close a SNMP socket.
119 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
121 DEBUG_printf(("_cupsSNMPClose(fd=%d)\n", fd
));
132 * '_cupsSNMPCopyOID()' - Copy an OID.
134 * The array pointed to by "src" is terminated by the value -1.
139 int * /* O - New OID */
140 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
141 const int *src
, /* I - Source OID */
142 int dstsize
) /* I - Number of integers in dst */
144 int i
; /* Looping var */
147 DEBUG_printf(("_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)\n", dst
, src
,
150 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
160 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
162 * The default community name is the first community name found in the
163 * snmp.conf file. If no community name is defined there, "public" is used.
168 const char * /* O - Default community name */
169 _cupsSNMPDefaultCommunity(void)
171 cups_file_t
*fp
; /* snmp.conf file */
172 char line
[1024], /* Line from file */
173 *value
; /* Value from file */
174 int linenum
; /* Line number in file */
175 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
178 DEBUG_puts("_cupsSNMPDefaultCommunity()");
180 if (!cg
->snmp_community
[0])
182 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
184 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
185 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
188 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
189 if (!strcasecmp(line
, "Community") && value
)
191 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
199 DEBUG_printf(("_cupsSNMPDefaultCommunity: Returning \"%s\"\n",
200 cg
->snmp_community
));
202 return (cg
->snmp_community
);
207 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
209 * The array pointed to by "oid" is terminated by the value -1.
214 int /* O - 1 if equal, 0 if not equal */
215 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
216 const int *oid
) /* I - OID */
218 int i
; /* Looping var */
222 * Range check input...
225 DEBUG_printf(("_cupsSNMPIsOID(packet=%p, oid=%p)\n", packet
, oid
));
229 DEBUG_puts("_cupsSNMPIsOID: Returning 0");
239 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
241 if (oid
[i
] != packet
->object_name
[i
])
243 DEBUG_puts("_cupsSNMPIsOID: Returning 0");
248 DEBUG_printf(("_cupsSNMPIsOID: Returning %d\n",
249 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
251 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
256 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
259 * The array pointed to by "prefix" is terminated by the value -1.
264 int /* O - 1 if prefixed, 0 if not prefixed */
265 _cupsSNMPIsOIDPrefixed(
266 cups_snmp_t
*packet
, /* I - Response packet */
267 const int *prefix
) /* I - OID prefix */
269 int i
; /* Looping var */
273 * Range check input...
276 DEBUG_printf(("_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)\n", packet
,
279 if (!packet
|| !prefix
)
281 DEBUG_puts("_cupsSNMPIsOIDPrefixed: Returning 0");
291 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
293 if (prefix
[i
] != packet
->object_name
[i
])
295 DEBUG_puts("_cupsSNMPIsOIDPrefixed: Returning 0");
300 DEBUG_printf(("_cupsSNMPIsOIDPrefixed: Returning %d\n",
301 i
< CUPS_SNMP_MAX_OID
));
303 return (i
< CUPS_SNMP_MAX_OID
);
308 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
314 char * /* O - New string or @code NULL@ on error */
315 _cupsSNMPOIDToString(const int *src
, /* I - OID */
316 char *dst
, /* I - String buffer */
317 size_t dstsize
) /* I - Size of string buffer */
319 char *dstptr
, /* Pointer into string buffer */
320 *dstend
; /* End of string buffer */
323 DEBUG_printf(("_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")\n",
324 src
, dst
, CUPS_LLCAST dstsize
));
327 * Range check input...
330 if (!src
|| !dst
|| dstsize
< 4)
334 * Loop through the OID array and build a string...
337 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
338 *src
>= 0 && dstptr
< dstend
;
339 src
++, dstptr
+= strlen(dstptr
))
340 snprintf(dstptr
, dstend
- dstptr
+ 1, ".%d", *src
);
350 * '_cupsSNMPOpen()' - Open a SNMP socket.
355 int /* O - SNMP socket file descriptor */
356 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
358 int fd
; /* SNMP socket file descriptor */
359 int val
; /* Socket option value */
363 * Create the SNMP socket...
366 DEBUG_printf(("_cupsSNMPOpen(family=%d)\n", family
));
368 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
370 DEBUG_printf(("_cupsSNMPOpen: Returning -1 (%s)\n", strerror(errno
)));
376 * Set the "broadcast" flag...
381 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, &val
, sizeof(val
)))
383 DEBUG_printf(("_cupsSNMPOpen: Returning -1 (%s)\n", strerror(errno
)));
390 DEBUG_printf(("_cupsSNMPOpen: Returning %d\n", fd
));
397 * '_cupsSNMPRead()' - Read and parse a SNMP response.
399 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
405 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
406 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
407 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
408 double timeout
) /* I - Timeout in seconds */
410 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
412 int bytes
; /* Number of bytes received */
413 socklen_t addrlen
; /* Source address length */
414 http_addr_t address
; /* Source address */
418 * Range check input...
421 DEBUG_printf(("_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)\n", fd
, packet
,
424 if (fd
< 0 || !packet
)
426 DEBUG_puts("_cupsSNMPRead: Returning NULL");
432 * Optionally wait for a response...
437 int ready
; /* Data ready on socket? */
439 struct pollfd pfd
; /* Polled file descriptor */
444 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
448 fd_set input_set
; /* select() input set */
449 struct timeval stimeout
; /* select() timeout */
454 FD_SET(fd
, &input_set
);
456 stimeout
.tv_sec
= (int)timeout
;
457 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_usec
) * 1000000);
459 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
462 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
464 while (ready
< 0 && errno
== EINTR
);
466 #endif /* HAVE_POLL */
469 * If we don't have any data ready, return right away...
474 DEBUG_puts("_cupsSNMPRead: Returning NULL (timeout)");
481 * Read the response data...
484 addrlen
= sizeof(address
);
486 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
489 DEBUG_printf(("_cupsSNMPRead: Returning NULL (%s)\n", strerror(errno
)));
495 * Look for the response status code in the SNMP message header...
498 asn1_debug("DEBUG: IN ", buffer
, bytes
, 0);
500 asn1_decode_snmp(buffer
, bytes
, packet
);
502 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
505 * Return decoded data packet...
508 DEBUG_puts("_cupsSNMPRead: Returning packet");
515 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
521 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
523 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
526 DEBUG_printf(("_cupsSNMPSetDebug(level=%d)\n", level
));
528 cg
->snmp_debug
= level
;
533 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
535 * This function converts a string of the form ".N.N.N.N.N" to the
536 * corresponding OID array terminated by -1.
538 * @code NULL@ is returned if the array is not large enough or the string is
539 * not a valid OID number.
544 int * /* O - Pointer to OID array or @code NULL@ on error */
545 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
546 int *dst
, /* I - OID array */
547 int dstsize
)/* I - Number of integers in OID array */
549 int *dstptr
, /* Pointer into OID array */
550 *dstend
; /* End of OID array */
553 DEBUG_printf(("_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)\n",
557 * Range check input...
560 if (!src
|| !dst
|| dstsize
< 2)
564 * Skip leading "."...
571 * Loop to the end of the string...
574 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
575 *src
&& dstptr
< dstend
;
583 else if (isdigit(*src
& 255))
584 *dstptr
= *dstptr
* 10 + *src
- '0';
593 * Terminate the end of the OID array and return...
603 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
605 * This function queries all of the OIDs with the specified OID prefix,
606 * calling the "cb" function for every response that is received.
608 * The array pointed to by "prefix" is terminated by the value -1.
610 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
616 int /* O - Number of OIDs found or -1 on error */
617 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
618 http_addr_t
*address
, /* I - Address to query */
619 int version
, /* I - SNMP version */
620 const char *community
,/* I - Community name */
621 const int *prefix
, /* I - OID prefix */
622 double timeout
, /* I - Timeout for each response in seconds */
623 cups_snmp_cb_t cb
, /* I - Function to call for each response */
624 void *data
) /* I - User data pointer that is passed to the callback function */
626 int count
= 0; /* Number of OIDs found */
627 int request_id
= 0; /* Current request ID */
628 cups_snmp_t packet
; /* Current response packet */
632 * Range check input...
635 DEBUG_printf(("_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
636 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)\n",
637 fd
, address
, version
, community
? community
: "(null)",
638 prefix
, timeout
, cb
, data
));
640 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
643 DEBUG_puts("_cupsSNMPWalk: Returning -1");
649 * Copy the OID prefix and then loop until we have no more OIDs...
652 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
658 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
659 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
662 DEBUG_puts("_cupsSNMPWalk: Returning -1");
667 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
669 DEBUG_puts("_cupsSNMPWalk: Returning -1");
674 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
))
676 DEBUG_printf(("_cupsSNMPWalk: Returning %d\n", count
));
681 if (packet
.error
|| packet
.error_status
)
683 DEBUG_printf(("_cupsSNMPWalk: Returning %d\n", count
> 0 ? count
: -1));
685 return (count
> 0 ? count
: -1);
690 (*cb
)(&packet
, data
);
696 * '_cupsSNMPWrite()' - Send an SNMP query packet.
698 * The array pointed to by "oid" is terminated by the value -1.
703 int /* O - 1 on success, 0 on error */
705 int fd
, /* I - SNMP socket */
706 http_addr_t
*address
, /* I - Address to send to */
707 int version
, /* I - SNMP version */
708 const char *community
, /* I - Community name */
709 cups_asn1_t request_type
, /* I - Request type */
710 const unsigned request_id
, /* I - Request ID */
711 const int *oid
) /* I - OID */
713 int i
; /* Looping var */
714 cups_snmp_t packet
; /* SNMP message packet */
715 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
716 /* SNMP message buffer */
717 int bytes
; /* Size of message */
721 * Range check input...
724 DEBUG_printf(("_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
725 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)\n",
726 fd
, address
, version
, community
? community
: "(null)",
727 request_type
, request_id
, oid
));
729 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
730 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
731 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
733 DEBUG_puts("_cupsSNMPWrite: Returning 0 (bad arguments)");
739 * Create the SNMP message...
742 memset(&packet
, 0, sizeof(packet
));
744 packet
.version
= version
;
745 packet
.request_type
= request_type
;
746 packet
.request_id
= request_id
;
747 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
749 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
751 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
752 packet
.object_name
[i
] = oid
[i
];
753 packet
.object_name
[i
] = -1;
757 DEBUG_puts("_cupsSNMPWrite: Returning 0 (OID too big)");
763 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
767 DEBUG_puts("_cupsSNMPWrite: Returning 0 (request too big)");
773 asn1_debug("DEBUG: OUT ", buffer
, bytes
, 0);
776 * Send the message...
780 if (address
->addr
.sa_family
== AF_INET6
)
781 address
->ipv6
.sin6_port
= htons(CUPS_SNMP_PORT
);
783 #endif /* AF_INET6 */
784 address
->ipv4
.sin_port
= htons(CUPS_SNMP_PORT
);
786 return (sendto(fd
, buffer
, bytes
, 0, (void *)address
,
787 httpAddrLength(address
)) == bytes
);
792 * 'asn1_debug()' - Decode an ASN1-encoded message.
796 asn1_debug(const char *prefix
, /* I - Prefix string */
797 unsigned char *buffer
, /* I - Buffer */
798 size_t len
, /* I - Length of buffer */
799 int indent
) /* I - Indentation */
801 int i
; /* Looping var */
802 unsigned char *bufend
; /* End of buffer */
803 int integer
; /* Number value */
804 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
805 char string
[CUPS_SNMP_MAX_STRING
];
807 unsigned char value_type
; /* Type of value */
808 int value_length
; /* Length of value */
809 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
812 if (cg
->snmp_debug
<= 0)
815 if (cg
->snmp_debug
> 1 && indent
== 0)
818 * Do a hex dump of the packet...
823 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
825 for (i
= 0; i
< len
; i
+= 16)
827 fprintf(stderr
, "%s%04x:", prefix
, i
);
829 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
832 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
834 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
849 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
850 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
853 putc(buffer
[i
+ j
], stderr
);
860 fprintf(stderr
, "%sMessage:\n", prefix
);
862 bufend
= buffer
+ len
;
864 while (buffer
< bufend
)
870 value_type
= asn1_get_type(&buffer
, bufend
);
871 value_length
= asn1_get_length(&buffer
, bufend
);
875 case CUPS_ASN1_BOOLEAN
:
876 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
878 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
879 value_length
, integer
);
882 case CUPS_ASN1_INTEGER
:
883 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
885 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
886 value_length
, integer
);
889 case CUPS_ASN1_COUNTER
:
890 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
892 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
893 value_length
, (unsigned)integer
);
896 case CUPS_ASN1_GAUGE
:
897 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
899 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
900 value_length
, (unsigned)integer
);
903 case CUPS_ASN1_TIMETICKS
:
904 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
906 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
907 value_length
, (unsigned)integer
);
910 case CUPS_ASN1_OCTET_STRING
:
911 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
912 indent
, "", value_length
,
913 asn1_get_string(&buffer
, bufend
, value_length
, string
,
917 case CUPS_ASN1_HEX_STRING
:
918 asn1_get_string(&buffer
, bufend
, value_length
, string
,
920 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
921 indent
, "", value_length
);
922 for (i
= 0; i
< value_length
; i
++)
923 fprintf(stderr
, " %02X", string
[i
] & 255);
927 case CUPS_ASN1_NULL_VALUE
:
928 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
931 buffer
+= value_length
;
935 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
938 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
940 for (i
= 0; i
< integer
; i
++)
941 fprintf(stderr
, ".%d", oid
[i
]);
945 case CUPS_ASN1_SEQUENCE
:
946 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
948 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
950 buffer
+= value_length
;
953 case CUPS_ASN1_GET_NEXT_REQUEST
:
954 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
955 indent
, "", value_length
);
956 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
958 buffer
+= value_length
;
961 case CUPS_ASN1_GET_REQUEST
:
962 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
964 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
966 buffer
+= value_length
;
969 case CUPS_ASN1_GET_RESPONSE
:
970 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
972 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
974 buffer
+= value_length
;
978 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
979 value_type
, value_length
);
981 buffer
+= value_length
;
989 * 'asn1_decode_snmp()' - Decode a SNMP packet.
992 static int /* O - 0 on success, -1 on error */
993 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
994 size_t len
, /* I - Size of buffer */
995 cups_snmp_t
*packet
) /* I - SNMP packet */
997 unsigned char *bufptr
, /* Pointer into the data */
998 *bufend
; /* End of data */
999 int length
; /* Length of value */
1003 * Initialize the decoding...
1006 memset(packet
, 0, sizeof(cups_snmp_t
));
1007 packet
->object_name
[0] = -1;
1010 bufend
= buffer
+ len
;
1012 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1013 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
1014 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1015 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
1016 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1017 snmp_set_error(packet
, _("No version number"));
1018 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1019 snmp_set_error(packet
, _("Version uses indefinite length"));
1020 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
1021 != CUPS_SNMP_VERSION_1
)
1022 snmp_set_error(packet
, _("Bad SNMP version number"));
1023 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
1024 snmp_set_error(packet
, _("No community name"));
1025 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1026 snmp_set_error(packet
, _("Community name uses indefinite length"));
1029 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
1030 sizeof(packet
->community
));
1032 if ((packet
->request_type
= asn1_get_type(&bufptr
, bufend
))
1033 != CUPS_ASN1_GET_RESPONSE
)
1034 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
1035 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1036 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
1037 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1038 snmp_set_error(packet
, _("No request-id"));
1039 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1040 snmp_set_error(packet
, _("request-id uses indefinite length"));
1043 packet
->request_id
= asn1_get_integer(&bufptr
, bufend
, length
);
1045 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1046 snmp_set_error(packet
, _("No error-status"));
1047 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1048 snmp_set_error(packet
, _("error-status uses indefinite length"));
1051 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
1053 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1054 snmp_set_error(packet
, _("No error-index"));
1055 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1056 snmp_set_error(packet
, _("error-index uses indefinite length"));
1059 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
1061 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1062 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
1063 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1064 snmp_set_error(packet
,
1065 _("variable-bindings uses indefinite length"));
1066 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1067 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
1068 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1069 snmp_set_error(packet
, _("VarBind uses indefinite length"));
1070 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1071 snmp_set_error(packet
, _("No name OID"));
1072 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1073 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1076 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1079 packet
->object_type
= asn1_get_type(&bufptr
, bufend
);
1081 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1082 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1083 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1084 snmp_set_error(packet
, _("Value uses indefinite length"));
1087 switch (packet
->object_type
)
1089 case CUPS_ASN1_BOOLEAN
:
1090 packet
->object_value
.boolean
=
1091 asn1_get_integer(&bufptr
, bufend
, length
);
1094 case CUPS_ASN1_INTEGER
:
1095 packet
->object_value
.integer
=
1096 asn1_get_integer(&bufptr
, bufend
, length
);
1099 case CUPS_ASN1_NULL_VALUE
:
1102 case CUPS_ASN1_OCTET_STRING
:
1103 asn1_get_string(&bufptr
, bufend
, length
,
1104 packet
->object_value
.string
,
1105 CUPS_SNMP_MAX_STRING
);
1108 case CUPS_ASN1_OID
:
1109 asn1_get_oid(&bufptr
, bufend
, length
,
1110 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1113 case CUPS_ASN1_HEX_STRING
:
1114 packet
->object_value
.hex_string
.num_bytes
= length
;
1116 asn1_get_string(&bufptr
, bufend
, length
,
1117 (char *)packet
->object_value
.hex_string
.bytes
,
1118 CUPS_SNMP_MAX_STRING
);
1121 case CUPS_ASN1_COUNTER
:
1122 packet
->object_value
.counter
=
1123 asn1_get_integer(&bufptr
, bufend
, length
);
1126 case CUPS_ASN1_GAUGE
:
1127 packet
->object_value
.gauge
=
1128 asn1_get_integer(&bufptr
, bufend
, length
);
1131 case CUPS_ASN1_TIMETICKS
:
1132 packet
->object_value
.timeticks
=
1133 asn1_get_integer(&bufptr
, bufend
, length
);
1137 snmp_set_error(packet
, _("Unsupported value type"));
1147 return (packet
->error
? -1 : 0);
1152 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1155 static int /* O - Length on success, -1 on error */
1156 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1157 size_t bufsize
, /* I - Size of buffer */
1158 cups_snmp_t
*packet
) /* I - SNMP packet */
1160 unsigned char *bufptr
; /* Pointer into buffer */
1161 int total
, /* Total length */
1162 msglen
, /* Length of entire message */
1163 commlen
, /* Length of community string */
1164 reqlen
, /* Length of request */
1165 listlen
, /* Length of variable list */
1166 varlen
, /* Length of variable */
1167 namelen
, /* Length of object name OID */
1168 valuelen
; /* Length of object value */
1172 * Get the lengths of the community string, OID, and message...
1176 namelen
= asn1_size_oid(packet
->object_name
);
1178 switch (packet
->object_type
)
1180 case CUPS_ASN1_NULL_VALUE
:
1184 case CUPS_ASN1_BOOLEAN
:
1185 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1188 case CUPS_ASN1_INTEGER
:
1189 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1192 case CUPS_ASN1_OCTET_STRING
:
1193 valuelen
= strlen(packet
->object_value
.string
);
1196 case CUPS_ASN1_OID
:
1197 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1201 packet
->error
= "Unknown object type";
1205 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1206 1 + asn1_size_length(valuelen
) + valuelen
;
1207 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1208 reqlen
= 2 + asn1_size_integer(packet
->request_id
) +
1209 2 + asn1_size_integer(packet
->error_status
) +
1210 2 + asn1_size_integer(packet
->error_index
) +
1211 1 + asn1_size_length(listlen
) + listlen
;
1212 commlen
= strlen(packet
->community
);
1213 msglen
= 2 + asn1_size_integer(packet
->version
) +
1214 1 + asn1_size_length(commlen
) + commlen
+
1215 1 + asn1_size_length(reqlen
) + reqlen
;
1216 total
= 1 + asn1_size_length(msglen
) + msglen
;
1218 if (total
> bufsize
)
1220 packet
->error
= "Message too large for buffer";
1225 * Then format the message...
1230 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1231 asn1_set_length(&bufptr
, msglen
);
1233 asn1_set_integer(&bufptr
, packet
->version
);
1236 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1237 asn1_set_length(&bufptr
, commlen
);
1238 memcpy(bufptr
, packet
->community
, commlen
);
1241 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1242 asn1_set_length(&bufptr
, reqlen
);
1244 asn1_set_integer(&bufptr
, packet
->request_id
);
1246 asn1_set_integer(&bufptr
, packet
->error_status
);
1248 asn1_set_integer(&bufptr
, packet
->error_index
);
1250 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1251 asn1_set_length(&bufptr
, listlen
);
1253 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1254 asn1_set_length(&bufptr
, varlen
);
1256 asn1_set_oid(&bufptr
, packet
->object_name
);
1259 switch (packet
->object_type
)
1261 case CUPS_ASN1_NULL_VALUE
:
1262 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1264 *bufptr
++ = 0; /* Length */
1267 case CUPS_ASN1_BOOLEAN
:
1268 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1271 case CUPS_ASN1_INTEGER
:
1272 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1275 case CUPS_ASN1_OCTET_STRING
:
1276 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1277 asn1_set_length(&bufptr
, valuelen
);
1278 memcpy(bufptr
, packet
->object_value
.string
, valuelen
);
1282 case CUPS_ASN1_OID
:
1283 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1290 return (bufptr
- buffer
);
1295 * 'asn1_get_integer()' - Get an integer value.
1298 static int /* O - Integer value */
1300 unsigned char **buffer
, /* IO - Pointer in buffer */
1301 unsigned char *bufend
, /* I - End of buffer */
1302 int length
) /* I - Length of value */
1304 int value
; /* Integer value */
1308 length
> 0 && *buffer
< bufend
;
1309 length
--, (*buffer
) ++)
1310 value
= (value
<< 8) | **buffer
;
1317 * 'asn1_get_length()' - Get a value length.
1320 static int /* O - Length */
1321 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1322 unsigned char *bufend
) /* I - End of buffer */
1324 int length
; /* Length */
1331 length
= asn1_get_integer(buffer
, bufend
, length
& 127);
1338 * 'asn1_get_oid()' - Get an OID value.
1341 static int /* O - Number of OIDs */
1343 unsigned char **buffer
, /* IO - Pointer in buffer */
1344 unsigned char *bufend
, /* I - End of buffer */
1345 int length
, /* I - Length of value */
1346 int *oid
, /* I - OID buffer */
1347 int oidsize
) /* I - Size of OID buffer */
1349 unsigned char *valend
; /* End of value */
1350 int *oidptr
, /* Current OID */
1351 *oidend
; /* End of OID buffer */
1352 int number
; /* OID number */
1355 valend
= *buffer
+ length
;
1357 oidend
= oid
+ oidsize
- 1;
1359 if (valend
> bufend
)
1362 number
= asn1_get_packed(buffer
, bufend
);
1366 *oidptr
++ = number
/ 40;
1367 number
= number
% 40;
1377 while (*buffer
< valend
)
1379 number
= asn1_get_packed(buffer
, bufend
);
1381 if (oidptr
< oidend
)
1387 return (oidptr
- oid
);
1392 * 'asn1_get_packed()' - Get a packed integer value.
1395 static int /* O - Value */
1397 unsigned char **buffer
, /* IO - Pointer in buffer */
1398 unsigned char *bufend
) /* I - End of buffer */
1400 int value
; /* Value */
1405 while ((**buffer
& 128) && *buffer
< bufend
)
1407 value
= (value
<< 7) | (**buffer
& 127);
1411 if (*buffer
< bufend
)
1413 value
= (value
<< 7) | **buffer
;
1422 * 'asn1_get_string()' - Get a string value.
1425 static char * /* O - String */
1427 unsigned char **buffer
, /* IO - Pointer in buffer */
1428 unsigned char *bufend
, /* I - End of buffer */
1429 int length
, /* I - Value length */
1430 char *string
, /* I - String buffer */
1431 int strsize
) /* I - String buffer size */
1436 * Disallow negative lengths!
1441 else if (length
< strsize
)
1444 * String is smaller than the buffer...
1448 memcpy(string
, *buffer
, length
);
1450 string
[length
] = '\0';
1455 * String is larger than the buffer...
1458 memcpy(string
, *buffer
, strsize
- 1);
1459 string
[strsize
- 1] = '\0';
1463 (*buffer
) += length
;
1465 return (length
< 0 ? NULL
: string
);
1470 * 'asn1_get_type()' - Get a value type.
1473 static int /* O - Type */
1474 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1475 unsigned char *bufend
) /* I - End of buffer */
1477 int type
; /* Type */
1483 if ((type
& 31) == 31)
1484 type
= asn1_get_packed(buffer
, bufend
);
1491 * 'asn1_set_integer()' - Set an integer value.
1495 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1496 int integer
) /* I - Integer value */
1498 **buffer
= CUPS_ASN1_INTEGER
;
1501 if (integer
> 0x7fffff || integer
< -0x800000)
1505 **buffer
= integer
>> 24;
1507 **buffer
= integer
>> 16;
1509 **buffer
= integer
>> 8;
1514 else if (integer
> 0x7fff || integer
< -0x8000)
1518 **buffer
= integer
>> 16;
1520 **buffer
= integer
>> 8;
1525 else if (integer
> 0x7f || integer
< -0x80)
1529 **buffer
= integer
>> 8;
1545 * 'asn1_set_length()' - Set a value length.
1549 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1550 int length
) /* I - Length value */
1554 **buffer
= 0x82; /* 2-byte length */
1556 **buffer
= length
>> 8;
1561 else if (length
> 127)
1563 **buffer
= 0x81; /* 1-byte length */
1570 **buffer
= length
; /* Length */
1577 * 'asn1_set_oid()' - Set an OID value.
1581 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1582 const int *oid
) /* I - OID value */
1584 **buffer
= CUPS_ASN1_OID
;
1587 asn1_set_length(buffer
, asn1_size_oid(oid
));
1591 asn1_set_packed(buffer
, oid
[0] * 40);
1595 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1597 for (oid
+= 2; *oid
>= 0; oid
++)
1598 asn1_set_packed(buffer
, *oid
);
1603 * 'asn1_set_packed()' - Set a packed integer value.
1607 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1608 int integer
) /* I - Integer value */
1610 if (integer
> 0xfffffff)
1612 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1616 if (integer
> 0x1fffff)
1618 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1622 if (integer
> 0x3fff)
1624 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1630 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1634 **buffer
= integer
& 0x7f;
1640 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1644 static int /* O - Size in bytes */
1645 asn1_size_integer(int integer
) /* I - Integer value */
1647 if (integer
> 0x7fffff || integer
< -0x800000)
1649 else if (integer
> 0x7fff || integer
< -0x8000)
1651 else if (integer
> 0x7f || integer
< -0x80)
1659 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1663 static int /* O - Size in bytes */
1664 asn1_size_length(int length
) /* I - Length value */
1668 else if (length
> 0x7f)
1676 * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
1680 static int /* O - Size in bytes */
1681 asn1_size_oid(const int *oid
) /* I - OID value */
1683 int length
; /* Length of value */
1687 return (asn1_size_packed(oid
[0] * 40));
1689 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1692 length
+= asn1_size_packed(*oid
);
1699 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1700 * packed integer value.
1703 static int /* O - Size in bytes */
1704 asn1_size_packed(int integer
) /* I - Integer value */
1706 if (integer
> 0xfffffff)
1708 else if (integer
> 0x1fffff)
1710 else if (integer
> 0x3fff)
1712 else if (integer
> 0x7f)
1720 * 'snmp_set_error()' - Set the localized error for a packet.
1724 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1725 const char *message
) /* I - Error message */
1727 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1730 if (!cg
->lang_default
)
1731 cg
->lang_default
= cupsLangDefault();
1733 packet
->error
= _cupsLangString(cg
->lang_default
, message
);