michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.conn.ssl;
michael@0: 
michael@0: import javax.net.ssl.HostnameVerifier;
michael@0: import javax.net.ssl.SSLException;
michael@0: import javax.net.ssl.SSLSocket;
michael@0: import java.io.IOException;
michael@0: import java.security.cert.X509Certificate;
michael@0: 
michael@0: /**
michael@0:  * Interface for checking if a hostname matches the names stored inside the
michael@0:  * server's X.509 certificate.  This interface extends
michael@0:  * {@link javax.net.ssl.HostnameVerifier}, but it is recommended to use
michael@0:  * methods added by X509HostnameVerifier.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface X509HostnameVerifier extends HostnameVerifier {
michael@0: 
michael@0:     /**
michael@0:      * Verifies that the host name is an acceptable match with the server's
michael@0:      * authentication scheme based on the given {@link SSLSocket}.
michael@0:      *
michael@0:      * @param host the host.
michael@0:      * @param ssl the SSL socket.
michael@0:      * @throws IOException if an I/O error occurs or the verification process
michael@0:      *   fails.
michael@0:      */
michael@0:     void verify(String host, SSLSocket ssl) throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Verifies that the host name is an acceptable match with the server's
michael@0:      * authentication scheme based on the given {@link X509Certificate}.
michael@0:      *
michael@0:      * @param host the host.
michael@0:      * @param cert the certificate.
michael@0:      * @throws SSLException if the verification process fails.
michael@0:      */
michael@0:     void verify(String host, X509Certificate cert) throws SSLException;
michael@0: 
michael@0:     /**
michael@0:      * Checks to see if the supplied hostname matches any of the supplied CNs
michael@0:      * or "DNS" Subject-Alts.  Most implementations only look at the first CN,
michael@0:      * and ignore any additional CNs.  Most implementations do look at all of
michael@0:      * the "DNS" Subject-Alts. The CNs or Subject-Alts may contain wildcards
michael@0:      * according to RFC 2818.
michael@0:      *
michael@0:      * @param cns         CN fields, in order, as extracted from the X.509
michael@0:      *                    certificate.
michael@0:      * @param subjectAlts Subject-Alt fields of type 2 ("DNS"), as extracted
michael@0:      *                    from the X.509 certificate.
michael@0:      * @param host        The hostname to verify.
michael@0:      * @throws SSLException if the verification process fails.
michael@0:      */
michael@0:     void verify(String host, String[] cns, String[] subjectAlts)
michael@0:           throws SSLException;
michael@0: 
michael@0: }