2 * SNMP functions for CUPS.
4 * Copyright 2007-2014 by Apple Inc.
5 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * "LICENSE" which should have been included with this file. If this
11 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * Include necessary headers.
18 #include "cups-private.h"
19 #include "snmp-private.h"
22 #endif /* HAVE_POLL */
29 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
30 size_t len
, int indent
);
31 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
33 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
35 static int asn1_get_integer(unsigned char **buffer
,
36 unsigned char *bufend
,
38 static int asn1_get_oid(unsigned char **buffer
,
39 unsigned char *bufend
,
40 unsigned length
, int *oid
, int oidsize
);
41 static int asn1_get_packed(unsigned char **buffer
,
42 unsigned char *bufend
);
43 static char *asn1_get_string(unsigned char **buffer
,
44 unsigned char *bufend
,
45 unsigned length
, char *string
,
47 static unsigned asn1_get_length(unsigned char **buffer
,
48 unsigned char *bufend
);
49 static int asn1_get_type(unsigned char **buffer
,
50 unsigned char *bufend
);
51 static void asn1_set_integer(unsigned char **buffer
,
53 static void asn1_set_length(unsigned char **buffer
,
55 static void asn1_set_oid(unsigned char **buffer
,
57 static void asn1_set_packed(unsigned char **buffer
,
59 static unsigned asn1_size_integer(int integer
);
60 static unsigned asn1_size_length(unsigned length
);
61 static unsigned asn1_size_oid(const int *oid
);
62 static unsigned asn1_size_packed(int integer
);
63 static void snmp_set_error(cups_snmp_t
*packet
,
68 * '_cupsSNMPClose()' - Close a SNMP socket.
72 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
74 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd
));
76 httpAddrClose(NULL
, fd
);
81 * '_cupsSNMPCopyOID()' - Copy an OID.
83 * The array pointed to by "src" is terminated by the value -1.
86 int * /* O - New OID */
87 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
88 const int *src
, /* I - Source OID */
89 int dstsize
) /* I - Number of integers in dst */
91 int i
; /* Looping var */
94 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst
, src
,
97 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
107 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
109 * The default community name is the first community name found in the
110 * snmp.conf file. If no community name is defined there, "public" is used.
113 const char * /* O - Default community name */
114 _cupsSNMPDefaultCommunity(void)
116 cups_file_t
*fp
; /* snmp.conf file */
117 char line
[1024], /* Line from file */
118 *value
; /* Value from file */
119 int linenum
; /* Line number in file */
120 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
123 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
125 if (!cg
->snmp_community
[0])
127 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
129 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
130 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
133 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
134 if (!_cups_strcasecmp(line
, "Community") && value
)
136 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
144 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
145 cg
->snmp_community
));
147 return (cg
->snmp_community
);
152 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
154 * The array pointed to by "oid" is terminated by the value -1.
157 int /* O - 1 if equal, 0 if not equal */
158 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
159 const int *oid
) /* I - OID */
161 int i
; /* Looping var */
165 * Range check input...
168 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet
, oid
));
172 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
182 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
184 if (oid
[i
] != packet
->object_name
[i
])
186 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
191 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
192 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
194 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
199 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
202 * The array pointed to by "prefix" is terminated by the value -1.
205 int /* O - 1 if prefixed, 0 if not prefixed */
206 _cupsSNMPIsOIDPrefixed(
207 cups_snmp_t
*packet
, /* I - Response packet */
208 const int *prefix
) /* I - OID prefix */
210 int i
; /* Looping var */
214 * Range check input...
217 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet
,
220 if (!packet
|| !prefix
)
222 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
232 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
234 if (prefix
[i
] != packet
->object_name
[i
])
236 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
241 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
242 i
< CUPS_SNMP_MAX_OID
));
244 return (i
< CUPS_SNMP_MAX_OID
);
249 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
253 char * /* O - New string or @code NULL@ on error */
254 _cupsSNMPOIDToString(const int *src
, /* I - OID */
255 char *dst
, /* I - String buffer */
256 size_t dstsize
) /* I - Size of string buffer */
258 char *dstptr
, /* Pointer into string buffer */
259 *dstend
; /* End of string buffer */
262 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")",
263 src
, dst
, CUPS_LLCAST dstsize
));
266 * Range check input...
269 if (!src
|| !dst
|| dstsize
< 4)
273 * Loop through the OID array and build a string...
276 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
277 *src
>= 0 && dstptr
< dstend
;
278 src
++, dstptr
+= strlen(dstptr
))
279 snprintf(dstptr
, (size_t)(dstend
- dstptr
+ 1), ".%d", *src
);
289 * '_cupsSNMPOpen()' - Open a SNMP socket.
292 int /* O - SNMP socket file descriptor */
293 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
295 int fd
; /* SNMP socket file descriptor */
296 int val
; /* Socket option value */
300 * Create the SNMP socket...
303 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family
));
305 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
307 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
313 * Set the "broadcast" flag...
318 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, CUPS_SOCAST
&val
, sizeof(val
)))
320 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
327 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd
));
334 * '_cupsSNMPRead()' - Read and parse a SNMP response.
336 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
340 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
341 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
342 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
343 double timeout
) /* I - Timeout in seconds */
345 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
347 ssize_t bytes
; /* Number of bytes received */
348 socklen_t addrlen
; /* Source address length */
349 http_addr_t address
; /* Source address */
353 * Range check input...
356 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd
, packet
,
359 if (fd
< 0 || !packet
)
361 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
367 * Optionally wait for a response...
372 int ready
; /* Data ready on socket? */
374 struct pollfd pfd
; /* Polled file descriptor */
379 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
380 (errno
== EINTR
|| errno
== EAGAIN
));
383 fd_set input_set
; /* select() input set */
384 struct timeval stimeout
; /* select() timeout */
389 FD_SET(fd
, &input_set
);
391 stimeout
.tv_sec
= (int)timeout
;
392 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_sec
) * 1000000);
394 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
397 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
399 while (ready
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
401 #endif /* HAVE_POLL */
404 * If we don't have any data ready, return right away...
409 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
416 * Read the response data...
419 addrlen
= sizeof(address
);
421 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
424 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno
)));
430 * Look for the response status code in the SNMP message header...
433 asn1_debug("DEBUG: IN ", buffer
, (size_t)bytes
, 0);
435 asn1_decode_snmp(buffer
, (size_t)bytes
, packet
);
437 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
440 * Return decoded data packet...
443 DEBUG_puts("5_cupsSNMPRead: Returning packet");
450 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
454 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
456 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
459 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level
));
461 cg
->snmp_debug
= level
;
466 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
468 * This function converts a string of the form ".N.N.N.N.N" to the
469 * corresponding OID array terminated by -1.
471 * @code NULL@ is returned if the array is not large enough or the string is
472 * not a valid OID number.
475 int * /* O - Pointer to OID array or @code NULL@ on error */
476 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
477 int *dst
, /* I - OID array */
478 int dstsize
)/* I - Number of integers in OID array */
480 int *dstptr
, /* Pointer into OID array */
481 *dstend
; /* End of OID array */
484 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
488 * Range check input...
491 if (!src
|| !dst
|| dstsize
< 2)
495 * Skip leading "."...
502 * Loop to the end of the string...
505 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
506 *src
&& dstptr
< dstend
;
514 else if (isdigit(*src
& 255))
515 *dstptr
= *dstptr
* 10 + *src
- '0';
524 * Terminate the end of the OID array and return...
534 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
536 * This function queries all of the OIDs with the specified OID prefix,
537 * calling the "cb" function for every response that is received.
539 * The array pointed to by "prefix" is terminated by the value -1.
541 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
545 int /* O - Number of OIDs found or -1 on error */
546 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
547 http_addr_t
*address
, /* I - Address to query */
548 int version
, /* I - SNMP version */
549 const char *community
,/* I - Community name */
550 const int *prefix
, /* I - OID prefix */
551 double timeout
, /* I - Timeout for each response in seconds */
552 cups_snmp_cb_t cb
, /* I - Function to call for each response */
553 void *data
) /* I - User data pointer that is passed to the callback function */
555 int count
= 0; /* Number of OIDs found */
556 unsigned request_id
= 0; /* Current request ID */
557 cups_snmp_t packet
; /* Current response packet */
558 int lastoid
[CUPS_SNMP_MAX_OID
];
559 /* Last OID we got */
563 * Range check input...
566 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
567 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
568 fd
, address
, version
, community
, prefix
, timeout
, cb
, data
));
570 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
573 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
579 * Copy the OID prefix and then loop until we have no more OIDs...
582 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
589 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
590 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
593 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
598 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
600 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
605 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
) ||
606 _cupsSNMPIsOID(&packet
, lastoid
))
608 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
));
613 if (packet
.error
|| packet
.error_status
)
615 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
> 0 ? count
: -1));
617 return (count
> 0 ? count
: -1);
620 _cupsSNMPCopyOID(lastoid
, packet
.object_name
, CUPS_SNMP_MAX_OID
);
624 (*cb
)(&packet
, data
);
630 * '_cupsSNMPWrite()' - Send an SNMP query packet.
632 * The array pointed to by "oid" is terminated by the value -1.
635 int /* O - 1 on success, 0 on error */
637 int fd
, /* I - SNMP socket */
638 http_addr_t
*address
, /* I - Address to send to */
639 int version
, /* I - SNMP version */
640 const char *community
, /* I - Community name */
641 cups_asn1_t request_type
, /* I - Request type */
642 const unsigned request_id
, /* I - Request ID */
643 const int *oid
) /* I - OID */
645 int i
; /* Looping var */
646 cups_snmp_t packet
; /* SNMP message packet */
647 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
648 /* SNMP message buffer */
649 ssize_t bytes
; /* Size of message */
650 http_addr_t temp
; /* Copy of address */
654 * Range check input...
657 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
658 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
659 fd
, address
, version
, community
, request_type
, request_id
, oid
));
661 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
662 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
663 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
665 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
671 * Create the SNMP message...
674 memset(&packet
, 0, sizeof(packet
));
676 packet
.version
= version
;
677 packet
.request_type
= request_type
;
678 packet
.request_id
= request_id
;
679 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
681 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
683 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
684 packet
.object_name
[i
] = oid
[i
];
685 packet
.object_name
[i
] = -1;
689 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
695 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
699 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
705 asn1_debug("DEBUG: OUT ", buffer
, (size_t)bytes
, 0);
708 * Send the message...
713 _httpAddrSetPort(&temp
, CUPS_SNMP_PORT
);
715 return (sendto(fd
, buffer
, (size_t)bytes
, 0, (void *)&temp
, (socklen_t
)httpAddrLength(&temp
)) == bytes
);
720 * 'asn1_debug()' - Decode an ASN1-encoded message.
724 asn1_debug(const char *prefix
, /* I - Prefix string */
725 unsigned char *buffer
, /* I - Buffer */
726 size_t len
, /* I - Length of buffer */
727 int indent
) /* I - Indentation */
729 size_t i
; /* Looping var */
730 unsigned char *bufend
; /* End of buffer */
731 int integer
; /* Number value */
732 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
733 char string
[CUPS_SNMP_MAX_STRING
];
735 unsigned char value_type
; /* Type of value */
736 unsigned value_length
; /* Length of value */
737 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
740 #ifdef __clang_analyzer__ /* Suppress bogus clang error */
741 memset(string
, 0, sizeof(string
));
742 #endif /* __clang_analyzer__ */
744 if (cg
->snmp_debug
<= 0)
747 if (cg
->snmp_debug
> 1 && indent
== 0)
750 * Do a hex dump of the packet...
755 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
757 for (i
= 0; i
< len
; i
+= 16)
759 fprintf(stderr
, "%s%04x:", prefix
, (unsigned)i
);
761 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
764 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
766 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
781 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
782 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
785 putc(buffer
[i
+ j
], stderr
);
792 fprintf(stderr
, "%sMessage:\n", prefix
);
794 bufend
= buffer
+ len
;
796 while (buffer
< bufend
)
802 value_type
= (unsigned char)asn1_get_type(&buffer
, bufend
);
803 value_length
= asn1_get_length(&buffer
, bufend
);
807 case CUPS_ASN1_BOOLEAN
:
808 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
810 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
811 value_length
, integer
);
814 case CUPS_ASN1_INTEGER
:
815 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
817 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
818 value_length
, integer
);
821 case CUPS_ASN1_COUNTER
:
822 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
824 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
825 value_length
, (unsigned)integer
);
828 case CUPS_ASN1_GAUGE
:
829 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
831 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
832 value_length
, (unsigned)integer
);
835 case CUPS_ASN1_TIMETICKS
:
836 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
838 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
839 value_length
, (unsigned)integer
);
842 case CUPS_ASN1_OCTET_STRING
:
843 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
844 indent
, "", value_length
,
845 asn1_get_string(&buffer
, bufend
, value_length
, string
,
849 case CUPS_ASN1_HEX_STRING
:
850 asn1_get_string(&buffer
, bufend
, value_length
, string
,
852 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
853 indent
, "", value_length
);
854 for (i
= 0; i
< value_length
; i
++)
855 fprintf(stderr
, " %02X", string
[i
] & 255);
859 case CUPS_ASN1_NULL_VALUE
:
860 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
863 buffer
+= value_length
;
867 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
870 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
872 for (i
= 0; i
< (unsigned)integer
; i
++)
873 fprintf(stderr
, ".%d", oid
[i
]);
877 case CUPS_ASN1_SEQUENCE
:
878 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
880 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
882 buffer
+= value_length
;
885 case CUPS_ASN1_GET_NEXT_REQUEST
:
886 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
887 indent
, "", value_length
);
888 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
890 buffer
+= value_length
;
893 case CUPS_ASN1_GET_REQUEST
:
894 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
896 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
898 buffer
+= value_length
;
901 case CUPS_ASN1_GET_RESPONSE
:
902 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
904 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
906 buffer
+= value_length
;
910 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
911 value_type
, value_length
);
913 buffer
+= value_length
;
921 * 'asn1_decode_snmp()' - Decode a SNMP packet.
924 static int /* O - 0 on success, -1 on error */
925 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
926 size_t len
, /* I - Size of buffer */
927 cups_snmp_t
*packet
) /* I - SNMP packet */
929 unsigned char *bufptr
, /* Pointer into the data */
930 *bufend
; /* End of data */
931 unsigned length
; /* Length of value */
935 * Initialize the decoding...
938 memset(packet
, 0, sizeof(cups_snmp_t
));
939 packet
->object_name
[0] = -1;
942 bufend
= buffer
+ len
;
944 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
945 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
946 else if (asn1_get_length(&bufptr
, bufend
) == 0)
947 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
948 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
949 snmp_set_error(packet
, _("No version number"));
950 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
951 snmp_set_error(packet
, _("Version uses indefinite length"));
952 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
953 != CUPS_SNMP_VERSION_1
)
954 snmp_set_error(packet
, _("Bad SNMP version number"));
955 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
956 snmp_set_error(packet
, _("No community name"));
957 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
958 snmp_set_error(packet
, _("Community name uses indefinite length"));
961 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
962 sizeof(packet
->community
));
964 if ((packet
->request_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
))
965 != CUPS_ASN1_GET_RESPONSE
)
966 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
967 else if (asn1_get_length(&bufptr
, bufend
) == 0)
968 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
969 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
970 snmp_set_error(packet
, _("No request-id"));
971 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
972 snmp_set_error(packet
, _("request-id uses indefinite length"));
975 packet
->request_id
= (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
977 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
978 snmp_set_error(packet
, _("No error-status"));
979 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
980 snmp_set_error(packet
, _("error-status uses indefinite length"));
983 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
985 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
986 snmp_set_error(packet
, _("No error-index"));
987 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
988 snmp_set_error(packet
, _("error-index uses indefinite length"));
991 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
993 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
994 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
995 else if (asn1_get_length(&bufptr
, bufend
) == 0)
996 snmp_set_error(packet
,
997 _("variable-bindings uses indefinite length"));
998 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
999 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
1000 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1001 snmp_set_error(packet
, _("VarBind uses indefinite length"));
1002 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1003 snmp_set_error(packet
, _("No name OID"));
1004 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1005 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1008 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1011 packet
->object_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
);
1013 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1014 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1015 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1016 snmp_set_error(packet
, _("Value uses indefinite length"));
1019 switch (packet
->object_type
)
1021 case CUPS_ASN1_BOOLEAN
:
1022 packet
->object_value
.boolean
=
1023 asn1_get_integer(&bufptr
, bufend
, length
);
1026 case CUPS_ASN1_INTEGER
:
1027 packet
->object_value
.integer
=
1028 asn1_get_integer(&bufptr
, bufend
, length
);
1031 case CUPS_ASN1_NULL_VALUE
:
1034 case CUPS_ASN1_OCTET_STRING
:
1035 case CUPS_ASN1_BIT_STRING
:
1036 case CUPS_ASN1_HEX_STRING
:
1037 packet
->object_value
.string
.num_bytes
= length
;
1038 asn1_get_string(&bufptr
, bufend
, length
,
1039 (char *)packet
->object_value
.string
.bytes
,
1040 sizeof(packet
->object_value
.string
.bytes
));
1043 case CUPS_ASN1_OID
:
1044 asn1_get_oid(&bufptr
, bufend
, length
,
1045 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1048 case CUPS_ASN1_COUNTER
:
1049 packet
->object_value
.counter
=
1050 asn1_get_integer(&bufptr
, bufend
, length
);
1053 case CUPS_ASN1_GAUGE
:
1054 packet
->object_value
.gauge
=
1055 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1058 case CUPS_ASN1_TIMETICKS
:
1059 packet
->object_value
.timeticks
=
1060 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1064 snmp_set_error(packet
, _("Unsupported value type"));
1074 return (packet
->error
? -1 : 0);
1079 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1082 static int /* O - Length on success, -1 on error */
1083 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1084 size_t bufsize
, /* I - Size of buffer */
1085 cups_snmp_t
*packet
) /* I - SNMP packet */
1087 unsigned char *bufptr
; /* Pointer into buffer */
1088 unsigned total
, /* Total length */
1089 msglen
, /* Length of entire message */
1090 commlen
, /* Length of community string */
1091 reqlen
, /* Length of request */
1092 listlen
, /* Length of variable list */
1093 varlen
, /* Length of variable */
1094 namelen
, /* Length of object name OID */
1095 valuelen
; /* Length of object value */
1099 * Get the lengths of the community string, OID, and message...
1103 namelen
= asn1_size_oid(packet
->object_name
);
1105 switch (packet
->object_type
)
1107 case CUPS_ASN1_NULL_VALUE
:
1111 case CUPS_ASN1_BOOLEAN
:
1112 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1115 case CUPS_ASN1_INTEGER
:
1116 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1119 case CUPS_ASN1_OCTET_STRING
:
1120 valuelen
= packet
->object_value
.string
.num_bytes
;
1123 case CUPS_ASN1_OID
:
1124 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1128 packet
->error
= "Unknown object type";
1132 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1133 1 + asn1_size_length(valuelen
) + valuelen
;
1134 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1135 reqlen
= 2 + asn1_size_integer((int)packet
->request_id
) +
1136 2 + asn1_size_integer(packet
->error_status
) +
1137 2 + asn1_size_integer(packet
->error_index
) +
1138 1 + asn1_size_length(listlen
) + listlen
;
1139 commlen
= (unsigned)strlen(packet
->community
);
1140 msglen
= 2 + asn1_size_integer(packet
->version
) +
1141 1 + asn1_size_length(commlen
) + commlen
+
1142 1 + asn1_size_length(reqlen
) + reqlen
;
1143 total
= 1 + asn1_size_length(msglen
) + msglen
;
1145 if (total
> bufsize
)
1147 packet
->error
= "Message too large for buffer";
1152 * Then format the message...
1157 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1158 asn1_set_length(&bufptr
, msglen
);
1160 asn1_set_integer(&bufptr
, packet
->version
);
1163 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1164 asn1_set_length(&bufptr
, commlen
);
1165 memcpy(bufptr
, packet
->community
, commlen
);
1168 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1169 asn1_set_length(&bufptr
, reqlen
);
1171 asn1_set_integer(&bufptr
, (int)packet
->request_id
);
1173 asn1_set_integer(&bufptr
, packet
->error_status
);
1175 asn1_set_integer(&bufptr
, packet
->error_index
);
1177 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1178 asn1_set_length(&bufptr
, listlen
);
1180 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1181 asn1_set_length(&bufptr
, varlen
);
1183 asn1_set_oid(&bufptr
, packet
->object_name
);
1186 switch (packet
->object_type
)
1188 case CUPS_ASN1_NULL_VALUE
:
1189 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1191 *bufptr
++ = 0; /* Length */
1194 case CUPS_ASN1_BOOLEAN
:
1195 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1198 case CUPS_ASN1_INTEGER
:
1199 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1202 case CUPS_ASN1_OCTET_STRING
:
1203 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1204 asn1_set_length(&bufptr
, valuelen
);
1205 memcpy(bufptr
, packet
->object_value
.string
.bytes
, valuelen
);
1209 case CUPS_ASN1_OID
:
1210 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1217 return ((int)(bufptr
- buffer
));
1222 * 'asn1_get_integer()' - Get an integer value.
1225 static int /* O - Integer value */
1227 unsigned char **buffer
, /* IO - Pointer in buffer */
1228 unsigned char *bufend
, /* I - End of buffer */
1229 unsigned length
) /* I - Length of value */
1231 int value
; /* Integer value */
1234 if (length
> sizeof(int))
1236 (*buffer
) += length
;
1240 for (value
= (**buffer
& 0x80) ? -1 : 0;
1241 length
> 0 && *buffer
< bufend
;
1242 length
--, (*buffer
) ++)
1243 value
= (value
<< 8) | **buffer
;
1250 * 'asn1_get_length()' - Get a value length.
1253 static unsigned /* O - Length */
1254 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1255 unsigned char *bufend
) /* I - End of buffer */
1257 unsigned length
; /* Length */
1265 int count
; /* Number of bytes for length */
1268 if ((count
= length
& 127) > sizeof(unsigned))
1275 count
> 0 && *buffer
< bufend
;
1276 count
--, (*buffer
) ++)
1277 length
= (length
<< 8) | **buffer
;
1285 * 'asn1_get_oid()' - Get an OID value.
1288 static int /* O - Number of OIDs */
1290 unsigned char **buffer
, /* IO - Pointer in buffer */
1291 unsigned char *bufend
, /* I - End of buffer */
1292 unsigned length
, /* I - Length of value */
1293 int *oid
, /* I - OID buffer */
1294 int oidsize
) /* I - Size of OID buffer */
1296 unsigned char *valend
; /* End of value */
1297 int *oidptr
, /* Current OID */
1298 *oidend
; /* End of OID buffer */
1299 int number
; /* OID number */
1302 valend
= *buffer
+ length
;
1304 oidend
= oid
+ oidsize
- 1;
1306 if (valend
> bufend
)
1309 number
= asn1_get_packed(buffer
, bufend
);
1313 *oidptr
++ = number
/ 40;
1314 number
= number
% 40;
1324 while (*buffer
< valend
)
1326 number
= asn1_get_packed(buffer
, bufend
);
1328 if (oidptr
< oidend
)
1334 return ((int)(oidptr
- oid
));
1339 * 'asn1_get_packed()' - Get a packed integer value.
1342 static int /* O - Value */
1344 unsigned char **buffer
, /* IO - Pointer in buffer */
1345 unsigned char *bufend
) /* I - End of buffer */
1347 int value
; /* Value */
1352 while ((**buffer
& 128) && *buffer
< bufend
)
1354 value
= (value
<< 7) | (**buffer
& 127);
1358 if (*buffer
< bufend
)
1360 value
= (value
<< 7) | **buffer
;
1369 * 'asn1_get_string()' - Get a string value.
1372 static char * /* O - String */
1374 unsigned char **buffer
, /* IO - Pointer in buffer */
1375 unsigned char *bufend
, /* I - End of buffer */
1376 unsigned length
, /* I - Value length */
1377 char *string
, /* I - String buffer */
1378 size_t strsize
) /* I - String buffer size */
1380 if (length
> (unsigned)(bufend
- *buffer
))
1381 length
= (unsigned)(bufend
- *buffer
);
1383 if (length
< strsize
)
1386 * String is smaller than the buffer...
1390 memcpy(string
, *buffer
, length
);
1392 string
[length
] = '\0';
1397 * String is larger than the buffer...
1400 memcpy(string
, *buffer
, strsize
- 1);
1401 string
[strsize
- 1] = '\0';
1405 (*buffer
) += length
;
1412 * 'asn1_get_type()' - Get a value type.
1415 static int /* O - Type */
1416 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1417 unsigned char *bufend
) /* I - End of buffer */
1419 int type
; /* Type */
1425 if ((type
& 31) == 31)
1426 type
= asn1_get_packed(buffer
, bufend
);
1433 * 'asn1_set_integer()' - Set an integer value.
1437 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1438 int integer
) /* I - Integer value */
1440 **buffer
= CUPS_ASN1_INTEGER
;
1443 if (integer
> 0x7fffff || integer
< -0x800000)
1447 **buffer
= (unsigned char)(integer
>> 24);
1449 **buffer
= (unsigned char)(integer
>> 16);
1451 **buffer
= (unsigned char)(integer
>> 8);
1453 **buffer
= (unsigned char)integer
;
1456 else if (integer
> 0x7fff || integer
< -0x8000)
1460 **buffer
= (unsigned char)(integer
>> 16);
1462 **buffer
= (unsigned char)(integer
>> 8);
1464 **buffer
= (unsigned char)integer
;
1467 else if (integer
> 0x7f || integer
< -0x80)
1471 **buffer
= (unsigned char)(integer
>> 8);
1473 **buffer
= (unsigned char)integer
;
1480 **buffer
= (unsigned char)integer
;
1487 * 'asn1_set_length()' - Set a value length.
1491 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1492 unsigned length
) /* I - Length value */
1496 **buffer
= 0x82; /* 2-byte length */
1498 **buffer
= (unsigned char)(length
>> 8);
1500 **buffer
= (unsigned char)length
;
1503 else if (length
> 127)
1505 **buffer
= 0x81; /* 1-byte length */
1507 **buffer
= (unsigned char)length
;
1512 **buffer
= (unsigned char)length
; /* Length */
1519 * 'asn1_set_oid()' - Set an OID value.
1523 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1524 const int *oid
) /* I - OID value */
1526 **buffer
= CUPS_ASN1_OID
;
1529 asn1_set_length(buffer
, asn1_size_oid(oid
));
1533 asn1_set_packed(buffer
, oid
[0] * 40);
1537 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1539 for (oid
+= 2; *oid
>= 0; oid
++)
1540 asn1_set_packed(buffer
, *oid
);
1545 * 'asn1_set_packed()' - Set a packed integer value.
1549 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1550 int integer
) /* I - Integer value */
1552 if (integer
> 0xfffffff)
1554 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1558 if (integer
> 0x1fffff)
1560 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1564 if (integer
> 0x3fff)
1566 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1572 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1576 **buffer
= integer
& 0x7f;
1582 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1586 static unsigned /* O - Size in bytes */
1587 asn1_size_integer(int integer
) /* I - Integer value */
1589 if (integer
> 0x7fffff || integer
< -0x800000)
1591 else if (integer
> 0x7fff || integer
< -0x8000)
1593 else if (integer
> 0x7f || integer
< -0x80)
1601 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1605 static unsigned /* O - Size in bytes */
1606 asn1_size_length(unsigned length
) /* I - Length value */
1610 else if (length
> 0x7f)
1618 * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
1622 static unsigned /* O - Size in bytes */
1623 asn1_size_oid(const int *oid
) /* I - OID value */
1625 unsigned length
; /* Length of value */
1629 return (asn1_size_packed(oid
[0] * 40));
1631 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1634 length
+= asn1_size_packed(*oid
);
1641 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1642 * packed integer value.
1645 static unsigned /* O - Size in bytes */
1646 asn1_size_packed(int integer
) /* I - Integer value */
1648 if (integer
> 0xfffffff)
1650 else if (integer
> 0x1fffff)
1652 else if (integer
> 0x3fff)
1654 else if (integer
> 0x7f)
1662 * 'snmp_set_error()' - Set the localized error for a packet.
1666 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1667 const char *message
) /* I - Error message */
1669 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1672 if (!cg
->lang_default
)
1673 cg
->lang_default
= cupsLangDefault();
1675 packet
->error
= _cupsLangString(cg
->lang_default
, message
);