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/ISecureRandom.php

Indentation +41 added lines, -41 removed lines

@@ -36,49 +36,49 @@
  */
 interface ISecureRandom {
 
-	/**
-	 * Flags for characters that can be used for <code>generate($length, $characters)</code>
-	 */
-	const CHAR_UPPER = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-	const CHAR_LOWER = 'abcdefghijklmnopqrstuvwxyz';
-	const CHAR_DIGITS = '0123456789';
-	const CHAR_SYMBOLS = '!\"#$%&\\\'()* +,-./:;<=>?@[\]^_`{|}~';
+    /**
+     * Flags for characters that can be used for <code>generate($length, $characters)</code>
+     */
+    const CHAR_UPPER = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    const CHAR_LOWER = 'abcdefghijklmnopqrstuvwxyz';
+    const CHAR_DIGITS = '0123456789';
+    const CHAR_SYMBOLS = '!\"#$%&\\\'()* +,-./:;<=>?@[\]^_`{|}~';
 
-	/**
-	 * Convenience method to get a low strength random number generator.
-	 *
-	 * Low Strength should be used anywhere that random strings are needed
-	 * in a non-cryptographical setting. They are not strong enough to be
-	 * used as keys or salts. They are however useful for one-time use tokens.
-	 *
-	 * @return $this
-	 * @since 8.0.0
-	 * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int()
-	 */
-	public function getLowStrengthGenerator();
+    /**
+     * Convenience method to get a low strength random number generator.
+     *
+     * Low Strength should be used anywhere that random strings are needed
+     * in a non-cryptographical setting. They are not strong enough to be
+     * used as keys or salts. They are however useful for one-time use tokens.
+     *
+     * @return $this
+     * @since 8.0.0
+     * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int()
+     */
+    public function getLowStrengthGenerator();
 
-	/**
-	 * Convenience method to get a medium strength random number generator.
-	 *
-	 * Medium Strength should be used for most needs of a cryptographic nature.
-	 * They are strong enough to be used as keys and salts. However, they do
-	 * take some time and resources to generate, so they should not be over-used
-	 *
-	 * @return $this
-	 * @since 8.0.0
-	 * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int()
-	 */
-	public function getMediumStrengthGenerator();
+    /**
+     * Convenience method to get a medium strength random number generator.
+     *
+     * Medium Strength should be used for most needs of a cryptographic nature.
+     * They are strong enough to be used as keys and salts. However, they do
+     * take some time and resources to generate, so they should not be over-used
+     *
+     * @return $this
+     * @since 8.0.0
+     * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int()
+     */
+    public function getMediumStrengthGenerator();
 
-	/**
-	 * Generate a random string of specified length.
-	 * @param int $length The length of the generated string
-	 * @param string $characters An optional list of characters to use if no character list is
-	 * 							specified all valid base64 characters are used.
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function generate($length,
-							 $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/');
+    /**
+     * Generate a random string of specified length.
+     * @param int $length The length of the generated string
+     * @param string $characters An optional list of characters to use if no character list is
+     * 							specified all valid base64 characters are used.
+     * @return string
+     * @since 8.0.0
+     */
+    public function generate($length,
+                                $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/');
 
 }

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/IContainer.php

Indentation +49 added lines, -49 removed lines

@@ -47,57 +47,57 @@
  */
 interface IContainer {
 
-	/**
-	 * If a parameter is not registered in the container try to instantiate it
-	 * by using reflection to find out how to build the class
-	 * @param string $name the class name to resolve
-	 * @return \stdClass
-	 * @since 8.2.0
-	 * @throws QueryException if the class could not be found or instantiated
-	 */
-	public function resolve($name);
+    /**
+     * If a parameter is not registered in the container try to instantiate it
+     * by using reflection to find out how to build the class
+     * @param string $name the class name to resolve
+     * @return \stdClass
+     * @since 8.2.0
+     * @throws QueryException if the class could not be found or instantiated
+     */
+    public function resolve($name);
 
-	/**
-	 * Look up a service for a given name in the container.
-	 *
-	 * @param string $name
-	 * @return mixed
-	 * @since 6.0.0
-	 */
-	public function query($name);
+    /**
+     * Look up a service for a given name in the container.
+     *
+     * @param string $name
+     * @return mixed
+     * @since 6.0.0
+     */
+    public function query($name);
 
-	/**
-	 * A value is stored in the container with it's corresponding name
-	 *
-	 * @param string $name
-	 * @param mixed $value
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerParameter($name, $value);
+    /**
+     * A value is stored in the container with it's corresponding name
+     *
+     * @param string $name
+     * @param mixed $value
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerParameter($name, $value);
 
-	/**
-	 * A service is registered in the container where a closure is passed in which will actually
-	 * create the service on demand.
-	 * In case the parameter $shared is set to true (the default usage) the once created service will remain in
-	 * memory and be reused on subsequent calls.
-	 * In case the parameter is false the service will be recreated on every call.
-	 *
-	 * @param string $name
-	 * @param \Closure $closure
-	 * @param bool $shared
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerService($name, Closure $closure, $shared = true);
+    /**
+     * A service is registered in the container where a closure is passed in which will actually
+     * create the service on demand.
+     * In case the parameter $shared is set to true (the default usage) the once created service will remain in
+     * memory and be reused on subsequent calls.
+     * In case the parameter is false the service will be recreated on every call.
+     *
+     * @param string $name
+     * @param \Closure $closure
+     * @param bool $shared
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerService($name, Closure $closure, $shared = true);
 
-	/**
-	 * Shortcut for returning a service from a service under a different key,
-	 * e.g. to tell the container to return a class when queried for an
-	 * interface
-	 * @param string $alias the alias that should be registered
-	 * @param string $target the target that should be resolved instead
-	 * @since 8.2.0
-	 */
-	public function registerAlias($alias, $target);
+    /**
+     * Shortcut for returning a service from a service under a different key,
+     * e.g. to tell the container to return a class when queried for an
+     * interface
+     * @param string $alias the alias that should be registered
+     * @param string $target the target that should be resolved instead
+     * @since 8.2.0
+     */
+    public function registerAlias($alias, $target);
 }