326 lines
9.8 KiB
Java
326 lines
9.8 KiB
Java
/* HttpsURLConnection.java -- an HTTPS connection.
|
|
Copyright (C) 2004, 2006 Free Software Foundation, Inc.
|
|
|
|
This file is part of GNU Classpath.
|
|
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
any later version.
|
|
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA.
|
|
|
|
Linking this library statically or dynamically with other modules is
|
|
making a combined work based on this library. Thus, the terms and
|
|
conditions of the GNU General Public License cover the whole
|
|
combination.
|
|
|
|
As a special exception, the copyright holders of this library give you
|
|
permission to link this library with independent modules to produce an
|
|
executable, regardless of the license terms of these independent
|
|
modules, and to copy and distribute the resulting executable under
|
|
terms of your choice, provided that you also meet, for each linked
|
|
independent module, the terms and conditions of the license of that
|
|
module. An independent module is a module which is not derived from
|
|
or based on this library. If you modify this library, you may extend
|
|
this exception to your version of the library, but you are not
|
|
obligated to do so. If you do not wish to do so, delete this
|
|
exception statement from your version. */
|
|
|
|
|
|
package javax.net.ssl;
|
|
|
|
import java.io.IOException;
|
|
import java.net.HttpURLConnection;
|
|
import java.net.URL;
|
|
import java.security.Principal;
|
|
import java.security.cert.Certificate;
|
|
import java.security.cert.X509Certificate;
|
|
|
|
/**
|
|
* A URL connection that connects via the <i>Secure Socket Layer</i>
|
|
* (<b>SSL</b>) for HTTPS connections.
|
|
*
|
|
* <p>This class may be used in the same way as {@link
|
|
* HttpURLConnection}, and it will transparently negotiate the SSL
|
|
* connection.
|
|
*
|
|
* @author Casey Marshall (rsdio@metastatic.org)
|
|
*/
|
|
public abstract class HttpsURLConnection extends HttpURLConnection
|
|
{
|
|
|
|
// Fields.
|
|
// ------------------------------------------------------------------
|
|
|
|
/**
|
|
* The default verifier.
|
|
* This is lazily initialized as required.
|
|
* @see #getDefaultHostnameVerifier
|
|
*/
|
|
private static HostnameVerifier defaultVerifier;
|
|
|
|
/**
|
|
* The default factory.
|
|
* This is lazily initialized as required.
|
|
* @see #getDefaultSSLSocketFactory
|
|
*/
|
|
private static SSLSocketFactory defaultFactory;
|
|
|
|
/**
|
|
* The hostname verifier used for this connection.
|
|
*/
|
|
protected HostnameVerifier hostnameVerifier;
|
|
|
|
/**
|
|
* This connection's socket factory.
|
|
*/
|
|
private SSLSocketFactory factory;
|
|
|
|
// Constructor.
|
|
// ------------------------------------------------------------------
|
|
|
|
/**
|
|
* Creates a new HTTPS URL connection.
|
|
*
|
|
* @param url The URL of the connection being established.
|
|
* @specnote This was marked as throwing IOException in 1.4,
|
|
* but this was removed in 1.5.
|
|
*/
|
|
protected HttpsURLConnection(URL url)
|
|
{
|
|
super(url);
|
|
}
|
|
|
|
// Class methods.
|
|
// ------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the default hostname verifier used in all new
|
|
* connections.
|
|
* If the default verifier has not been set, a new default one will be
|
|
* provided by this method.
|
|
*
|
|
* @return The default hostname verifier.
|
|
*/
|
|
public static synchronized HostnameVerifier getDefaultHostnameVerifier()
|
|
{
|
|
if (defaultVerifier == null)
|
|
{
|
|
defaultVerifier = new TrivialHostnameVerifier();
|
|
}
|
|
return defaultVerifier;
|
|
}
|
|
|
|
/**
|
|
* Sets the default hostname verifier to be used in all new
|
|
* connections.
|
|
*
|
|
* @param newDefault The new default hostname verifier.
|
|
* @throws IllegalArgumentException If <i>newDefault</i> is null.
|
|
* @throws SecurityException If there is a security manager
|
|
* currently installed and the caller does not have the {@link
|
|
* SSLPermission} "setHostnameVerifier".
|
|
*/
|
|
public static void setDefaultHostnameVerifier(HostnameVerifier newDefault)
|
|
{
|
|
if (newDefault == null)
|
|
throw new IllegalArgumentException("default verifier cannot be null");
|
|
SecurityManager sm = System.getSecurityManager();
|
|
if (sm != null)
|
|
sm.checkPermission(new SSLPermission("setHostnameVerifier"));
|
|
synchronized (HttpsURLConnection.class)
|
|
{
|
|
defaultVerifier = newDefault;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the default SSL socket factory used in all new
|
|
* connections.
|
|
* If the default SSL socket factory has not been set, a new default one
|
|
* will be provided by this method.
|
|
*
|
|
* @return The default SSL socket factory.
|
|
*/
|
|
public static synchronized SSLSocketFactory getDefaultSSLSocketFactory()
|
|
{
|
|
if (defaultFactory == null)
|
|
{
|
|
try
|
|
{
|
|
defaultFactory = (SSLSocketFactory) SSLSocketFactory.getDefault();
|
|
}
|
|
catch (Throwable t)
|
|
{
|
|
t.printStackTrace();
|
|
}
|
|
}
|
|
return defaultFactory;
|
|
}
|
|
|
|
/**
|
|
* Sets the default SSL socket factory to be used in all new
|
|
* connections.
|
|
*
|
|
* @param newDefault The new socket factory.
|
|
* @throws IllegalArgumentException If <i>newDefault</i> is null.
|
|
* @throws SecurityException If there is a security manager
|
|
* installed and a call to {@link
|
|
* SecurityManager#checkSetFactory()} fails.
|
|
*/
|
|
public static void setDefaultSSLSocketFactory(SSLSocketFactory newDefault)
|
|
{
|
|
if (newDefault == null)
|
|
throw new IllegalArgumentException("default factory cannot be null");
|
|
SecurityManager sm = System.getSecurityManager();
|
|
if (sm != null)
|
|
sm.checkSetFactory();
|
|
synchronized (HttpsURLConnection.class)
|
|
{
|
|
defaultFactory = newDefault;
|
|
}
|
|
}
|
|
|
|
// Instance methods.
|
|
// ------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the current hostname verifier for this instance.
|
|
*
|
|
* @return The hostname verifier.
|
|
*/
|
|
public HostnameVerifier getHostnameVerifier()
|
|
{
|
|
if (hostnameVerifier == null)
|
|
{
|
|
hostnameVerifier = getDefaultHostnameVerifier();
|
|
}
|
|
return hostnameVerifier;
|
|
}
|
|
|
|
/**
|
|
* Sets the hostname verifier for this instance.
|
|
*
|
|
* @param hostnameVerifier The new verifier.
|
|
* @throws IllegalArgumentException If <i>hostnameVerifier</i> is
|
|
* null.
|
|
*/
|
|
public void setHostnameVerifier(HostnameVerifier hostnameVerifier)
|
|
{
|
|
if (hostnameVerifier == null)
|
|
throw new IllegalArgumentException("verifier cannot be null");
|
|
this.hostnameVerifier = hostnameVerifier;
|
|
}
|
|
|
|
/**
|
|
* Returns the current SSL socket factory for this instance.
|
|
*
|
|
* @return The current SSL socket factory.
|
|
*/
|
|
public SSLSocketFactory getSSLSocketFactory()
|
|
{
|
|
if (factory == null)
|
|
{
|
|
factory = getDefaultSSLSocketFactory();
|
|
}
|
|
return factory;
|
|
}
|
|
|
|
/**
|
|
* Sets the SSL socket factory for this instance.
|
|
*
|
|
* @param factory The new factory.
|
|
* @throws IllegalArgumentException If <i>factory</i> is null.
|
|
*/
|
|
public void setSSLSocketFactory(SSLSocketFactory factory)
|
|
{
|
|
if (factory == null)
|
|
throw new IllegalArgumentException("factory cannot be null");
|
|
this.factory = factory;
|
|
}
|
|
|
|
/**
|
|
* Returns the local principal for this connection.
|
|
*
|
|
* <p>The default implementation will return the {@link
|
|
* javax.security.x500.X500Principal} for the end entity certificate
|
|
* in the local certificate chain if those certificates are of type
|
|
* {@link java.security.cert.X509Certificate}. Otherwise, this
|
|
* method returns <code>null</code>.
|
|
*
|
|
* @return The local principal.
|
|
* @since 1.5
|
|
*/
|
|
public Principal getLocalPrincipal ()
|
|
{
|
|
Certificate[] c = getLocalCertificates ();
|
|
if (c != null && c.length > 0 && (c[0] instanceof X509Certificate))
|
|
return ((X509Certificate) c[0]).getSubjectX500Principal ();
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the remote peer's principal for this connection.
|
|
*
|
|
* <p>The default implementation will return the {@link
|
|
* javax.security.x500.X500Principal} for the end entity certificate
|
|
* in the remote peer's certificate chain if those certificates are
|
|
* of type {@link java.security.cert.X509Certificate}. Otherwise,
|
|
* this method returns <code>null</code>.
|
|
*
|
|
* @return The remote principal.
|
|
* @throws SSLPeerUnverifiedException If the remote peer has not
|
|
* been verified.
|
|
* @since 1.5
|
|
*/
|
|
public Principal getPeerPrincipal () throws SSLPeerUnverifiedException
|
|
{
|
|
Certificate[] c = getServerCertificates ();
|
|
if (c != null && c.length > 0 && (c[0] instanceof X509Certificate))
|
|
return ((X509Certificate) c[0]).getSubjectX500Principal ();
|
|
return null;
|
|
}
|
|
|
|
// Abstract methods.
|
|
// -------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the cipher name negotiated for this connection.
|
|
*
|
|
* @return The cipher name.
|
|
* @throws IllegalStateException If the connection has not yet been
|
|
* established.
|
|
*/
|
|
public abstract String getCipherSuite();
|
|
|
|
/**
|
|
* Returns the certificates used on the local side in this
|
|
* connection.
|
|
*
|
|
* @return The local certificates.
|
|
* @throws IllegalStateException If the connection has not yet been
|
|
* established.
|
|
*/
|
|
public abstract Certificate[] getLocalCertificates();
|
|
|
|
/**
|
|
* Returns the certificates sent by the other party.
|
|
*
|
|
* @return The peer's certificates.
|
|
* @throws IllegalStateException If the connection has not yet been
|
|
* established.
|
|
* @throws SSLPeerUnverifiedException If the peer could not be
|
|
* verified.
|
|
*/
|
|
public abstract Certificate[] getServerCertificates() throws SSLPeerUnverifiedException;
|
|
}
|