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

java.lang.Object
- oracle.security.crypto.cryptoki.drivers.GDLib

All Implemented Interfaces:: CkiLibrary

public class GDLib
extends java.lang.Object
implements CkiLibrary

Interface between the Java library and the native library for Giesecke & Devrient smart card readers.

The default mapping used in CkiSlotManager.initializeCryptoki for the GD driver is:

        Diffie Hellman         NO
        DSA                    YES
        RSA                    YES
        Message Digest         NO
        Symmetric Cipher       NO
        RandomBitsSource       NO
        Cloning Mechanisms     YES
        Managed State          NO
        Signature Mechanisms   YES

When creating a new CkiParams object for GDLib, the new object will be initialized with these values.

Constructor Summary

Constructors
Constructor and Description

GDLib()

Constructors
Constructor and Description
`GDLib()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`closeAllSessions(long slotID)`
`boolean`	`closeSession(long session, boolean hasLoginRequired)`
`long`	`createObject(long[] attrType, java.lang.Object[] values, long session)`
`byte[]`	`decrypt(long mecha, long[] attrType, java.lang.Object[] values, byte[] data, long handleKey, long session)`
`byte[]`	`decryptFinal(long session)`
`void`	`decryptInit(long mecha, long[] attrType, java.lang.Object[] values, long handleKey, long session)`
`byte[]`	`decryptUpdate(byte[] data, long session)`
`long`	`deriveKey(long mecha, long[] attrTypeMecha, java.lang.Object[] valuesMecha, long[] attrTypeKey, java.lang.Object[] valuesKey, long handleKey, long session)`
`byte[]`	`digest(long mecha, long[] attrType, java.lang.Object[] values, byte[] data, long session)`
`java.lang.Object[]`	`digestAndDecryptSSL3(boolean useManagedState, byte[] operationState, byte[] secret, byte[] seqNumb, byte type, byte[] pad1, byte[] pad2, byte[] content, long macSize, long cipherMechanism, long[] attrType, java.lang.Object[] values, long digestMechanism, long blocksize, long keyHandle, long session)`
`java.lang.Object[]`	`digestAndEncryptSSL3(boolean useManagedState, byte[] operationState, byte[] secret, byte[] seqNumb, byte type, byte[] length, byte[] pad1, byte[] pad2, byte[] content, long macSize, long cipherMechanism, long[] attrType, java.lang.Object[] values, long digestMechanism, long blocksize, long keyHandle, long session)`
`byte[]`	`digestFinal(long session)`
`void`	`digestInit(long mecha, long[] attrType, java.lang.Object[] values, long session)`
`void`	`digestKey(long key, long session)`
`void`	`digestUpdate(byte[] data, long session)`
`byte[]`	`encrypt(long mecha, long[] attrType, java.lang.Object[] values, byte[] data, long handleKey, long session)`
`byte[]`	`encryptFinal(long session)`
`void`	`encryptInit(long mecha, long[] attrType, java.lang.Object[] values, long handleKey, long session)`
`byte[]`	`encryptUpdate(byte[] data, long session)`
`void`	`finalizeOp()`
`long`	`findObject(long[] attrType, java.lang.Object[] values, long session)`
`long`	`generateMasterSecret(byte[] clientRandom, byte[] serverRandom, long[] attrType, java.lang.Object[] values, long preMasterSecret, long session)`
`long`	`generateMS(byte[] clientRandom, byte[] serverRandom, long[] attrType, java.lang.Object[] values, long preMasterSecret, long session)`
`byte[]`	`generateRandom(long randomLen, long session)`
`java.lang.Object[]`	`generateSecrets(byte[] clientRandom, byte[] serverRandom, long macSize, long keySize, long ivSize, boolean isExportable, long[] attrType, java.lang.Object[] values, long masterSecret, long session)`
`byte[]`	`generateSSL3MAC(byte[] secret, byte[] seqNumb, byte type, byte[] length, byte[] pad1, byte[] pad2, byte[] content, long macSize, long mechanism, long session)`
`byte[]`	`generateSSL3MACHandshake(byte[] secret, byte[] pad1, byte[] pad2, byte[] label, byte[] content, long macSize, long mechanism, long session)`
`byte[]`	`generateSSL3MS(byte[] clientRandom, byte[] serverRandom, byte[] pms, long session)`
`java.lang.Object[]`	`generateSSL3Secrets(byte[] clientRandom, byte[] serverRandom, long macSize, long keySize, long expKeySize, long ivSize, boolean isExportable, byte[] ms, long keyType, boolean cipherInSoftware, long session)`
`long`	`genKey(long mecha, long[] attrTypeMecha, java.lang.Object[] valuesMecha, long[] attrTypeKey, java.lang.Object[] valuesKey, long session)`
`long[]`	`genKeyPair(long mecha, long[] attrTypeMecha, java.lang.Object[] valuesMecha, long[] attrTypePub, java.lang.Object[] valuesPub, long[] attrTypePriv, java.lang.Object[] valuesPriv, long session)`
`java.lang.Object[]`	`getAttributes(long handleObject, long[] attrType, long session)`
`CkiParams`	`getCkiParams()`
`java.lang.Object[]`	`getInfo()`
`java.lang.Object[]`	`getMechanism(long slotID)`
`byte[]`	`getOperationState(long session)`
`long`	`getSession(long slotID, boolean readOnly)`
`java.lang.Object[]`	`getSlotInfo(long slotID)`
`long[]`	`getSlotList()`
`java.lang.Object[]`	`getTokenInfo(long slotID)`
`void`	`initializeOp()`
`void`	`initPin(long session, java.lang.String pin)`
`void`	`initToken(long slotID, java.lang.String pinSO, java.lang.String tokenLabel)`
`boolean`	`isClosed(long session)`
`long[]`	`listObjects(long[] attrType, java.lang.Object[] values, long session)`
`void`	`login(long session, java.lang.String pin)`
`void`	`loginSO(long session, java.lang.String pinSO)`
`long`	`loginSOToken(long slotID, java.lang.String pinSO)`
`long`	`loginToken(long slotID, java.lang.String pin, boolean readOnly, boolean alreadyLoggedIn)`
`boolean`	`logoutToken(long session, boolean hasLoginRequired)`
`void`	`removeObject(long object, long session)`
`boolean`	`seed(byte[] dataSeed, long session)`
`void`	`setAttributes(long handleObject, long[] attrType, java.lang.Object[] values, long session)`
`void`	`setOperationState(byte[] value, long encKey, long sigKey, long session)`
`void`	`setPin(long session, java.lang.String oldPin, java.lang.String pin)`
`byte[]`	`sign(long mecha, long[] attrType, java.lang.Object[] values, byte[] data, long handleKey, long session)`
`long`	`unwrap(long mecha, long[] attrType, java.lang.Object[] values, long handleUnwrappingKey, byte[] wrappedKey, long[] attrTypeKey, java.lang.Object[] valuesKey, long session)`
`boolean`	`verify(long mecha, long[] attrType, java.lang.Object[] values, byte[] data, byte[] signature, long handleKey, long session)`
`byte[]`	`wrap(long mecha, long[] attrType, java.lang.Object[] values, long handleWrappingKey, long handleKey, long session)`

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

Constructor Detail
- GDLib
```
public GDLib()
```

Method Detail

getCkiParams
```
public CkiParams getCkiParams()
```
Specified by:

getCkiParams in interface CkiLibrary

initializeOp
```
public void initializeOp()
```
Specified by:

initializeOp in interface CkiLibrary

finalizeOp
```
public void finalizeOp()
```
Specified by:

finalizeOp in interface CkiLibrary

getSlotList
```
public long[] getSlotList()
```
Specified by:

getSlotList in interface CkiLibrary

getMechanism
```
public java.lang.Object[] getMechanism(long slotID)
```
Specified by:

getMechanism in interface CkiLibrary

getInfo
```
public java.lang.Object[] getInfo()
```
Specified by:

getInfo in interface CkiLibrary

getSlotInfo
```
public java.lang.Object[] getSlotInfo(long slotID)
```
Specified by:

getSlotInfo in interface CkiLibrary

getTokenInfo
```
public java.lang.Object[] getTokenInfo(long slotID)
```
Specified by:

getTokenInfo in interface CkiLibrary

getSession

public long getSession(long slotID,
                       boolean readOnly)

Specified by:: getSession in interface CkiLibrary

closeSession

public boolean closeSession(long session,
                            boolean hasLoginRequired)

Specified by:: closeSession in interface CkiLibrary

closeAllSessions
```
public boolean closeAllSessions(long slotID)
```
Specified by:

closeAllSessions in interface CkiLibrary

loginToken

public long loginToken(long slotID,
                       java.lang.String pin,
                       boolean readOnly,
                       boolean alreadyLoggedIn)

Specified by:: loginToken in interface CkiLibrary

login

public void login(long session,
                  java.lang.String pin)

Specified by:: login in interface CkiLibrary

logoutToken

public boolean logoutToken(long session,
                           boolean hasLoginRequired)

Specified by:: logoutToken in interface CkiLibrary

loginSO

public void loginSO(long session,
                    java.lang.String pinSO)

Specified by:: loginSO in interface CkiLibrary

loginSOToken

public long loginSOToken(long slotID,
                         java.lang.String pinSO)

Specified by:: loginSOToken in interface CkiLibrary

isClosed
```
public boolean isClosed(long session)
```
Specified by:

isClosed in interface CkiLibrary

initToken

public void initToken(long slotID,
                      java.lang.String pinSO,
                      java.lang.String tokenLabel)

Specified by:: initToken in interface CkiLibrary

initPin

public void initPin(long session,
                    java.lang.String pin)

Specified by:: initPin in interface CkiLibrary

setPin

public void setPin(long session,
                   java.lang.String oldPin,
                   java.lang.String pin)

Specified by:: setPin in interface CkiLibrary

getOperationState
```
public byte[] getOperationState(long session)
```
Specified by:

getOperationState in interface CkiLibrary

setOperationState

public void setOperationState(byte[] value,
                              long encKey,
                              long sigKey,
                              long session)

Specified by:: setOperationState in interface CkiLibrary

createObject

public long createObject(long[] attrType,
                         java.lang.Object[] values,
                         long session)

Specified by:: createObject in interface CkiLibrary

removeObject

public void removeObject(long object,
                         long session)

Specified by:: removeObject in interface CkiLibrary

listObjects

public long[] listObjects(long[] attrType,
                          java.lang.Object[] values,
                          long session)

Specified by:: listObjects in interface CkiLibrary

getAttributes

public java.lang.Object[] getAttributes(long handleObject,
                                        long[] attrType,
                                        long session)

Specified by:: getAttributes in interface CkiLibrary

setAttributes

public void setAttributes(long handleObject,
                          long[] attrType,
                          java.lang.Object[] values,
                          long session)

Specified by:: setAttributes in interface CkiLibrary

findObject

public long findObject(long[] attrType,
                       java.lang.Object[] values,
                       long session)

Specified by:: findObject in interface CkiLibrary

genKeyPair

public long[] genKeyPair(long mecha,
                         long[] attrTypeMecha,
                         java.lang.Object[] valuesMecha,
                         long[] attrTypePub,
                         java.lang.Object[] valuesPub,
                         long[] attrTypePriv,
                         java.lang.Object[] valuesPriv,
                         long session)

Specified by:: genKeyPair in interface CkiLibrary

genKey

public long genKey(long mecha,
                   long[] attrTypeMecha,
                   java.lang.Object[] valuesMecha,
                   long[] attrTypeKey,
                   java.lang.Object[] valuesKey,
                   long session)

Specified by:: genKey in interface CkiLibrary

deriveKey

public long deriveKey(long mecha,
                      long[] attrTypeMecha,
                      java.lang.Object[] valuesMecha,
                      long[] attrTypeKey,
                      java.lang.Object[] valuesKey,
                      long handleKey,
                      long session)

Specified by:: deriveKey in interface CkiLibrary

digest

public byte[] digest(long mecha,
                     long[] attrType,
                     java.lang.Object[] values,
                     byte[] data,
                     long session)

Specified by:: digest in interface CkiLibrary

digestInit

public void digestInit(long mecha,
                       long[] attrType,
                       java.lang.Object[] values,
                       long session)

Specified by:: digestInit in interface CkiLibrary

digestUpdate

public void digestUpdate(byte[] data,
                         long session)

Specified by:: digestUpdate in interface CkiLibrary

digestKey

public void digestKey(long key,
                      long session)

Specified by:: digestKey in interface CkiLibrary

digestFinal
```
public byte[] digestFinal(long session)
```
Specified by:

digestFinal in interface CkiLibrary

sign

public byte[] sign(long mecha,
                   long[] attrType,
                   java.lang.Object[] values,
                   byte[] data,
                   long handleKey,
                   long session)

Specified by:: sign in interface CkiLibrary

verify

public boolean verify(long mecha,
                      long[] attrType,
                      java.lang.Object[] values,
                      byte[] data,
                      byte[] signature,
                      long handleKey,
                      long session)

Specified by:: verify in interface CkiLibrary

encrypt

public byte[] encrypt(long mecha,
                      long[] attrType,
                      java.lang.Object[] values,
                      byte[] data,
                      long handleKey,
                      long session)

Specified by:: encrypt in interface CkiLibrary

encryptInit

public void encryptInit(long mecha,
                        long[] attrType,
                        java.lang.Object[] values,
                        long handleKey,
                        long session)

Specified by:: encryptInit in interface CkiLibrary

encryptUpdate

public byte[] encryptUpdate(byte[] data,
                            long session)

Specified by:: encryptUpdate in interface CkiLibrary

encryptFinal
```
public byte[] encryptFinal(long session)
```
Specified by:

encryptFinal in interface CkiLibrary

decrypt

public byte[] decrypt(long mecha,
                      long[] attrType,
                      java.lang.Object[] values,
                      byte[] data,
                      long handleKey,
                      long session)

Specified by:: decrypt in interface CkiLibrary

decryptInit

public void decryptInit(long mecha,
                        long[] attrType,
                        java.lang.Object[] values,
                        long handleKey,
                        long session)

Specified by:: decryptInit in interface CkiLibrary

decryptUpdate

public byte[] decryptUpdate(byte[] data,
                            long session)

Specified by:: decryptUpdate in interface CkiLibrary

decryptFinal
```
public byte[] decryptFinal(long session)
```
Specified by:

decryptFinal in interface CkiLibrary

wrap

public byte[] wrap(long mecha,
                   long[] attrType,
                   java.lang.Object[] values,
                   long handleWrappingKey,
                   long handleKey,
                   long session)

Specified by:: wrap in interface CkiLibrary

unwrap

public long unwrap(long mecha,
                   long[] attrType,
                   java.lang.Object[] values,
                   long handleUnwrappingKey,
                   byte[] wrappedKey,
                   long[] attrTypeKey,
                   java.lang.Object[] valuesKey,
                   long session)

Specified by:: unwrap in interface CkiLibrary

seed

public boolean seed(byte[] dataSeed,
                    long session)

Specified by:: seed in interface CkiLibrary

generateRandom

public byte[] generateRandom(long randomLen,
                             long session)

Specified by:: generateRandom in interface CkiLibrary

generateMasterSecret

public long generateMasterSecret(byte[] clientRandom,
                                 byte[] serverRandom,
                                 long[] attrType,
                                 java.lang.Object[] values,
                                 long preMasterSecret,
                                 long session)

Specified by:: generateMasterSecret in interface CkiLibrary

generateMS

public long generateMS(byte[] clientRandom,
                       byte[] serverRandom,
                       long[] attrType,
                       java.lang.Object[] values,
                       long preMasterSecret,
                       long session)

Specified by:: generateMS in interface CkiLibrary

generateSecrets

public java.lang.Object[] generateSecrets(byte[] clientRandom,
                                          byte[] serverRandom,
                                          long macSize,
                                          long keySize,
                                          long ivSize,
                                          boolean isExportable,
                                          long[] attrType,
                                          java.lang.Object[] values,
                                          long masterSecret,
                                          long session)

Specified by:: generateSecrets in interface CkiLibrary

generateSSL3MS

public byte[] generateSSL3MS(byte[] clientRandom,
                             byte[] serverRandom,
                             byte[] pms,
                             long session)

Specified by:: generateSSL3MS in interface CkiLibrary

generateSSL3Secrets

public java.lang.Object[] generateSSL3Secrets(byte[] clientRandom,
                                              byte[] serverRandom,
                                              long macSize,
                                              long keySize,
                                              long expKeySize,
                                              long ivSize,
                                              boolean isExportable,
                                              byte[] ms,
                                              long keyType,
                                              boolean cipherInSoftware,
                                              long session)

Specified by:: generateSSL3Secrets in interface CkiLibrary

generateSSL3MAC

public byte[] generateSSL3MAC(byte[] secret,
                              byte[] seqNumb,
                              byte type,
                              byte[] length,
                              byte[] pad1,
                              byte[] pad2,
                              byte[] content,
                              long macSize,
                              long mechanism,
                              long session)

Specified by:: generateSSL3MAC in interface CkiLibrary

generateSSL3MACHandshake

public byte[] generateSSL3MACHandshake(byte[] secret,
                                       byte[] pad1,
                                       byte[] pad2,
                                       byte[] label,
                                       byte[] content,
                                       long macSize,
                                       long mechanism,
                                       long session)

Specified by:: generateSSL3MACHandshake in interface CkiLibrary

digestAndEncryptSSL3

public java.lang.Object[] digestAndEncryptSSL3(boolean useManagedState,
                                               byte[] operationState,
                                               byte[] secret,
                                               byte[] seqNumb,
                                               byte type,
                                               byte[] length,
                                               byte[] pad1,
                                               byte[] pad2,
                                               byte[] content,
                                               long macSize,
                                               long cipherMechanism,
                                               long[] attrType,
                                               java.lang.Object[] values,
                                               long digestMechanism,
                                               long blocksize,
                                               long keyHandle,
                                               long session)

Specified by:: digestAndEncryptSSL3 in interface CkiLibrary

digestAndDecryptSSL3

public java.lang.Object[] digestAndDecryptSSL3(boolean useManagedState,
                                               byte[] operationState,
                                               byte[] secret,
                                               byte[] seqNumb,
                                               byte type,
                                               byte[] pad1,
                                               byte[] pad2,
                                               byte[] content,
                                               long macSize,
                                               long cipherMechanism,
                                               long[] attrType,
                                               java.lang.Object[] values,
                                               long digestMechanism,
                                               long blocksize,
                                               long keyHandle,
                                               long session)

Specified by:: digestAndDecryptSSL3 in interface CkiLibrary

Class GDLib

Constructor Summary