@@ -34,93 +34,93 @@ |
||
34 | 34 | */ |
35 | 35 | class CredentialsManager implements ICredentialsManager { |
36 | 36 | |
37 | - const DB_TABLE = 'credentials'; |
|
37 | + const DB_TABLE = 'credentials'; |
|
38 | 38 | |
39 | - /** @var ICrypto */ |
|
40 | - protected $crypto; |
|
39 | + /** @var ICrypto */ |
|
40 | + protected $crypto; |
|
41 | 41 | |
42 | - /** @var IDBConnection */ |
|
43 | - protected $dbConnection; |
|
42 | + /** @var IDBConnection */ |
|
43 | + protected $dbConnection; |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param ICrypto $crypto |
|
47 | - * @param IDBConnection $dbConnection |
|
48 | - */ |
|
49 | - public function __construct(ICrypto $crypto, IDBConnection $dbConnection) { |
|
50 | - $this->crypto = $crypto; |
|
51 | - $this->dbConnection = $dbConnection; |
|
52 | - } |
|
45 | + /** |
|
46 | + * @param ICrypto $crypto |
|
47 | + * @param IDBConnection $dbConnection |
|
48 | + */ |
|
49 | + public function __construct(ICrypto $crypto, IDBConnection $dbConnection) { |
|
50 | + $this->crypto = $crypto; |
|
51 | + $this->dbConnection = $dbConnection; |
|
52 | + } |
|
53 | 53 | |
54 | - /** |
|
55 | - * Store a set of credentials |
|
56 | - * |
|
57 | - * @param string|null $userId Null for system-wide credentials |
|
58 | - * @param string $identifier |
|
59 | - * @param mixed $credentials |
|
60 | - */ |
|
61 | - public function store($userId, $identifier, $credentials) { |
|
62 | - $value = $this->crypto->encrypt(json_encode($credentials)); |
|
54 | + /** |
|
55 | + * Store a set of credentials |
|
56 | + * |
|
57 | + * @param string|null $userId Null for system-wide credentials |
|
58 | + * @param string $identifier |
|
59 | + * @param mixed $credentials |
|
60 | + */ |
|
61 | + public function store($userId, $identifier, $credentials) { |
|
62 | + $value = $this->crypto->encrypt(json_encode($credentials)); |
|
63 | 63 | |
64 | - $this->dbConnection->setValues(self::DB_TABLE, [ |
|
65 | - 'user' => $userId, |
|
66 | - 'identifier' => $identifier, |
|
67 | - ], [ |
|
68 | - 'credentials' => $value, |
|
69 | - ]); |
|
70 | - } |
|
64 | + $this->dbConnection->setValues(self::DB_TABLE, [ |
|
65 | + 'user' => $userId, |
|
66 | + 'identifier' => $identifier, |
|
67 | + ], [ |
|
68 | + 'credentials' => $value, |
|
69 | + ]); |
|
70 | + } |
|
71 | 71 | |
72 | - /** |
|
73 | - * Retrieve a set of credentials |
|
74 | - * |
|
75 | - * @param string|null $userId Null for system-wide credentials |
|
76 | - * @param string $identifier |
|
77 | - * @return mixed |
|
78 | - */ |
|
79 | - public function retrieve($userId, $identifier) { |
|
80 | - $qb = $this->dbConnection->getQueryBuilder(); |
|
81 | - $qb->select('credentials') |
|
82 | - ->from(self::DB_TABLE) |
|
83 | - ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
84 | - ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier))) |
|
85 | - ; |
|
86 | - $result = $qb->execute()->fetch(); |
|
72 | + /** |
|
73 | + * Retrieve a set of credentials |
|
74 | + * |
|
75 | + * @param string|null $userId Null for system-wide credentials |
|
76 | + * @param string $identifier |
|
77 | + * @return mixed |
|
78 | + */ |
|
79 | + public function retrieve($userId, $identifier) { |
|
80 | + $qb = $this->dbConnection->getQueryBuilder(); |
|
81 | + $qb->select('credentials') |
|
82 | + ->from(self::DB_TABLE) |
|
83 | + ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
84 | + ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier))) |
|
85 | + ; |
|
86 | + $result = $qb->execute()->fetch(); |
|
87 | 87 | |
88 | - if (!$result) { |
|
89 | - return null; |
|
90 | - } |
|
91 | - $value = $result['credentials']; |
|
88 | + if (!$result) { |
|
89 | + return null; |
|
90 | + } |
|
91 | + $value = $result['credentials']; |
|
92 | 92 | |
93 | - return json_decode($this->crypto->decrypt($value), true); |
|
94 | - } |
|
93 | + return json_decode($this->crypto->decrypt($value), true); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Delete a set of credentials |
|
98 | - * |
|
99 | - * @param string|null $userId Null for system-wide credentials |
|
100 | - * @param string $identifier |
|
101 | - * @return int rows removed |
|
102 | - */ |
|
103 | - public function delete($userId, $identifier) { |
|
104 | - $qb = $this->dbConnection->getQueryBuilder(); |
|
105 | - $qb->delete(self::DB_TABLE) |
|
106 | - ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
107 | - ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier))) |
|
108 | - ; |
|
109 | - return $qb->execute(); |
|
110 | - } |
|
96 | + /** |
|
97 | + * Delete a set of credentials |
|
98 | + * |
|
99 | + * @param string|null $userId Null for system-wide credentials |
|
100 | + * @param string $identifier |
|
101 | + * @return int rows removed |
|
102 | + */ |
|
103 | + public function delete($userId, $identifier) { |
|
104 | + $qb = $this->dbConnection->getQueryBuilder(); |
|
105 | + $qb->delete(self::DB_TABLE) |
|
106 | + ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
107 | + ->andWhere($qb->expr()->eq('identifier', $qb->createNamedParameter($identifier))) |
|
108 | + ; |
|
109 | + return $qb->execute(); |
|
110 | + } |
|
111 | 111 | |
112 | - /** |
|
113 | - * Erase all credentials stored for a user |
|
114 | - * |
|
115 | - * @param string $userId |
|
116 | - * @return int rows removed |
|
117 | - */ |
|
118 | - public function erase($userId) { |
|
119 | - $qb = $this->dbConnection->getQueryBuilder(); |
|
120 | - $qb->delete(self::DB_TABLE) |
|
121 | - ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
122 | - ; |
|
123 | - return $qb->execute(); |
|
124 | - } |
|
112 | + /** |
|
113 | + * Erase all credentials stored for a user |
|
114 | + * |
|
115 | + * @param string $userId |
|
116 | + * @return int rows removed |
|
117 | + */ |
|
118 | + public function erase($userId) { |
|
119 | + $qb = $this->dbConnection->getQueryBuilder(); |
|
120 | + $qb->delete(self::DB_TABLE) |
|
121 | + ->where($qb->expr()->eq('user', $qb->createNamedParameter($userId))) |
|
122 | + ; |
|
123 | + return $qb->execute(); |
|
124 | + } |
|
125 | 125 | |
126 | 126 | } |
@@ -32,68 +32,68 @@ |
||
32 | 32 | * @package OC\Security |
33 | 33 | */ |
34 | 34 | class TrustedDomainHelper { |
35 | - /** @var IConfig */ |
|
36 | - private $config; |
|
35 | + /** @var IConfig */ |
|
36 | + private $config; |
|
37 | 37 | |
38 | - /** |
|
39 | - * @param IConfig $config |
|
40 | - */ |
|
41 | - function __construct(IConfig $config) { |
|
42 | - $this->config = $config; |
|
43 | - } |
|
38 | + /** |
|
39 | + * @param IConfig $config |
|
40 | + */ |
|
41 | + function __construct(IConfig $config) { |
|
42 | + $this->config = $config; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * Strips a potential port from a domain (in format domain:port) |
|
47 | - * @param string $host |
|
48 | - * @return string $host without appended port |
|
49 | - */ |
|
50 | - private function getDomainWithoutPort($host) { |
|
51 | - $pos = strrpos($host, ':'); |
|
52 | - if ($pos !== false) { |
|
53 | - $port = substr($host, $pos + 1); |
|
54 | - if (is_numeric($port)) { |
|
55 | - $host = substr($host, 0, $pos); |
|
56 | - } |
|
57 | - } |
|
58 | - return $host; |
|
59 | - } |
|
45 | + /** |
|
46 | + * Strips a potential port from a domain (in format domain:port) |
|
47 | + * @param string $host |
|
48 | + * @return string $host without appended port |
|
49 | + */ |
|
50 | + private function getDomainWithoutPort($host) { |
|
51 | + $pos = strrpos($host, ':'); |
|
52 | + if ($pos !== false) { |
|
53 | + $port = substr($host, $pos + 1); |
|
54 | + if (is_numeric($port)) { |
|
55 | + $host = substr($host, 0, $pos); |
|
56 | + } |
|
57 | + } |
|
58 | + return $host; |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * Checks whether a domain is considered as trusted from the list |
|
63 | - * of trusted domains. If no trusted domains have been configured, returns |
|
64 | - * true. |
|
65 | - * This is used to prevent Host Header Poisoning. |
|
66 | - * @param string $domainWithPort |
|
67 | - * @return bool true if the given domain is trusted or if no trusted domains |
|
68 | - * have been configured |
|
69 | - */ |
|
70 | - public function isTrustedDomain($domainWithPort) { |
|
71 | - $domain = $this->getDomainWithoutPort($domainWithPort); |
|
61 | + /** |
|
62 | + * Checks whether a domain is considered as trusted from the list |
|
63 | + * of trusted domains. If no trusted domains have been configured, returns |
|
64 | + * true. |
|
65 | + * This is used to prevent Host Header Poisoning. |
|
66 | + * @param string $domainWithPort |
|
67 | + * @return bool true if the given domain is trusted or if no trusted domains |
|
68 | + * have been configured |
|
69 | + */ |
|
70 | + public function isTrustedDomain($domainWithPort) { |
|
71 | + $domain = $this->getDomainWithoutPort($domainWithPort); |
|
72 | 72 | |
73 | - // Read trusted domains from config |
|
74 | - $trustedList = $this->config->getSystemValue('trusted_domains', []); |
|
75 | - if (!is_array($trustedList)) { |
|
76 | - return false; |
|
77 | - } |
|
73 | + // Read trusted domains from config |
|
74 | + $trustedList = $this->config->getSystemValue('trusted_domains', []); |
|
75 | + if (!is_array($trustedList)) { |
|
76 | + return false; |
|
77 | + } |
|
78 | 78 | |
79 | - // Always allow access from localhost |
|
80 | - if (preg_match(Request::REGEX_LOCALHOST, $domain) === 1) { |
|
81 | - return true; |
|
82 | - } |
|
83 | - // Reject misformed domains in any case |
|
84 | - if (strpos($domain,'-') === 0 || strpos($domain,'..') !== false) { |
|
85 | - return false; |
|
86 | - } |
|
87 | - // Match, allowing for * wildcards |
|
88 | - foreach ($trustedList as $trusted) { |
|
89 | - if (gettype($trusted) !== 'string') { |
|
90 | - break; |
|
91 | - } |
|
92 | - $regex = '/^' . join('[-\.a-zA-Z0-9]*', array_map(function($v) { return preg_quote($v, '/'); }, explode('*', $trusted))) . '$/'; |
|
93 | - if (preg_match($regex, $domain) || preg_match($regex, $domainWithPort)) { |
|
94 | - return true; |
|
95 | - } |
|
96 | - } |
|
97 | - return false; |
|
98 | - } |
|
79 | + // Always allow access from localhost |
|
80 | + if (preg_match(Request::REGEX_LOCALHOST, $domain) === 1) { |
|
81 | + return true; |
|
82 | + } |
|
83 | + // Reject misformed domains in any case |
|
84 | + if (strpos($domain,'-') === 0 || strpos($domain,'..') !== false) { |
|
85 | + return false; |
|
86 | + } |
|
87 | + // Match, allowing for * wildcards |
|
88 | + foreach ($trustedList as $trusted) { |
|
89 | + if (gettype($trusted) !== 'string') { |
|
90 | + break; |
|
91 | + } |
|
92 | + $regex = '/^' . join('[-\.a-zA-Z0-9]*', array_map(function($v) { return preg_quote($v, '/'); }, explode('*', $trusted))) . '$/'; |
|
93 | + if (preg_match($regex, $domain) || preg_match($regex, $domainWithPort)) { |
|
94 | + return true; |
|
95 | + } |
|
96 | + } |
|
97 | + return false; |
|
98 | + } |
|
99 | 99 | } |
@@ -46,116 +46,116 @@ |
||
46 | 46 | * @package OC\Security |
47 | 47 | */ |
48 | 48 | class Hasher implements IHasher { |
49 | - /** @var IConfig */ |
|
50 | - private $config; |
|
51 | - /** @var array Options passed to password_hash and password_needs_rehash */ |
|
52 | - private $options = array(); |
|
53 | - /** @var string Salt used for legacy passwords */ |
|
54 | - private $legacySalt = null; |
|
55 | - /** @var int Current version of the generated hash */ |
|
56 | - private $currentVersion = 1; |
|
57 | - |
|
58 | - /** |
|
59 | - * @param IConfig $config |
|
60 | - */ |
|
61 | - function __construct(IConfig $config) { |
|
62 | - $this->config = $config; |
|
63 | - |
|
64 | - $hashingCost = $this->config->getSystemValue('hashingCost', null); |
|
65 | - if(!is_null($hashingCost)) { |
|
66 | - $this->options['cost'] = $hashingCost; |
|
67 | - } |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Hashes a message using PHP's `password_hash` functionality. |
|
72 | - * Please note that the size of the returned string is not guaranteed |
|
73 | - * and can be up to 255 characters. |
|
74 | - * |
|
75 | - * @param string $message Message to generate hash from |
|
76 | - * @return string Hash of the message with appended version parameter |
|
77 | - */ |
|
78 | - public function hash($message) { |
|
79 | - return $this->currentVersion . '|' . password_hash($message, PASSWORD_DEFAULT, $this->options); |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Get the version and hash from a prefixedHash |
|
84 | - * @param string $prefixedHash |
|
85 | - * @return null|array Null if the hash is not prefixed, otherwise array('version' => 1, 'hash' => 'foo') |
|
86 | - */ |
|
87 | - protected function splitHash($prefixedHash) { |
|
88 | - $explodedString = explode('|', $prefixedHash, 2); |
|
89 | - if(sizeof($explodedString) === 2) { |
|
90 | - if((int)$explodedString[0] > 0) { |
|
91 | - return array('version' => (int)$explodedString[0], 'hash' => $explodedString[1]); |
|
92 | - } |
|
93 | - } |
|
94 | - |
|
95 | - return null; |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Verify legacy hashes |
|
100 | - * @param string $message Message to verify |
|
101 | - * @param string $hash Assumed hash of the message |
|
102 | - * @param null|string &$newHash Reference will contain the updated hash |
|
103 | - * @return bool Whether $hash is a valid hash of $message |
|
104 | - */ |
|
105 | - protected function legacyHashVerify($message, $hash, &$newHash = null) { |
|
106 | - if(empty($this->legacySalt)) { |
|
107 | - $this->legacySalt = $this->config->getSystemValue('passwordsalt', ''); |
|
108 | - } |
|
109 | - |
|
110 | - // Verify whether it matches a legacy PHPass or SHA1 string |
|
111 | - $hashLength = strlen($hash); |
|
112 | - if($hashLength === 60 && password_verify($message.$this->legacySalt, $hash) || |
|
113 | - $hashLength === 40 && hash_equals($hash, sha1($message))) { |
|
114 | - $newHash = $this->hash($message); |
|
115 | - return true; |
|
116 | - } |
|
117 | - |
|
118 | - return false; |
|
119 | - } |
|
120 | - |
|
121 | - /** |
|
122 | - * Verify V1 hashes |
|
123 | - * @param string $message Message to verify |
|
124 | - * @param string $hash Assumed hash of the message |
|
125 | - * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
126 | - * @return bool Whether $hash is a valid hash of $message |
|
127 | - */ |
|
128 | - protected function verifyHashV1($message, $hash, &$newHash = null) { |
|
129 | - if(password_verify($message, $hash)) { |
|
130 | - if(password_needs_rehash($hash, PASSWORD_DEFAULT, $this->options)) { |
|
131 | - $newHash = $this->hash($message); |
|
132 | - } |
|
133 | - return true; |
|
134 | - } |
|
135 | - |
|
136 | - return false; |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * @param string $message Message to verify |
|
141 | - * @param string $hash Assumed hash of the message |
|
142 | - * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
143 | - * @return bool Whether $hash is a valid hash of $message |
|
144 | - */ |
|
145 | - public function verify($message, $hash, &$newHash = null) { |
|
146 | - $splittedHash = $this->splitHash($hash); |
|
147 | - |
|
148 | - if(isset($splittedHash['version'])) { |
|
149 | - switch ($splittedHash['version']) { |
|
150 | - case 1: |
|
151 | - return $this->verifyHashV1($message, $splittedHash['hash'], $newHash); |
|
152 | - } |
|
153 | - } else { |
|
154 | - return $this->legacyHashVerify($message, $hash, $newHash); |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - return false; |
|
159 | - } |
|
49 | + /** @var IConfig */ |
|
50 | + private $config; |
|
51 | + /** @var array Options passed to password_hash and password_needs_rehash */ |
|
52 | + private $options = array(); |
|
53 | + /** @var string Salt used for legacy passwords */ |
|
54 | + private $legacySalt = null; |
|
55 | + /** @var int Current version of the generated hash */ |
|
56 | + private $currentVersion = 1; |
|
57 | + |
|
58 | + /** |
|
59 | + * @param IConfig $config |
|
60 | + */ |
|
61 | + function __construct(IConfig $config) { |
|
62 | + $this->config = $config; |
|
63 | + |
|
64 | + $hashingCost = $this->config->getSystemValue('hashingCost', null); |
|
65 | + if(!is_null($hashingCost)) { |
|
66 | + $this->options['cost'] = $hashingCost; |
|
67 | + } |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Hashes a message using PHP's `password_hash` functionality. |
|
72 | + * Please note that the size of the returned string is not guaranteed |
|
73 | + * and can be up to 255 characters. |
|
74 | + * |
|
75 | + * @param string $message Message to generate hash from |
|
76 | + * @return string Hash of the message with appended version parameter |
|
77 | + */ |
|
78 | + public function hash($message) { |
|
79 | + return $this->currentVersion . '|' . password_hash($message, PASSWORD_DEFAULT, $this->options); |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Get the version and hash from a prefixedHash |
|
84 | + * @param string $prefixedHash |
|
85 | + * @return null|array Null if the hash is not prefixed, otherwise array('version' => 1, 'hash' => 'foo') |
|
86 | + */ |
|
87 | + protected function splitHash($prefixedHash) { |
|
88 | + $explodedString = explode('|', $prefixedHash, 2); |
|
89 | + if(sizeof($explodedString) === 2) { |
|
90 | + if((int)$explodedString[0] > 0) { |
|
91 | + return array('version' => (int)$explodedString[0], 'hash' => $explodedString[1]); |
|
92 | + } |
|
93 | + } |
|
94 | + |
|
95 | + return null; |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Verify legacy hashes |
|
100 | + * @param string $message Message to verify |
|
101 | + * @param string $hash Assumed hash of the message |
|
102 | + * @param null|string &$newHash Reference will contain the updated hash |
|
103 | + * @return bool Whether $hash is a valid hash of $message |
|
104 | + */ |
|
105 | + protected function legacyHashVerify($message, $hash, &$newHash = null) { |
|
106 | + if(empty($this->legacySalt)) { |
|
107 | + $this->legacySalt = $this->config->getSystemValue('passwordsalt', ''); |
|
108 | + } |
|
109 | + |
|
110 | + // Verify whether it matches a legacy PHPass or SHA1 string |
|
111 | + $hashLength = strlen($hash); |
|
112 | + if($hashLength === 60 && password_verify($message.$this->legacySalt, $hash) || |
|
113 | + $hashLength === 40 && hash_equals($hash, sha1($message))) { |
|
114 | + $newHash = $this->hash($message); |
|
115 | + return true; |
|
116 | + } |
|
117 | + |
|
118 | + return false; |
|
119 | + } |
|
120 | + |
|
121 | + /** |
|
122 | + * Verify V1 hashes |
|
123 | + * @param string $message Message to verify |
|
124 | + * @param string $hash Assumed hash of the message |
|
125 | + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
126 | + * @return bool Whether $hash is a valid hash of $message |
|
127 | + */ |
|
128 | + protected function verifyHashV1($message, $hash, &$newHash = null) { |
|
129 | + if(password_verify($message, $hash)) { |
|
130 | + if(password_needs_rehash($hash, PASSWORD_DEFAULT, $this->options)) { |
|
131 | + $newHash = $this->hash($message); |
|
132 | + } |
|
133 | + return true; |
|
134 | + } |
|
135 | + |
|
136 | + return false; |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * @param string $message Message to verify |
|
141 | + * @param string $hash Assumed hash of the message |
|
142 | + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
143 | + * @return bool Whether $hash is a valid hash of $message |
|
144 | + */ |
|
145 | + public function verify($message, $hash, &$newHash = null) { |
|
146 | + $splittedHash = $this->splitHash($hash); |
|
147 | + |
|
148 | + if(isset($splittedHash['version'])) { |
|
149 | + switch ($splittedHash['version']) { |
|
150 | + case 1: |
|
151 | + return $this->verifyHashV1($message, $splittedHash['hash'], $newHash); |
|
152 | + } |
|
153 | + } else { |
|
154 | + return $this->legacyHashVerify($message, $hash, $newHash); |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + return false; |
|
159 | + } |
|
160 | 160 | |
161 | 161 | } |
@@ -31,23 +31,23 @@ |
||
31 | 31 | * @package OC\Security\CSRF |
32 | 32 | */ |
33 | 33 | class CsrfTokenGenerator { |
34 | - /** @var ISecureRandom */ |
|
35 | - private $random; |
|
34 | + /** @var ISecureRandom */ |
|
35 | + private $random; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @param ISecureRandom $random |
|
39 | - */ |
|
40 | - public function __construct(ISecureRandom $random) { |
|
41 | - $this->random = $random; |
|
42 | - } |
|
37 | + /** |
|
38 | + * @param ISecureRandom $random |
|
39 | + */ |
|
40 | + public function __construct(ISecureRandom $random) { |
|
41 | + $this->random = $random; |
|
42 | + } |
|
43 | 43 | |
44 | - /** |
|
45 | - * Generate a new CSRF token. |
|
46 | - * |
|
47 | - * @param int $length Length of the token in characters. |
|
48 | - * @return string |
|
49 | - */ |
|
50 | - public function generateToken($length = 32) { |
|
51 | - return $this->random->generate($length); |
|
52 | - } |
|
44 | + /** |
|
45 | + * Generate a new CSRF token. |
|
46 | + * |
|
47 | + * @param int $length Length of the token in characters. |
|
48 | + * @return string |
|
49 | + */ |
|
50 | + public function generateToken($length = 32) { |
|
51 | + return $this->random->generate($length); |
|
52 | + } |
|
53 | 53 | } |
@@ -43,93 +43,93 @@ |
||
43 | 43 | * @package OC\Security |
44 | 44 | */ |
45 | 45 | class Crypto implements ICrypto { |
46 | - /** @var AES $cipher */ |
|
47 | - private $cipher; |
|
48 | - /** @var int */ |
|
49 | - private $ivLength = 16; |
|
50 | - /** @var IConfig */ |
|
51 | - private $config; |
|
52 | - /** @var ISecureRandom */ |
|
53 | - private $random; |
|
54 | - |
|
55 | - /** |
|
56 | - * @param IConfig $config |
|
57 | - * @param ISecureRandom $random |
|
58 | - */ |
|
59 | - function __construct(IConfig $config, ISecureRandom $random) { |
|
60 | - $this->cipher = new AES(); |
|
61 | - $this->config = $config; |
|
62 | - $this->random = $random; |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * @param string $message The message to authenticate |
|
67 | - * @param string $password Password to use (defaults to `secret` in config.php) |
|
68 | - * @return string Calculated HMAC |
|
69 | - */ |
|
70 | - public function calculateHMAC($message, $password = '') { |
|
71 | - if($password === '') { |
|
72 | - $password = $this->config->getSystemValue('secret'); |
|
73 | - } |
|
74 | - |
|
75 | - // Append an "a" behind the password and hash it to prevent reusing the same password as for encryption |
|
76 | - $password = hash('sha512', $password . 'a'); |
|
77 | - |
|
78 | - $hash = new Hash('sha512'); |
|
79 | - $hash->setKey($password); |
|
80 | - return $hash->hash($message); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
85 | - * @param string $plaintext |
|
86 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
87 | - * @return string Authenticated ciphertext |
|
88 | - */ |
|
89 | - public function encrypt($plaintext, $password = '') { |
|
90 | - if($password === '') { |
|
91 | - $password = $this->config->getSystemValue('secret'); |
|
92 | - } |
|
93 | - $this->cipher->setPassword($password); |
|
94 | - |
|
95 | - $iv = $this->random->generate($this->ivLength); |
|
96 | - $this->cipher->setIV($iv); |
|
97 | - |
|
98 | - $ciphertext = bin2hex($this->cipher->encrypt($plaintext)); |
|
99 | - $hmac = bin2hex($this->calculateHMAC($ciphertext.$iv, $password)); |
|
100 | - |
|
101 | - return $ciphertext.'|'.$iv.'|'.$hmac; |
|
102 | - } |
|
103 | - |
|
104 | - /** |
|
105 | - * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
106 | - * @param string $authenticatedCiphertext |
|
107 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
108 | - * @return string plaintext |
|
109 | - * @throws \Exception If the HMAC does not match |
|
110 | - */ |
|
111 | - public function decrypt($authenticatedCiphertext, $password = '') { |
|
112 | - if($password === '') { |
|
113 | - $password = $this->config->getSystemValue('secret'); |
|
114 | - } |
|
115 | - $this->cipher->setPassword($password); |
|
116 | - |
|
117 | - $parts = explode('|', $authenticatedCiphertext); |
|
118 | - if(sizeof($parts) !== 3) { |
|
119 | - throw new \Exception('Authenticated ciphertext could not be decoded.'); |
|
120 | - } |
|
121 | - |
|
122 | - $ciphertext = hex2bin($parts[0]); |
|
123 | - $iv = $parts[1]; |
|
124 | - $hmac = hex2bin($parts[2]); |
|
125 | - |
|
126 | - $this->cipher->setIV($iv); |
|
127 | - |
|
128 | - if(!hash_equals($this->calculateHMAC($parts[0].$parts[1], $password), $hmac)) { |
|
129 | - throw new \Exception('HMAC does not match.'); |
|
130 | - } |
|
131 | - |
|
132 | - return $this->cipher->decrypt($ciphertext); |
|
133 | - } |
|
46 | + /** @var AES $cipher */ |
|
47 | + private $cipher; |
|
48 | + /** @var int */ |
|
49 | + private $ivLength = 16; |
|
50 | + /** @var IConfig */ |
|
51 | + private $config; |
|
52 | + /** @var ISecureRandom */ |
|
53 | + private $random; |
|
54 | + |
|
55 | + /** |
|
56 | + * @param IConfig $config |
|
57 | + * @param ISecureRandom $random |
|
58 | + */ |
|
59 | + function __construct(IConfig $config, ISecureRandom $random) { |
|
60 | + $this->cipher = new AES(); |
|
61 | + $this->config = $config; |
|
62 | + $this->random = $random; |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * @param string $message The message to authenticate |
|
67 | + * @param string $password Password to use (defaults to `secret` in config.php) |
|
68 | + * @return string Calculated HMAC |
|
69 | + */ |
|
70 | + public function calculateHMAC($message, $password = '') { |
|
71 | + if($password === '') { |
|
72 | + $password = $this->config->getSystemValue('secret'); |
|
73 | + } |
|
74 | + |
|
75 | + // Append an "a" behind the password and hash it to prevent reusing the same password as for encryption |
|
76 | + $password = hash('sha512', $password . 'a'); |
|
77 | + |
|
78 | + $hash = new Hash('sha512'); |
|
79 | + $hash->setKey($password); |
|
80 | + return $hash->hash($message); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
85 | + * @param string $plaintext |
|
86 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
87 | + * @return string Authenticated ciphertext |
|
88 | + */ |
|
89 | + public function encrypt($plaintext, $password = '') { |
|
90 | + if($password === '') { |
|
91 | + $password = $this->config->getSystemValue('secret'); |
|
92 | + } |
|
93 | + $this->cipher->setPassword($password); |
|
94 | + |
|
95 | + $iv = $this->random->generate($this->ivLength); |
|
96 | + $this->cipher->setIV($iv); |
|
97 | + |
|
98 | + $ciphertext = bin2hex($this->cipher->encrypt($plaintext)); |
|
99 | + $hmac = bin2hex($this->calculateHMAC($ciphertext.$iv, $password)); |
|
100 | + |
|
101 | + return $ciphertext.'|'.$iv.'|'.$hmac; |
|
102 | + } |
|
103 | + |
|
104 | + /** |
|
105 | + * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
106 | + * @param string $authenticatedCiphertext |
|
107 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
108 | + * @return string plaintext |
|
109 | + * @throws \Exception If the HMAC does not match |
|
110 | + */ |
|
111 | + public function decrypt($authenticatedCiphertext, $password = '') { |
|
112 | + if($password === '') { |
|
113 | + $password = $this->config->getSystemValue('secret'); |
|
114 | + } |
|
115 | + $this->cipher->setPassword($password); |
|
116 | + |
|
117 | + $parts = explode('|', $authenticatedCiphertext); |
|
118 | + if(sizeof($parts) !== 3) { |
|
119 | + throw new \Exception('Authenticated ciphertext could not be decoded.'); |
|
120 | + } |
|
121 | + |
|
122 | + $ciphertext = hex2bin($parts[0]); |
|
123 | + $iv = $parts[1]; |
|
124 | + $hmac = hex2bin($parts[2]); |
|
125 | + |
|
126 | + $this->cipher->setIV($iv); |
|
127 | + |
|
128 | + if(!hash_equals($this->calculateHMAC($parts[0].$parts[1], $password), $hmac)) { |
|
129 | + throw new \Exception('HMAC does not match.'); |
|
130 | + } |
|
131 | + |
|
132 | + return $this->cipher->decrypt($ciphertext); |
|
133 | + } |
|
134 | 134 | |
135 | 135 | } |
@@ -37,51 +37,51 @@ |
||
37 | 37 | * @package OC\Security |
38 | 38 | */ |
39 | 39 | class SecureRandom implements ISecureRandom { |
40 | - /** |
|
41 | - * Convenience method to get a low strength random number generator. |
|
42 | - * |
|
43 | - * Low Strength should be used anywhere that random strings are needed |
|
44 | - * in a non-cryptographical setting. They are not strong enough to be |
|
45 | - * used as keys or salts. They are however useful for one-time use tokens. |
|
46 | - * |
|
47 | - * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
48 | - * @return $this |
|
49 | - */ |
|
50 | - public function getLowStrengthGenerator() { |
|
51 | - return $this; |
|
52 | - } |
|
40 | + /** |
|
41 | + * Convenience method to get a low strength random number generator. |
|
42 | + * |
|
43 | + * Low Strength should be used anywhere that random strings are needed |
|
44 | + * in a non-cryptographical setting. They are not strong enough to be |
|
45 | + * used as keys or salts. They are however useful for one-time use tokens. |
|
46 | + * |
|
47 | + * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
48 | + * @return $this |
|
49 | + */ |
|
50 | + public function getLowStrengthGenerator() { |
|
51 | + return $this; |
|
52 | + } |
|
53 | 53 | |
54 | - /** |
|
55 | - * Convenience method to get a medium strength random number generator. |
|
56 | - * |
|
57 | - * Medium Strength should be used for most needs of a cryptographic nature. |
|
58 | - * They are strong enough to be used as keys and salts. However, they do |
|
59 | - * take some time and resources to generate, so they should not be over-used |
|
60 | - * |
|
61 | - * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
62 | - * @return $this |
|
63 | - */ |
|
64 | - public function getMediumStrengthGenerator() { |
|
65 | - return $this; |
|
66 | - } |
|
54 | + /** |
|
55 | + * Convenience method to get a medium strength random number generator. |
|
56 | + * |
|
57 | + * Medium Strength should be used for most needs of a cryptographic nature. |
|
58 | + * They are strong enough to be used as keys and salts. However, they do |
|
59 | + * take some time and resources to generate, so they should not be over-used |
|
60 | + * |
|
61 | + * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
62 | + * @return $this |
|
63 | + */ |
|
64 | + public function getMediumStrengthGenerator() { |
|
65 | + return $this; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Generate a random string of specified length. |
|
70 | - * @param int $length The length of the generated string |
|
71 | - * @param string $characters An optional list of characters to use if no character list is |
|
72 | - * specified all valid base64 characters are used. |
|
73 | - * @return string |
|
74 | - */ |
|
75 | - public function generate($length, |
|
76 | - $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/') { |
|
77 | - $maxCharIndex = strlen($characters) - 1; |
|
78 | - $randomString = ''; |
|
68 | + /** |
|
69 | + * Generate a random string of specified length. |
|
70 | + * @param int $length The length of the generated string |
|
71 | + * @param string $characters An optional list of characters to use if no character list is |
|
72 | + * specified all valid base64 characters are used. |
|
73 | + * @return string |
|
74 | + */ |
|
75 | + public function generate($length, |
|
76 | + $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/') { |
|
77 | + $maxCharIndex = strlen($characters) - 1; |
|
78 | + $randomString = ''; |
|
79 | 79 | |
80 | - while($length > 0) { |
|
81 | - $randomNumber = \random_int(0, $maxCharIndex); |
|
82 | - $randomString .= $characters[$randomNumber]; |
|
83 | - $length--; |
|
84 | - } |
|
85 | - return $randomString; |
|
86 | - } |
|
80 | + while($length > 0) { |
|
81 | + $randomNumber = \random_int(0, $maxCharIndex); |
|
82 | + $randomString .= $characters[$randomNumber]; |
|
83 | + $length--; |
|
84 | + } |
|
85 | + return $randomString; |
|
86 | + } |
|
87 | 87 | } |
@@ -27,104 +27,104 @@ |
||
27 | 27 | use OCP\ICertificate; |
28 | 28 | |
29 | 29 | class Certificate implements ICertificate { |
30 | - protected $name; |
|
31 | - |
|
32 | - protected $commonName; |
|
33 | - |
|
34 | - protected $organization; |
|
35 | - |
|
36 | - protected $serial; |
|
37 | - |
|
38 | - protected $issueDate; |
|
39 | - |
|
40 | - protected $expireDate; |
|
41 | - |
|
42 | - protected $issuerName; |
|
43 | - |
|
44 | - protected $issuerOrganization; |
|
45 | - |
|
46 | - /** |
|
47 | - * @param string $data base64 encoded certificate |
|
48 | - * @param string $name |
|
49 | - * @throws \Exception If the certificate could not get parsed |
|
50 | - */ |
|
51 | - public function __construct($data, $name) { |
|
52 | - $this->name = $name; |
|
53 | - $gmt = new \DateTimeZone('GMT'); |
|
54 | - |
|
55 | - // If string starts with "file://" ignore the certificate |
|
56 | - $query = 'file://'; |
|
57 | - if(strtolower(substr($data, 0, strlen($query))) === $query) { |
|
58 | - throw new \Exception('Certificate could not get parsed.'); |
|
59 | - } |
|
60 | - |
|
61 | - $info = openssl_x509_parse($data); |
|
62 | - if(!is_array($info)) { |
|
63 | - throw new \Exception('Certificate could not get parsed.'); |
|
64 | - } |
|
65 | - |
|
66 | - $this->commonName = isset($info['subject']['CN']) ? $info['subject']['CN'] : null; |
|
67 | - $this->organization = isset($info['subject']['O']) ? $info['subject']['O'] : null; |
|
68 | - $this->issueDate = new \DateTime('@' . $info['validFrom_time_t'], $gmt); |
|
69 | - $this->expireDate = new \DateTime('@' . $info['validTo_time_t'], $gmt); |
|
70 | - $this->issuerName = isset($info['issuer']['CN']) ? $info['issuer']['CN'] : null; |
|
71 | - $this->issuerOrganization = isset($info['issuer']['O']) ? $info['issuer']['O'] : null; |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * @return string |
|
76 | - */ |
|
77 | - public function getName() { |
|
78 | - return $this->name; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * @return string|null |
|
83 | - */ |
|
84 | - public function getCommonName() { |
|
85 | - return $this->commonName; |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * @return string |
|
90 | - */ |
|
91 | - public function getOrganization() { |
|
92 | - return $this->organization; |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * @return \DateTime |
|
97 | - */ |
|
98 | - public function getIssueDate() { |
|
99 | - return $this->issueDate; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @return \DateTime |
|
104 | - */ |
|
105 | - public function getExpireDate() { |
|
106 | - return $this->expireDate; |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * @return bool |
|
111 | - */ |
|
112 | - public function isExpired() { |
|
113 | - $now = new \DateTime(); |
|
114 | - return $this->issueDate > $now or $now > $this->expireDate; |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * @return string|null |
|
119 | - */ |
|
120 | - public function getIssuerName() { |
|
121 | - return $this->issuerName; |
|
122 | - } |
|
123 | - |
|
124 | - /** |
|
125 | - * @return string|null |
|
126 | - */ |
|
127 | - public function getIssuerOrganization() { |
|
128 | - return $this->issuerOrganization; |
|
129 | - } |
|
30 | + protected $name; |
|
31 | + |
|
32 | + protected $commonName; |
|
33 | + |
|
34 | + protected $organization; |
|
35 | + |
|
36 | + protected $serial; |
|
37 | + |
|
38 | + protected $issueDate; |
|
39 | + |
|
40 | + protected $expireDate; |
|
41 | + |
|
42 | + protected $issuerName; |
|
43 | + |
|
44 | + protected $issuerOrganization; |
|
45 | + |
|
46 | + /** |
|
47 | + * @param string $data base64 encoded certificate |
|
48 | + * @param string $name |
|
49 | + * @throws \Exception If the certificate could not get parsed |
|
50 | + */ |
|
51 | + public function __construct($data, $name) { |
|
52 | + $this->name = $name; |
|
53 | + $gmt = new \DateTimeZone('GMT'); |
|
54 | + |
|
55 | + // If string starts with "file://" ignore the certificate |
|
56 | + $query = 'file://'; |
|
57 | + if(strtolower(substr($data, 0, strlen($query))) === $query) { |
|
58 | + throw new \Exception('Certificate could not get parsed.'); |
|
59 | + } |
|
60 | + |
|
61 | + $info = openssl_x509_parse($data); |
|
62 | + if(!is_array($info)) { |
|
63 | + throw new \Exception('Certificate could not get parsed.'); |
|
64 | + } |
|
65 | + |
|
66 | + $this->commonName = isset($info['subject']['CN']) ? $info['subject']['CN'] : null; |
|
67 | + $this->organization = isset($info['subject']['O']) ? $info['subject']['O'] : null; |
|
68 | + $this->issueDate = new \DateTime('@' . $info['validFrom_time_t'], $gmt); |
|
69 | + $this->expireDate = new \DateTime('@' . $info['validTo_time_t'], $gmt); |
|
70 | + $this->issuerName = isset($info['issuer']['CN']) ? $info['issuer']['CN'] : null; |
|
71 | + $this->issuerOrganization = isset($info['issuer']['O']) ? $info['issuer']['O'] : null; |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * @return string |
|
76 | + */ |
|
77 | + public function getName() { |
|
78 | + return $this->name; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * @return string|null |
|
83 | + */ |
|
84 | + public function getCommonName() { |
|
85 | + return $this->commonName; |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * @return string |
|
90 | + */ |
|
91 | + public function getOrganization() { |
|
92 | + return $this->organization; |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * @return \DateTime |
|
97 | + */ |
|
98 | + public function getIssueDate() { |
|
99 | + return $this->issueDate; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @return \DateTime |
|
104 | + */ |
|
105 | + public function getExpireDate() { |
|
106 | + return $this->expireDate; |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * @return bool |
|
111 | + */ |
|
112 | + public function isExpired() { |
|
113 | + $now = new \DateTime(); |
|
114 | + return $this->issueDate > $now or $now > $this->expireDate; |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * @return string|null |
|
119 | + */ |
|
120 | + public function getIssuerName() { |
|
121 | + return $this->issuerName; |
|
122 | + } |
|
123 | + |
|
124 | + /** |
|
125 | + * @return string|null |
|
126 | + */ |
|
127 | + public function getIssuerOrganization() { |
|
128 | + return $this->issuerOrganization; |
|
129 | + } |
|
130 | 130 | } |
@@ -34,246 +34,246 @@ |
||
34 | 34 | use OCP\ITempManager; |
35 | 35 | |
36 | 36 | class TempManager implements ITempManager { |
37 | - /** @var string[] Current temporary files and folders, used for cleanup */ |
|
38 | - protected $current = []; |
|
39 | - /** @var string i.e. /tmp on linux systems */ |
|
40 | - protected $tmpBaseDir; |
|
41 | - /** @var ILogger */ |
|
42 | - protected $log; |
|
43 | - /** @var IConfig */ |
|
44 | - protected $config; |
|
37 | + /** @var string[] Current temporary files and folders, used for cleanup */ |
|
38 | + protected $current = []; |
|
39 | + /** @var string i.e. /tmp on linux systems */ |
|
40 | + protected $tmpBaseDir; |
|
41 | + /** @var ILogger */ |
|
42 | + protected $log; |
|
43 | + /** @var IConfig */ |
|
44 | + protected $config; |
|
45 | 45 | |
46 | - /** Prefix */ |
|
47 | - const TMP_PREFIX = 'oc_tmp_'; |
|
46 | + /** Prefix */ |
|
47 | + const TMP_PREFIX = 'oc_tmp_'; |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param \OCP\ILogger $logger |
|
51 | - * @param \OCP\IConfig $config |
|
52 | - */ |
|
53 | - public function __construct(ILogger $logger, IConfig $config) { |
|
54 | - $this->log = $logger; |
|
55 | - $this->config = $config; |
|
56 | - $this->tmpBaseDir = $this->getTempBaseDir(); |
|
57 | - } |
|
49 | + /** |
|
50 | + * @param \OCP\ILogger $logger |
|
51 | + * @param \OCP\IConfig $config |
|
52 | + */ |
|
53 | + public function __construct(ILogger $logger, IConfig $config) { |
|
54 | + $this->log = $logger; |
|
55 | + $this->config = $config; |
|
56 | + $this->tmpBaseDir = $this->getTempBaseDir(); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * Builds the filename with suffix and removes potential dangerous characters |
|
61 | - * such as directory separators. |
|
62 | - * |
|
63 | - * @param string $absolutePath Absolute path to the file / folder |
|
64 | - * @param string $postFix Postfix appended to the temporary file name, may be user controlled |
|
65 | - * @return string |
|
66 | - */ |
|
67 | - private function buildFileNameWithSuffix($absolutePath, $postFix = '') { |
|
68 | - if($postFix !== '') { |
|
69 | - $postFix = '.' . ltrim($postFix, '.'); |
|
70 | - $postFix = str_replace(['\\', '/'], '', $postFix); |
|
71 | - $absolutePath .= '-'; |
|
72 | - } |
|
59 | + /** |
|
60 | + * Builds the filename with suffix and removes potential dangerous characters |
|
61 | + * such as directory separators. |
|
62 | + * |
|
63 | + * @param string $absolutePath Absolute path to the file / folder |
|
64 | + * @param string $postFix Postfix appended to the temporary file name, may be user controlled |
|
65 | + * @return string |
|
66 | + */ |
|
67 | + private function buildFileNameWithSuffix($absolutePath, $postFix = '') { |
|
68 | + if($postFix !== '') { |
|
69 | + $postFix = '.' . ltrim($postFix, '.'); |
|
70 | + $postFix = str_replace(['\\', '/'], '', $postFix); |
|
71 | + $absolutePath .= '-'; |
|
72 | + } |
|
73 | 73 | |
74 | - return $absolutePath . $postFix; |
|
75 | - } |
|
74 | + return $absolutePath . $postFix; |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * Create a temporary file and return the path |
|
79 | - * |
|
80 | - * @param string $postFix Postfix appended to the temporary file name |
|
81 | - * @return string |
|
82 | - */ |
|
83 | - public function getTemporaryFile($postFix = '') { |
|
84 | - if (is_writable($this->tmpBaseDir)) { |
|
85 | - // To create an unique file and prevent the risk of race conditions |
|
86 | - // or duplicated temporary files by other means such as collisions |
|
87 | - // we need to create the file using `tempnam` and append a possible |
|
88 | - // postfix to it later |
|
89 | - $file = tempnam($this->tmpBaseDir, self::TMP_PREFIX); |
|
90 | - $this->current[] = $file; |
|
77 | + /** |
|
78 | + * Create a temporary file and return the path |
|
79 | + * |
|
80 | + * @param string $postFix Postfix appended to the temporary file name |
|
81 | + * @return string |
|
82 | + */ |
|
83 | + public function getTemporaryFile($postFix = '') { |
|
84 | + if (is_writable($this->tmpBaseDir)) { |
|
85 | + // To create an unique file and prevent the risk of race conditions |
|
86 | + // or duplicated temporary files by other means such as collisions |
|
87 | + // we need to create the file using `tempnam` and append a possible |
|
88 | + // postfix to it later |
|
89 | + $file = tempnam($this->tmpBaseDir, self::TMP_PREFIX); |
|
90 | + $this->current[] = $file; |
|
91 | 91 | |
92 | - // If a postfix got specified sanitize it and create a postfixed |
|
93 | - // temporary file |
|
94 | - if($postFix !== '') { |
|
95 | - $fileNameWithPostfix = $this->buildFileNameWithSuffix($file, $postFix); |
|
96 | - touch($fileNameWithPostfix); |
|
97 | - chmod($fileNameWithPostfix, 0600); |
|
98 | - $this->current[] = $fileNameWithPostfix; |
|
99 | - return $fileNameWithPostfix; |
|
100 | - } |
|
92 | + // If a postfix got specified sanitize it and create a postfixed |
|
93 | + // temporary file |
|
94 | + if($postFix !== '') { |
|
95 | + $fileNameWithPostfix = $this->buildFileNameWithSuffix($file, $postFix); |
|
96 | + touch($fileNameWithPostfix); |
|
97 | + chmod($fileNameWithPostfix, 0600); |
|
98 | + $this->current[] = $fileNameWithPostfix; |
|
99 | + return $fileNameWithPostfix; |
|
100 | + } |
|
101 | 101 | |
102 | - return $file; |
|
103 | - } else { |
|
104 | - $this->log->warning( |
|
105 | - 'Can not create a temporary file in directory {dir}. Check it exists and has correct permissions', |
|
106 | - [ |
|
107 | - 'dir' => $this->tmpBaseDir, |
|
108 | - ] |
|
109 | - ); |
|
110 | - return false; |
|
111 | - } |
|
112 | - } |
|
102 | + return $file; |
|
103 | + } else { |
|
104 | + $this->log->warning( |
|
105 | + 'Can not create a temporary file in directory {dir}. Check it exists and has correct permissions', |
|
106 | + [ |
|
107 | + 'dir' => $this->tmpBaseDir, |
|
108 | + ] |
|
109 | + ); |
|
110 | + return false; |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Create a temporary folder and return the path |
|
116 | - * |
|
117 | - * @param string $postFix Postfix appended to the temporary folder name |
|
118 | - * @return string |
|
119 | - */ |
|
120 | - public function getTemporaryFolder($postFix = '') { |
|
121 | - if (is_writable($this->tmpBaseDir)) { |
|
122 | - // To create an unique directory and prevent the risk of race conditions |
|
123 | - // or duplicated temporary files by other means such as collisions |
|
124 | - // we need to create the file using `tempnam` and append a possible |
|
125 | - // postfix to it later |
|
126 | - $uniqueFileName = tempnam($this->tmpBaseDir, self::TMP_PREFIX); |
|
127 | - $this->current[] = $uniqueFileName; |
|
114 | + /** |
|
115 | + * Create a temporary folder and return the path |
|
116 | + * |
|
117 | + * @param string $postFix Postfix appended to the temporary folder name |
|
118 | + * @return string |
|
119 | + */ |
|
120 | + public function getTemporaryFolder($postFix = '') { |
|
121 | + if (is_writable($this->tmpBaseDir)) { |
|
122 | + // To create an unique directory and prevent the risk of race conditions |
|
123 | + // or duplicated temporary files by other means such as collisions |
|
124 | + // we need to create the file using `tempnam` and append a possible |
|
125 | + // postfix to it later |
|
126 | + $uniqueFileName = tempnam($this->tmpBaseDir, self::TMP_PREFIX); |
|
127 | + $this->current[] = $uniqueFileName; |
|
128 | 128 | |
129 | - // Build a name without postfix |
|
130 | - $path = $this->buildFileNameWithSuffix($uniqueFileName . '-folder', $postFix); |
|
131 | - mkdir($path, 0700); |
|
132 | - $this->current[] = $path; |
|
129 | + // Build a name without postfix |
|
130 | + $path = $this->buildFileNameWithSuffix($uniqueFileName . '-folder', $postFix); |
|
131 | + mkdir($path, 0700); |
|
132 | + $this->current[] = $path; |
|
133 | 133 | |
134 | - return $path . '/'; |
|
135 | - } else { |
|
136 | - $this->log->warning( |
|
137 | - 'Can not create a temporary folder in directory {dir}. Check it exists and has correct permissions', |
|
138 | - [ |
|
139 | - 'dir' => $this->tmpBaseDir, |
|
140 | - ] |
|
141 | - ); |
|
142 | - return false; |
|
143 | - } |
|
144 | - } |
|
134 | + return $path . '/'; |
|
135 | + } else { |
|
136 | + $this->log->warning( |
|
137 | + 'Can not create a temporary folder in directory {dir}. Check it exists and has correct permissions', |
|
138 | + [ |
|
139 | + 'dir' => $this->tmpBaseDir, |
|
140 | + ] |
|
141 | + ); |
|
142 | + return false; |
|
143 | + } |
|
144 | + } |
|
145 | 145 | |
146 | - /** |
|
147 | - * Remove the temporary files and folders generated during this request |
|
148 | - */ |
|
149 | - public function clean() { |
|
150 | - $this->cleanFiles($this->current); |
|
151 | - } |
|
146 | + /** |
|
147 | + * Remove the temporary files and folders generated during this request |
|
148 | + */ |
|
149 | + public function clean() { |
|
150 | + $this->cleanFiles($this->current); |
|
151 | + } |
|
152 | 152 | |
153 | - /** |
|
154 | - * @param string[] $files |
|
155 | - */ |
|
156 | - protected function cleanFiles($files) { |
|
157 | - foreach ($files as $file) { |
|
158 | - if (file_exists($file)) { |
|
159 | - try { |
|
160 | - \OC_Helper::rmdirr($file); |
|
161 | - } catch (\UnexpectedValueException $ex) { |
|
162 | - $this->log->warning( |
|
163 | - "Error deleting temporary file/folder: {file} - Reason: {error}", |
|
164 | - [ |
|
165 | - 'file' => $file, |
|
166 | - 'error' => $ex->getMessage(), |
|
167 | - ] |
|
168 | - ); |
|
169 | - } |
|
170 | - } |
|
171 | - } |
|
172 | - } |
|
153 | + /** |
|
154 | + * @param string[] $files |
|
155 | + */ |
|
156 | + protected function cleanFiles($files) { |
|
157 | + foreach ($files as $file) { |
|
158 | + if (file_exists($file)) { |
|
159 | + try { |
|
160 | + \OC_Helper::rmdirr($file); |
|
161 | + } catch (\UnexpectedValueException $ex) { |
|
162 | + $this->log->warning( |
|
163 | + "Error deleting temporary file/folder: {file} - Reason: {error}", |
|
164 | + [ |
|
165 | + 'file' => $file, |
|
166 | + 'error' => $ex->getMessage(), |
|
167 | + ] |
|
168 | + ); |
|
169 | + } |
|
170 | + } |
|
171 | + } |
|
172 | + } |
|
173 | 173 | |
174 | - /** |
|
175 | - * Remove old temporary files and folders that were failed to be cleaned |
|
176 | - */ |
|
177 | - public function cleanOld() { |
|
178 | - $this->cleanFiles($this->getOldFiles()); |
|
179 | - } |
|
174 | + /** |
|
175 | + * Remove old temporary files and folders that were failed to be cleaned |
|
176 | + */ |
|
177 | + public function cleanOld() { |
|
178 | + $this->cleanFiles($this->getOldFiles()); |
|
179 | + } |
|
180 | 180 | |
181 | - /** |
|
182 | - * Get all temporary files and folders generated by oc older than an hour |
|
183 | - * |
|
184 | - * @return string[] |
|
185 | - */ |
|
186 | - protected function getOldFiles() { |
|
187 | - $cutOfTime = time() - 3600; |
|
188 | - $files = []; |
|
189 | - $dh = opendir($this->tmpBaseDir); |
|
190 | - if ($dh) { |
|
191 | - while (($file = readdir($dh)) !== false) { |
|
192 | - if (substr($file, 0, 7) === self::TMP_PREFIX) { |
|
193 | - $path = $this->tmpBaseDir . '/' . $file; |
|
194 | - $mtime = filemtime($path); |
|
195 | - if ($mtime < $cutOfTime) { |
|
196 | - $files[] = $path; |
|
197 | - } |
|
198 | - } |
|
199 | - } |
|
200 | - } |
|
201 | - return $files; |
|
202 | - } |
|
181 | + /** |
|
182 | + * Get all temporary files and folders generated by oc older than an hour |
|
183 | + * |
|
184 | + * @return string[] |
|
185 | + */ |
|
186 | + protected function getOldFiles() { |
|
187 | + $cutOfTime = time() - 3600; |
|
188 | + $files = []; |
|
189 | + $dh = opendir($this->tmpBaseDir); |
|
190 | + if ($dh) { |
|
191 | + while (($file = readdir($dh)) !== false) { |
|
192 | + if (substr($file, 0, 7) === self::TMP_PREFIX) { |
|
193 | + $path = $this->tmpBaseDir . '/' . $file; |
|
194 | + $mtime = filemtime($path); |
|
195 | + if ($mtime < $cutOfTime) { |
|
196 | + $files[] = $path; |
|
197 | + } |
|
198 | + } |
|
199 | + } |
|
200 | + } |
|
201 | + return $files; |
|
202 | + } |
|
203 | 203 | |
204 | - /** |
|
205 | - * Get the temporary base directory configured on the server |
|
206 | - * |
|
207 | - * @return string Path to the temporary directory or null |
|
208 | - * @throws \UnexpectedValueException |
|
209 | - */ |
|
210 | - public function getTempBaseDir() { |
|
211 | - if ($this->tmpBaseDir) { |
|
212 | - return $this->tmpBaseDir; |
|
213 | - } |
|
204 | + /** |
|
205 | + * Get the temporary base directory configured on the server |
|
206 | + * |
|
207 | + * @return string Path to the temporary directory or null |
|
208 | + * @throws \UnexpectedValueException |
|
209 | + */ |
|
210 | + public function getTempBaseDir() { |
|
211 | + if ($this->tmpBaseDir) { |
|
212 | + return $this->tmpBaseDir; |
|
213 | + } |
|
214 | 214 | |
215 | - $directories = []; |
|
216 | - if ($temp = $this->config->getSystemValue('tempdirectory', null)) { |
|
217 | - $directories[] = $temp; |
|
218 | - } |
|
219 | - if ($temp = \OC::$server->getIniWrapper()->get('upload_tmp_dir')) { |
|
220 | - $directories[] = $temp; |
|
221 | - } |
|
222 | - if ($temp = getenv('TMP')) { |
|
223 | - $directories[] = $temp; |
|
224 | - } |
|
225 | - if ($temp = getenv('TEMP')) { |
|
226 | - $directories[] = $temp; |
|
227 | - } |
|
228 | - if ($temp = getenv('TMPDIR')) { |
|
229 | - $directories[] = $temp; |
|
230 | - } |
|
231 | - if ($temp = sys_get_temp_dir()) { |
|
232 | - $directories[] = $temp; |
|
233 | - } |
|
215 | + $directories = []; |
|
216 | + if ($temp = $this->config->getSystemValue('tempdirectory', null)) { |
|
217 | + $directories[] = $temp; |
|
218 | + } |
|
219 | + if ($temp = \OC::$server->getIniWrapper()->get('upload_tmp_dir')) { |
|
220 | + $directories[] = $temp; |
|
221 | + } |
|
222 | + if ($temp = getenv('TMP')) { |
|
223 | + $directories[] = $temp; |
|
224 | + } |
|
225 | + if ($temp = getenv('TEMP')) { |
|
226 | + $directories[] = $temp; |
|
227 | + } |
|
228 | + if ($temp = getenv('TMPDIR')) { |
|
229 | + $directories[] = $temp; |
|
230 | + } |
|
231 | + if ($temp = sys_get_temp_dir()) { |
|
232 | + $directories[] = $temp; |
|
233 | + } |
|
234 | 234 | |
235 | - foreach ($directories as $dir) { |
|
236 | - if ($this->checkTemporaryDirectory($dir)) { |
|
237 | - return $dir; |
|
238 | - } |
|
239 | - } |
|
235 | + foreach ($directories as $dir) { |
|
236 | + if ($this->checkTemporaryDirectory($dir)) { |
|
237 | + return $dir; |
|
238 | + } |
|
239 | + } |
|
240 | 240 | |
241 | - $temp = tempnam(dirname(__FILE__), ''); |
|
242 | - if (file_exists($temp)) { |
|
243 | - unlink($temp); |
|
244 | - return dirname($temp); |
|
245 | - } |
|
246 | - throw new \UnexpectedValueException('Unable to detect system temporary directory'); |
|
247 | - } |
|
241 | + $temp = tempnam(dirname(__FILE__), ''); |
|
242 | + if (file_exists($temp)) { |
|
243 | + unlink($temp); |
|
244 | + return dirname($temp); |
|
245 | + } |
|
246 | + throw new \UnexpectedValueException('Unable to detect system temporary directory'); |
|
247 | + } |
|
248 | 248 | |
249 | - /** |
|
250 | - * Check if a temporary directory is ready for use |
|
251 | - * |
|
252 | - * @param mixed $directory |
|
253 | - * @return bool |
|
254 | - */ |
|
255 | - private function checkTemporaryDirectory($directory) { |
|
256 | - // suppress any possible errors caused by is_writable |
|
257 | - // checks missing or invalid path or characters, wrong permissions etc |
|
258 | - try { |
|
259 | - if (is_writeable($directory)) { |
|
260 | - return true; |
|
261 | - } |
|
262 | - } catch (\Exception $e) { |
|
263 | - } |
|
264 | - $this->log->warning('Temporary directory {dir} is not present or writable', |
|
265 | - ['dir' => $directory] |
|
266 | - ); |
|
267 | - return false; |
|
268 | - } |
|
249 | + /** |
|
250 | + * Check if a temporary directory is ready for use |
|
251 | + * |
|
252 | + * @param mixed $directory |
|
253 | + * @return bool |
|
254 | + */ |
|
255 | + private function checkTemporaryDirectory($directory) { |
|
256 | + // suppress any possible errors caused by is_writable |
|
257 | + // checks missing or invalid path or characters, wrong permissions etc |
|
258 | + try { |
|
259 | + if (is_writeable($directory)) { |
|
260 | + return true; |
|
261 | + } |
|
262 | + } catch (\Exception $e) { |
|
263 | + } |
|
264 | + $this->log->warning('Temporary directory {dir} is not present or writable', |
|
265 | + ['dir' => $directory] |
|
266 | + ); |
|
267 | + return false; |
|
268 | + } |
|
269 | 269 | |
270 | - /** |
|
271 | - * Override the temporary base directory |
|
272 | - * |
|
273 | - * @param string $directory |
|
274 | - */ |
|
275 | - public function overrideTempBaseDir($directory) { |
|
276 | - $this->tmpBaseDir = $directory; |
|
277 | - } |
|
270 | + /** |
|
271 | + * Override the temporary base directory |
|
272 | + * |
|
273 | + * @param string $directory |
|
274 | + */ |
|
275 | + public function overrideTempBaseDir($directory) { |
|
276 | + $this->tmpBaseDir = $directory; |
|
277 | + } |
|
278 | 278 | |
279 | 279 | } |
@@ -24,15 +24,15 @@ |
||
24 | 24 | namespace OC; |
25 | 25 | |
26 | 26 | class DatabaseException extends \Exception { |
27 | - private $query; |
|
27 | + private $query; |
|
28 | 28 | |
29 | - //FIXME getQuery seems to be unused, maybe use parent constructor with $message, $code and $previous |
|
30 | - public function __construct($message, $query = null){ |
|
31 | - parent::__construct($message); |
|
32 | - $this->query = $query; |
|
33 | - } |
|
29 | + //FIXME getQuery seems to be unused, maybe use parent constructor with $message, $code and $previous |
|
30 | + public function __construct($message, $query = null){ |
|
31 | + parent::__construct($message); |
|
32 | + $this->query = $query; |
|
33 | + } |
|
34 | 34 | |
35 | - public function getQuery() { |
|
36 | - return $this->query; |
|
37 | - } |
|
35 | + public function getQuery() { |
|
36 | + return $this->query; |
|
37 | + } |
|
38 | 38 | } |