io.warp10.crypto

Interface KeyStore

All Known Implementing Classes:

DummyKeyStore, OSSKeyStore, UnsecureKeyStore

public interface KeyStore

The interface Key store.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AES_FDB_DATA Name of key for wrapping data (readings)
static java.lang.String	AES_FDB_METADATA Name of key for wrapping metadata
static java.lang.String	AES_FETCHER Key for wrapping GTSSplit instances
static java.lang.String	AES_KAFKA_DATA Name of key for wrapping kafka data messages
static java.lang.String	AES_KAFKA_METADATA Name of key for wrapping kafka medata messages
static java.lang.String	AES_KAFKA_PLASMA_BACKEND_IN Name of key for wrapping kafka messages consumed by plasma backends
static java.lang.String	AES_KAFKA_PLASMA_BACKEND_OUT Name of key for wrapping kafka messages produced by plasma backends
static java.lang.String	AES_KAFKA_PLASMA_FRONTEND_IN Name of key for wrapping kafka messages consumed by plasma frontends
static java.lang.String	AES_LEVELDB_DATA Name of key for wrapping data (readings)
static java.lang.String	AES_LEVELDB_METADATA Name of key for wrapping metadata
static java.lang.String	AES_LOGGING AES key to use for wrapping sensitive logging messages
static java.lang.String	AES_METASETS Key for wrapping MetaSets
static java.lang.String	AES_RUNNER_PSK PreShared key for Runner so scripts coming from runners can be identified
static java.lang.String	AES_SECURESCRIPTS Key for wrapping secure scripts
static java.lang.String	AES_TOKEN Name of key for wrapping Tokens
static java.lang.String	SIPHASH_APPID Name of key for application Ids
static java.lang.String	SIPHASH_CLASS Name of key for hashing class names
static java.lang.String	SIPHASH_CLASS_SECONDARY Name of secondary key for class name hashing
static java.lang.String	SIPHASH_DIRECTORY_PSK Name of key for computing MAC for DirectoryFindRequest instances
static java.lang.String	SIPHASH_FETCH_PSK Name of key for computing MAC for fetch requests
static java.lang.String	SIPHASH_KAFKA_DATA Name of key for computing MAC for kafka data messages
static java.lang.String	SIPHASH_KAFKA_METADATA Name of key for computing MAC for kafka metadata messages
static java.lang.String	SIPHASH_KAFKA_PLASMA_BACKEND_IN Name of key for computing MAC for kafka messages consumed by plasma backends
static java.lang.String	SIPHASH_KAFKA_PLASMA_BACKEND_OUT Name of key for computing MAC for kafka messages produced by plasma backends
static java.lang.String	SIPHASH_KAFKA_PLASMA_FRONTEND_IN Name of key for computing MAC for kafka messages consumed by plasma frontends
static java.lang.String	SIPHASH_KAFKA_RUNNER Name of key for computing MAC for kafka runn requests
static java.lang.String	SIPHASH_LABELS Name of key for hash labels
static java.lang.String	SIPHASH_LABELS_SECONDARY Name of secondary key for labels hashing
static java.lang.String	SIPHASH_TOKEN Name of key for token Ids.

Method Summary

Modifier and Type	Method and Description
static byte[]	checkAndSetKey(KeyStore keystore, java.lang.String keystoreKey, java.util.Properties props, java.lang.String configurationKey, int... sizeInBits) Get a key from the configuration, and, if it exists and if the number of bits of the key is in the given values, add it to the keystore.
static byte[]	checkAndSetKey(KeyStore keystore, java.lang.String keyname, java.util.Properties props, java.lang.String configurationKey, java.lang.String defaultKeyValue, int... sizeInBits) Get a key from the configuration, and, if it exists or has a non-null default and if the number of bits of the key is in the given values, add it to the keystore.
KeyStore	clone()
byte[]	decodeKey(java.lang.String encoded) Decode key byte [ ].
void	forget() Forget.
byte[]	getKey(java.lang.String name) Get key byte [ ].
void	setKey(java.lang.String name, byte[] key) Sets key.

Field Detail

SIPHASH_CLASS

static final java.lang.String SIPHASH_CLASS

Name of key for hashing class names

See Also:

Constant Field Values

SIPHASH_LABELS

static final java.lang.String SIPHASH_LABELS

Name of key for hash labels

See Also:

Constant Field Values

SIPHASH_CLASS_SECONDARY

static final java.lang.String SIPHASH_CLASS_SECONDARY

Name of secondary key for class name hashing

See Also:

Constant Field Values

SIPHASH_LABELS_SECONDARY

static final java.lang.String SIPHASH_LABELS_SECONDARY

Name of secondary key for labels hashing

See Also:

Constant Field Values

SIPHASH_APPID

static final java.lang.String SIPHASH_APPID

Name of key for application Ids

See Also:

Constant Field Values

SIPHASH_TOKEN

static final java.lang.String SIPHASH_TOKEN

Name of key for token Ids.

See Also:

Constant Field Values

AES_FDB_METADATA

static final java.lang.String AES_FDB_METADATA

Name of key for wrapping metadata

See Also:

Constant Field Values

AES_FDB_DATA

static final java.lang.String AES_FDB_DATA

Name of key for wrapping data (readings)

See Also:

Constant Field Values

AES_TOKEN

static final java.lang.String AES_TOKEN

Name of key for wrapping Tokens

See Also:

Constant Field Values

AES_RUNNER_PSK

static final java.lang.String AES_RUNNER_PSK

PreShared key for Runner so scripts coming from runners can be identified

See Also:

Constant Field Values

SIPHASH_KAFKA_RUNNER

static final java.lang.String SIPHASH_KAFKA_RUNNER

Name of key for computing MAC for kafka runn requests

See Also:

Constant Field Values

SIPHASH_KAFKA_DATA

static final java.lang.String SIPHASH_KAFKA_DATA

Name of key for computing MAC for kafka data messages

See Also:

Constant Field Values

SIPHASH_KAFKA_METADATA

static final java.lang.String SIPHASH_KAFKA_METADATA

Name of key for computing MAC for kafka metadata messages

See Also:

Constant Field Values

SIPHASH_KAFKA_PLASMA_BACKEND_IN

static final java.lang.String SIPHASH_KAFKA_PLASMA_BACKEND_IN

Name of key for computing MAC for kafka messages consumed by plasma backends

See Also:

Constant Field Values

SIPHASH_KAFKA_PLASMA_BACKEND_OUT

static final java.lang.String SIPHASH_KAFKA_PLASMA_BACKEND_OUT

Name of key for computing MAC for kafka messages produced by plasma backends

See Also:

Constant Field Values

SIPHASH_KAFKA_PLASMA_FRONTEND_IN

static final java.lang.String SIPHASH_KAFKA_PLASMA_FRONTEND_IN

Name of key for computing MAC for kafka messages consumed by plasma frontends

See Also:

Constant Field Values

SIPHASH_DIRECTORY_PSK

static final java.lang.String SIPHASH_DIRECTORY_PSK

Name of key for computing MAC for DirectoryFindRequest instances

See Also:

Constant Field Values

SIPHASH_FETCH_PSK

static final java.lang.String SIPHASH_FETCH_PSK

Name of key for computing MAC for fetch requests

See Also:

Constant Field Values

AES_KAFKA_DATA

static final java.lang.String AES_KAFKA_DATA

Name of key for wrapping kafka data messages

See Also:

Constant Field Values

AES_KAFKA_METADATA

static final java.lang.String AES_KAFKA_METADATA

Name of key for wrapping kafka medata messages

See Also:

Constant Field Values

AES_KAFKA_PLASMA_BACKEND_IN

static final java.lang.String AES_KAFKA_PLASMA_BACKEND_IN

Name of key for wrapping kafka messages consumed by plasma backends

See Also:

Constant Field Values

AES_KAFKA_PLASMA_BACKEND_OUT

static final java.lang.String AES_KAFKA_PLASMA_BACKEND_OUT

Name of key for wrapping kafka messages produced by plasma backends

See Also:

Constant Field Values

AES_KAFKA_PLASMA_FRONTEND_IN

static final java.lang.String AES_KAFKA_PLASMA_FRONTEND_IN

Name of key for wrapping kafka messages consumed by plasma frontends

See Also:

Constant Field Values

AES_LOGGING

static final java.lang.String AES_LOGGING

AES key to use for wrapping sensitive logging messages

See Also:

Constant Field Values

AES_LEVELDB_METADATA

static final java.lang.String AES_LEVELDB_METADATA

Name of key for wrapping metadata

See Also:

Constant Field Values

AES_LEVELDB_DATA

static final java.lang.String AES_LEVELDB_DATA

Name of key for wrapping data (readings)

See Also:

Constant Field Values

AES_SECURESCRIPTS

static final java.lang.String AES_SECURESCRIPTS

Key for wrapping secure scripts

See Also:

Constant Field Values

AES_METASETS

static final java.lang.String AES_METASETS

Key for wrapping MetaSets

See Also:

Constant Field Values

AES_FETCHER

static final java.lang.String AES_FETCHER

Key for wrapping GTSSplit instances

See Also:

Constant Field Values

Method Detail

getKey

byte[] getKey(java.lang.String name)

Get key byte [ ].

Parameters:

name - the name

Returns:

the byte [ ]

setKey

void setKey(java.lang.String name,
            byte[] key)

Sets key.

Parameters:

name - the name

key - the key

decodeKey

byte[] decodeKey(java.lang.String encoded)

Decode key byte [ ].

Parameters:

encoded - the encoded

Returns:

the byte [ ]

clone

KeyStore clone()

forget

void forget()

Forget.

checkAndSetKey

static byte[] checkAndSetKey(KeyStore keystore,
                             java.lang.String keystoreKey,
                             java.util.Properties props,
                             java.lang.String configurationKey,
                             int... sizeInBits)

Get a key from the configuration, and, if it exists and if the number of bits of the key is in the given values, add it to the keystore.

Parameters:

keystore - The KeyStore to add the key to.

keystoreKey - The key name under which to add the key in the keystore.

props - The properties from which to get the key.

configurationKey - The configuration key holding the key value.

sizeInBits - The valid number of bits of the key. Typically 128 or 128, 192, 256.

Returns:

The key.

checkAndSetKey

static byte[] checkAndSetKey(KeyStore keystore,
                             java.lang.String keyname,
                             java.util.Properties props,
                             java.lang.String configurationKey,
                             java.lang.String defaultKeyValue,
                             int... sizeInBits)

Get a key from the configuration, and, if it exists or has a non-null default and if the number of bits of the key is in the given values, add it to the keystore.

Parameters:

keystore - The KeyStore to add the key to.

keyname - The key name under which to add the key in the keystore.

props - The properties from which to get the key.

configurationKey - The configuration key holding the key value.

defaultKeyValue - The default key in case it is not found in the properties.

sizeInBits - The valid number of bits of the key. Typically 128 or 128, 192, 256.

Returns:

The key.