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/".
13 * This file is subject to the Apple OS-Developed Software exception.
17 * Include necessary headers.
20 #include "cups-private.h"
21 #include "snmp-private.h"
24 #endif /* HAVE_POLL */
31 static void asn1_debug(const char *prefix
, unsigned char *buffer
,
32 size_t len
, int indent
);
33 static int asn1_decode_snmp(unsigned char *buffer
, size_t len
,
35 static int asn1_encode_snmp(unsigned char *buffer
, size_t len
,
37 static int asn1_get_integer(unsigned char **buffer
,
38 unsigned char *bufend
,
40 static int asn1_get_oid(unsigned char **buffer
,
41 unsigned char *bufend
,
42 unsigned length
, int *oid
, int oidsize
);
43 static int asn1_get_packed(unsigned char **buffer
,
44 unsigned char *bufend
);
45 static char *asn1_get_string(unsigned char **buffer
,
46 unsigned char *bufend
,
47 unsigned length
, char *string
,
49 static unsigned asn1_get_length(unsigned char **buffer
,
50 unsigned char *bufend
);
51 static int asn1_get_type(unsigned char **buffer
,
52 unsigned char *bufend
);
53 static void asn1_set_integer(unsigned char **buffer
,
55 static void asn1_set_length(unsigned char **buffer
,
57 static void asn1_set_oid(unsigned char **buffer
,
59 static void asn1_set_packed(unsigned char **buffer
,
61 static unsigned asn1_size_integer(int integer
);
62 static unsigned asn1_size_length(unsigned length
);
63 static unsigned asn1_size_oid(const int *oid
);
64 static unsigned asn1_size_packed(int integer
);
65 static void snmp_set_error(cups_snmp_t
*packet
,
70 * '_cupsSNMPClose()' - Close a SNMP socket.
74 _cupsSNMPClose(int fd
) /* I - SNMP socket file descriptor */
76 DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd
));
78 httpAddrClose(NULL
, fd
);
83 * '_cupsSNMPCopyOID()' - Copy an OID.
85 * The array pointed to by "src" is terminated by the value -1.
88 int * /* O - New OID */
89 _cupsSNMPCopyOID(int *dst
, /* I - Destination OID */
90 const int *src
, /* I - Source OID */
91 int dstsize
) /* I - Number of integers in dst */
93 int i
; /* Looping var */
96 DEBUG_printf(("4_cupsSNMPCopyOID(dst=%p, src=%p, dstsize=%d)", dst
, src
,
99 for (i
= 0, dstsize
--; src
[i
] >= 0 && i
< dstsize
; i
++)
109 * '_cupsSNMPDefaultCommunity()' - Get the default SNMP community name.
111 * The default community name is the first community name found in the
112 * snmp.conf file. If no community name is defined there, "public" is used.
115 const char * /* O - Default community name */
116 _cupsSNMPDefaultCommunity(void)
118 cups_file_t
*fp
; /* snmp.conf file */
119 char line
[1024], /* Line from file */
120 *value
; /* Value from file */
121 int linenum
; /* Line number in file */
122 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
125 DEBUG_puts("4_cupsSNMPDefaultCommunity()");
127 if (!cg
->snmp_community
[0])
129 strlcpy(cg
->snmp_community
, "public", sizeof(cg
->snmp_community
));
131 snprintf(line
, sizeof(line
), "%s/snmp.conf", cg
->cups_serverroot
);
132 if ((fp
= cupsFileOpen(line
, "r")) != NULL
)
135 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
136 if (!_cups_strcasecmp(line
, "Community") && value
)
138 strlcpy(cg
->snmp_community
, value
, sizeof(cg
->snmp_community
));
146 DEBUG_printf(("5_cupsSNMPDefaultCommunity: Returning \"%s\"",
147 cg
->snmp_community
));
149 return (cg
->snmp_community
);
154 * '_cupsSNMPIsOID()' - Test whether a SNMP response contains the specified OID.
156 * The array pointed to by "oid" is terminated by the value -1.
159 int /* O - 1 if equal, 0 if not equal */
160 _cupsSNMPIsOID(cups_snmp_t
*packet
, /* I - Response packet */
161 const int *oid
) /* I - OID */
163 int i
; /* Looping var */
167 * Range check input...
170 DEBUG_printf(("4_cupsSNMPIsOID(packet=%p, oid=%p)", packet
, oid
));
174 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
184 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] >= 0 && packet
->object_name
[i
] >= 0;
186 if (oid
[i
] != packet
->object_name
[i
])
188 DEBUG_puts("5_cupsSNMPIsOID: Returning 0");
193 DEBUG_printf(("5_cupsSNMPIsOID: Returning %d",
194 i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]));
196 return (i
< CUPS_SNMP_MAX_OID
&& oid
[i
] == packet
->object_name
[i
]);
201 * '_cupsSNMPIsOIDPrefixed()' - Test whether a SNMP response uses the specified
204 * The array pointed to by "prefix" is terminated by the value -1.
207 int /* O - 1 if prefixed, 0 if not prefixed */
208 _cupsSNMPIsOIDPrefixed(
209 cups_snmp_t
*packet
, /* I - Response packet */
210 const int *prefix
) /* I - OID prefix */
212 int i
; /* Looping var */
216 * Range check input...
219 DEBUG_printf(("4_cupsSNMPIsOIDPrefixed(packet=%p, prefix=%p)", packet
,
222 if (!packet
|| !prefix
)
224 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
234 i
< CUPS_SNMP_MAX_OID
&& prefix
[i
] >= 0 && packet
->object_name
[i
] >= 0;
236 if (prefix
[i
] != packet
->object_name
[i
])
238 DEBUG_puts("5_cupsSNMPIsOIDPrefixed: Returning 0");
243 DEBUG_printf(("5_cupsSNMPIsOIDPrefixed: Returning %d",
244 i
< CUPS_SNMP_MAX_OID
));
246 return (i
< CUPS_SNMP_MAX_OID
);
251 * '_cupsSNMPOIDToString()' - Convert an OID to a string.
255 char * /* O - New string or @code NULL@ on error */
256 _cupsSNMPOIDToString(const int *src
, /* I - OID */
257 char *dst
, /* I - String buffer */
258 size_t dstsize
) /* I - Size of string buffer */
260 char *dstptr
, /* Pointer into string buffer */
261 *dstend
; /* End of string buffer */
264 DEBUG_printf(("4_cupsSNMPOIDToString(src=%p, dst=%p, dstsize=" CUPS_LLFMT
")",
265 src
, dst
, CUPS_LLCAST dstsize
));
268 * Range check input...
271 if (!src
|| !dst
|| dstsize
< 4)
275 * Loop through the OID array and build a string...
278 for (dstptr
= dst
, dstend
= dstptr
+ dstsize
- 1;
279 *src
>= 0 && dstptr
< dstend
;
280 src
++, dstptr
+= strlen(dstptr
))
281 snprintf(dstptr
, (size_t)(dstend
- dstptr
+ 1), ".%d", *src
);
291 * '_cupsSNMPOpen()' - Open a SNMP socket.
294 int /* O - SNMP socket file descriptor */
295 _cupsSNMPOpen(int family
) /* I - Address family - @code AF_INET@ or @code AF_INET6@ */
297 int fd
; /* SNMP socket file descriptor */
298 int val
; /* Socket option value */
302 * Create the SNMP socket...
305 DEBUG_printf(("4_cupsSNMPOpen(family=%d)", family
));
307 if ((fd
= socket(family
, SOCK_DGRAM
, 0)) < 0)
309 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
315 * Set the "broadcast" flag...
320 if (setsockopt(fd
, SOL_SOCKET
, SO_BROADCAST
, CUPS_SOCAST
&val
, sizeof(val
)))
322 DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno
)));
329 DEBUG_printf(("5_cupsSNMPOpen: Returning %d", fd
));
336 * '_cupsSNMPRead()' - Read and parse a SNMP response.
338 * If "timeout" is negative, @code _cupsSNMPRead@ will wait for a response
342 cups_snmp_t
* /* O - SNMP packet or @code NULL@ if none */
343 _cupsSNMPRead(int fd
, /* I - SNMP socket file descriptor */
344 cups_snmp_t
*packet
, /* I - SNMP packet buffer */
345 double timeout
) /* I - Timeout in seconds */
347 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
349 ssize_t bytes
; /* Number of bytes received */
350 socklen_t addrlen
; /* Source address length */
351 http_addr_t address
; /* Source address */
355 * Range check input...
358 DEBUG_printf(("4_cupsSNMPRead(fd=%d, packet=%p, timeout=%.1f)", fd
, packet
,
361 if (fd
< 0 || !packet
)
363 DEBUG_puts("5_cupsSNMPRead: Returning NULL");
369 * Optionally wait for a response...
374 int ready
; /* Data ready on socket? */
376 struct pollfd pfd
; /* Polled file descriptor */
381 while ((ready
= poll(&pfd
, 1, (int)(timeout
* 1000.0))) < 0 &&
382 (errno
== EINTR
|| errno
== EAGAIN
));
385 fd_set input_set
; /* select() input set */
386 struct timeval stimeout
; /* select() timeout */
391 FD_SET(fd
, &input_set
);
393 stimeout
.tv_sec
= (int)timeout
;
394 stimeout
.tv_usec
= (int)((timeout
- stimeout
.tv_sec
) * 1000000);
396 ready
= select(fd
+ 1, &input_set
, NULL
, NULL
, &stimeout
);
399 while (ready
< 0 && WSAGetLastError() == WSAEINTR
);
401 while (ready
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
403 #endif /* HAVE_POLL */
406 * If we don't have any data ready, return right away...
411 DEBUG_puts("5_cupsSNMPRead: Returning NULL (timeout)");
418 * Read the response data...
421 addrlen
= sizeof(address
);
423 if ((bytes
= recvfrom(fd
, buffer
, sizeof(buffer
), 0, (void *)&address
,
426 DEBUG_printf(("5_cupsSNMPRead: Returning NULL (%s)", strerror(errno
)));
432 * Look for the response status code in the SNMP message header...
435 asn1_debug("DEBUG: IN ", buffer
, (size_t)bytes
, 0);
437 asn1_decode_snmp(buffer
, (size_t)bytes
, packet
);
439 memcpy(&(packet
->address
), &address
, sizeof(packet
->address
));
442 * Return decoded data packet...
445 DEBUG_puts("5_cupsSNMPRead: Returning packet");
452 * '_cupsSNMPSetDebug()' - Enable/disable debug logging to stderr.
456 _cupsSNMPSetDebug(int level
) /* I - 1 to enable debug output, 0 otherwise */
458 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
461 DEBUG_printf(("4_cupsSNMPSetDebug(level=%d)", level
));
463 cg
->snmp_debug
= level
;
468 * '_cupsSNMPStringToOID()' - Convert a numeric OID string to an OID array.
470 * This function converts a string of the form ".N.N.N.N.N" to the
471 * corresponding OID array terminated by -1.
473 * @code NULL@ is returned if the array is not large enough or the string is
474 * not a valid OID number.
477 int * /* O - Pointer to OID array or @code NULL@ on error */
478 _cupsSNMPStringToOID(const char *src
, /* I - OID string */
479 int *dst
, /* I - OID array */
480 int dstsize
)/* I - Number of integers in OID array */
482 int *dstptr
, /* Pointer into OID array */
483 *dstend
; /* End of OID array */
486 DEBUG_printf(("4_cupsSNMPStringToOID(src=\"%s\", dst=%p, dstsize=%d)",
490 * Range check input...
493 if (!src
|| !dst
|| dstsize
< 2)
497 * Skip leading "."...
504 * Loop to the end of the string...
507 for (dstend
= dst
+ dstsize
- 1, dstptr
= dst
, *dstptr
= 0;
508 *src
&& dstptr
< dstend
;
516 else if (isdigit(*src
& 255))
517 *dstptr
= *dstptr
* 10 + *src
- '0';
526 * Terminate the end of the OID array and return...
536 * '_cupsSNMPWalk()' - Enumerate a group of OIDs.
538 * This function queries all of the OIDs with the specified OID prefix,
539 * calling the "cb" function for every response that is received.
541 * The array pointed to by "prefix" is terminated by the value -1.
543 * If "timeout" is negative, @code _cupsSNMPWalk@ will wait for a response
547 int /* O - Number of OIDs found or -1 on error */
548 _cupsSNMPWalk(int fd
, /* I - SNMP socket */
549 http_addr_t
*address
, /* I - Address to query */
550 int version
, /* I - SNMP version */
551 const char *community
,/* I - Community name */
552 const int *prefix
, /* I - OID prefix */
553 double timeout
, /* I - Timeout for each response in seconds */
554 cups_snmp_cb_t cb
, /* I - Function to call for each response */
555 void *data
) /* I - User data pointer that is passed to the callback function */
557 int count
= 0; /* Number of OIDs found */
558 unsigned request_id
= 0; /* Current request ID */
559 cups_snmp_t packet
; /* Current response packet */
560 int lastoid
[CUPS_SNMP_MAX_OID
];
561 /* Last OID we got */
565 * Range check input...
568 DEBUG_printf(("4_cupsSNMPWalk(fd=%d, address=%p, version=%d, "
569 "community=\"%s\", prefix=%p, timeout=%.1f, cb=%p, data=%p)",
570 fd
, address
, version
, community
, prefix
, timeout
, cb
, data
));
572 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
575 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
581 * Copy the OID prefix and then loop until we have no more OIDs...
584 _cupsSNMPCopyOID(packet
.object_name
, prefix
, CUPS_SNMP_MAX_OID
);
591 if (!_cupsSNMPWrite(fd
, address
, version
, community
,
592 CUPS_ASN1_GET_NEXT_REQUEST
, request_id
,
595 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
600 if (!_cupsSNMPRead(fd
, &packet
, timeout
))
602 DEBUG_puts("5_cupsSNMPWalk: Returning -1");
607 if (!_cupsSNMPIsOIDPrefixed(&packet
, prefix
) ||
608 _cupsSNMPIsOID(&packet
, lastoid
))
610 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
));
615 if (packet
.error
|| packet
.error_status
)
617 DEBUG_printf(("5_cupsSNMPWalk: Returning %d", count
> 0 ? count
: -1));
619 return (count
> 0 ? count
: -1);
622 _cupsSNMPCopyOID(lastoid
, packet
.object_name
, CUPS_SNMP_MAX_OID
);
626 (*cb
)(&packet
, data
);
632 * '_cupsSNMPWrite()' - Send an SNMP query packet.
634 * The array pointed to by "oid" is terminated by the value -1.
637 int /* O - 1 on success, 0 on error */
639 int fd
, /* I - SNMP socket */
640 http_addr_t
*address
, /* I - Address to send to */
641 int version
, /* I - SNMP version */
642 const char *community
, /* I - Community name */
643 cups_asn1_t request_type
, /* I - Request type */
644 const unsigned request_id
, /* I - Request ID */
645 const int *oid
) /* I - OID */
647 int i
; /* Looping var */
648 cups_snmp_t packet
; /* SNMP message packet */
649 unsigned char buffer
[CUPS_SNMP_MAX_PACKET
];
650 /* SNMP message buffer */
651 ssize_t bytes
; /* Size of message */
652 http_addr_t temp
; /* Copy of address */
656 * Range check input...
659 DEBUG_printf(("4_cupsSNMPWrite(fd=%d, address=%p, version=%d, "
660 "community=\"%s\", request_type=%d, request_id=%u, oid=%p)",
661 fd
, address
, version
, community
, request_type
, request_id
, oid
));
663 if (fd
< 0 || !address
|| version
!= CUPS_SNMP_VERSION_1
|| !community
||
664 (request_type
!= CUPS_ASN1_GET_REQUEST
&&
665 request_type
!= CUPS_ASN1_GET_NEXT_REQUEST
) || request_id
< 1 || !oid
)
667 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (bad arguments)");
673 * Create the SNMP message...
676 memset(&packet
, 0, sizeof(packet
));
678 packet
.version
= version
;
679 packet
.request_type
= request_type
;
680 packet
.request_id
= request_id
;
681 packet
.object_type
= CUPS_ASN1_NULL_VALUE
;
683 strlcpy(packet
.community
, community
, sizeof(packet
.community
));
685 for (i
= 0; oid
[i
] >= 0 && i
< (CUPS_SNMP_MAX_OID
- 1); i
++)
686 packet
.object_name
[i
] = oid
[i
];
687 packet
.object_name
[i
] = -1;
691 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (OID too big)");
697 bytes
= asn1_encode_snmp(buffer
, sizeof(buffer
), &packet
);
701 DEBUG_puts("5_cupsSNMPWrite: Returning 0 (request too big)");
707 asn1_debug("DEBUG: OUT ", buffer
, (size_t)bytes
, 0);
710 * Send the message...
715 _httpAddrSetPort(&temp
, CUPS_SNMP_PORT
);
717 return (sendto(fd
, buffer
, (size_t)bytes
, 0, (void *)&temp
, (socklen_t
)httpAddrLength(&temp
)) == bytes
);
722 * 'asn1_debug()' - Decode an ASN1-encoded message.
726 asn1_debug(const char *prefix
, /* I - Prefix string */
727 unsigned char *buffer
, /* I - Buffer */
728 size_t len
, /* I - Length of buffer */
729 int indent
) /* I - Indentation */
731 size_t i
; /* Looping var */
732 unsigned char *bufend
; /* End of buffer */
733 int integer
; /* Number value */
734 int oid
[CUPS_SNMP_MAX_OID
]; /* OID value */
735 char string
[CUPS_SNMP_MAX_STRING
];
737 unsigned char value_type
; /* Type of value */
738 unsigned value_length
; /* Length of value */
739 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
742 #ifdef __clang_analyzer__ /* Suppress bogus clang error */
743 memset(string
, 0, sizeof(string
));
744 #endif /* __clang_analyzer__ */
746 if (cg
->snmp_debug
<= 0)
749 if (cg
->snmp_debug
> 1 && indent
== 0)
752 * Do a hex dump of the packet...
757 fprintf(stderr
, "%sHex Dump (%d bytes):\n", prefix
, (int)len
);
759 for (i
= 0; i
< len
; i
+= 16)
761 fprintf(stderr
, "%s%04x:", prefix
, (unsigned)i
);
763 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
766 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
768 fprintf(stderr
, " %02x", buffer
[i
+ j
]);
783 for (j
= 0; j
< 16 && (i
+ j
) < len
; j
++)
784 if (buffer
[i
+ j
] < ' ' || buffer
[i
+ j
] >= 0x7f)
787 putc(buffer
[i
+ j
], stderr
);
794 fprintf(stderr
, "%sMessage:\n", prefix
);
796 bufend
= buffer
+ len
;
798 while (buffer
< bufend
)
804 value_type
= (unsigned char)asn1_get_type(&buffer
, bufend
);
805 value_length
= asn1_get_length(&buffer
, bufend
);
809 case CUPS_ASN1_BOOLEAN
:
810 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
812 fprintf(stderr
, "%s%*sBOOLEAN %d bytes %d\n", prefix
, indent
, "",
813 value_length
, integer
);
816 case CUPS_ASN1_INTEGER
:
817 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
819 fprintf(stderr
, "%s%*sINTEGER %d bytes %d\n", prefix
, indent
, "",
820 value_length
, integer
);
823 case CUPS_ASN1_COUNTER
:
824 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
826 fprintf(stderr
, "%s%*sCOUNTER %d bytes %u\n", prefix
, indent
, "",
827 value_length
, (unsigned)integer
);
830 case CUPS_ASN1_GAUGE
:
831 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
833 fprintf(stderr
, "%s%*sGAUGE %d bytes %u\n", prefix
, indent
, "",
834 value_length
, (unsigned)integer
);
837 case CUPS_ASN1_TIMETICKS
:
838 integer
= asn1_get_integer(&buffer
, bufend
, value_length
);
840 fprintf(stderr
, "%s%*sTIMETICKS %d bytes %u\n", prefix
, indent
, "",
841 value_length
, (unsigned)integer
);
844 case CUPS_ASN1_OCTET_STRING
:
845 fprintf(stderr
, "%s%*sOCTET STRING %d bytes \"%s\"\n", prefix
,
846 indent
, "", value_length
,
847 asn1_get_string(&buffer
, bufend
, value_length
, string
,
851 case CUPS_ASN1_HEX_STRING
:
852 asn1_get_string(&buffer
, bufend
, value_length
, string
,
854 fprintf(stderr
, "%s%*sHex-STRING %d bytes", prefix
,
855 indent
, "", value_length
);
856 for (i
= 0; i
< value_length
; i
++)
857 fprintf(stderr
, " %02X", string
[i
] & 255);
861 case CUPS_ASN1_NULL_VALUE
:
862 fprintf(stderr
, "%s%*sNULL VALUE %d bytes\n", prefix
, indent
, "",
865 buffer
+= value_length
;
869 integer
= asn1_get_oid(&buffer
, bufend
, value_length
, oid
,
872 fprintf(stderr
, "%s%*sOID %d bytes ", prefix
, indent
, "",
874 for (i
= 0; i
< (unsigned)integer
; i
++)
875 fprintf(stderr
, ".%d", oid
[i
]);
879 case CUPS_ASN1_SEQUENCE
:
880 fprintf(stderr
, "%s%*sSEQUENCE %d bytes\n", prefix
, indent
, "",
882 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
884 buffer
+= value_length
;
887 case CUPS_ASN1_GET_NEXT_REQUEST
:
888 fprintf(stderr
, "%s%*sGet-Next-Request-PDU %d bytes\n", prefix
,
889 indent
, "", value_length
);
890 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
892 buffer
+= value_length
;
895 case CUPS_ASN1_GET_REQUEST
:
896 fprintf(stderr
, "%s%*sGet-Request-PDU %d bytes\n", prefix
, indent
, "",
898 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
900 buffer
+= value_length
;
903 case CUPS_ASN1_GET_RESPONSE
:
904 fprintf(stderr
, "%s%*sGet-Response-PDU %d bytes\n", prefix
, indent
,
906 asn1_debug(prefix
, buffer
, value_length
, indent
+ 4);
908 buffer
+= value_length
;
912 fprintf(stderr
, "%s%*sUNKNOWN(%x) %d bytes\n", prefix
, indent
, "",
913 value_type
, value_length
);
915 buffer
+= value_length
;
923 * 'asn1_decode_snmp()' - Decode a SNMP packet.
926 static int /* O - 0 on success, -1 on error */
927 asn1_decode_snmp(unsigned char *buffer
, /* I - Buffer */
928 size_t len
, /* I - Size of buffer */
929 cups_snmp_t
*packet
) /* I - SNMP packet */
931 unsigned char *bufptr
, /* Pointer into the data */
932 *bufend
; /* End of data */
933 unsigned length
; /* Length of value */
937 * Initialize the decoding...
940 memset(packet
, 0, sizeof(cups_snmp_t
));
941 packet
->object_name
[0] = -1;
944 bufend
= buffer
+ len
;
946 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
947 snmp_set_error(packet
, _("Packet does not start with SEQUENCE"));
948 else if (asn1_get_length(&bufptr
, bufend
) == 0)
949 snmp_set_error(packet
, _("SEQUENCE uses indefinite length"));
950 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
951 snmp_set_error(packet
, _("No version number"));
952 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
953 snmp_set_error(packet
, _("Version uses indefinite length"));
954 else if ((packet
->version
= asn1_get_integer(&bufptr
, bufend
, length
))
955 != CUPS_SNMP_VERSION_1
)
956 snmp_set_error(packet
, _("Bad SNMP version number"));
957 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OCTET_STRING
)
958 snmp_set_error(packet
, _("No community name"));
959 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
960 snmp_set_error(packet
, _("Community name uses indefinite length"));
963 asn1_get_string(&bufptr
, bufend
, length
, packet
->community
,
964 sizeof(packet
->community
));
966 if ((packet
->request_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
))
967 != CUPS_ASN1_GET_RESPONSE
)
968 snmp_set_error(packet
, _("Packet does not contain a Get-Response-PDU"));
969 else if (asn1_get_length(&bufptr
, bufend
) == 0)
970 snmp_set_error(packet
, _("Get-Response-PDU uses indefinite length"));
971 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
972 snmp_set_error(packet
, _("No request-id"));
973 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
974 snmp_set_error(packet
, _("request-id uses indefinite length"));
977 packet
->request_id
= (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
979 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
980 snmp_set_error(packet
, _("No error-status"));
981 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
982 snmp_set_error(packet
, _("error-status uses indefinite length"));
985 packet
->error_status
= asn1_get_integer(&bufptr
, bufend
, length
);
987 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_INTEGER
)
988 snmp_set_error(packet
, _("No error-index"));
989 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
990 snmp_set_error(packet
, _("error-index uses indefinite length"));
993 packet
->error_index
= asn1_get_integer(&bufptr
, bufend
, length
);
995 if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
996 snmp_set_error(packet
, _("No variable-bindings SEQUENCE"));
997 else if (asn1_get_length(&bufptr
, bufend
) == 0)
998 snmp_set_error(packet
,
999 _("variable-bindings uses indefinite length"));
1000 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_SEQUENCE
)
1001 snmp_set_error(packet
, _("No VarBind SEQUENCE"));
1002 else if (asn1_get_length(&bufptr
, bufend
) == 0)
1003 snmp_set_error(packet
, _("VarBind uses indefinite length"));
1004 else if (asn1_get_type(&bufptr
, bufend
) != CUPS_ASN1_OID
)
1005 snmp_set_error(packet
, _("No name OID"));
1006 else if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0)
1007 snmp_set_error(packet
, _("Name OID uses indefinite length"));
1010 asn1_get_oid(&bufptr
, bufend
, length
, packet
->object_name
,
1013 packet
->object_type
= (cups_asn1_t
)asn1_get_type(&bufptr
, bufend
);
1015 if ((length
= asn1_get_length(&bufptr
, bufend
)) == 0 &&
1016 packet
->object_type
!= CUPS_ASN1_NULL_VALUE
&&
1017 packet
->object_type
!= CUPS_ASN1_OCTET_STRING
)
1018 snmp_set_error(packet
, _("Value uses indefinite length"));
1021 switch (packet
->object_type
)
1023 case CUPS_ASN1_BOOLEAN
:
1024 packet
->object_value
.boolean
=
1025 asn1_get_integer(&bufptr
, bufend
, length
);
1028 case CUPS_ASN1_INTEGER
:
1029 packet
->object_value
.integer
=
1030 asn1_get_integer(&bufptr
, bufend
, length
);
1033 case CUPS_ASN1_NULL_VALUE
:
1036 case CUPS_ASN1_OCTET_STRING
:
1037 case CUPS_ASN1_BIT_STRING
:
1038 case CUPS_ASN1_HEX_STRING
:
1039 packet
->object_value
.string
.num_bytes
= length
;
1040 asn1_get_string(&bufptr
, bufend
, length
,
1041 (char *)packet
->object_value
.string
.bytes
,
1042 sizeof(packet
->object_value
.string
.bytes
));
1045 case CUPS_ASN1_OID
:
1046 asn1_get_oid(&bufptr
, bufend
, length
,
1047 packet
->object_value
.oid
, CUPS_SNMP_MAX_OID
);
1050 case CUPS_ASN1_COUNTER
:
1051 packet
->object_value
.counter
=
1052 asn1_get_integer(&bufptr
, bufend
, length
);
1055 case CUPS_ASN1_GAUGE
:
1056 packet
->object_value
.gauge
=
1057 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1060 case CUPS_ASN1_TIMETICKS
:
1061 packet
->object_value
.timeticks
=
1062 (unsigned)asn1_get_integer(&bufptr
, bufend
, length
);
1066 snmp_set_error(packet
, _("Unsupported value type"));
1076 return (packet
->error
? -1 : 0);
1081 * 'asn1_encode_snmp()' - Encode a SNMP packet.
1084 static int /* O - Length on success, -1 on error */
1085 asn1_encode_snmp(unsigned char *buffer
, /* I - Buffer */
1086 size_t bufsize
, /* I - Size of buffer */
1087 cups_snmp_t
*packet
) /* I - SNMP packet */
1089 unsigned char *bufptr
; /* Pointer into buffer */
1090 unsigned total
, /* Total length */
1091 msglen
, /* Length of entire message */
1092 commlen
, /* Length of community string */
1093 reqlen
, /* Length of request */
1094 listlen
, /* Length of variable list */
1095 varlen
, /* Length of variable */
1096 namelen
, /* Length of object name OID */
1097 valuelen
; /* Length of object value */
1101 * Get the lengths of the community string, OID, and message...
1105 namelen
= asn1_size_oid(packet
->object_name
);
1107 switch (packet
->object_type
)
1109 case CUPS_ASN1_NULL_VALUE
:
1113 case CUPS_ASN1_BOOLEAN
:
1114 valuelen
= asn1_size_integer(packet
->object_value
.boolean
);
1117 case CUPS_ASN1_INTEGER
:
1118 valuelen
= asn1_size_integer(packet
->object_value
.integer
);
1121 case CUPS_ASN1_OCTET_STRING
:
1122 valuelen
= packet
->object_value
.string
.num_bytes
;
1125 case CUPS_ASN1_OID
:
1126 valuelen
= asn1_size_oid(packet
->object_value
.oid
);
1130 packet
->error
= "Unknown object type";
1134 varlen
= 1 + asn1_size_length(namelen
) + namelen
+
1135 1 + asn1_size_length(valuelen
) + valuelen
;
1136 listlen
= 1 + asn1_size_length(varlen
) + varlen
;
1137 reqlen
= 2 + asn1_size_integer((int)packet
->request_id
) +
1138 2 + asn1_size_integer(packet
->error_status
) +
1139 2 + asn1_size_integer(packet
->error_index
) +
1140 1 + asn1_size_length(listlen
) + listlen
;
1141 commlen
= (unsigned)strlen(packet
->community
);
1142 msglen
= 2 + asn1_size_integer(packet
->version
) +
1143 1 + asn1_size_length(commlen
) + commlen
+
1144 1 + asn1_size_length(reqlen
) + reqlen
;
1145 total
= 1 + asn1_size_length(msglen
) + msglen
;
1147 if (total
> bufsize
)
1149 packet
->error
= "Message too large for buffer";
1154 * Then format the message...
1159 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* SNMPv1 message header */
1160 asn1_set_length(&bufptr
, msglen
);
1162 asn1_set_integer(&bufptr
, packet
->version
);
1165 *bufptr
++ = CUPS_ASN1_OCTET_STRING
; /* community */
1166 asn1_set_length(&bufptr
, commlen
);
1167 memcpy(bufptr
, packet
->community
, commlen
);
1170 *bufptr
++ = packet
->request_type
; /* Get-Request-PDU/Get-Next-Request-PDU */
1171 asn1_set_length(&bufptr
, reqlen
);
1173 asn1_set_integer(&bufptr
, (int)packet
->request_id
);
1175 asn1_set_integer(&bufptr
, packet
->error_status
);
1177 asn1_set_integer(&bufptr
, packet
->error_index
);
1179 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable-bindings */
1180 asn1_set_length(&bufptr
, listlen
);
1182 *bufptr
++ = CUPS_ASN1_SEQUENCE
; /* variable */
1183 asn1_set_length(&bufptr
, varlen
);
1185 asn1_set_oid(&bufptr
, packet
->object_name
);
1188 switch (packet
->object_type
)
1190 case CUPS_ASN1_NULL_VALUE
:
1191 *bufptr
++ = CUPS_ASN1_NULL_VALUE
;
1193 *bufptr
++ = 0; /* Length */
1196 case CUPS_ASN1_BOOLEAN
:
1197 asn1_set_integer(&bufptr
, packet
->object_value
.boolean
);
1200 case CUPS_ASN1_INTEGER
:
1201 asn1_set_integer(&bufptr
, packet
->object_value
.integer
);
1204 case CUPS_ASN1_OCTET_STRING
:
1205 *bufptr
++ = CUPS_ASN1_OCTET_STRING
;
1206 asn1_set_length(&bufptr
, valuelen
);
1207 memcpy(bufptr
, packet
->object_value
.string
.bytes
, valuelen
);
1211 case CUPS_ASN1_OID
:
1212 asn1_set_oid(&bufptr
, packet
->object_value
.oid
);
1219 return ((int)(bufptr
- buffer
));
1224 * 'asn1_get_integer()' - Get an integer value.
1227 static int /* O - Integer value */
1229 unsigned char **buffer
, /* IO - Pointer in buffer */
1230 unsigned char *bufend
, /* I - End of buffer */
1231 unsigned length
) /* I - Length of value */
1233 int value
; /* Integer value */
1236 if (length
> sizeof(int))
1238 (*buffer
) += length
;
1242 for (value
= (**buffer
& 0x80) ? -1 : 0;
1243 length
> 0 && *buffer
< bufend
;
1244 length
--, (*buffer
) ++)
1245 value
= (value
<< 8) | **buffer
;
1252 * 'asn1_get_length()' - Get a value length.
1255 static unsigned /* O - Length */
1256 asn1_get_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1257 unsigned char *bufend
) /* I - End of buffer */
1259 unsigned length
; /* Length */
1267 int count
; /* Number of bytes for length */
1270 if ((count
= length
& 127) > sizeof(unsigned))
1277 count
> 0 && *buffer
< bufend
;
1278 count
--, (*buffer
) ++)
1279 length
= (length
<< 8) | **buffer
;
1287 * 'asn1_get_oid()' - Get an OID value.
1290 static int /* O - Number of OIDs */
1292 unsigned char **buffer
, /* IO - Pointer in buffer */
1293 unsigned char *bufend
, /* I - End of buffer */
1294 unsigned length
, /* I - Length of value */
1295 int *oid
, /* I - OID buffer */
1296 int oidsize
) /* I - Size of OID buffer */
1298 unsigned char *valend
; /* End of value */
1299 int *oidptr
, /* Current OID */
1300 *oidend
; /* End of OID buffer */
1301 int number
; /* OID number */
1304 valend
= *buffer
+ length
;
1306 oidend
= oid
+ oidsize
- 1;
1308 if (valend
> bufend
)
1311 number
= asn1_get_packed(buffer
, bufend
);
1315 *oidptr
++ = number
/ 40;
1316 number
= number
% 40;
1326 while (*buffer
< valend
)
1328 number
= asn1_get_packed(buffer
, bufend
);
1330 if (oidptr
< oidend
)
1336 return ((int)(oidptr
- oid
));
1341 * 'asn1_get_packed()' - Get a packed integer value.
1344 static int /* O - Value */
1346 unsigned char **buffer
, /* IO - Pointer in buffer */
1347 unsigned char *bufend
) /* I - End of buffer */
1349 int value
; /* Value */
1354 while ((**buffer
& 128) && *buffer
< bufend
)
1356 value
= (value
<< 7) | (**buffer
& 127);
1360 if (*buffer
< bufend
)
1362 value
= (value
<< 7) | **buffer
;
1371 * 'asn1_get_string()' - Get a string value.
1374 static char * /* O - String */
1376 unsigned char **buffer
, /* IO - Pointer in buffer */
1377 unsigned char *bufend
, /* I - End of buffer */
1378 unsigned length
, /* I - Value length */
1379 char *string
, /* I - String buffer */
1380 size_t strsize
) /* I - String buffer size */
1382 if (length
> (unsigned)(bufend
- *buffer
))
1383 length
= (unsigned)(bufend
- *buffer
);
1385 if (length
< strsize
)
1388 * String is smaller than the buffer...
1392 memcpy(string
, *buffer
, length
);
1394 string
[length
] = '\0';
1399 * String is larger than the buffer...
1402 memcpy(string
, *buffer
, strsize
- 1);
1403 string
[strsize
- 1] = '\0';
1407 (*buffer
) += length
;
1414 * 'asn1_get_type()' - Get a value type.
1417 static int /* O - Type */
1418 asn1_get_type(unsigned char **buffer
, /* IO - Pointer in buffer */
1419 unsigned char *bufend
) /* I - End of buffer */
1421 int type
; /* Type */
1427 if ((type
& 31) == 31)
1428 type
= asn1_get_packed(buffer
, bufend
);
1435 * 'asn1_set_integer()' - Set an integer value.
1439 asn1_set_integer(unsigned char **buffer
,/* IO - Pointer in buffer */
1440 int integer
) /* I - Integer value */
1442 **buffer
= CUPS_ASN1_INTEGER
;
1445 if (integer
> 0x7fffff || integer
< -0x800000)
1449 **buffer
= (unsigned char)(integer
>> 24);
1451 **buffer
= (unsigned char)(integer
>> 16);
1453 **buffer
= (unsigned char)(integer
>> 8);
1455 **buffer
= (unsigned char)integer
;
1458 else if (integer
> 0x7fff || integer
< -0x8000)
1462 **buffer
= (unsigned char)(integer
>> 16);
1464 **buffer
= (unsigned char)(integer
>> 8);
1466 **buffer
= (unsigned char)integer
;
1469 else if (integer
> 0x7f || integer
< -0x80)
1473 **buffer
= (unsigned char)(integer
>> 8);
1475 **buffer
= (unsigned char)integer
;
1482 **buffer
= (unsigned char)integer
;
1489 * 'asn1_set_length()' - Set a value length.
1493 asn1_set_length(unsigned char **buffer
, /* IO - Pointer in buffer */
1494 unsigned length
) /* I - Length value */
1498 **buffer
= 0x82; /* 2-byte length */
1500 **buffer
= (unsigned char)(length
>> 8);
1502 **buffer
= (unsigned char)length
;
1505 else if (length
> 127)
1507 **buffer
= 0x81; /* 1-byte length */
1509 **buffer
= (unsigned char)length
;
1514 **buffer
= (unsigned char)length
; /* Length */
1521 * 'asn1_set_oid()' - Set an OID value.
1525 asn1_set_oid(unsigned char **buffer
, /* IO - Pointer in buffer */
1526 const int *oid
) /* I - OID value */
1528 **buffer
= CUPS_ASN1_OID
;
1531 asn1_set_length(buffer
, asn1_size_oid(oid
));
1535 asn1_set_packed(buffer
, oid
[0] * 40);
1539 asn1_set_packed(buffer
, oid
[0] * 40 + oid
[1]);
1541 for (oid
+= 2; *oid
>= 0; oid
++)
1542 asn1_set_packed(buffer
, *oid
);
1547 * 'asn1_set_packed()' - Set a packed integer value.
1551 asn1_set_packed(unsigned char **buffer
, /* IO - Pointer in buffer */
1552 int integer
) /* I - Integer value */
1554 if (integer
> 0xfffffff)
1556 **buffer
= ((integer
>> 28) & 0x7f) | 0x80;
1560 if (integer
> 0x1fffff)
1562 **buffer
= ((integer
>> 21) & 0x7f) | 0x80;
1566 if (integer
> 0x3fff)
1568 **buffer
= ((integer
>> 14) & 0x7f) | 0x80;
1574 **buffer
= ((integer
>> 7) & 0x7f) | 0x80;
1578 **buffer
= integer
& 0x7f;
1584 * 'asn1_size_integer()' - Figure out the number of bytes needed for an
1588 static unsigned /* O - Size in bytes */
1589 asn1_size_integer(int integer
) /* I - Integer value */
1591 if (integer
> 0x7fffff || integer
< -0x800000)
1593 else if (integer
> 0x7fff || integer
< -0x8000)
1595 else if (integer
> 0x7f || integer
< -0x80)
1603 * 'asn1_size_length()' - Figure out the number of bytes needed for a
1607 static unsigned /* O - Size in bytes */
1608 asn1_size_length(unsigned length
) /* I - Length value */
1612 else if (length
> 0x7f)
1620 * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
1624 static unsigned /* O - Size in bytes */
1625 asn1_size_oid(const int *oid
) /* I - OID value */
1627 unsigned length
; /* Length of value */
1631 return (asn1_size_packed(oid
[0] * 40));
1633 for (length
= asn1_size_packed(oid
[0] * 40 + oid
[1]), oid
+= 2;
1636 length
+= asn1_size_packed(*oid
);
1643 * 'asn1_size_packed()' - Figure out the number of bytes needed for a
1644 * packed integer value.
1647 static unsigned /* O - Size in bytes */
1648 asn1_size_packed(int integer
) /* I - Integer value */
1650 if (integer
> 0xfffffff)
1652 else if (integer
> 0x1fffff)
1654 else if (integer
> 0x3fff)
1656 else if (integer
> 0x7f)
1664 * 'snmp_set_error()' - Set the localized error for a packet.
1668 snmp_set_error(cups_snmp_t
*packet
, /* I - Packet */
1669 const char *message
) /* I - Error message */
1671 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1674 if (!cg
->lang_default
)
1675 cg
->lang_default
= cupsLangDefault();
1677 packet
->error
= _cupsLangString(cg
->lang_default
, message
);