net.java.truelicense.core.auth

Interface KeyStoreParameters

All Superinterfaces:

AuthenticationParameters, SourceProvider

public interface KeyStoreParameters
extends AuthenticationParameters, SourceProvider

Defines parameters for accessing a KeyStore which holds the public or private keys to sign or verify a Repository by an Authentication.

Unless stated otherwise, all no-argument methods need to return consistent objects so that caching them is not required. A returned object is considered to be consistent if it compares equal or at least behaves identical to any previously returned object.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
String	alias() Returns the alias of the entry in the key store.
char[]	keyPassword() Returns a new char array with the password for accessing the private key in the key entry.
Source	source() Returns the nullable input source for the key store.
char[]	storePassword() Returns a new char array with the password for verifying the integrity of the key store.
String	storeType() Returns the type of the key store, for example "JCEKS" or "JKS".

Method Detail

alias

String alias()

Returns the alias of the entry in the key store.

keyPassword

char[] keyPassword()

Returns a new char array with the password for accessing the private key in the key entry. If the returned array is empty, then the key store password should get used instead.

It is the caller's responsibility to wipe the contents of the char array after use, e.g. by a call to Arrays.fill(char[], char).

Returns:

A new char array with the password for accessing the private key in the key entry.

source

@CheckForNull
Source source()

Returns the nullable input source for the key store.

Specified by:

source in interface SourceProvider

Returns:

the nullable input source for the key store. May be null if and only if the key store type does not require loading from an input stream.

storePassword

char[] storePassword()

Returns a new char array with the password for verifying the integrity of the key store.

It is the caller's responsibility to wipe the contents of the char array after use, e.g. by a call to Arrays.fill(char[], char).

Returns:

A new char array with the password for verifying the key store.

storeType

String storeType()

Returns the type of the key store, for example "JCEKS" or "JKS". The returned string should be computed on demand from an obfuscated form, e.g. by annotating a constant string value with the \@Obfuscate annotation and processing it with the TrueLicense Maven Plugin.