CertificateChainValidator.java revision 93ba4fedebb78ba47c24e8472c8960ea8fdc933a
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.net.http; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 192269d1572e5fcfb725ea55f5764d8c3280d69f6dDianne Hackborn 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.IOException; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.security.cert.Certificate; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.security.cert.CertificateException; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.security.cert.X509Certificate; 2452cd299eef703030f8fcf7a92f413791301771ccJesse Wilsonimport javax.net.ssl.DefaultHostnameVerifier; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport javax.net.ssl.SSLHandshakeException; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport javax.net.ssl.SSLSession; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport javax.net.ssl.SSLSocket; 2893ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurunimport javax.net.ssl.X509TrustManager; 2952cd299eef703030f8fcf7a92f413791301771ccJesse Wilsonimport org.apache.harmony.security.provider.cert.X509CertImpl; 3052cd299eef703030f8fcf7a92f413791301771ccJesse Wilsonimport org.apache.harmony.xnet.provider.jsse.SSLParametersImpl; 3193ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurunimport org.apache.harmony.xnet.provider.jsse.TrustManagerImpl; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Class responsible for all server certificate validation functionality 3552cd299eef703030f8fcf7a92f413791301771ccJesse Wilson * 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@hide} 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3893ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurunpublic class CertificateChainValidator { 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The singleton instance of the certificate chain validator 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 43886f3d69b79748fe937725e33b8bbb3d67ab82c7Bob Lee private static final CertificateChainValidator sInstance 44886f3d69b79748fe937725e33b8bbb3d67ab82c7Bob Lee = new CertificateChainValidator(); 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4652cd299eef703030f8fcf7a92f413791301771ccJesse Wilson private static final DefaultHostnameVerifier sVerifier 4752cd299eef703030f8fcf7a92f413791301771ccJesse Wilson = new DefaultHostnameVerifier(); 4852cd299eef703030f8fcf7a92f413791301771ccJesse Wilson 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 50c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * @return The singleton instance of the certificates chain validator 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static CertificateChainValidator getInstance() { 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sInstance; 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 57c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * Creates a new certificate chain validator. This is a private constructor. 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you need a Certificate chain validator, call getInstance(). 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 60e97c2006bf7c391c933307e520a392e532aa5d6aBob Lee private CertificateChainValidator() {} 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Performs the handshake and server certificates validation 64c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * Notice a new chain will be rebuilt by tracing the issuer and subject 65c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * before calling checkServerTrusted(). 66c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * And if the last traced certificate is self issued and it is expired, it 67c4e834dc47885c8dbd3a2911ce4b9fccde21c800Huahui Wu * will be dropped. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param sslSocket The secure connection socket 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param domain The website domain 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return An SSL error object if there is an error and null otherwise 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SslError doHandshakeAndValidateServerCertificates( 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project HttpsConnection connection, SSLSocket sslSocket, String domain) 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws IOException { 75e103355d9332e2fab9d5c408e824ac8ab3b915a7Brian Carlstrom // get a valid SSLSession, close the socket if we fail 7685ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu SSLSession sslSession = sslSocket.getSession(); 77e103355d9332e2fab9d5c408e824ac8ab3b915a7Brian Carlstrom if (!sslSession.isValid()) { 78e103355d9332e2fab9d5c408e824ac8ab3b915a7Brian Carlstrom closeSocketThrowException(sslSocket, "failed to perform SSL handshake"); 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // retrieve the chain of the server peer certificates 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Certificate[] peerCertificates = 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sslSocket.getSession().getPeerCertificates(); 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8585ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu if (peerCertificates == null || peerCertificates.length == 0) { 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project closeSocketThrowException( 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sslSocket, "failed to retrieve peer certificates"); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // update the SSL certificate associated with the connection 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (connection != null) { 9185ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu if (peerCertificates[0] != null) { 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project connection.setCertificate( 9385ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu new SslCertificate((X509Certificate)peerCertificates[0])); 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 988234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu return verifyServerDomainAndCertificates((X509Certificate[]) peerCertificates, domain, "RSA"); 9985ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu } 10085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 10185ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu /** 10285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * Similar to doHandshakeAndValidateServerCertificates but exposed to JNI for use 10385ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * by Chromium HTTPS stack to validate the cert chain. 1048234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu * @param certChain The bytes for certificates in ASN.1 DER encoded certificates format. 10585ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * @param domain The full website hostname and domain 1068234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu * @param authType The authentication type for the cert chain 10785ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * @return An SSL error object if there is an error and null otherwise 10885ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu */ 10985ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu public static SslError verifyServerCertificates( 11085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu byte[][] certChain, String domain, String authType) 11185ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu throws IOException { 11285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 11385ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu if (certChain == null || certChain.length == 0) { 11485ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu throw new IllegalArgumentException("bad certificate chain"); 11585ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu } 11685ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 11785ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu X509Certificate[] serverCertificates = new X509Certificate[certChain.length]; 11885ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 11985ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu for (int i = 0; i < certChain.length; ++i) { 12085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu serverCertificates[i] = new X509CertImpl(certChain[i]); 12185ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu } 12285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 1238234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu return verifyServerDomainAndCertificates(serverCertificates, domain, authType); 12485ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu } 12585ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 12685ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu /** 12793ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun * Handles updates to credential storage. 12893ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun */ 12993ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun public static void handleTrustStorageUpdate() { 13093ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun 13193ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun X509TrustManager x509TrustManager = SSLParametersImpl.getDefaultTrustManager(); 13293ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun if( x509TrustManager instanceof TrustManagerImpl ) { 13393ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun TrustManagerImpl trustManager = (TrustManagerImpl) x509TrustManager; 13493ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun trustManager.handleTrustStorageUpdate(); 13593ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun } 13693ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun } 13793ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun 13893ba4fedebb78ba47c24e8472c8960ea8fdc933aSelim Gurun /** 13985ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * Common code of doHandshakeAndValidateServerCertificates and verifyServerCertificates. 1408234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu * Calls DomainNamevalidator to verify the domain, and TrustManager to verify the certs. 14185ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * @param chain the cert chain in X509 cert format. 14285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * @param domain The full website hostname and domain 1438234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu * @param authType The authentication type for the cert chain 14485ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu * @return An SSL error object if there is an error and null otherwise 14585ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu */ 14685ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu private static SslError verifyServerDomainAndCertificates( 1478234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu X509Certificate[] chain, String domain, String authType) 14885ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu throws IOException { 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // check if the first certificate in the chain is for this site 15085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu X509Certificate currCertificate = chain[0]; 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (currCertificate == null) { 15285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu throw new IllegalArgumentException("certificate for this site is null"); 15385ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu } 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15552cd299eef703030f8fcf7a92f413791301771ccJesse Wilson boolean valid = domain != null 15652cd299eef703030f8fcf7a92f413791301771ccJesse Wilson && !domain.isEmpty() 15752cd299eef703030f8fcf7a92f413791301771ccJesse Wilson && sVerifier.verify(domain, currCertificate); 15852cd299eef703030f8fcf7a92f413791301771ccJesse Wilson if (!valid) { 15985ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu if (HttpLog.LOGV) { 16085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu HttpLog.v("certificate not for this host: " + domain); 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16285ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu return new SslError(SslError.SSL_IDMISMATCH, currCertificate); 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1668234bdb36a951c1265b2bc702c06bab09509a615Huahui Wu SSLParametersImpl.getDefaultTrustManager().checkServerTrusted(chain, authType); 16785ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu return null; // No errors. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (CertificateException e) { 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (HttpLog.LOGV) { 17085ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu HttpLog.v("failed to validate the certificate chain, error: " + 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.getMessage()); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17385ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu return new SslError(SslError.SSL_UNTRUSTED, currCertificate); 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17785ffa26f67efad30912e1561b5123b6f8f5827eeHuahui Wu 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void closeSocketThrowException( 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SSLSocket socket, String errorMessage, String defaultErrorMessage) 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws IOException { 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project closeSocketThrowException( 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project socket, errorMessage != null ? errorMessage : defaultErrorMessage); 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void closeSocketThrowException(SSLSocket socket, 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String errorMessage) throws IOException { 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (HttpLog.LOGV) { 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project HttpLog.v("validation error: " + errorMessage); 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (socket != null) { 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SSLSession session = socket.getSession(); 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (session != null) { 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project session.invalidate(); 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project socket.close(); 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new SSLHandshakeException(errorMessage); 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 203