summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAnjali Nijhara <a.nijhara@samsung.com>2023-03-15 14:54:24 +0530
committerAnjali Nijhara <a.nijhara@samsung.com>2023-03-15 14:54:24 +0530
commit37bf962ac8da256ed3f48392da76365fd7cfee5d (patch)
treebccd59faab4ddde51066b43f2fdedeafdf7f7a79 /doc
parentb70dafc0d1bb160625f34db0446c58b859982b48 (diff)
parent38642bb625ec192e058ec7cdae356f3ebaaa7561 (diff)
downloadconnman-37bf962ac8da256ed3f48392da76365fd7cfee5d.tar.gz
connman-37bf962ac8da256ed3f48392da76365fd7cfee5d.tar.bz2
connman-37bf962ac8da256ed3f48392da76365fd7cfee5d.zip
Merge tag 'upstream/1.41' into tizen
Change-Id: I7e90773484901c50e61d243f97d916f5588da9c5
Diffstat (limited to 'doc')
-rw-r--r--doc/connman.conf.5.in13
-rwxr-xr-xdoc/technology-api.txt7
-rw-r--r--doc/vpn-agent-api.txt13
-rwxr-xr-xdoc/vpn-connection-api.txt13
4 files changed, 41 insertions, 5 deletions
diff --git a/doc/connman.conf.5.in b/doc/connman.conf.5.in
index 2e06b3ef..82cceb72 100644
--- a/doc/connman.conf.5.in
+++ b/doc/connman.conf.5.in
@@ -167,13 +167,16 @@ transitioned to ONLINE state.
If this setting is false, the default service will remain in READY state.
Default value is true.
.TP
+.BI OnlineCheckIPv4URL= url, OnlineCheckIPv6URL= url
+Urls (IPv4 and IPv6 respectively) used during the online status check.
+Please refer to the README for more detailed information.
+Default values are http://ipv4.connman.net/online/status.html and
+http://ipv6.connman.net/online/status.html respectively.
+.TP
.BI OnlineCheckInitialInterval= secs, OnlineCheckMaxInterval= secs
Range of intervals between two online check requests.
-When an online check request fails, another one is triggered after a
-longer interval. The intervals follow the power of two series of numbers
-between OnlineCheckInitialInterval and OnlineCheckMaxInterval.
-Default range is [1, 12], corresponding to the following intervals, in
-seconds: 1, 4, 9, 16, 25, 36, 49, 64, 81, 100, 121 and 144.
+Please refer to the README for more detailed information.
+Default values are 1 and 12 respectively.
.TP
.BI EnableOnlineToReadyTransition=true\ \fR|\fB\ false
WARNING: Experimental feature!!!
diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index f22e9b29..cdf30396 100755
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -100,3 +100,10 @@ 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.
+
+ int TetheringFreq [readwrite]
+
+ The tethering access point frequency
+
+ This property is only valid for the WiFi technology and it's
+ optional. Default frequency is 2412 Mhz.
diff --git a/doc/vpn-agent-api.txt b/doc/vpn-agent-api.txt
index ffa6fadd..ecc8faaa 100644
--- a/doc/vpn-agent-api.txt
+++ b/doc/vpn-agent-api.txt
@@ -85,6 +85,10 @@ Fields string Username
Return the OpenConnect cookie value that is used for
authenticating the VPN session.
+ string OpenConnect.Group
+
+ Choose authentication login group.
+
string OpenConnect.PKCSClientCert
Informational field containing a PKCS#1/PKCS#8/PKCS#12
@@ -96,12 +100,21 @@ Fields string Username
Password for decrypting PKCS#8/PKCS#12 client
certificate.
+ string OpenConnect.SecondPassword
+
+ Second factor password for authentication.
+
string OpenConnect.ServerCert
Return the OpenConnect server hash used to identify
the final server after possible web authentication
logins, selections and redirections.
+ boolean OpenConnect.UseSecondPassword
+
+ Indicates that second factor password is used
+ for selected authentication group.
+
string OpenConnect.VPNHost
Return the final VPN server to use after possible
diff --git a/doc/vpn-connection-api.txt b/doc/vpn-connection-api.txt
index 6e6293e4..2d3e0078 100755
--- a/doc/vpn-connection-api.txt
+++ b/doc/vpn-connection-api.txt
@@ -235,6 +235,19 @@ Properties string State [readonly]
The VPN server activated route. These routes
are pushed to connman by VPN server.
+ string AuthErrorLimit
+
+ This value defines the amount of authentication errors
+ that are allowed before informing VPN agent to clear
+ the credentials in case there was a previous successful
+ VPN connection made within one hour. This is to be used
+ with providers that allow only one login from one
+ account at a time to prevent clearing of credentials
+ when networks are rapidly changed. This value is used
+ as an integer and if unset this default to "1" for all
+ except OpenVPN that uses value "10". Setting value "0"
+ disables the feature for the provider.
+
There can be other properties also but as the VPN
technologies are so different, they have different
kind of options that they need, so not all options