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"
19 #endif /* HAVE_POLL */
26 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
27 size_t len
, int indent
);
28 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
30 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
32 static int asn1_get_integer(unsigned char **buffer
,
33 unsigned char *bufend
,
35 static int asn1_get_oid(unsigned char **buffer
,
36 unsigned char *bufend
,
37 unsigned length
, int *oid
, int oidsize
);
38 static int asn1_get_packed(unsigned char **buffer
,
39 unsigned char *bufend
);
40 static char *asn1_get_string(unsigned char **buffer
,
41 unsigned char *bufend
,
42 unsigned length
, char *string
,
44 static unsigned asn1_get_length(unsigned char **buffer
,
45 unsigned char *bufend
);
46 static int asn1_get_type(unsigned char **buffer
,
47 unsigned char *bufend
);
48 static void asn1_set_integer(unsigned char **buffer
,
50 static void asn1_set_length(unsigned char **buffer
,
52 static void asn1_set_oid(unsigned char **buffer
,
54 static void asn1_set_packed(unsigned char **buffer
,
56 static unsigned asn1_size_integer(int integer
);
57 static unsigned asn1_size_length(unsigned length
);
58 static unsigned asn1_size_oid(const int *oid
);
59 static unsigned asn1_size_packed(int integer
);
60 static void snmp_set_error(cups_snmp_t
*packet
,
65 * '_cupsSNMPClose()' - Close a SNMP socket.
69 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
71 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd
));
73 httpAddrClose(NULL
, fd
);
78 * '_cupsSNMPCopyOID()' - Copy an OID.
80 * The array pointed to by "src" is terminated by the value -1.
83 int * /* O - New OID */
84 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
85 const int *src
, /* I - Source OID */
86 int dstsize
) /* I - Number of integers in dst */
88 int i
; /* Looping var */
91 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst
, src
,
94 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
104 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
106 * The default community name is the first community name found in the
107 * snmp.conf file. If no community name is defined there, "public" is used.
110 const char * /* O - Default community name */
111 _cupsSNMPDefaultCommunity(void)
113 cups_file_t
*fp
; /* snmp.conf file */
114 char line
[1024], /* Line from file */
115 *value
; /* Value from file */
116 int linenum
; /* Line number in file */
117 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
120 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
122 if (!cg
->snmp_community
[0])
124 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
126 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
127 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
130 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
131 if (!_cups_strcasecmp(line
, "Community") && value
)
133 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
141 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
142 cg
->snmp_community
));
144 return (cg
->snmp_community
);
149 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
151 * The array pointed to by "oid" is terminated by the value -1.
154 int /* O - 1 if equal, 0 if not equal */
155 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
156 const int *oid
) /* I - OID */
158 int i
; /* Looping var */
162 * Range check input...
165 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet
, oid
));
169 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
179 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
181 if (oid
[i
] != packet
->object_name
[i
])
183 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
188 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
189 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
191 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
196 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
199 * The array pointed to by "prefix" is terminated by the value -1.
202 int /* O - 1 if prefixed, 0 if not prefixed */
203 _cupsSNMPIsOIDPrefixed(
204 cups_snmp_t
*packet
, /* I - Response packet */
205 const int *prefix
) /* I - OID prefix */
207 int i
; /* Looping var */
211 * Range check input...
214 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet
,
217 if (!packet
|| !prefix
)
219 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
229 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
231 if (prefix
[i
] != packet
->object_name
[i
])
233 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
238 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
239 i
< CUPS_SNMP_MAX_OID
));
241 return (i
< CUPS_SNMP_MAX_OID
);
246 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
250 char * /* O - New string or @code NULL@ on error */
251 _cupsSNMPOIDToString(const int *src
, /* I - OID */
252 char *dst
, /* I - String buffer */
253 size_t dstsize
) /* I - Size of string buffer */
255 char *dstptr
, /* Pointer into string buffer */
256 *dstend
; /* End of string buffer */
259 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")",
260 src
, dst
, CUPS_LLCAST dstsize
));
263 * Range check input...
266 if (!src
|| !dst
|| dstsize
< 4)
270 * Loop through the OID array and build a string...
273 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
274 *src
>= 0 && dstptr
< dstend
;
275 src
++, dstptr
+= strlen(dstptr
))
276 snprintf(dstptr
, (size_t)(dstend
- dstptr
+ 1), ".%d", *src
);
286 * '_cupsSNMPOpen()' - Open a SNMP socket.
289 int /* O - SNMP socket file descriptor */
290 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
292 int fd
; /* SNMP socket file descriptor */
293 int val
; /* Socket option value */
297 * Create the SNMP socket...
300 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family
));
302 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
304 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
310 * Set the "broadcast" flag...
315 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, CUPS_SOCAST
&val
, sizeof(val
)))
317 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
324 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd
));
331 * '_cupsSNMPRead()' - Read and parse a SNMP response.
333 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
337 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
338 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
339 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
340 double timeout
) /* I - Timeout in seconds */
342 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
344 ssize_t bytes
; /* Number of bytes received */
345 socklen_t addrlen
; /* Source address length */
346 http_addr_t address
; /* Source address */
350 * Range check input...
353 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd
, packet
,
356 if (fd
< 0 || !packet
)
358 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
364 * Optionally wait for a response...
369 int ready
; /* Data ready on socket? */
371 struct pollfd pfd
; /* Polled file descriptor */
376 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
377 (errno
== EINTR
|| errno
== EAGAIN
));
380 fd_set input_set
; /* select() input set */
381 struct timeval stimeout
; /* select() timeout */
386 FD_SET(fd
, &input_set
);
388 stimeout
.tv_sec
= (int)timeout
;
389 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_sec
) * 1000000);
391 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
394 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
396 while (ready
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
398 #endif /* HAVE_POLL */
401 * If we don't have any data ready, return right away...
406 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
413 * Read the response data...
416 addrlen
= sizeof(address
);
418 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
421 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno
)));
427 * Look for the response status code in the SNMP message header...
430 asn1_debug("DEBUG: IN ", buffer
, (size_t)bytes
, 0);
432 asn1_decode_snmp(buffer
, (size_t)bytes
, packet
);
434 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
437 * Return decoded data packet...
440 DEBUG_puts("5_cupsSNMPRead: Returning packet");
447 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
451 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
453 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
456 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level
));
458 cg
->snmp_debug
= level
;
463 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
465 * This function converts a string of the form ".N.N.N.N.N" to the
466 * corresponding OID array terminated by -1.
468 * @code NULL@ is returned if the array is not large enough or the string is
469 * not a valid OID number.
472 int * /* O - Pointer to OID array or @code NULL@ on error */
473 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
474 int *dst
, /* I - OID array */
475 int dstsize
)/* I - Number of integers in OID array */
477 int *dstptr
, /* Pointer into OID array */
478 *dstend
; /* End of OID array */
481 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
485 * Range check input...
488 if (!src
|| !dst
|| dstsize
< 2)
492 * Skip leading "."...
499 * Loop to the end of the string...
502 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
503 *src
&& dstptr
< dstend
;
511 else if (isdigit(*src
& 255))
512 *dstptr
= *dstptr
* 10 + *src
- '0';
521 * Terminate the end of the OID array and return...
531 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
533 * This function queries all of the OIDs with the specified OID prefix,
534 * calling the "cb" function for every response that is received.
536 * The array pointed to by "prefix" is terminated by the value -1.
538 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
542 int /* O - Number of OIDs found or -1 on error */
543 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
544 http_addr_t
*address
, /* I - Address to query */
545 int version
, /* I - SNMP version */
546 const char *community
,/* I - Community name */
547 const int *prefix
, /* I - OID prefix */
548 double timeout
, /* I - Timeout for each response in seconds */
549 cups_snmp_cb_t cb
, /* I - Function to call for each response */
550 void *data
) /* I - User data pointer that is passed to the callback function */
552 int count
= 0; /* Number of OIDs found */
553 unsigned request_id
= 0; /* Current request ID */
554 cups_snmp_t packet
; /* Current response packet */
555 int lastoid
[CUPS_SNMP_MAX_OID
];
556 /* Last OID we got */
560 * Range check input...
563 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
564 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
565 fd
, address
, version
, community
, prefix
, timeout
, cb
, data
));
567 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
570 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
576 * Copy the OID prefix and then loop until we have no more OIDs...
579 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
586 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
587 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
590 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
595 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
597 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
602 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
) ||
603 _cupsSNMPIsOID(&packet
, lastoid
))
605 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
));
610 if (packet
.error
|| packet
.error_status
)
612 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
> 0 ? count
: -1));
614 return (count
> 0 ? count
: -1);
617 _cupsSNMPCopyOID(lastoid
, packet
.object_name
, CUPS_SNMP_MAX_OID
);
621 (*cb
)(&packet
, data
);
627 * '_cupsSNMPWrite()' - Send an SNMP query packet.
629 * The array pointed to by "oid" is terminated by the value -1.
632 int /* O - 1 on success, 0 on error */
634 int fd
, /* I - SNMP socket */
635 http_addr_t
*address
, /* I - Address to send to */
636 int version
, /* I - SNMP version */
637 const char *community
, /* I - Community name */
638 cups_asn1_t request_type
, /* I - Request type */
639 const unsigned request_id
, /* I - Request ID */
640 const int *oid
) /* I - OID */
642 int i
; /* Looping var */
643 cups_snmp_t packet
; /* SNMP message packet */
644 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
645 /* SNMP message buffer */
646 ssize_t bytes
; /* Size of message */
647 http_addr_t temp
; /* Copy of address */
651 * Range check input...
654 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
655 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
656 fd
, address
, version
, community
, request_type
, request_id
, oid
));
658 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
659 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
660 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
662 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
668 * Create the SNMP message...
671 memset(&packet
, 0, sizeof(packet
));
673 packet
.version
= version
;
674 packet
.request_type
= request_type
;
675 packet
.request_id
= request_id
;
676 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
678 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
680 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
681 packet
.object_name
[i
] = oid
[i
];
682 packet
.object_name
[i
] = -1;
686 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
692 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
696 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
702 asn1_debug("DEBUG: OUT ", buffer
, (size_t)bytes
, 0);
705 * Send the message...
710 _httpAddrSetPort(&temp
, CUPS_SNMP_PORT
);
712 return (sendto(fd
, buffer
, (size_t)bytes
, 0, (void *)&temp
, (socklen_t
)httpAddrLength(&temp
)) == bytes
);
717 * 'asn1_debug()' - Decode an ASN1-encoded message.
721 asn1_debug(const char *prefix
, /* I - Prefix string */
722 unsigned char *buffer
, /* I - Buffer */
723 size_t len
, /* I - Length of buffer */
724 int indent
) /* I - Indentation */
726 size_t i
; /* Looping var */
727 unsigned char *bufend
; /* End of buffer */
728 int integer
; /* Number value */
729 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
730 char string
[CUPS_SNMP_MAX_STRING
];
732 unsigned char value_type
; /* Type of value */
733 unsigned value_length
; /* Length of value */
734 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
737 #ifdef __clang_analyzer__ /* Suppress bogus clang error */
738 memset(string
, 0, sizeof(string
));
739 #endif /* __clang_analyzer__ */
741 if (cg
->snmp_debug
<= 0)
744 if (cg
->snmp_debug
> 1 && indent
== 0)
747 * Do a hex dump of the packet...
752 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
754 for (i
= 0; i
< len
; i
+= 16)
756 fprintf(stderr
, "%s%04x:", prefix
, (unsigned)i
);
758 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
761 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
763 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
778 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
779 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
782 putc(buffer
[i
+ j
], stderr
);
789 fprintf(stderr
, "%sMessage:\n", prefix
);
791 bufend
= buffer
+ len
;
793 while (buffer
< bufend
)
799 value_type
= (unsigned char)asn1_get_type(&buffer
, bufend
);
800 value_length
= asn1_get_length(&buffer
, bufend
);
804 case CUPS_ASN1_BOOLEAN
:
805 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
807 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
808 value_length
, integer
);
811 case CUPS_ASN1_INTEGER
:
812 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
814 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
815 value_length
, integer
);
818 case CUPS_ASN1_COUNTER
:
819 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
821 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
822 value_length
, (unsigned)integer
);
825 case CUPS_ASN1_GAUGE
:
826 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
828 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
829 value_length
, (unsigned)integer
);
832 case CUPS_ASN1_TIMETICKS
:
833 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
835 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
836 value_length
, (unsigned)integer
);
839 case CUPS_ASN1_OCTET_STRING
:
840 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
841 indent
, "", value_length
,
842 asn1_get_string(&buffer
, bufend
, value_length
, string
,
846 case CUPS_ASN1_HEX_STRING
:
847 asn1_get_string(&buffer
, bufend
, value_length
, string
,
849 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
850 indent
, "", value_length
);
851 for (i
= 0; i
< value_length
; i
++)
852 fprintf(stderr
, " %02X", string
[i
] & 255);
856 case CUPS_ASN1_NULL_VALUE
:
857 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
860 buffer
+= value_length
;
864 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
867 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
869 for (i
= 0; i
< (unsigned)integer
; i
++)
870 fprintf(stderr
, ".%d", oid
[i
]);
874 case CUPS_ASN1_SEQUENCE
:
875 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
877 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
879 buffer
+= value_length
;
882 case CUPS_ASN1_GET_NEXT_REQUEST
:
883 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
884 indent
, "", value_length
);
885 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
887 buffer
+= value_length
;
890 case CUPS_ASN1_GET_REQUEST
:
891 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
893 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
895 buffer
+= value_length
;
898 case CUPS_ASN1_GET_RESPONSE
:
899 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
901 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
903 buffer
+= value_length
;
907 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
908 value_type
, value_length
);
910 buffer
+= value_length
;
918 * 'asn1_decode_snmp()' - Decode a SNMP packet.
921 static int /* O - 0 on success, -1 on error */
922 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
923 size_t len
, /* I - Size of buffer */
924 cups_snmp_t
*packet
) /* I - SNMP packet */
926 unsigned char *bufptr
, /* Pointer into the data */
927 *bufend
; /* End of data */
928 unsigned length
; /* Length of value */
932 * Initialize the decoding...
935 memset(packet
, 0, sizeof(cups_snmp_t
));
936 packet
->object_name
[0] = -1;
939 bufend
= buffer
+ len
;
941 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
942 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
943 else if (asn1_get_length(&bufptr
, bufend
) == 0)
944 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
945 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
946 snmp_set_error(packet
, _("No version number"));
947 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
948 snmp_set_error(packet
, _("Version uses indefinite length"));
949 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
950 != CUPS_SNMP_VERSION_1
)
951 snmp_set_error(packet
, _("Bad SNMP version number"));
952 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
953 snmp_set_error(packet
, _("No community name"));
954 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
955 snmp_set_error(packet
, _("Community name uses indefinite length"));
958 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
959 sizeof(packet
->community
));
961 if ((packet
->request_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
))
962 != CUPS_ASN1_GET_RESPONSE
)
963 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
964 else if (asn1_get_length(&bufptr
, bufend
) == 0)
965 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
966 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
967 snmp_set_error(packet
, _("No request-id"));
968 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
969 snmp_set_error(packet
, _("request-id uses indefinite length"));
972 packet
->request_id
= (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
974 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
975 snmp_set_error(packet
, _("No error-status"));
976 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
977 snmp_set_error(packet
, _("error-status uses indefinite length"));
980 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
982 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
983 snmp_set_error(packet
, _("No error-index"));
984 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
985 snmp_set_error(packet
, _("error-index uses indefinite length"));
988 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
990 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
991 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
992 else if (asn1_get_length(&bufptr
, bufend
) == 0)
993 snmp_set_error(packet
,
994 _("variable-bindings uses indefinite length"));
995 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
996 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
997 else if (asn1_get_length(&bufptr
, bufend
) == 0)
998 snmp_set_error(packet
, _("VarBind uses indefinite length"));
999 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1000 snmp_set_error(packet
, _("No name OID"));
1001 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1002 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1005 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1008 packet
->object_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
);
1010 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1011 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1012 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1013 snmp_set_error(packet
, _("Value uses indefinite length"));
1016 switch (packet
->object_type
)
1018 case CUPS_ASN1_BOOLEAN
:
1019 packet
->object_value
.boolean
=
1020 asn1_get_integer(&bufptr
, bufend
, length
);
1023 case CUPS_ASN1_INTEGER
:
1024 packet
->object_value
.integer
=
1025 asn1_get_integer(&bufptr
, bufend
, length
);
1028 case CUPS_ASN1_NULL_VALUE
:
1031 case CUPS_ASN1_OCTET_STRING
:
1032 case CUPS_ASN1_BIT_STRING
:
1033 case CUPS_ASN1_HEX_STRING
:
1034 packet
->object_value
.string
.num_bytes
= length
;
1035 asn1_get_string(&bufptr
, bufend
, length
,
1036 (char *)packet
->object_value
.string
.bytes
,
1037 sizeof(packet
->object_value
.string
.bytes
));
1040 case CUPS_ASN1_OID
:
1041 asn1_get_oid(&bufptr
, bufend
, length
,
1042 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1045 case CUPS_ASN1_COUNTER
:
1046 packet
->object_value
.counter
=
1047 asn1_get_integer(&bufptr
, bufend
, length
);
1050 case CUPS_ASN1_GAUGE
:
1051 packet
->object_value
.gauge
=
1052 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1055 case CUPS_ASN1_TIMETICKS
:
1056 packet
->object_value
.timeticks
=
1057 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1061 snmp_set_error(packet
, _("Unsupported value type"));
1071 return (packet
->error
? -1 : 0);
1076 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1079 static int /* O - Length on success, -1 on error */
1080 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1081 size_t bufsize
, /* I - Size of buffer */
1082 cups_snmp_t
*packet
) /* I - SNMP packet */
1084 unsigned char *bufptr
; /* Pointer into buffer */
1085 unsigned total
, /* Total length */
1086 msglen
, /* Length of entire message */
1087 commlen
, /* Length of community string */
1088 reqlen
, /* Length of request */
1089 listlen
, /* Length of variable list */
1090 varlen
, /* Length of variable */
1091 namelen
, /* Length of object name OID */
1092 valuelen
; /* Length of object value */
1096 * Get the lengths of the community string, OID, and message...
1100 namelen
= asn1_size_oid(packet
->object_name
);
1102 switch (packet
->object_type
)
1104 case CUPS_ASN1_NULL_VALUE
:
1108 case CUPS_ASN1_BOOLEAN
:
1109 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1112 case CUPS_ASN1_INTEGER
:
1113 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1116 case CUPS_ASN1_OCTET_STRING
:
1117 valuelen
= packet
->object_value
.string
.num_bytes
;
1120 case CUPS_ASN1_OID
:
1121 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1125 packet
->error
= "Unknown object type";
1129 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1130 1 + asn1_size_length(valuelen
) + valuelen
;
1131 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1132 reqlen
= 2 + asn1_size_integer((int)packet
->request_id
) +
1133 2 + asn1_size_integer(packet
->error_status
) +
1134 2 + asn1_size_integer(packet
->error_index
) +
1135 1 + asn1_size_length(listlen
) + listlen
;
1136 commlen
= (unsigned)strlen(packet
->community
);
1137 msglen
= 2 + asn1_size_integer(packet
->version
) +
1138 1 + asn1_size_length(commlen
) + commlen
+
1139 1 + asn1_size_length(reqlen
) + reqlen
;
1140 total
= 1 + asn1_size_length(msglen
) + msglen
;
1142 if (total
> bufsize
)
1144 packet
->error
= "Message too large for buffer";
1149 * Then format the message...
1154 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1155 asn1_set_length(&bufptr
, msglen
);
1157 asn1_set_integer(&bufptr
, packet
->version
);
1160 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1161 asn1_set_length(&bufptr
, commlen
);
1162 memcpy(bufptr
, packet
->community
, commlen
);
1165 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1166 asn1_set_length(&bufptr
, reqlen
);
1168 asn1_set_integer(&bufptr
, (int)packet
->request_id
);
1170 asn1_set_integer(&bufptr
, packet
->error_status
);
1172 asn1_set_integer(&bufptr
, packet
->error_index
);
1174 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1175 asn1_set_length(&bufptr
, listlen
);
1177 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1178 asn1_set_length(&bufptr
, varlen
);
1180 asn1_set_oid(&bufptr
, packet
->object_name
);
1183 switch (packet
->object_type
)
1185 case CUPS_ASN1_NULL_VALUE
:
1186 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1188 *bufptr
++ = 0; /* Length */
1191 case CUPS_ASN1_BOOLEAN
:
1192 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1195 case CUPS_ASN1_INTEGER
:
1196 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1199 case CUPS_ASN1_OCTET_STRING
:
1200 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1201 asn1_set_length(&bufptr
, valuelen
);
1202 memcpy(bufptr
, packet
->object_value
.string
.bytes
, valuelen
);
1206 case CUPS_ASN1_OID
:
1207 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1214 return ((int)(bufptr
- buffer
));
1219 * 'asn1_get_integer()' - Get an integer value.
1222 static int /* O - Integer value */
1224 unsigned char **buffer
, /* IO - Pointer in buffer */
1225 unsigned char *bufend
, /* I - End of buffer */
1226 unsigned length
) /* I - Length of value */
1228 int value
; /* Integer value */
1231 if (length
> sizeof(int))
1233 (*buffer
) += length
;
1237 for (value
= (**buffer
& 0x80) ? ~0 : 0;
1238 length
> 0 && *buffer
< bufend
;
1239 length
--, (*buffer
) ++)
1240 value
= ((value
& 0xffffff) << 8) | **buffer
;
1247 * 'asn1_get_length()' - Get a value length.
1250 static unsigned /* O - Length */
1251 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1252 unsigned char *bufend
) /* I - End of buffer */
1254 unsigned length
; /* Length */
1262 int count
; /* Number of bytes for length */
1265 if ((count
= length
& 127) > sizeof(unsigned))
1272 count
> 0 && *buffer
< bufend
;
1273 count
--, (*buffer
) ++)
1274 length
= (length
<< 8) | **buffer
;
1282 * 'asn1_get_oid()' - Get an OID value.
1285 static int /* O - Number of OIDs */
1287 unsigned char **buffer
, /* IO - Pointer in buffer */
1288 unsigned char *bufend
, /* I - End of buffer */
1289 unsigned length
, /* I - Length of value */
1290 int *oid
, /* I - OID buffer */
1291 int oidsize
) /* I - Size of OID buffer */
1293 unsigned char *valend
; /* End of value */
1294 int *oidptr
, /* Current OID */
1295 *oidend
; /* End of OID buffer */
1296 int number
; /* OID number */
1299 valend
= *buffer
+ length
;
1301 oidend
= oid
+ oidsize
- 1;
1303 if (valend
> bufend
)
1306 number
= asn1_get_packed(buffer
, bufend
);
1310 *oidptr
++ = number
/ 40;
1311 number
= number
% 40;
1321 while (*buffer
< valend
)
1323 number
= asn1_get_packed(buffer
, bufend
);
1325 if (oidptr
< oidend
)
1331 return ((int)(oidptr
- oid
));
1336 * 'asn1_get_packed()' - Get a packed integer value.
1339 static int /* O - Value */
1341 unsigned char **buffer
, /* IO - Pointer in buffer */
1342 unsigned char *bufend
) /* I - End of buffer */
1344 int value
; /* Value */
1349 while ((**buffer
& 128) && *buffer
< bufend
)
1351 value
= (value
<< 7) | (**buffer
& 127);
1355 if (*buffer
< bufend
)
1357 value
= (value
<< 7) | **buffer
;
1366 * 'asn1_get_string()' - Get a string value.
1369 static char * /* O - String */
1371 unsigned char **buffer
, /* IO - Pointer in buffer */
1372 unsigned char *bufend
, /* I - End of buffer */
1373 unsigned length
, /* I - Value length */
1374 char *string
, /* I - String buffer */
1375 size_t strsize
) /* I - String buffer size */
1377 if (length
> (unsigned)(bufend
- *buffer
))
1378 length
= (unsigned)(bufend
- *buffer
);
1380 if (length
< strsize
)
1383 * String is smaller than the buffer...
1387 memcpy(string
, *buffer
, length
);
1389 string
[length
] = '\0';
1394 * String is larger than the buffer...
1397 memcpy(string
, *buffer
, strsize
- 1);
1398 string
[strsize
- 1] = '\0';
1402 (*buffer
) += length
;
1409 * 'asn1_get_type()' - Get a value type.
1412 static int /* O - Type */
1413 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1414 unsigned char *bufend
) /* I - End of buffer */
1416 int type
; /* Type */
1422 if ((type
& 31) == 31)
1423 type
= asn1_get_packed(buffer
, bufend
);
1430 * 'asn1_set_integer()' - Set an integer value.
1434 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1435 int integer
) /* I - Integer value */
1437 **buffer
= CUPS_ASN1_INTEGER
;
1440 if (integer
> 0x7fffff || integer
< -0x800000)
1444 **buffer
= (unsigned char)(integer
>> 24);
1446 **buffer
= (unsigned char)(integer
>> 16);
1448 **buffer
= (unsigned char)(integer
>> 8);
1450 **buffer
= (unsigned char)integer
;
1453 else if (integer
> 0x7fff || integer
< -0x8000)
1457 **buffer
= (unsigned char)(integer
>> 16);
1459 **buffer
= (unsigned char)(integer
>> 8);
1461 **buffer
= (unsigned char)integer
;
1464 else if (integer
> 0x7f || integer
< -0x80)
1468 **buffer
= (unsigned char)(integer
>> 8);
1470 **buffer
= (unsigned char)integer
;
1477 **buffer
= (unsigned char)integer
;
1484 * 'asn1_set_length()' - Set a value length.
1488 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1489 unsigned length
) /* I - Length value */
1493 **buffer
= 0x82; /* 2-byte length */
1495 **buffer
= (unsigned char)(length
>> 8);
1497 **buffer
= (unsigned char)length
;
1500 else if (length
> 127)
1502 **buffer
= 0x81; /* 1-byte length */
1504 **buffer
= (unsigned char)length
;
1509 **buffer
= (unsigned char)length
; /* Length */
1516 * 'asn1_set_oid()' - Set an OID value.
1520 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1521 const int *oid
) /* I - OID value */
1523 **buffer
= CUPS_ASN1_OID
;
1526 asn1_set_length(buffer
, asn1_size_oid(oid
));
1530 asn1_set_packed(buffer
, oid
[0] * 40);
1534 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1536 for (oid
+= 2; *oid
>= 0; oid
++)
1537 asn1_set_packed(buffer
, *oid
);
1542 * 'asn1_set_packed()' - Set a packed integer value.
1546 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1547 int integer
) /* I - Integer value */
1549 if (integer
> 0xfffffff)
1551 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1555 if (integer
> 0x1fffff)
1557 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1561 if (integer
> 0x3fff)
1563 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1569 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1573 **buffer
= integer
& 0x7f;
1579 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1583 static unsigned /* O - Size in bytes */
1584 asn1_size_integer(int integer
) /* I - Integer value */
1586 if (integer
> 0x7fffff || integer
< -0x800000)
1588 else if (integer
> 0x7fff || integer
< -0x8000)
1590 else if (integer
> 0x7f || integer
< -0x80)
1598 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1602 static unsigned /* O - Size in bytes */
1603 asn1_size_length(unsigned length
) /* I - Length value */
1607 else if (length
> 0x7f)
1615 * 'asn1_size_oid()' - Figure out the number of bytes needed for an
1619 static unsigned /* O - Size in bytes */
1620 asn1_size_oid(const int *oid
) /* I - OID value */
1622 unsigned length
; /* Length of value */
1626 return (asn1_size_packed(oid
[0] * 40));
1628 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1631 length
+= asn1_size_packed(*oid
);
1638 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1639 * packed integer value.
1642 static unsigned /* O - Size in bytes */
1643 asn1_size_packed(int integer
) /* I - Integer value */
1645 if (integer
> 0xfffffff)
1647 else if (integer
> 0x1fffff)
1649 else if (integer
> 0x3fff)
1651 else if (integer
> 0x7f)
1659 * 'snmp_set_error()' - Set the localized error for a packet.
1663 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1664 const char *message
) /* I - Error message */
1666 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1669 if (!cg
->lang_default
)
1670 cg
->lang_default
= cupsLangDefault();
1672 packet
->error
= _cupsLangString(cg
->lang_default
, message
);