libnm-util

---

Description:

Network management framework, utils.

• Home: http://projects.gnome.org/NetworkManager/
• C-Documentation: https://developer-old.gnome.org/libnm-util/unstable/
• Devhelp-Package download

Content:

Namespaces:

• NM

Classes:

• Connection - The NMConnection struct contains only private data.
• IP4Address
• IP4Route
• IP6Address
• IP6Route
• Setting - The NMSetting struct contains only private data.
• Setting8021x
• SettingAdsl
• SettingBluetooth
• SettingBond
• SettingBridge
• SettingBridgePort
• SettingCdma
• SettingConnection - The NMSettingConnection struct contains only private data.
• SettingDcb
• SettingGeneric
• SettingGsm
• SettingIP4Config
• SettingIP6Config
• SettingInfiniband
• SettingOlpcMesh
• SettingPPP
• SettingPPPOE
• SettingSerial
• SettingTeam
• SettingTeamPort
• SettingVPN
• SettingVlan
• SettingWimax
• SettingWired
• SettingWireless
• SettingWirelessSecurity

Enums:

• @80211ApFlags - 802.11 access point flags.
• @80211ApSecurityFlags - 802.11 access point security and authentication flags.
• @80211Mode - Indicates the 802.11 mode an access point or device is currently in.
• ActiveConnectionState - ActiveConnectionState values indicate the state of a connection to a specific network while it is starting, connected, or disconnecting from that network.
• BluetoothCapabilities - BluetoothCapabilities values indicate the usable capabilities of a Bluetooth device.
• ConnectivityState
• DeviceCapabilities - General device capability flags.
• DeviceModemCapabilities - DeviceModemCapabilities values indicate the generic radio access technology families a modem device supports.
• DeviceState
• DeviceStateReason - Device state change reason codes
• DeviceType - DeviceType values indicate the type of hardware represented by an NMDevice.
• DeviceWifiCapabilities - 802.11 specific device encryption and authentication capabilities.
• Setting8021xCKFormat - Setting8021xCKFormat values indicate the general type of a certificate or private key
• Setting8021xCKScheme - Setting8021xCKScheme values indicate how a certificate or private key is stored in the setting properties, either as a blob of the item's data, or as a path to a certificate or private key file on the filesystem
• SettingCompareFlags - These flags modify the comparison behavior when comparing two settings or two connections.
• SettingDcbFlags - DCB feature flags.
• SettingDiffResult - These values indicate the result of a setting difference operation.
• SettingGsmNetworkBand - SettingGsmNetworkBand values indicate the allowed frequency bands the device may use when connecting to this network.
• SettingGsmNetworkType - SettingGsmNetworkType values indicate the allowed access technologies the device may use when connecting to this network.
• SettingHashFlags - These flags determine which properties are added to the resulting hash when calling to_hash.
• SettingIP6ConfigPrivacy - SettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy Extensions are used (RFC4941).
• SettingSecretFlags - These flags indicate specific behavior related to handling of a secret.
• State - State values indicate the current overall networking state.
• VPNConnectionState - VPN connection states
• VPNConnectionStateReason - VPN connection state reasons
• VPNPluginFailure - VPN plugin failure reasons
• VPNServiceState - VPN daemon states
• VlanFlags - VlanFlags values control the behavior of the VLAN interface.
• VlanPriorityMap - A selector for traffic priority maps; these map Linux SKB priorities to 802.1p priorities used in VLANs.
• WepKeyType - The WepKeyType values specify how any WEP keys present in the setting are interpreted.

Error domains:

• ConnectionError - Describes errors that may result from operations involving a Connection.
• Setting8021xError
• SettingAdslError
• SettingBluetoothError
• SettingBondError
• SettingBridgeError
• SettingBridgePortError
• SettingCdmaError
• SettingConnectionError - Describes errors that may result from operations involving a SettingConnection .
• SettingDcbError
• SettingError - Describes errors that may result from operations involving a Setting.
• SettingGenericError
• SettingGsmError
• SettingIP4ConfigError
• SettingIP6ConfigError
• SettingInfinibandError
• SettingOlpcMeshError
• SettingPPPError
• SettingPPPOEError
• SettingSerialError
• SettingTeamError
• SettingTeamPortError
• SettingVlanError
• SettingVpnError
• SettingWimaxError
• SettingWiredError
• SettingWirelessError
• SettingWirelessSecurityError

Constants:

• public const string CONNECTION_CHANGED
• public const string CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD
• public const string CONNECTION_PATH
• public const string CONNECTION_SECRETS_CLEARED
• public const string CONNECTION_SECRETS_UPDATED
• public const string DBUS_IFACE_SETTINGS
• public const string DBUS_IFACE_SETTINGS_CONNECTION
• public const string DBUS_IFACE_SETTINGS_CONNECTION_SECRETS
• public const string DBUS_INTERFACE
• public const string DBUS_INTERFACE_VPN
• public const string DBUS_INTERFACE_VPN_CONNECTION
• public const string DBUS_INVALID_VPN_CONNECTION
• public const string DBUS_NO_ACTIVE_VPN_CONNECTION
• public const string DBUS_NO_VPN_CONNECTIONS
• public const string DBUS_PATH
• public const string DBUS_PATH_AGENT_MANAGER
• public const string DBUS_PATH_SECRET_AGENT
• public const string DBUS_PATH_SETTINGS
• public const string DBUS_PATH_SETTINGS_CONNECTION
• public const string DBUS_PATH_VPN
• public const string DBUS_PATH_VPN_CONNECTION
• public const string DBUS_SERVICE
• public const string DBUS_VPN_ALREADY_STARTED
• public const string DBUS_VPN_ALREADY_STOPPED
• public const string DBUS_VPN_BAD_ARGUMENTS
• public const string DBUS_VPN_ERROR_PREFIX
• public const string DBUS_VPN_INTERACTIVE_NOT_SUPPORTED
• public const string DBUS_VPN_SIGNAL_CONNECT_FAILED
• public const string DBUS_VPN_SIGNAL_IP4_CONFIG
• public const string DBUS_VPN_SIGNAL_IP_CONFIG_BAD
• public const string DBUS_VPN_SIGNAL_LAUNCH_FAILED
• public const string DBUS_VPN_SIGNAL_LOGIN_BANNER
• public const string DBUS_VPN_SIGNAL_LOGIN_FAILED
• public const string DBUS_VPN_SIGNAL_STATE_CHANGE
• public const string DBUS_VPN_SIGNAL_VPN_CONFIG_BAD
• public const string DBUS_VPN_STARTING_IN_PROGRESS
• public const string DBUS_VPN_STOPPING_IN_PROGRESS
• public const string DBUS_VPN_WRONG_STATE
• public const int MAJOR_VERSION
  Evaluates to the major version number of NetworkManager which this source is compiled against.
• public const int MICRO_VERSION
  Evaluates to the micro version number of NetworkManager which this source compiled against.
• public const int MINOR_VERSION
  Evaluates to the minor version number of NetworkManager which this source is compiled against.
• public const string SETTING_DCB_APP_FCOE_FLAGS
• public const string SETTING_DCB_APP_FCOE_MODE
• public const string SETTING_DCB_APP_FCOE_PRIORITY
• public const string SETTING_DCB_APP_FIP_FLAGS
• public const string SETTING_DCB_APP_FIP_PRIORITY
• public const string SETTING_DCB_APP_ISCSI_FLAGS
• public const string SETTING_DCB_APP_ISCSI_PRIORITY
• public const string SETTING_DCB_FCOE_MODE_FABRIC
  Indicates that the FCoE controller should use "fabric" mode (default)
• public const string SETTING_DCB_FCOE_MODE_VN2VN
  Indicates that the FCoE controller should use "VN2VN" mode.
• public const string SETTING_DCB_PRIORITY_BANDWIDTH
• public const string SETTING_DCB_PRIORITY_FLOW_CONTROL
• public const string SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS
• public const string SETTING_DCB_PRIORITY_GROUP_BANDWIDTH
• public const string SETTING_DCB_PRIORITY_GROUP_FLAGS
• public const string SETTING_DCB_PRIORITY_GROUP_ID
• public const string SETTING_DCB_PRIORITY_STRICT_BANDWIDTH
• public const string SETTING_DCB_PRIORITY_TRAFFIC_CLASS
• public const string SETTING_DCB_SETTING_NAME
• public const string SETTING_NAME
• public const int VLAN_FLAGS_ALL

Delegates:

• public delegate bool SettingClearSecretsWithFlagsFn (Setting setting, string secret, SettingSecretFlags flags)
• public delegate void SettingValueIterFn (Setting setting, string key, Value value, ParamFlags flags)
• public delegate bool UtilsFileSearchInPathsPredicate (string filename)
• public delegate void VPNIterFunc (string key, string value)
• SettingIP4

Constants:

• public const string CONFIG_ADDRESSES
• public const string CONFIG_DHCP_CLIENT_ID
• public const string CONFIG_DHCP_HOSTNAME
• public const string CONFIG_DHCP_SEND_HOSTNAME
• public const string CONFIG_DHCP_TIMEOUT
• public const string CONFIG_DNS
• public const string CONFIG_DNS_SEARCH
• public const string CONFIG_IGNORE_AUTO_DNS
• public const string CONFIG_IGNORE_AUTO_ROUTES
• public const string CONFIG_MAY_FAIL
• public const string CONFIG_METHOD
• public const string CONFIG_METHOD_AUTO
  IPv4 configuration should be automatically determined via a method appropriate for the hardware interface, ie DHCP or PPP or some other device-specific manner.
• public const string CONFIG_METHOD_DISABLED
  This connection does not use or require IPv4 address and it should be disabled.
• public const string CONFIG_METHOD_LINK_LOCAL
  IPv4 configuration should be automatically configured for link-local-only operation.
• public const string CONFIG_METHOD_MANUAL
  All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified in the setting's properties.
• public const string CONFIG_METHOD_SHARED
  This connection specifies configuration that allows other computers to connect through it to the default network (usually the Internet).
• public const string CONFIG_NEVER_DEFAULT
• public const string CONFIG_ROUTES
• public const string CONFIG_ROUTE_METRIC
• public const string CONFIG_SETTING_NAME
• SettingIP6

Constants:

• public const string CONFIG_ADDRESSES
• public const string CONFIG_DHCP_HOSTNAME
• public const string CONFIG_DNS
• public const string CONFIG_DNS_SEARCH
• public const string CONFIG_IGNORE_AUTO_DNS
• public const string CONFIG_IGNORE_AUTO_ROUTES
• public const string CONFIG_IP6_PRIVACY
• public const string CONFIG_MAY_FAIL
• public const string CONFIG_METHOD
• public const string CONFIG_METHOD_AUTO
  IPv6 configuration should be automatically determined via a method appropriate for the hardware interface, ie router advertisements, DHCP, or PPP or some other device-specific manner.
• public const string CONFIG_METHOD_DHCP
  IPv6 configuration should be automatically determined via DHCPv6 only and router advertisements should be ignored.
• public const string CONFIG_METHOD_IGNORE
  IPv6 is not required or is handled by some other mechanism, and NetworkManager should not configure IPv6 for this connection.
• public const string CONFIG_METHOD_LINK_LOCAL
  IPv6 configuration should be automatically configured for link-local-only operation.
• public const string CONFIG_METHOD_MANUAL
  All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified in the setting's properties.
• public const string CONFIG_METHOD_SHARED
  This connection specifies configuration that allows other computers to connect through it to the default network (usually the Internet).
• public const string CONFIG_NEVER_DEFAULT
• public const string CONFIG_ROUTES
• public const string CONFIG_ROUTE_METRIC
• public const string CONFIG_SETTING_NAME
• SettingOLPC

Constants:

• public const string MESH_CHANNEL
• public const string MESH_DHCP_ANYCAST_ADDRESS
• public const string MESH_SETTING_NAME
• public const string MESH_SSID
• SettingVpn

Constants:

• public const string DATA
• public const string PERSISTENT
• public const string SECRETS
• public const string SERVICE_TYPE
• public const string SETTING_NAME
• public const string USER_NAME
• Utils

Enums:

• SecurityType - Describes generic security mechanisms that 802.11 access points may offer.

Constants:

• public const int HWADDR_LEN_MAX
  The maximum length of hardware addresses handled by NetworkManager itself, hwaddr_len, and hwaddr_aton.

Methods:

• public bool ap_mode_security_valid (SecurityType type, DeviceWifiCapabilities wifi_caps)
  Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device capabilities and desired security type are valid for AP/Hotspot connections.
• public string bin2hexstr (string bytes, int len, int final_len)
  Converts a byte-array bytes into a hexadecimal string.
• public bool check_virtual_device_compatibility (Type virtual_type, Type other_type)
  Determines if a connection of type virtual_type can (in the general case) work with connections of type other_type.
• public void deinit ()
  No-op.
• public unowned string escape_ssid (uint8 ssid, uint32 len)
  This function does a quick printable character conversion of the SSID, simply replacing embedded NULLs and non-printable characters with the hexadecimal representation of that character.
• public bool file_is_pkcs12 (string filename)
  Utility function to find out if the filename is in PKCS#12 format.
• public unowned string file_search_in_paths (string progname, string? try_first, string? paths, FileTest file_test_flags, UtilsFileSearchInPathsPredicate predicate) throws Error
  Searches for a progname file in a list of search paths .
• public HashTable<unowned string,unowned Value?> gvalue_hash_dup (HashTable<void*,void*> hash)
  Utility function to duplicate a hash table of Values.
• public int hex2byte (string hex)
  Converts a hex string (2 characters) into its byte representation.
• public string hexstr2bin (string hex, size_t len)
  Converts a hexadecimal string hex into a byte-array.
• public ByteArray hwaddr_atoba (string asc, int type)
  Parses asc and converts it to binary form in a ByteArray.
• public uint8 hwaddr_aton (string asc, int type, void* buffer)
  Parses asc and converts it to binary form in buffer .
• public uint8 hwaddr_aton_len (string asc, void* buffer, size_t length)
  Parses asc and converts it to binary form in buffer .
• public int hwaddr_len (int type)
  Returns the length in octets of a hardware address of type type .
• public string hwaddr_ntoa (void* addr, int type)
  Converts addr to textual form.
• public string hwaddr_ntoa_len (void* addr, size_t length)
  Converts addr to textual form.
• public int hwaddr_type (int len)
  Returns the type (either ARPHRD_ETHER or ARPHRD_INFINIBAND) of the raw address given its length.
• public bool hwaddr_valid (string asc)
  Parses asc to see if it is a valid hardware address of some type.
• public bool iface_valid_name (string name)
  This function is a 1:1 copy of the kernel's interface validation function in net/core/dev.
• public bool init () throws Error
  Initializes libnm-util; should be called when starting any program that uses libnm-util.
• public SList<IP4Address> ip4_addresses_from_gvalue (Value value)
  Utility function to convert a GenericArray of Arrays of uint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix) into a SList of IP4Address objects.
• public void ip4_addresses_to_gvalue (SList<IP4Address> list, Value value)
  Utility function to convert a SList of IP4Address objects into a GenericArray of Arrays of uint32s representing a list of NetworkManager IPv4 addresses (which is a tuple of address, gateway, and prefix).
• public uint32 ip4_get_default_prefix (uint32 ip)
  When the Internet was originally set up, various ranges of IP addresses were segmented into three network classes: A, B, and C.
• public uint32 ip4_netmask_to_prefix (uint32 netmask)
• public uint32 ip4_prefix_to_netmask (uint32 prefix)
• public SList<IP4Route> ip4_routes_from_gvalue (Value value)
  Utility function to convert a GenericArray of Arrays of uint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric) into a SList of IP4Route objects.
• public void ip4_routes_to_gvalue (SList<IP4Route> list, Value value)
  Utility function to convert a SList of IP4Route objects into a GenericArray of Arrays of uint32s representing a list of NetworkManager IPv4 routes (which is a tuple of route, next hop, prefix, and metric).
• public SList<IP6Address> ip6_addresses_from_gvalue (Value value)
  Utility function to convert a GenericArray of ValueArrays of (#GArray of guchars) and uint32 representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway), into a SList of IP6Address objects.
• public void ip6_addresses_to_gvalue (SList<IP6Address> list, Value value)
  Utility function to convert a SList of IP6Address objects into a GenericArray of ValueArrays representing a list of NetworkManager IPv6 addresses (which is a tuple of address, prefix, and gateway).
• public SList<IP6Route> ip6_routes_from_gvalue (Value value)
  Utility function GenericArray of ValueArrays of (#GArray of uchars), uint32, (#GArray of uchars), and uint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric) into a SList of IP6Route objects.
• public void ip6_routes_to_gvalue (SList<IP6Route> list, Value value)
  Utility function to convert a SList of IP6Route objects into a GenericArray of ValueArrays of (#GArray of uchars), uint32, (#GArray of uchar s), and uint32 representing a list of NetworkManager IPv6 routes (which is a tuple of destination, prefix, next hop, and metric).
• public bool is_empty_ssid (uint8 ssid, int len)
  Different manufacturers use different mechanisms for not broadcasting the AP's SSID.
• public bool is_uuid (string str)
  Checks if str is a UUID
• public ByteArray rsa_key_encrypt (ByteArray data, string? in_password, out string out_password) throws Error
  Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format suitable for writing to a file.
• public ByteArray rsa_key_encrypt_aes (ByteArray data, string? in_password, out string out_password) throws Error
  Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format suitable for writing to a file.
• public bool same_ssid (ByteArray ssid1, ByteArray ssid2, bool ignore_trailing_null)
  Earlier versions of the Linux kernel added a NULL byte to the end of the SSID to enable easy printing of the SSID on the console or in a terminal, but this behavior was problematic (SSIDs are simply byte arrays, not strings) and thus was changed.
• public bool security_valid (SecurityType type, DeviceWifiCapabilities wifi_caps, bool have_ap, bool adhoc, @80211ApFlags ap_flags, @80211ApSecurityFlags ap_wpa, @80211ApSecurityFlags ap_rsn)
  Given a set of device capabilities, and a desired security type to check against, determines whether the combination of device, desired security type, and AP capabilities intersect.
• public string ssid_to_utf8 (ByteArray ssid)
  Wi-Fi SSIDs are byte arrays, they are _not_ strings.
• public string uuid_generate ()
• public string uuid_generate_from_string (string s)
  For a given s, this function will always return the same UUID.
• public bool wep_key_valid (string key, WepKeyType wep_type)
  Checks if key is a valid WEP key
• public uint32 wifi_channel_to_freq (uint32 channel, string band)
  Utility function to translate a Wi-Fi channel to its corresponding frequency.
• public uint32 wifi_find_next_channel (uint32 channel, int direction, string band)
  Utility function to find out next/previous Wi-Fi channel for a channel.
• public uint32 wifi_freq_to_channel (uint32 freq)
  Utility function to translate a Wi-Fi frequency to its corresponding channel.
• public bool wifi_is_channel_valid (uint32 channel, string band)
  Utility function to verify Wi-Fi channel validity.
• public bool wpa_psk_valid (string psk)
  Checks if psk is a valid WPA PSK
• VPN

Constants:

• public const string DBUS_PLUGIN_INTERFACE
• public const string DBUS_PLUGIN_PATH
• public const string PLUGIN_CAN_PERSIST
• public const string PLUGIN_CONFIG_BANNER
• public const string PLUGIN_CONFIG_EXT_GATEWAY
• public const string PLUGIN_CONFIG_HAS_IP4
• public const string PLUGIN_CONFIG_HAS_IP6
• public const string PLUGIN_CONFIG_MTU
• public const string PLUGIN_CONFIG_TUNDEV
• public const string PLUGIN_IP4_CONFIG_ADDRESS
• public const string PLUGIN_IP4_CONFIG_DNS
• public const string PLUGIN_IP4_CONFIG_DOMAIN
• public const string PLUGIN_IP4_CONFIG_DOMAINS
• public const string PLUGIN_IP4_CONFIG_INT_GATEWAY
• public const string PLUGIN_IP4_CONFIG_MSS
• public const string PLUGIN_IP4_CONFIG_NBNS
• public const string PLUGIN_IP4_CONFIG_NEVER_DEFAULT
• public const string PLUGIN_IP4_CONFIG_PREFIX
• public const string PLUGIN_IP4_CONFIG_PTP
• public const string PLUGIN_IP4_CONFIG_ROUTES
• public const string PLUGIN_IP6_CONFIG_ADDRESS
• public const string PLUGIN_IP6_CONFIG_DNS
• public const string PLUGIN_IP6_CONFIG_DOMAIN
• public const string PLUGIN_IP6_CONFIG_DOMAINS
• public const string PLUGIN_IP6_CONFIG_INT_GATEWAY
• public const string PLUGIN_IP6_CONFIG_MSS
• public const string PLUGIN_IP6_CONFIG_NEVER_DEFAULT
• public const string PLUGIN_IP6_CONFIG_PREFIX
• public const string PLUGIN_IP6_CONFIG_PTP
• public const string PLUGIN_IP6_CONFIG_ROUTES