Added in API level 1

Cipher

open class Cipher

kotlin.Any
↳	javax.crypto.Cipher

Known Direct Subclasses NullCipher NullCipher The NullCipher class is a class that provides an "identity cipher" -- one that does not transform the plain text.

This class provides the functionality of a cryptographic cipher for encryption and decryption. It forms the core of the Java Cryptographic Extension (JCE) framework.

In order to create a Cipher object, the application calls the Cipher's getInstance method, and passes the name of the requested transformation to it. Optionally, the name of a provider may be specified.

A transformation is a string that describes the operation (or set of operations) to be performed on the given input, to produce some output. A transformation always includes the name of a cryptographic algorithm (e.g., DES), and may be followed by a feedback mode and padding scheme.

A transformation is of the form:

• "algorithm/mode/padding" or
• "algorithm"

(in the latter case, provider-specific default values for the mode and padding scheme are used). For example, the following is a valid transformation:

<code>Cipher c = Cipher.getInstance("DES/CBC/PKCS5Padding");
  </code>

Using modes such as CFB and OFB, block ciphers can encrypt data in units smaller than the cipher's actual block size. When requesting such a mode, you may optionally specify the number of bits to be processed at a time by appending this number to the mode name as shown in the "DES/CFB8/NoPadding" and "DES/OFB32/PKCS5Padding" transformations. If no such number is specified, a provider-specific default is used. (For example, the SunJCE provider uses a default of 64 bits for DES.) Thus, block ciphers can be turned into byte-oriented stream ciphers by using an 8 bit mode such as CFB8 or OFB8.

Modes such as Authenticated Encryption with Associated Data (AEAD) provide authenticity assurances for both confidential data and Additional Associated Data (AAD) that is not encrypted. (Please see RFC 5116 for more information on AEAD and AEAD algorithms such as GCM/CCM.) Both confidential and AAD data can be used when calculating the authentication tag (similar to a Mac). This tag is appended to the ciphertext during encryption, and is verified on decryption.

AEAD modes such as GCM/CCM perform all AAD authenticity calculations before starting the ciphertext authenticity calculations. To avoid implementations having to internally buffer ciphertext, all AAD data must be supplied to GCM/CCM implementations (via the updateAAD methods) before the ciphertext is processed (via the update and doFinal methods).

Note that GCM mode has a uniqueness requirement on IVs used in encryption with a given key. When IVs are repeated for GCM encryption, such usages are subject to forgery attacks. Thus, after each encryption operation using GCM mode, callers should re-initialize the cipher objects with GCM parameters which has a different IV value.

GCMParameterSpec s = ...;
      cipher.init(..., s);
 
      // If the GCM parameters were generated by the provider, it can
      // be retrieved by:
      // cipher.getParameters().getParameterSpec(GCMParameterSpec.class);
 
      cipher.updateAAD(...);  // AAD
      cipher.update(...);     // Multi-part update
      cipher.doFinal(...);    // conclusion of operation
 
      // Use a different IV value for every encryption
      byte[] newIv = ...;
      s = new GCMParameterSpec(s.getTLen(), newIv);
      cipher.init(..., s);
      ...
 
  

Android provides the following Cipher transformations:

Algorithm	Modes	Paddings	Supported API Levels	Notes
AES	CBC CFB CTR CTS ECB OFB	ISO10126Padding NoPadding PKCS5Padding	1+
	GCM	NoPadding	10+
	GCM-SIV	NoPadding	30+
AES_128	CBC ECB	NoPadding PKCS5Padding	26+
	GCM	NoPadding	26+
	GCM-SIV	NoPadding	30+
AES_256	CBC ECB	NoPadding PKCS5Padding	26+
	GCM	NoPadding	26+
	GCM-SIV	NoPadding	30+
ARC4	ECB	NoPadding	10+
	NONE	NoPadding	28+
BLOWFISH	CBC CFB CTR CTS ECB OFB	ISO10126Padding NoPadding PKCS5Padding	10+
ChaCha20	NONE Poly1305	NoPadding	28+	ChaCha with 20 rounds, 96-bit nonce, and 32-bit counter as described in RFC 7539.
DES	CBC CFB CTR CTS ECB OFB	ISO10126Padding NoPadding PKCS5Padding	1+
DESede	CBC CFB CTR CTS ECB OFB	ISO10126Padding NoPadding PKCS5Padding	1+
RSA	ECB NONE	NoPadding OAEPPadding PKCS1Padding	1+
		OAEPwithSHA-1andMGF1Padding OAEPwithSHA-256andMGF1Padding	10+
		OAEPwithSHA-224andMGF1Padding OAEPwithSHA-384andMGF1Padding OAEPwithSHA-512andMGF1Padding	23+

These transformations are described in the Cipher section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Summary

Constants
static Int	DECRYPT_MODE Constant used to initialize cipher to decryption mode.
static Int	ENCRYPT_MODE Constant used to initialize cipher to encryption mode.
static Int	PRIVATE_KEY Constant used to indicate the to-be-unwrapped key is a "private key".
static Int	PUBLIC_KEY Constant used to indicate the to-be-unwrapped key is a "public key".
static Int	SECRET_KEY Constant used to indicate the to-be-unwrapped key is a "secret key".
static Int	UNWRAP_MODE Constant used to initialize cipher to key-unwrapping mode.
static Int	WRAP_MODE Constant used to initialize cipher to key-wrapping mode.

Protected constructors
Cipher(cipherSpi: CipherSpi!, provider: Provider!, transformation: String!) Creates a Cipher object.

Public methods
ByteArray!	doFinal() Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.
Int	doFinal(output: ByteArray!, outputOffset: Int) Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.
ByteArray!	doFinal(input: ByteArray!) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
ByteArray!	doFinal(input: ByteArray!, inputOffset: Int, inputLen: Int) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
Int	doFinal(input: ByteArray!, inputOffset: Int, inputLen: Int, output: ByteArray!) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
Int	doFinal(input: ByteArray!, inputOffset: Int, inputLen: Int, output: ByteArray!, outputOffset: Int) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
Int	doFinal(input: ByteBuffer!, output: ByteBuffer!) Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
String!	getAlgorithm() Returns the algorithm name of this Cipher object.
Int	getBlockSize() Returns the block size (in bytes).
ExemptionMechanism!	getExemptionMechanism() Returns the exemption mechanism object used with this cipher.
ByteArray!	getIV() Returns the initialization vector (IV) in a new buffer.
static Cipher!	getInstance(transformation: String!) Returns a Cipher object that implements the specified transformation.
static Cipher!	getInstance(transformation: String!, provider: String!) Returns a Cipher object that implements the specified transformation.
static Cipher!	getInstance(transformation: String!, provider: Provider!) Returns a Cipher object that implements the specified transformation.
static Int	getMaxAllowedKeyLength(transformation: String!) Returns the maximum key length for the specified transformation according to the installed JCE jurisdiction policy files.
static AlgorithmParameterSpec!	getMaxAllowedParameterSpec(transformation: String!) Returns an AlgorithmParameterSpec object which contains the maximum cipher parameter value according to the jurisdiction policy file.
Int	getOutputSize(inputLen: Int) Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).
AlgorithmParameters!	getParameters() Returns the parameters used with this cipher.
Provider!	getProvider() Returns the provider of this Cipher object.
Unit	init(opmode: Int, key: Key!) Initializes this cipher with a key.
Unit	init(opmode: Int, key: Key!, random: SecureRandom!) Initializes this cipher with a key and a source of randomness.
Unit	init(opmode: Int, key: Key!, params: AlgorithmParameterSpec!) Initializes this cipher with a key and a set of algorithm parameters.
Unit	init(opmode: Int, key: Key!, params: AlgorithmParameterSpec!, random: SecureRandom!) Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.
Unit	init(opmode: Int, key: Key!, params: AlgorithmParameters!) Initializes this cipher with a key and a set of algorithm parameters.
Unit	init(opmode: Int, key: Key!, params: AlgorithmParameters!, random: SecureRandom!) Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.
Unit	init(opmode: Int, certificate: Certificate!) Initializes this cipher with the public key from the given certificate.
Unit	init(opmode: Int, certificate: Certificate!, random: SecureRandom!) Initializes this cipher with the public key from the given certificate and a source of randomness.
Key!	unwrap(wrappedKey: ByteArray!, wrappedKeyAlgorithm: String!, wrappedKeyType: Int) Unwrap a previously wrapped key.
ByteArray!	update(input: ByteArray!) Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
ByteArray!	update(input: ByteArray!, inputOffset: Int, inputLen: Int) Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
Int	update(input: ByteArray!, inputOffset: Int, inputLen: Int, output: ByteArray!) Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
Int	update(input: ByteArray!, inputOffset: Int, inputLen: Int, output: ByteArray!, outputOffset: Int) Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
Int	update(input: ByteBuffer!, output: ByteBuffer!) Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
Unit	updateAAD(src: ByteArray!) Continues a multi-part update of the Additional Authentication Data (AAD).
Unit	updateAAD(src: ByteArray!, offset: Int, len: Int) Continues a multi-part update of the Additional Authentication Data (AAD), using a subset of the provided buffer.
Unit	updateAAD(src: ByteBuffer!) Continues a multi-part update of the Additional Authentication Data (AAD).
ByteArray!	wrap(key: Key!) Wrap a key.

Constants

DECRYPT_MODE

Added in API level 1

static val DECRYPT_MODE: Int

Constant used to initialize cipher to decryption mode.

Value: 2

ENCRYPT_MODE

Added in API level 1

static val ENCRYPT_MODE: Int

Constant used to initialize cipher to encryption mode.

Value: 1

PRIVATE_KEY

Added in API level 1

static val PRIVATE_KEY: Int

Constant used to indicate the to-be-unwrapped key is a "private key".

Value: 2

PUBLIC_KEY

Added in API level 1

static val PUBLIC_KEY: Int

Constant used to indicate the to-be-unwrapped key is a "public key".

Value: 1

SECRET_KEY

Added in API level 1

static val SECRET_KEY: Int

Constant used to indicate the to-be-unwrapped key is a "secret key".

Value: 3

UNWRAP_MODE

Added in API level 1

static val UNWRAP_MODE: Int

Constant used to initialize cipher to key-unwrapping mode.

Value: 4

WRAP_MODE

Added in API level 1

static val WRAP_MODE: Int

Constant used to initialize cipher to key-wrapping mode.

Value: 3

Protected constructors

Cipher

Added in API level 1

protected Cipher(
    cipherSpi: CipherSpi!, 
    provider: Provider!, 
    transformation: String!)

Creates a Cipher object.

Parameters
cipherSpi	CipherSpi!: the delegate
provider	Provider!: the provider
transformation	String!: the transformation

Public methods

doFinal

Added in API level 1

fun doFinal(): ByteArray!

Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.

Input data that may have been buffered during a previous update operation is processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Return
ByteArray!	the new buffer with the result

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(
    output: ByteArray!, 
    outputOffset: Int
): Int

Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.

Input data that may have been buffered during a previous update operation is processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Parameters
output	ByteArray!: the buffer for the result
outputOffset	Int: the offset in output where the result is stored

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.ShortBufferException	if the given output buffer is too small to hold the result
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(input: ByteArray!): ByteArray!

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

The bytes in the input buffer, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Parameters
input	ByteArray!: the input buffer

Return
ByteArray!	the new buffer with the result

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int
): ByteArray!

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length

Return
ByteArray!	the new buffer with the result

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int, 
    output: ByteArray!
): Int

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length
output	ByteArray!: the buffer for the result

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.ShortBufferException	if the given output buffer is too small to hold the result
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int, 
    output: ByteArray!, 
    outputOffset: Int
): Int

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length
output	ByteArray!: the buffer for the result
outputOffset	Int: the offset in output where the result is stored

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.ShortBufferException	if the given output buffer is too small to hold the result
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

doFinal

Added in API level 1

fun doFinal(
    input: ByteBuffer!, 
    output: ByteBuffer!
): Int

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

All input.remaining() bytes starting at input.position() are processed. If an AEAD mode such as GCM/CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed. The output buffer's position will have advanced by n, where n is the value returned by this method; the output buffer's limit will not have changed.

If output.remaining() bytes are insufficient to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteBuffer!: the input ByteBuffer
output	ByteBuffer!: the output ByteBuffer

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
java.lang.IllegalArgumentException	if input and output are the same object
java.nio.ReadOnlyBufferException	if the output buffer is read-only
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
javax.crypto.ShortBufferException	if there is insufficient space in the output buffer
javax.crypto.BadPaddingException	if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
javax.crypto.AEADBadTagException	if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

getAlgorithm

Added in API level 1

fun getAlgorithm(): String!

Returns the algorithm name of this Cipher object.

This is the same name that was specified in one of the getInstance calls that created this Cipher object..

Return
String!	the algorithm name of this Cipher object.

getBlockSize

Added in API level 1

fun getBlockSize(): Int

Returns the block size (in bytes).

Return
Int	the block size (in bytes), or 0 if the underlying algorithm is not a block cipher

getExemptionMechanism

Added in API level 1

fun getExemptionMechanism(): ExemptionMechanism!

Returns the exemption mechanism object used with this cipher.

Return
ExemptionMechanism!	the exemption mechanism object used with this cipher, or null if this cipher does not use any exemption mechanism.

getIV

Added in API level 1

fun getIV(): ByteArray!

Returns the initialization vector (IV) in a new buffer.

This is useful in the case where a random IV was created, or in the context of password-based encryption or decryption, where the IV is derived from a user-supplied password.

Return
ByteArray!	the initialization vector in a new buffer, or null if the underlying algorithm does not use an IV, or if the IV has not yet been set.

getInstance

Added in API level 1

static fun getInstance(transformation: String!): Cipher!

Returns a Cipher object that implements the specified transformation.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new Cipher object encapsulating the CipherSpi implementation from the first Provider that supports the specified algorithm is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
transformation	String!: the name of the transformation, e.g., DES/CBC/PKCS5Padding. See the Cipher section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard transformation names.

Return
Cipher!	a cipher that implements the requested transformation.

Exceptions
java.security.NoSuchAlgorithmException	if transformation is null, empty, in an invalid format, or if no Provider supports a CipherSpi implementation for the specified algorithm.
javax.crypto.NoSuchPaddingException	if transformation contains a padding scheme that is not available.

See Also

• java.security.Provider

getInstance

Added in API level 1

static fun getInstance(
    transformation: String!, 
    provider: String!
): Cipher!

Returns a Cipher object that implements the specified transformation.

A new Cipher object encapsulating the CipherSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
transformation	String!: the name of the transformation, e.g., DES/CBC/PKCS5Padding. See the Cipher section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard transformation names.
provider	String!: the name of the provider.

Return
Cipher!	a cipher that implements the requested transformation.

Exceptions
java.security.NoSuchAlgorithmException	if transformation is null, empty, in an invalid format, or if a CipherSpi implementation for the specified algorithm is not available from the specified provider.
java.security.NoSuchProviderException	if the specified provider is not registered in the security provider list.
javax.crypto.NoSuchPaddingException	if transformation contains a padding scheme that is not available.
java.lang.IllegalArgumentException	if the provider is null or empty.

See Also

• java.security.Provider

getInstance

Added in API level 1

static fun getInstance(
    transformation: String!, 
    provider: Provider!
): Cipher!

Returns a Cipher object that implements the specified transformation.

A new Cipher object encapsulating the CipherSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

Parameters
transformation	String!: the name of the transformation, e.g., DES/CBC/PKCS5Padding. See the Cipher section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard transformation names.
provider	Provider!: the provider.

Return
Cipher!	a cipher that implements the requested transformation.

Exceptions
java.security.NoSuchAlgorithmException	if transformation is null, empty, in an invalid format, or if a CipherSpi implementation for the specified algorithm is not available from the specified Provider object.
javax.crypto.NoSuchPaddingException	if transformation contains a padding scheme that is not available.
java.lang.IllegalArgumentException	if the provider is null.

See Also

• java.security.Provider

getMaxAllowedKeyLength

Added in API level 1

static fun getMaxAllowedKeyLength(transformation: String!): Int

Returns the maximum key length for the specified transformation according to the installed JCE jurisdiction policy files. If JCE unlimited strength jurisdiction policy files are installed, Integer.MAX_VALUE will be returned. For more information on default key size in JCE jurisdiction policy files, please see Appendix E in the Java Cryptography Architecture Reference Guide.

Parameters
transformation	String!: the cipher transformation.

Return
Int	the maximum key length in bits or Integer.MAX_VALUE.

Exceptions
java.lang.NullPointerException	if transformation is null.
java.security.NoSuchAlgorithmException	if transformation is not a valid transformation, i.e. in the form of "algorithm" or "algorithm/mode/padding".

getMaxAllowedParameterSpec

Added in API level 1

static fun getMaxAllowedParameterSpec(transformation: String!): AlgorithmParameterSpec!

Returns an AlgorithmParameterSpec object which contains the maximum cipher parameter value according to the jurisdiction policy file. If JCE unlimited strength jurisdiction policy files are installed or there is no maximum limit on the parameters for the specified transformation in the policy file, null will be returned.

Parameters
transformation	String!: the cipher transformation.

Return
AlgorithmParameterSpec!	an AlgorithmParameterSpec which holds the maximum value or null.

Exceptions
java.lang.NullPointerException	if transformation is null.
java.security.NoSuchAlgorithmException	if transformation is not a valid transformation, i.e. in the form of "algorithm" or "algorithm/mode/padding".

getOutputSize

Added in API level 1

fun getOutputSize(inputLen: Int): Int

Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).

This call takes into account any unprocessed (buffered) data from a previous update call, padding, and AEAD tagging.

The actual output length of the next update or doFinal call may be smaller than the length returned by this method.

Parameters
inputLen	Int: the input length (in bytes)

Return
Int	the required output buffer size (in bytes)

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not yet been initialized)

getParameters

Added in API level 1

fun getParameters(): AlgorithmParameters!

Returns the parameters used with this cipher.

The returned parameters may be the same that were used to initialize this cipher, or may contain a combination of default and random parameter values used by the underlying cipher implementation if this cipher requires algorithm parameters but was not initialized with any.

Return
AlgorithmParameters!	the parameters used with this cipher, or null if this cipher does not use any parameters.

getProvider

Added in API level 1

fun getProvider(): Provider!

Returns the provider of this Cipher object.

Return
Provider!	the provider of this Cipher object

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!
): Unit

Initializes this cipher with a key.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them using the java.security.SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the key

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key, or if the given key has a keysize that exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!, 
    random: SecureRandom!
): Unit

Initializes this cipher with a key and a source of randomness.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the encryption key
random	SecureRandom!: the source of randomness

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key, or if the given key has a keysize that exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!, 
    params: AlgorithmParameterSpec!
): Unit

Initializes this cipher with a key and a set of algorithm parameters.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them using the java.security.SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the encryption key
params	AlgorithmParameterSpec!: the algorithm parameters

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).
java.security.InvalidAlgorithmParameterException	if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!, 
    params: AlgorithmParameterSpec!, 
    random: SecureRandom!
): Unit

Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the encryption key
params	AlgorithmParameterSpec!: the algorithm parameters
random	SecureRandom!: the source of randomness

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).
java.security.InvalidAlgorithmParameterException	if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!, 
    params: AlgorithmParameters!
): Unit

Initializes this cipher with a key and a set of algorithm parameters.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them using the java.security.SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the encryption key
params	AlgorithmParameters!: the algorithm parameters

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).
java.security.InvalidAlgorithmParameterException	if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    key: Key!, 
    params: AlgorithmParameters!, 
    random: SecureRandom!
): Unit

Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
key	Key!: the encryption key
params	AlgorithmParameters!: the algorithm parameters
random	SecureRandom!: the source of randomness

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the given key is inappropriate for initializing this cipher, or its keysize exceeds the maximum allowable keysize (as determined from the configured jurisdiction policy files).
java.security.InvalidAlgorithmParameterException	if the given algorithm parameters are inappropriate for this cipher, or this cipher requires algorithm parameters and params is null, or the given algorithm parameters imply a cryptographic strength that would exceed the legal limits (as determined from the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    certificate: Certificate!
): Unit

Initializes this cipher with the public key from the given certificate.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If the certificate is of type X.509 and has a key usage extension field marked as critical, and the value of the key usage extension field implies that the public key in the certificate and its corresponding private key are not supposed to be used for the operation represented by the value of opmode, an InvalidKeyException is thrown.

If this cipher requires any algorithm parameters that cannot be derived from the public key in the given certificate, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them using the SecureRandom implementation of the highest-priority installed provider as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness will be used.)

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
certificate	Certificate!: the certificate

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the public key in the given certificate is inappropriate for initializing this cipher, or this cipher requires algorithm parameters that cannot be determined from the public key in the given certificate, or the keysize of the public key in the given certificate has a keysize that exceeds the maximum allowable keysize (as determined by the configured jurisdiction policy files).

init

Added in API level 1

fun init(
    opmode: Int, 
    certificate: Certificate!, 
    random: SecureRandom!
): Unit

Initializes this cipher with the public key from the given certificate and a source of randomness.

The cipher is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If the certificate is of type X.509 and has a key usage extension field marked as critical, and the value of the key usage extension field implies that the public key in the certificate and its corresponding private key are not supposed to be used for the operation represented by the value of opmode, an InvalidKeyException is thrown.

If this cipher requires any algorithm parameters that cannot be derived from the public key in the given certificate, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using getParameters or getIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.

Parameters
opmode	Int: the operation mode of this cipher (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
certificate	Certificate!: the certificate
random	SecureRandom!: the source of randomness

Exceptions
java.lang.UnsupportedOperationException	if (@code opmode} is WRAP_MODE or UNWRAP_MODE but the mode is not implemented by the underlying CipherSpi.
java.security.InvalidKeyException	if the public key in the given certificate is inappropriate for initializing this cipher, or this cipher requires algorithm parameters that cannot be determined from the public key in the given certificate, or the keysize of the public key in the given certificate has a keysize that exceeds the maximum allowable keysize (as determined by the configured jurisdiction policy files).

unwrap

Added in API level 1

fun unwrap(
    wrappedKey: ByteArray!, 
    wrappedKeyAlgorithm: String!, 
    wrappedKeyType: Int
): Key!

Unwrap a previously wrapped key.

Parameters
wrappedKey	ByteArray!: the key to be unwrapped.
wrappedKeyAlgorithm	String!: the algorithm associated with the wrapped key.
wrappedKeyType	Int: the type of the wrapped key. This must be one of SECRET_KEY, PRIVATE_KEY, or PUBLIC_KEY.

Return
Key!	the unwrapped key.

Exceptions
java.lang.UnsupportedOperationException	if the corresponding method in the CipherSpi is not supported.
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized).
java.security.NoSuchAlgorithmException	if no installed providers can create keys of type wrappedKeyType for the wrappedKeyAlgorithm.
java.security.InvalidKeyException	if wrappedKey does not represent a wrapped key of type wrappedKeyType for the wrappedKeyAlgorithm.

update

Added in API level 1

fun update(input: ByteArray!): ByteArray!

Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The bytes in the input buffer are processed, and the result is stored in a new buffer.

If input has a length of zero, this method returns null.

Parameters
input	ByteArray!: the input buffer

Return
ByteArray!	the new buffer with the result, or null if the underlying cipher is a block cipher and the input data is too short to result in a new block.

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)

update

Added in API level 1

fun update(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int
): ByteArray!

Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in a new buffer.

If inputLen is zero, this method returns null.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length

Return
ByteArray!	the new buffer with the result, or null if the underlying cipher is a block cipher and the input data is too short to result in a new block.

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)

update

Added in API level 1

fun update(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int, 
    output: ByteArray!
): Int

Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

If inputLen is zero, this method returns a length of zero.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length
output	ByteArray!: the buffer for the result

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.ShortBufferException	if the given output buffer is too small to hold the result

update

Added in API level 1

fun update(
    input: ByteArray!, 
    inputOffset: Int, 
    inputLen: Int, 
    output: ByteArray!, 
    outputOffset: Int
): Int

Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

If inputLen is zero, this method returns a length of zero.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteArray!: the input buffer
inputOffset	Int: the offset in input where the input starts
inputLen	Int: the input length
output	ByteArray!: the buffer for the result
outputOffset	Int: the offset in output where the result is stored

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
javax.crypto.ShortBufferException	if the given output buffer is too small to hold the result

update

Added in API level 1

fun update(
    input: ByteBuffer!, 
    output: ByteBuffer!
): Int

Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

All input.remaining() bytes starting at input.position() are processed. The result is stored in the output buffer. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed. The output buffer's position will have advanced by n, where n is the value returned by this method; the output buffer's limit will not have changed.

If output.remaining() bytes are insufficient to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be.

Note: this method should be copy-safe, which means the input and output buffers can reference the same block of memory and no unprocessed input data is overwritten when the result is copied into the output buffer.

Parameters
input	ByteBuffer!: the input ByteBuffer
output	ByteBuffer!: the output ByteByffer

Return
Int	the number of bytes stored in output

Exceptions
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized)
java.lang.IllegalArgumentException	if input and output are the same object
java.nio.ReadOnlyBufferException	if the output buffer is read-only
javax.crypto.ShortBufferException	if there is insufficient space in the output buffer

updateAAD

Added in API level 19

fun updateAAD(src: ByteArray!): Unit

Continues a multi-part update of the Additional Authentication Data (AAD).

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM/CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

Parameters
src	ByteArray!: the buffer containing the Additional Authentication Data

Exceptions
java.lang.IllegalArgumentException	if the src byte array is null
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM or CCM mode and one of the update methods has already been called for the active encryption/decryption operation
java.lang.UnsupportedOperationException	if the corresponding method in the CipherSpi has not been overridden by an implementation

updateAAD

Added in API level 19

fun updateAAD(
    src: ByteArray!, 
    offset: Int, 
    len: Int
): Unit

Continues a multi-part update of the Additional Authentication Data (AAD), using a subset of the provided buffer.

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM/CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

Parameters
src	ByteArray!: the buffer containing the AAD
offset	Int: the offset in src where the AAD input starts
len	Int: the number of AAD bytes

Exceptions
java.lang.IllegalArgumentException	if the src byte array is null, or the offset or length is less than 0, or the sum of the offset and len is greater than the length of the src byte array
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM or CCM mode and one of the update methods has already been called for the active encryption/decryption operation
java.lang.UnsupportedOperationException	if the corresponding method in the CipherSpi has not been overridden by an implementation

updateAAD

Added in API level 19

fun updateAAD(src: ByteBuffer!): Unit

Continues a multi-part update of the Additional Authentication Data (AAD).

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM/CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

All src.remaining() bytes starting at src.position() are processed. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed.

Parameters
src	ByteBuffer!: the buffer containing the AAD

Exceptions
java.lang.IllegalArgumentException	if the src ByteBuffer is null
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM or CCM mode and one of the update methods has already been called for the active encryption/decryption operation
java.lang.UnsupportedOperationException	if the corresponding method in the CipherSpi has not been overridden by an implementation

wrap

Added in API level 1

fun wrap(key: Key!): ByteArray!

Wrap a key.

Parameters
key	Key!: the key to be wrapped.

Return
ByteArray!	the wrapped key.

Exceptions
java.lang.UnsupportedOperationException	if the corresponding method in the CipherSpi is not supported.
java.lang.IllegalStateException	if this cipher is in a wrong state (e.g., has not been initialized).
javax.crypto.IllegalBlockSizeException	if this cipher is a block cipher, no padding has been requested, and the length of the encoding of the key to be wrapped is not a multiple of the block size.
java.security.InvalidKeyException	if it is impossible or unsafe to wrap the key with this cipher (e.g., a hardware protected key is being passed to a software-only cipher).