module ROM::LDAP

Constants

ABSTRACTS

@return [Array]

ALL_ATTRS

@return [Array<String>]

BIN_FILE_REGEX

Local file path

@return [Regexp]

BOOLEAN_MATCHERS

@return [Array<String>]

@api private

BindError

@see Client::Authentication#bind

CONNECTION_FAILURES

@see ROM::LDAP::Gateway

@see ROM::LDAP::Schema::Inferrer

CONSTRUCTORS

Internal abstraction of LDAP string search filter constructors.

@see www.rfc-editor.org/rfc/rfc4515.txt String Search Filter Definition

@return [Hash]

CONSTRUCTOR_REGEX
ConnectionError

@see Socket#connect

DEFAULT_FILTER

@return [String]

DEFAULT_FORMATTER

Proc that returns input value.

DEFAULT_PK

@return [String]

DEREF_ALL

Array of all dereferencing modes

DEREF_ALWAYS

Always dereference aliases both in searching and in locating the base object of the search. is the default behavior.

DEREF_FIND

Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object.

DEREF_NEVER

Do not dereference aliases in searching or in locating the base object of the search.

While searching subordinates of the base object, dereference any alias within the search scope.

DN_REGEX

Any word character or hyphen, equals

@return [Regexp]

DistinguishedNameError

@see Directory::Operations#find, by_dn, add

ESCAPES

DSL dataset methods

@see RFC4515 value encoding rule.

@return [Hash]

ESCAPE_REGEX

@return [Regexp]

EXTENSIBLE_REGEX

Expression Encoder (1)type (2)dn (4)rule

<attribute name>:<matching rule OID>:=<value> (&(objectCategory=group)(groupType:1.2.840.113556.1.4.803:=2147483648))

@return [Regexp]

FILTER_REGEX

Something in parentheses

@return [Regexp]

INTEGER_MATCHERS

@return [Array<String>]

@api private

LDAPURI_REGEX

Matches an ldap(s) url

@return [Regexp]

LDIF_LINE_REGEX

$1 = attribute $3 = value

MAJOR

The major version of ROM-LDAP. Only bumped for major changes.

MINOR

The minor version of ROM-LDAP. Bumped for every non-patch level release.

MessageQueue
NEW_LINE

@return [String]

OID

LDAP OID hash map

@see oid-info.com/get/{{OID}} @see ldap.com/ldap-oid-reference-guide/ @see ldapwiki.com/wiki/LDAP%20Extensions%20and%20Controls%20Listing

@return [Hash]

@api private

OID_TYPE_MAP

LDAPv3 Syntaxes

@see ldapwiki.com/wiki/LDAPSyntaxes

OPERATORS

Internal abstraction of LDAP string search filter operators.

@return [Hash]

@see www.rfc-editor.org/rfc/rfc4515.txt String Search Filter Definition

equal          = EQUALS
approx         = TILDE EQUALS
greaterorequal = RANGLE EQUALS
lessorequal    = LANGLE EQUALS
extensible     = ( attr [dnattrs]
                     [matchingrule] COLON EQUALS assertionvalue )
                 / ( [dnattrs]
                      matchingrule COLON EQUALS assertionvalue )
OPERATOR_REGEX
OP_ATTRS

@return [Array<String>]

PERCENT_SPACE

@return [String]

PasswordError

@see Directory::Password#generate

RESPONSES
RESPONSES_PATH

Loaded by PDU

@see tools.ietf.org/html/rfc4511#section-4.1.9

ResponseError

@see Client#submit

SCOPES
SCOPE_BASE

Search Scope

@see ldapwiki.com/wiki/LDAP%20Search%20Scopes

Constrained to the entry named by baseObject.

SCOPE_ONE
SCOPE_SUB
SINCE_1601

@return [Integer]

@see Functions.to_time

SPACE

@return [String]

STRING_MATCHERS

Type Builder

@see ldap.com/matching-rules/

Matching Rules - 2.5.13

@return [Array<String>]

@api private

SUCCESS_CODES

@see PDU

@return [Array<Symbol>]

SecureBindError

@see Client::Authentication#sasl_bind

TEN_MILLION

Time conversion

@return [Integer]

@see Functions.to_time

TIMESTAMPS

@return [Array<String>]

@example [Schema]

use :timestamps,
  attributes: %i(create_timestamp modify_timestamp),
  type: ROM::LDAP::Types::Time

@see Relation#operational

TIME_MATCHERS

@return [Array<String>]

@api private

TINY

The tiny version of ROM-LDAP. Only bumped for bugfix releases.

UNESCAPE_REGEX

ESC and HEX values

The value encoding rule ensures that the entire filter string is a valid UTF-8 string and provides that the octets that represent theses ESCAPES are represented as a backslash followed by the two hexadecimal digits representing the value of the encoded octet.

VALUES_MAP

Symbolic abstraction of LDIF booleans and wildcard matcher

@return [Hash]

VAL_REGEX

@return [Regexp]

VERSION

The version of ROM-LDAP, as a string (e.g. “2.11.0”)

WILDCARD

@return [String]

Public Class Methods

formatter() click to toggle source

@see 'rom/ldap/extensions/compatibility'

@example

ROM::LDAP.load_extensions :compatibility
# File lib/rom/ldap/formatter.rb, line 22
def self.formatter
  @formatter || DEFAULT_FORMATTER
end
use_formatter(func = nil) click to toggle source

Set/Reset the formatting proc

@param func [Proc] Callable object

# File lib/rom/ldap/formatter.rb, line 13
def self.use_formatter(func = nil)
  @formatter = func
end

Public Instance Methods

LDIF(ldif, &block) click to toggle source

Parser for LDIF format rubocop:disable Naming/MethodName

alias for LDIF.to_tuples

@api public

# File lib/rom/ldap/ldif.rb, line 69
def LDIF(ldif, &block)
  LDIF.to_tuples(ldif, &block)
end