Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Fields](https://developer.android.com/reference/javax/crypto/SealedObject#lfields) \| [Ctors](https://developer.android.com/reference/javax/crypto/SealedObject#pubctors) \| [Protected Ctors](https://developer.android.com/reference/javax/crypto/SealedObject#proctors) \| [Methods](https://developer.android.com/reference/javax/crypto/SealedObject#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/javax/crypto/SealedObject#inhmethods)

# SealedObject

` public class SealedObject `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/io/Serializable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | javax.crypto.SealedObject |

<br />

*** ** * ** ***

This class enables a programmer to create an object and protect its confidentiality with a cryptographic algorithm.

Given any Serializable object, one can create a SealedObject that encapsulates the original object, in serialized format (i.e., a "deep copy"), and seals (encrypts) its serialized contents, using a cryptographic algorithm such as DES, to protect its confidentiality. The encrypted content can later be decrypted (with the corresponding algorithm using the correct decryption key) and de-serialized, yielding the original object.

Note that the Cipher object must be fully initialized with the correct algorithm, key, padding scheme, etc., before being applied to a SealedObject.

The original object that was sealed can be recovered in two different ways:

- by using the `https://developer.android.com/reference/javax/crypto/SealedObject#getObject(javax.crypto.Cipher)` method that takes a `Cipher` object.

  This method requires a fully initialized `Cipher` object, initialized with the exact same algorithm, key, padding scheme, etc., that were used to seal the object.

  This approach has the advantage that the party who unseals the sealed object does not require knowledge of the decryption key. For example, after one party has initialized the cipher object with the required decryption key, it could hand over the cipher object to another party who then unseals the sealed object.
- by using one of the `https://developer.android.com/reference/javax/crypto/SealedObject#getObject(java.security.Key)` methods that take a `Key` object.

  In this approach, the `getObject` method creates a cipher object for the appropriate decryption algorithm and initializes it with the given decryption key and the algorithm parameters (if any) that were stored in the sealed object.

  This approach has the advantage that the party who unseals the object does not need to keep track of the parameters (e.g., an IV) that were used to seal the object.

<br />

**See also:**

- `https://developer.android.com/reference/javax/crypto/Cipher`

## Summary

| ### Fields ||
|---|---|
| ` protected byte[]` | `https://developer.android.com/reference/javax/crypto/SealedObject#encodedParams` The cryptographic parameters used by the sealing Cipher, encoded in the default format. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/javax/crypto/SealedObject#SealedObject(java.io.Serializable,%20javax.crypto.Cipher)(https://developer.android.com/reference/java/io/Serializable object, https://developer.android.com/reference/javax/crypto/Cipher c) ` Constructs a SealedObject from any Serializable object. |

| ### Protected constructors ||
|---|---|
| ` https://developer.android.com/reference/javax/crypto/SealedObject#SealedObject(javax.crypto.SealedObject)(https://developer.android.com/reference/javax/crypto/SealedObject so) ` Constructs a SealedObject object from the passed-in SealedObject. |

| ### Public methods ||
|---|---|
| ` final https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/crypto/SealedObject#getAlgorithm()() ` Returns the algorithm that was used to seal this object. |
| ` final https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/javax/crypto/SealedObject#getObject(java.security.Key,%20java.lang.String)(https://developer.android.com/reference/java/security/Key key, https://developer.android.com/reference/java/lang/String provider) ` Retrieves the original (encapsulated) object. |
| ` final https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/javax/crypto/SealedObject#getObject(java.security.Key)(https://developer.android.com/reference/java/security/Key key) ` Retrieves the original (encapsulated) object. |
| ` final https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/javax/crypto/SealedObject#getObject(javax.crypto.Cipher)(https://developer.android.com/reference/javax/crypto/Cipher c) ` Retrieves the original (encapsulated) object. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Fields

### encodedParams

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected byte[] encodedParams
```

The cryptographic parameters used by the sealing Cipher, encoded in the default format.

That is, `cipher.getParameters().getEncoded()`.

<br />

## Public constructors

### SealedObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public SealedObject (Serializable object, 
                Cipher c)
```

Constructs a SealedObject from any Serializable object.

The given object is serialized, and its serialized contents are encrypted using the given Cipher, which must be fully initialized.

Any algorithm parameters that may be used in the encryption operation are stored inside of the new `SealedObject`.

<br />

| Parameters ||
|---|---|
| `object` | `Serializable`: the object to be sealed; can be null. <br /> |
| `c` | `Cipher`: the cipher used to seal the object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an error occurs during serialization |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the given cipher is null. |
| `https://developer.android.com/reference/javax/crypto/IllegalBlockSizeException` | if the given cipher is a block cipher, no padding has been requested, and the total input length (i.e., the length of the serialized object contents) is not a multiple of the cipher's block size |

## Protected constructors

### SealedObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected SealedObject (SealedObject so)
```

Constructs a SealedObject object from the passed-in SealedObject.

<br />

| Parameters ||
|---|---|
| `so` | `SealedObject`: a SealedObject object <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the given sealed object is null. |

## Public methods

### getAlgorithm

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final String getAlgorithm ()
```

Returns the algorithm that was used to seal this object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the algorithm that was used to seal this object. <br /> |

### getObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final Object getObject (Key key, 
                String provider)
```

Retrieves the original (encapsulated) object.

This method creates a cipher for the algorithm that had been used in the sealing operation, using an implementation of that algorithm from the given `provider`. The Cipher object is initialized for decryption, using the given `key` and the parameters (if any) that had been used in the sealing operation.

The encapsulated object is unsealed and de-serialized, before it is returned.

<br />

| Parameters ||
|---|---|
| `key` | `Key`: the key used to unseal the object. <br /> |
| `provider` | `String`: the name of the provider of the algorithm to unseal the object. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | the original object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an error occurs during de-serialiazation. |
| `https://developer.android.com/reference/java/lang/ClassNotFoundException` | if an error occurs during de-serialiazation. |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the given provider is null or empty. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `key` is null. |
| `https://developer.android.com/reference/java/security/InvalidKeyException` | if the given key cannot be used to unseal the object (e.g., it has the wrong algorithm). |
| `https://developer.android.com/reference/java/security/NoSuchAlgorithmException` | if the algorithm to unseal the object is not available. |
| `https://developer.android.com/reference/java/security/NoSuchProviderException` | if the given provider is not configured. |

### getObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final Object getObject (Key key)
```

Retrieves the original (encapsulated) object.

This method creates a cipher for the algorithm that had been used in the sealing operation. If the default provider package provides an implementation of that algorithm, an instance of Cipher containing that implementation is used. If the algorithm is not available in the default package, other packages are searched. The Cipher object is initialized for decryption, using the given `key` and the parameters (if any) that had been used in the sealing operation.

The encapsulated object is unsealed and de-serialized, before it is returned.

<br />

| Parameters ||
|---|---|
| `key` | `Key`: the key used to unseal the object. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | the original object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an error occurs during de-serialiazation. |
| `https://developer.android.com/reference/java/lang/ClassNotFoundException` | if an error occurs during de-serialiazation. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `key` is null. |
| `https://developer.android.com/reference/java/security/InvalidKeyException` | if the given key cannot be used to unseal the object (e.g., it has the wrong algorithm). |
| `https://developer.android.com/reference/java/security/NoSuchAlgorithmException` | if the algorithm to unseal the object is not available. |

### getObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final Object getObject (Cipher c)
```

Retrieves the original (encapsulated) object.

The encapsulated object is unsealed (using the given Cipher, assuming that the Cipher is already properly initialized) and de-serialized, before it is returned.

<br />

| Parameters ||
|---|---|
| `c` | `Cipher`: the cipher used to unseal the object <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | the original object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | if an error occurs during de-serialiazation |
| `https://developer.android.com/reference/java/lang/ClassNotFoundException` | if an error occurs during de-serialiazation |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the given cipher is null. |
| `https://developer.android.com/reference/javax/crypto/BadPaddingException` | if the given cipher has been initialized for decryption, and padding has been specified, but the input data does not have proper expected padding bytes |
| `https://developer.android.com/reference/javax/crypto/IllegalBlockSizeException` | if the given cipher is a block cipher, no padding has been requested, and the total input length is not a multiple of the cipher's block size |