| /* |
| * Copyright (C) 2013 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package android.net.wifi; |
| |
| import android.annotation.Nullable; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.security.Credentials; |
| import android.text.TextUtils; |
| |
| import java.io.ByteArrayInputStream; |
| import java.nio.charset.StandardCharsets; |
| import java.security.KeyFactory; |
| import java.security.NoSuchAlgorithmException; |
| import java.security.PrivateKey; |
| import java.security.cert.CertificateEncodingException; |
| import java.security.cert.CertificateException; |
| import java.security.cert.CertificateFactory; |
| import java.security.cert.X509Certificate; |
| import java.security.spec.InvalidKeySpecException; |
| import java.security.spec.PKCS8EncodedKeySpec; |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| /** |
| * Enterprise configuration details for Wi-Fi. Stores details about the EAP method |
| * and any associated credentials. |
| */ |
| public class WifiEnterpriseConfig implements Parcelable { |
| |
| /** @hide */ |
| public static final String EMPTY_VALUE = "NULL"; |
| /** @hide */ |
| public static final String EAP_KEY = "eap"; |
| /** @hide */ |
| public static final String PHASE2_KEY = "phase2"; |
| /** @hide */ |
| public static final String IDENTITY_KEY = "identity"; |
| /** @hide */ |
| public static final String ANON_IDENTITY_KEY = "anonymous_identity"; |
| /** @hide */ |
| public static final String PASSWORD_KEY = "password"; |
| /** @hide */ |
| public static final String SUBJECT_MATCH_KEY = "subject_match"; |
| /** @hide */ |
| public static final String ALTSUBJECT_MATCH_KEY = "altsubject_match"; |
| /** @hide */ |
| public static final String DOM_SUFFIX_MATCH_KEY = "domain_suffix_match"; |
| /** @hide */ |
| public static final String OPP_KEY_CACHING = "proactive_key_caching"; |
| /** |
| * String representing the keystore OpenSSL ENGINE's ID. |
| * @hide |
| */ |
| public static final String ENGINE_ID_KEYSTORE = "keystore"; |
| |
| /** |
| * String representing the keystore URI used for wpa_supplicant. |
| * @hide |
| */ |
| public static final String KEYSTORE_URI = "keystore://"; |
| |
| /** |
| * String representing the keystore URI used for wpa_supplicant, |
| * Unlike #KEYSTORE_URI, this supports a list of space-delimited aliases |
| * @hide |
| */ |
| public static final String KEYSTORES_URI = "keystores://"; |
| |
| /** |
| * String to set the engine value to when it should be enabled. |
| * @hide |
| */ |
| public static final String ENGINE_ENABLE = "1"; |
| |
| /** |
| * String to set the engine value to when it should be disabled. |
| * @hide |
| */ |
| public static final String ENGINE_DISABLE = "0"; |
| |
| /** @hide */ |
| public static final String CA_CERT_PREFIX = KEYSTORE_URI + Credentials.CA_CERTIFICATE; |
| /** @hide */ |
| public static final String CLIENT_CERT_PREFIX = KEYSTORE_URI + Credentials.USER_CERTIFICATE; |
| /** @hide */ |
| public static final String CLIENT_CERT_KEY = "client_cert"; |
| /** @hide */ |
| public static final String CA_CERT_KEY = "ca_cert"; |
| /** @hide */ |
| public static final String CA_PATH_KEY = "ca_path"; |
| /** @hide */ |
| public static final String ENGINE_KEY = "engine"; |
| /** @hide */ |
| public static final String ENGINE_ID_KEY = "engine_id"; |
| /** @hide */ |
| public static final String PRIVATE_KEY_ID_KEY = "key_id"; |
| /** @hide */ |
| public static final String REALM_KEY = "realm"; |
| /** @hide */ |
| public static final String PLMN_KEY = "plmn"; |
| /** @hide */ |
| public static final String CA_CERT_ALIAS_DELIMITER = " "; |
| |
| |
| private HashMap<String, String> mFields = new HashMap<String, String>(); |
| private X509Certificate[] mCaCerts; |
| private PrivateKey mClientPrivateKey; |
| private X509Certificate mClientCertificate; |
| |
| public WifiEnterpriseConfig() { |
| // Do not set defaults so that the enterprise fields that are not changed |
| // by API are not changed underneath |
| // This is essential because an app may not have all fields like password |
| // available. It allows modification of subset of fields. |
| |
| } |
| |
| /** Copy constructor */ |
| public WifiEnterpriseConfig(WifiEnterpriseConfig source) { |
| for (String key : source.mFields.keySet()) { |
| mFields.put(key, source.mFields.get(key)); |
| } |
| } |
| |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| |
| @Override |
| public void writeToParcel(Parcel dest, int flags) { |
| dest.writeInt(mFields.size()); |
| for (Map.Entry<String, String> entry : mFields.entrySet()) { |
| dest.writeString(entry.getKey()); |
| dest.writeString(entry.getValue()); |
| } |
| |
| writeCertificates(dest, mCaCerts); |
| |
| if (mClientPrivateKey != null) { |
| String algorithm = mClientPrivateKey.getAlgorithm(); |
| byte[] userKeyBytes = mClientPrivateKey.getEncoded(); |
| dest.writeInt(userKeyBytes.length); |
| dest.writeByteArray(userKeyBytes); |
| dest.writeString(algorithm); |
| } else { |
| dest.writeInt(0); |
| } |
| |
| writeCertificate(dest, mClientCertificate); |
| } |
| |
| private void writeCertificates(Parcel dest, X509Certificate[] cert) { |
| if (cert != null && cert.length != 0) { |
| dest.writeInt(cert.length); |
| for (int i = 0; i < cert.length; i++) { |
| writeCertificate(dest, cert[i]); |
| } |
| } else { |
| dest.writeInt(0); |
| } |
| } |
| |
| private void writeCertificate(Parcel dest, X509Certificate cert) { |
| if (cert != null) { |
| try { |
| byte[] certBytes = cert.getEncoded(); |
| dest.writeInt(certBytes.length); |
| dest.writeByteArray(certBytes); |
| } catch (CertificateEncodingException e) { |
| dest.writeInt(0); |
| } |
| } else { |
| dest.writeInt(0); |
| } |
| } |
| |
| public static final Creator<WifiEnterpriseConfig> CREATOR = |
| new Creator<WifiEnterpriseConfig>() { |
| public WifiEnterpriseConfig createFromParcel(Parcel in) { |
| WifiEnterpriseConfig enterpriseConfig = new WifiEnterpriseConfig(); |
| int count = in.readInt(); |
| for (int i = 0; i < count; i++) { |
| String key = in.readString(); |
| String value = in.readString(); |
| enterpriseConfig.mFields.put(key, value); |
| } |
| |
| enterpriseConfig.mCaCerts = readCertificates(in); |
| |
| PrivateKey userKey = null; |
| int len = in.readInt(); |
| if (len > 0) { |
| try { |
| byte[] bytes = new byte[len]; |
| in.readByteArray(bytes); |
| String algorithm = in.readString(); |
| KeyFactory keyFactory = KeyFactory.getInstance(algorithm); |
| userKey = keyFactory.generatePrivate(new PKCS8EncodedKeySpec(bytes)); |
| } catch (NoSuchAlgorithmException e) { |
| userKey = null; |
| } catch (InvalidKeySpecException e) { |
| userKey = null; |
| } |
| } |
| |
| enterpriseConfig.mClientPrivateKey = userKey; |
| enterpriseConfig.mClientCertificate = readCertificate(in); |
| return enterpriseConfig; |
| } |
| |
| private X509Certificate[] readCertificates(Parcel in) { |
| X509Certificate[] certs = null; |
| int len = in.readInt(); |
| if (len > 0) { |
| certs = new X509Certificate[len]; |
| for (int i = 0; i < len; i++) { |
| certs[i] = readCertificate(in); |
| } |
| } |
| return certs; |
| } |
| |
| private X509Certificate readCertificate(Parcel in) { |
| X509Certificate cert = null; |
| int len = in.readInt(); |
| if (len > 0) { |
| try { |
| byte[] bytes = new byte[len]; |
| in.readByteArray(bytes); |
| CertificateFactory cFactory = CertificateFactory.getInstance("X.509"); |
| cert = (X509Certificate) cFactory |
| .generateCertificate(new ByteArrayInputStream(bytes)); |
| } catch (CertificateException e) { |
| cert = null; |
| } |
| } |
| return cert; |
| } |
| |
| public WifiEnterpriseConfig[] newArray(int size) { |
| return new WifiEnterpriseConfig[size]; |
| } |
| }; |
| |
| /** The Extensible Authentication Protocol method used */ |
| public static final class Eap { |
| /** No EAP method used. Represents an empty config */ |
| public static final int NONE = -1; |
| /** Protected EAP */ |
| public static final int PEAP = 0; |
| /** EAP-Transport Layer Security */ |
| public static final int TLS = 1; |
| /** EAP-Tunneled Transport Layer Security */ |
| public static final int TTLS = 2; |
| /** EAP-Password */ |
| public static final int PWD = 3; |
| /** EAP-Subscriber Identity Module */ |
| public static final int SIM = 4; |
| /** EAP-Authentication and Key Agreement */ |
| public static final int AKA = 5; |
| /** EAP-Authentication and Key Agreement Prime */ |
| public static final int AKA_PRIME = 6; |
| /** Hotspot 2.0 r2 OSEN */ |
| public static final int UNAUTH_TLS = 7; |
| /** @hide */ |
| public static final String[] strings = |
| { "PEAP", "TLS", "TTLS", "PWD", "SIM", "AKA", "AKA'", "WFA-UNAUTH-TLS" }; |
| |
| /** Prevent initialization */ |
| private Eap() {} |
| } |
| |
| /** The inner authentication method used */ |
| public static final class Phase2 { |
| public static final int NONE = 0; |
| /** Password Authentication Protocol */ |
| public static final int PAP = 1; |
| /** Microsoft Challenge Handshake Authentication Protocol */ |
| public static final int MSCHAP = 2; |
| /** Microsoft Challenge Handshake Authentication Protocol v2 */ |
| public static final int MSCHAPV2 = 3; |
| /** Generic Token Card */ |
| public static final int GTC = 4; |
| private static final String PREFIX = "auth="; |
| /** @hide */ |
| public static final String[] strings = {EMPTY_VALUE, "PAP", "MSCHAP", |
| "MSCHAPV2", "GTC" }; |
| |
| /** Prevent initialization */ |
| private Phase2() {} |
| } |
| |
| /** Internal use only |
| * @hide |
| */ |
| public HashMap<String, String> getFields() { |
| return mFields; |
| } |
| |
| /** |
| * Set the EAP authentication method. |
| * @param eapMethod is one {@link Eap#PEAP}, {@link Eap#TLS}, {@link Eap#TTLS} or |
| * {@link Eap#PWD} |
| * @throws IllegalArgumentException on an invalid eap method |
| */ |
| public void setEapMethod(int eapMethod) { |
| switch (eapMethod) { |
| /** Valid methods */ |
| case Eap.TLS: |
| setPhase2Method(Phase2.NONE); |
| /* fall through */ |
| case Eap.PEAP: |
| case Eap.PWD: |
| case Eap.TTLS: |
| case Eap.SIM: |
| case Eap.AKA: |
| case Eap.AKA_PRIME: |
| mFields.put(EAP_KEY, Eap.strings[eapMethod]); |
| mFields.put(OPP_KEY_CACHING, "1"); |
| break; |
| default: |
| throw new IllegalArgumentException("Unknown EAP method"); |
| } |
| } |
| |
| /** |
| * Get the eap method. |
| * @return eap method configured |
| */ |
| public int getEapMethod() { |
| String eapMethod = mFields.get(EAP_KEY); |
| return getStringIndex(Eap.strings, eapMethod, Eap.NONE); |
| } |
| |
| /** |
| * Set Phase 2 authentication method. Sets the inner authentication method to be used in |
| * phase 2 after setting up a secure channel |
| * @param phase2Method is the inner authentication method and can be one of {@link Phase2#NONE}, |
| * {@link Phase2#PAP}, {@link Phase2#MSCHAP}, {@link Phase2#MSCHAPV2}, |
| * {@link Phase2#GTC} |
| * @throws IllegalArgumentException on an invalid phase2 method |
| * |
| */ |
| public void setPhase2Method(int phase2Method) { |
| switch (phase2Method) { |
| case Phase2.NONE: |
| mFields.put(PHASE2_KEY, EMPTY_VALUE); |
| break; |
| /** Valid methods */ |
| case Phase2.PAP: |
| case Phase2.MSCHAP: |
| case Phase2.MSCHAPV2: |
| case Phase2.GTC: |
| mFields.put(PHASE2_KEY, convertToQuotedString( |
| Phase2.PREFIX + Phase2.strings[phase2Method])); |
| break; |
| default: |
| throw new IllegalArgumentException("Unknown Phase 2 method"); |
| } |
| } |
| |
| /** |
| * Get the phase 2 authentication method. |
| * @return a phase 2 method defined at {@link Phase2} |
| * */ |
| public int getPhase2Method() { |
| String phase2Method = removeDoubleQuotes(mFields.get(PHASE2_KEY)); |
| // Remove auth= prefix |
| if (phase2Method.startsWith(Phase2.PREFIX)) { |
| phase2Method = phase2Method.substring(Phase2.PREFIX.length()); |
| } |
| return getStringIndex(Phase2.strings, phase2Method, Phase2.NONE); |
| } |
| |
| /** |
| * Set the identity |
| * @param identity |
| */ |
| public void setIdentity(String identity) { |
| setFieldValue(IDENTITY_KEY, identity, ""); |
| } |
| |
| /** |
| * Get the identity |
| * @return the identity |
| */ |
| public String getIdentity() { |
| return getFieldValue(IDENTITY_KEY, ""); |
| } |
| |
| /** |
| * Set anonymous identity. This is used as the unencrypted identity with |
| * certain EAP types |
| * @param anonymousIdentity the anonymous identity |
| */ |
| public void setAnonymousIdentity(String anonymousIdentity) { |
| setFieldValue(ANON_IDENTITY_KEY, anonymousIdentity, ""); |
| } |
| |
| /** Get the anonymous identity |
| * @return anonymous identity |
| */ |
| public String getAnonymousIdentity() { |
| return getFieldValue(ANON_IDENTITY_KEY, ""); |
| } |
| |
| /** |
| * Set the password. |
| * @param password the password |
| */ |
| public void setPassword(String password) { |
| setFieldValue(PASSWORD_KEY, password, ""); |
| } |
| |
| /** |
| * Get the password. |
| * |
| * Returns locally set password value. For networks fetched from |
| * framework, returns "*". |
| */ |
| public String getPassword() { |
| return getFieldValue(PASSWORD_KEY, ""); |
| } |
| |
| /** |
| * Encode a CA certificate alias so it does not contain illegal character. |
| * @hide |
| */ |
| public static String encodeCaCertificateAlias(String alias) { |
| byte[] bytes = alias.getBytes(StandardCharsets.UTF_8); |
| StringBuilder sb = new StringBuilder(bytes.length * 2); |
| for (byte o : bytes) { |
| sb.append(String.format("%02x", o & 0xFF)); |
| } |
| return sb.toString(); |
| } |
| |
| /** |
| * Decode a previously-encoded CA certificate alias. |
| * @hide |
| */ |
| public static String decodeCaCertificateAlias(String alias) { |
| byte[] data = new byte[alias.length() >> 1]; |
| for (int n = 0, position = 0; n < alias.length(); n += 2, position++) { |
| data[position] = (byte) Integer.parseInt(alias.substring(n, n + 2), 16); |
| } |
| try { |
| return new String(data, StandardCharsets.UTF_8); |
| } catch (NumberFormatException e) { |
| e.printStackTrace(); |
| return alias; |
| } |
| } |
| |
| /** |
| * Set CA certificate alias. |
| * |
| * <p> See the {@link android.security.KeyChain} for details on installing or choosing |
| * a certificate |
| * </p> |
| * @param alias identifies the certificate |
| * @hide |
| */ |
| public void setCaCertificateAlias(String alias) { |
| setFieldValue(CA_CERT_KEY, alias, CA_CERT_PREFIX); |
| } |
| |
| /** |
| * Set CA certificate aliases. When creating installing the corresponding certificate to |
| * the keystore, please use alias encoded by {@link #encodeCaCertificateAlias(String)}. |
| * |
| * <p> See the {@link android.security.KeyChain} for details on installing or choosing |
| * a certificate. |
| * </p> |
| * @param aliases identifies the certificate |
| * @hide |
| */ |
| public void setCaCertificateAliases(@Nullable String[] aliases) { |
| if (aliases == null) { |
| setFieldValue(CA_CERT_KEY, null, CA_CERT_PREFIX); |
| } else if (aliases.length == 1) { |
| // Backwards compatibility: use the original cert prefix if setting only one alias. |
| setCaCertificateAlias(aliases[0]); |
| } else { |
| // Use KEYSTORES_URI which supports multiple aliases. |
| StringBuilder sb = new StringBuilder(); |
| for (int i = 0; i < aliases.length; i++) { |
| if (i > 0) { |
| sb.append(CA_CERT_ALIAS_DELIMITER); |
| } |
| sb.append(encodeCaCertificateAlias(Credentials.CA_CERTIFICATE + aliases[i])); |
| } |
| setFieldValue(CA_CERT_KEY, sb.toString(), KEYSTORES_URI); |
| } |
| } |
| |
| /** |
| * Get CA certificate alias |
| * @return alias to the CA certificate |
| * @hide |
| */ |
| public String getCaCertificateAlias() { |
| return getFieldValue(CA_CERT_KEY, CA_CERT_PREFIX); |
| } |
| |
| /** |
| * Get CA certificate aliases |
| * @return alias to the CA certificate |
| * @hide |
| */ |
| @Nullable public String[] getCaCertificateAliases() { |
| String value = getFieldValue(CA_CERT_KEY, ""); |
| if (value.startsWith(CA_CERT_PREFIX)) { |
| // Backwards compatibility: parse the original alias prefix. |
| return new String[] {getFieldValue(CA_CERT_KEY, CA_CERT_PREFIX)}; |
| } else if (value.startsWith(KEYSTORES_URI)) { |
| String values = value.substring(KEYSTORES_URI.length()); |
| |
| String[] aliases = TextUtils.split(values, CA_CERT_ALIAS_DELIMITER); |
| for (int i = 0; i < aliases.length; i++) { |
| aliases[i] = decodeCaCertificateAlias(aliases[i]); |
| if (aliases[i].startsWith(Credentials.CA_CERTIFICATE)) { |
| aliases[i] = aliases[i].substring(Credentials.CA_CERTIFICATE.length()); |
| } |
| } |
| return aliases.length != 0 ? aliases : null; |
| } else { |
| return TextUtils.isEmpty(value) ? null : new String[] {value}; |
| } |
| } |
| |
| /** |
| * Specify a X.509 certificate that identifies the server. |
| * |
| * <p>A default name is automatically assigned to the certificate and used |
| * with this configuration. The framework takes care of installing the |
| * certificate when the config is saved and removing the certificate when |
| * the config is removed. |
| * |
| * @param cert X.509 CA certificate |
| * @throws IllegalArgumentException if not a CA certificate |
| */ |
| public void setCaCertificate(@Nullable X509Certificate cert) { |
| if (cert != null) { |
| if (cert.getBasicConstraints() >= 0) { |
| mCaCerts = new X509Certificate[] {cert}; |
| } else { |
| throw new IllegalArgumentException("Not a CA certificate"); |
| } |
| } else { |
| mCaCerts = null; |
| } |
| } |
| |
| /** |
| * Get CA certificate. If multiple CA certificates are configured previously, |
| * return the first one. |
| * @return X.509 CA certificate |
| */ |
| @Nullable public X509Certificate getCaCertificate() { |
| if (mCaCerts != null && mCaCerts.length > 0) { |
| return mCaCerts[0]; |
| } else { |
| return null; |
| } |
| } |
| |
| /** |
| * Specify a list of X.509 certificates that identifies the server. The validation |
| * passes if the CA of server certificate matches one of the given certificates. |
| |
| * <p>Default names are automatically assigned to the certificates and used |
| * with this configuration. The framework takes care of installing the |
| * certificates when the config is saved and removing the certificates when |
| * the config is removed. |
| * |
| * @param certs X.509 CA certificates |
| * @throws IllegalArgumentException if any of the provided certificates is |
| * not a CA certificate |
| */ |
| public void setCaCertificates(@Nullable X509Certificate[] certs) { |
| if (certs != null) { |
| X509Certificate[] newCerts = new X509Certificate[certs.length]; |
| for (int i = 0; i < certs.length; i++) { |
| if (certs[i].getBasicConstraints() >= 0) { |
| newCerts[i] = certs[i]; |
| } else { |
| throw new IllegalArgumentException("Not a CA certificate"); |
| } |
| } |
| mCaCerts = newCerts; |
| } else { |
| mCaCerts = null; |
| } |
| } |
| |
| /** |
| * Get CA certificates. |
| */ |
| @Nullable public X509Certificate[] getCaCertificates() { |
| if (mCaCerts != null || mCaCerts.length > 0) { |
| return mCaCerts; |
| } else { |
| return null; |
| } |
| } |
| |
| /** |
| * @hide |
| */ |
| public void resetCaCertificate() { |
| mCaCerts = null; |
| } |
| |
| /** |
| * Set the ca_path directive on wpa_supplicant. |
| * |
| * From wpa_supplicant documentation: |
| * |
| * Directory path for CA certificate files (PEM). This path may contain |
| * multiple CA certificates in OpenSSL format. Common use for this is to |
| * point to system trusted CA list which is often installed into directory |
| * 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. |
| * @param domain The path for CA certificate files |
| * @hide |
| */ |
| public void setCaPath(String path) { |
| setFieldValue(CA_PATH_KEY, path); |
| } |
| |
| /** |
| * Get the domain_suffix_match value. See setDomSuffixMatch. |
| * @return The path for CA certificate files. |
| * @hide |
| */ |
| public String getCaPath() { |
| return getFieldValue(CA_PATH_KEY, ""); |
| } |
| |
| /** Set Client certificate alias. |
| * |
| * <p> See the {@link android.security.KeyChain} for details on installing or choosing |
| * a certificate |
| * </p> |
| * @param alias identifies the certificate |
| * @hide |
| */ |
| public void setClientCertificateAlias(String alias) { |
| setFieldValue(CLIENT_CERT_KEY, alias, CLIENT_CERT_PREFIX); |
| setFieldValue(PRIVATE_KEY_ID_KEY, alias, Credentials.USER_PRIVATE_KEY); |
| // Also, set engine parameters |
| if (TextUtils.isEmpty(alias)) { |
| mFields.put(ENGINE_KEY, ENGINE_DISABLE); |
| mFields.put(ENGINE_ID_KEY, EMPTY_VALUE); |
| } else { |
| mFields.put(ENGINE_KEY, ENGINE_ENABLE); |
| mFields.put(ENGINE_ID_KEY, convertToQuotedString(ENGINE_ID_KEYSTORE)); |
| } |
| } |
| |
| /** |
| * Get client certificate alias |
| * @return alias to the client certificate |
| * @hide |
| */ |
| public String getClientCertificateAlias() { |
| return getFieldValue(CLIENT_CERT_KEY, CLIENT_CERT_PREFIX); |
| } |
| |
| /** |
| * Specify a private key and client certificate for client authorization. |
| * |
| * <p>A default name is automatically assigned to the key entry and used |
| * with this configuration. The framework takes care of installing the |
| * key entry when the config is saved and removing the key entry when |
| * the config is removed. |
| |
| * @param privateKey |
| * @param clientCertificate |
| * @throws IllegalArgumentException for an invalid key or certificate. |
| */ |
| public void setClientKeyEntry(PrivateKey privateKey, X509Certificate clientCertificate) { |
| if (clientCertificate != null) { |
| if (clientCertificate.getBasicConstraints() != -1) { |
| throw new IllegalArgumentException("Cannot be a CA certificate"); |
| } |
| if (privateKey == null) { |
| throw new IllegalArgumentException("Client cert without a private key"); |
| } |
| if (privateKey.getEncoded() == null) { |
| throw new IllegalArgumentException("Private key cannot be encoded"); |
| } |
| } |
| |
| mClientPrivateKey = privateKey; |
| mClientCertificate = clientCertificate; |
| } |
| |
| /** |
| * Get client certificate |
| * |
| * @return X.509 client certificate |
| */ |
| public X509Certificate getClientCertificate() { |
| return mClientCertificate; |
| } |
| |
| /** |
| * @hide |
| */ |
| public void resetClientKeyEntry() { |
| mClientPrivateKey = null; |
| mClientCertificate = null; |
| } |
| |
| /** |
| * @hide |
| */ |
| public PrivateKey getClientPrivateKey() { |
| return mClientPrivateKey; |
| } |
| |
| /** |
| * Set subject match (deprecated). This is the substring to be matched against the subject of |
| * the authentication server certificate. |
| * @param subjectMatch substring to be matched |
| * @deprecated in favor of altSubjectMatch |
| */ |
| public void setSubjectMatch(String subjectMatch) { |
| setFieldValue(SUBJECT_MATCH_KEY, subjectMatch, ""); |
| } |
| |
| /** |
| * Get subject match (deprecated) |
| * @return the subject match string |
| * @deprecated in favor of altSubjectMatch |
| */ |
| public String getSubjectMatch() { |
| return getFieldValue(SUBJECT_MATCH_KEY, ""); |
| } |
| |
| /** |
| * Set alternate subject match. This is the substring to be matched against the |
| * alternate subject of the authentication server certificate. |
| * @param altSubjectMatch substring to be matched, for example |
| * DNS:server.example.com;EMAIL:server@example.com |
| */ |
| public void setAltSubjectMatch(String altSubjectMatch) { |
| setFieldValue(ALTSUBJECT_MATCH_KEY, altSubjectMatch, ""); |
| } |
| |
| /** |
| * Get alternate subject match |
| * @return the alternate subject match string |
| */ |
| public String getAltSubjectMatch() { |
| return getFieldValue(ALTSUBJECT_MATCH_KEY, ""); |
| } |
| |
| /** |
| * Set the domain_suffix_match directive on wpa_supplicant. This is the parameter to use |
| * for Hotspot 2.0 defined matching of AAA server certs per WFA HS2.0 spec, section 7.3.3.2, |
| * second paragraph. |
| * |
| * From wpa_supplicant documentation: |
| * Constraint for server domain name. If set, this FQDN is used as a suffix match requirement |
| * for the AAAserver certificate in SubjectAltName dNSName element(s). If a matching dNSName is |
| * found, this constraint is met. If no dNSName values are present, this constraint is matched |
| * against SubjectName CN using same suffix match comparison. |
| * Suffix match here means that the host/domain name is compared one label at a time starting |
| * from the top-level domain and all the labels in domain_suffix_match shall be included in the |
| * certificate. The certificate may include additional sub-level labels in addition to the |
| * required labels. |
| * For example, domain_suffix_match=example.com would match test.example.com but would not |
| * match test-example.com. |
| * @param domain The domain value |
| */ |
| public void setDomainSuffixMatch(String domain) { |
| setFieldValue(DOM_SUFFIX_MATCH_KEY, domain); |
| } |
| |
| /** |
| * Get the domain_suffix_match value. See setDomSuffixMatch. |
| * @return The domain value. |
| */ |
| public String getDomainSuffixMatch() { |
| return getFieldValue(DOM_SUFFIX_MATCH_KEY, ""); |
| } |
| |
| /** |
| * Set realm for passpoint credential; realm identifies a set of networks where your |
| * passpoint credential can be used |
| * @param realm the realm |
| */ |
| public void setRealm(String realm) { |
| setFieldValue(REALM_KEY, realm, ""); |
| } |
| |
| /** |
| * Get realm for passpoint credential; see {@link #setRealm(String)} for more information |
| * @return the realm |
| */ |
| public String getRealm() { |
| return getFieldValue(REALM_KEY, ""); |
| } |
| |
| /** |
| * Set plmn (Public Land Mobile Network) of the provider of passpoint credential |
| * @param plmn the plmn value derived from mcc (mobile country code) & mnc (mobile network code) |
| */ |
| public void setPlmn(String plmn) { |
| setFieldValue(PLMN_KEY, plmn, ""); |
| } |
| |
| /** |
| * Get plmn (Public Land Mobile Network) for passpoint credential; see {@link #setPlmn |
| * (String)} for more information |
| * @return the plmn |
| */ |
| public String getPlmn() { |
| return getFieldValue(PLMN_KEY, ""); |
| } |
| |
| /** See {@link WifiConfiguration#getKeyIdForCredentials} @hide */ |
| String getKeyId(WifiEnterpriseConfig current) { |
| String eap = mFields.get(EAP_KEY); |
| String phase2 = mFields.get(PHASE2_KEY); |
| |
| // If either eap or phase2 are not initialized, use current config details |
| if (TextUtils.isEmpty((eap))) { |
| eap = current.mFields.get(EAP_KEY); |
| } |
| if (TextUtils.isEmpty(phase2)) { |
| phase2 = current.mFields.get(PHASE2_KEY); |
| } |
| return eap + "_" + phase2; |
| } |
| |
| private String removeDoubleQuotes(String string) { |
| if (TextUtils.isEmpty(string)) return ""; |
| int length = string.length(); |
| if ((length > 1) && (string.charAt(0) == '"') |
| && (string.charAt(length - 1) == '"')) { |
| return string.substring(1, length - 1); |
| } |
| return string; |
| } |
| |
| private String convertToQuotedString(String string) { |
| return "\"" + string + "\""; |
| } |
| |
| /** Returns the index at which the toBeFound string is found in the array. |
| * @param arr array of strings |
| * @param toBeFound string to be found |
| * @param defaultIndex default index to be returned when string is not found |
| * @return the index into array |
| */ |
| private int getStringIndex(String arr[], String toBeFound, int defaultIndex) { |
| if (TextUtils.isEmpty(toBeFound)) return defaultIndex; |
| for (int i = 0; i < arr.length; i++) { |
| if (toBeFound.equals(arr[i])) return i; |
| } |
| return defaultIndex; |
| } |
| |
| /** Returns the field value for the key. |
| * @param key into the hash |
| * @param prefix is the prefix that the value may have |
| * @return value |
| * @hide |
| */ |
| public String getFieldValue(String key, String prefix) { |
| String value = mFields.get(key); |
| // Uninitialized or known to be empty after reading from supplicant |
| if (TextUtils.isEmpty(value) || EMPTY_VALUE.equals(value)) return ""; |
| |
| value = removeDoubleQuotes(value); |
| if (value.startsWith(prefix)) { |
| return value.substring(prefix.length()); |
| } else { |
| return value; |
| } |
| } |
| |
| /** Set a value with an optional prefix at key |
| * @param key into the hash |
| * @param value to be set |
| * @param prefix an optional value to be prefixed to actual value |
| * @hide |
| */ |
| public void setFieldValue(String key, String value, String prefix) { |
| if (TextUtils.isEmpty(value)) { |
| mFields.put(key, EMPTY_VALUE); |
| } else { |
| mFields.put(key, convertToQuotedString(prefix + value)); |
| } |
| } |
| |
| |
| /** Set a value with an optional prefix at key |
| * @param key into the hash |
| * @param value to be set |
| * @param prefix an optional value to be prefixed to actual value |
| * @hide |
| */ |
| public void setFieldValue(String key, String value) { |
| if (TextUtils.isEmpty(value)) { |
| mFields.put(key, EMPTY_VALUE); |
| } else { |
| mFields.put(key, convertToQuotedString(value)); |
| } |
| } |
| |
| @Override |
| public String toString() { |
| StringBuffer sb = new StringBuffer(); |
| for (String key : mFields.keySet()) { |
| // Don't display password in toString(). |
| String value = (key == PASSWORD_KEY) ? "<removed>" : mFields.get(key); |
| sb.append(key).append(" ").append(value).append("\n"); |
| } |
| return sb.toString(); |
| } |
| } |