CkiSymmetricKey (Oracle® Fusion Middleware Java API Reference for Oracle Security Developer Tools)

java.lang.Object
- SymmetricKey
- - oracle.security.crypto.cryptoki.crypto.CkiSymmetricKey

All Implemented Interfaces:

java.lang.Cloneable
```
public class CkiSymmetricKey
extends SymmetricKey
implements java.lang.Cloneable
```
An encryption/decryption key on a PKCS #11 token used by a CkiSymmetricCipher.

Constructor Summary

Constructors
Constructor and Description
`CkiSymmetricKey()` Empty constructor.
`CkiSymmetricKey(byte[] keyBytes, AlgorithmIdentifier algID, boolean tokenPersistent)` Creates a new CkiSymmetricKey object with the value of the key and the cipher's algorithm identifier corresponding to the key.
`CkiSymmetricKey(byte[] keyBytes, CkiSession session, AlgorithmIdentifier algID, boolean tokenPersistent)` Creates a new CkiSymmetricKey object with the given session with the value of the key and the cipher's algorithm identifier corresponding to the key.
`CkiSymmetricKey(byte[] keyBytes, CkiSlot slot, AlgorithmIdentifier algID, boolean tokenPersistent)` Creates a new CkiSymmetricKey object on the given slot with the value of the key and the cipher's algorithm identifier corresponding to the key.
`CkiSymmetricKey(CkiSession session, byte[] keyID)` Creates a new CkiSymmetricKey object from an existant key on a token.
`CkiSymmetricKey(CkiSession session, CkiObject ckiObject)` Creates a new CkiSymmetricKey object.
`CkiSymmetricKey(CkiSession session, CkiObject ckiObject, AlgorithmIdentifier algID, byte[] keyID)`
`CkiSymmetricKey(CkiSlot slot, byte[] keyID)` Creates a new CkiSymmetricKey object from an existant key on a token.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a deep copy of this `SymmetricKey` instance.
`void`	`erase()` Makes this CkiSymmetricKey unusable.
`void`	`finalize()`
`AlgorithmIdentifier`	`getAlgID()` Returns the `AlgorithmIdentifier` for this key.
`java.lang.String`	`getAlgorithm()` Deprecated.
`byte[]`	`getBytes()` Gets the actual bytes of the key.
`CkiObject`	`getCkiObject()` Returns the CkiObject used by this CkiSymmetricKey.
`java.lang.String`	`getFormat()` Returns the format used in this key's encoding.
`byte[]`	`getKeyID()` Gets the keyID of this CkiSymmetricKey object.
`java.lang.String`	`getLabel()` Retrieves the label of this CkiSymmetricKey passed in parameter
`CkiSession`	`getSession()` Returns the CkiSession used by this CkiSymmetricKey.
`CkiSlot`	`getSlot()` Gets the cki slot corresponding to this CkiSymmetricKey object.
`int`	`keySize()` Returns the length of the key in bytes.
`void`	`removeWhenErase(boolean removeWhenErase)` Sets a flag that is used when the `erase()` method is called.
`void`	`setBytes(byte[] key)` Sets the actual bytes of the key.
`void`	`setKeyID(byte[] keyID)` Sets the keyID of this CkiSymmetricKey object.
`void`	`setLabel(java.lang.String label)` Sets the label of this CkiSymmetricKey passed in parameter
`void`	`setSlot(CkiSlot slot)` Sets the CkiSlot of this CkiSymmetricKey.
`java.lang.String`	`toString()` Returns a description of this CkiSymmetricKey.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CkiSymmetricKey
```
public CkiSymmetricKey()
```
    Empty constructor.
  - CkiSymmetricKey
```
public CkiSymmetricKey(byte[] keyBytes,
                       AlgorithmIdentifier algID,
                       boolean tokenPersistent)
                throws CryptokiException
```
    Creates a new CkiSymmetricKey object with the value of the key and the cipher's algorithm identifier corresponding to the key.
    
    Parameters:
    
    keyBytes - The value of the symmetric key.
    
    algID - The algorithm identifier representing the cipher that will be used with the key.
    
    tokenPersistent - If false the key will be destroyed when the session will logout.
    
    Throws:
    
    CryptokiException
  - CkiSymmetricKey
```
public CkiSymmetricKey(byte[] keyBytes,
                       CkiSlot slot,
                       AlgorithmIdentifier algID,
                       boolean tokenPersistent)
                throws CryptokiException
```
    Creates a new CkiSymmetricKey object on the given slot with the value of the key and the cipher's algorithm identifier corresponding to the key.
    
    Parameters:
    
    keyBytes - The value of the symmetric key.
    
    slot - The slot to create the key.
    
    algID - The algorithm identifier representing the cipher that will be used with the key.
    
    tokenPersistent - If false the key will be destroyed when the session will logout.
    
    Throws:
    
    CryptokiException
  - CkiSymmetricKey
```
public CkiSymmetricKey(byte[] keyBytes,
                       CkiSession session,
                       AlgorithmIdentifier algID,
                       boolean tokenPersistent)
                throws CryptokiException
```
    Creates a new CkiSymmetricKey object with the given session with the value of the key and the cipher's algorithm identifier corresponding to the key.
    
    Parameters:
    
    keyBytes - The value of the symmetric key.
    
    session - The session to use to create the key.
    
    algID - The algorithm identifier representing the cipher that will be used with the key.
    
    tokenPersistent - If false the key will be destroyed when the session will logout.
    
    Throws:
    
    CryptokiException
  - CkiSymmetricKey
```
public CkiSymmetricKey(CkiSlot slot,
                       byte[] keyID)
```
    Creates a new CkiSymmetricKey object from an existant key on a token.
    
    Parameters:
    
    slot - The ckislot where the key can be found.
    
    keyID - The keyID of the key.
  - CkiSymmetricKey
```
public CkiSymmetricKey(CkiSession session,
                       byte[] keyID)
```
    Creates a new CkiSymmetricKey object from an existant key on a token.
    
    Parameters:
    
    session - The CkiSession to use to find the key.
    
    keyID - The keyID of the key.
  - CkiSymmetricKey
```
public CkiSymmetricKey(CkiSession session,
                       CkiObject ckiObject)
                throws CryptokiException
```
    Creates a new CkiSymmetricKey object.
    
    Parameters:
    
    session - The CkiSession object.
    
    ckiObject - The CkiObject pointing to the object on the token within the session.
    
    Throws:
    
    CryptokiException
  - CkiSymmetricKey
```
public CkiSymmetricKey(CkiSession session,
                       CkiObject ckiObject,
                       AlgorithmIdentifier algID,
                       byte[] keyID)
                throws CryptokiException
```
    Throws:
    
    CryptokiException
- Method Detail
  - getKeyID
```
public byte[] getKeyID()
```
    Gets the keyID of this CkiSymmetricKey object.
    
    Returns:
    
    byte[] representing the keyID.
  - setKeyID
```
public void setKeyID(byte[] keyID)
              throws CryptokiException
```
    Sets the keyID of this CkiSymmetricKey object.
    
    Parameters:
    
    keyID - The new key ID.
    
    Throws:
    
    CryptokiException
  - setLabel
```
public void setLabel(java.lang.String label)
              throws CryptokiException
```
    Sets the label of this CkiSymmetricKey passed in parameter
    
    Parameters:
    
    label - The new label.
    
    Throws:
    
    CryptokiException
  - getLabel
```
public java.lang.String getLabel()
                          throws CryptokiException
```
    Retrieves the label of this CkiSymmetricKey passed in parameter
    
    Returns:
    
    The keyID in a byte[]
    
    Throws:
    
    CryptokiException
  - setSlot
```
public void setSlot(CkiSlot slot)
```
    Sets the CkiSlot of this CkiSymmetricKey.
  - getSlot
```
public CkiSlot getSlot()
```
    Gets the cki slot corresponding to this CkiSymmetricKey object.
    
    Returns:
    
    CkiSlot representing the slot where this key is stored.
  - getSession
```
public CkiSession getSession()
                      throws CryptokiException
```
    Returns the CkiSession used by this CkiSymmetricKey.
    
    Throws:
    
    CryptokiException
  - getCkiObject
```
public CkiObject getCkiObject()
                       throws CryptokiException
```
    Returns the CkiObject used by this CkiSymmetricKey.
    
    Throws:
    
    CryptokiException
  - getAlgorithm
```
public java.lang.String getAlgorithm()
```
    Deprecated.
    
    The algorithm for which this key is used.
    
    Returns:
    
    A String representing the algorithm.
  - keySize
```
public int keySize()
```
    Returns the length of the key in bytes.
  - setBytes
```
public void setBytes(byte[] key)
```
    Sets the actual bytes of the key.
  - getBytes
```
public byte[] getBytes()
```
    Gets the actual bytes of the key.
  - getFormat
```
public java.lang.String getFormat()
```
    Returns the format used in this key's encoding.
    
    Returns:
    
    "RAW"
  - getAlgID
```
public AlgorithmIdentifier getAlgID()
```
    Returns the AlgorithmIdentifier for this key.
  - toString
```
public java.lang.String toString()
```
    Returns a description of this CkiSymmetricKey.
  - erase
```
public void erase()
```
    Makes this CkiSymmetricKey unusable.
  - finalize
```
public void finalize()
```
  - removeWhenErase
```
public void removeWhenErase(boolean removeWhenErase)
```
    Sets a flag that is used when the erase() method is called.
    
    Parameters:
    
    removeWhenErase - If the flag is true, this CkiPrivateKey will be removed from the token when the erase() method will be called.
  - clone
```
public java.lang.Object clone()
```
    Creates a deep copy of this SymmetricKey instance.

Class CkiSymmetricKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

CkiSymmetricKey

Method Detail

getKeyID

setKeyID

setLabel

getLabel

setSlot

getSlot

getSession

getCkiObject

getAlgorithm

keySize

setBytes

getBytes

getFormat

getAlgID

toString

erase

finalize

removeWhenErase

clone