B.7.7 Transaction Token Properties
Under transactionToken
, specify the key pair that you want to use for transaction token.
If you set transactionTokenEnabled
to true
in tcs-docker-swarm.yaml
, you must provide values for the properties listed in the following table.
Property | Description |
---|---|
transactionTokenEnabled |
Set this to true when you want MicroTx to include a signed transaction token, tmm-tx-token , in the request header. You don't have to create the tmm-tx-token transaction token or pass it in the request header. The MicroTx library creates this token based on the private-public key pair that you provide. For more information about creating the key pair, see Create Encryption Key and Key Pair.
|
transactionTokenKeyPairVersion |
Enter the version of the key pair that you want to use for signing and verification of the transaction token. When there are multiple key pairs, you must specify the version of the key pair that you want to use. |
keyPairs.keyPairs.privateKeyName |
Enter the name of the Docker secret which has the base64-encoded value of the private key. |
keyPairs.keyPairs.publicKeyName |
Enter the name of the Docker secret which has the base64-encoded value of the public key. |
keyPairs.keyPairs.version |
Enter the version of the private-public key pair that you want to use. |
keyPairs.keyPairs.privateKeyPasswordName |
Enter the name of the Docker secret which has the value of the pass phrase that you had provided while generating the private key. |
The following code snippet provides sample values for the transactionToken
field.
transactionToken:
transactionTokenEnabled: false
keyPairs: '{"keyPairs":[{"privateKeyName":"TMMPRIKEY", "publicKeyName":"TMMPUBKEY", "version":"1", "privateKeyPasswordName":"TMMPRIKEYPASSWD"}]}'
#TMMPRIKEY is the environment variable for the Docker secret that contains the base64-encoded private key
#TMMPUBKEY is the environment variable for the Docker secret that contains the base64-encoded public key
#TMMPRIKEYPASSWD is the environment variable for the Docker secret that contains the private key password
transactionTokenKeyPairVersion: 1
Parent topic: Configure the tcs-docker-swarm.yaml File