4 * SNMP functions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2010 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 unsigned 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.
117 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
119 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd
));
130 * '_cupsSNMPCopyOID()' - Copy an OID.
132 * The array pointed to by "src" is terminated by the value -1.
135 int * /* O - New OID */
136 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
137 const int *src
, /* I - Source OID */
138 int dstsize
) /* I - Number of integers in dst */
140 int i
; /* Looping var */
143 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst
, src
,
146 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
156 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
158 * The default community name is the first community name found in the
159 * snmp.conf file. If no community name is defined there, "public" is used.
162 const char * /* O - Default community name */
163 _cupsSNMPDefaultCommunity(void)
165 cups_file_t
*fp
; /* snmp.conf file */
166 char line
[1024], /* Line from file */
167 *value
; /* Value from file */
168 int linenum
; /* Line number in file */
169 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
172 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
174 if (!cg
->snmp_community
[0])
176 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
178 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
179 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
182 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
183 if (!strcasecmp(line
, "Community") && value
)
185 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
193 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
194 cg
->snmp_community
));
196 return (cg
->snmp_community
);
201 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
203 * The array pointed to by "oid" is terminated by the value -1.
206 int /* O - 1 if equal, 0 if not equal */
207 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
208 const int *oid
) /* I - OID */
210 int i
; /* Looping var */
214 * Range check input...
217 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet
, oid
));
221 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
231 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
233 if (oid
[i
] != packet
->object_name
[i
])
235 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
240 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
241 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
243 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
248 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
251 * The array pointed to by "prefix" is terminated by the value -1.
254 int /* O - 1 if prefixed, 0 if not prefixed */
255 _cupsSNMPIsOIDPrefixed(
256 cups_snmp_t
*packet
, /* I - Response packet */
257 const int *prefix
) /* I - OID prefix */
259 int i
; /* Looping var */
263 * Range check input...
266 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet
,
269 if (!packet
|| !prefix
)
271 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
281 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
283 if (prefix
[i
] != packet
->object_name
[i
])
285 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
290 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
291 i
< CUPS_SNMP_MAX_OID
));
293 return (i
< CUPS_SNMP_MAX_OID
);
298 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
302 char * /* O - New string or @code NULL@ on error */
303 _cupsSNMPOIDToString(const int *src
, /* I - OID */
304 char *dst
, /* I - String buffer */
305 size_t dstsize
) /* I - Size of string buffer */
307 char *dstptr
, /* Pointer into string buffer */
308 *dstend
; /* End of string buffer */
311 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")",
312 src
, dst
, CUPS_LLCAST dstsize
));
315 * Range check input...
318 if (!src
|| !dst
|| dstsize
< 4)
322 * Loop through the OID array and build a string...
325 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
326 *src
>= 0 && dstptr
< dstend
;
327 src
++, dstptr
+= strlen(dstptr
))
328 snprintf(dstptr
, dstend
- dstptr
+ 1, ".%d", *src
);
338 * '_cupsSNMPOpen()' - Open a SNMP socket.
341 int /* O - SNMP socket file descriptor */
342 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
344 int fd
; /* SNMP socket file descriptor */
345 int val
; /* Socket option value */
349 * Create the SNMP socket...
352 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family
));
354 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
356 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
362 * Set the "broadcast" flag...
368 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, (char *)&val
, sizeof(val
)))
370 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, &val
, sizeof(val
)))
373 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
380 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd
));
387 * '_cupsSNMPRead()' - Read and parse a SNMP response.
389 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
393 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
394 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
395 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
396 double timeout
) /* I - Timeout in seconds */
398 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
400 int bytes
; /* Number of bytes received */
401 socklen_t addrlen
; /* Source address length */
402 http_addr_t address
; /* Source address */
406 * Range check input...
409 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd
, packet
,
412 if (fd
< 0 || !packet
)
414 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
420 * Optionally wait for a response...
425 int ready
; /* Data ready on socket? */
427 struct pollfd pfd
; /* Polled file descriptor */
432 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
433 (errno
== EINTR
|| errno
== EAGAIN
));
436 fd_set input_set
; /* select() input set */
437 struct timeval stimeout
; /* select() timeout */
442 FD_SET(fd
, &input_set
);
444 stimeout
.tv_sec
= (int)timeout
;
445 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_sec
) * 1000000);
447 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
450 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
452 while (ready
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
454 #endif /* HAVE_POLL */
457 * If we don't have any data ready, return right away...
462 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
469 * Read the response data...
472 addrlen
= sizeof(address
);
474 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
477 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno
)));
483 * Look for the response status code in the SNMP message header...
486 asn1_debug("DEBUG: IN ", buffer
, bytes
, 0);
488 asn1_decode_snmp(buffer
, bytes
, packet
);
490 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
493 * Return decoded data packet...
496 DEBUG_puts("5_cupsSNMPRead: Returning packet");
503 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
507 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
509 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
512 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level
));
514 cg
->snmp_debug
= level
;
519 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
521 * This function converts a string of the form ".N.N.N.N.N" to the
522 * corresponding OID array terminated by -1.
524 * @code NULL@ is returned if the array is not large enough or the string is
525 * not a valid OID number.
528 int * /* O - Pointer to OID array or @code NULL@ on error */
529 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
530 int *dst
, /* I - OID array */
531 int dstsize
)/* I - Number of integers in OID array */
533 int *dstptr
, /* Pointer into OID array */
534 *dstend
; /* End of OID array */
537 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
541 * Range check input...
544 if (!src
|| !dst
|| dstsize
< 2)
548 * Skip leading "."...
555 * Loop to the end of the string...
558 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
559 *src
&& dstptr
< dstend
;
567 else if (isdigit(*src
& 255))
568 *dstptr
= *dstptr
* 10 + *src
- '0';
577 * Terminate the end of the OID array and return...
587 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
589 * This function queries all of the OIDs with the specified OID prefix,
590 * calling the "cb" function for every response that is received.
592 * The array pointed to by "prefix" is terminated by the value -1.
594 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
598 int /* O - Number of OIDs found or -1 on error */
599 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
600 http_addr_t
*address
, /* I - Address to query */
601 int version
, /* I - SNMP version */
602 const char *community
,/* I - Community name */
603 const int *prefix
, /* I - OID prefix */
604 double timeout
, /* I - Timeout for each response in seconds */
605 cups_snmp_cb_t cb
, /* I - Function to call for each response */
606 void *data
) /* I - User data pointer that is passed to the callback function */
608 int count
= 0; /* Number of OIDs found */
609 int request_id
= 0; /* Current request ID */
610 cups_snmp_t packet
; /* Current response packet */
611 int lastoid
[CUPS_SNMP_MAX_OID
];
612 /* Last OID we got */
616 * Range check input...
619 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
620 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
621 fd
, address
, version
, community
, prefix
, timeout
, cb
, data
));
623 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
626 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
632 * Copy the OID prefix and then loop until we have no more OIDs...
635 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
642 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
643 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
646 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
651 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
653 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
658 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
) ||
659 _cupsSNMPIsOID(&packet
, lastoid
))
661 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
));
666 if (packet
.error
|| packet
.error_status
)
668 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
> 0 ? count
: -1));
670 return (count
> 0 ? count
: -1);
673 _cupsSNMPCopyOID(lastoid
, packet
.object_name
, CUPS_SNMP_MAX_OID
);
677 (*cb
)(&packet
, data
);
683 * '_cupsSNMPWrite()' - Send an SNMP query packet.
685 * The array pointed to by "oid" is terminated by the value -1.
688 int /* O - 1 on success, 0 on error */
690 int fd
, /* I - SNMP socket */
691 http_addr_t
*address
, /* I - Address to send to */
692 int version
, /* I - SNMP version */
693 const char *community
, /* I - Community name */
694 cups_asn1_t request_type
, /* I - Request type */
695 const unsigned request_id
, /* I - Request ID */
696 const int *oid
) /* I - OID */
698 int i
; /* Looping var */
699 cups_snmp_t packet
; /* SNMP message packet */
700 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
701 /* SNMP message buffer */
702 int bytes
; /* Size of message */
703 http_addr_t temp
; /* Copy of address */
707 * Range check input...
710 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
711 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
712 fd
, address
, version
, community
, request_type
, request_id
, oid
));
714 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
715 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
716 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
718 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
724 * Create the SNMP message...
727 memset(&packet
, 0, sizeof(packet
));
729 packet
.version
= version
;
730 packet
.request_type
= request_type
;
731 packet
.request_id
= request_id
;
732 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
734 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
736 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
737 packet
.object_name
[i
] = oid
[i
];
738 packet
.object_name
[i
] = -1;
742 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
748 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
752 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
758 asn1_debug("DEBUG: OUT ", buffer
, bytes
, 0);
761 * Send the message...
767 if (temp
.addr
.sa_family
== AF_INET6
)
768 temp
.ipv6
.sin6_port
= htons(CUPS_SNMP_PORT
);
770 #endif /* AF_INET6 */
771 temp
.ipv4
.sin_port
= htons(CUPS_SNMP_PORT
);
773 return (sendto(fd
, buffer
, bytes
, 0, (void *)&temp
,
774 httpAddrLength(&temp
)) == bytes
);
779 * 'asn1_debug()' - Decode an ASN1-encoded message.
783 asn1_debug(const char *prefix
, /* I - Prefix string */
784 unsigned char *buffer
, /* I - Buffer */
785 size_t len
, /* I - Length of buffer */
786 int indent
) /* I - Indentation */
788 int i
; /* Looping var */
789 unsigned char *bufend
; /* End of buffer */
790 int integer
; /* Number value */
791 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
792 char string
[CUPS_SNMP_MAX_STRING
];
794 unsigned char value_type
; /* Type of value */
795 int value_length
; /* Length of value */
796 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
799 if (cg
->snmp_debug
<= 0)
802 if (cg
->snmp_debug
> 1 && indent
== 0)
805 * Do a hex dump of the packet...
810 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
812 for (i
= 0; i
< (int)len
; i
+= 16)
814 fprintf(stderr
, "%s%04x:", prefix
, i
);
816 for (j
= 0; j
< 16 && (i
+ j
) < (int)len
; j
++)
819 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
821 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
836 for (j
= 0; j
< 16 && (i
+ j
) < (int)len
; j
++)
837 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
840 putc(buffer
[i
+ j
], stderr
);
847 fprintf(stderr
, "%sMessage:\n", prefix
);
849 bufend
= buffer
+ len
;
851 while (buffer
< bufend
)
857 value_type
= asn1_get_type(&buffer
, bufend
);
858 value_length
= asn1_get_length(&buffer
, bufend
);
862 case CUPS_ASN1_BOOLEAN
:
863 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
865 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
866 value_length
, integer
);
869 case CUPS_ASN1_INTEGER
:
870 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
872 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
873 value_length
, integer
);
876 case CUPS_ASN1_COUNTER
:
877 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
879 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
880 value_length
, (unsigned)integer
);
883 case CUPS_ASN1_GAUGE
:
884 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
886 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
887 value_length
, (unsigned)integer
);
890 case CUPS_ASN1_TIMETICKS
:
891 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
893 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
894 value_length
, (unsigned)integer
);
897 case CUPS_ASN1_OCTET_STRING
:
898 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
899 indent
, "", value_length
,
900 asn1_get_string(&buffer
, bufend
, value_length
, string
,
904 case CUPS_ASN1_HEX_STRING
:
905 asn1_get_string(&buffer
, bufend
, value_length
, string
,
907 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
908 indent
, "", value_length
);
909 for (i
= 0; i
< value_length
; i
++)
910 fprintf(stderr
, " %02X", string
[i
] & 255);
914 case CUPS_ASN1_NULL_VALUE
:
915 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
918 buffer
+= value_length
;
922 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
925 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
927 for (i
= 0; i
< integer
; i
++)
928 fprintf(stderr
, ".%d", oid
[i
]);
932 case CUPS_ASN1_SEQUENCE
:
933 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
935 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
937 buffer
+= value_length
;
940 case CUPS_ASN1_GET_NEXT_REQUEST
:
941 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
942 indent
, "", value_length
);
943 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
945 buffer
+= value_length
;
948 case CUPS_ASN1_GET_REQUEST
:
949 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
951 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
953 buffer
+= value_length
;
956 case CUPS_ASN1_GET_RESPONSE
:
957 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
959 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
961 buffer
+= value_length
;
965 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
966 value_type
, value_length
);
968 buffer
+= value_length
;
976 * 'asn1_decode_snmp()' - Decode a SNMP packet.
979 static int /* O - 0 on success, -1 on error */
980 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
981 size_t len
, /* I - Size of buffer */
982 cups_snmp_t
*packet
) /* I - SNMP packet */
984 unsigned char *bufptr
, /* Pointer into the data */
985 *bufend
; /* End of data */
986 int length
; /* Length of value */
990 * Initialize the decoding...
993 memset(packet
, 0, sizeof(cups_snmp_t
));
994 packet
->object_name
[0] = -1;
997 bufend
= buffer
+ len
;
999 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1000 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
1001 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1002 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
1003 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1004 snmp_set_error(packet
, _("No version number"));
1005 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1006 snmp_set_error(packet
, _("Version uses indefinite length"));
1007 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
1008 != CUPS_SNMP_VERSION_1
)
1009 snmp_set_error(packet
, _("Bad SNMP version number"));
1010 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
1011 snmp_set_error(packet
, _("No community name"));
1012 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1013 snmp_set_error(packet
, _("Community name uses indefinite length"));
1016 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
1017 sizeof(packet
->community
));
1019 if ((packet
->request_type
= asn1_get_type(&bufptr
, bufend
))
1020 != CUPS_ASN1_GET_RESPONSE
)
1021 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
1022 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1023 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
1024 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1025 snmp_set_error(packet
, _("No request-id"));
1026 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1027 snmp_set_error(packet
, _("request-id uses indefinite length"));
1030 packet
->request_id
= asn1_get_integer(&bufptr
, bufend
, length
);
1032 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1033 snmp_set_error(packet
, _("No error-status"));
1034 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1035 snmp_set_error(packet
, _("error-status uses indefinite length"));
1038 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
1040 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
1041 snmp_set_error(packet
, _("No error-index"));
1042 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1043 snmp_set_error(packet
, _("error-index uses indefinite length"));
1046 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
1048 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1049 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
1050 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1051 snmp_set_error(packet
,
1052 _("variable-bindings uses indefinite length"));
1053 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1054 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
1055 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1056 snmp_set_error(packet
, _("VarBind uses indefinite length"));
1057 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1058 snmp_set_error(packet
, _("No name OID"));
1059 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1060 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1063 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1066 packet
->object_type
= asn1_get_type(&bufptr
, bufend
);
1068 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1069 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1070 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1071 snmp_set_error(packet
, _("Value uses indefinite length"));
1074 switch (packet
->object_type
)
1076 case CUPS_ASN1_BOOLEAN
:
1077 packet
->object_value
.boolean
=
1078 asn1_get_integer(&bufptr
, bufend
, length
);
1081 case CUPS_ASN1_INTEGER
:
1082 packet
->object_value
.integer
=
1083 asn1_get_integer(&bufptr
, bufend
, length
);
1086 case CUPS_ASN1_NULL_VALUE
:
1089 case CUPS_ASN1_OCTET_STRING
:
1090 case CUPS_ASN1_BIT_STRING
:
1091 case CUPS_ASN1_HEX_STRING
:
1092 packet
->object_value
.string
.num_bytes
= length
;
1093 asn1_get_string(&bufptr
, bufend
, length
,
1094 (char *)packet
->object_value
.string
.bytes
,
1095 CUPS_SNMP_MAX_STRING
);
1098 case CUPS_ASN1_OID
:
1099 asn1_get_oid(&bufptr
, bufend
, length
,
1100 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1103 case CUPS_ASN1_COUNTER
:
1104 packet
->object_value
.counter
=
1105 asn1_get_integer(&bufptr
, bufend
, length
);
1108 case CUPS_ASN1_GAUGE
:
1109 packet
->object_value
.gauge
=
1110 asn1_get_integer(&bufptr
, bufend
, length
);
1113 case CUPS_ASN1_TIMETICKS
:
1114 packet
->object_value
.timeticks
=
1115 asn1_get_integer(&bufptr
, bufend
, length
);
1119 snmp_set_error(packet
, _("Unsupported value type"));
1129 return (packet
->error
? -1 : 0);
1134 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1137 static int /* O - Length on success, -1 on error */
1138 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1139 size_t bufsize
, /* I - Size of buffer */
1140 cups_snmp_t
*packet
) /* I - SNMP packet */
1142 unsigned char *bufptr
; /* Pointer into buffer */
1143 int total
, /* Total length */
1144 msglen
, /* Length of entire message */
1145 commlen
, /* Length of community string */
1146 reqlen
, /* Length of request */
1147 listlen
, /* Length of variable list */
1148 varlen
, /* Length of variable */
1149 namelen
, /* Length of object name OID */
1150 valuelen
; /* Length of object value */
1154 * Get the lengths of the community string, OID, and message...
1158 namelen
= asn1_size_oid(packet
->object_name
);
1160 switch (packet
->object_type
)
1162 case CUPS_ASN1_NULL_VALUE
:
1166 case CUPS_ASN1_BOOLEAN
:
1167 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1170 case CUPS_ASN1_INTEGER
:
1171 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1174 case CUPS_ASN1_OCTET_STRING
:
1175 valuelen
= packet
->object_value
.string
.num_bytes
;
1178 case CUPS_ASN1_OID
:
1179 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1183 packet
->error
= "Unknown object type";
1187 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1188 1 + asn1_size_length(valuelen
) + valuelen
;
1189 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1190 reqlen
= 2 + asn1_size_integer(packet
->request_id
) +
1191 2 + asn1_size_integer(packet
->error_status
) +
1192 2 + asn1_size_integer(packet
->error_index
) +
1193 1 + asn1_size_length(listlen
) + listlen
;
1194 commlen
= strlen(packet
->community
);
1195 msglen
= 2 + asn1_size_integer(packet
->version
) +
1196 1 + asn1_size_length(commlen
) + commlen
+
1197 1 + asn1_size_length(reqlen
) + reqlen
;
1198 total
= 1 + asn1_size_length(msglen
) + msglen
;
1200 if (total
> (int)bufsize
)
1202 packet
->error
= "Message too large for buffer";
1207 * Then format the message...
1212 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1213 asn1_set_length(&bufptr
, msglen
);
1215 asn1_set_integer(&bufptr
, packet
->version
);
1218 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1219 asn1_set_length(&bufptr
, commlen
);
1220 memcpy(bufptr
, packet
->community
, commlen
);
1223 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1224 asn1_set_length(&bufptr
, reqlen
);
1226 asn1_set_integer(&bufptr
, packet
->request_id
);
1228 asn1_set_integer(&bufptr
, packet
->error_status
);
1230 asn1_set_integer(&bufptr
, packet
->error_index
);
1232 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1233 asn1_set_length(&bufptr
, listlen
);
1235 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1236 asn1_set_length(&bufptr
, varlen
);
1238 asn1_set_oid(&bufptr
, packet
->object_name
);
1241 switch (packet
->object_type
)
1243 case CUPS_ASN1_NULL_VALUE
:
1244 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1246 *bufptr
++ = 0; /* Length */
1249 case CUPS_ASN1_BOOLEAN
:
1250 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1253 case CUPS_ASN1_INTEGER
:
1254 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1257 case CUPS_ASN1_OCTET_STRING
:
1258 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1259 asn1_set_length(&bufptr
, valuelen
);
1260 memcpy(bufptr
, packet
->object_value
.string
.bytes
, valuelen
);
1264 case CUPS_ASN1_OID
:
1265 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1272 return (bufptr
- buffer
);
1277 * 'asn1_get_integer()' - Get an integer value.
1280 static int /* O - Integer value */
1282 unsigned char **buffer
, /* IO - Pointer in buffer */
1283 unsigned char *bufend
, /* I - End of buffer */
1284 int length
) /* I - Length of value */
1286 int value
; /* Integer value */
1289 if (length
> sizeof(int))
1291 (*buffer
) += length
;
1295 for (value
= (**buffer
& 0x80) ? -1 : 0;
1296 length
> 0 && *buffer
< bufend
;
1297 length
--, (*buffer
) ++)
1298 value
= (value
<< 8) | **buffer
;
1305 * 'asn1_get_length()' - Get a value length.
1308 static unsigned /* O - Length */
1309 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1310 unsigned char *bufend
) /* I - End of buffer */
1312 unsigned length
; /* Length */
1320 int count
; /* Number of bytes for length */
1323 if ((count
= length
& 127) > sizeof(unsigned))
1330 count
> 0 && *buffer
< bufend
;
1331 count
--, (*buffer
) ++)
1332 length
= (length
<< 8) | **buffer
;
1340 * 'asn1_get_oid()' - Get an OID value.
1343 static int /* O - Number of OIDs */
1345 unsigned char **buffer
, /* IO - Pointer in buffer */
1346 unsigned char *bufend
, /* I - End of buffer */
1347 int length
, /* I - Length of value */
1348 int *oid
, /* I - OID buffer */
1349 int oidsize
) /* I - Size of OID buffer */
1351 unsigned char *valend
; /* End of value */
1352 int *oidptr
, /* Current OID */
1353 *oidend
; /* End of OID buffer */
1354 int number
; /* OID number */
1357 valend
= *buffer
+ length
;
1359 oidend
= oid
+ oidsize
- 1;
1361 if (valend
> bufend
)
1364 number
= asn1_get_packed(buffer
, bufend
);
1368 *oidptr
++ = number
/ 40;
1369 number
= number
% 40;
1379 while (*buffer
< valend
)
1381 number
= asn1_get_packed(buffer
, bufend
);
1383 if (oidptr
< oidend
)
1389 return (oidptr
- oid
);
1394 * 'asn1_get_packed()' - Get a packed integer value.
1397 static int /* O - Value */
1399 unsigned char **buffer
, /* IO - Pointer in buffer */
1400 unsigned char *bufend
) /* I - End of buffer */
1402 int value
; /* Value */
1407 while ((**buffer
& 128) && *buffer
< bufend
)
1409 value
= (value
<< 7) | (**buffer
& 127);
1413 if (*buffer
< bufend
)
1415 value
= (value
<< 7) | **buffer
;
1424 * 'asn1_get_string()' - Get a string value.
1427 static char * /* O - String */
1429 unsigned char **buffer
, /* IO - Pointer in buffer */
1430 unsigned char *bufend
, /* I - End of buffer */
1431 int length
, /* I - Value length */
1432 char *string
, /* I - String buffer */
1433 int strsize
) /* I - String buffer size */
1438 * Disallow negative lengths!
1443 else if (length
< strsize
)
1446 * String is smaller than the buffer...
1450 memcpy(string
, *buffer
, length
);
1452 string
[length
] = '\0';
1457 * String is larger than the buffer...
1460 memcpy(string
, *buffer
, strsize
- 1);
1461 string
[strsize
- 1] = '\0';
1465 (*buffer
) += length
;
1467 return (length
< 0 ? NULL
: string
);
1472 * 'asn1_get_type()' - Get a value type.
1475 static int /* O - Type */
1476 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1477 unsigned char *bufend
) /* I - End of buffer */
1479 int type
; /* Type */
1485 if ((type
& 31) == 31)
1486 type
= asn1_get_packed(buffer
, bufend
);
1493 * 'asn1_set_integer()' - Set an integer value.
1497 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1498 int integer
) /* I - Integer value */
1500 **buffer
= CUPS_ASN1_INTEGER
;
1503 if (integer
> 0x7fffff || integer
< -0x800000)
1507 **buffer
= integer
>> 24;
1509 **buffer
= integer
>> 16;
1511 **buffer
= integer
>> 8;
1516 else if (integer
> 0x7fff || integer
< -0x8000)
1520 **buffer
= integer
>> 16;
1522 **buffer
= integer
>> 8;
1527 else if (integer
> 0x7f || integer
< -0x80)
1531 **buffer
= integer
>> 8;
1547 * 'asn1_set_length()' - Set a value length.
1551 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1552 unsigned length
) /* I - Length value */
1556 **buffer
= 0x82; /* 2-byte length */
1558 **buffer
= length
>> 8;
1563 else if (length
> 127)
1565 **buffer
= 0x81; /* 1-byte length */
1572 **buffer
= length
; /* Length */
1579 * 'asn1_set_oid()' - Set an OID value.
1583 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1584 const int *oid
) /* I - OID value */
1586 **buffer
= CUPS_ASN1_OID
;
1589 asn1_set_length(buffer
, asn1_size_oid(oid
));
1593 asn1_set_packed(buffer
, oid
[0] * 40);
1597 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1599 for (oid
+= 2; *oid
>= 0; oid
++)
1600 asn1_set_packed(buffer
, *oid
);
1605 * 'asn1_set_packed()' - Set a packed integer value.
1609 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1610 int integer
) /* I - Integer value */
1612 if (integer
> 0xfffffff)
1614 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1618 if (integer
> 0x1fffff)
1620 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1624 if (integer
> 0x3fff)
1626 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1632 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1636 **buffer
= integer
& 0x7f;
1642 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1646 static int /* O - Size in bytes */
1647 asn1_size_integer(int integer
) /* I - Integer value */
1649 if (integer
> 0x7fffff || integer
< -0x800000)
1651 else if (integer
> 0x7fff || integer
< -0x8000)
1653 else if (integer
> 0x7f || integer
< -0x80)
1661 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1665 static int /* O - Size in bytes */
1666 asn1_size_length(int length
) /* I - Length value */
1670 else if (length
> 0x7f)
1678 * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
1682 static int /* O - Size in bytes */
1683 asn1_size_oid(const int *oid
) /* I - OID value */
1685 int length
; /* Length of value */
1689 return (asn1_size_packed(oid
[0] * 40));
1691 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1694 length
+= asn1_size_packed(*oid
);
1701 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1702 * packed integer value.
1705 static int /* O - Size in bytes */
1706 asn1_size_packed(int integer
) /* I - Integer value */
1708 if (integer
> 0xfffffff)
1710 else if (integer
> 0x1fffff)
1712 else if (integer
> 0x3fff)
1714 else if (integer
> 0x7f)
1722 * 'snmp_set_error()' - Set the localized error for a packet.
1726 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1727 const char *message
) /* I - Error message */
1729 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1732 if (!cg
->lang_default
)
1733 cg
->lang_default
= cupsLangDefault();
1735 packet
->error
= _cupsLangString(cg
->lang_default
, message
);