nextcloud / server

lib/public/IUserSession.php

Indentation +36 added lines, -36 removed lines

@@ -40,44 +40,44 @@
  * @since 6.0.0
  */
 interface IUserSession {
-	/**
-	 * Do a user login
-	 * @param string $user the username
-	 * @param string $password the password
-	 * @return bool true if successful
-	 * @since 6.0.0
-	 */
-	public function login($user, $password);
+    /**
+     * Do a user login
+     * @param string $user the username
+     * @param string $password the password
+     * @return bool true if successful
+     * @since 6.0.0
+     */
+    public function login($user, $password);
 
-	/**
-	 * Logs the user out including all the session data
-	 * Logout, destroys session
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function logout();
+    /**
+     * Logs the user out including all the session data
+     * Logout, destroys session
+     * @return void
+     * @since 6.0.0
+     */
+    public function logout();
 
-	/**
-	 * set the currently active user
-	 *
-	 * @param \OCP\IUser|null $user
-	 * @since 8.0.0
-	 */
-	public function setUser($user);
+    /**
+     * set the currently active user
+     *
+     * @param \OCP\IUser|null $user
+     * @since 8.0.0
+     */
+    public function setUser($user);
 
-	/**
-	 * get the current active user
-	 *
-	 * @return \OCP\IUser|null Current user, otherwise null
-	 * @since 8.0.0
-	 */
-	public function getUser();
+    /**
+     * get the current active user
+     *
+     * @return \OCP\IUser|null Current user, otherwise null
+     * @since 8.0.0
+     */
+    public function getUser();
 
-	/**
-	 * Checks whether the user is logged in
-	 *
-	 * @return bool if logged in
-	 * @since 8.0.0
-	 */
-	public function isLoggedIn();
+    /**
+     * Checks whether the user is logged in
+     *
+     * @return bool if logged in
+     * @since 8.0.0
+     */
+    public function isLoggedIn();
 }

lib/public/IDateTimeZone.php

Indentation +6 added lines, -6 removed lines

@@ -30,10 +30,10 @@
  * @since 8.0.0
  */
 interface IDateTimeZone {
-	/**
-	 * @param bool|int $timestamp
-	 * @return \DateTimeZone
-	 * @since 8.0.0 - parameter $timestamp was added in 8.1.0
-	 */
-	public function getTimeZone($timestamp = false);
+    /**
+     * @param bool|int $timestamp
+     * @return \DateTimeZone
+     * @since 8.0.0 - parameter $timestamp was added in 8.1.0
+     */
+    public function getTimeZone($timestamp = false);
 }

lib/public/Security/StringUtils.php

Indentation +14 added lines, -14 removed lines

@@ -31,18 +31,18 @@
  * @since 8.0.0
  */
 class StringUtils {
-	/**
-	 * Compares whether two strings are equal. To prevent guessing of the string
-	 * length this is done by comparing two hashes against each other and afterwards
-	 * a comparison of the real string to prevent against the unlikely chance of
-	 * collisions.
-	 * @param string $expected The expected value
-	 * @param string $input The input to compare against
-	 * @return bool True if the two strings are equal, otherwise false.
-	 * @since 8.0.0
-	 * @deprecated 9.0.0 Use hash_equals
-	 */
-	public static function equals($expected, $input) {
-		return hash_equals($expected, $input);
-	}
+    /**
+     * Compares whether two strings are equal. To prevent guessing of the string
+     * length this is done by comparing two hashes against each other and afterwards
+     * a comparison of the real string to prevent against the unlikely chance of
+     * collisions.
+     * @param string $expected The expected value
+     * @param string $input The input to compare against
+     * @return bool True if the two strings are equal, otherwise false.
+     * @since 8.0.0
+     * @deprecated 9.0.0 Use hash_equals
+     */
+    public static function equals($expected, $input) {
+        return hash_equals($expected, $input);
+    }
 }

lib/public/Security/ICredentialsManager.php

Indentation +35 added lines, -35 removed lines

@@ -30,43 +30,43 @@
  */
 interface ICredentialsManager {
 
-	/**
-	 * Store a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @param mixed $credentials
-	 * @since 8.2.0
-	 */
-	public function store($userId, $identifier, $credentials);
+    /**
+     * Store a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @param mixed $credentials
+     * @since 8.2.0
+     */
+    public function store($userId, $identifier, $credentials);
 
-	/**
-	 * Retrieve a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function retrieve($userId, $identifier);
+    /**
+     * Retrieve a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function retrieve($userId, $identifier);
 
-	/**
-	 * Delete a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function delete($userId, $identifier);
+    /**
+     * Delete a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function delete($userId, $identifier);
 
-	/**
-	 * Erase all credentials stored for a user
-	 *
-	 * @param string $userId
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function erase($userId);
+    /**
+     * Erase all credentials stored for a user
+     *
+     * @param string $userId
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function erase($userId);
 
 }

lib/public/Security/IHasher.php

Indentation +18 added lines, -18 removed lines

@@ -44,23 +44,23 @@
  * @since 8.0.0
  */
 interface IHasher {
-	/**
-	 * Hashes a message using PHP's `password_hash` functionality.
-	 * Please note that the size of the returned string is not guaranteed
-	 * and can be up to 255 characters.
-	 *
-	 * @param string $message Message to generate hash from
-	 * @return string Hash of the message with appended version parameter
-	 * @since 8.0.0
-	 */
-	public function hash($message);
+    /**
+     * Hashes a message using PHP's `password_hash` functionality.
+     * Please note that the size of the returned string is not guaranteed
+     * and can be up to 255 characters.
+     *
+     * @param string $message Message to generate hash from
+     * @return string Hash of the message with appended version parameter
+     * @since 8.0.0
+     */
+    public function hash($message);
 
-	/**
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
-	 * @return bool Whether $hash is a valid hash of $message
-	 * @since 8.0.0
-	 */
-	public function verify($message, $hash, &$newHash = null);
+    /**
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
+     * @return bool Whether $hash is a valid hash of $message
+     * @since 8.0.0
+     */
+    public function verify($message, $hash, &$newHash = null);
 }

lib/public/Security/IContentSecurityPolicyManager.php

Indentation +18 added lines, -18 removed lines

@@ -30,22 +30,22 @@
  * @since 9.0.0
  */
 interface IContentSecurityPolicyManager {
-	/**
-	 * Allows to inject something into the default content policy. This is for
-	 * example useful when you're injecting Javascript code into a view belonging
-	 * to another controller and cannot modify its Content-Security-Policy itself.
-	 * Note that the adjustment is only applied to applications that use AppFramework
-	 * controllers.
-	 *
-	 * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
-	 * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
-	 *
-	 * WARNING: Using this API incorrectly may make the instance more insecure.
-	 * Do think twice before adding whitelisting resources. Please do also note
-	 * that it is not possible to use the `disallowXYZ` functions.
-	 *
-	 * @param EmptyContentSecurityPolicy $policy
-	 * @since 9.0.0
-	 */
-	public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
+    /**
+     * Allows to inject something into the default content policy. This is for
+     * example useful when you're injecting Javascript code into a view belonging
+     * to another controller and cannot modify its Content-Security-Policy itself.
+     * Note that the adjustment is only applied to applications that use AppFramework
+     * controllers.
+     *
+     * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
+     * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
+     *
+     * WARNING: Using this API incorrectly may make the instance more insecure.
+     * Do think twice before adding whitelisting resources. Please do also note
+     * that it is not possible to use the `disallowXYZ` functions.
+     *
+     * @param EmptyContentSecurityPolicy $policy
+     * @since 9.0.0
+     */
+    public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
 }

lib/public/Security/ICrypto.php

Indentation +24 added lines, -24 removed lines

@@ -36,30 +36,30 @@
  */
 interface ICrypto {
 
-	/**
-	 * @param string $message The message to authenticate
-	 * @param string $password Password to use (defaults to `secret` in config.php)
-	 * @return string Calculated HMAC
-	 * @since 8.0.0
-	 */
-	public function calculateHMAC($message, $password = '');
+    /**
+     * @param string $message The message to authenticate
+     * @param string $password Password to use (defaults to `secret` in config.php)
+     * @return string Calculated HMAC
+     * @since 8.0.0
+     */
+    public function calculateHMAC($message, $password = '');
 
-	/**
-	 * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
-	 * @param string $plaintext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string Authenticated ciphertext
-	 * @since 8.0.0
-	 */
-	public function encrypt($plaintext, $password = '');
+    /**
+     * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
+     * @param string $plaintext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string Authenticated ciphertext
+     * @since 8.0.0
+     */
+    public function encrypt($plaintext, $password = '');
 
-	/**
-	 * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
-	 * @param string $authenticatedCiphertext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string plaintext
-	 * @throws \Exception If the HMAC does not match
-	 * @since 8.0.0
-	 */
-	public function decrypt($authenticatedCiphertext, $password = '');
+    /**
+     * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
+     * @param string $authenticatedCiphertext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string plaintext
+     * @throws \Exception If the HMAC does not match
+     * @since 8.0.0
+     */
+    public function decrypt($authenticatedCiphertext, $password = '');
 }

lib/public/Federation/ICloudId.php

Indentation +28 added lines, -28 removed lines

@@ -26,35 +26,35 @@
  * @since 12.0.0
  */
 interface ICloudId {
-	/**
-	 * The remote cloud id
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getId();
+    /**
+     * The remote cloud id
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get a clean representation of the cloud id for display
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getDisplayId();
+    /**
+     * Get a clean representation of the cloud id for display
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getDisplayId();
 
-	/**
-	 * The username on the remote server
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getUser();
+    /**
+     * The username on the remote server
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getUser();
 
-	/**
-	 * The base address of the remote server
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getRemote();
+    /**
+     * The base address of the remote server
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getRemote();
 }

lib/public/IUserManager.php

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	 * remove all user backends
 	 * @since 8.0.0
 	 */
-	public function clearBackends() ;
+	public function clearBackends();
 
 	/**
 	 * get a user by user id

Indentation +141 added lines, -141 removed lines

@@ -41,145 +41,145 @@
  * @since 8.0.0
  */
 interface IUserManager {
-		/**
-	 * register a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 * @since 8.0.0
-	 */
-	public function registerBackend($backend);
-
-	/**
-	 * Get the active backends
-	 * @return \OCP\UserInterface[]
-	 * @since 8.0.0
-	 */
-	public function getBackends();
-
-	/**
-	 * remove a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 * @since 8.0.0
-	 */
-	public function removeBackend($backend);
-
-	/**
-	 * remove all user backends
-	 * @since 8.0.0
-	 */
-	public function clearBackends() ;
-
-	/**
-	 * get a user by user id
-	 *
-	 * @param string $uid
-	 * @return \OCP\IUser|null Either the user or null if the specified user does not exist
-	 * @since 8.0.0
-	 */
-	public function get($uid);
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function userExists($uid);
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @param string $loginName
-	 * @param string $password
-	 * @return mixed the User object on success, false otherwise
-	 * @since 8.0.0
-	 */
-	public function checkPassword($loginName, $password);
-
-	/**
-	 * search by user id
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IUser[]
-	 * @since 8.0.0
-	 */
-	public function search($pattern, $limit = null, $offset = null);
-
-	/**
-	 * search by displayName
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IUser[]
-	 * @since 8.0.0
-	 */
-	public function searchDisplayName($pattern, $limit = null, $offset = null);
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @throws \InvalidArgumentException
-	 * @return bool|\OCP\IUser the created user of false
-	 * @since 8.0.0
-	 */
-	public function createUser($uid, $password);
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @param UserInterface $backend
-	 * @return IUser|null
-	 * @throws \InvalidArgumentException
-	 * @since 12.0.0
-	 */
-	public function createUserFromBackend($uid, $password, UserInterface $backend);
-
-	/**
-	 * returns how many users per backend exist (if supported by backend)
-	 *
-	 * @return array an array of backend class as key and count number as value
-	 * @since 8.0.0
-	 */
-	public function countUsers();
-
-	/**
-	 * @param \Closure $callback
-	 * @param string $search
-	 * @since 9.0.0
-	 */
-	public function callForAllUsers(\Closure $callback, $search = '');
-
-	/**
-	 * returns how many users have logged in once
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function countDisabledUsers();
-
-	/**
-	 * returns how many users have logged in once
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function countSeenUsers();
-
-	/**
-	 * @param \Closure $callback
-	 * @since 11.0.0
-	 */
-	public function callForSeenUsers(\Closure $callback);
-
-	/**
-	 * @param string $email
-	 * @return IUser[]
-	 * @since 9.1.0
-	 */
-	public function getByEmail($email);
+        /**
+         * register a user backend
+         *
+         * @param \OCP\UserInterface $backend
+         * @since 8.0.0
+         */
+    public function registerBackend($backend);
+
+    /**
+     * Get the active backends
+     * @return \OCP\UserInterface[]
+     * @since 8.0.0
+     */
+    public function getBackends();
+
+    /**
+     * remove a user backend
+     *
+     * @param \OCP\UserInterface $backend
+     * @since 8.0.0
+     */
+    public function removeBackend($backend);
+
+    /**
+     * remove all user backends
+     * @since 8.0.0
+     */
+    public function clearBackends() ;
+
+    /**
+     * get a user by user id
+     *
+     * @param string $uid
+     * @return \OCP\IUser|null Either the user or null if the specified user does not exist
+     * @since 8.0.0
+     */
+    public function get($uid);
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid
+     * @return bool
+     * @since 8.0.0
+     */
+    public function userExists($uid);
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @param string $loginName
+     * @param string $password
+     * @return mixed the User object on success, false otherwise
+     * @since 8.0.0
+     */
+    public function checkPassword($loginName, $password);
+
+    /**
+     * search by user id
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IUser[]
+     * @since 8.0.0
+     */
+    public function search($pattern, $limit = null, $offset = null);
+
+    /**
+     * search by displayName
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IUser[]
+     * @since 8.0.0
+     */
+    public function searchDisplayName($pattern, $limit = null, $offset = null);
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @throws \InvalidArgumentException
+     * @return bool|\OCP\IUser the created user of false
+     * @since 8.0.0
+     */
+    public function createUser($uid, $password);
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @param UserInterface $backend
+     * @return IUser|null
+     * @throws \InvalidArgumentException
+     * @since 12.0.0
+     */
+    public function createUserFromBackend($uid, $password, UserInterface $backend);
+
+    /**
+     * returns how many users per backend exist (if supported by backend)
+     *
+     * @return array an array of backend class as key and count number as value
+     * @since 8.0.0
+     */
+    public function countUsers();
+
+    /**
+     * @param \Closure $callback
+     * @param string $search
+     * @since 9.0.0
+     */
+    public function callForAllUsers(\Closure $callback, $search = '');
+
+    /**
+     * returns how many users have logged in once
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function countDisabledUsers();
+
+    /**
+     * returns how many users have logged in once
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function countSeenUsers();
+
+    /**
+     * @param \Closure $callback
+     * @since 11.0.0
+     */
+    public function callForSeenUsers(\Closure $callback);
+
+    /**
+     * @param string $email
+     * @return IUser[]
+     * @since 9.1.0
+     */
+    public function getByEmail($email);
 }