ojluni/src/main/java/javax/net/ssl/SSLParameters.java - platform/libcore.git - Git at Google

 /*
  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code 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
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */

 package javax.net.ssl;

 import java.security.AlgorithmConstraints;

 /**
  * Encapsulates parameters for an SSL/TLS connection. The parameters
  * are the list of ciphersuites to be accepted in an SSL/TLS handshake,
  * the list of protocols to be allowed, the endpoint identification
  * algorithm during SSL/TLS handshaking, the algorithm constraints and
  * whether SSL/TLS servers should request or require client authentication.
  * <p>
  * SSLParameters can be created via the constructors in this class.
  * Objects can also be obtained using the <code>getSSLParameters()</code>
  * methods in
  * {@link SSLSocket#getSSLParameters SSLSocket} and
  * {@link SSLServerSocket#getSSLParameters SSLServerSocket} and
  * {@link SSLEngine#getSSLParameters SSLEngine} or the
  * {@link SSLContext#getDefaultSSLParameters getDefaultSSLParameters()} and
  * {@link SSLContext#getSupportedSSLParameters getSupportedSSLParameters()}
  * methods in <code>SSLContext</code>.
  * <p>
  * SSLParameters can be applied to a connection via the methods
  * {@link SSLSocket#setSSLParameters SSLSocket.setSSLParameters()} and
  * {@link SSLServerSocket#setSSLParameters SSLServerSocket.setSSLParameters()}
  * and {@link SSLEngine#setSSLParameters SSLEngine.getSSLParameters()}.
  *
  * @see SSLSocket
  * @see SSLEngine
  * @see SSLContext
  *
  * @since 1.6
  */
 public class SSLParameters {

     private String[] cipherSuites;
     private String[] protocols;
     private boolean wantClientAuth;
     private boolean needClientAuth;
     private String identificationAlgorithm;
     private AlgorithmConstraints algorithmConstraints;

     /**
      * Constructs SSLParameters.
      * <p>
      * The cipherSuites and protocols values are set to <code>null</code>,
      * wantClientAuth and needClientAuth are set to <code>false</code>.
      */
     public SSLParameters() {
         // empty
     }

     /**
      * Constructs SSLParameters from the specified array of ciphersuites.
      * <p>
      * Calling this constructor is equivalent to calling the no-args
      * constructor followed by
      * <code>setCipherSuites(cipherSuites);</code>.
      *
      * @param cipherSuites the array of ciphersuites (or null)
      */
     public SSLParameters(String[] cipherSuites) {
         setCipherSuites(cipherSuites);
     }

     /**
      * Constructs SSLParameters from the specified array of ciphersuites
      * and protocols.
      * <p>
      * Calling this constructor is equivalent to calling the no-args
      * constructor followed by
      * <code>setCipherSuites(cipherSuites); setProtocols(protocols);</code>.
      *
      * @param cipherSuites the array of ciphersuites (or null)
      * @param protocols the array of protocols (or null)
      */
     public SSLParameters(String[] cipherSuites, String[] protocols) {
         setCipherSuites(cipherSuites);
         setProtocols(protocols);
     }

     private static String[] clone(String[] s) {
         return (s == null) ? null : s.clone();
     }

     /**
      * Returns a copy of the array of ciphersuites or null if none
      * have been set.
      *
      * @return a copy of the array of ciphersuites or null if none
      * have been set.
      */
     public String[] getCipherSuites() {
         return clone(cipherSuites);
     }

     /**
      * Sets the array of ciphersuites.
      *
      * @param cipherSuites the array of ciphersuites (or null)
      */
     public void setCipherSuites(String[] cipherSuites) {
         this.cipherSuites = clone(cipherSuites);
     }

     /**
      * Returns a copy of the array of protocols or null if none
      * have been set.
      *
      * @return a copy of the array of protocols or null if none
      * have been set.
      */
     public String[] getProtocols() {
         return clone(protocols);
     }

     /**
      * Sets the array of protocols.
      *
      * @param protocols the array of protocols (or null)
      */
     public void setProtocols(String[] protocols) {
         this.protocols = clone(protocols);
     }

     /**
      * Returns whether client authentication should be requested.
      *
      * @return whether client authentication should be requested.
      */
     public boolean getWantClientAuth() {
         return wantClientAuth;
     }

     /**
      * Sets whether client authentication should be requested. Calling
      * this method clears the <code>needClientAuth</code> flag.
      *
      * @param wantClientAuth whether client authentication should be requested
      */
     public void setWantClientAuth(boolean wantClientAuth) {
         this.wantClientAuth = wantClientAuth;
         this.needClientAuth = false;
     }

     /**
      * Returns whether client authentication should be required.
      *
      * @return whether client authentication should be required.
      */
     public boolean getNeedClientAuth() {
         return needClientAuth;
     }

     /**
      * Sets whether client authentication should be required. Calling
      * this method clears the <code>wantClientAuth</code> flag.
      *
      * @param needClientAuth whether client authentication should be required
      */
     public void setNeedClientAuth(boolean needClientAuth) {
         this.wantClientAuth = false;
         this.needClientAuth = needClientAuth;
     }

     /**
      * Returns the cryptographic algorithm constraints.
      *
      * @return the cryptographic algorithm constraints, or null if the
      *     constraints have not been set
      *
      * @see #setAlgorithmConstraints(AlgorithmConstraints)
      *
      * @since 1.7
      */
     public AlgorithmConstraints getAlgorithmConstraints() {
         return algorithmConstraints;
     }

     /**
      * Sets the cryptographic algorithm constraints, which will be used
      * in addition to any configured by the runtime environment.
      * <p>
      * If the <code>constraints</code> parameter is non-null, every
      * cryptographic algorithm, key and algorithm parameters used in the
      * SSL/TLS handshake must be permitted by the constraints.
      *
      * @param constraints the algorithm constraints (or null)
      *
      * @since 1.7
      */
     public void setAlgorithmConstraints(AlgorithmConstraints constraints) {
         // the constraints object is immutable
         this.algorithmConstraints = constraints;
     }

     /**
      * Gets the endpoint identification algorithm.
      *
      * @return the endpoint identification algorithm, or null if none
      * has been set.
      *
      * @see X509ExtendedTrustManager
      * @see #setEndpointIdentificationAlgorithm(String)
      *
      * @since 1.7
      */
     public String getEndpointIdentificationAlgorithm() {
         return identificationAlgorithm;
     }

     /**
      * Sets the endpoint identification algorithm.
      * <p>
      * If the <code>algorithm</code> parameter is non-null or non-empty, the
      * endpoint identification/verification procedures must be handled during
      * SSL/TLS handshaking.  This is to prevent man-in-the-middle attacks.
      *
      * @param algorithm The standard string name of the endpoint
      *     identification algorithm (or null).  See Appendix A in the <a href=
      *   "{@docRoot}/../technotes/guides/security/crypto/CryptoSpec.html#AppA">
      *     Java Cryptography Architecture API Specification &amp; Reference </a>
      *     for information about standard algorithm names.
      *
      * @see X509ExtendedTrustManager
      *
      * @since 1.7
      */
     public void setEndpointIdentificationAlgorithm(String algorithm) {
         this.identificationAlgorithm = algorithm;
     }

 }
	/*
	* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
	*
	* This code is free software; you can redistribute it and/or modify it
	* under the terms of the GNU General Public License version 2 only, as
	* published by the Free Software Foundation. Oracle designates this
	* particular file as subject to the "Classpath" exception as provided
	* by Oracle in the LICENSE file that accompanied this code.
	*
	* This code 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
	* version 2 for more details (a copy is included in the LICENSE file that
	* accompanied this code).
	*
	* You should have received a copy of the GNU General Public License version
	* 2 along with this work; if not, write to the Free Software Foundation,
	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
	*
	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
	* or visit www.oracle.com if you need additional information or have any
	* questions.
	*/

	package javax.net.ssl;

	import java.security.AlgorithmConstraints;

	/**
	* Encapsulates parameters for an SSL/TLS connection. The parameters
	* are the list of ciphersuites to be accepted in an SSL/TLS handshake,
	* the list of protocols to be allowed, the endpoint identification
	* algorithm during SSL/TLS handshaking, the algorithm constraints and
	* whether SSL/TLS servers should request or require client authentication.
	* <p>
	* SSLParameters can be created via the constructors in this class.
	* Objects can also be obtained using the <code>getSSLParameters()</code>
	* methods in
	* {@link SSLSocket#getSSLParameters SSLSocket} and
	* {@link SSLServerSocket#getSSLParameters SSLServerSocket} and
	* {@link SSLEngine#getSSLParameters SSLEngine} or the
	* {@link SSLContext#getDefaultSSLParameters getDefaultSSLParameters()} and
	* {@link SSLContext#getSupportedSSLParameters getSupportedSSLParameters()}
	* methods in <code>SSLContext</code>.
	* <p>
	* SSLParameters can be applied to a connection via the methods
	* {@link SSLSocket#setSSLParameters SSLSocket.setSSLParameters()} and
	* {@link SSLServerSocket#setSSLParameters SSLServerSocket.setSSLParameters()}
	* and {@link SSLEngine#setSSLParameters SSLEngine.getSSLParameters()}.
	*
	* @see SSLSocket
	* @see SSLEngine
	* @see SSLContext
	*
	* @since 1.6
	*/
	public class SSLParameters {

	private String[] cipherSuites;
	private String[] protocols;
	private boolean wantClientAuth;
	private boolean needClientAuth;
	private String identificationAlgorithm;
	private AlgorithmConstraints algorithmConstraints;

	/**
	* Constructs SSLParameters.
	* <p>
	* The cipherSuites and protocols values are set to <code>null</code>,
	* wantClientAuth and needClientAuth are set to <code>false</code>.
	*/
	public SSLParameters() {
	// empty
	}

	/**
	* Constructs SSLParameters from the specified array of ciphersuites.
	* <p>
	* Calling this constructor is equivalent to calling the no-args
	* constructor followed by
	* <code>setCipherSuites(cipherSuites);</code>.
	*
	* @param cipherSuites the array of ciphersuites (or null)
	*/
	public SSLParameters(String[] cipherSuites) {
	setCipherSuites(cipherSuites);
	}

	/**
	* Constructs SSLParameters from the specified array of ciphersuites
	* and protocols.
	* <p>
	* Calling this constructor is equivalent to calling the no-args
	* constructor followed by
	* <code>setCipherSuites(cipherSuites); setProtocols(protocols);</code>.
	*
	* @param cipherSuites the array of ciphersuites (or null)
	* @param protocols the array of protocols (or null)
	*/
	public SSLParameters(String[] cipherSuites, String[] protocols) {
	setCipherSuites(cipherSuites);
	setProtocols(protocols);
	}

	private static String[] clone(String[] s) {
	return (s == null) ? null : s.clone();
	}

	/**
	* Returns a copy of the array of ciphersuites or null if none
	* have been set.
	*
	* @return a copy of the array of ciphersuites or null if none
	* have been set.
	*/
	public String[] getCipherSuites() {
	return clone(cipherSuites);
	}

	/**
	* Sets the array of ciphersuites.
	*
	* @param cipherSuites the array of ciphersuites (or null)
	*/
	public void setCipherSuites(String[] cipherSuites) {
	this.cipherSuites = clone(cipherSuites);
	}

	/**
	* Returns a copy of the array of protocols or null if none
	* have been set.
	*
	* @return a copy of the array of protocols or null if none
	* have been set.
	*/
	public String[] getProtocols() {
	return clone(protocols);
	}

	/**
	* Sets the array of protocols.
	*
	* @param protocols the array of protocols (or null)
	*/
	public void setProtocols(String[] protocols) {
	this.protocols = clone(protocols);
	}

	/**
	* Returns whether client authentication should be requested.
	*
	* @return whether client authentication should be requested.
	*/
	public boolean getWantClientAuth() {
	return wantClientAuth;
	}

	/**
	* Sets whether client authentication should be requested. Calling
	* this method clears the <code>needClientAuth</code> flag.
	*
	* @param wantClientAuth whether client authentication should be requested
	*/
	public void setWantClientAuth(boolean wantClientAuth) {
	this.wantClientAuth = wantClientAuth;
	this.needClientAuth = false;
	}

	/**
	* Returns whether client authentication should be required.
	*
	* @return whether client authentication should be required.
	*/
	public boolean getNeedClientAuth() {
	return needClientAuth;
	}

	/**
	* Sets whether client authentication should be required. Calling
	* this method clears the <code>wantClientAuth</code> flag.
	*
	* @param needClientAuth whether client authentication should be required
	*/
	public void setNeedClientAuth(boolean needClientAuth) {
	this.wantClientAuth = false;
	this.needClientAuth = needClientAuth;
	}

	/**
	* Returns the cryptographic algorithm constraints.
	*
	* @return the cryptographic algorithm constraints, or null if the
	* constraints have not been set
	*
	* @see #setAlgorithmConstraints(AlgorithmConstraints)
	*
	* @since 1.7
	*/
	public AlgorithmConstraints getAlgorithmConstraints() {
	return algorithmConstraints;
	}

	/**
	* Sets the cryptographic algorithm constraints, which will be used
	* in addition to any configured by the runtime environment.
	* <p>
	* If the <code>constraints</code> parameter is non-null, every
	* cryptographic algorithm, key and algorithm parameters used in the
	* SSL/TLS handshake must be permitted by the constraints.
	*
	* @param constraints the algorithm constraints (or null)
	*
	* @since 1.7
	*/
	public void setAlgorithmConstraints(AlgorithmConstraints constraints) {
	// the constraints object is immutable
	this.algorithmConstraints = constraints;
	}

	/**
	* Gets the endpoint identification algorithm.
	*
	* @return the endpoint identification algorithm, or null if none
	* has been set.
	*
	* @see X509ExtendedTrustManager
	* @see #setEndpointIdentificationAlgorithm(String)
	*
	* @since 1.7
	*/
	public String getEndpointIdentificationAlgorithm() {
	return identificationAlgorithm;
	}

	/**
	* Sets the endpoint identification algorithm.
	* <p>
	* If the <code>algorithm</code> parameter is non-null or non-empty, the
	* endpoint identification/verification procedures must be handled during
	* SSL/TLS handshaking. This is to prevent man-in-the-middle attacks.
	*
	* @param algorithm The standard string name of the endpoint
	* identification algorithm (or null). See Appendix A in the <a href=
	* "{@docRoot}/../technotes/guides/security/crypto/CryptoSpec.html#AppA">
	* Java Cryptography Architecture API Specification & Reference </a>
	* for information about standard algorithm names.
	*
	* @see X509ExtendedTrustManager
	*
	* @since 1.7
	*/
	public void setEndpointIdentificationAlgorithm(String algorithm) {
	this.identificationAlgorithm = algorithm;
	}

	}