Configuration options

Table 1. Optional configuration options
key type default value description

algorithm

string

 

Algorithm of signature used by this client. Currently supported:

  • rsa-sha256 - asymmetric based on public/private keys

  • hmac-sha256 - symmetric based on a shared secret

hmac.secret

string

 

Helper method to configure a password-like secret (instead of byte based hmacSecret(byte[]). The password is transformed to bytes with StandardCharsets.UTF_8 charset.

key-id

string

 

The key id of this client to map to this signature validation configuration.

principal-name

string

 

The principal name of the client, defaults to keyId if not configured.

principal-type

SubjectType (USER, SERVICE)

SERVICE

The type of principal we have authenticated (either user or service, defaults to service).

public-key

 

For algorithms based on public/private key (such as rsa-sha256), this provides access to the public key of the client.