lib/isc/sockaddr.c

	sockaddr.c revision 87cafc5e70f79f2586d067fbdd64f61bbab069d2
/*
 * Copyright (C) 1999, 2000  Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */

#include <config.h>

#include <stdio.h>

#include <isc/buffer.h>
#include <isc/netaddr.h>
#include <isc/print.h>
#include <isc/region.h>
#include <isc/sockaddr.h>
#include <isc/string.h>
#include <isc/util.h>

isc_boolean_t
isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
    REQUIRE(a != NULL && b != NULL);

    if (a->length != b->length)
        return (ISC_FALSE);

    /*
     * We don't just memcmp because the sin_zero field isn't always
     * zero.
     */

    if (a->type.sa.sa_family != b->type.sa.sa_family)
        return (ISC_FALSE);
    switch (a->type.sa.sa_family) {
    case AF_INET:
        if (memcmp(&a->type.sin.sin_addr, &b->type.sin.sin_addr,
               sizeof a->type.sin.sin_addr) != 0)
            return (ISC_FALSE);
        if (a->type.sin.sin_port != b->type.sin.sin_port)
            return (ISC_FALSE);
        break;
    case AF_INET6:
        if (memcmp(&a->type.sin6.sin6_addr, &b->type.sin6.sin6_addr,
               sizeof a->type.sin6.sin6_addr) != 0)
            return (ISC_FALSE);
        if (a->type.sin6.sin6_port != b->type.sin6.sin6_port)
            return (ISC_FALSE);
        break;
    default:
        if (memcmp(&a->type, &b->type, a->length) != 0)
            return (ISC_FALSE);
    }
    return (ISC_TRUE);
}

/*
 * Compare just the addresses (ignore ports)
 */
isc_boolean_t
isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
    REQUIRE(a != NULL && b != NULL);

    if (a->length != b->length)
        return (ISC_FALSE);

    if (a->type.sa.sa_family != b->type.sa.sa_family)
        return (ISC_FALSE);
    switch (a->type.sa.sa_family) {
    case AF_INET:
        if (memcmp(&a->type.sin.sin_addr, &b->type.sin.sin_addr,
               sizeof a->type.sin.sin_addr) != 0)
            return (ISC_FALSE);
        break;
    case AF_INET6:
        if (memcmp(&a->type.sin6.sin6_addr, &b->type.sin6.sin6_addr,
               sizeof a->type.sin6.sin6_addr) != 0)
            return (ISC_FALSE);
        break;
    default:
        if (memcmp(&a->type, &b->type, a->length) != 0)
            return (ISC_FALSE);
    }
    return (ISC_TRUE);
}

/*
 * Compare just a prefix of the addresses (ignore ports and
 * low address bits)
 */

isc_boolean_t
isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
              unsigned int prefixlen)
{
    isc_netaddr_t na, nb;
    isc_netaddr_fromsockaddr(&na, a);
    isc_netaddr_fromsockaddr(&nb, b);
    return (isc_netaddr_eqprefix(&na, &nb, prefixlen));
}

isc_result_t
isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target) {
    isc_result_t result;
    isc_netaddr_t netaddr;
    char pbuf[sizeof "65000"];
    unsigned int plen;
    isc_region_t avail;

    REQUIRE(sockaddr != NULL);

    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
    result = isc_netaddr_totext(&netaddr, target);
    if (result != ISC_R_SUCCESS)
        return (result);

    switch (sockaddr->type.sa.sa_family) {
    case AF_INET:
        sprintf(pbuf, "%u", ntohs(sockaddr->type.sin.sin_port));
        break;
    case AF_INET6:
        sprintf(pbuf, "%u", ntohs(sockaddr->type.sin6.sin6_port));
        break;
    default:
        INSIST(0);
        break;
    }

    plen = strlen(pbuf);
    INSIST(plen < sizeof(pbuf));

    if (1 + plen + 1 > isc_buffer_availablelength(target))
        return (ISC_R_NOSPACE);

    isc_buffer_putmem(target, (const unsigned char *)"#", 1);
    isc_buffer_putmem(target, (const unsigned char *)pbuf, plen);

    /*
     * Null terminate after used region.
     */
    isc_buffer_availableregion(target, &avail);
    INSIST(avail.length >= 1);
    avail.base[0] = '\0';

    return (ISC_R_SUCCESS);
}

void
isc_sockaddr_format(isc_sockaddr_t *sa, char *array, unsigned int size) {
    isc_result_t result;
    isc_buffer_t buf;

    isc_buffer_init(&buf, array, size);
    result = isc_sockaddr_totext(sa, &buf);
    if (result != ISC_R_SUCCESS) {
        snprintf(array, size,
             "<unknown address, family %u>",
             sa->type.sa.sa_family);
        array[size - 1] = '\0';
    }
}

unsigned int
isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, isc_boolean_t address_only) {
    unsigned int length;
    const unsigned char *s;
    unsigned int h = 0;
    unsigned int g;

    /*
     * Provide a hash value for 'sockaddr'.
     */

    REQUIRE(sockaddr != NULL);

    if (address_only) {
        switch (sockaddr->type.sa.sa_family) {
        case AF_INET:
            return (ntohl(sockaddr->type.sin.sin_addr.s_addr));
        case AF_INET6:
            s = (const unsigned char *)&sockaddr->
                               type.sin6.sin6_addr;
            length = sizeof sockaddr->type.sin6.sin6_addr;
            break;
        default:
            UNEXPECTED_ERROR(__FILE__, __LINE__,
                     "unknown address family: %d",
                     (int)sockaddr->type.sa.sa_family);
            s = (const unsigned char *)&sockaddr->type;
            length = sockaddr->length;
        }
    } else {
        s = (const unsigned char *)&sockaddr->type;
        length = sockaddr->length;
    }

    while (length > 0) {
        h = ( h << 4 ) + *s;
        if ((g = ( h & 0xf0000000 )) != 0) {
            h = h ^ (g >> 24);
            h = h ^ g;
        }
        s++;
        length--;
    }
    return (h);
}

void
isc_sockaddr_any(isc_sockaddr_t *sockaddr)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin.sin_family = AF_INET;
#ifdef ISC_PLATFORM_HAVESALEN
    sockaddr->type.sin.sin_len = sizeof sockaddr->type.sin;
#endif
    sockaddr->type.sin.sin_addr.s_addr = INADDR_ANY;
    sockaddr->type.sin.sin_port = 0;
    sockaddr->length = sizeof sockaddr->type.sin;
    ISC_LINK_INIT(sockaddr, link);
}

void
isc_sockaddr_any6(isc_sockaddr_t *sockaddr)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin6.sin6_family = AF_INET6;
#ifdef ISC_PLATFORM_HAVESALEN
    sockaddr->type.sin6.sin6_len = sizeof sockaddr->type.sin6;
#endif
    sockaddr->type.sin6.sin6_addr = in6addr_any;
    sockaddr->type.sin6.sin6_port = 0;
    sockaddr->length = sizeof sockaddr->type.sin6;
    ISC_LINK_INIT(sockaddr, link);
}

void
isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
            in_port_t port)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin.sin_family = AF_INET;
#ifdef ISC_PLATFORM_HAVESALEN
    sockaddr->type.sin.sin_len = sizeof sockaddr->type.sin;
#endif
    sockaddr->type.sin.sin_addr = *ina;
    sockaddr->type.sin.sin_port = htons(port);
    sockaddr->length = sizeof sockaddr->type.sin;
    ISC_LINK_INIT(sockaddr, link);
}

void
isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
             in_port_t port)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin6.sin6_family = AF_INET6;
#ifdef ISC_PLATFORM_HAVESALEN
    sockaddr->type.sin6.sin6_len = sizeof sockaddr->type.sin6;
#endif
    sockaddr->type.sin6.sin6_addr = *ina6;
    sockaddr->type.sin6.sin6_port = htons(port);
    sockaddr->length = sizeof sockaddr->type.sin6;
    ISC_LINK_INIT(sockaddr, link);
}

void
isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
              in_port_t port)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin6.sin6_family = AF_INET6;
#ifdef ISC_PLATFORM_HAVESALEN
    sockaddr->type.sin6.sin6_len = sizeof sockaddr->type.sin6;
#endif
    sockaddr->type.sin6.sin6_addr.s6_addr[10] = 0xff;
    sockaddr->type.sin6.sin6_addr.s6_addr[11] = 0xff;
    memcpy(&sockaddr->type.sin6.sin6_addr.s6_addr[12], ina, 4);
    sockaddr->type.sin6.sin6_port = htons(port);
    sockaddr->length = sizeof sockaddr->type.sin6;
    ISC_LINK_INIT(sockaddr, link);
}

int
isc_sockaddr_pf(const isc_sockaddr_t *sockaddr) {

    /*
     * Get the protocol family of 'sockaddr'.
     */

#if (AF_INET == PF_INET && AF_INET6 == PF_INET6)
    /*
     * Assume that PF_xxx == AF_xxx for all AF and PF.
     */
    return (sockaddr->type.sa.sa_family);
#else
    switch (sockaddr->type.sa.sa_family) {
    case AF_INET:
        return (PF_INET);
    case AF_INET6:
        return (PF_INET);
    default:
        FATAL_ERROR(__FILE__, __LINE__, "unknown address family");
    }
#endif
}

void
isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
            in_port_t port)
{
    memset(sockaddr, 0, sizeof *sockaddr);
    sockaddr->type.sin.sin_family = na->family;
    switch (na->family) {
    case AF_INET:
        sockaddr->length = sizeof sockaddr->type.sin;
#ifdef ISC_PLATFORM_HAVESALEN
        sockaddr->type.sin.sin_len = sizeof sockaddr->type.sin;
#endif
        sockaddr->type.sin.sin_addr = na->type.in;
        sockaddr->type.sin.sin_port = htons(port);
        break;
    case AF_INET6:
        sockaddr->length = sizeof sockaddr->type.sin6;
#ifdef ISC_PLATFORM_HAVESALEN
        sockaddr->type.sin6.sin6_len = sizeof sockaddr->type.sin6;
#endif
        memcpy(&sockaddr->type.sin6.sin6_addr, &na->type.in6, 16);
        sockaddr->type.sin6.sin6_port = htons(port);
        break;
        default:
                INSIST(0);
    }
    ISC_LINK_INIT(sockaddr, link);
}

void
isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port) {
    switch (sockaddr->type.sa.sa_family) {
    case AF_INET:
        sockaddr->type.sin.sin_port = htons(port);
        break;
    case AF_INET6:
        sockaddr->type.sin6.sin6_port = htons(port);
        break;
    default:
        FATAL_ERROR(__FILE__, __LINE__, "unknown address family");
    }
}

in_port_t
isc_sockaddr_getport(isc_sockaddr_t *sockaddr) {
    in_port_t port = 0;

    switch (sockaddr->type.sa.sa_family) {
    case AF_INET:
        port = ntohs(sockaddr->type.sin.sin_port);
        break;
    case AF_INET6:
        port = ntohs(sockaddr->type.sin6.sin6_port);
        break;
    default:
        FATAL_ERROR(__FILE__, __LINE__, "unknown address family");
    }

    return (port);
}