nextcloud/lib/public/LDAP/ILDAPProvider.php

162 lines
4.3 KiB
PHP
Raw Normal View History

2016-07-22 11:46:29 +03:00
<?php
/**
2016-07-28 10:13:00 +03:00
* @copyright Copyright (c) 2016, Roger Szabo (roger.szabo@web.de)
2016-07-22 11:46:29 +03:00
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Roger Szabo <roger.szabo@web.de>
* @author root <root@localhost.localdomain>
* @author Vinicius Cubas Brand <vinicius@eita.org.br>
*
2016-07-28 10:13:00 +03:00
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
2016-07-22 11:46:29 +03:00
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2016-07-28 10:13:00 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2016-07-22 11:46:29 +03:00
* GNU Affero General Public License for more details.
*
2016-07-28 10:13:00 +03:00
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2016-07-22 11:46:29 +03:00
*
*/
namespace OCP\LDAP;
/**
* Interface ILDAPProvider
*
* @package OCP\LDAP
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
interface ILDAPProvider {
/**
2016-07-27 10:10:35 +03:00
* Translate a user id to LDAP DN.
* @param string $uid user id
2016-07-22 11:46:29 +03:00
* @return string
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function getUserDN($uid);
/**
* Translate a group id to LDAP DN.
* @param string $gid group id
* @return string
* @since 13.0.0
*/
public function getGroupDN($gid);
2016-07-22 11:46:29 +03:00
/**
2016-07-27 10:10:35 +03:00
* Translate a LDAP DN to an internal user name.
2016-07-22 11:46:29 +03:00
* @param string $dn LDAP DN
2016-07-27 10:10:35 +03:00
* @return string with the internal user name
2016-07-22 11:46:29 +03:00
* @throws \Exception if translation was unsuccessful
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function getUserName($dn);
/**
* Convert a stored DN so it can be used as base parameter for LDAP queries.
* @param string $dn the DN
* @return string
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function DNasBaseParameter($dn);
/**
* Sanitize a DN received from the LDAP server.
* @param array $dn the DN in question
* @return array the sanitized DN
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function sanitizeDN($dn);
/**
* Return a new LDAP connection resource for the specified user.
2016-07-27 10:10:35 +03:00
* @param string $uid user id
2016-07-22 11:46:29 +03:00
* @return resource of the LDAP connection
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function getLDAPConnection($uid);
/**
* Return a new LDAP connection resource for the specified group.
* @param string $gid group id
* @return resource of the LDAP connection
* @since 13.0.0
*/
public function getGroupLDAPConnection($gid);
2016-07-22 11:46:29 +03:00
/**
* Get the LDAP base for users.
2016-07-27 10:10:35 +03:00
* @param string $uid user id
2016-07-22 11:46:29 +03:00
* @return string the base for users
* @throws \Exception if user id was not found in LDAP
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function getLDAPBaseUsers($uid);
/**
* Get the LDAP base for groups.
2016-07-27 10:10:35 +03:00
* @param string $uid user id
2016-07-22 11:46:29 +03:00
* @return string the base for groups
* @throws \Exception if user id was not found in LDAP
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function getLDAPBaseGroups($uid);
/**
* Check whether a LDAP DN exists
* @param string $dn LDAP DN
* @return bool whether the DN exists
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function dnExists($dn);
/**
* Clear the cache if a cache is used, otherwise do nothing.
2016-07-27 10:10:35 +03:00
* @param string $uid user id
* @since 11.0.0
2016-07-22 11:46:29 +03:00
*/
public function clearCache($uid);
/**
* Clear the cache if a cache is used, otherwise do nothing.
* @param string $gid group id
* @since 13.0.0
*/
public function clearGroupCache($gid);
/**
* Get the LDAP attribute name for the user's display name
* @param string $uid user id
* @return string the display name field
* @throws \Exception if user id was not found in LDAP
* @since 12.0.0
*/
public function getLDAPDisplayNameField($uid);
/**
* Get the LDAP attribute name for the email
* @param string $uid user id
* @return string the email field
* @throws \Exception if user id was not found in LDAP
* @since 12.0.0
*/
public function getLDAPEmailField($uid);
/**
* Get the LDAP attribute name for the type of association betweeen users and groups
* @param string $gid group id
* @return string the configuration, one of: 'memberUid', 'uniqueMember', 'member', 'gidNumber', ''
* @throws \Exception if group id was not found in LDAP
* @since 13.0.0
*/
public function getLDAPGroupMemberAssoc($gid);
2016-07-22 11:46:29 +03:00
}