/*
- * "$Id$"
+ * SNMP functions for CUPS.
*
- * SNMP functions for the Common UNIX Printing System (CUPS).
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 2006-2007 by Easy Software Products, all rights reserved.
*
- * Copyright 2007-2009 by Apple Inc.
- * Copyright 2006-2007 by Easy Software Products, all rights reserved.
- *
- * These coded instructions, statements, and computer programs are the
- * property of Apple Inc. and are protected by Federal copyright
- * law. Distribution and use rights are outlined in the file "LICENSE.txt"
- * "LICENSE" which should have been included with this file. If this
- * file is missing or damaged, see the license at "http://www.cups.org/".
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * _cupsSNMPClose() - Close a SNMP socket.
- * _cupsSNMPCopyOID() - Copy an OID.
- * _cupsSNMPDefaultCommunity() - Get the default SNMP community name.
- * _cupsSNMPIsOID() - Test whether a SNMP response contains the
- * specified OID.
- * _cupsSNMPIsOIDPrefixed() - Test whether a SNMP response uses the
- * specified OID prefix.
- * _cupsSNMPOIDToString() - Convert an OID to a string.
- * _cupsSNMPOpen() - Open a SNMP socket.
- * _cupsSNMPRead() - Read and parse a SNMP response.
- * _cupsSNMPSetDebug() - Enable/disable debug logging to stderr.
- * _cupsSNMPStringToOID() - Convert a numeric OID string to an OID array.
- * _cupsSNMPWalk() - Enumerate a group of OIDs.
- * _cupsSNMPWrite() - Send an SNMP query packet.
- * asn1_debug() - Decode an ASN1-encoded message.
- * asn1_decode_snmp() - Decode a SNMP packet.
- * asn1_encode_snmp() - Encode a SNMP packet.
- * asn1_get_integer() - Get an integer value.
- * asn1_get_length() - Get a value length.
- * asn1_get_oid() - Get an OID value.
- * asn1_get_packed() - Get a packed integer value.
- * asn1_get_string() - Get a string value.
- * asn1_get_type() - Get a value type.
- * asn1_set_integer() - Set an integer value.
- * asn1_set_length() - Set a value length.
- * asn1_set_oid() - Set an OID value.
- * asn1_set_packed() - Set a packed integer value.
- * asn1_size_integer() - Figure out the number of bytes needed for an
- * integer value.
- * asn1_size_length() - Figure out the number of bytes needed for a
- * length value.
- * asn1_size_oid() - Figure out the numebr of bytes needed for an
- * OID value.
- * asn1_size_packed() - Figure out the number of bytes needed for a
- * packed integer value.
- * snmp_set_error() - Set the localized error for a packet.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
* Include necessary headers.
*/
-#include "globals.h"
-#include "debug.h"
+#include "cups-private.h"
#include "snmp-private.h"
-#include <errno.h>
+#include "debug-internal.h"
#ifdef HAVE_POLL
-# include <sys/poll.h>
+# include <poll.h>
#endif /* HAVE_POLL */
cups_snmp_t *packet);
static int asn1_get_integer(unsigned char **buffer,
unsigned char *bufend,
- int length);
+ unsigned length);
static int asn1_get_oid(unsigned char **buffer,
unsigned char *bufend,
- int length, int *oid, int oidsize);
+ unsigned length, int *oid, int oidsize);
static int asn1_get_packed(unsigned char **buffer,
unsigned char *bufend);
static char *asn1_get_string(unsigned char **buffer,
unsigned char *bufend,
- int length, char *string,
- int strsize);
-static int asn1_get_length(unsigned char **buffer,
+ unsigned length, char *string,
+ size_t strsize);
+static unsigned asn1_get_length(unsigned char **buffer,
unsigned char *bufend);
static int asn1_get_type(unsigned char **buffer,
unsigned char *bufend);
static void asn1_set_integer(unsigned char **buffer,
int integer);
static void asn1_set_length(unsigned char **buffer,
- int length);
+ unsigned length);
static void asn1_set_oid(unsigned char **buffer,
const int *oid);
static void asn1_set_packed(unsigned char **buffer,
int integer);
-static int asn1_size_integer(int integer);
-static int asn1_size_length(int length);
-static int asn1_size_oid(const int *oid);
-static int asn1_size_packed(int integer);
+static unsigned asn1_size_integer(int integer);
+static unsigned asn1_size_length(unsigned length);
+static unsigned asn1_size_oid(const int *oid);
+static unsigned asn1_size_packed(int integer);
static void snmp_set_error(cups_snmp_t *packet,
const char *message);
{
DEBUG_printf(("4_cupsSNMPClose(fd=%d)", fd));
-#ifdef WIN32
- closesocket(fd);
-#else
- close(fd);
-#endif /* WIN32 */
+ httpAddrClose(NULL, fd);
}
{
linenum = 0;
while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
- if (!strcasecmp(line, "Community") && value)
+ if (!_cups_strcasecmp(line, "Community"))
{
- strlcpy(cg->snmp_community, value, sizeof(cg->snmp_community));
+ if (value)
+ strlcpy(cg->snmp_community, value, sizeof(cg->snmp_community));
+ else
+ cg->snmp_community[0] = '\0';
+
break;
}
for (dstptr = dst, dstend = dstptr + dstsize - 1;
*src >= 0 && dstptr < dstend;
src ++, dstptr += strlen(dstptr))
- snprintf(dstptr, dstend - dstptr + 1, ".%d", *src);
+ snprintf(dstptr, (size_t)(dstend - dstptr + 1), ".%d", *src);
if (*src >= 0)
return (NULL);
val = 1;
-#ifdef WIN32
- if (setsockopt(fd, SOL_SOCKET, SO_BROADCAST, (char *)&val, sizeof(val)))
-#else
- if (setsockopt(fd, SOL_SOCKET, SO_BROADCAST, &val, sizeof(val)))
-#endif /* WIN32 */
+ if (setsockopt(fd, SOL_SOCKET, SO_BROADCAST, CUPS_SOCAST &val, sizeof(val)))
{
DEBUG_printf(("5_cupsSNMPOpen: Returning -1 (%s)", strerror(errno)));
{
unsigned char buffer[CUPS_SNMP_MAX_PACKET];
/* Data packet */
- int bytes; /* Number of bytes received */
+ ssize_t bytes; /* Number of bytes received */
socklen_t addrlen; /* Source address length */
http_addr_t address; /* Source address */
ready = select(fd + 1, &input_set, NULL, NULL, &stimeout);
}
-# ifdef WIN32
+# ifdef _WIN32
while (ready < 0 && WSAGetLastError() == WSAEINTR);
# else
while (ready < 0 && (errno == EINTR || errno == EAGAIN));
-# endif /* WIN32 */
+# endif /* _WIN32 */
#endif /* HAVE_POLL */
/*
* Look for the response status code in the SNMP message header...
*/
- asn1_debug("DEBUG: IN ", buffer, bytes, 0);
+ asn1_debug("DEBUG: IN ", buffer, (size_t)bytes, 0);
- asn1_decode_snmp(buffer, bytes, packet);
+ asn1_decode_snmp(buffer, (size_t)bytes, packet);
memcpy(&(packet->address), &address, sizeof(packet->address));
void *data) /* I - User data pointer that is passed to the callback function */
{
int count = 0; /* Number of OIDs found */
- int request_id = 0; /* Current request ID */
+ unsigned request_id = 0; /* Current request ID */
cups_snmp_t packet; /* Current response packet */
int lastoid[CUPS_SNMP_MAX_OID];
/* Last OID we got */
cups_snmp_t packet; /* SNMP message packet */
unsigned char buffer[CUPS_SNMP_MAX_PACKET];
/* SNMP message buffer */
- int bytes; /* Size of message */
+ ssize_t bytes; /* Size of message */
http_addr_t temp; /* Copy of address */
packet.request_type = request_type;
packet.request_id = request_id;
packet.object_type = CUPS_ASN1_NULL_VALUE;
-
+
strlcpy(packet.community, community, sizeof(packet.community));
for (i = 0; oid[i] >= 0 && i < (CUPS_SNMP_MAX_OID - 1); i ++)
return (0);
}
- asn1_debug("DEBUG: OUT ", buffer, bytes, 0);
+ asn1_debug("DEBUG: OUT ", buffer, (size_t)bytes, 0);
/*
* Send the message...
temp = *address;
-#ifdef AF_INET6
- if (temp.addr.sa_family == AF_INET6)
- temp.ipv6.sin6_port = htons(CUPS_SNMP_PORT);
- else
-#endif /* AF_INET6 */
- temp.ipv4.sin_port = htons(CUPS_SNMP_PORT);
+ _httpAddrSetPort(&temp, CUPS_SNMP_PORT);
- return (sendto(fd, buffer, bytes, 0, (void *)&temp,
- httpAddrLength(&temp)) == bytes);
+ return (sendto(fd, buffer, (size_t)bytes, 0, (void *)&temp, (socklen_t)httpAddrLength(&temp)) == bytes);
}
size_t len, /* I - Length of buffer */
int indent) /* I - Indentation */
{
- int i; /* Looping var */
+ size_t i; /* Looping var */
unsigned char *bufend; /* End of buffer */
int integer; /* Number value */
int oid[CUPS_SNMP_MAX_OID]; /* OID value */
char string[CUPS_SNMP_MAX_STRING];
/* String value */
unsigned char value_type; /* Type of value */
- int value_length; /* Length of value */
+ unsigned value_length; /* Length of value */
_cups_globals_t *cg = _cupsGlobals(); /* Global data */
+#ifdef __clang_analyzer__ /* Suppress bogus clang error */
+ memset(string, 0, sizeof(string));
+#endif /* __clang_analyzer__ */
+
if (cg->snmp_debug <= 0)
return;
* Do a hex dump of the packet...
*/
- int j;
+ size_t j;
fprintf(stderr, "%sHex Dump (%d bytes):\n", prefix, (int)len);
- for (i = 0; i < (int)len; i += 16)
+ for (i = 0; i < len; i += 16)
{
- fprintf(stderr, "%s%04x:", prefix, i);
+ fprintf(stderr, "%s%04x:", prefix, (unsigned)i);
- for (j = 0; j < 16 && (i + j) < (int)len; j ++)
+ for (j = 0; j < 16 && (i + j) < len; j ++)
{
if (j && !(j & 3))
fprintf(stderr, " %02x", buffer[i + j]);
fputs(" ", stderr);
- for (j = 0; j < 16 && (i + j) < (int)len; j ++)
+ for (j = 0; j < 16 && (i + j) < len; j ++)
if (buffer[i + j] < ' ' || buffer[i + j] >= 0x7f)
putc('.', stderr);
else
* Get value type...
*/
- value_type = asn1_get_type(&buffer, bufend);
+ value_type = (unsigned char)asn1_get_type(&buffer, bufend);
value_length = asn1_get_length(&buffer, bufend);
switch (value_type)
fprintf(stderr, "%s%*sOID %d bytes ", prefix, indent, "",
value_length);
- for (i = 0; i < integer; i ++)
+ for (i = 0; i < (unsigned)integer; i ++)
fprintf(stderr, ".%d", oid[i]);
putc('\n', stderr);
break;
}
}
}
-
+
/*
* 'asn1_decode_snmp()' - Decode a SNMP packet.
{
unsigned char *bufptr, /* Pointer into the data */
*bufend; /* End of data */
- int length; /* Length of value */
+ unsigned length; /* Length of value */
/*
asn1_get_string(&bufptr, bufend, length, packet->community,
sizeof(packet->community));
- if ((packet->request_type = asn1_get_type(&bufptr, bufend))
+ if ((packet->request_type = (cups_asn1_t)asn1_get_type(&bufptr, bufend))
!= CUPS_ASN1_GET_RESPONSE)
snmp_set_error(packet, _("Packet does not contain a Get-Response-PDU"));
else if (asn1_get_length(&bufptr, bufend) == 0)
snmp_set_error(packet, _("request-id uses indefinite length"));
else
{
- packet->request_id = asn1_get_integer(&bufptr, bufend, length);
+ packet->request_id = (unsigned)asn1_get_integer(&bufptr, bufend, length);
if (asn1_get_type(&bufptr, bufend) != CUPS_ASN1_INTEGER)
snmp_set_error(packet, _("No error-status"));
asn1_get_oid(&bufptr, bufend, length, packet->object_name,
CUPS_SNMP_MAX_OID);
- packet->object_type = asn1_get_type(&bufptr, bufend);
+ packet->object_type = (cups_asn1_t)asn1_get_type(&bufptr, bufend);
if ((length = asn1_get_length(&bufptr, bufend)) == 0 &&
packet->object_type != CUPS_ASN1_NULL_VALUE &&
packet->object_value.string.num_bytes = length;
asn1_get_string(&bufptr, bufend, length,
(char *)packet->object_value.string.bytes,
- CUPS_SNMP_MAX_STRING);
+ sizeof(packet->object_value.string.bytes));
break;
case CUPS_ASN1_OID :
case CUPS_ASN1_GAUGE :
packet->object_value.gauge =
- asn1_get_integer(&bufptr, bufend, length);
+ (unsigned)asn1_get_integer(&bufptr, bufend, length);
break;
case CUPS_ASN1_TIMETICKS :
packet->object_value.timeticks =
- asn1_get_integer(&bufptr, bufend, length);
+ (unsigned)asn1_get_integer(&bufptr, bufend, length);
break;
default :
cups_snmp_t *packet) /* I - SNMP packet */
{
unsigned char *bufptr; /* Pointer into buffer */
- int total, /* Total length */
+ unsigned total, /* Total length */
msglen, /* Length of entire message */
commlen, /* Length of community string */
reqlen, /* Length of request */
varlen = 1 + asn1_size_length(namelen) + namelen +
1 + asn1_size_length(valuelen) + valuelen;
listlen = 1 + asn1_size_length(varlen) + varlen;
- reqlen = 2 + asn1_size_integer(packet->request_id) +
+ reqlen = 2 + asn1_size_integer((int)packet->request_id) +
2 + asn1_size_integer(packet->error_status) +
2 + asn1_size_integer(packet->error_index) +
1 + asn1_size_length(listlen) + listlen;
- commlen = strlen(packet->community);
+ commlen = (unsigned)strlen(packet->community);
msglen = 2 + asn1_size_integer(packet->version) +
1 + asn1_size_length(commlen) + commlen +
1 + asn1_size_length(reqlen) + reqlen;
total = 1 + asn1_size_length(msglen) + msglen;
- if (total > (int)bufsize)
+ if (total > bufsize)
{
packet->error = "Message too large for buffer";
return (-1);
memcpy(bufptr, packet->community, commlen);
bufptr += commlen;
- *bufptr++ = packet->request_type; /* Get-Request-PDU/Get-Next-Request-PDU */
+ *bufptr++ = (unsigned char)packet->request_type; /* Get-Request-PDU/Get-Next-Request-PDU */
asn1_set_length(&bufptr, reqlen);
- asn1_set_integer(&bufptr, packet->request_id);
+ asn1_set_integer(&bufptr, (int)packet->request_id);
asn1_set_integer(&bufptr, packet->error_status);
break;
}
- return (bufptr - buffer);
+ return ((int)(bufptr - buffer));
}
asn1_get_integer(
unsigned char **buffer, /* IO - Pointer in buffer */
unsigned char *bufend, /* I - End of buffer */
- int length) /* I - Length of value */
+ unsigned length) /* I - Length of value */
{
int value; /* Integer value */
- for (value = (**buffer & 0x80) ? -1 : 0;
+ if (*buffer >= bufend)
+ return (0);
+
+ if (length > sizeof(int))
+ {
+ (*buffer) += length;
+ return (0);
+ }
+
+ for (value = (**buffer & 0x80) ? ~0 : 0;
length > 0 && *buffer < bufend;
length --, (*buffer) ++)
- value = (value << 8) | **buffer;
+ value = ((value & 0xffffff) << 8) | **buffer;
return (value);
}
* 'asn1_get_length()' - Get a value length.
*/
-static int /* O - Length */
+static unsigned /* O - Length */
asn1_get_length(unsigned char **buffer, /* IO - Pointer in buffer */
unsigned char *bufend) /* I - End of buffer */
{
- int length; /* Length */
+ unsigned length; /* Length */
+ if (*buffer >= bufend)
+ return (0);
+
length = **buffer;
(*buffer) ++;
if (length & 128)
- length = asn1_get_integer(buffer, bufend, length & 127);
+ {
+ int count; /* Number of bytes for length */
+
+
+ if ((count = length & 127) > sizeof(unsigned))
+ {
+ (*buffer) += count;
+ return (0);
+ }
+
+ for (length = 0;
+ count > 0 && *buffer < bufend;
+ count --, (*buffer) ++)
+ length = (length << 8) | **buffer;
+ }
return (length);
}
asn1_get_oid(
unsigned char **buffer, /* IO - Pointer in buffer */
unsigned char *bufend, /* I - End of buffer */
- int length, /* I - Length of value */
+ unsigned length, /* I - Length of value */
int *oid, /* I - OID buffer */
int oidsize) /* I - Size of OID buffer */
{
int number; /* OID number */
+ if (*buffer >= bufend)
+ return (0);
+
valend = *buffer + length;
oidptr = oid;
oidend = oid + oidsize - 1;
*oidptr = -1;
- return (oidptr - oid);
+ return ((int)(oidptr - oid));
}
int value; /* Value */
+ if (*buffer >= bufend)
+ return (0);
+
value = 0;
- while ((**buffer & 128) && *buffer < bufend)
+ while (*buffer < bufend && (**buffer & 128))
{
value = (value << 7) | (**buffer & 127);
(*buffer) ++;
asn1_get_string(
unsigned char **buffer, /* IO - Pointer in buffer */
unsigned char *bufend, /* I - End of buffer */
- int length, /* I - Value length */
+ unsigned length, /* I - Value length */
char *string, /* I - String buffer */
- int strsize) /* I - String buffer size */
+ size_t strsize) /* I - String buffer size */
{
- if (length < 0)
- {
- /*
- * Disallow negative lengths!
- */
+ if (*buffer >= bufend)
+ return (NULL);
- *string = '\0';
- }
- else if (length < strsize)
+ if (length > (unsigned)(bufend - *buffer))
+ length = (unsigned)(bufend - *buffer);
+
+ if (length < strsize)
{
/*
* String is smaller than the buffer...
if (length > 0)
(*buffer) += length;
- return (length < 0 ? NULL : string);
+ return (string);
}
int type; /* Type */
+ if (*buffer >= bufend)
+ return (0);
+
type = **buffer;
(*buffer) ++;
{
**buffer = 4;
(*buffer) ++;
- **buffer = integer >> 24;
+ **buffer = (unsigned char)(integer >> 24);
(*buffer) ++;
- **buffer = integer >> 16;
+ **buffer = (unsigned char)(integer >> 16);
(*buffer) ++;
- **buffer = integer >> 8;
+ **buffer = (unsigned char)(integer >> 8);
(*buffer) ++;
- **buffer = integer;
+ **buffer = (unsigned char)integer;
(*buffer) ++;
}
else if (integer > 0x7fff || integer < -0x8000)
{
**buffer = 3;
(*buffer) ++;
- **buffer = integer >> 16;
+ **buffer = (unsigned char)(integer >> 16);
(*buffer) ++;
- **buffer = integer >> 8;
+ **buffer = (unsigned char)(integer >> 8);
(*buffer) ++;
- **buffer = integer;
+ **buffer = (unsigned char)integer;
(*buffer) ++;
}
else if (integer > 0x7f || integer < -0x80)
{
**buffer = 2;
(*buffer) ++;
- **buffer = integer >> 8;
+ **buffer = (unsigned char)(integer >> 8);
(*buffer) ++;
- **buffer = integer;
+ **buffer = (unsigned char)integer;
(*buffer) ++;
}
else
{
**buffer = 1;
(*buffer) ++;
- **buffer = integer;
+ **buffer = (unsigned char)integer;
(*buffer) ++;
}
}
static void
asn1_set_length(unsigned char **buffer, /* IO - Pointer in buffer */
- int length) /* I - Length value */
+ unsigned length) /* I - Length value */
{
if (length > 255)
{
**buffer = 0x82; /* 2-byte length */
(*buffer) ++;
- **buffer = length >> 8;
+ **buffer = (unsigned char)(length >> 8);
(*buffer) ++;
- **buffer = length;
+ **buffer = (unsigned char)length;
(*buffer) ++;
}
else if (length > 127)
{
**buffer = 0x81; /* 1-byte length */
(*buffer) ++;
- **buffer = length;
+ **buffer = (unsigned char)length;
(*buffer) ++;
}
else
{
- **buffer = length; /* Length */
+ **buffer = (unsigned char)length; /* Length */
(*buffer) ++;
}
}
* integer value.
*/
-static int /* O - Size in bytes */
+static unsigned /* O - Size in bytes */
asn1_size_integer(int integer) /* I - Integer value */
{
if (integer > 0x7fffff || integer < -0x800000)
* length value.
*/
-static int /* O - Size in bytes */
-asn1_size_length(int length) /* I - Length value */
+static unsigned /* O - Size in bytes */
+asn1_size_length(unsigned length) /* I - Length value */
{
if (length > 0xff)
return (3);
/*
- * 'asn1_size_oid()' - Figure out the numebr of bytes needed for an
+ * 'asn1_size_oid()' - Figure out the number of bytes needed for an
* OID value.
*/
-static int /* O - Size in bytes */
+static unsigned /* O - Size in bytes */
asn1_size_oid(const int *oid) /* I - OID value */
{
- int length; /* Length of value */
+ unsigned length; /* Length of value */
if (oid[1] < 0)
* packed integer value.
*/
-static int /* O - Size in bytes */
+static unsigned /* O - Size in bytes */
asn1_size_packed(int integer) /* I - Integer value */
{
if (integer > 0xfffffff)
packet->error = _cupsLangString(cg->lang_default, message);
}
-
-
-/*
- * End of "$Id$".
- */