libnm-core: add NMSettingTun

Add a new NMSettingTun which contains configuration properties for TUN/TAP
interfaces.
This commit is contained in:
Beniamino Galvani 2015-09-14 22:56:51 +02:00
parent fa96bade79
commit 1f30147a7a
10 changed files with 537 additions and 0 deletions

View file

@ -33,6 +33,7 @@ libnm_core_headers = \
$(core)/nm-setting-serial.h \
$(core)/nm-setting-team-port.h \
$(core)/nm-setting-team.h \
$(core)/nm-setting-tun.h \
$(core)/nm-setting-vlan.h \
$(core)/nm-setting-vpn.h \
$(core)/nm-setting-wimax.h \
@ -89,6 +90,7 @@ libnm_core_sources = \
$(core)/nm-setting-serial.c \
$(core)/nm-setting-team-port.c \
$(core)/nm-setting-team.c \
$(core)/nm-setting-tun.c \
$(core)/nm-setting-vlan.c \
$(core)/nm-setting-vpn.c \
$(core)/nm-setting-wimax.c \

View file

@ -1949,6 +1949,24 @@ nm_connection_get_setting_serial (NMConnection *connection)
return (NMSettingSerial *) nm_connection_get_setting (connection, NM_TYPE_SETTING_SERIAL);
}
/**
* nm_connection_get_setting_tun:
* @connection: the #NMConnection
*
* A shortcut to return any #NMSettingTun the connection might contain.
*
* Returns: (transfer none): an #NMSettingTun if the connection contains one, otherwise %NULL
*
* Since: 1.2
**/
NMSettingTun *
nm_connection_get_setting_tun (NMConnection *connection)
{
g_return_val_if_fail (NM_IS_CONNECTION (connection), NULL);
return (NMSettingTun *) nm_connection_get_setting (connection, NM_TYPE_SETTING_TUN);
}
/**
* nm_connection_get_setting_vpn:
* @connection: the #NMConnection

View file

@ -208,6 +208,7 @@ NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnec
NMSettingPpp * nm_connection_get_setting_ppp (NMConnection *connection);
NMSettingPppoe * nm_connection_get_setting_pppoe (NMConnection *connection);
NMSettingSerial * nm_connection_get_setting_serial (NMConnection *connection);
NMSettingTun * nm_connection_get_setting_tun (NMConnection *connection);
NMSettingVpn * nm_connection_get_setting_vpn (NMConnection *connection);
NMSettingWimax * nm_connection_get_setting_wimax (NMConnection *connection);
NMSettingAdsl * nm_connection_get_setting_adsl (NMConnection *connection);

View file

@ -57,6 +57,7 @@
#include "nm-setting-serial.h"
#include "nm-setting-team-port.h"
#include "nm-setting-team.h"
#include "nm-setting-tun.h"
#include "nm-setting-vlan.h"
#include "nm-setting-vpn.h"
#include "nm-setting-wimax.h"

View file

@ -50,6 +50,7 @@ typedef struct _NMSettingPppoe NMSettingPppoe;
typedef struct _NMSettingSerial NMSettingSerial;
typedef struct _NMSettingTeam NMSettingTeam;
typedef struct _NMSettingTeamPort NMSettingTeamPort;
typedef struct _NMSettingTun NMSettingTun;
typedef struct _NMSettingVlan NMSettingVlan;
typedef struct _NMSettingVpn NMSettingVpn;
typedef struct _NMSettingWimax NMSettingWimax;

409
libnm-core/nm-setting-tun.c Normal file
View file

@ -0,0 +1,409 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
* 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2015 Red Hat, Inc.
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include "nm-setting-tun.h"
#include "nm-utils.h"
#include "nm-setting-connection.h"
#include "nm-setting-private.h"
#include "nm-connection-private.h"
/**
* SECTION:nm-setting-tun
* @short_description: Describes connection properties for TUN/TAP interfaces
*
* The #NMSettingTun object is a #NMSetting subclass that describes properties
* necessary for connection to TUN/TAP interfaces.
**/
G_DEFINE_TYPE_WITH_CODE (NMSettingTun, nm_setting_tun, NM_TYPE_SETTING,
_nm_register_setting (TUN, 1))
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_TUN)
#define NM_SETTING_TUN_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_TUN, NMSettingTunPrivate))
typedef struct {
NMSettingTunMode mode;
char *owner;
char *group;
gboolean pi;
gboolean vnet_hdr;
gboolean multi_queue;
} NMSettingTunPrivate;
enum {
PROP_0,
PROP_MODE,
PROP_OWNER,
PROP_GROUP,
PROP_PI,
PROP_VNET_HDR,
PROP_MULTI_QUEUE,
LAST_PROP
};
/**
* nm_setting_tun_new:
*
* Creates a new #NMSettingTun object with default values.
*
* Returns: (transfer full): the new empty #NMSettingTun object
*
* Since: 1.2
**/
NMSetting *
nm_setting_tun_new (void)
{
return (NMSetting *) g_object_new (NM_TYPE_SETTING_TUN, NULL);
}
/**
* nm_setting_tun_get_mode:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:mode property of the setting
*
* Since: 1.2
**/
NMSettingTunMode
nm_setting_tun_get_mode (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), NM_SETTING_TUN_MODE_TUN);
return NM_SETTING_TUN_GET_PRIVATE (setting)->mode;
}
/**
* nm_setting_tun_get_owner:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:owner property of the setting
*
* Since: 1.2
**/
const char *
nm_setting_tun_get_owner (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), NULL);
return NM_SETTING_TUN_GET_PRIVATE (setting)->owner;
}
/**
* nm_setting_tun_get_group:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:group property of the setting
*
* Since: 1.2
**/
const char *
nm_setting_tun_get_group (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), NULL);
return NM_SETTING_TUN_GET_PRIVATE (setting)->group;
}
/**
* nm_setting_tun_get_pi:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:pi property of the setting
*
* Since: 1.2
**/
gboolean
nm_setting_tun_get_pi (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), FALSE);
return NM_SETTING_TUN_GET_PRIVATE (setting)->pi;
}
/**
* nm_setting_tun_get_vnet_hdr:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:vnet_hdr property of the setting
*
* Since: 1.2
**/
gboolean
nm_setting_tun_get_vnet_hdr (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), FALSE);
return NM_SETTING_TUN_GET_PRIVATE (setting)->vnet_hdr;
}
/**
* nm_setting_tun_get_multi_queue:
* @setting: the #NMSettingTun
*
* Returns: the #NMSettingTun:multi-queue property of the setting
*
* Since: 1.2
**/
gboolean
nm_setting_tun_get_multi_queue (NMSettingTun *setting)
{
g_return_val_if_fail (NM_IS_SETTING_TUN (setting), FALSE);
return NM_SETTING_TUN_GET_PRIVATE (setting)->multi_queue;
}
static void
nm_setting_tun_init (NMSettingTun *setting)
{
}
static gboolean
verify (NMSetting *setting, NMConnection *connection, GError **error)
{
NMSettingTunPrivate *priv = NM_SETTING_TUN_GET_PRIVATE (setting);
if ( priv->mode != NM_SETTING_TUN_MODE_TUN
&& priv->mode != NM_SETTING_TUN_MODE_TAP) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("'%u': invalid mode"), (unsigned int) priv->mode);
g_prefix_error (error, "%s.%s: ", NM_SETTING_TUN_SETTING_NAME, NM_SETTING_TUN_MODE);
return FALSE;
}
if (priv->owner) {
if (_nm_utils_ascii_str_to_int64 (priv->owner, 10, 0, G_MAXINT32, -1) == -1) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("'%s': invalid user ID"), priv->owner);
g_prefix_error (error, "%s.%s: ", NM_SETTING_TUN_SETTING_NAME, NM_SETTING_TUN_OWNER);
return FALSE;
}
}
if (priv->group) {
if (_nm_utils_ascii_str_to_int64 (priv->group, 10, 0, G_MAXINT32, -1) == -1) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("'%s': invalid group ID"), priv->group);
g_prefix_error (error, "%s.%s: ", NM_SETTING_TUN_SETTING_NAME, NM_SETTING_TUN_GROUP);
return FALSE;
}
}
return TRUE;
}
static void
set_property (GObject *object, guint prop_id,
const GValue *value, GParamSpec *pspec)
{
NMSettingTun *setting = NM_SETTING_TUN (object);
NMSettingTunPrivate *priv = NM_SETTING_TUN_GET_PRIVATE (setting);
switch (prop_id) {
case PROP_MODE:
priv->mode = g_value_get_uint (value);
break;
case PROP_OWNER:
g_free (priv->owner);
priv->owner = g_value_dup_string (value);
break;
case PROP_GROUP:
g_free (priv->group);
priv->group = g_value_dup_string (value);
break;
case PROP_PI:
priv->pi = g_value_get_boolean (value);
break;
case PROP_VNET_HDR:
priv->vnet_hdr = g_value_get_boolean (value);
break;
case PROP_MULTI_QUEUE:
priv->multi_queue = g_value_get_boolean (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec)
{
NMSettingTun *setting = NM_SETTING_TUN (object);
NMSettingTunPrivate *priv = NM_SETTING_TUN_GET_PRIVATE (setting);
switch (prop_id) {
case PROP_MODE:
g_value_set_uint (value, priv->mode);
break;
case PROP_OWNER:
g_value_set_string (value, priv->owner);
break;
case PROP_GROUP:
g_value_set_string (value, priv->group);
break;
case PROP_PI:
g_value_set_boolean (value, priv->pi);
break;
case PROP_VNET_HDR:
g_value_set_boolean (value, priv->vnet_hdr);
break;
case PROP_MULTI_QUEUE:
g_value_set_boolean (value, priv->multi_queue);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
finalize (GObject *object)
{
NMSettingTun *setting = NM_SETTING_TUN (object);
NMSettingTunPrivate *priv = NM_SETTING_TUN_GET_PRIVATE (setting);
g_free (priv->owner);
g_free (priv->group);
G_OBJECT_CLASS (nm_setting_tun_parent_class)->finalize (object);
}
static void
nm_setting_tun_class_init (NMSettingTunClass *setting_class)
{
GObjectClass *object_class = G_OBJECT_CLASS (setting_class);
NMSettingClass *parent_class = NM_SETTING_CLASS (setting_class);
g_type_class_add_private (setting_class, sizeof (NMSettingTunPrivate));
/* virtual methods */
object_class->set_property = set_property;
object_class->get_property = get_property;
object_class->finalize = finalize;
parent_class->verify = verify;
/* Properties */
/**
* NMSettingTun:mode:
*
* The operating mode of the virtual device. Allowed values are
* %NM_SETTING_TUN_MODE_TUN to create a layer 3 device and
* %NM_SETTING_TUN_MODE_TAP to create an Ethernet-like layer 2
* one.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_MODE,
g_param_spec_uint (NM_SETTING_TUN_MODE, "", "",
0, G_MAXUINT, NM_SETTING_TUN_MODE_TUN,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTun:owner:
*
* The user ID which will own the device. If set to %NULL everyone
* will be able to use the device.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_OWNER,
g_param_spec_string (NM_SETTING_TUN_OWNER, "", "",
NULL,
G_PARAM_READWRITE |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTun:group:
*
* The group ID which will own the device. If set to %NULL everyone
* will be able to use the device.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_GROUP,
g_param_spec_string (NM_SETTING_TUN_GROUP, "", "",
NULL,
G_PARAM_READWRITE |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTun:pi:
*
* If %TRUE the interface will prepend a 4 byte header describing the
* physical interface to the packets.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_PI,
g_param_spec_boolean (NM_SETTING_TUN_PI, "", "",
FALSE,
G_PARAM_READWRITE |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTun:vnet-hdr:
*
* If %TRUE the IFF_VNET_HDR the tunnel packets will include a virtio
* network header.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_VNET_HDR,
g_param_spec_boolean (NM_SETTING_TUN_VNET_HDR, "", "",
FALSE,
G_PARAM_READWRITE |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTun:multi-queue:
*
* If the property is set to %TRUE, the interface will support
* multiple file descriptors (queues) to parallelize packet
* sending or receiving. Otherwise, the interface will only
* support a single queue.
*
* Since: 1.2
*/
g_object_class_install_property
(object_class, PROP_MULTI_QUEUE,
g_param_spec_boolean (NM_SETTING_TUN_MULTI_QUEUE, "", "",
FALSE,
G_PARAM_READWRITE |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
}

View file

@ -0,0 +1,94 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
* 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2015 Red Hat, Inc.
*/
#ifndef __NM_SETTING_TUN_H__
#define __NM_SETTING_TUN_H__
#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
#error "Only <NetworkManager.h> can be included directly."
#endif
#include "nm-setting.h"
G_BEGIN_DECLS
#define NM_TYPE_SETTING_TUN (nm_setting_tun_get_type ())
#define NM_SETTING_TUN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_TUN, NMSettingTun))
#define NM_SETTING_TUN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_TUNCONFIG, NMSettingTunClass))
#define NM_IS_SETTING_TUN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_TUN))
#define NM_IS_SETTING_TUN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_TUN))
#define NM_SETTING_TUN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_TUN, NMSettingTunClass))
#define NM_SETTING_TUN_SETTING_NAME "tun"
#define NM_SETTING_TUN_MODE "mode"
#define NM_SETTING_TUN_OWNER "owner"
#define NM_SETTING_TUN_GROUP "group"
#define NM_SETTING_TUN_PI "pi"
#define NM_SETTING_TUN_VNET_HDR "vnet-hdr"
#define NM_SETTING_TUN_MULTI_QUEUE "multi-queue"
/**
* NMSettingTunMode:
* @NM_SETTING_TUN_MODE_UNKNOWN: an unknown device type
* @NM_SETTING_TUN_MODE_TUN: a TUN device
* @NM_SETTING_TUN_MODE_TAP: a TAP device
*
* #NMSettingTunMode values indicate the device type (TUN/TAP)
*/
typedef enum {
NM_SETTING_TUN_MODE_UNKNOWN = 0,
NM_SETTING_TUN_MODE_TUN = 1,
NM_SETTING_TUN_MODE_TAP = 2,
} NMSettingTunMode;
struct _NMSettingTun {
NMSetting parent;
};
typedef struct {
NMSettingClass parent;
/*< private >*/
gpointer padding[4];
} NMSettingTunClass;
NM_AVAILABLE_IN_1_2
GType nm_setting_tun_get_type (void);
NM_AVAILABLE_IN_1_2
NMSetting *nm_setting_tun_new (void);
NM_AVAILABLE_IN_1_2
NMSettingTunMode nm_setting_tun_get_mode (NMSettingTun *setting);
NM_AVAILABLE_IN_1_2
const char *nm_setting_tun_get_owner (NMSettingTun *setting);
NM_AVAILABLE_IN_1_2
const char *nm_setting_tun_get_group (NMSettingTun *setting);
NM_AVAILABLE_IN_1_2
gboolean nm_setting_tun_get_pi (NMSettingTun *setting);
NM_AVAILABLE_IN_1_2
gboolean nm_setting_tun_get_vnet_hdr (NMSettingTun *setting);
NM_AVAILABLE_IN_1_2
gboolean nm_setting_tun_get_multi_queue (NMSettingTun *setting);
G_END_DECLS
#endif /* __NM_SETTING_TUN_H__ */

View file

@ -69,6 +69,7 @@
#include <nm-setting-serial.h>
#include <nm-setting-team-port.h>
#include <nm-setting-team.h>
#include <nm-setting-tun.h>
#include <nm-setting-vlan.h>
#include <nm-setting-vpn.h>
#include <nm-setting-wimax.h>

View file

@ -897,6 +897,15 @@ global:
nm_setting_ip_config_remove_dns_option;
nm_setting_ip_config_remove_dns_option_by_value;
nm_setting_mac_randomization_get_type;
nm_setting_tun_get_group;
nm_setting_tun_get_mode;
nm_setting_tun_get_multi_queue;
nm_setting_tun_get_owner;
nm_setting_tun_get_pi;
nm_setting_tun_get_type;
nm_setting_tun_get_vnet_hdr;
nm_setting_tun_mode_get_type;
nm_setting_tun_new;
nm_setting_verify_secrets;
nm_setting_vpn_get_timeout;
nm_setting_wired_get_wake_on_lan;

View file

@ -69,6 +69,7 @@ libnm-core/nm-setting-olpc-mesh.c
libnm-core/nm-setting-ppp.c
libnm-core/nm-setting-pppoe.c
libnm-core/nm-setting-team-port.c
libnm-core/nm-setting-tun.c
libnm-core/nm-setting-vlan.c
libnm-core/nm-setting-vpn.c
libnm-core/nm-setting-wimax.c