keyfactor-auth-client-go

command module

v0.0.1-rc.13 Latest Latest Go to latest Published: Oct 21, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Client library for authenticating to Keyfactor Command

Name	Description	Default
KEYFACTOR_HOSTNAME	Keyfactor Command hostname without protocol and port
KEYFACTOR_PORT	Keyfactor Command port	`443`
KEYFACTOR_API_PATH	Keyfactor Command API Path	`KeyfactorAPI`
KEYFACTOR_SKIP_VERIFY	Skip TLS verification when connecting to Keyfactor Command	`false`
KEYFACTOR_CA_CERT	Either a file path or PEM encoded string to a CA certificate to trust when communicating with Keyfactor Command
KEYFACTOR_CLIENT_TIMEOUT	Timeout for HTTP client requests to Keyfactor Command	`60s`
KEYFACTOR_AUTH_CONFIG_FILE	Path to a JSON file containing the authentication configuration	`$HOME/.keyfactor/command_config.json`
KEYFACTOR_AUTH_CONFIG_PROFILE	Profile to use from the authentication configuration file	`default`

Currently, only Active Directory Basic authentication is supported.

Name	Description	Default
KEYFACTOR_USERNAME	Active Directory username to authenticate to Keyfactor Command API
KEYFACTOR_PASSWORD	Password associated with Active Directory username to authenticate to Keyfactor Command API
KEYFACTOR_DOMAIN	Active Directory domain of user. Can be implied from username if it contains `@` or `\\`

Name	Description	Default
KEYFACTOR_AUTH_CLIENT_ID	Keyfactor Auth Client ID
KEYFACTOR_AUTH_CLIENT_SECRET	Keyfactor Auth Client Secret
KEYFACTOR_AUTH_TOKEN_URL	URL to request an access token from Keyfactor Auth
KEYFACTOR_AUTH_SCOPES	Scopes to request when authenticating to Keyfactor Command API	`openid`
KEYFACTOR_AUTH_ACCESS_TOKEN	Access token to use to authenticate to Keyfactor Command API. This can be supplied directly or generated via client credentials
KEYFACTOR_AUTH_CA_CERT	Either a file path or PEM encoded string to a CA certificate to use when connecting to Keyfactor Auth

These environment variables are used to run go tests. They are not used in the actual client library.

Name	Description	Default
TEST_KEYFACTOR_AD_AUTH	Set to `true` to test Active Directory authentication	false
TEST_KEYFACTOR_KC_AUTH	Set to `true` to test Keycloak authentication	false

There is no documentation for this package.