xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • ldap
  • ldap_Token
  • sspi
  • sspi_Token
  • storage
  • storage_Token

Class ldap

LDAP bind-based authentication driver. Verifies user credentials against a v3 LDAP server using the server bind method.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Authentication
Extended by Core\Authentication\Driver\ldap
Namespace: Core\Authentication\Driver
Package: Core\Authentication
Since: 3.0
Requires: PHP 5.3, LDAP extension
Version: 1.2
Located at Authentication/Driver/ldap.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Parameters

$uri
Authentication driver description from factory.

Throws

Core\Exception\InvalidArgument
Target object for auto-chaining does not implement Chainable.
Core\Exception\MissingParameter
A mandatory parameter is missing.
Core\Exception\Parameter
Invalid value for enumeration parameter.

Since

3.0

Overrides

Core\Authentication::__construct
protected Core\Authentication_Token|false
# _validate( array $credentials )

Driver implementation of user credentials verification.

Driver implementation of user credentials verification.

Parameters

$credentials

Associative array of user credentials. Contains at least the following entries:

  • string user

    The username to verify.

  • string password

    The provided password or password hash to verify.

  • string domain

    The domain name to verify credentials for.

Returns

Core\Authentication_Token|false

Token instance for the specified user on success, otherwise false. Set the status and status message properties to provide additional information on why authentication failed.

If the back-end encounters a fatal error, it might throw an exception.

Since

3.0
public string
# encodeDN( array $credentials )

Expands and encodes the DN from user credentials.

Expands and encodes the DN from user credentials.

Parameters

$credentials
Credentials from verification method.

Returns

string
Expanded DN of user to verify.

Since

3.0
public string
# encodeDN_expand( string $value, string $delimiter, string $rdn )

Expands RDN fragments based on a value and delimiter.

Expands RDN fragments based on a value and delimiter.

Parameters

$value
Value to split using given delimiter.
$delimiter
Delimiter to split value by.
$rdn
RDN for assignment of each value fragment.

Returns

string
Comma-separated list of expanded RDN fragments.

Since

3.0
public string
# encodeString( string $str )

Encodes a string for use as a DN fragment parameter.

Encodes a string for use as a DN fragment parameter.

Parameters

$str
String to encode.

Returns

string

Encoded string with every character not being a letter, number, dot or dash being replaced by the corresponding hexadecimal escape sequence.

Since

3.0

Methods inherited from Core\Authentication

_validatePassword(), autocreate(), chain(), perform(), verify()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

integer DefaultPort

Default LDAP server port used if not defined.

Default LDAP server port used if not defined.

Since

3.1
# 389

Constants inherited from Core\Authentication

AllowEmptyPasswordParameter, AllowEmptyUsernameParameter, FieldSelectorParameter, InvalidCredentials, PasswordEncryptionParameter, Success, TemporaryFailure, UnknownIdentifier

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected string $_v_host

LDAP server hostname.

LDAP server hostname.

Since

3.0
#
protected integer $_v_port

LDAP server port.

LDAP server port.

Since

3.0
# self::DefaultPort
protected string $_v_dn

Search base DN.

Search base DN.

Since

3.0
#

Properties inherited from Core\Authentication

$_v_parameters, $_v_status, $_v_statusMessage, $_v_successor

Magic properties

public read-only string $host

Hostname of LDAP server from driver configuration URI.
public read-only integer $port

Port of LDAP server from driver configuration URI.
public read-only string $dn

Search base DN from driver configuration URI.

Magic properties inherited from Core\Authentication

$parameters, $status, $statusMessage, $successor

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen