Package org.forgerock.opendj.server.config.meta

Class LdapPassThroughAuthenticationPolicyCfgDefn

    • Method Detail

      • getInstance

        public static LdapPassThroughAuthenticationPolicyCfgDefn getInstance()
        Get the LDAP Pass Through Authentication Policy configuration definition singleton.
        Returns:
        Returns the LDAP Pass Through Authentication Policy configuration definition singleton.

      • getCachedPasswordStorageSchemePropertyDefinition

        public AggregationPropertyDefinition<PasswordStorageSchemeCfgClient,​PasswordStorageSchemeCfg> getCachedPasswordStorageSchemePropertyDefinition()
        Get the "cached-password-storage-scheme" property definition.

        Specifies the name of a password storage scheme which should be used for encoding cached passwords.

        Changing the password storage scheme will cause all existing cached passwords to be discarded.

        Returns:
        Returns the "cached-password-storage-scheme" property definition.

      • getCachedPasswordTtlPropertyDefinition

        public DurationPropertyDefinition getCachedPasswordTtlPropertyDefinition()
        Get the "cached-password-ttl" property definition.

        Specifies the maximum length of time that a locally cached password may be used for authentication before it is refreshed from the remote LDAP service.

        This property represents a cache timeout. Increasing the timeout period decreases the frequency that bind operations are delegated to the remote LDAP service, but increases the risk of users authenticating using stale passwords. Note that authentication attempts which fail because the provided password does not match the locally cached password will always be retried against the remote LDAP service.

        Returns:
        Returns the "cached-password-ttl" property definition.

      • getConnectionTimeoutPropertyDefinition

        public DurationPropertyDefinition getConnectionTimeoutPropertyDefinition()
        Get the "connection-timeout" property definition.

        Specifies the timeout used when connecting to remote LDAP directory servers, performing SSL negotiation, and for individual search and bind requests.

        If the timeout expires then the current operation will be aborted and retried against another LDAP server if one is available.

        Returns:
        Returns the "connection-timeout" property definition.

      • getJavaClassPropertyDefinition

        public ClassPropertyDefinition getJavaClassPropertyDefinition()
        Get the "java-class" property definition.

        Specifies the fully-qualified name of the Java class which provides the LDAP Pass Through Authentication Policy implementation.

        Returns:
        Returns the "java-class" property definition.

      • getMappedAttributePropertyDefinition

        public AttributeTypePropertyDefinition getMappedAttributePropertyDefinition()
        Get the "mapped-attribute" property definition.

        Specifies one or more attributes in the user's entry whose value(s) will determine the bind DN used when authenticating to the remote LDAP directory service. This property is mandatory when using the "mapped-bind" or "mapped-search" mapping policies.

        At least one value must be provided. All values must refer to the name or OID of an attribute type defined in the directory server schema. At least one of the named attributes must exist in a user's local entry in order for authentication to proceed. When multiple attributes or values are found in the user's entry then the behavior is determined by the mapping policy.

        Returns:
        Returns the "mapped-attribute" property definition.

      • getMappedSearchBaseDnPropertyDefinition

        public DnPropertyDefinition getMappedSearchBaseDnPropertyDefinition()
        Get the "mapped-search-base-dn" property definition.

        Specifies the set of base DNs below which to search for users in the remote LDAP directory service. This property is mandatory when using the "mapped-search" mapping policy.

        If multiple values are given, searches are performed below all specified base DNs.

        Returns:
        Returns the "mapped-search-base-dn" property definition.

      • getMappedSearchBindDnPropertyDefinition

        public DnPropertyDefinition getMappedSearchBindDnPropertyDefinition()
        Get the "mapped-search-bind-dn" property definition.

        Specifies the bind DN which should be used to perform user searches in the remote LDAP directory service.

        Returns:
        Returns the "mapped-search-bind-dn" property definition.

      • getMappedSearchBindPasswordPropertyDefinition

        public StringPropertyDefinition getMappedSearchBindPasswordPropertyDefinition()
        Get the "mapped-search-bind-password" property definition.

        Specifies the bind password which should be used to perform user searches in the remote LDAP directory service.

        Returns:
        Returns the "mapped-search-bind-password" property definition.

      • getMappedSearchFilterTemplatePropertyDefinition

        public StringPropertyDefinition getMappedSearchFilterTemplatePropertyDefinition()
        Get the "mapped-search-filter-template" property definition.

        If defined, overrides the filter used when searching for the user, substituting %s with the value of the local entry's "mapped-attribute".

        The filter-template may include ZERO or ONE %s substitutions. If multiple mapped-attributes are configured, multiple renditions of this template will be aggregated into one larger filter using an OR (|) operator. An example use-case for this property would be to use a different attribute type on the mapped search. For example, mapped-attribute could be set to "uid" and filter-template to "(samAccountName=%s)". You can also use the filter to restrict search results. For example: " (&(uid=%s)(objectclass=student))"

        Returns:
        Returns the "mapped-search-filter-template" property definition.

      • getPrimaryRemoteLdapServerPropertyDefinition

        public HostPortPropertyDefinition getPrimaryRemoteLdapServerPropertyDefinition()
        Get the "primary-remote-ldap-server" property definition.

        Specifies the primary list of remote LDAP servers which should be used for pass through authentication.

        If more than one LDAP server is specified then operations may be distributed across them. If all of the primary LDAP servers are unavailable then operations will fail-over to the set of secondary LDAP servers, if defined. When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Returns:
        Returns the "primary-remote-ldap-server" property definition.

      • getSecondaryRemoteLdapServerPropertyDefinition

        public HostPortPropertyDefinition getSecondaryRemoteLdapServerPropertyDefinition()
        Get the "secondary-remote-ldap-server" property definition.

        Specifies the secondary list of remote LDAP servers which should be used for pass through authentication in the event that the primary LDAP servers are unavailable.

        If more than one LDAP server is specified then operations may be distributed across them. Operations will be rerouted to the primary LDAP servers as soon as they are determined to be available. When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Returns:
        Returns the "secondary-remote-ldap-server" property definition.

      • getSourceAddressPropertyDefinition

        public HostPropertyDefinition getSourceAddressPropertyDefinition()
        Get the "source-address" property definition.

        If specified, the server will bind to the address before connecting to the remote server.

        The address must be one assigned to an existing network interface.

        Returns:
        Returns the "source-address" property definition.

      • getSslCipherSuitePropertyDefinition

        public StringPropertyDefinition getSslCipherSuitePropertyDefinition()
        Get the "ssl-cipher-suite" property definition.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL based LDAP connections.

        Returns:
        Returns the "ssl-cipher-suite" property definition.

      • getSslProtocolPropertyDefinition

        public StringPropertyDefinition getSslProtocolPropertyDefinition()
        Get the "ssl-protocol" property definition.

        Specifies the names of the SSL protocols which are allowed for use in SSL based LDAP connections.

        Returns:
        Returns the "ssl-protocol" property definition.

      • getTrustManagerProviderPropertyDefinition

        public AggregationPropertyDefinition<TrustManagerProviderCfgClient,​TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()
        Get the "trust-manager-provider" property definition.

        Specifies the name of the trust manager that should be used when negotiating SSL connections with remote LDAP directory servers.

        Returns:
        Returns the "trust-manager-provider" property definition.

      • getUsePasswordCachingPropertyDefinition

        public BooleanPropertyDefinition getUsePasswordCachingPropertyDefinition()
        Get the "use-password-caching" property definition.

        Indicates whether passwords should be cached locally within the user's entry.

        Returns:
        Returns the "use-password-caching" property definition.

      • getUseSslPropertyDefinition

        public BooleanPropertyDefinition getUseSslPropertyDefinition()
        Get the "use-ssl" property definition.

        Indicates whether the LDAP Pass Through Authentication Policy should use SSL.

        If enabled, the LDAP Pass Through Authentication Policy will use SSL to encrypt communication with the clients.

        Returns:
        Returns the "use-ssl" property definition.

      • getUseTcpKeepAlivePropertyDefinition

        public BooleanPropertyDefinition getUseTcpKeepAlivePropertyDefinition()
        Get the "use-tcp-keep-alive" property definition.

        Indicates whether LDAP connections should use TCP keep-alive.

        If enabled, the SO_KEEPALIVE socket option is used to indicate that TCP keepalive messages should periodically be sent to the client to verify that the associated connection is still valid. This may also help prevent cases in which intermediate network hardware could silently drop an otherwise idle client connection, provided that the keepalive interval configured in the underlying operating system is smaller than the timeout enforced by the network hardware.

        Returns:
        Returns the "use-tcp-keep-alive" property definition.

      • getUseTcpNoDelayPropertyDefinition

        public BooleanPropertyDefinition getUseTcpNoDelayPropertyDefinition()
        Get the "use-tcp-no-delay" property definition.

        Indicates whether LDAP connections should use TCP no-delay.

        If enabled, the TCP_NODELAY socket option is used to ensure that response messages to the client are sent immediately rather than potentially waiting to determine whether additional response messages can be sent in the same packet. In most cases, using the TCP_NODELAY socket option provides better performance and lower response times, but disabling it may help for some cases in which the server sends a large number of entries to a client in response to a search request.

        Returns:
        Returns the "use-tcp-no-delay" property definition.