Authorization Server Properties

Owned by Yi Zhan Lim
Last updated: Oct 14, 2024 by Yeok Hong Ng (Deactivated)
3 min read

This section describes the different properties that are being used in the Authorization Server. These properties are divided into several blocks with each block corresponding to a particular element of the Authorization Server.

The following is an example of parameters that have been configured accordingly to the requirements. 

enabled=true # -------------------------------------------------------------------------------- # Storage Properties # -------------------------------------------------------------------------------- # Only used when storage type is "database". PostgreSQL or Oracle DB only storage.database.profile-name=<Path.DBProfileName> storage.database.poolsize=8 # Only used when storage type is "file-based" storage.file-based.storage-location=/Users/limyizhan/Workspace/mz9/mz-drx/mediationzone/storage/oauth2.storage # The storage type can be either "file-based" or "database" storage.type=file-based # -------------------------------------------------------------------------------- # Server Properties # -------------------------------------------------------------------------------- # Validity period in seconds for access token generated server.access-token-expiry=1800 # -------------------------------------------------------------------------------- # Management Api Properties # -------------------------------------------------------------------------------- management-api.enable-basic-auth=true # HTTP Basic Authentication Password management-api.password=DR-4-6912EB66E4E5FDF6035DBF848195669A # HTTP Basic Authentication Username management-api.username=mzadmin # -------------------------------------------------------------------------------- # JSON Web Token (JWT) Properties # -------------------------------------------------------------------------------- jwt.key-id=selfsigned jwt.key-password=DR-4-6912EB66E4E5FDF6035DBF848195669A jwt.keystore-location=/Users/limyizhan/Downloads/keystore_server.jks jwt.keystore-password=DR-4-6912EB66E4E5FDF6035DBF848195669A # Only RS256, RS384 and RS512 are supported jwt.signature-algorithm=RS256

Storage

The OAuth2 Service stores provisioned scopes and registered clients into memory or persistent storage.

The storage configuration is used to determine where the data should be stored. For Database type storage, refer to Authorization Server Storage Database Schema for details on creating the table for Authorization Server.

Parameter Name

Description

Parameter Name

Description

type

Type of storage to be used. The value can be one of the following:

  • file-based (Default) - The data will be stored in a file-based storage.

  • database - The data will be stored in a database.

Only PostgreSQL and Oracle database are currently supported.

file-based.storage-location

Location of the file-based storage. Will be created if not found. Only used when storage type is set to "file-based"

For fresh installs, the last path in the location should be non-existent as the Authorization server will create it automatically.

database.profile-name

The Database Profile Name in MZ to be used. Only used when storage type is set to "database". The value of the profile name should include the directory name as shown in the desktop UI.

Example

storage { database { profile-name="REST.PRF_DB" } type="database" }

database.poolsize

The size of the connection pool, representing the number of database connections that are kept open and ready for use. Only used when stroage type is set to "database". 

Server

The server configuration for the OAuth2 Service that will determine where the access token endpoint will be hosted on and the access token expiry.

Parameter Name

Description

Parameter Name

Description

access-token-expiry

Validity period in seconds for access token generated.


Management API

The Management API is used to provision scopes and register clients via HTTP. Clients need to be registered before any access token can be requested.

The Management API configuration is used to configure the base endpoint in the Authorization Server that will be used to host the Management API.

For more information on the function of Management API, refer to Management API.

Parameter Name

Description

Parameter Name

Description

enable-basic-auth

Enables the HTTP Basic Authentication for Management API.

username

Username for HTTP Basic Authentication (if enabled).

password

Password for HTTP Basic Authentication (if enabled). Must be encrypted using "mzsh encryptpassword" command.

JWT

The Authorization Server generates the JSON Web Token (JWT) and requires the JWT to be digitally signed. Currently, only the RSA private/public key pair signing method is supported.

The JWT block is used to configure the keystore and the RSA private/public key pair details.

Parameter Name

Description

Parameter Name

Description

keystore-location

Path to the keystore where the RSA private/public key pair used for JWT is stored. Only Java KeyStore (JKS) format is supported.

keystore-password

Password of the keystore. Must be encrypted using "mzsh encryptpassword" command.

key-id

Alias of the RSA private/public key pair used for JWT.

key-password

Password of the RSA private/public key pair used for JWT.

signature-algorithm

Signature algorithm to be used for JWT signing. Only RS256, RS384 and RS512 are supported.