2 * SNMP functions for CUPS.
4 * Copyright © 2007-2014 by Apple Inc.
5 * Copyright © 2006-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers.
15 #include "cups-private.h"
16 #include "snmp-private.h"
17 #include "debug-internal.h"
20 #endif /* HAVE_POLL */
27 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
28 size_t len
, int indent
);
29 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
31 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
33 static int asn1_get_integer(unsigned char **buffer
,
34 unsigned char *bufend
,
36 static int asn1_get_oid(unsigned char **buffer
,
37 unsigned char *bufend
,
38 unsigned length
, int *oid
, int oidsize
);
39 static int asn1_get_packed(unsigned char **buffer
,
40 unsigned char *bufend
);
41 static char *asn1_get_string(unsigned char **buffer
,
42 unsigned char *bufend
,
43 unsigned length
, char *string
,
45 static unsigned asn1_get_length(unsigned char **buffer
,
46 unsigned char *bufend
);
47 static int asn1_get_type(unsigned char **buffer
,
48 unsigned char *bufend
);
49 static void asn1_set_integer(unsigned char **buffer
,
51 static void asn1_set_length(unsigned char **buffer
,
53 static void asn1_set_oid(unsigned char **buffer
,
55 static void asn1_set_packed(unsigned char **buffer
,
57 static unsigned asn1_size_integer(int integer
);
58 static unsigned asn1_size_length(unsigned length
);
59 static unsigned asn1_size_oid(const int *oid
);
60 static unsigned asn1_size_packed(int integer
);
61 static void snmp_set_error(cups_snmp_t
*packet
,
66 * '_cupsSNMPClose()' - Close a SNMP socket.
70 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
72 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd
));
74 httpAddrClose(NULL
, fd
);
79 * '_cupsSNMPCopyOID()' - Copy an OID.
81 * The array pointed to by "src" is terminated by the value -1.
84 int * /* O - New OID */
85 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
86 const int *src
, /* I - Source OID */
87 int dstsize
) /* I - Number of integers in dst */
89 int i
; /* Looping var */
92 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst
, src
,
95 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
105 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
107 * The default community name is the first community name found in the
108 * snmp.conf file. If no community name is defined there, "public" is used.
111 const char * /* O - Default community name */
112 _cupsSNMPDefaultCommunity(void)
114 cups_file_t
*fp
; /* snmp.conf file */
115 char line
[1024], /* Line from file */
116 *value
; /* Value from file */
117 int linenum
; /* Line number in file */
118 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
121 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
123 if (!cg
->snmp_community
[0])
125 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
127 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
128 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
131 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
132 if (!_cups_strcasecmp(line
, "Community") && value
)
134 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
142 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
143 cg
->snmp_community
));
145 return (cg
->snmp_community
);
150 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
152 * The array pointed to by "oid" is terminated by the value -1.
155 int /* O - 1 if equal, 0 if not equal */
156 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
157 const int *oid
) /* I - OID */
159 int i
; /* Looping var */
163 * Range check input...
166 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet
, oid
));
170 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
180 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
182 if (oid
[i
] != packet
->object_name
[i
])
184 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
189 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
190 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
192 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
197 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
200 * The array pointed to by "prefix" is terminated by the value -1.
203 int /* O - 1 if prefixed, 0 if not prefixed */
204 _cupsSNMPIsOIDPrefixed(
205 cups_snmp_t
*packet
, /* I - Response packet */
206 const int *prefix
) /* I - OID prefix */
208 int i
; /* Looping var */
212 * Range check input...
215 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet
,
218 if (!packet
|| !prefix
)
220 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
230 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
232 if (prefix
[i
] != packet
->object_name
[i
])
234 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
239 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
240 i
< CUPS_SNMP_MAX_OID
));
242 return (i
< CUPS_SNMP_MAX_OID
);
247 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
251 char * /* O - New string or @code NULL@ on error */
252 _cupsSNMPOIDToString(const int *src
, /* I - OID */
253 char *dst
, /* I - String buffer */
254 size_t dstsize
) /* I - Size of string buffer */
256 char *dstptr
, /* Pointer into string buffer */
257 *dstend
; /* End of string buffer */
260 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")",
261 src
, dst
, CUPS_LLCAST dstsize
));
264 * Range check input...
267 if (!src
|| !dst
|| dstsize
< 4)
271 * Loop through the OID array and build a string...
274 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
275 *src
>= 0 && dstptr
< dstend
;
276 src
++, dstptr
+= strlen(dstptr
))
277 snprintf(dstptr
, (size_t)(dstend
- dstptr
+ 1), ".%d", *src
);
287 * '_cupsSNMPOpen()' - Open a SNMP socket.
290 int /* O - SNMP socket file descriptor */
291 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
293 int fd
; /* SNMP socket file descriptor */
294 int val
; /* Socket option value */
298 * Create the SNMP socket...
301 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family
));
303 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
305 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
311 * Set the "broadcast" flag...
316 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, CUPS_SOCAST
&val
, sizeof(val
)))
318 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
325 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd
));
332 * '_cupsSNMPRead()' - Read and parse a SNMP response.
334 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
338 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
339 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
340 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
341 double timeout
) /* I - Timeout in seconds */
343 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
345 ssize_t bytes
; /* Number of bytes received */
346 socklen_t addrlen
; /* Source address length */
347 http_addr_t address
; /* Source address */
351 * Range check input...
354 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd
, packet
,
357 if (fd
< 0 || !packet
)
359 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
365 * Optionally wait for a response...
370 int ready
; /* Data ready on socket? */
372 struct pollfd pfd
; /* Polled file descriptor */
377 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
378 (errno
== EINTR
|| errno
== EAGAIN
));
381 fd_set input_set
; /* select() input set */
382 struct timeval stimeout
; /* select() timeout */
387 FD_SET(fd
, &input_set
);
389 stimeout
.tv_sec
= (int)timeout
;
390 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_sec
) * 1000000);
392 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
395 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
397 while (ready
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
399 #endif /* HAVE_POLL */
402 * If we don't have any data ready, return right away...
407 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
414 * Read the response data...
417 addrlen
= sizeof(address
);
419 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
422 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno
)));
428 * Look for the response status code in the SNMP message header...
431 asn1_debug("DEBUG: IN ", buffer
, (size_t)bytes
, 0);
433 asn1_decode_snmp(buffer
, (size_t)bytes
, packet
);
435 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
438 * Return decoded data packet...
441 DEBUG_puts("5_cupsSNMPRead: Returning packet");
448 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
452 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
454 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
457 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level
));
459 cg
->snmp_debug
= level
;
464 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
466 * This function converts a string of the form ".N.N.N.N.N" to the
467 * corresponding OID array terminated by -1.
469 * @code NULL@ is returned if the array is not large enough or the string is
470 * not a valid OID number.
473 int * /* O - Pointer to OID array or @code NULL@ on error */
474 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
475 int *dst
, /* I - OID array */
476 int dstsize
)/* I - Number of integers in OID array */
478 int *dstptr
, /* Pointer into OID array */
479 *dstend
; /* End of OID array */
482 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
486 * Range check input...
489 if (!src
|| !dst
|| dstsize
< 2)
493 * Skip leading "."...
500 * Loop to the end of the string...
503 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
504 *src
&& dstptr
< dstend
;
512 else if (isdigit(*src
& 255))
513 *dstptr
= *dstptr
* 10 + *src
- '0';
522 * Terminate the end of the OID array and return...
532 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
534 * This function queries all of the OIDs with the specified OID prefix,
535 * calling the "cb" function for every response that is received.
537 * The array pointed to by "prefix" is terminated by the value -1.
539 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
543 int /* O - Number of OIDs found or -1 on error */
544 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
545 http_addr_t
*address
, /* I - Address to query */
546 int version
, /* I - SNMP version */
547 const char *community
,/* I - Community name */
548 const int *prefix
, /* I - OID prefix */
549 double timeout
, /* I - Timeout for each response in seconds */
550 cups_snmp_cb_t cb
, /* I - Function to call for each response */
551 void *data
) /* I - User data pointer that is passed to the callback function */
553 int count
= 0; /* Number of OIDs found */
554 unsigned request_id
= 0; /* Current request ID */
555 cups_snmp_t packet
; /* Current response packet */
556 int lastoid
[CUPS_SNMP_MAX_OID
];
557 /* Last OID we got */
561 * Range check input...
564 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
565 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
566 fd
, address
, version
, community
, prefix
, timeout
, cb
, data
));
568 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
571 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
577 * Copy the OID prefix and then loop until we have no more OIDs...
580 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
587 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
588 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
591 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
596 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
598 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
603 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
) ||
604 _cupsSNMPIsOID(&packet
, lastoid
))
606 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
));
611 if (packet
.error
|| packet
.error_status
)
613 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
> 0 ? count
: -1));
615 return (count
> 0 ? count
: -1);
618 _cupsSNMPCopyOID(lastoid
, packet
.object_name
, CUPS_SNMP_MAX_OID
);
622 (*cb
)(&packet
, data
);
628 * '_cupsSNMPWrite()' - Send an SNMP query packet.
630 * The array pointed to by "oid" is terminated by the value -1.
633 int /* O - 1 on success, 0 on error */
635 int fd
, /* I - SNMP socket */
636 http_addr_t
*address
, /* I - Address to send to */
637 int version
, /* I - SNMP version */
638 const char *community
, /* I - Community name */
639 cups_asn1_t request_type
, /* I - Request type */
640 const unsigned request_id
, /* I - Request ID */
641 const int *oid
) /* I - OID */
643 int i
; /* Looping var */
644 cups_snmp_t packet
; /* SNMP message packet */
645 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
646 /* SNMP message buffer */
647 ssize_t bytes
; /* Size of message */
648 http_addr_t temp
; /* Copy of address */
652 * Range check input...
655 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
656 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
657 fd
, address
, version
, community
, request_type
, request_id
, oid
));
659 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
660 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
661 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
663 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
669 * Create the SNMP message...
672 memset(&packet
, 0, sizeof(packet
));
674 packet
.version
= version
;
675 packet
.request_type
= request_type
;
676 packet
.request_id
= request_id
;
677 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
679 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
681 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
682 packet
.object_name
[i
] = oid
[i
];
683 packet
.object_name
[i
] = -1;
687 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
693 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
697 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
703 asn1_debug("DEBUG: OUT ", buffer
, (size_t)bytes
, 0);
706 * Send the message...
711 _httpAddrSetPort(&temp
, CUPS_SNMP_PORT
);
713 return (sendto(fd
, buffer
, (size_t)bytes
, 0, (void *)&temp
, (socklen_t
)httpAddrLength(&temp
)) == bytes
);
718 * 'asn1_debug()' - Decode an ASN1-encoded message.
722 asn1_debug(const char *prefix
, /* I - Prefix string */
723 unsigned char *buffer
, /* I - Buffer */
724 size_t len
, /* I - Length of buffer */
725 int indent
) /* I - Indentation */
727 size_t i
; /* Looping var */
728 unsigned char *bufend
; /* End of buffer */
729 int integer
; /* Number value */
730 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
731 char string
[CUPS_SNMP_MAX_STRING
];
733 unsigned char value_type
; /* Type of value */
734 unsigned value_length
; /* Length of value */
735 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
738 #ifdef __clang_analyzer__ /* Suppress bogus clang error */
739 memset(string
, 0, sizeof(string
));
740 #endif /* __clang_analyzer__ */
742 if (cg
->snmp_debug
<= 0)
745 if (cg
->snmp_debug
> 1 && indent
== 0)
748 * Do a hex dump of the packet...
753 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
755 for (i
= 0; i
< len
; i
+= 16)
757 fprintf(stderr
, "%s%04x:", prefix
, (unsigned)i
);
759 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
762 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
764 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
779 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
780 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
783 putc(buffer
[i
+ j
], stderr
);
790 fprintf(stderr
, "%sMessage:\n", prefix
);
792 bufend
= buffer
+ len
;
794 while (buffer
< bufend
)
800 value_type
= (unsigned char)asn1_get_type(&buffer
, bufend
);
801 value_length
= asn1_get_length(&buffer
, bufend
);
805 case CUPS_ASN1_BOOLEAN
:
806 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
808 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
809 value_length
, integer
);
812 case CUPS_ASN1_INTEGER
:
813 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
815 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
816 value_length
, integer
);
819 case CUPS_ASN1_COUNTER
:
820 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
822 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
823 value_length
, (unsigned)integer
);
826 case CUPS_ASN1_GAUGE
:
827 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
829 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
830 value_length
, (unsigned)integer
);
833 case CUPS_ASN1_TIMETICKS
:
834 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
836 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
837 value_length
, (unsigned)integer
);
840 case CUPS_ASN1_OCTET_STRING
:
841 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
842 indent
, "", value_length
,
843 asn1_get_string(&buffer
, bufend
, value_length
, string
,
847 case CUPS_ASN1_HEX_STRING
:
848 asn1_get_string(&buffer
, bufend
, value_length
, string
,
850 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
851 indent
, "", value_length
);
852 for (i
= 0; i
< value_length
; i
++)
853 fprintf(stderr
, " %02X", string
[i
] & 255);
857 case CUPS_ASN1_NULL_VALUE
:
858 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
861 buffer
+= value_length
;
865 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
868 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
870 for (i
= 0; i
< (unsigned)integer
; i
++)
871 fprintf(stderr
, ".%d", oid
[i
]);
875 case CUPS_ASN1_SEQUENCE
:
876 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
878 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
880 buffer
+= value_length
;
883 case CUPS_ASN1_GET_NEXT_REQUEST
:
884 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
885 indent
, "", value_length
);
886 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
888 buffer
+= value_length
;
891 case CUPS_ASN1_GET_REQUEST
:
892 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
894 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
896 buffer
+= value_length
;
899 case CUPS_ASN1_GET_RESPONSE
:
900 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
902 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
904 buffer
+= value_length
;
908 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
909 value_type
, value_length
);
911 buffer
+= value_length
;
919 * 'asn1_decode_snmp()' - Decode a SNMP packet.
922 static int /* O - 0 on success, -1 on error */
923 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
924 size_t len
, /* I - Size of buffer */
925 cups_snmp_t
*packet
) /* I - SNMP packet */
927 unsigned char *bufptr
, /* Pointer into the data */
928 *bufend
; /* End of data */
929 unsigned length
; /* Length of value */
933 * Initialize the decoding...
936 memset(packet
, 0, sizeof(cups_snmp_t
));
937 packet
->object_name
[0] = -1;
940 bufend
= buffer
+ len
;
942 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
943 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
944 else if (asn1_get_length(&bufptr
, bufend
) == 0)
945 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
946 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
947 snmp_set_error(packet
, _("No version number"));
948 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
949 snmp_set_error(packet
, _("Version uses indefinite length"));
950 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
951 != CUPS_SNMP_VERSION_1
)
952 snmp_set_error(packet
, _("Bad SNMP version number"));
953 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
954 snmp_set_error(packet
, _("No community name"));
955 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
956 snmp_set_error(packet
, _("Community name uses indefinite length"));
959 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
960 sizeof(packet
->community
));
962 if ((packet
->request_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
))
963 != CUPS_ASN1_GET_RESPONSE
)
964 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
965 else if (asn1_get_length(&bufptr
, bufend
) == 0)
966 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
967 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
968 snmp_set_error(packet
, _("No request-id"));
969 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
970 snmp_set_error(packet
, _("request-id uses indefinite length"));
973 packet
->request_id
= (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
975 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
976 snmp_set_error(packet
, _("No error-status"));
977 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
978 snmp_set_error(packet
, _("error-status uses indefinite length"));
981 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
983 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
984 snmp_set_error(packet
, _("No error-index"));
985 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
986 snmp_set_error(packet
, _("error-index uses indefinite length"));
989 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
991 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
992 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
993 else if (asn1_get_length(&bufptr
, bufend
) == 0)
994 snmp_set_error(packet
,
995 _("variable-bindings uses indefinite length"));
996 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
997 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
998 else if (asn1_get_length(&bufptr
, bufend
) == 0)
999 snmp_set_error(packet
, _("VarBind uses indefinite length"));
1000 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1001 snmp_set_error(packet
, _("No name OID"));
1002 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1003 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1006 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1009 packet
->object_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
);
1011 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1012 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1013 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1014 snmp_set_error(packet
, _("Value uses indefinite length"));
1017 switch (packet
->object_type
)
1019 case CUPS_ASN1_BOOLEAN
:
1020 packet
->object_value
.boolean
=
1021 asn1_get_integer(&bufptr
, bufend
, length
);
1024 case CUPS_ASN1_INTEGER
:
1025 packet
->object_value
.integer
=
1026 asn1_get_integer(&bufptr
, bufend
, length
);
1029 case CUPS_ASN1_NULL_VALUE
:
1032 case CUPS_ASN1_OCTET_STRING
:
1033 case CUPS_ASN1_BIT_STRING
:
1034 case CUPS_ASN1_HEX_STRING
:
1035 packet
->object_value
.string
.num_bytes
= length
;
1036 asn1_get_string(&bufptr
, bufend
, length
,
1037 (char *)packet
->object_value
.string
.bytes
,
1038 sizeof(packet
->object_value
.string
.bytes
));
1041 case CUPS_ASN1_OID
:
1042 asn1_get_oid(&bufptr
, bufend
, length
,
1043 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1046 case CUPS_ASN1_COUNTER
:
1047 packet
->object_value
.counter
=
1048 asn1_get_integer(&bufptr
, bufend
, length
);
1051 case CUPS_ASN1_GAUGE
:
1052 packet
->object_value
.gauge
=
1053 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1056 case CUPS_ASN1_TIMETICKS
:
1057 packet
->object_value
.timeticks
=
1058 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1062 snmp_set_error(packet
, _("Unsupported value type"));
1072 return (packet
->error
? -1 : 0);
1077 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1080 static int /* O - Length on success, -1 on error */
1081 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1082 size_t bufsize
, /* I - Size of buffer */
1083 cups_snmp_t
*packet
) /* I - SNMP packet */
1085 unsigned char *bufptr
; /* Pointer into buffer */
1086 unsigned total
, /* Total length */
1087 msglen
, /* Length of entire message */
1088 commlen
, /* Length of community string */
1089 reqlen
, /* Length of request */
1090 listlen
, /* Length of variable list */
1091 varlen
, /* Length of variable */
1092 namelen
, /* Length of object name OID */
1093 valuelen
; /* Length of object value */
1097 * Get the lengths of the community string, OID, and message...
1101 namelen
= asn1_size_oid(packet
->object_name
);
1103 switch (packet
->object_type
)
1105 case CUPS_ASN1_NULL_VALUE
:
1109 case CUPS_ASN1_BOOLEAN
:
1110 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1113 case CUPS_ASN1_INTEGER
:
1114 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1117 case CUPS_ASN1_OCTET_STRING
:
1118 valuelen
= packet
->object_value
.string
.num_bytes
;
1121 case CUPS_ASN1_OID
:
1122 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1126 packet
->error
= "Unknown object type";
1130 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1131 1 + asn1_size_length(valuelen
) + valuelen
;
1132 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1133 reqlen
= 2 + asn1_size_integer((int)packet
->request_id
) +
1134 2 + asn1_size_integer(packet
->error_status
) +
1135 2 + asn1_size_integer(packet
->error_index
) +
1136 1 + asn1_size_length(listlen
) + listlen
;
1137 commlen
= (unsigned)strlen(packet
->community
);
1138 msglen
= 2 + asn1_size_integer(packet
->version
) +
1139 1 + asn1_size_length(commlen
) + commlen
+
1140 1 + asn1_size_length(reqlen
) + reqlen
;
1141 total
= 1 + asn1_size_length(msglen
) + msglen
;
1143 if (total
> bufsize
)
1145 packet
->error
= "Message too large for buffer";
1150 * Then format the message...
1155 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1156 asn1_set_length(&bufptr
, msglen
);
1158 asn1_set_integer(&bufptr
, packet
->version
);
1161 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1162 asn1_set_length(&bufptr
, commlen
);
1163 memcpy(bufptr
, packet
->community
, commlen
);
1166 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1167 asn1_set_length(&bufptr
, reqlen
);
1169 asn1_set_integer(&bufptr
, (int)packet
->request_id
);
1171 asn1_set_integer(&bufptr
, packet
->error_status
);
1173 asn1_set_integer(&bufptr
, packet
->error_index
);
1175 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1176 asn1_set_length(&bufptr
, listlen
);
1178 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1179 asn1_set_length(&bufptr
, varlen
);
1181 asn1_set_oid(&bufptr
, packet
->object_name
);
1184 switch (packet
->object_type
)
1186 case CUPS_ASN1_NULL_VALUE
:
1187 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1189 *bufptr
++ = 0; /* Length */
1192 case CUPS_ASN1_BOOLEAN
:
1193 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1196 case CUPS_ASN1_INTEGER
:
1197 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1200 case CUPS_ASN1_OCTET_STRING
:
1201 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1202 asn1_set_length(&bufptr
, valuelen
);
1203 memcpy(bufptr
, packet
->object_value
.string
.bytes
, valuelen
);
1207 case CUPS_ASN1_OID
:
1208 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1215 return ((int)(bufptr
- buffer
));
1220 * 'asn1_get_integer()' - Get an integer value.
1223 static int /* O - Integer value */
1225 unsigned char **buffer
, /* IO - Pointer in buffer */
1226 unsigned char *bufend
, /* I - End of buffer */
1227 unsigned length
) /* I - Length of value */
1229 int value
; /* Integer value */
1232 if (length
> sizeof(int))
1234 (*buffer
) += length
;
1238 for (value
= (**buffer
& 0x80) ? ~0 : 0;
1239 length
> 0 && *buffer
< bufend
;
1240 length
--, (*buffer
) ++)
1241 value
= ((value
& 0xffffff) << 8) | **buffer
;
1248 * 'asn1_get_length()' - Get a value length.
1251 static unsigned /* O - Length */
1252 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1253 unsigned char *bufend
) /* I - End of buffer */
1255 unsigned length
; /* Length */
1263 int count
; /* Number of bytes for length */
1266 if ((count
= length
& 127) > sizeof(unsigned))
1273 count
> 0 && *buffer
< bufend
;
1274 count
--, (*buffer
) ++)
1275 length
= (length
<< 8) | **buffer
;
1283 * 'asn1_get_oid()' - Get an OID value.
1286 static int /* O - Number of OIDs */
1288 unsigned char **buffer
, /* IO - Pointer in buffer */
1289 unsigned char *bufend
, /* I - End of buffer */
1290 unsigned length
, /* I - Length of value */
1291 int *oid
, /* I - OID buffer */
1292 int oidsize
) /* I - Size of OID buffer */
1294 unsigned char *valend
; /* End of value */
1295 int *oidptr
, /* Current OID */
1296 *oidend
; /* End of OID buffer */
1297 int number
; /* OID number */
1300 valend
= *buffer
+ length
;
1302 oidend
= oid
+ oidsize
- 1;
1304 if (valend
> bufend
)
1307 number
= asn1_get_packed(buffer
, bufend
);
1311 *oidptr
++ = number
/ 40;
1312 number
= number
% 40;
1322 while (*buffer
< valend
)
1324 number
= asn1_get_packed(buffer
, bufend
);
1326 if (oidptr
< oidend
)
1332 return ((int)(oidptr
- oid
));
1337 * 'asn1_get_packed()' - Get a packed integer value.
1340 static int /* O - Value */
1342 unsigned char **buffer
, /* IO - Pointer in buffer */
1343 unsigned char *bufend
) /* I - End of buffer */
1345 int value
; /* Value */
1350 while ((**buffer
& 128) && *buffer
< bufend
)
1352 value
= (value
<< 7) | (**buffer
& 127);
1356 if (*buffer
< bufend
)
1358 value
= (value
<< 7) | **buffer
;
1367 * 'asn1_get_string()' - Get a string value.
1370 static char * /* O - String */
1372 unsigned char **buffer
, /* IO - Pointer in buffer */
1373 unsigned char *bufend
, /* I - End of buffer */
1374 unsigned length
, /* I - Value length */
1375 char *string
, /* I - String buffer */
1376 size_t strsize
) /* I - String buffer size */
1378 if (length
> (unsigned)(bufend
- *buffer
))
1379 length
= (unsigned)(bufend
- *buffer
);
1381 if (length
< strsize
)
1384 * String is smaller than the buffer...
1388 memcpy(string
, *buffer
, length
);
1390 string
[length
] = '\0';
1395 * String is larger than the buffer...
1398 memcpy(string
, *buffer
, strsize
- 1);
1399 string
[strsize
- 1] = '\0';
1403 (*buffer
) += length
;
1410 * 'asn1_get_type()' - Get a value type.
1413 static int /* O - Type */
1414 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1415 unsigned char *bufend
) /* I - End of buffer */
1417 int type
; /* Type */
1423 if ((type
& 31) == 31)
1424 type
= asn1_get_packed(buffer
, bufend
);
1431 * 'asn1_set_integer()' - Set an integer value.
1435 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1436 int integer
) /* I - Integer value */
1438 **buffer
= CUPS_ASN1_INTEGER
;
1441 if (integer
> 0x7fffff || integer
< -0x800000)
1445 **buffer
= (unsigned char)(integer
>> 24);
1447 **buffer
= (unsigned char)(integer
>> 16);
1449 **buffer
= (unsigned char)(integer
>> 8);
1451 **buffer
= (unsigned char)integer
;
1454 else if (integer
> 0x7fff || integer
< -0x8000)
1458 **buffer
= (unsigned char)(integer
>> 16);
1460 **buffer
= (unsigned char)(integer
>> 8);
1462 **buffer
= (unsigned char)integer
;
1465 else if (integer
> 0x7f || integer
< -0x80)
1469 **buffer
= (unsigned char)(integer
>> 8);
1471 **buffer
= (unsigned char)integer
;
1478 **buffer
= (unsigned char)integer
;
1485 * 'asn1_set_length()' - Set a value length.
1489 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1490 unsigned length
) /* I - Length value */
1494 **buffer
= 0x82; /* 2-byte length */
1496 **buffer
= (unsigned char)(length
>> 8);
1498 **buffer
= (unsigned char)length
;
1501 else if (length
> 127)
1503 **buffer
= 0x81; /* 1-byte length */
1505 **buffer
= (unsigned char)length
;
1510 **buffer
= (unsigned char)length
; /* Length */
1517 * 'asn1_set_oid()' - Set an OID value.
1521 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1522 const int *oid
) /* I - OID value */
1524 **buffer
= CUPS_ASN1_OID
;
1527 asn1_set_length(buffer
, asn1_size_oid(oid
));
1531 asn1_set_packed(buffer
, oid
[0] * 40);
1535 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1537 for (oid
+= 2; *oid
>= 0; oid
++)
1538 asn1_set_packed(buffer
, *oid
);
1543 * 'asn1_set_packed()' - Set a packed integer value.
1547 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1548 int integer
) /* I - Integer value */
1550 if (integer
> 0xfffffff)
1552 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1556 if (integer
> 0x1fffff)
1558 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1562 if (integer
> 0x3fff)
1564 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1570 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1574 **buffer
= integer
& 0x7f;
1580 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1584 static unsigned /* O - Size in bytes */
1585 asn1_size_integer(int integer
) /* I - Integer value */
1587 if (integer
> 0x7fffff || integer
< -0x800000)
1589 else if (integer
> 0x7fff || integer
< -0x8000)
1591 else if (integer
> 0x7f || integer
< -0x80)
1599 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1603 static unsigned /* O - Size in bytes */
1604 asn1_size_length(unsigned length
) /* I - Length value */
1608 else if (length
> 0x7f)
1616 * 'asn1_size_oid()' - Figure out the number of bytes needed for an
1620 static unsigned /* O - Size in bytes */
1621 asn1_size_oid(const int *oid
) /* I - OID value */
1623 unsigned length
; /* Length of value */
1627 return (asn1_size_packed(oid
[0] * 40));
1629 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1632 length
+= asn1_size_packed(*oid
);
1639 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1640 * packed integer value.
1643 static unsigned /* O - Size in bytes */
1644 asn1_size_packed(int integer
) /* I - Integer value */
1646 if (integer
> 0xfffffff)
1648 else if (integer
> 0x1fffff)
1650 else if (integer
> 0x3fff)
1652 else if (integer
> 0x7f)
1660 * 'snmp_set_error()' - Set the localized error for a packet.
1664 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1665 const char *message
) /* I - Error message */
1667 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1670 if (!cg
->lang_default
)
1671 cg
->lang_default
= cupsLangDefault();
1673 packet
->error
= _cupsLangString(cg
->lang_default
, message
);