/sources/ocf_ldap.php

Description
Description | Functions
Functions
Description | Functions
clean_cn (line 738)

Remove potential noise from a CN (strange).

  • return: The cleaned one.
string clean_cn (string $cn)
  • string $cn: The potentially noisy one.
get_group_class (line 99)

The LDAP class indicating a group.

  • return: The property.
string get_group_class ()
get_mapped_admin_group (line 119)

The LDAP group that maps to the first administrative group in ocPortal (db_get_first_id()+1).

  • return: The group.
string get_mapped_admin_group ()
get_mapped_users_group (line 109)

The LDAP group that maps to the default ocPortal group.

  • return: The group.
string get_mapped_users_group ()
get_member_class (line 67)

The LDAP class indicating an account.

  • return: The property.
string get_member_class ()
group_property (line 89)

The group naming property LDAP will be using.

  • return: The property.
string group_property ()
group_search_qualifier (line 77)

Where in the LDAP hierarchy to search for members.

  • return: The property.
string group_search_qualifier ()
member_property (line 57)

The property in LDAP used for logins.

  • return: The property.
string member_property ()
member_search_qualifier (line 45)

Where in the LDAP hierarchy to search for groups.

  • return: The property.
string member_search_qualifier ()
ocf_get_all_ldap_groups (line 385)

Get a list of usergroups on the LDAP server.

  • return: The list of user-groups (string).
array ocf_get_all_ldap_groups ()
ocf_get_group_members_raw_ldap (line 486)

(LDAP helper for ocf_get_group_members_raw) Get a list of members in a group (or more full details if $non_validated is true).

void ocf_get_group_members_raw_ldap (array &$members, GROUP $group_id, boolean $include_primaries, boolean $non_validated, boolean $include_secondaries)
  • array &$members: The list is written into this.
  • GROUP $group_id: The ID of the usergroup.
  • boolean $include_primaries: Whether to include those in the usergroup as a primary member.
  • boolean $non_validated: Whether to include those applied to join the usergroup, but not validated in.
  • boolean $include_secondaries: Whether to include those in the usergroup as a secondary member.
ocf_get_ldap_hash (line 226)

Find the LDAP servers password for a certain member.

  • return: The password (NULL: no such user).
?string ocf_get_ldap_hash (string $cn)
  • string $cn: The username.
ocf_get_members_groups_ldap (line 578)

(LDAP helper for ocf_get_members_groups) Get a list of the usergroups a member is in (keys say the usergroups, values are irrelevant).

  • return: The list (e.g. array(1=>1,2=>1,3=>1) for someone in (1,2,3)). The keys are all that matters, values are arbitrary.
array ocf_get_members_groups_ldap (?MEMBER $member_id)
  • ?MEMBER $member_id: The member to find the usergroups of (NULL: current member).
ocf_group_ldapcn_to_ldapgid (line 721)

Find the LDAP ID for a named LDAP usergroup. POSIX Only.

  • return: The LDAP usergroup ID (NULL: none).
?integer ocf_group_ldapcn_to_ldapgid (string $cn)
  • string $cn: The named LDAP usergroup.
ocf_group_ldapcn_to_ocfid (line 425)

Find the ocPortal-ID for a named LDAP usergroup.

  • return: The ocPortal-ID (NULL: none).
?GROUP ocf_group_ldapcn_to_ocfid (string $cn)
  • string $cn: The usergroup.
ocf_group_ldapgid_to_ocfid (line 697)

Find the ocPortal-ID for an LDAP usergroup-ID. POSIX Only.

  • return: The ocPortal-ID (NULL: could not find).
?GROUP ocf_group_ldapgid_to_ocfid (integer $gid)
  • integer $gid: The LDAP ID.
ocf_group_ocfid_to_ldapcn (line 446)

Find the named LDAP usergroup for an OCF ID. Note that the returned MAY NOT ACTUALLY EXIST!

  • return: The named LDAP usergroup (NULL: none).
?SHORT_TEXT ocf_group_ocfid_to_ldapcn (GROUP $id)
  • GROUP $id: The OCF ID.
ocf_is_ldap_member_potential (line 134)

Find whether a member of a certain username WOULD be bound to LDAP authentication (an exceptional situation, only for sites that use it).

  • return: The answer.
boolean ocf_is_ldap_member_potential (string $cn)
  • string $cn: The username.
ocf_is_on_ldap (line 201)

Find whether a member exists on the LDAP server.

  • return: The answer.
boolean ocf_is_on_ldap (SHORT_TEXT $cn)
  • SHORT_TEXT $cn: The username.
ocf_ldap_authorise_login (line 297)

Authorise an LDAP login.

  • return: Part of the member row to put back in and authorise normally (hackerish, but it works kind of like a filter / stage in a chain).
array ocf_ldap_authorise_login (string $cn, ?string $password)
  • string $cn: The username.
  • ?string $password: The password (NULL: no such user).
ocf_ldap_bind (line 149)

Performs the OCF LDAP connection bind, used to do general querying (not a user login).

void ocf_ldap_bind ()
ocf_ldap_connect (line 26)

Set up the OCF LDAP connection.

void ocf_ldap_connect ()
ocf_ldap_get_member_primary_group (line 654)

Get the primary usergroup of a member in LDAP.

  • return: The.
GROUP ocf_ldap_get_member_primary_group (MEMBER $member_id)
  • MEMBER $member_id: The member.
ocf_ldap_guess_email (line 462)

Get the e-mail of a member in LDAP.

  • return: Guessed e-mail address (blank: couldn't find).
SHORT_TEXT ocf_ldap_guess_email (ID_TEXT $cn)
  • ID_TEXT $cn: The CN of the member.
ocf_ldap_hash (line 258)

Convert a plain-text password into a hashed password.

  • return: The hashed password.
string ocf_ldap_hash (string $cn, string $password)
  • string $cn: The username (we use this to extract the hash algorithm being used by the member).
  • string $password: The password.
ocf_long_cn_to_short_cn (line 750)

Converts an active directory style long-CN to a short one.

  • return: The short one.
string ocf_long_cn_to_short_cn (string $long, string $type)
  • string $long: The long one.
  • string $type: The type (e.g. CN, DN).
ocf_member_ldapcn_to_ocfid (line 358)

Find the ocPortal member-ID for an LDAP username.

  • return: The ocPortal member-ID (NULL: none).
?integer ocf_member_ldapcn_to_ocfid (string $cn)
  • string $cn: The username.
ocf_member_ocfid_to_ldapcn (line 372)

Find the LDAP username for an ocPortal member-ID.

  • return: The username (NULL: none).
?SHORT_TEXT ocf_member_ocfid_to_ldapcn (integer $id)
  • integer $id: The ocPortal member-ID.

Documentation generated on Sun, 02 Jan 2011 23:19:52 +0000 by phpDocumentor 1.4.3