glib/gio/ginetsocketaddress.c
Dan Winship a60014f1b6 GInetSocketAddress: fix the byte order of flowinfo and scope_id
The flowinfo and scope_id fields of struct sockaddr_in6 are in host
byte order, but the code previously assumed they were in network byte
order. Fix that.

This is an ABI-breaking change (since before you would have had to use
g_ntohl() and g_htonl() with them to get the correct values, and now
that would give the wrong values), but the previous behavior was
clearly wrong, and no one ever reported it, so it is likely that no
one was actually using it.

https://bugzilla.gnome.org/show_bug.cgi?id=684404
2013-01-30 16:46:02 -05:00

423 lines
13 KiB
C

/* GIO - GLib Input, Output and Streaming Library
*
* Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* Authors: Christian Kellner <gicmo@gnome.org>
* Samuel Cormier-Iijima <sciyoshi@gmail.com>
*/
#include <config.h>
#include <glib.h>
#include <string.h>
#include "ginetsocketaddress.h"
#include "ginetaddress.h"
#include "gnetworkingprivate.h"
#include "gioerror.h"
#include "glibintl.h"
/**
* SECTION:ginetsocketaddress
* @short_description: Internet GSocketAddress
*
* An IPv4 or IPv6 socket address; that is, the combination of a
* #GInetAddress and a port number.
*/
/**
* GInetSocketAddress:
*
* An IPv4 or IPv6 socket address, corresponding to a <type>struct
* sockaddr_in</type> or <type>struct sockaddr_in6</type>.
*/
G_DEFINE_TYPE (GInetSocketAddress, g_inet_socket_address, G_TYPE_SOCKET_ADDRESS);
enum {
PROP_0,
PROP_ADDRESS,
PROP_PORT,
PROP_FLOWINFO,
PROP_SCOPE_ID
};
struct _GInetSocketAddressPrivate
{
GInetAddress *address;
guint16 port;
guint32 flowinfo;
guint32 scope_id;
};
static void
g_inet_socket_address_finalize (GObject *object)
{
GInetSocketAddress *address G_GNUC_UNUSED = G_INET_SOCKET_ADDRESS (object);
if (G_OBJECT_CLASS (g_inet_socket_address_parent_class)->finalize)
(*G_OBJECT_CLASS (g_inet_socket_address_parent_class)->finalize) (object);
}
static void
g_inet_socket_address_dispose (GObject *object)
{
GInetSocketAddress *address G_GNUC_UNUSED = G_INET_SOCKET_ADDRESS (object);
g_object_unref (address->priv->address);
if (G_OBJECT_CLASS (g_inet_socket_address_parent_class)->dispose)
(*G_OBJECT_CLASS (g_inet_socket_address_parent_class)->dispose) (object);
}
static void
g_inet_socket_address_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GInetSocketAddress *address = G_INET_SOCKET_ADDRESS (object);
switch (prop_id)
{
case PROP_ADDRESS:
g_value_set_object (value, address->priv->address);
break;
case PROP_PORT:
g_value_set_uint (value, address->priv->port);
break;
case PROP_FLOWINFO:
g_return_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6);
g_value_set_uint (value, address->priv->flowinfo);
break;
case PROP_SCOPE_ID:
g_return_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6);
g_value_set_uint (value, address->priv->scope_id);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
g_inet_socket_address_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GInetSocketAddress *address = G_INET_SOCKET_ADDRESS (object);
switch (prop_id)
{
case PROP_ADDRESS:
address->priv->address = g_object_ref (g_value_get_object (value));
break;
case PROP_PORT:
address->priv->port = (guint16) g_value_get_uint (value);
break;
case PROP_FLOWINFO:
/* We can't test that address->priv->address is IPv6 here,
* since this property might get set before PROP_ADDRESS.
*/
address->priv->flowinfo = g_value_get_uint (value);
break;
case PROP_SCOPE_ID:
address->priv->scope_id = g_value_get_uint (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static GSocketFamily
g_inet_socket_address_get_family (GSocketAddress *address)
{
GInetSocketAddress *addr;
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
addr = G_INET_SOCKET_ADDRESS (address);
return g_inet_address_get_family (addr->priv->address);
}
static gssize
g_inet_socket_address_get_native_size (GSocketAddress *address)
{
GInetSocketAddress *addr;
GSocketFamily family;
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
addr = G_INET_SOCKET_ADDRESS (address);
family = g_inet_address_get_family (addr->priv->address);
if (family == AF_INET)
return sizeof (struct sockaddr_in);
else if (family == AF_INET6)
return sizeof (struct sockaddr_in6);
else
return -1;
}
static gboolean
g_inet_socket_address_to_native (GSocketAddress *address,
gpointer dest,
gsize destlen,
GError **error)
{
GInetSocketAddress *addr;
GSocketFamily family;
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), FALSE);
addr = G_INET_SOCKET_ADDRESS (address);
family = g_inet_address_get_family (addr->priv->address);
if (family == AF_INET)
{
struct sockaddr_in *sock = (struct sockaddr_in *) dest;
if (destlen < sizeof (*sock))
{
g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NO_SPACE,
_("Not enough space for socket address"));
return FALSE;
}
sock->sin_family = AF_INET;
sock->sin_port = g_htons (addr->priv->port);
memcpy (&(sock->sin_addr.s_addr), g_inet_address_to_bytes (addr->priv->address), sizeof (sock->sin_addr));
memset (sock->sin_zero, 0, sizeof (sock->sin_zero));
return TRUE;
}
else if (family == AF_INET6)
{
struct sockaddr_in6 *sock = (struct sockaddr_in6 *) dest;
if (destlen < sizeof (*sock))
{
g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NO_SPACE,
_("Not enough space for socket address"));
return FALSE;
}
memset (sock, 0, sizeof (*sock));
sock->sin6_family = AF_INET6;
sock->sin6_port = g_htons (addr->priv->port);
sock->sin6_flowinfo = addr->priv->flowinfo;
sock->sin6_scope_id = addr->priv->scope_id;
memcpy (&(sock->sin6_addr.s6_addr), g_inet_address_to_bytes (addr->priv->address), sizeof (sock->sin6_addr));
return TRUE;
}
else
{
g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
_("Unsupported socket address"));
return FALSE;
}
}
static void
g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GSocketAddressClass *gsocketaddress_class = G_SOCKET_ADDRESS_CLASS (klass);
g_type_class_add_private (klass, sizeof (GInetSocketAddressPrivate));
gobject_class->finalize = g_inet_socket_address_finalize;
gobject_class->dispose = g_inet_socket_address_dispose;
gobject_class->set_property = g_inet_socket_address_set_property;
gobject_class->get_property = g_inet_socket_address_get_property;
gsocketaddress_class->get_family = g_inet_socket_address_get_family;
gsocketaddress_class->to_native = g_inet_socket_address_to_native;
gsocketaddress_class->get_native_size = g_inet_socket_address_get_native_size;
g_object_class_install_property (gobject_class, PROP_ADDRESS,
g_param_spec_object ("address",
P_("Address"),
P_("The address"),
G_TYPE_INET_ADDRESS,
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_PORT,
g_param_spec_uint ("port",
P_("Port"),
P_("The port"),
0,
65535,
0,
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GInetSocketAddress:flowinfo:
*
* The <literal>sin6_flowinfo</literal> field, for IPv6 addresses.
*
* Since: 2.32
*/
g_object_class_install_property (gobject_class, PROP_FLOWINFO,
g_param_spec_uint ("flowinfo",
P_("Flow info"),
P_("IPv6 flow info"),
0,
G_MAXUINT32,
0,
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GInetSocketAddress:scope_id:
*
* The <literal>sin6_scope_id</literal> field, for IPv6 addresses.
*
* Since: 2.32
*/
g_object_class_install_property (gobject_class, PROP_SCOPE_ID,
g_param_spec_uint ("scope-id",
P_("Scope ID"),
P_("IPv6 scope ID"),
0,
G_MAXUINT32,
0,
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
}
static void
g_inet_socket_address_init (GInetSocketAddress *address)
{
address->priv = G_TYPE_INSTANCE_GET_PRIVATE (address,
G_TYPE_INET_SOCKET_ADDRESS,
GInetSocketAddressPrivate);
}
/**
* g_inet_socket_address_new:
* @address: a #GInetAddress
* @port: a port number
*
* Creates a new #GInetSocketAddress for @address and @port.
*
* Returns: a new #GInetSocketAddress
*
* Since: 2.22
*/
GSocketAddress *
g_inet_socket_address_new (GInetAddress *address,
guint16 port)
{
return g_object_new (G_TYPE_INET_SOCKET_ADDRESS,
"address", address,
"port", port,
NULL);
}
/**
* g_inet_socket_address_get_address:
* @address: a #GInetSocketAddress
*
* Gets @address's #GInetAddress.
*
* Returns: (transfer none): the #GInetAddress for @address, which must be
* g_object_ref()'d if it will be stored
*
* Since: 2.22
*/
GInetAddress *
g_inet_socket_address_get_address (GInetSocketAddress *address)
{
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), NULL);
return address->priv->address;
}
/**
* g_inet_socket_address_get_port:
* @address: a #GInetSocketAddress
*
* Gets @address's port.
*
* Returns: the port for @address
*
* Since: 2.22
*/
guint16
g_inet_socket_address_get_port (GInetSocketAddress *address)
{
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
return address->priv->port;
}
/**
* g_inet_socket_address_get_flowinfo:
* @address: a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress
*
* Gets the <literal>sin6_flowinfo</literal> field from @address,
* which must be an IPv6 address.
*
* Return value: the flowinfo field
*
* Since: 2.32
*/
guint32
g_inet_socket_address_get_flowinfo (GInetSocketAddress *address)
{
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
g_return_val_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6, 0);
return address->priv->flowinfo;
}
/**
* g_inet_socket_address_get_scope_id:
* @address: a %G_SOCKET_FAMILY_IPV6 #GInetAddress
*
* Gets the <literal>sin6_scope_id</literal> field from @address,
* which must be an IPv6 address.
*
* Return value: the scope id field
*
* Since: 2.32
*/
guint32
g_inet_socket_address_get_scope_id (GInetSocketAddress *address)
{
g_return_val_if_fail (G_IS_INET_SOCKET_ADDRESS (address), 0);
g_return_val_if_fail (g_inet_address_get_family (address->priv->address) == G_SOCKET_FAMILY_IPV6, 0);
return address->priv->scope_id;
}