Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With the Security Profile, you can make encryption configurations that can be used by various agents. The profile consists of three tabs: General, Advanced, and External Keystore.

General Tab

General Tab Screen

...

Keystore Settings

The following settings are available:

SettingsDescription
Type

You can select from the following options:

  • Java Keystore
  • External Keystore
  • <None>

Selecting External Keystore or <None> disables the rest of the keystore settings. Selecting External Keystore will require the more input in External Keystore tab.

Path

Enter the location of the keystore from which you want to read the key. 
PasswordEnter the relevant keystore password. 
Public Key AliasThe encryption alias to use. In a client it should be the alias to the server public certificate. If left empty the Keystore Alias will be used to encrypt the message.
Private Key AliasIf the keystore contains more than one key, specify the alias of the key that you want to use.
Key PasswordThe Key Password fields is optional. You can enter the key password, or if you leave this field empty, the Password that you entered is the default.


Excerpt
namekeystore_settings
Info
titleExample - How to create a symmetric crypto key


Code Block
$ keytool -keystore test.ks -storepass password -genseckey -keysize 128 -alias testkey -keyalg AES



Info
titleExample - How to create a Keystore file with security contents

This example code shows how to create a Java keystore file for both the server and client connection. In this example this will generate the file, containing the associated security certificate, public and private key. 

Code Block
languagebash
titleCode Block
keytool -genkey -alias server -keyalg RSA -keystore ./server.jks

NOTE: Remember the password issued for the server.jks file.


Info
titleExample - How to create a client-specific Keystore file

To create a client-specific Java Keystore file, you can use the keytool command with the required variables. In this example the generated file will be for a specific client and contain only their certificate and public key. 

Code Block
languagebash
titleCode Block
$ keytool -export -alias server -keystore ./server.jks -file ./server.cer
...
$ keytool -import -alias client -file ./server.cer -keystore ./client.jks
...

Note: Execution of these commands will present password entry prompts, you will need to remember the entered passphrase. 


...

FieldDescription
Type

You can select from the following options: 

  • Java Truststore
  • Use Java Keystore
  • External Truststore
  • Use External Keystore
  • <None>

Selecting Use Java Keystore disables the rest of the truststore settings and the keystore specified in Keystore Settings is used.

Selecting External Truststore or Use External Keystore disables the rest of the truststore settings and will require more input in External Keystore tab.

Selecting <None> disables the rest of the truststore settings.

Path

Enter the location of the truststore that you want to use. 
PasswordEnter the relevant truststore password.


Advanced Tab

Image Modified

The Advanced tab enables you to make more detailed configurations for which cipher suites to accept. 

...

SettingsDescription
Enable TLS Settings

If you want to change the TLS security parameters, select this check box. The default setting is to use the settings from the Java installation.

Accepted Protocols

You can select if you want agents using this profile to accept only TLS version 1.3 or any TLS version. The default setting is to only accept version 1.3.

Used Cipher Suites

You can select if you want agents using this profile to use only suites that are enabled by default, or any suites. The default setting is to only use suites that are enabled by default.

Cipher Suite Must Match

In this field, you can enter any characters that you want the cipher suites to match. You can also enter lists of regular expression, one per row, that you want the cipher suites to match. Suites not matching your entry are greyed out in the Result on this JVM field.

Cipher Suite Must Not Match

If you want to exclude cipher suites, you can enter any characters in this field which excludes suites matching the characters. You can also enter lists of regular expression, one per row, for cipher suites to exclude.

Result on this JVMThis field displays the cipher suites available on the current JVM.

...

SettingsDescription
Azure KeyVault Profile

Choose a Azure KeyVault Profile to use for the credentials.

Certificate name

The name of the certificate in Azure KeyVault

...

SettingsDescription
Auth Methods

Select the authentication method used to access the vault.

Address

The address for the vault. The format of the address begins with the hypertext transfer protocol, either HTTP or HTTPS, followed by the IP address of the vault and the TCP port used by the TCP listener of the vault.

Info
titleExample

https://127.0.0.1:8200


Username

Enter the vault username.

Password

Enter the vault password.

Path

The full path of the vault secret engine that contains the relevant keystore or truststore.

Info
titleExample

secret/digitalroute/mz/security/server


...