com.microej.crypto.internal.sni

Class ExternalKeyStoreNatives

java.lang.Object

com.microej.crypto.internal.sni.ExternalKeyStoreNatives

public class ExternalKeyStoreNatives
extends Object

Natives for the External KeyStore.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENTRY_TYPE_CERTIFICATE Certificate Entry Type.
static int	ENTRY_TYPE_KEY Key Entry Type.

Method Summary

Modifier and Type	Method and Description
static int	closeCertificateChainHandle(int handle) Closes a handle to a certificate chain (opened with getCertificateChainHandle(byte[])).
static int	closeKeyEntry(int handle) Closes a key entry.
static boolean	containsAlias(byte[] alias) Returns whether the KeyStore contains the given alias or not.
static int	deleteEntry(byte[] alias) Delete an entry.
static int	getAlias(int i, byte[] alias) Returns the alias at given index in the KeyStore.
static int	getCertificateChainHandle(byte[] alias) Returns a handle for the certificate chain loaded from KeyStore with given alias.
static int	getCertificateChainLength(int handle) Returns the length of the given certificate chain.
static void	getCertificateData(int handle, byte[] buffer) Fills the given buffer with the encoded X509 certificate.
static int	getCertificateFromChain(int handle, int index) Returns a handle for the certificate at given index from given certificate chain.
static int	getCertificateHandle(byte[] alias) Returns a handle for the certificate loaded from KeyStore with given alias.
static int	getCertificateSize(int handle) Returns the size of the encoded X509 certificate.
static int	getEntryType(byte[] alias) Get the entry type (certificate or key).
static void	getKeyAlgorithm(int keyId, byte[] algorithm) Returns the algorithm of the key with the given ID.
static int	getKeyId(byte[] alias, char[] password) Returns the ID of the key for the given alias.
static int	getKeyType(int keyId) Returns the type of the key with the given ID.
static int	insertCertificateInChain(int handle, int index, byte[] certificate) Insert a new certificate in the certificate chain associated to a given key entry.
static void	login(char[] password) Logs in to the KeyStore with the given password.
static int	openKeyEntryWithData(byte[] alias, byte[] key, int chainLength) Open a key entry with the key data.
static int	openKeyEntryWithNativeId(byte[] alias, int keyId, char[] password, int chainLength) Open a key entry with a handle to a native key.
static int	setCertificateEntry(byte[] alias, byte[] certificate) Set a new certificate entry.
static int	size() Returns the size of the KeyStore (the number of "objects": keys, certificates, certificate chains).

Methods inherited from class java.lang.Object

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

Field Detail

ENTRY_TYPE_CERTIFICATE

public static final int ENTRY_TYPE_CERTIFICATE

Certificate Entry Type.

See Also:

Constant Field Values

ENTRY_TYPE_KEY

public static final int ENTRY_TYPE_KEY

Key Entry Type.

See Also:

Constant Field Values

Method Detail

closeCertificateChainHandle

public static int closeCertificateChainHandle(int handle)

Closes a handle to a certificate chain (opened with getCertificateChainHandle(byte[])).

Parameters:

handle - the handle of the certificate chain

Returns:

if successful, else .

See Also:

getCertificateChainHandle(byte[])

closeKeyEntry

public static int closeKeyEntry(int handle)

Closes a key entry.

Parameters:

handle - the handle to the key entry (returned by openKeyEntryWithNativeId(byte[], int, char[], int) or openKeyEntryWithData(byte[], byte[], int)).

Returns:

if successful, else .

containsAlias

public static boolean containsAlias(byte[] alias)

Returns whether the KeyStore contains the given alias or not.

Parameters:

alias - the alias.

Returns:

true if the KeyStore contains the alias, false otherwise.

deleteEntry

public static int deleteEntry(byte[] alias)

Delete an entry.

Parameters:

alias - the alias of the entry.

Returns:

if successful, else .

getAlias

public static int getAlias(int i,
                           byte[] alias)

Returns the alias at given index in the KeyStore.

Parameters:

i - the key index, between 0 and size() (excluded).

alias - the byte array in which the next alias will be stored.

Returns:

NativeConstants.SUCCESS if successful, NativeConstants.ERROR if no such element at this index.

getCertificateChainHandle

public static int getCertificateChainHandle(byte[] alias)

Returns a handle for the certificate chain loaded from KeyStore with given alias.

Parameters:

alias - the alias of the certificate chain.

Returns:

a handle to the loaded certificate chain to navigate to get the list of certificates, or if no certificate chain exist with this alias or the certificate chain could not be loaded.

See Also:

getCertificateChainLength(int), getCertificateFromChain(int, int), closeCertificateChainHandle(int)

getCertificateChainLength

public static int getCertificateChainLength(int handle)

Returns the length of the given certificate chain.

Parameters:

handle - the handle of the certificate chain.

Returns:

the length of the given certificate chain.

See Also:

getCertificateChainHandle(byte[])

getCertificateData

public static void getCertificateData(int handle,
                                      byte[] buffer)

Fills the given buffer with the encoded X509 certificate.

Parameters:

handle - the handle of the certificate.

buffer - the buffer to fill.

See Also:

getCertificateHandle(byte[]), getCertificateFromChain(int, int)

getCertificateFromChain

public static int getCertificateFromChain(int handle,
                                          int index)

Returns a handle for the certificate at given index from given certificate chain.

Parameters:

handle - the handle of the certificate chain

index - the index of the certificate in the chain.

Returns:

the handle of the certificate, or if the certificate could not be loaded.

See Also:

getCertificateChainHandle(byte[])

getCertificateHandle

public static int getCertificateHandle(byte[] alias)

Returns a handle for the certificate loaded from KeyStore with given alias.

Parameters:

alias - the alias of the certificate.

Returns:

a handle to the loaded certificate to use to get size and data, or if no certificate exist with this alias or the certificate could not be loaded, .

See Also:

getCertificateSize(int), getCertificateData(int, byte[])

getCertificateSize

public static int getCertificateSize(int handle)

Returns the size of the encoded X509 certificate.

Parameters:

handle - the handle of the certificate.

Returns:

the size of the encoded X509 certificate.

See Also:

getCertificateHandle(byte[]), getCertificateFromChain(int, int)

getEntryType

public static int getEntryType(byte[] alias)

Get the entry type (certificate or key). - type 1: The keystore entry contains a key + optionally a certificate chain (for a private key). - type 0: The keystore entry contains a single certificate.

Parameters:

alias - the alias of the key.

Returns:

if successful 0 or 1, else

getKeyAlgorithm

public static void getKeyAlgorithm(int keyId,
                                   byte[] algorithm)

Returns the algorithm of the key with the given ID.

Parameters:

keyId - the ID of the key.

algorithm - the buffer to use to fill in the algorithm name.

See Also:

getKeyId(byte[], char[])

getKeyId

public static int getKeyId(byte[] alias,
                           @Nullable
                           char[] password)

Returns the ID of the key for the given alias.

The key will be "closed" using the close function associated with the key type.

Parameters:

alias - the alias of the key to get the ID from.

password - the password to access the key (for authorization or integrity check).

Returns:

the ID of the key, or -1 if no key is available with given alias or an error occurred loading the key, or if it is a secret key (currently unsupported).

See Also:

getKeyType(int), getKeyAlgorithm(int, byte[])

getKeyType

public static int getKeyType(int keyId)

Returns the type of the key with the given ID.

Parameters:

keyId - the ID of the key.

Returns:

the type of the key, one of NativeConstants.KEY_TYPE_PRIVATE, NativeConstants.KEY_TYPE_PUBLIC or NativeConstants.KEY_TYPE_SECRET.

See Also:

getKeyId(byte[], char[])

insertCertificateInChain

public static int insertCertificateInChain(int handle,
                                           int index,
                                           byte[] certificate)

Insert a new certificate in the certificate chain associated to a given key entry.

Parameters:

handle - the handle to the key entry (returned by openKeyEntryWithNativeId(byte[], int, char[], int) or openKeyEntryWithData(byte[], byte[], int)).

index - the index of the certificate in the chain.

certificate - the X.509 encoded certificate.

Returns:

if successful, else .

login

public static void login(@Nullable
                         char[] password)
                  throws IOException

Logs in to the KeyStore with the given password.

Parameters:

password - the password to login in with.

Throws:

IOException - if login fails such as because no external keystore available or the password check failed.

openKeyEntryWithData

public static int openKeyEntryWithData(byte[] alias,
                                       byte[] key,
                                       int chainLength)

Open a key entry with the key data. It is called by KeyStore.setKeyEntry(String, byte[], Certificate[]).

Parameters:

alias - the alias of the key.

key - the key (in protected format) to be associated with the alias.

chainLength - the size of the certificate chain (number of certificates).

Returns:

if successful, a handle to the created key entry, else

See Also:

insertCertificateInChain(int, int, byte[]), closeKeyEntry(int)

openKeyEntryWithNativeId

public static int openKeyEntryWithNativeId(byte[] alias,
                                           int keyId,
                                           char[] password,
                                           int chainLength)

Open a key entry with a handle to a native key. It is called by KeyStore.setKeyEntry(String, Key, char[], Certificate[]).

Parameters:

alias - the alias of the key.

keyId - the id of the native key.

password - the password to protect the key.

chainLength - the size of the certificate chain (number of certificates).

Returns:

if successful, a handle to the created key entry, else

See Also:

insertCertificateInChain(int, int, byte[]), closeKeyEntry(int)

setCertificateEntry

public static int setCertificateEntry(byte[] alias,
                                      byte[] certificate)

Set a new certificate entry.

Parameters:

alias - the alias of the key.

certificate - the X.509 encoded certificate.

Returns:

if successful, else .

size

public static int size()

Returns the size of the KeyStore (the number of "objects": keys, certificates, certificate chains).

Returns:

the size of the KeyStore.