Merge "Javadoc cleanup of IpSecManager API." (d09d106e) · Commits · e / os / android_frameworks_base

api/current.txt

+0 −1

Original line number	Original line	Diff line number	Diff line
	@@ -25529,7 +25529,6 @@ package android.net {
	method public void removeTransportModeTransform(java.io.FileDescriptor, android.net.IpSecTransform) throws java.io.IOException;		method public void removeTransportModeTransform(java.io.FileDescriptor, android.net.IpSecTransform) throws java.io.IOException;
	method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress) throws android.net.IpSecManager.ResourceUnavailableException;		method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress) throws android.net.IpSecManager.ResourceUnavailableException;
	method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress, int) throws android.net.IpSecManager.ResourceUnavailableException, android.net.IpSecManager.SpiUnavailableException;		method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress, int) throws android.net.IpSecManager.ResourceUnavailableException, android.net.IpSecManager.SpiUnavailableException;
	field public static final int INVALID_SECURITY_PARAMETER_INDEX = 0; // 0x0
	}		}

	public static final class IpSecManager.ResourceUnavailableException extends android.util.AndroidException {		public static final class IpSecManager.ResourceUnavailableException extends android.util.AndroidException {

api/system-current.txt

+0 −1

Original line number	Original line	Diff line number	Diff line
	@@ -27725,7 +27725,6 @@ package android.net {
	method public void removeTransportModeTransform(java.io.FileDescriptor, android.net.IpSecTransform) throws java.io.IOException;		method public void removeTransportModeTransform(java.io.FileDescriptor, android.net.IpSecTransform) throws java.io.IOException;
	method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress) throws android.net.IpSecManager.ResourceUnavailableException;		method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress) throws android.net.IpSecManager.ResourceUnavailableException;
	method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress, int) throws android.net.IpSecManager.ResourceUnavailableException, android.net.IpSecManager.SpiUnavailableException;		method public android.net.IpSecManager.SecurityParameterIndex reserveSecurityParameterIndex(int, java.net.InetAddress, int) throws android.net.IpSecManager.ResourceUnavailableException, android.net.IpSecManager.SpiUnavailableException;
	field public static final int INVALID_SECURITY_PARAMETER_INDEX = 0; // 0x0
	}		}

	public static final class IpSecManager.ResourceUnavailableException extends android.util.AndroidException {		public static final class IpSecManager.ResourceUnavailableException extends android.util.AndroidException {

core/java/android/net/IpSecAlgorithm.java

+32 −30

Original line number	Original line	Diff line number	Diff line
	@@ -15,6 +15,7 @@
	*/		*/
	package android.net;		package android.net;

			import android.annotation.NonNull;
	import android.annotation.StringDef;		import android.annotation.StringDef;
	import android.os.Build;		import android.os.Build;
	import android.os.Parcel;		import android.os.Parcel;
	@@ -27,8 +28,10 @@ import java.lang.annotation.RetentionPolicy;
	import java.util.Arrays;		import java.util.Arrays;

	/**		/**
	* IpSecAlgorithm specifies a single algorithm that can be applied to an IpSec Transform. Refer to		* This class represents a single algorithm that can be used by an {@link IpSecTransform}.
	* RFC 4301.		*
			* @see <a href="https://tools.ietf.org/html/rfc4301">RFC 4301, Security Architecture for the
			* Internet Protocol</a>
	*/		*/
	public final class IpSecAlgorithm implements Parcelable {		public final class IpSecAlgorithm implements Parcelable {
	/**		/**
	@@ -39,16 +42,16 @@ public final class IpSecAlgorithm implements Parcelable {
	public static final String CRYPT_AES_CBC = "cbc(aes)";		public static final String CRYPT_AES_CBC = "cbc(aes)";

	/**		/**
	* MD5 HMAC Authentication/Integrity Algorithm. This algorithm is not recommended for use in new		* MD5 HMAC Authentication/Integrity Algorithm. <b>This algorithm is not recommended for use in
	* applications and is provided for legacy compatibility with 3gpp infrastructure.		* new applications and is provided for legacy compatibility with 3gpp infrastructure.</b>
	*		*
	* <p>Valid truncation lengths are multiples of 8 bits from 96 to (default) 128.		* <p>Valid truncation lengths are multiples of 8 bits from 96 to (default) 128.
	*/		*/
	public static final String AUTH_HMAC_MD5 = "hmac(md5)";		public static final String AUTH_HMAC_MD5 = "hmac(md5)";

	/**		/**
	* SHA1 HMAC Authentication/Integrity Algorithm. This algorithm is not recommended for use in		* SHA1 HMAC Authentication/Integrity Algorithm. <b>This algorithm is not recommended for use in
	* new applications and is provided for legacy compatibility with 3gpp infrastructure.		* new applications and is provided for legacy compatibility with 3gpp infrastructure.</b>
	*		*
	* <p>Valid truncation lengths are multiples of 8 bits from 96 to (default) 160.		* <p>Valid truncation lengths are multiples of 8 bits from 96 to (default) 160.
	*/		*/
	@@ -69,7 +72,7 @@ public final class IpSecAlgorithm implements Parcelable {
	public static final String AUTH_HMAC_SHA384 = "hmac(sha384)";		public static final String AUTH_HMAC_SHA384 = "hmac(sha384)";

	/**		/**
	* SHA512 HMAC Authentication/Integrity Algorithm		* SHA512 HMAC Authentication/Integrity Algorithm.
	*		*
	* <p>Valid truncation lengths are multiples of 8 bits from 256 to (default) 512.		* <p>Valid truncation lengths are multiples of 8 bits from 256 to (default) 512.
	*/		*/
	@@ -80,9 +83,9 @@ public final class IpSecAlgorithm implements Parcelable {
	*		*
	* <p>Valid lengths for keying material are {160, 224, 288}.		* <p>Valid lengths for keying material are {160, 224, 288}.
	*		*
	* <p>As per RFC4106 (Section 8.1), keying material consists of a 128, 192, or 256 bit AES key		* <p>As per <a href="https://tools.ietf.org/html/rfc4106#section-8.1">RFC4106 (Section
	* followed by a 32-bit salt. RFC compliance requires that the salt must be unique per		* 8.1)</a>, keying material consists of a 128, 192, or 256 bit AES key followed by a 32-bit
	* invocation with the same key.		* salt. RFC compliance requires that the salt must be unique per invocation with the same key.
	*		*
	* <p>Valid ICV (truncation) lengths are {64, 96, 128}.		* <p>Valid ICV (truncation) lengths are {64, 96, 128}.
	*/		*/
	@@ -105,48 +108,47 @@ public final class IpSecAlgorithm implements Parcelable {
	private final int mTruncLenBits;		private final int mTruncLenBits;

	/**		/**
	* Specify a IpSecAlgorithm of one of the supported types including the truncation length of the		* Creates an IpSecAlgorithm of one of the supported types. Supported algorithm names are
	* algorithm		* defined as constants in this class.
	*		*
	* @param algorithm type for IpSec.		* @param algorithm name of the algorithm.
	* @param key non-null Key padded to a multiple of 8 bits.		* @param key key padded to a multiple of 8 bits.
	*/		*/
	public IpSecAlgorithm(String algorithm, byte[] key) {		public IpSecAlgorithm(@AlgorithmName String algorithm, @NonNull byte[] key) {
	this(algorithm, key, key.length * 8);		this(algorithm, key, key.length * 8);
	}		}

	/**		/**
	* Specify a IpSecAlgorithm of one of the supported types including the truncation length of the		* Creates an IpSecAlgorithm of one of the supported types. Supported algorithm names are
	* algorithm		* defined as constants in this class.
			*
			* <p>This constructor only supports algorithms that use a truncation length. i.e.
			* Authentication and Authenticated Encryption algorithms.
	*		*
	* @param algoName precise name of the algorithm to be used.		* @param algorithm name of the algorithm.
	* @param key non-null Key padded to a multiple of 8 bits.		* @param key key padded to a multiple of 8 bits.
	* @param truncLenBits the number of bits of output hash to use; only meaningful for		* @param truncLenBits number of bits of output hash to use.
	* Authentication or Authenticated Encryption (equivalent to ICV length).
	*/		*/
	public IpSecAlgorithm(@AlgorithmName String algoName, byte[] key, int truncLenBits) {		public IpSecAlgorithm(@AlgorithmName String algorithm, @NonNull byte[] key, int truncLenBits) {
	if (!isTruncationLengthValid(algoName, truncLenBits)) {		if (!isTruncationLengthValid(algorithm, truncLenBits)) {
	throw new IllegalArgumentException("Unknown algorithm or invalid length");		throw new IllegalArgumentException("Unknown algorithm or invalid length");
	}		}
	mName = algoName;		mName = algorithm;
	mKey = key.clone();		mKey = key.clone();
	mTruncLenBits = Math.min(truncLenBits, key.length * 8);		mTruncLenBits = Math.min(truncLenBits, key.length * 8);
	}		}

	/** Retrieve the algorithm name */		/** Get the algorithm name */
	public String getName() {		public String getName() {
	return mName;		return mName;
	}		}

	/** Retrieve the key for this algorithm */		/** Get the key for this algorithm */
	public byte[] getKey() {		public byte[] getKey() {
	return mKey.clone();		return mKey.clone();
	}		}

	/**		/** Get the truncation length of this algorithm, in bits */
	* Retrieve the truncation length, in bits, for the key in this algo. By default this will be
	* the length in bits of the key.
	*/
	public int getTruncationLengthBits() {		public int getTruncationLengthBits() {
	return mTruncLenBits;		return mTruncLenBits;
	}		}

core/java/android/net/IpSecConfig.java

+9 −1

Original line number	Original line	Diff line number	Diff line
	@@ -20,7 +20,12 @@ import android.os.Parcelable;

	import com.android.internal.annotations.VisibleForTesting;		import com.android.internal.annotations.VisibleForTesting;

	/** @hide */		/**
			* This class encapsulates all the configuration parameters needed to create IPsec transforms and
			* policies.
			*
			* @hide
			*/
	public final class IpSecConfig implements Parcelable {		public final class IpSecConfig implements Parcelable {
	private static final String TAG = "IpSecConfig";		private static final String TAG = "IpSecConfig";

	@@ -38,6 +43,9 @@ public final class IpSecConfig implements Parcelable {
	// for outbound packets. It may also be used to select packets.		// for outbound packets. It may also be used to select packets.
	private Network mNetwork;		private Network mNetwork;

			/**
			* This class captures the parameters that specifically apply to inbound or outbound traffic.
			*/
	public static class Flow {		public static class Flow {
	// Minimum requirements for identifying a transform		// Minimum requirements for identifying a transform
	// SPI identifying the IPsec flow in packet processing		// SPI identifying the IPsec flow in packet processing

core/java/android/net/IpSecManager.java

+171 −101

File changed.

Preview size limit exceeded, changes collapsed.