cmdline: use SPDX tags
[dpdk.git] / lib / librte_cmdline / cmdline_parse_ipaddr.c
index 66a1493..ae6ea10 100644 (file)
@@ -1,63 +1,7 @@
-/*-
- *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
- *   All rights reserved.
- * 
- *   Redistribution and use in source and binary forms, with or without 
- *   modification, are permitted provided that the following conditions 
- *   are met:
- * 
- *     * Redistributions of source code must retain the above copyright 
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright 
- *       notice, this list of conditions and the following disclaimer in 
- *       the documentation and/or other materials provided with the 
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its 
- *       contributors may be used to endorse or promote products derived 
- *       from this software without specific prior written permission.
- * 
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
- *  version: DPDK.L.1.2.3-3
- */
-
-/*
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation.
  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  * All rights reserved.
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the University of California, Berkeley nor the
- *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 /*
 #include <errno.h>
 #include <netinet/in.h>
 #ifndef __linux__
+#ifndef __FreeBSD__
 #include <net/socket.h>
+#else
+#include <sys/socket.h>
+#endif
 #endif
 
 #include <rte_string_fns.h>
@@ -106,6 +54,8 @@ struct cmdline_token_ops cmdline_token_ipaddr_ops = {
 
 #define INADDRSZ 4
 #define IN6ADDRSZ 16
+#define PREFIXMAX 128
+#define V4PREFIXMAX 32
 
 /*
  * WARNING: Don't even consider trying to compile this on a system where
@@ -131,12 +81,12 @@ my_inet_pton(int af, const char *src, void *dst)
 {
        switch (af) {
                case AF_INET:
-                       return (inet_pton4(src, dst));
+                       return inet_pton4(src, dst);
                case AF_INET6:
-                       return (inet_pton6(src, dst));
+                       return inet_pton6(src, dst);
                default:
                        errno = EAFNOSUPPORT;
-                       return (-1);
+                       return -1;
        }
        /* NOTREACHED */
 }
@@ -168,26 +118,26 @@ inet_pton4(const char *src, unsigned char *dst)
                        unsigned int new = *tp * 10 + (pch - digits);
 
                        if (new > 255)
-                               return (0);
+                               return 0;
                        if (! saw_digit) {
                                if (++octets > 4)
-                                       return (0);
+                                       return 0;
                                saw_digit = 1;
                        }
                        *tp = (unsigned char)new;
                } else if (ch == '.' && saw_digit) {
                        if (octets == 4)
-                               return (0);
+                               return 0;
                        *++tp = 0;
                        saw_digit = 0;
                } else
-                       return (0);
+                       return 0;
        }
        if (octets < 4)
-               return (0);
+               return 0;
 
        memcpy(dst, tmp, INADDRSZ);
-       return (1);
+       return 1;
 }
 
 /* int
@@ -208,10 +158,11 @@ inet_pton6(const char *src, unsigned char *dst)
 {
        static const char xdigits_l[] = "0123456789abcdef",
                xdigits_u[] = "0123456789ABCDEF";
-       unsigned char tmp[IN6ADDRSZ], *tp, *endp, *colonp;
-       const char *xdigits, *curtok;
-       int ch, saw_xdigit, count_xdigit;
-       unsigned int val;
+       unsigned char tmp[IN6ADDRSZ], *tp = 0, *endp = 0, *colonp = 0;
+       const char *xdigits = 0, *curtok = 0;
+       int ch = 0, saw_xdigit = 0, count_xdigit = 0;
+       unsigned int val = 0;
+       unsigned dbloct_count = 0;
 
        memset((tp = tmp), '\0', IN6ADDRSZ);
        endp = tp + IN6ADDRSZ;
@@ -219,10 +170,11 @@ inet_pton6(const char *src, unsigned char *dst)
        /* Leading :: requires some special handling. */
        if (*src == ':')
                if (*++src != ':')
-                       return (0);
+                       return 0;
        curtok = src;
        saw_xdigit = count_xdigit = 0;
        val = 0;
+
        while ((ch = *src++) != '\0') {
                const char *pch;
 
@@ -230,11 +182,11 @@ inet_pton6(const char *src, unsigned char *dst)
                        pch = strchr((xdigits = xdigits_u), ch);
                if (pch != NULL) {
                        if (count_xdigit >= 4)
-                               return (0);
+                               return 0;
                        val <<= 4;
                        val |= (pch - xdigits);
                        if (val > 0xffff)
-                               return (0);
+                               return 0;
                        saw_xdigit = 1;
                        count_xdigit++;
                        continue;
@@ -243,37 +195,43 @@ inet_pton6(const char *src, unsigned char *dst)
                        curtok = src;
                        if (!saw_xdigit) {
                                if (colonp)
-                                       return (0);
+                                       return 0;
                                colonp = tp;
                                continue;
                        } else if (*src == '\0') {
-                               return (0);
+                               return 0;
                        }
                        if (tp + sizeof(int16_t) > endp)
-                               return (0);
+                               return 0;
                        *tp++ = (unsigned char) ((val >> 8) & 0xff);
                        *tp++ = (unsigned char) (val & 0xff);
                        saw_xdigit = 0;
                        count_xdigit = 0;
                        val = 0;
+                       dbloct_count++;
                        continue;
                }
                if (ch == '.' && ((tp + INADDRSZ) <= endp) &&
                    inet_pton4(curtok, tp) > 0) {
                        tp += INADDRSZ;
                        saw_xdigit = 0;
-                       count_xdigit = 0;
+                       dbloct_count += 2;
                        break;  /* '\0' was seen by inet_pton4(). */
                }
-               return (0);
+               return 0;
        }
        if (saw_xdigit) {
                if (tp + sizeof(int16_t) > endp)
-                       return (0);
+                       return 0;
                *tp++ = (unsigned char) ((val >> 8) & 0xff);
                *tp++ = (unsigned char) (val & 0xff);
+               dbloct_count++;
        }
        if (colonp != NULL) {
+               /* if we already have 8 double octets, having a colon means error */
+               if (dbloct_count == 8)
+                       return 0;
+
                /*
                 * Since some memmove()'s erroneously fail to handle
                 * overlapping regions, we'll do the shift by hand.
@@ -288,24 +246,30 @@ inet_pton6(const char *src, unsigned char *dst)
                tp = endp;
        }
        if (tp != endp)
-               return (0);
+               return 0;
        memcpy(dst, tmp, IN6ADDRSZ);
-       return (1);
+       return 1;
 }
 
 int
-cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
+cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res,
+       unsigned ressize)
 {
-       struct cmdline_token_ipaddr *tk2 = (struct cmdline_token_ipaddr *)tk;
+       struct cmdline_token_ipaddr *tk2;
        unsigned int token_len = 0;
        char ip_str[INET6_ADDRSTRLEN+4+1]; /* '+4' is for prefixlen (if any) */
        cmdline_ipaddr_t ipaddr;
        char *prefix, *prefix_end;
-       long prefixlen;
+       long prefixlen = 0;
+
+       if (res && ressize < sizeof(cmdline_ipaddr_t))
+               return -1;
 
-       if (! *buf)
+       if (!buf || !tk || ! *buf)
                return -1;
 
+       tk2 = (struct cmdline_token_ipaddr *)tk;
+
        while (!cmdline_isendoftoken(buf[token_len]))
                token_len++;
 
@@ -313,7 +277,7 @@ cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
        if (token_len >= INET6_ADDRSTRLEN+4)
                return -1;
 
-       rte_snprintf(ip_str, token_len+1, "%s", buf);
+       snprintf(ip_str, token_len+1, "%s", buf);
 
        /* convert the network prefix */
        if (tk2->ipaddr_data.flags & CMDLINE_IPADDR_NETWORK) {
@@ -324,7 +288,8 @@ cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
                prefix ++;
                errno = 0;
                prefixlen = strtol(prefix, &prefix_end, 10);
-               if (errno || (*prefix_end != '\0') )
+               if (errno || (*prefix_end != '\0')
+                       || prefixlen < 0 || prefixlen > PREFIXMAX)
                        return -1;
                ipaddr.prefixlen = prefixlen;
        }
@@ -334,16 +299,17 @@ cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 
        /* convert the IP addr */
        if ((tk2->ipaddr_data.flags & CMDLINE_IPADDR_V4) &&
-           my_inet_pton(AF_INET, ip_str, &ipaddr.addr.ipv4) == 1) {
+           my_inet_pton(AF_INET, ip_str, &ipaddr.addr.ipv4) == 1 &&
+               prefixlen <= V4PREFIXMAX) {
                ipaddr.family = AF_INET;
-               if (res != NULL)
+               if (res)
                        memcpy(res, &ipaddr, sizeof(ipaddr));
                return token_len;
        }
        if ((tk2->ipaddr_data.flags & CMDLINE_IPADDR_V6) &&
            my_inet_pton(AF_INET6, ip_str, &ipaddr.addr.ipv6) == 1) {
                ipaddr.family = AF_INET6;
-               if (res != NULL)
+               if (res)
                        memcpy(res, &ipaddr, sizeof(ipaddr));
                return token_len;
        }
@@ -354,29 +320,34 @@ cmdline_parse_ipaddr(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 int cmdline_get_help_ipaddr(cmdline_parse_token_hdr_t *tk, char *dstbuf,
                            unsigned int size)
 {
-       struct cmdline_token_ipaddr *tk2 = (struct cmdline_token_ipaddr *)tk;
+       struct cmdline_token_ipaddr *tk2;
+
+       if (!tk || !dstbuf)
+               return -1;
+
+       tk2 = (struct cmdline_token_ipaddr *)tk;
 
        switch (tk2->ipaddr_data.flags) {
        case CMDLINE_IPADDR_V4:
-               rte_snprintf(dstbuf, size, "IPv4");
+               snprintf(dstbuf, size, "IPv4");
                break;
        case CMDLINE_IPADDR_V6:
-               rte_snprintf(dstbuf, size, "IPv6");
+               snprintf(dstbuf, size, "IPv6");
                break;
        case CMDLINE_IPADDR_V4|CMDLINE_IPADDR_V6:
-               rte_snprintf(dstbuf, size, "IPv4/IPv6");
+               snprintf(dstbuf, size, "IPv4/IPv6");
                break;
        case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V4:
-               rte_snprintf(dstbuf, size, "IPv4 network");
+               snprintf(dstbuf, size, "IPv4 network");
                break;
        case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V6:
-               rte_snprintf(dstbuf, size, "IPv6 network");
+               snprintf(dstbuf, size, "IPv6 network");
                break;
        case CMDLINE_IPADDR_NETWORK|CMDLINE_IPADDR_V4|CMDLINE_IPADDR_V6:
-               rte_snprintf(dstbuf, size, "IPv4/IPv6 network");
+               snprintf(dstbuf, size, "IPv4/IPv6 network");
                break;
        default:
-               rte_snprintf(dstbuf, size, "IPaddr (bad flags)");
+               snprintf(dstbuf, size, "IPaddr (bad flags)");
                break;
        }
        return 0;