diff options
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/agent-api.txt | 2 | ||||
| -rwxr-xr-x | doc/config-format.txt | 5 | ||||
| -rw-r--r-- | doc/connman-service.config.5.in | 21 | ||||
| -rw-r--r-- | doc/connman-vpn-provider.config.5.in | 3 | ||||
| -rw-r--r-- | doc/connman-vpn.conf.5.in | 3 | ||||
| -rw-r--r-- | doc/connman.8.in | 16 | ||||
| -rw-r--r-- | doc/connman.conf.5.in | 55 | ||||
| -rw-r--r-- | doc/connmanctl.1.in | 2 | ||||
| -rwxr-xr-x | doc/manager-api.txt | 30 | ||||
| -rwxr-xr-x | doc/peer-api.txt | 1 | ||||
| -rwxr-xr-x | doc/plugin-api.txt | 2 | ||||
| -rwxr-xr-x | doc/service-api.txt | 63 | ||||
| -rwxr-xr-x | doc/session-api.txt | 11 | ||||
| -rwxr-xr-x | doc/technology-api.txt | 17 | ||||
| -rw-r--r-- | doc/valgrind.suppressions | 235 | ||||
| -rwxr-xr-x | doc/vpn-connection-api.txt | 13 |
16 files changed, 420 insertions, 59 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt index aa7271d4..e3c1dcde 100755 --- a/doc/agent-api.txt +++ b/doc/agent-api.txt @@ -54,6 +54,8 @@ Methods void Release() keys are the field names and the values are the actual fields. Alternatively an error indicating that the request got canceled can be returned. + OperationAborted will be return on a successfull + cancel request. Most common return field names are "Name" and of course "Passphrase". diff --git a/doc/config-format.txt b/doc/config-format.txt index ed3123aa..584220f0 100755 --- a/doc/config-format.txt +++ b/doc/config-format.txt @@ -63,6 +63,11 @@ Allowed fields: - SearchDomains: Comma separated list of DNS search domains - Timeservers: Comma separated list of timeservers - Domain: Domain name to be used +- mDNS: Boolean value (true or false). True means that mDNS is enabled. + mDNS domains can be resolved and hostname is registered. False means + that all mDNS functionality for this service is disabled. Note that + not all DNS backends support mDNS: currently systemd-resolved is + the only DNS backend with mDNS. If IPv4 address is missing then DHCP is used. If IPv6 address is missing, then SLAAC or DHCPv6 is used. diff --git a/doc/connman-service.config.5.in b/doc/connman-service.config.5.in index 535c626c..eb63f225 100644 --- a/doc/connman-service.config.5.in +++ b/doc/connman-service.config.5.in @@ -18,8 +18,7 @@ eduroam, or for static IPs and so on. Each provisioning file can be used for multiple services at once. .SH "FILE FORMAT" .P -The configuration file format is key file format. -It consists of sections (groups) of key-value pairs. +The configuration file consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank lines are considered comments. Sections are started by a header line containing the section enclosed in '[' and ']', and ended implicitly by the start of the next section @@ -96,6 +95,8 @@ configured, \fBpsk\fP if a passphrase is present and \fBnone\fP otherwise. If set to \fBtrue\fP, then this AP is hidden. If missing or set to \fBfalse\fP, then AP is not hidden. .TP +The following keys are used for WPA EAP (when \fBSecurity=ieee8021x\fP): +.TP .B EAP=tls \fR|\fB ttls \fR|\fB peap EAP type to use. Only \fBtls\fP, \fBttls\fP and \fBpeap\fP are supported. .TP @@ -118,6 +119,22 @@ Identity string for EAP. .BI AnonymousIdentity= identity Anonymous identity string for EAP. .TP +.BI SubjectMatch= substring +Substring to be matched against the subject of the +authentication server certificate for EAP. +.TP +.BI AltSubjectMatch= substring +Semicolon separated string of entries to be matched against the alternative +subject name of the authentication server certificate for EAP. +.TP +.BI DomainSuffixMatch= domain +Constraint for server domain name. If set, this FQDN is used as a suffix match +requirement for the authentication server certificate for EAP. +.TP +.BI DomainMatch= domain +This FQDN is used as a full match requirement for the +authentication server certificate for EAP. +.TP .BI Phase2= type Inner authentication type with for \fBEAP=tls\fP or \fBEAP=ttls\fP. Prefix the value with \fBEAP-\fP to indicate usage of EAP-based authentication diff --git a/doc/connman-vpn-provider.config.5.in b/doc/connman-vpn-provider.config.5.in index ef704352..51d547b3 100644 --- a/doc/connman-vpn-provider.config.5.in +++ b/doc/connman-vpn-provider.config.5.in @@ -17,8 +17,7 @@ must end with \fB.config\fP. Each VPN connection requires a provisioning file, but multiple connections can be specified in the same file. .SH "FILE FORMAT" .P -The configuration file format is key file format. -It consists of sections (groups) of key-value pairs. +The configuration file consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank lines are considered comments. Sections are started by a header line containing the section enclosed in '[' and ']', and ended implicitly by the start of the next section diff --git a/doc/connman-vpn.conf.5.in b/doc/connman-vpn.conf.5.in index fcc4c692..20d30fcc 100644 --- a/doc/connman-vpn.conf.5.in +++ b/doc/connman-vpn.conf.5.in @@ -16,8 +16,7 @@ behavior. The location of the file may be changed through use of the \fB\-\-config= \fRargument for \fBconnman-vpn\fP(8). .SH "FILE FORMAT" .P -The configuration file format is key file format. -It consists of sections (groups) of key-value pairs. +The configuration file consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank lines are considered comments. Sections are started by a header line containing the section enclosed in '[' and ']', and ended implicitly by the start of the next section diff --git a/doc/connman.8.in b/doc/connman.8.in index ddfba09b..85e7c5e0 100644 --- a/doc/connman.8.in +++ b/doc/connman.8.in @@ -88,13 +88,15 @@ Do not daemonize. This is useful for debugging, and directs log output to the controlling terminal in addition to syslog. .TP .BR \-r ", " \-\-nodnsproxy -Do not act as a DNS proxy. By default ConnMan will direct all DNS traffic -to itself by setting nameserver to 127.0.0.1 in \fBresolv.conf\fP(5) file. -If this is not desired and you want that all programs call directly some -DNS server, then you can use the \fB--nodnsproxy\fP option. -If this option is used, then ConnMan is not able to cache the DNS queries -because the DNS traffic is not going through ConnMan and that can cause -some extra network traffic. +Do not act as a DNS proxy or support external DNS resolving. Depending +on how ConnMan is compiled, it will by default direct all DNS traffic +to itself by setting nameserver to 127.0.0.1 in \fBresolv.conf\fP(5) +file or leave DNS management to an external entity, such as +systemd-resolved. If this is not desired and you want that all programs +call directly some DNS server, then you can use the \fB--nodnsproxy\fP +option. If this option is used, then ConnMan is not able to cache the +DNS queries because the DNS traffic is not going through ConnMan and that +can cause some extra network traffic. .SH SEE ALSO .BR connmanctl (1), \ connman.conf (5), \ connman-service.config (5), \c .BR \ connman-vpn (8) diff --git a/doc/connman.conf.5.in b/doc/connman.conf.5.in index fdc8e9ec..e42b22f0 100644 --- a/doc/connman.conf.5.in +++ b/doc/connman.conf.5.in @@ -16,8 +16,7 @@ behavior. The location of the file may be changed through use of the \fB\-\-config= \fRargument for \fBconnman\fP(8). .SH "FILE FORMAT" .P -The configuration file format is key file format. -It consists of sections (groups) of key-value pairs. +The configuration file consists of sections (groups) of key-value pairs. Lines beginning with a '#' and blank lines are considered comments. Sections are started by a header line containing the section enclosed in '[' and ']', and ended implicitly by the start of the next section @@ -43,16 +42,27 @@ user interface designs. .TP .BI BackgroundScanning=true\ \fR|\fB\ false Enable background scanning. Default is true. -Background scanning will start every 5 minutes unless -the scan list is empty. In that case, a simple backoff -mechanism starting from 10s up to 5 minutes will run. +If wifi is disconnected, the background scanning will follow a simple +backoff mechanism from 3s up to 5 minutes. Then, it will stay in 5 +minutes unless user specifically asks for scanning through a D-Bus +call. If so, the mechanism will start again from 3s. This feature +activates also the background scanning while being connected, which +is required for roaming on wifi. +When BackgroundScanning is false, ConnMan will not perform any scan +regardless of wifi is connected or not, unless it is requested by +the user through a D-Bus call. +.TP +.BI UseGatewaysAsTimeservers=true \fR|\fB\ false +Assume that service gateways also function as timeservers. +Default is false. .TP .BI FallbackTimeservers= server\fR[,...] List of Fallback timeservers separated by ",". These timeservers are used for NTP sync when there are -no timeserver set by the user or by the service. -These can contain mixed combination of fully qualified -domain names, IPv4 and IPv6 addresses. +no timeservers set by the user or by the service, and +when UseGatewaysAsTimeservers = false. These can contain +a mixed combination of fully qualified domain names, IPv4 +and IPv6 addresses. .TP .BI FallbackNameservers= server\fR[,...] List of fallback nameservers separated by "," appended @@ -67,6 +77,12 @@ for this entry when empty is ethernet,wifi,cellular. Services that are automatically connected must have been set up and saved to storage beforehand. .TP +.BI DefaultFavoriteTechnologies= technology\fR[,...] +List of technologies that are marked favorite by default, +separated by commas ",". The default value for this entry +when empty is ethernet. Connects to services from this +technology even if not setup and saved to storage. +.TP .BI AlwaysConnectedTechnologies= technology\fR[,...] List of technoolgies which are always connected regardless of PreferredTechnologies setting (AutoConnect = true). The @@ -98,6 +114,11 @@ Allow connman to change the system hostname. This can happen for example if we receive DHCP hostname option. Default value is true. .TP +.BI AllowDomainnameUpdates=true\ \fR|\fB\ false +Allow connman to change the system domainname. This can +happen for example if we receive DHCP domainname option. +Default value is true. +.TP .BI SingleConnectedTechnology=true\ \fR|\fB\ false Keep only a single connected technology at any time. When a new service is connected by the user or a better one is found according @@ -138,13 +159,28 @@ be used by DHCP servers to identify specific clients without having to rely on MAC address ranges, etc .TP .BI EnableOnlineCheck=true\ \fR|\fB\ false -Enable or disable use of HTTP GET as on online status check. +Enable or disable use of HTTP GET as an online status check. When a service is in a READY state, and is selected as default, ConnMan will issue an HTTP GET request to verify that end-to-end connectivity is successful. Only then the service will be transitioned to ONLINE state. If this setting is false, the default service will remain in READY state. Default value is true. +.TP +.BI AutoConnectRoamingServices=true\ \fR|\fB\ false +Automatically connect roaming services. This is not recommended unless you know +you won't have any billing problem. +Default value is false. +.TP +.BI AddressConflictDetection=true\ \fR|\fB\ false +Enable or disable the implementation of IPv4 address conflict detection +according to RFC5227. ConnMan will send probe ARP packets to see if an +IPv4 address is already in use before assigning the address to an interface. +If an address conflict occurs for a statically configured address, an IPv4LL +address will be chosen instead (according to RFC3927). If an address conflict +occurs for an address offered via DHCP, ConnMan send a DHCP DECLINE once and +for the second conflict resort to finding an IPv4LL address. +Default value is false. .SH "EXAMPLE" The following example configuration disables hostname updates and enables ethernet tethering. @@ -152,6 +188,7 @@ ethernet tethering. .nf [General] AllowHostnameUpdates = false +AllowDomainnameUpdates = false TetheringTechnologies = ethernet,wifi,bluetooth,gadget .fi .SH "SEE ALSO" diff --git a/doc/connmanctl.1.in b/doc/connmanctl.1.in index 0f891bd0..47d9c303 100644 --- a/doc/connmanctl.1.in +++ b/doc/connmanctl.1.in @@ -180,7 +180,7 @@ Configures the IPv6 settings for the service. The argument settings will be asked from the network and \fBmanual\fR means that the given arguments will be used as IPv6 settings. .IR address " and " gateway -must be valid IPv4 addresses. \fIprefixlength\fR is the length +must be valid IPv6 addresses. \fIprefixlength\fR is the length of the prefix in bits. See the \fBEXAMPLE\fR section of this man page for details. .PP diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 31e137ca..bfb07bd3 100755 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -46,6 +46,11 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments + array{string} GetTetheringClients() [experimental] + + Returns a sorted list of MAC addresses of clients + connected to tethered technologies. + object ConnectProvider(dict provider) [deprecated] Connect to a VPN specified by the given provider @@ -210,11 +215,12 @@ Signals TechnologyAdded(object path, dict properties) ServicesChanged(array{object, dict}, array{object}) - Signals a list of services that have been changed - via the first array. And a list of service that - have been removed via the second array. + This signal indicates a change in the services. + List of all services currently registered is passed + via the first array. And a list of services that have + been removed via the second array. - The list of added services is sorted. The dictionary + The list of all services is sorted. The dictionary with the properties might be empty in case none of the properties have changed. Or only contains the properties that have changed. @@ -233,11 +239,12 @@ Signals TechnologyAdded(object path, dict properties) PeersChanged(array{object, dict}, array{object}) [experimental] - Signals a list of peers that have been changed via the - first array. And a list of peer that have been removed - via the second array. + This signal indicates a change in the peers. List of + all peers currently registered is passed via the first + array. And a list of peers that have been removed via + the second array. - The list of changed peers is sorted. The dictionary + The list of all peers is sorted. The dictionary with the properties might be empty in case none of the properties have changed. Or only contains the properties that have changed. @@ -253,6 +260,13 @@ Signals TechnologyAdded(object path, dict properties) object changes. For that it is required to watch the PropertyChanged signal of the peer object. + TetheringClientsChanged(array{string}, array{string}) [experimental] + + This signal indicates a change in the tethering clients. + List of all tethering clients currently registered connman is + passed via the first array. And a list of tethering clients that + have been removed via the second array. + PropertyChanged(string name, variant value) This signal indicates a changed value of the given diff --git a/doc/peer-api.txt b/doc/peer-api.txt index b871f4d5..cc094ff2 100755 --- a/doc/peer-api.txt +++ b/doc/peer-api.txt @@ -100,4 +100,3 @@ Properties string State [readonly] [experimental] The TLV formated byte array representing the WiFi Display Informations Elements. - diff --git a/doc/plugin-api.txt b/doc/plugin-api.txt index ea5ec0a1..36391e96 100755 --- a/doc/plugin-api.txt +++ b/doc/plugin-api.txt @@ -6,7 +6,7 @@ Plugin basics ============= The Connection Manager supports plugins for various actions. The basic plugin -contains of plugin description via CONNMAN_PLUGIN_DEFINE and also init/exit +contains a plugin description via CONNMAN_PLUGIN_DEFINE and also init/exit callbacks defined through that description. #include <connman/plugin.h> diff --git a/doc/service-api.txt b/doc/service-api.txt index 4fe4093a..f8dbb96d 100755 --- a/doc/service-api.txt +++ b/doc/service-api.txt @@ -122,13 +122,6 @@ Methods dict GetProperties() [deprecated] Possible Errors: None - boolean GetUserFavorite() [experimental] - - This function is used to check whether this service - is favorite to the current user. - - Possible Errors: None - Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given @@ -194,8 +187,15 @@ Properties string State [readonly] present and contains the list of security methods or key management settings. - Possible values are "none", "wep", "psk", "ieee8021x" - and also "wps". + Possible values are "none", "wep", "psk", "ieee8021x", + and also "wps" and "wps_advertising". + + Value "wps" means that the service supports WPS. A + service advertising itself as WPS registrar contains + the additional value "wps_advertising" for as long as + it is advertising. That is, while "wps_advertising" is + listed, WPS is active and it should be possible to + connect to the corresponding service via WPS. This property might be only present for WiFi services. @@ -533,3 +533,48 @@ Properties string State [readonly] Possible values are "half" and "full". This information is not available. + + bool mDNS [readonly] + + Whether or not mDNS support is enabled. Note + that mDNS requires a DNS backend which + supports it. Currently the only DNS backend + which supports mDNS is systemd-resolved. + + bool mDNS.Configuration [readwrite] + + Same values as mDNS property. The mDNS + represents the actual system configuration + while this allows user configuration. + + dict LastAddressConflict [readonly] + + This property contains information about the previously detected + address conflict. If there has been no address conflict then + IPv4 Address is "0.0.0.0", Ethernet Address is "00:00:00:00:00:00", + Timestamp is zero and Resolved is true. + + dict IPv4 [readonly] + + string Address [readonly] + + The IPv4 address which had a conflict. + + dict Ethernet [readonly] + + string Address [readonly] + + The ethernet device address (MAC address) of the conflicting + host. + + int64 Timestamp [readonly] + + A timestamp when the conflict was detected in microseconds + since January 1, 1970 UTC. + + bool Resolved [readonly] + + Set to false when an address conflict occurs. + If a previous conflict could be resolved by probing another + IPv4 address (which is not an IPv4LL) then this boolean is set + to true. diff --git a/doc/session-api.txt b/doc/session-api.txt index e8da5224..46ac5f3d 100755 --- a/doc/session-api.txt +++ b/doc/session-api.txt @@ -205,3 +205,14 @@ Settings string State [readonly] a default route. When the source IP rule is enabled, an application can select which session/interface to send traffic on, using bind-before-connect mechanism. + + string ContextIdentifier [readwrite] [experimental] + + The application can provide an identifier for a + session. If an application runs several session + at the same time, the additional information + can be used by ConnMan to assign different + bearers according the identifier. For example + a web browser creates per tab a session. For + each session a different should bearer be + assigned. diff --git a/doc/technology-api.txt b/doc/technology-api.txt index fb6bd314..f22e9b29 100755 --- a/doc/technology-api.txt +++ b/doc/technology-api.txt @@ -45,18 +45,6 @@ Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. - DhcpConnected(string aptype, string ipaddr, - string macaddr, string hostname) - - This signal indicates a station information that - has connected to the AP(Access Point). - - DhcpLeaseDeleted(string aptype, string ipaddr, - string macaddr, string hostname) - - This signal indicates a station information that - has disconnected to the AP(Access Point). - Properties boolean Powered [readwrite] Boolean representing the power state of the @@ -112,8 +100,3 @@ Properties boolean Powered [readwrite] This property is only valid for the WiFi technology, and is then mapped to the WPA pre-shared key clients will have to use in order to establish a connection. - - boolean Hidden [readwrite] - - This option allows to enable or disable the support - for the hidden Wi-Fi tethering. diff --git a/doc/valgrind.suppressions b/doc/valgrind.suppressions new file mode 100644 index 00000000..c1c7bca1 --- /dev/null +++ b/doc/valgrind.suppressions @@ -0,0 +1,235 @@ +{ + <syslog error> + Memcheck:Cond + obj:/lib/libc-*.so + ... + fun:localtime_r + fun:__vsyslog_chk + fun:__syslog_chk + fun:__connman_log_init + ... +} +{ + <iconv open> + Memcheck:Addr4 + obj:/lib/libc-*.so + obj:/lib/libglib-2.0.so* + fun:g_iconv_open + ... + fun:g_convert + fun:g_locale_to_utf8 + fun:g_strerror + fun:g_key_file_load_from_file + ... +} +{ + <ioctl ADDRT/DELRT> + Memcheck:Param + ioctl(SIOCADDRT/DELRT) + obj:/lib/ld-*.so + ... +} +{ + <g_main_loop> + Memcheck:Leak + fun:memalign + ... + fun:g_slice_alloc + ... + fun:g_main_loop_new + ... +} +{ + <g_option_context_parse> + Memcheck:Leak + ... + fun:g_slice_alloc + ... + fun:g_option_context_parse + ... +} +{ + <g_key_file_load_from_data> + Memcheck:Leak + ... + fun:g_slice_alloc + ... + fun:g_key_file_load_from_data + ... +} +{ + <g_key_file_new 1> + Memcheck:Leak + ... + fun:g_slice_alloc + ... + fun:g_key_file_new + ... +} +{ + <g_key_file_new 2> + Memcheck:Leak + fun:*alloc + ... + fun:g_key_file_new + fun:main +} +{ + <connman plugin cleanup> + Memcheck:Leak + ... + fun:__connman_plugin_cleanup + ... +} +{ + <cmd line option parsing> + Memcheck:Leak + fun:malloc + fun:g_malloc + fun:g_strdup + fun:g_set_prgname + fun:g_option_context_parse + fun:main +} +{ + <dbus system bus setup 1> + Memcheck:Leak + ... + fun:dbus_malloc* + ... + fun:g_dbus_setup_bus + fun:main +} +{ + <dbus system bus setup 2> + Memcheck:Leak + ... + fun:g_malloc* + ... + fun:dbus_connection_set_watch_functions + fun:setup_bus + ... +} +{ + <key file get charset> + Memcheck:Leak + ... + fun:g_*alloc* + ... + fun:g_strerror + fun:g_key_file_load_from_file + fun:main +} +{ + <dbus disconnect func set> + Memcheck:Leak + ... + fun:filter_data_get + fun:g_dbus_add_signal_watch + fun:g_dbus_set_disconnect_function + fun:main +} +{ + <plugin dlopen> + Memcheck:Leak + ... + fun:dlopen + fun:__connman_plugin_init + fun:main +} +{ + <dbus system bus setup 3> + Memcheck:Leak + ... + fun:dbus_malloc0 + ... + fun:dbus_parse_address + ... + fun:g_dbus_setup_bus + fun:main +} +{ + <libdbus internals 1> + Memcheck:Leak + fun:*malloc + ... + obj:/lib/libdbus-1.so.3.5.3 +} +{ + <dbus system bus setup 4> + Memcheck:Leak + fun:*alloc + ... + fun:dbus_*alloc* + ... + fun:g_dbus_setup_bus + fun:main +} +{ + <dbus system bus setup 5> + Memcheck:Leak + fun:calloc + fun:g_malloc0 + ... + fun:g_dbus_set_disconnect_function + fun:main +} +{ + <dbus bus remove match> + Memcheck:Leak + fun:malloc + fun:g_malloc + fun:g_source_set_callback + fun:g_timeout_add_full + fun:g_timeout_add + ... + fun:dbus_pending_call_block + fun:dbus_connection_send_with_reply_and_block + ... + fun:dbus_bus_remove_match +} +{ + <g_main_loop_run/new> + Memcheck:Leak + fun:*alloc + ... + fun:g_main_loop_* + fun:main +} +{ + <g_main_context_dispatch> + Memcheck:Leak + fun:*alloc + ... + fun:g_main_context_dispatch +} +{ + <libdbus internals 2> + Memcheck:Leak + fun:realloc + fun:dbus_realloc + ... + fun:dbus_message_set_reply_serial + fun:dbus_message_new_error + ... +} +{ + <libdbus internals 3> + Memcheck:Leak + fun:realloc + fun:dbus_realloc + ... + fun:dbus_message_new_signal + ... +} +{ + <dbus_bus_register> + Memcheck:Leak + fun:malloc + fun:realloc + fun:dbus_realloc + ... + fun:dbus_pending_call_block + fun:dbus_connection_send_with_reply_and_block + fun:dbus_bus_register +} diff --git a/doc/vpn-connection-api.txt b/doc/vpn-connection-api.txt index a814a388..1fd3be26 100755 --- a/doc/vpn-connection-api.txt +++ b/doc/vpn-connection-api.txt @@ -39,6 +39,19 @@ Methods dict GetProperties() [experimental] Possible Errors: [connection].Error.InvalidArguments [connection].Error.InProgress + void Connect2(string dbus_sender) [experimental] + + Connect this VPN connection. The Connect2() is a + wrapper for Connect() allowing to pass original D-Bus + sender when proxying the connection request. The + Connect2() will wait until the connection is created or + there is an error. The error description is returned in + dbus error. + + Possible Errors: [connection].Error.InvalidArguments + [connection].Error.InProgress + + void Disconnect() [experimental] Disconnect this VPN connection. If the connection is |