Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[WifiEnterpriseConfig] Update javadoc for setCaCert/Path

Browse Source 
Update javadoc for WifiEnterpriseConfig#setCaCert, setCaCerts and
setCaPath to document that if not set, then the server certificate
validation is skipped and the connection is not secure.

Bug: 159458442
Test: No code changes
Change-Id: Icb26b340f743faf129544a0d889dcb7bc1a76551
This commit is contained in:
Hai Shalom
2020-06-19 10:00:05 -07:00
parent 8cbfba234f
commit 21f67c5fb0
1 changed files with 29 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
wifi/java/android/net/wifi/WifiEnterpriseConfig.java
View File

@@ -769,6 +769,10 @@ public class WifiEnterpriseConfig implements Parcelable {
* certificate when the config is saved and removing the certificate when
* the config is removed.
*
* Note: If no certificate is set for an Enterprise configuration, either by not calling this
* API (or the {@link #setCaCertificates(X509Certificate[])}, or by calling it with null, then
* the server certificate validation is skipped - which means that the connection is not secure.
*
* @param cert X.509 CA certificate
* @throws IllegalArgumentException if not a CA certificate
*/
@@ -808,6 +812,11 @@ public class WifiEnterpriseConfig implements Parcelable {
* certificates when the config is saved and removing the certificates when
* the config is removed.
*
* Note: If no certificates are set for an Enterprise configuration, either by not calling this
* API (or the {@link #setCaCertificate(X509Certificate)}, or by calling it with null, then the
* server certificate validation is skipped - which means that the
* connection is not secure.
*
* @param certs X.509 CA certificates
* @throws IllegalArgumentException if any of the provided certificates is
* not a CA certificate
@@ -859,6 +868,13 @@ public class WifiEnterpriseConfig implements Parcelable {
* like /etc/ssl/certs. If configured, these certificates are added to the
* list of trusted CAs. ca_cert may also be included in that case, but it is
* not required.
*
* Note: If no certificate path is set for an Enterprise configuration, either by not calling
* this API, or by calling it with null, and no certificate is set by
* {@link #setCaCertificate(X509Certificate)} or {@link #setCaCertificates(X509Certificate[])},
* then the server certificate validation is skipped - which means that the connection is not
* secure.
*
* @param path The path for CA certificate files, or empty string to clear.
* @hide
*/
@@ -868,7 +884,7 @@ public class WifiEnterpriseConfig implements Parcelable {
}
/**
* Get the domain_suffix_match value. See setDomSuffixMatch.
* Get the ca_path directive from wpa_supplicant.
* @return The path for CA certificate files, or an empty string if unset.
* @hide
*/
@@ -1061,6 +1077,12 @@ public class WifiEnterpriseConfig implements Parcelable {
/**
* Set alternate subject match. This is the substring to be matched against the
* alternate subject of the authentication server certificate.
*
* Note: If no alternate subject is set for an Enterprise configuration, either by not calling
* this API, or by calling it with null, or not setting domain suffix match using the
* {@link #setDomainSuffixMatch(String)}, then the server certificate validation is incomplete -
* which means that the connection is not secure.
*
* @param altSubjectMatch substring to be matched, for example
* DNS:server.example.com;EMAIL:server@example.com
*/
@@ -1095,6 +1117,12 @@ public class WifiEnterpriseConfig implements Parcelable {
* ORed ogether.
* <p>For example, domain_suffix_match=example.com would match test.example.com but would not
* match test-example.com.
*
* Note: If no domain suffix is set for an Enterprise configuration, either by not calling this
* API, or by calling it with null, or not setting alternate subject match using the
* {@link #setAltSubjectMatch(String)}, then the server certificate
* validation is incomplete - which means that the connection is not secure.
*
* @param domain The domain value
*/
public void setDomainSuffixMatch(String domain) {