configuration.properties for OAuth

You find this file in your OAuth installation on Tomcat in <Tomcat installation path>\webapps\oauth-server\WEB-INF\classes\config.

Note: Some configuration files are delivered with the extension ".sample" to ensure that your existing configuration files will not be overwritten when you update your components. If a configuration file has this extension, remove it from the file name. Otherwise, the configuration will not go into effect.

Preparation: Before you begin, it is a good idea to prepare two random hexadecimal strings, one that is 32‑characters long and one that is 16‑characters long. You need to provide these two strings for key values in this configuration file and, in a later step, for the AES encryption.

Note: You can do this best with a tool that can generate random hexadecimal strings. (You can search online for "random hexadecimal string generator" to find tools such as https://onlinerandomtools.com/generate-random-hexadecimal-numbers.)

Parameter

Type

Description

Encryption.Key

String

Key to be used for AES encryption. It is also called the "Secret Key."

Important: This must be exactly 32 hexadecimal characters (0 though F).

Note: You can use a tool to generate this encryption key.

Encryption.IV

String

Initialization vector (IV) for the AES encryption

Important: This must be exactly 16 hexadecimal characters (0 though F).

Note: You can use a tool to generate this encryption key.

AutomationEngine.System String

Name of the AE system that validates the logins

AutomationEngine.AEUser

String

Name of the technical AE user for the internal processing

Format: user_name/department

Example: OAUTH_SERVER_USER/MYDEPARTMENT

AutomationEngine.AEPassword

String

Password for the technical AE user

AccessToken.CacheTimeout

Number

Number of seconds that the OAuth server keeps a token validation result in its memory

Default: 30

ValidationEndpoint.Username

String

User name for the basic authentication for the validation endpoint

Note: This must be the same user name as the one specified in the Password Exit INI file.

ValidationEndpoint.Password

String

Password for the basic authentication for the validation endpoint

Note: his must be the same password as the one specified in the Password Exit INI file, and it must be in plain text (not encrypted).

Example

Encryption.Key = B174A26A71490437AA024E4FADD5B497

Encryption.IV = 9E892875A52C59A3
 
AutomationEngine.System = AE11
AutomationEngine.AEUser = OAUTH_SERVER_USER/MYDEPARTMENT
AutomationEngine.AEPassword = 123
 
AccessToken.CacheTimeout = 30
ValidationEndpoint.Username = User1
ValidationEndpoint.Password = PWord