Class: SDM::ActiveDirectoryEngine

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(after_read_ttl: nil, binddn: nil, bindpass: nil, certificate: nil, connection_timeout: nil, do_not_validate_timestamps: nil, id: nil, insecure_tls: nil, key_rotation_interval_days: nil, max_backoff_duration: nil, name: nil, policy: nil, public_key: nil, request_timeout: nil, secret_store_id: nil, secret_store_root_path: nil, start_tls: nil, tags: nil, ttl: nil, upndomain: nil, url: nil, userdn: nil) ⇒ ActiveDirectoryEngine 



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'lib/models/porcelain.rb', line 2090

def initialize(
  after_read_ttl: nil,
  binddn: nil,
  bindpass: nil,
  certificate: nil,
  connection_timeout: nil,
  do_not_validate_timestamps: nil,
  id: nil,
  insecure_tls: nil,
  key_rotation_interval_days: nil,
  max_backoff_duration: nil,
  name: nil,
  policy: nil,
  public_key: nil,
  request_timeout: nil,
  secret_store_id: nil,
  secret_store_root_path: nil,
  start_tls: nil,
  tags: nil,
  ttl: nil,
  upndomain: nil,
  url: nil,
  userdn: nil
)
  @after_read_ttl = after_read_ttl == nil ? nil : after_read_ttl
  @binddn = binddn == nil ? "" : binddn
  @bindpass = bindpass == nil ? "" : bindpass
  @certificate = certificate == nil ? "" : certificate
  @connection_timeout = connection_timeout == nil ? 0 : connection_timeout
  @do_not_validate_timestamps = do_not_validate_timestamps == nil ? false : do_not_validate_timestamps
  @id = id == nil ? "" : id
  @insecure_tls = insecure_tls == nil ? false : insecure_tls
  @key_rotation_interval_days = key_rotation_interval_days == nil ? 0 : key_rotation_interval_days
  @max_backoff_duration = max_backoff_duration == nil ? nil : max_backoff_duration
  @name = name == nil ? "" : name
  @policy = policy == nil ? nil : policy
  @public_key = public_key == nil ? "" : public_key
  @request_timeout = request_timeout == nil ? 0 : request_timeout
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @secret_store_root_path = secret_store_root_path == nil ? "" : secret_store_root_path
  @start_tls = start_tls == nil ? false : start_tls
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @ttl = ttl == nil ? nil : ttl
  @upndomain = upndomain == nil ? "" : upndomain
  @url = url == nil ? "" : url
  @userdn = userdn == nil ? "" : userdn
end

Instance Attribute Details

#after_read_ttl ⇒ Object

The default time-to-live duration of the password after it's read. Once the ttl has passed, a password will be rotated.



2045
2046
2047
 
# File 'lib/models/porcelain.rb', line 2045

def after_read_ttl
  @after_read_ttl
end

#binddn ⇒ Object

Distinguished name of object to bind when performing user and group search. Example: cn=vault,ou=Users,dc=example,dc=com



2047
2048
2049
 
# File 'lib/models/porcelain.rb', line 2047

def binddn
  @binddn
end

#bindpass ⇒ Object

Password to use along with binddn when performing user search.



2049
2050
2051
 
# File 'lib/models/porcelain.rb', line 2049

def bindpass
  @bindpass
end

#certificate ⇒ Object

CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.



2051
2052
2053
 
# File 'lib/models/porcelain.rb', line 2051

def certificate
  @certificate
end

#connection_timeout ⇒ Object

Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.



2053
2054
2055
 
# File 'lib/models/porcelain.rb', line 2053

def connection_timeout
  @connection_timeout
end

#do_not_validate_timestamps ⇒ Object

If set to true this will prevent password change timestamp validation in Active Directory when validating credentials



2055
2056
2057
 
# File 'lib/models/porcelain.rb', line 2055

def do_not_validate_timestamps
  @do_not_validate_timestamps
end

#id ⇒ Object

Unique identifier of the Secret Engine.



2057
2058
2059
 
# File 'lib/models/porcelain.rb', line 2057

def id
  @id
end

#insecure_tls ⇒ Object

If true, skips LDAP server SSL certificate verification - insecure, use with caution!



2059
2060
2061
 
# File 'lib/models/porcelain.rb', line 2059

def insecure_tls
  @insecure_tls
end

#key_rotation_interval_days ⇒ Object

An interval of public/private key rotation for secret engine in days



2061
2062
2063
 
# File 'lib/models/porcelain.rb', line 2061

def key_rotation_interval_days
  @key_rotation_interval_days
end

#max_backoff_duration ⇒ Object

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



2064
2065
2066
 
# File 'lib/models/porcelain.rb', line 2064

def max_backoff_duration
  @max_backoff_duration
end

#name ⇒ Object

Unique human-readable name of the Secret Engine.



2066
2067
2068
 
# File 'lib/models/porcelain.rb', line 2066

def name
  @name
end

#policy ⇒ Object

Policy for password creation



2068
2069
2070
 
# File 'lib/models/porcelain.rb', line 2068

def policy
  @policy
end

#public_key ⇒ Object

Public key linked with a secret engine



2070
2071
2072
 
# File 'lib/models/porcelain.rb', line 2070

def public_key
  @public_key
end

#request_timeout ⇒ Object

Timeout, in seconds, for the connection when making requests against the server before returning back an error.



2072
2073
2074
 
# File 'lib/models/porcelain.rb', line 2072

def request_timeout
  @request_timeout
end

#secret_store_id ⇒ Object

Backing secret store identifier



2074
2075
2076
 
# File 'lib/models/porcelain.rb', line 2074

def secret_store_id
  @secret_store_id
end

#secret_store_root_path ⇒ Object

Backing Secret Store root path where managed secrets are going to be stored



2076
2077
2078
 
# File 'lib/models/porcelain.rb', line 2076

def secret_store_root_path
  @secret_store_root_path
end

#start_tls ⇒ Object

If true, issues a StartTLS command after establishing an unencrypted connection.



2078
2079
2080
 
# File 'lib/models/porcelain.rb', line 2078

def start_tls
  @start_tls
end

#tags ⇒ Object

Tags is a map of key, value pairs.



2080
2081
2082
 
# File 'lib/models/porcelain.rb', line 2080

def tags
  @tags
end

#ttl ⇒ Object

The default password time-to-live duration. Once the ttl has passed, a password will be rotated the next time it's requested.



2082
2083
2084
 
# File 'lib/models/porcelain.rb', line 2082

def ttl
  @ttl
end

#upndomain ⇒ Object

The domain (userPrincipalDomain) used to construct a UPN string for authentication.



2084
2085
2086
 
# File 'lib/models/porcelain.rb', line 2084

def upndomain
  @upndomain
end

#url ⇒ Object

The LDAP server to connect to.



2086
2087
2088
 
# File 'lib/models/porcelain.rb', line 2086

def url
  @url
end

#userdn ⇒ Object

Base DN under which to perform user search. Example: ou=Users,dc=example,dc=com



2088
2089
2090
 
# File 'lib/models/porcelain.rb', line 2088

def userdn
  @userdn
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



2138
2139
2140
2141
2142
2143
2144
 
# File 'lib/models/porcelain.rb', line 2138

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end