Package com.strongdm.api
Class ActiveDirectoryEngine
java.lang.Object
com.strongdm.api.ActiveDirectoryEngine
- All Implemented Interfaces:
SecretEngine
ActiveDirectoryEngine is currently unstable, and its API may change, or it may be removed,
without a major version bump.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe default time-to-live duration of the password after it's read.Distinguished name of object to bind when performing user and group search.Password to use along with binddn when performing user search.CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.int
Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.boolean
If set to true this will prevent password change timestamp validation in Active Directory when validating credentialsgetId()
Unique identifier of the Secret Engine.boolean
If true, skips LDAP server SSL certificate verification - insecure, use with caution!int
An interval of public/private key rotation for secret engine in daysThe maximum retry duration in case of automatic failure.getName()
Unique human-readable name of the Secret Engine.Policy for password creationbyte[]
Public key linked with a secret engineint
Timeout, in seconds, for the connection when making requests against the server before returning back an error.Backing secret store identifierBacking Secret Store root path where managed secrets are going to be storedboolean
If true, issues a StartTLS command after establishing an unencrypted connection.getTags()
Tags is a map of key, value pairs.getTtl()
The default password time-to-live duration.The domain (userPrincipalDomain) used to construct a UPN string for authentication.getUrl()
The LDAP server to connect to.Base DN under which to perform user search.void
The default time-to-live duration of the password after it's read.void
Distinguished name of object to bind when performing user and group search.void
setBindpass
(String in) Password to use along with binddn when performing user search.void
setCertificate
(String in) CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.void
setConnectionTimeout
(int in) Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.void
setDoNotValidateTimestamps
(boolean in) If set to true this will prevent password change timestamp validation in Active Directory when validating credentialsvoid
Unique identifier of the Secret Engine.void
setInsecureTls
(boolean in) If true, skips LDAP server SSL certificate verification - insecure, use with caution!void
setKeyRotationIntervalDays
(int in) An interval of public/private key rotation for secret engine in daysvoid
The maximum retry duration in case of automatic failure.void
Unique human-readable name of the Secret Engine.void
Policy for password creationvoid
setPublicKey
(byte[] in) Public key linked with a secret enginevoid
setRequestTimeout
(int in) Timeout, in seconds, for the connection when making requests against the server before returning back an error.void
Backing secret store identifiervoid
Backing Secret Store root path where managed secrets are going to be storedvoid
setStartTls
(boolean in) If true, issues a StartTLS command after establishing an unencrypted connection.void
Tags is a map of key, value pairs.void
The default password time-to-live duration.void
setUpndomain
(String in) The domain (userPrincipalDomain) used to construct a UPN string for authentication.void
The LDAP server to connect to.void
Base DN under which to perform user search.
-
Constructor Details
-
ActiveDirectoryEngine
public ActiveDirectoryEngine()
-
-
Method Details
-
getAfterReadTtl
The default time-to-live duration of the password after it's read. Once the ttl has passed, a password will be rotated. -
setAfterReadTtl
The default time-to-live duration of the password after it's read. Once the ttl has passed, a password will be rotated. -
getBinddn
Distinguished name of object to bind when performing user and group search. Example: cn=vault,ou=Users,dc=example,dc=com -
setBinddn
Distinguished name of object to bind when performing user and group search. Example: cn=vault,ou=Users,dc=example,dc=com -
getBindpass
Password to use along with binddn when performing user search. -
setBindpass
Password to use along with binddn when performing user search. -
getCertificate
CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded. -
setCertificate
CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded. -
getConnectionTimeout
public int getConnectionTimeout()Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration. -
setConnectionTimeout
public void setConnectionTimeout(int in) Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration. -
getDoNotValidateTimestamps
public boolean getDoNotValidateTimestamps()If set to true this will prevent password change timestamp validation in Active Directory when validating credentials -
setDoNotValidateTimestamps
public void setDoNotValidateTimestamps(boolean in) If set to true this will prevent password change timestamp validation in Active Directory when validating credentials -
getId
Unique identifier of the Secret Engine.- Specified by:
getId
in interfaceSecretEngine
-
setId
Unique identifier of the Secret Engine. -
getInsecureTls
public boolean getInsecureTls()If true, skips LDAP server SSL certificate verification - insecure, use with caution! -
setInsecureTls
public void setInsecureTls(boolean in) If true, skips LDAP server SSL certificate verification - insecure, use with caution! -
getKeyRotationIntervalDays
public int getKeyRotationIntervalDays()An interval of public/private key rotation for secret engine in days -
setKeyRotationIntervalDays
public void setKeyRotationIntervalDays(int in) An interval of public/private key rotation for secret engine in days -
getMaxBackoffDuration
The maximum retry duration in case of automatic failure. On failed ttl rotation attempt it will be retried in an increasing intervals until it reaches max_backoff_duration -
setMaxBackoffDuration
The maximum retry duration in case of automatic failure. On failed ttl rotation attempt it will be retried in an increasing intervals until it reaches max_backoff_duration -
getName
Unique human-readable name of the Secret Engine.- Specified by:
getName
in interfaceSecretEngine
-
setName
Unique human-readable name of the Secret Engine.- Specified by:
setName
in interfaceSecretEngine
-
getPolicy
Policy for password creation -
setPolicy
Policy for password creation -
getPublicKey
public byte[] getPublicKey()Public key linked with a secret engine- Specified by:
getPublicKey
in interfaceSecretEngine
-
setPublicKey
public void setPublicKey(byte[] in) Public key linked with a secret engine- Specified by:
setPublicKey
in interfaceSecretEngine
-
getRequestTimeout
public int getRequestTimeout()Timeout, in seconds, for the connection when making requests against the server before returning back an error. -
setRequestTimeout
public void setRequestTimeout(int in) Timeout, in seconds, for the connection when making requests against the server before returning back an error. -
getSecretStoreId
Backing secret store identifier- Specified by:
getSecretStoreId
in interfaceSecretEngine
-
setSecretStoreId
Backing secret store identifier- Specified by:
setSecretStoreId
in interfaceSecretEngine
-
getSecretStoreRootPath
Backing Secret Store root path where managed secrets are going to be stored- Specified by:
getSecretStoreRootPath
in interfaceSecretEngine
-
setSecretStoreRootPath
Backing Secret Store root path where managed secrets are going to be stored- Specified by:
setSecretStoreRootPath
in interfaceSecretEngine
-
getStartTls
public boolean getStartTls()If true, issues a StartTLS command after establishing an unencrypted connection. -
setStartTls
public void setStartTls(boolean in) If true, issues a StartTLS command after establishing an unencrypted connection. -
getTags
Tags is a map of key, value pairs.- Specified by:
getTags
in interfaceSecretEngine
-
setTags
Tags is a map of key, value pairs.- Specified by:
setTags
in interfaceSecretEngine
-
getTtl
The default password time-to-live duration. Once the ttl has passed, a password will be rotated the next time it's requested. -
setTtl
The default password time-to-live duration. Once the ttl has passed, a password will be rotated the next time it's requested. -
getUpndomain
The domain (userPrincipalDomain) used to construct a UPN string for authentication. -
setUpndomain
The domain (userPrincipalDomain) used to construct a UPN string for authentication. -
getUrl
The LDAP server to connect to. -
setUrl
The LDAP server to connect to. -
getUserdn
Base DN under which to perform user search. Example: ou=Users,dc=example,dc=com -
setUserdn
Base DN under which to perform user search. Example: ou=Users,dc=example,dc=com
-