NetworkManager/src/libnm-core-impl/nm-setting-cdma.c
Thomas Haller fdf9614ba7
build: move "libnm-core/" to "src/" and split it
"libnm-core/" is rather complicated. It provides a static library that
is linked into libnm.so and NetworkManager. It also contains public
headers (like "nm-setting.h") which are part of public libnm API.

Then we have helper libraries ("libnm-core/nm-libnm-core-*/") which
only rely on public API of libnm-core, but are themself static
libraries that can be used by anybody who uses libnm-core. And
"libnm-core/nm-libnm-core-intern" is used by libnm-core itself.

Move "libnm-core/" to "src/". But also split it in different
directories so that they have a clearer purpose.

The goal is to have a flat directory hierarchy. The "src/libnm-core*/"
directories correspond to the different modules (static libraries and set
of headers that we have). We have different kinds of such modules because
of how we combine various code together. The directory layout now reflects
this.
2021-02-18 19:46:51 +01:00

358 lines
11 KiB
C

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2007 - 2013 Red Hat, Inc.
*/
#include "libnm-core-impl/nm-default-libnm-core.h"
#include "nm-setting-cdma.h"
#include "nm-utils.h"
#include "nm-setting-private.h"
#include "nm-core-enum-types.h"
/**
* SECTION:nm-setting-cdma
* @short_description: Describes CDMA-based mobile broadband properties
*
* The #NMSettingCdma object is a #NMSetting subclass that describes
* properties that allow connections to IS-95-based mobile broadband
* networks, including those using CDMA2000/EVDO technology.
*/
/*****************************************************************************/
NM_GOBJECT_PROPERTIES_DEFINE_BASE(PROP_NUMBER,
PROP_USERNAME,
PROP_PASSWORD,
PROP_PASSWORD_FLAGS,
PROP_MTU, );
typedef struct {
char * number; /* For dialing, duh */
char * username;
char * password;
guint32 mtu;
NMSettingSecretFlags password_flags;
} NMSettingCdmaPrivate;
G_DEFINE_TYPE(NMSettingCdma, nm_setting_cdma, NM_TYPE_SETTING)
#define NM_SETTING_CDMA_GET_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE((o), NM_TYPE_SETTING_CDMA, NMSettingCdmaPrivate))
/*****************************************************************************/
/**
* nm_setting_cdma_get_number:
* @setting: the #NMSettingCdma
*
* Returns: the #NMSettingCdma:number property of the setting
**/
const char *
nm_setting_cdma_get_number(NMSettingCdma *setting)
{
g_return_val_if_fail(NM_IS_SETTING_CDMA(setting), NULL);
return NM_SETTING_CDMA_GET_PRIVATE(setting)->number;
}
/**
* nm_setting_cdma_get_username:
* @setting: the #NMSettingCdma
*
* Returns: the #NMSettingCdma:username property of the setting
**/
const char *
nm_setting_cdma_get_username(NMSettingCdma *setting)
{
g_return_val_if_fail(NM_IS_SETTING_CDMA(setting), NULL);
return NM_SETTING_CDMA_GET_PRIVATE(setting)->username;
}
/**
* nm_setting_cdma_get_password:
* @setting: the #NMSettingCdma
*
* Returns: the #NMSettingCdma:password property of the setting
**/
const char *
nm_setting_cdma_get_password(NMSettingCdma *setting)
{
g_return_val_if_fail(NM_IS_SETTING_CDMA(setting), NULL);
return NM_SETTING_CDMA_GET_PRIVATE(setting)->password;
}
/**
* nm_setting_cdma_get_password_flags:
* @setting: the #NMSettingCdma
*
* Returns: the #NMSettingSecretFlags pertaining to the #NMSettingCdma:password
**/
NMSettingSecretFlags
nm_setting_cdma_get_password_flags(NMSettingCdma *setting)
{
g_return_val_if_fail(NM_IS_SETTING_CDMA(setting), NM_SETTING_SECRET_FLAG_NONE);
return NM_SETTING_CDMA_GET_PRIVATE(setting)->password_flags;
}
/**
* nm_setting_cdma_get_mtu:
* @setting: the #NMSettingCdma
*
* Returns: the #NMSettingCdma:mtu property of the setting
*
* Since: 1.8
**/
guint32
nm_setting_cdma_get_mtu(NMSettingCdma *setting)
{
g_return_val_if_fail(NM_IS_SETTING_CDMA(setting), 0);
return NM_SETTING_CDMA_GET_PRIVATE(setting)->mtu;
}
static gboolean
verify(NMSetting *setting, NMConnection *connection, GError **error)
{
NMSettingCdmaPrivate *priv = NM_SETTING_CDMA_GET_PRIVATE(setting);
if (!priv->number) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_PROPERTY,
_("property is missing"));
g_prefix_error(error, "%s.%s: ", NM_SETTING_CDMA_SETTING_NAME, NM_SETTING_CDMA_NUMBER);
return FALSE;
} else if (!strlen(priv->number)) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("property is empty"));
g_prefix_error(error, "%s.%s: ", NM_SETTING_CDMA_SETTING_NAME, NM_SETTING_CDMA_NUMBER);
return FALSE;
}
if (priv->username && !strlen(priv->username)) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("property is empty"));
g_prefix_error(error, "%s.%s: ", NM_SETTING_CDMA_SETTING_NAME, NM_SETTING_CDMA_USERNAME);
return FALSE;
}
return TRUE;
}
static gboolean
verify_secrets(NMSetting *setting, NMConnection *connection, GError **error)
{
return _nm_setting_verify_secret_string(NM_SETTING_CDMA_GET_PRIVATE(setting)->password,
NM_SETTING_CDMA_SETTING_NAME,
NM_SETTING_CDMA_PASSWORD,
error);
}
static GPtrArray *
need_secrets(NMSetting *setting)
{
NMSettingCdmaPrivate *priv = NM_SETTING_CDMA_GET_PRIVATE(setting);
GPtrArray * secrets = NULL;
if (priv->password && *priv->password)
return NULL;
if (priv->username) {
if (!(priv->password_flags & NM_SETTING_SECRET_FLAG_NOT_REQUIRED)) {
secrets = g_ptr_array_sized_new(1);
g_ptr_array_add(secrets, NM_SETTING_CDMA_PASSWORD);
}
}
return secrets;
}
/*****************************************************************************/
static void
get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
{
NMSettingCdma *setting = NM_SETTING_CDMA(object);
switch (prop_id) {
case PROP_NUMBER:
g_value_set_string(value, nm_setting_cdma_get_number(setting));
break;
case PROP_USERNAME:
g_value_set_string(value, nm_setting_cdma_get_username(setting));
break;
case PROP_PASSWORD:
g_value_set_string(value, nm_setting_cdma_get_password(setting));
break;
case PROP_PASSWORD_FLAGS:
g_value_set_flags(value, nm_setting_cdma_get_password_flags(setting));
break;
case PROP_MTU:
g_value_set_uint(value, nm_setting_cdma_get_mtu(setting));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
static void
set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
{
NMSettingCdmaPrivate *priv = NM_SETTING_CDMA_GET_PRIVATE(object);
switch (prop_id) {
case PROP_NUMBER:
g_free(priv->number);
priv->number = g_value_dup_string(value);
break;
case PROP_USERNAME:
g_free(priv->username);
priv->username = g_value_dup_string(value);
break;
case PROP_PASSWORD:
g_free(priv->password);
priv->password = g_value_dup_string(value);
break;
case PROP_PASSWORD_FLAGS:
priv->password_flags = g_value_get_flags(value);
break;
case PROP_MTU:
priv->mtu = g_value_get_uint(value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
/*****************************************************************************/
static void
nm_setting_cdma_init(NMSettingCdma *setting)
{}
/**
* nm_setting_cdma_new:
*
* Creates a new #NMSettingCdma object with default values.
*
* Returns: the new empty #NMSettingCdma object
**/
NMSetting *
nm_setting_cdma_new(void)
{
return g_object_new(NM_TYPE_SETTING_CDMA, NULL);
}
static void
finalize(GObject *object)
{
NMSettingCdmaPrivate *priv = NM_SETTING_CDMA_GET_PRIVATE(object);
g_free(priv->number);
g_free(priv->username);
g_free(priv->password);
G_OBJECT_CLASS(nm_setting_cdma_parent_class)->finalize(object);
}
static void
nm_setting_cdma_class_init(NMSettingCdmaClass *klass)
{
GObjectClass * object_class = G_OBJECT_CLASS(klass);
NMSettingClass *setting_class = NM_SETTING_CLASS(klass);
g_type_class_add_private(klass, sizeof(NMSettingCdmaPrivate));
object_class->get_property = get_property;
object_class->set_property = set_property;
object_class->finalize = finalize;
setting_class->verify = verify;
setting_class->verify_secrets = verify_secrets;
setting_class->need_secrets = need_secrets;
/**
* NMSettingCdma:number:
*
* The number to dial to establish the connection to the CDMA-based mobile
* broadband network, if any. If not specified, the default number (#777)
* is used when required.
**/
obj_properties[PROP_NUMBER] = g_param_spec_string(NM_SETTING_CDMA_NUMBER,
"",
"",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingCdma:username:
*
* The username used to authenticate with the network, if required. Many
* providers do not require a username, or accept any username. But if a
* username is required, it is specified here.
**/
obj_properties[PROP_USERNAME] = g_param_spec_string(NM_SETTING_CDMA_USERNAME,
"",
"",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingCdma:password:
*
* The password used to authenticate with the network, if required. Many
* providers do not require a password, or accept any password. But if a
* password is required, it is specified here.
**/
obj_properties[PROP_PASSWORD] =
g_param_spec_string(NM_SETTING_CDMA_PASSWORD,
"",
"",
NULL,
G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | G_PARAM_STATIC_STRINGS);
/**
* NMSettingCdma:password-flags:
*
* Flags indicating how to handle the #NMSettingCdma:password property.
**/
obj_properties[PROP_PASSWORD_FLAGS] =
g_param_spec_flags(NM_SETTING_CDMA_PASSWORD_FLAGS,
"",
"",
NM_TYPE_SETTING_SECRET_FLAGS,
NM_SETTING_SECRET_FLAG_NONE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingCdma:mtu:
*
* If non-zero, only transmit packets of the specified size or smaller,
* breaking larger packets up into multiple frames.
*
* Since: 1.8
**/
obj_properties[PROP_MTU] = g_param_spec_uint(NM_SETTING_CDMA_MTU,
"",
"",
0,
G_MAXUINT32,
0,
G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE
| G_PARAM_STATIC_STRINGS);
g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);
_nm_setting_class_commit(setting_class, NM_META_SETTING_TYPE_CDMA);
}