/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */ /* * Dan Williams * Tambet Ingo * * 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. * * (C) Copyright 2007 - 2013 Red Hat, Inc. * (C) Copyright 2007 - 2008 Novell, Inc. */ #include #include #include "nm-setting-gsm.h" #include "nm-utils.h" #include "nm-setting-private.h" /** * SECTION:nm-setting-gsm * @short_description: Describes GSM/3GPP-based mobile broadband properties * @include: nm-setting-gsm.h * * The #NMSettingGsm object is a #NMSetting subclass that describes * properties that allow connections to 3GPP-based mobile broadband * networks, including those using GPRS/EDGE and UMTS/HSPA technology. */ /** * nm_setting_gsm_error_quark: * * Registers an error quark for #NMSettingGsm if necessary. * * Returns: the error quark used for #NMSettingGsm errors. **/ GQuark nm_setting_gsm_error_quark (void) { static GQuark quark; if (G_UNLIKELY (!quark)) quark = g_quark_from_static_string ("nm-setting-gsm-error-quark"); return quark; } G_DEFINE_TYPE_WITH_CODE (NMSettingGsm, nm_setting_gsm, NM_TYPE_SETTING, _nm_register_setting (NM_SETTING_GSM_SETTING_NAME, g_define_type_id, 1, NM_SETTING_GSM_ERROR)) NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_GSM) #define NM_SETTING_GSM_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_GSM, NMSettingGsmPrivate)) typedef struct { char *number; /* For dialing, duh */ char *username; char *password; NMSettingSecretFlags password_flags; char *apn; /* NULL for dynamic */ char *network_id; /* for manual registration or NULL for automatic */ int network_type; /* One of the NM_SETTING_GSM_NETWORK_TYPE_* */ guint32 allowed_bands; /* A bitfield of NM_SETTING_GSM_BAND_* */ char *pin; NMSettingSecretFlags pin_flags; gboolean home_only; } NMSettingGsmPrivate; enum { PROP_0, PROP_NUMBER, PROP_USERNAME, PROP_PASSWORD, PROP_PASSWORD_FLAGS, PROP_APN, PROP_NETWORK_ID, PROP_NETWORK_TYPE, PROP_PIN, PROP_PIN_FLAGS, PROP_ALLOWED_BANDS, PROP_HOME_ONLY, LAST_PROP }; /** * nm_setting_gsm_new: * * Creates a new #NMSettingGsm object with default values. * * Returns: the new empty #NMSettingGsm object **/ NMSetting * nm_setting_gsm_new (void) { return (NMSetting *) g_object_new (NM_TYPE_SETTING_GSM, NULL); } /** * nm_setting_gsm_get_number: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:number property of the setting **/ const char * nm_setting_gsm_get_number (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->number; } /** * nm_setting_gsm_get_username: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:username property of the setting **/ const char * nm_setting_gsm_get_username (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->username; } /** * nm_setting_gsm_get_password: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:password property of the setting **/ const char * nm_setting_gsm_get_password (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->password; } /** * nm_setting_gsm_get_password_flags: * @setting: the #NMSettingGsm * * Returns: the #NMSettingSecretFlags pertaining to the #NMSettingGsm:password **/ NMSettingSecretFlags nm_setting_gsm_get_password_flags (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NM_SETTING_SECRET_FLAG_NONE); return NM_SETTING_GSM_GET_PRIVATE (setting)->password_flags; } /** * nm_setting_gsm_get_apn: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:apn property of the setting **/ const char * nm_setting_gsm_get_apn (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->apn; } /** * nm_setting_gsm_get_network_id: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:network-id property of the setting **/ const char * nm_setting_gsm_get_network_id (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->network_id; } /** * nm_setting_gsm_get_network_type: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:network-type property of the setting **/ int nm_setting_gsm_get_network_type (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), -1); return NM_SETTING_GSM_GET_PRIVATE (setting)->network_type; } /** * nm_setting_gsm_get_allowed_bands: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:allowed-bands property of the setting **/ guint32 nm_setting_gsm_get_allowed_bands (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NM_SETTING_GSM_BAND_UNKNOWN); return NM_SETTING_GSM_GET_PRIVATE (setting)->allowed_bands; } /** * nm_setting_gsm_get_pin: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:pin property of the setting **/ const char * nm_setting_gsm_get_pin (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NULL); return NM_SETTING_GSM_GET_PRIVATE (setting)->pin; } /** * nm_setting_gsm_get_pin_flags: * @setting: the #NMSettingGsm * * Returns: the #NMSettingSecretFlags pertaining to the #NMSettingGsm:pin **/ NMSettingSecretFlags nm_setting_gsm_get_pin_flags (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), NM_SETTING_SECRET_FLAG_NONE); return NM_SETTING_GSM_GET_PRIVATE (setting)->pin_flags; } /** * nm_setting_gsm_get_home_only: * @setting: the #NMSettingGsm * * Returns: the #NMSettingGsm:home-only property of the setting **/ gboolean nm_setting_gsm_get_home_only (NMSettingGsm *setting) { g_return_val_if_fail (NM_IS_SETTING_GSM (setting), FALSE); return NM_SETTING_GSM_GET_PRIVATE (setting)->home_only; } static gboolean verify (NMSetting *setting, GSList *all_settings, GError **error) { NMSettingGsmPrivate *priv = NM_SETTING_GSM_GET_PRIVATE (setting); if (priv->number && !priv->number[0]) { g_set_error_literal (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("property is empty")); g_prefix_error (error, "%s: ", NM_SETTING_GSM_NUMBER); return FALSE; } if (priv->apn) { guint32 apn_len = strlen (priv->apn); guint32 i; if (apn_len < 1 || apn_len > 64) { g_set_error (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("property value '%s' is empty or too long (>64)"), priv->apn); g_prefix_error (error, "%s: ", NM_SETTING_GSM_APN); return FALSE; } /* APNs roughly follow the same rules as DNS domain names. Allowed * characters are a-z, 0-9, . and -. GSM 03.03 Section 9.1 states: * * The syntax of the APN shall follow the Name Syntax defined in * RFC 2181 [14] and RFC 1035 [15]. The APN consists of one or * more labels. Each label is coded as one octet length field * followed by that number of octets coded as 8 bit ASCII characters. * Following RFC 1035 [15] the labels should consist only of the * alphabetic characters (A-Z and a-z), digits (0-9) and the * dash (-). The case of alphabetic characters is not significant. * * A dot (.) is commonly used to separate parts of the APN, and * apparently the underscore (_) is used as well. RFC 2181 indicates * that no restrictions of any kind are placed on DNS labels, and thus * it would appear that none are placed on APNs either, but many modems * and networks will fail to accept APNs that include odd characters * like space ( ) and such. */ for (i = 0; i < apn_len; i++) { if ( !g_ascii_isalnum (priv->apn[i]) && (priv->apn[i] != '.') && (priv->apn[i] != '_') && (priv->apn[i] != '-')) { g_set_error (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("'%s' contains invalid char(s) (use [A-Za-z._-])"), priv->apn); g_prefix_error (error, "%s: ", NM_SETTING_GSM_APN); return FALSE; } } } if (priv->username && !strlen (priv->username)) { g_set_error_literal (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("property is empty")); g_prefix_error (error, "%s: ", NM_SETTING_GSM_USERNAME); return FALSE; } if (priv->password && !strlen (priv->password)) { g_set_error_literal (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("property is empty")); g_prefix_error (error, "%s: ", NM_SETTING_GSM_USERNAME); return FALSE; } if (priv->network_id) { guint32 nid_len = strlen (priv->network_id); guint32 i; /* Accept both 5 and 6 digit MCC/MNC codes */ if ((nid_len < 5) || (nid_len > 6)) { g_set_error (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("'%s' length is invalid (should be 5 or 6 digits)"), priv->network_id); g_prefix_error (error, "%s: ", NM_SETTING_GSM_NETWORK_ID); return FALSE; } for (i = 0; i < nid_len; i++) { if (!g_ascii_isdigit (priv->network_id[i])) { g_set_error (error, NM_SETTING_GSM_ERROR, NM_SETTING_GSM_ERROR_INVALID_PROPERTY, _("'%s' is not a number"), priv->network_id); g_prefix_error (error, "%s: ", NM_SETTING_GSM_NETWORK_ID); return FALSE; } } } return TRUE; } static GPtrArray * need_secrets (NMSetting *setting) { NMSettingGsmPrivate *priv = NM_SETTING_GSM_GET_PRIVATE (setting); GPtrArray *secrets = NULL; if (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_GSM_PASSWORD); } } return secrets; } static void nm_setting_gsm_init (NMSettingGsm *setting) { g_object_set (setting, NM_SETTING_NAME, NM_SETTING_GSM_SETTING_NAME, NULL); } static void finalize (GObject *object) { NMSettingGsmPrivate *priv = NM_SETTING_GSM_GET_PRIVATE (object); g_free (priv->number); g_free (priv->username); g_free (priv->password); g_free (priv->apn); g_free (priv->network_id); g_free (priv->pin); G_OBJECT_CLASS (nm_setting_gsm_parent_class)->finalize (object); } static void set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { NMSettingGsmPrivate *priv = NM_SETTING_GSM_GET_PRIVATE (object); char *tmp; 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_uint (value); break; case PROP_APN: g_free (priv->apn); priv->apn = NULL; tmp = g_value_dup_string (value); if (tmp) priv->apn = g_strstrip (tmp); break; case PROP_NETWORK_ID: g_free (priv->network_id); priv->network_id = NULL; tmp = g_value_dup_string (value); if (tmp) priv->network_id = g_strstrip (tmp); break; case PROP_NETWORK_TYPE: priv->network_type = g_value_get_int (value); break; case PROP_ALLOWED_BANDS: priv->allowed_bands = g_value_get_uint (value); break; case PROP_PIN: g_free (priv->pin); priv->pin = g_value_dup_string (value); break; case PROP_PIN_FLAGS: priv->pin_flags = g_value_get_uint (value); break; case PROP_HOME_ONLY: priv->home_only = 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) { NMSettingGsm *setting = NM_SETTING_GSM (object); switch (prop_id) { case PROP_NUMBER: g_value_set_string (value, nm_setting_gsm_get_number (setting)); break; case PROP_USERNAME: g_value_set_string (value, nm_setting_gsm_get_username (setting)); break; case PROP_PASSWORD: g_value_set_string (value, nm_setting_gsm_get_password (setting)); break; case PROP_PASSWORD_FLAGS: g_value_set_uint (value, nm_setting_gsm_get_password_flags (setting)); break; case PROP_APN: g_value_set_string (value, nm_setting_gsm_get_apn (setting)); break; case PROP_NETWORK_ID: g_value_set_string (value, nm_setting_gsm_get_network_id (setting)); break; case PROP_NETWORK_TYPE: g_value_set_int (value, nm_setting_gsm_get_network_type (setting)); break; case PROP_ALLOWED_BANDS: g_value_set_uint (value, nm_setting_gsm_get_allowed_bands (setting)); break; case PROP_PIN: g_value_set_string (value, nm_setting_gsm_get_pin (setting)); break; case PROP_PIN_FLAGS: g_value_set_uint (value, nm_setting_gsm_get_pin_flags (setting)); break; case PROP_HOME_ONLY: g_value_set_boolean (value, nm_setting_gsm_get_home_only (setting)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void nm_setting_gsm_class_init (NMSettingGsmClass *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 (NMSettingGsmPrivate)); /* virtual methods */ object_class->set_property = set_property; object_class->get_property = get_property; object_class->finalize = finalize; parent_class->verify = verify; parent_class->need_secrets = need_secrets; /* Properties */ /** * NMSettingGsm:number: * * Number to dial when establishing a PPP data session with the GSM-based * mobile broadband network. Many modems do not require PPP for connections * to the mobile network and thus this property should be left blank, which * allows NetworkManager to select the appropriate settings automatically. **/ g_object_class_install_property (object_class, PROP_NUMBER, g_param_spec_string (NM_SETTING_GSM_NUMBER, "Number", "Number to dial when establishing a PPP data session " "with the GSM-based mobile broadband network. Many " "modems do not require PPP for connections to the " "mobile network and thus this property should be left " "blank, which allows NetworkManager to select the " "appropriate settings automatically.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm: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. **/ g_object_class_install_property (object_class, PROP_USERNAME, g_param_spec_string (NM_SETTING_GSM_USERNAME, "Username", "Username used to authenticate with the network, if " "required. Note that many providers do not require " "a username or accept any username.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm: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. **/ g_object_class_install_property (object_class, PROP_PASSWORD, g_param_spec_string (NM_SETTING_GSM_PASSWORD, "Password", "Password used to authenticate with the network, if " "required. Note that many providers do not require " "a password or accept any password.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE | NM_SETTING_PARAM_SECRET)); /** * NMSettingGsm:password-flags: * * Flags indicating how to handle #NMSettingGsm:password:. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_GSM_PASSWORD_FLAGS, "Password Flags", "Flags indicating how to handle the GSM password.", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:apn: * * The GPRS Access Point Name specifying the APN used when establishing a * data session with the GSM-based network. The APN often determines how * the user will be billed for their network usage and whether the user has * access to the Internet or just a provider-specific walled-garden, so it * is important to use the correct APN for the user's mobile broadband plan. * The APN may only be composed of the characters a-z, 0-9, ., and - per * GSM 03.60 Section 14.9. **/ g_object_class_install_property (object_class, PROP_APN, g_param_spec_string (NM_SETTING_GSM_APN, "APN", "The GPRS Access Point Name specifying the APN used " "when establishing a data session with the GSM-based " "network. The APN often determines how the user will " "be billed for their network usage and whether the " "user has access to the Internet or just a provider-" "specific walled-garden, so it is important to use " "the correct APN for the user's mobile broadband " "plan. The APN may only be composed of the characters " "a-z, 0-9, ., and - per GSM 03.60 Section 14.9.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:network-id: * * The Network ID (GSM LAI format, ie MCC-MNC) to force specific network * registration. If the Network ID is specified, NetworkManager will * attempt to force the device to register only on the specified network. * This can be used to ensure that the device does not roam when direct * roaming control of the device is not otherwise possible. **/ g_object_class_install_property (object_class, PROP_NETWORK_ID, g_param_spec_string (NM_SETTING_GSM_NETWORK_ID, "Network ID", "The Network ID (GSM LAI format, ie MCC-MNC) to force " "specific network registration. If the Network ID is " "specified, NetworkManager will attempt to force the " "device to register only on the specified network. " "This can be used to ensure that the device does not " "roam when direct roaming control of the device is " "not otherwise possible.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:network-type: * * Network preference to force the device to only use specific network * technologies. Permitted values are those specified by * #NMSettingGsmNetworkType. Note that not all devices allow network * preference control. **/ g_object_class_install_property (object_class, PROP_NETWORK_TYPE, g_param_spec_int (NM_SETTING_GSM_NETWORK_TYPE, "Network type", "Network preference to force the device to only use " "specific network technologies. The permitted values " "are: -1: any, 0: 3G only, 1: GPRS/EDGE only, " "2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. " "Note that not all devices allow network preference control.", NM_SETTING_GSM_NETWORK_TYPE_ANY, NM_SETTING_GSM_NETWORK_TYPE_4G, NM_SETTING_GSM_NETWORK_TYPE_ANY, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:allowed-bands: * * Bitfield of allowed frequency bands. Note that not all devices allow * frequency band control. Permitted values are those specified by * #NMSettingGsmNetworkBand. **/ g_object_class_install_property (object_class, PROP_ALLOWED_BANDS, g_param_spec_uint (NM_SETTING_GSM_ALLOWED_BANDS, "Allowed Bands", "Bitfield of allowed frequency bands. Note that " "not all devices allow frequency band control.", NM_SETTING_GSM_BAND_UNKNOWN, NM_SETTING_GSM_BAND_UNKNOWN || NM_SETTING_GSM_BAND_ANY || NM_SETTING_GSM_BAND_EGSM || NM_SETTING_GSM_BAND_DCS || NM_SETTING_GSM_BAND_PCS || NM_SETTING_GSM_BAND_G850 || NM_SETTING_GSM_BAND_U2100 || NM_SETTING_GSM_BAND_U1800 || NM_SETTING_GSM_BAND_U17IV || NM_SETTING_GSM_BAND_U800 || NM_SETTING_GSM_BAND_U850 || NM_SETTING_GSM_BAND_U900 || NM_SETTING_GSM_BAND_U17IX || NM_SETTING_GSM_BAND_U1900 || NM_SETTING_GSM_BAND_U2600, NM_SETTING_GSM_BAND_ANY, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:pin: * * If the SIM is locked with a PIN it must be unlocked before any other * operations are requested. Specify the PIN here to allow operation of * the device. **/ g_object_class_install_property (object_class, PROP_PIN, g_param_spec_string (NM_SETTING_GSM_PIN, "PIN", "If the SIM is locked with a PIN it must be unlocked " "before any other operations are requested. Specify " "the PIN here to allow operation of the device.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE | NM_SETTING_PARAM_SECRET)); /** * NMSettingGsm:pin-flags: * * Flags indicating how to handle #NMSettingGsm:pin. **/ g_object_class_install_property (object_class, PROP_PIN_FLAGS, g_param_spec_uint (NM_SETTING_GSM_PIN_FLAGS, "PIN Flags", "Flags indicating how to handle the GSM SIM PIN.", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); /** * NMSettingGsm:home-only: * * When TRUE, only connections to the home network will be allowed. * Connections to roaming networks will not be made. **/ g_object_class_install_property (object_class, PROP_HOME_ONLY, g_param_spec_boolean (NM_SETTING_GSM_HOME_ONLY, "Home Only", "When TRUE, only connections to the home network will " "be allowed. Connections to roaming networks will " "not be made.", FALSE, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); }