com.so.net

Class DeviceApi.Crypto

java.lang.Object

com.so.net.DeviceApi.Crypto

Enclosing class:

DeviceApi

public static final class DeviceApi.Crypto
extends Object

A collection of cryptograpic functions most of which entail a signature device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceApi.Crypto.BioDataFormat Two biodata formats.
static class	DeviceApi.Crypto.CryptoId A Crypto ID identifies a device specific set of keys.
static class	DeviceApi.Crypto.RealTimeDecryption The realtime decryption decrypts the biodata while it is received from the device.
static interface	DeviceApi.Crypto.SetFinalDocHashCallback The continuation to call when setting the final document hash succeeded.
static class	DeviceApi.Crypto.SetFinalDocHashResult The result of an operation that sets the final document hash.
static class	DeviceApi.Crypto.SignKey Can set the sign key.

Method Summary

Modifier and Type	Method and Description
static byte[]	decryptAesKey(byte[] encryptedAesKey, byte[] preliminaryDocumentHash, Path pem) Decrypts the encrypted AES key by means of the preliminary document hash and a private RSA key.
static Optional<String>	decryptBioText(String bioText, byte[] aesKey) Decrypts the encrypted AES key by means of the preliminary document hash and a private RSA key.
static Optional<String>	getBioData() Gets the textual biodata.
static Optional<String>	getBioData(DeviceApi.Crypto.BioDataFormat bioDataFormat) Gets the biodata in different formats.
static Optional<String>	getCryptoIdInfo() Gets textual information on the available crypto IDs.
static List<DeviceApi.Crypto.CryptoId>	getCryptoIds() Gets the available crypto IDs for the selected device.
static byte[]	getEncryptedAesKey() Gets the encrypted AES key.
static Optional<String>	getNotaryInfo() Gets the notary information.
static byte[]	getNotaryKey() Gets the public notary key.
static List<byte[]>	getNotaryKeys() Deprecated. A required dependency is not yet released.
static Optional<Instant>	getRtcTime() Gets the time from the RTC of the signature device.
static Optional<X509Certificate>	getSignatureCertificate() Gets the certificate of the signer.
static Optional<X509Certificate>	getSignatureCertificate(boolean swSign) Gets the certificate of the signer.
static byte[]	getSignatureCertificateRaw(boolean swSign) Gets the certificate of the signer
static byte[]	getSignedDocumentHash() Gets the signed document hash that is an RSA signature.
static boolean	setCryptoId(DeviceApi.Crypto.CryptoId cryptoId) Sets the cryptoId to use for subsequent signatures.
static boolean	setFinalDocumentHash32(byte[] octets) Sets the final document hash.
static boolean	setFinalDocumentHash32(byte[] octets, boolean swSign) Sets the final document hash.
static boolean	setFinalDocumentHash32Async(byte[] octets, boolean swSign, DeviceApi.Crypto.SetFinalDocHashCallback callback) Deprecated. A required dependency is not yet released.
static Optional<DeviceApi.Crypto.SetFinalDocHashResult>	setFinalDocumentHash32Blocking(byte[] octets, boolean swSign) Deprecated. A required dependency is not yet released.
static boolean	setPreliminaryDocumentHash32(byte[] octets) Sets the premilinary document hash.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

decryptAesKey

public static byte[] decryptAesKey(byte[] encryptedAesKey,
                                   byte[] preliminaryDocumentHash,
                                   Path pem)

Decrypts the encrypted AES key by means of the preliminary document hash and a private RSA key.

Parameters:

encryptedAesKey - The encrypted AES key.

preliminaryDocumentHash - The preliminary document hash.

pem - The pem file having the private RSA key.

Returns:

An empty array in case of error. Else the key.

decryptBioText

public static Optional<String> decryptBioText(String bioText,
                                              byte[] aesKey)

Decrypts the encrypted AES key by means of the preliminary document hash and a private RSA key.

Parameters:

bioText - The textual biometric data.

aesKey - The AES Key.

Returns:

Some biodata in case of success.

setPreliminaryDocumentHash32

public static boolean setPreliminaryDocumentHash32(byte[] octets)

Sets the premilinary document hash.

Parameters:

octets - The hash. 32 octets.

Returns:

True in case of success.

getSignedDocumentHash

public static byte[] getSignedDocumentHash()

Gets the signed document hash that is an RSA signature.

Returns:

The signed document hash.

getEncryptedAesKey

public static byte[] getEncryptedAesKey()

Gets the encrypted AES key.

Returns:

An empty array in case of error.

setFinalDocumentHash32

public static boolean setFinalDocumentHash32(byte[] octets)

Sets the final document hash. May call the

Parameters:

octets - The hash. 32 octets.

Returns:

True in case of success.

setFinalDocumentHash32

public static boolean setFinalDocumentHash32(byte[] octets,
                                             boolean swSign)

Sets the final document hash. May call the button callback, see DeviceApi.Button.setCallback(com.so.net.DeviceApi.Button.Callback).

Parameters:

octets - The hash. 32 octets.

swSign - Pass false to let the signature device sign the final document hash.

Returns:

True in case of success.

setFinalDocumentHash32Blocking

public static Optional<DeviceApi.Crypto.SetFinalDocHashResult> setFinalDocumentHash32Blocking(byte[] octets,
                                                                                              boolean swSign)

Deprecated. A required dependency is not yet released.

Sets the final document hash. This is a blocking version of setFinalDocumentHash32Async(byte[], boolean, com.so.net.DeviceApi.Crypto.SetFinalDocHashCallback).

Parameters:

octets - The hash.

swSign - Pass false to let the signature device sign the final document hash.

Returns:

The result of this operation.

Since:

0.0.26

setFinalDocumentHash32Async

public static boolean setFinalDocumentHash32Async(byte[] octets,
                                                  boolean swSign,
                                                  DeviceApi.Crypto.SetFinalDocHashCallback callback)

Deprecated. A required dependency is not yet released.

Sets the final document hash to be signed.

Parameters:

octets - The hash.

swSign - Pass false to let the signature device sign the final document hash.

callback - The callback to call when setting the final document hash succeeded.

Returns:

True in case of success.

Since:

0.0.26

getSignatureCertificate

public static Optional<X509Certificate> getSignatureCertificate()

Gets the certificate of the signer.

Returns:

Some certificate in case of success.

getSignatureCertificate

public static Optional<X509Certificate> getSignatureCertificate(boolean swSign)

Gets the certificate of the signer.

Parameters:

swSign - Pass false if the signature device signs the final document hash. See setFinalDocumentHash32(byte[], boolean).

Returns:

Some certificate in case of success.

getSignatureCertificateRaw

public static byte[] getSignatureCertificateRaw(boolean swSign)

Gets the certificate of the signer

Parameters:

swSign - Pass false if the signature device signs the final document hash. See setFinalDocumentHash32(byte[], boolean).

Returns:

An empty array in case of error. The DER-encoded certificate in case of success.

getBioData

public static Optional<String> getBioData()

Gets the textual biodata.

Returns:

Some biodata in case of success.

getBioData

public static Optional<String> getBioData(DeviceApi.Crypto.BioDataFormat bioDataFormat)

Gets the biodata in different formats.

Parameters:

bioDataFormat - The biodata format.

Returns:

Some biodata in case of success.

getNotaryInfo

public static Optional<String> getNotaryInfo()

Gets the notary information.

Returns:

Some notary information in case of success.

getNotaryKey

public static byte[] getNotaryKey()

Gets the public notary key.

Returns:

An empty array in case of error.

getRtcTime

public static Optional<Instant> getRtcTime()

Gets the time from the RTC of the signature device.

Returns:

Some time in case of success.

getCryptoIdInfo

public static Optional<String> getCryptoIdInfo()

Gets textual information on the available crypto IDs.

Returns:

A text in case of success.

getCryptoIds

public static List<DeviceApi.Crypto.CryptoId> getCryptoIds()

Gets the available crypto IDs for the selected device.

Returns:

A list of crypto ID objects. An empty list in case of error or absence of files.

setCryptoId

public static boolean setCryptoId(DeviceApi.Crypto.CryptoId cryptoId)

Sets the cryptoId to use for subsequent signatures.

Parameters:

cryptoId - The crypto ID.

Returns:

True in case of success. See getCryptoIds()

getNotaryKeys

public static List<byte[]> getNotaryKeys()

Deprecated. A required dependency is not yet released.

Gets the notary keys for the selected device. These keys correspond to the crypto IDs. See getCryptoIds().

Returns:

A list of public RSA keys. An empty list in case of error or absence of files.

Since:

0.0.25