Skip to content

Latest commit

 

History

History

auth

README.md

Authentication

Configuration loading is designed for containerization in mind. The container engine and orchestrator can mount volumes (secret or regular) as well as set the environment variables as outlined below.

You may set configurations through both files and environment variables. Please note that environment variables will override the settings in the configuration files. The configuration files are all expected to be in YAML format.


Table of contents


JSON Web Token API Key

API key based authentication is provided through the use of JWTs that must be included in the message header section of an HTTP request:


File Location(s)

Location Details
/etc/FTeX.conf/ The etc directory is the canonical location for configurations.
$HOME/.FTeX/ Configurations can be located in the user's home directory.
./configs/ The config folder in the root directory where the application is located.
Environment variables Finally, the configurations will be loaded from environment variables and override configuration files

Configuration File

The expected file name is AuthConfig.yaml. All the configuration items below are required.

Name Environment Variable Key Type Description
JWT AUTH_JWT JWT Configurations. Parent key for JSON Web Token configurations.
↳ key ↳ .KEY string The encryption key used for the JSON Web Token.
↳ issuer ↳ .ISSUER string The issuer of the JSON Web Token.
↳ expirationDuration ↳ .EXPIRATIONDURATION int64 The validity duration in seconds for the JSON Web Token.
↳ refreshThreshold ↳ .REFRESHTHRESHOLD int64 The seconds before expiration that a JSON Web Token can be refreshed before.
General AUTH_CONFIG General Configurations. Parent key for general authentication configurations.
↳ bcryptCost ↳ .BCRYPTCOST int The cost value that is used for the BCrypt algorithm.
↳ cryptoSecret ↳ .CRYPTOSECRET string A 32 character secret key to be used for AES256 encryption and decryption.

Example Configuration File

jwt:
  key: some-long-random-key
  issuer: issuer of the token
  expirationDuration: 600
  refreshThreshold: 60
general:
  bcryptCost: 8

Example Environment Variables

export AUTH_CONFIG.BCRYPT_COST=8
export AUTH_JWT.KEY="some-long-random-key"