@@ -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 | } |
@@ -50,9 +50,9 @@ |
||
50 | 50 | * @return string |
51 | 51 | */ |
52 | 52 | public function getEncryptedValue() { |
53 | - if($this->encryptedValue === '') { |
|
53 | + if ($this->encryptedValue === '') { |
|
54 | 54 | $sharedSecret = random_bytes(strlen($this->value)); |
55 | - $this->encryptedValue = base64_encode($this->value ^ $sharedSecret) . ':' . base64_encode($sharedSecret); |
|
55 | + $this->encryptedValue = base64_encode($this->value ^ $sharedSecret).':'.base64_encode($sharedSecret); |
|
56 | 56 | } |
57 | 57 | |
58 | 58 | return $this->encryptedValue; |
@@ -31,46 +31,46 @@ |
||
31 | 31 | * @package OC\Security\CSRF |
32 | 32 | */ |
33 | 33 | class CsrfToken { |
34 | - /** @var string */ |
|
35 | - private $value; |
|
36 | - /** @var string */ |
|
37 | - private $encryptedValue = ''; |
|
34 | + /** @var string */ |
|
35 | + private $value; |
|
36 | + /** @var string */ |
|
37 | + private $encryptedValue = ''; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param string $value Value of the token. Can be encrypted or not encrypted. |
|
41 | - */ |
|
42 | - public function __construct($value) { |
|
43 | - $this->value = $value; |
|
44 | - } |
|
39 | + /** |
|
40 | + * @param string $value Value of the token. Can be encrypted or not encrypted. |
|
41 | + */ |
|
42 | + public function __construct($value) { |
|
43 | + $this->value = $value; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * Encrypted value of the token. This is used to mitigate BREACH alike |
|
48 | - * vulnerabilities. For display measures do use this functionality. |
|
49 | - * |
|
50 | - * @return string |
|
51 | - */ |
|
52 | - public function getEncryptedValue() { |
|
53 | - if($this->encryptedValue === '') { |
|
54 | - $sharedSecret = random_bytes(strlen($this->value)); |
|
55 | - $this->encryptedValue = base64_encode($this->value ^ $sharedSecret) . ':' . base64_encode($sharedSecret); |
|
56 | - } |
|
46 | + /** |
|
47 | + * Encrypted value of the token. This is used to mitigate BREACH alike |
|
48 | + * vulnerabilities. For display measures do use this functionality. |
|
49 | + * |
|
50 | + * @return string |
|
51 | + */ |
|
52 | + public function getEncryptedValue() { |
|
53 | + if($this->encryptedValue === '') { |
|
54 | + $sharedSecret = random_bytes(strlen($this->value)); |
|
55 | + $this->encryptedValue = base64_encode($this->value ^ $sharedSecret) . ':' . base64_encode($sharedSecret); |
|
56 | + } |
|
57 | 57 | |
58 | - return $this->encryptedValue; |
|
59 | - } |
|
58 | + return $this->encryptedValue; |
|
59 | + } |
|
60 | 60 | |
61 | - /** |
|
62 | - * The unencrypted value of the token. Used for decrypting an already |
|
63 | - * encrypted token. |
|
64 | - * |
|
65 | - * @return string |
|
66 | - */ |
|
67 | - public function getDecryptedValue() { |
|
68 | - $token = explode(':', $this->value); |
|
69 | - if (count($token) !== 2) { |
|
70 | - return ''; |
|
71 | - } |
|
72 | - $obfuscatedToken = $token[0]; |
|
73 | - $secret = $token[1]; |
|
74 | - return base64_decode($obfuscatedToken) ^ base64_decode($secret); |
|
75 | - } |
|
61 | + /** |
|
62 | + * The unencrypted value of the token. Used for decrypting an already |
|
63 | + * encrypted token. |
|
64 | + * |
|
65 | + * @return string |
|
66 | + */ |
|
67 | + public function getDecryptedValue() { |
|
68 | + $token = explode(':', $this->value); |
|
69 | + if (count($token) !== 2) { |
|
70 | + return ''; |
|
71 | + } |
|
72 | + $obfuscatedToken = $token[0]; |
|
73 | + $secret = $token[1]; |
|
74 | + return base64_decode($obfuscatedToken) ^ base64_decode($secret); |
|
75 | + } |
|
76 | 76 | } |
@@ -30,59 +30,59 @@ |
||
30 | 30 | * @package OC\Security\CSRF\TokenStorage |
31 | 31 | */ |
32 | 32 | class SessionStorage { |
33 | - /** @var ISession */ |
|
34 | - private $session; |
|
33 | + /** @var ISession */ |
|
34 | + private $session; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param ISession $session |
|
38 | - */ |
|
39 | - public function __construct(ISession $session) { |
|
40 | - $this->session = $session; |
|
41 | - } |
|
36 | + /** |
|
37 | + * @param ISession $session |
|
38 | + */ |
|
39 | + public function __construct(ISession $session) { |
|
40 | + $this->session = $session; |
|
41 | + } |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param ISession $session |
|
45 | - */ |
|
46 | - public function setSession(ISession $session) { |
|
47 | - $this->session = $session; |
|
48 | - } |
|
43 | + /** |
|
44 | + * @param ISession $session |
|
45 | + */ |
|
46 | + public function setSession(ISession $session) { |
|
47 | + $this->session = $session; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns the current token or throws an exception if none is found. |
|
52 | - * |
|
53 | - * @return string |
|
54 | - * @throws \Exception |
|
55 | - */ |
|
56 | - public function getToken() { |
|
57 | - $token = $this->session->get('requesttoken'); |
|
58 | - if(empty($token)) { |
|
59 | - throw new \Exception('Session does not contain a requesttoken'); |
|
60 | - } |
|
50 | + /** |
|
51 | + * Returns the current token or throws an exception if none is found. |
|
52 | + * |
|
53 | + * @return string |
|
54 | + * @throws \Exception |
|
55 | + */ |
|
56 | + public function getToken() { |
|
57 | + $token = $this->session->get('requesttoken'); |
|
58 | + if(empty($token)) { |
|
59 | + throw new \Exception('Session does not contain a requesttoken'); |
|
60 | + } |
|
61 | 61 | |
62 | - return $token; |
|
63 | - } |
|
62 | + return $token; |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Set the valid current token to $value. |
|
67 | - * |
|
68 | - * @param string $value |
|
69 | - */ |
|
70 | - public function setToken($value) { |
|
71 | - $this->session->set('requesttoken', $value); |
|
72 | - } |
|
65 | + /** |
|
66 | + * Set the valid current token to $value. |
|
67 | + * |
|
68 | + * @param string $value |
|
69 | + */ |
|
70 | + public function setToken($value) { |
|
71 | + $this->session->set('requesttoken', $value); |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * Removes the current token. |
|
76 | - */ |
|
77 | - public function removeToken() { |
|
78 | - $this->session->remove('requesttoken'); |
|
79 | - } |
|
80 | - /** |
|
81 | - * Whether the storage has a storage. |
|
82 | - * |
|
83 | - * @return bool |
|
84 | - */ |
|
85 | - public function hasToken() { |
|
86 | - return $this->session->exists('requesttoken'); |
|
87 | - } |
|
74 | + /** |
|
75 | + * Removes the current token. |
|
76 | + */ |
|
77 | + public function removeToken() { |
|
78 | + $this->session->remove('requesttoken'); |
|
79 | + } |
|
80 | + /** |
|
81 | + * Whether the storage has a storage. |
|
82 | + * |
|
83 | + * @return bool |
|
84 | + */ |
|
85 | + public function hasToken() { |
|
86 | + return $this->session->exists('requesttoken'); |
|
87 | + } |
|
88 | 88 | } |
@@ -55,7 +55,7 @@ |
||
55 | 55 | */ |
56 | 56 | public function getToken() { |
57 | 57 | $token = $this->session->get('requesttoken'); |
58 | - if(empty($token)) { |
|
58 | + if (empty($token)) { |
|
59 | 59 | throw new \Exception('Session does not contain a requesttoken'); |
60 | 60 | } |
61 | 61 |
@@ -30,78 +30,78 @@ |
||
30 | 30 | * @package OC\Security\CSRF |
31 | 31 | */ |
32 | 32 | class CsrfTokenManager { |
33 | - /** @var CsrfTokenGenerator */ |
|
34 | - private $tokenGenerator; |
|
35 | - /** @var SessionStorage */ |
|
36 | - private $sessionStorage; |
|
37 | - /** @var CsrfToken|null */ |
|
38 | - private $csrfToken = null; |
|
33 | + /** @var CsrfTokenGenerator */ |
|
34 | + private $tokenGenerator; |
|
35 | + /** @var SessionStorage */ |
|
36 | + private $sessionStorage; |
|
37 | + /** @var CsrfToken|null */ |
|
38 | + private $csrfToken = null; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param CsrfTokenGenerator $tokenGenerator |
|
42 | - * @param SessionStorage $storageInterface |
|
43 | - */ |
|
44 | - public function __construct(CsrfTokenGenerator $tokenGenerator, |
|
45 | - SessionStorage $storageInterface) { |
|
46 | - $this->tokenGenerator = $tokenGenerator; |
|
47 | - $this->sessionStorage = $storageInterface; |
|
48 | - } |
|
40 | + /** |
|
41 | + * @param CsrfTokenGenerator $tokenGenerator |
|
42 | + * @param SessionStorage $storageInterface |
|
43 | + */ |
|
44 | + public function __construct(CsrfTokenGenerator $tokenGenerator, |
|
45 | + SessionStorage $storageInterface) { |
|
46 | + $this->tokenGenerator = $tokenGenerator; |
|
47 | + $this->sessionStorage = $storageInterface; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns the current CSRF token, if none set it will create a new one. |
|
52 | - * |
|
53 | - * @return CsrfToken |
|
54 | - */ |
|
55 | - public function getToken() { |
|
56 | - if(!is_null($this->csrfToken)) { |
|
57 | - return $this->csrfToken; |
|
58 | - } |
|
50 | + /** |
|
51 | + * Returns the current CSRF token, if none set it will create a new one. |
|
52 | + * |
|
53 | + * @return CsrfToken |
|
54 | + */ |
|
55 | + public function getToken() { |
|
56 | + if(!is_null($this->csrfToken)) { |
|
57 | + return $this->csrfToken; |
|
58 | + } |
|
59 | 59 | |
60 | - if($this->sessionStorage->hasToken()) { |
|
61 | - $value = $this->sessionStorage->getToken(); |
|
62 | - } else { |
|
63 | - $value = $this->tokenGenerator->generateToken(); |
|
64 | - $this->sessionStorage->setToken($value); |
|
65 | - } |
|
60 | + if($this->sessionStorage->hasToken()) { |
|
61 | + $value = $this->sessionStorage->getToken(); |
|
62 | + } else { |
|
63 | + $value = $this->tokenGenerator->generateToken(); |
|
64 | + $this->sessionStorage->setToken($value); |
|
65 | + } |
|
66 | 66 | |
67 | - $this->csrfToken = new CsrfToken($value); |
|
68 | - return $this->csrfToken; |
|
69 | - } |
|
67 | + $this->csrfToken = new CsrfToken($value); |
|
68 | + return $this->csrfToken; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * Invalidates any current token and sets a new one. |
|
73 | - * |
|
74 | - * @return CsrfToken |
|
75 | - */ |
|
76 | - public function refreshToken() { |
|
77 | - $value = $this->tokenGenerator->generateToken(); |
|
78 | - $this->sessionStorage->setToken($value); |
|
79 | - $this->csrfToken = new CsrfToken($value); |
|
80 | - return $this->csrfToken; |
|
81 | - } |
|
71 | + /** |
|
72 | + * Invalidates any current token and sets a new one. |
|
73 | + * |
|
74 | + * @return CsrfToken |
|
75 | + */ |
|
76 | + public function refreshToken() { |
|
77 | + $value = $this->tokenGenerator->generateToken(); |
|
78 | + $this->sessionStorage->setToken($value); |
|
79 | + $this->csrfToken = new CsrfToken($value); |
|
80 | + return $this->csrfToken; |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Remove the current token from the storage. |
|
85 | - */ |
|
86 | - public function removeToken() { |
|
87 | - $this->csrfToken = null; |
|
88 | - $this->sessionStorage->removeToken(); |
|
89 | - } |
|
83 | + /** |
|
84 | + * Remove the current token from the storage. |
|
85 | + */ |
|
86 | + public function removeToken() { |
|
87 | + $this->csrfToken = null; |
|
88 | + $this->sessionStorage->removeToken(); |
|
89 | + } |
|
90 | 90 | |
91 | - /** |
|
92 | - * Verifies whether the provided token is valid. |
|
93 | - * |
|
94 | - * @param CsrfToken $token |
|
95 | - * @return bool |
|
96 | - */ |
|
97 | - public function isTokenValid(CsrfToken $token) { |
|
98 | - if(!$this->sessionStorage->hasToken()) { |
|
99 | - return false; |
|
100 | - } |
|
91 | + /** |
|
92 | + * Verifies whether the provided token is valid. |
|
93 | + * |
|
94 | + * @param CsrfToken $token |
|
95 | + * @return bool |
|
96 | + */ |
|
97 | + public function isTokenValid(CsrfToken $token) { |
|
98 | + if(!$this->sessionStorage->hasToken()) { |
|
99 | + return false; |
|
100 | + } |
|
101 | 101 | |
102 | - return hash_equals( |
|
103 | - $this->sessionStorage->getToken(), |
|
104 | - $token->getDecryptedValue() |
|
105 | - ); |
|
106 | - } |
|
102 | + return hash_equals( |
|
103 | + $this->sessionStorage->getToken(), |
|
104 | + $token->getDecryptedValue() |
|
105 | + ); |
|
106 | + } |
|
107 | 107 | } |
@@ -53,11 +53,11 @@ discard block |
||
53 | 53 | * @return CsrfToken |
54 | 54 | */ |
55 | 55 | public function getToken() { |
56 | - if(!is_null($this->csrfToken)) { |
|
56 | + if (!is_null($this->csrfToken)) { |
|
57 | 57 | return $this->csrfToken; |
58 | 58 | } |
59 | 59 | |
60 | - if($this->sessionStorage->hasToken()) { |
|
60 | + if ($this->sessionStorage->hasToken()) { |
|
61 | 61 | $value = $this->sessionStorage->getToken(); |
62 | 62 | } else { |
63 | 63 | $value = $this->tokenGenerator->generateToken(); |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | * @return bool |
96 | 96 | */ |
97 | 97 | public function isTokenValid(CsrfToken $token) { |
98 | - if(!$this->sessionStorage->hasToken()) { |
|
98 | + if (!$this->sessionStorage->hasToken()) { |
|
99 | 99 | return false; |
100 | 100 | } |
101 | 101 |
@@ -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 | } |
@@ -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 | } |
@@ -54,19 +54,19 @@ |
||
54 | 54 | |
55 | 55 | // If string starts with "file://" ignore the certificate |
56 | 56 | $query = 'file://'; |
57 | - if(strtolower(substr($data, 0, strlen($query))) === $query) { |
|
57 | + if (strtolower(substr($data, 0, strlen($query))) === $query) { |
|
58 | 58 | throw new \Exception('Certificate could not get parsed.'); |
59 | 59 | } |
60 | 60 | |
61 | 61 | $info = openssl_x509_parse($data); |
62 | - if(!is_array($info)) { |
|
62 | + if (!is_array($info)) { |
|
63 | 63 | throw new \Exception('Certificate could not get parsed.'); |
64 | 64 | } |
65 | 65 | |
66 | 66 | $this->commonName = isset($info['subject']['CN']) ? $info['subject']['CN'] : null; |
67 | 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); |
|
68 | + $this->issueDate = new \DateTime('@'.$info['validFrom_time_t'], $gmt); |
|
69 | + $this->expireDate = new \DateTime('@'.$info['validTo_time_t'], $gmt); |
|
70 | 70 | $this->issuerName = isset($info['issuer']['CN']) ? $info['issuer']['CN'] : null; |
71 | 71 | $this->issuerOrganization = isset($info['issuer']['O']) ? $info['issuer']['O'] : null; |
72 | 72 | } |
@@ -26,76 +26,76 @@ |
||
26 | 26 | use OCP\IUserManager; |
27 | 27 | |
28 | 28 | class Signer { |
29 | - /** @var Manager */ |
|
30 | - private $keyManager; |
|
31 | - /** @var ITimeFactory */ |
|
32 | - private $timeFactory; |
|
33 | - /** @var IUserManager */ |
|
34 | - private $userManager; |
|
29 | + /** @var Manager */ |
|
30 | + private $keyManager; |
|
31 | + /** @var ITimeFactory */ |
|
32 | + private $timeFactory; |
|
33 | + /** @var IUserManager */ |
|
34 | + private $userManager; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @param Manager $keyManager |
|
38 | - * @param ITimeFactory $timeFactory |
|
39 | - * @param IUserManager $userManager |
|
40 | - */ |
|
41 | - public function __construct(Manager $keyManager, |
|
42 | - ITimeFactory $timeFactory, |
|
43 | - IUserManager $userManager) { |
|
44 | - $this->keyManager = $keyManager; |
|
45 | - $this->timeFactory = $timeFactory; |
|
46 | - $this->userManager = $userManager; |
|
47 | - } |
|
36 | + /** |
|
37 | + * @param Manager $keyManager |
|
38 | + * @param ITimeFactory $timeFactory |
|
39 | + * @param IUserManager $userManager |
|
40 | + */ |
|
41 | + public function __construct(Manager $keyManager, |
|
42 | + ITimeFactory $timeFactory, |
|
43 | + IUserManager $userManager) { |
|
44 | + $this->keyManager = $keyManager; |
|
45 | + $this->timeFactory = $timeFactory; |
|
46 | + $this->userManager = $userManager; |
|
47 | + } |
|
48 | 48 | |
49 | - /** |
|
50 | - * Returns a signed blob for $data |
|
51 | - * |
|
52 | - * @param string $type |
|
53 | - * @param array $data |
|
54 | - * @param IUser $user |
|
55 | - * @return array ['message', 'signature'] |
|
56 | - */ |
|
57 | - public function sign($type, array $data, IUser $user) { |
|
58 | - $privateKey = $this->keyManager->getKey($user)->getPrivate(); |
|
59 | - $data = [ |
|
60 | - 'data' => $data, |
|
61 | - 'type' => $type, |
|
62 | - 'signer' => $user->getCloudId(), |
|
63 | - 'timestamp' => $this->timeFactory->getTime(), |
|
64 | - ]; |
|
65 | - openssl_sign(json_encode($data), $signature, $privateKey, OPENSSL_ALGO_SHA512); |
|
49 | + /** |
|
50 | + * Returns a signed blob for $data |
|
51 | + * |
|
52 | + * @param string $type |
|
53 | + * @param array $data |
|
54 | + * @param IUser $user |
|
55 | + * @return array ['message', 'signature'] |
|
56 | + */ |
|
57 | + public function sign($type, array $data, IUser $user) { |
|
58 | + $privateKey = $this->keyManager->getKey($user)->getPrivate(); |
|
59 | + $data = [ |
|
60 | + 'data' => $data, |
|
61 | + 'type' => $type, |
|
62 | + 'signer' => $user->getCloudId(), |
|
63 | + 'timestamp' => $this->timeFactory->getTime(), |
|
64 | + ]; |
|
65 | + openssl_sign(json_encode($data), $signature, $privateKey, OPENSSL_ALGO_SHA512); |
|
66 | 66 | |
67 | - return [ |
|
68 | - 'message' => $data, |
|
69 | - 'signature' => base64_encode($signature), |
|
70 | - ]; |
|
71 | - } |
|
67 | + return [ |
|
68 | + 'message' => $data, |
|
69 | + 'signature' => base64_encode($signature), |
|
70 | + ]; |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * Whether the data is signed properly |
|
75 | - * |
|
76 | - * @param array $data |
|
77 | - * @return bool |
|
78 | - */ |
|
79 | - public function verify(array $data) { |
|
80 | - if(isset($data['message']) |
|
81 | - && isset($data['signature']) |
|
82 | - && isset($data['message']['signer']) |
|
83 | - ) { |
|
84 | - $location = strrpos($data['message']['signer'], '@'); |
|
85 | - $userId = substr($data['message']['signer'], 0, $location); |
|
73 | + /** |
|
74 | + * Whether the data is signed properly |
|
75 | + * |
|
76 | + * @param array $data |
|
77 | + * @return bool |
|
78 | + */ |
|
79 | + public function verify(array $data) { |
|
80 | + if(isset($data['message']) |
|
81 | + && isset($data['signature']) |
|
82 | + && isset($data['message']['signer']) |
|
83 | + ) { |
|
84 | + $location = strrpos($data['message']['signer'], '@'); |
|
85 | + $userId = substr($data['message']['signer'], 0, $location); |
|
86 | 86 | |
87 | - $user = $this->userManager->get($userId); |
|
88 | - if($user !== null) { |
|
89 | - $key = $this->keyManager->getKey($user); |
|
90 | - return (bool)openssl_verify( |
|
91 | - json_encode($data['message']), |
|
92 | - base64_decode($data['signature']), |
|
93 | - $key->getPublic(), |
|
94 | - OPENSSL_ALGO_SHA512 |
|
95 | - ); |
|
96 | - } |
|
97 | - } |
|
87 | + $user = $this->userManager->get($userId); |
|
88 | + if($user !== null) { |
|
89 | + $key = $this->keyManager->getKey($user); |
|
90 | + return (bool)openssl_verify( |
|
91 | + json_encode($data['message']), |
|
92 | + base64_decode($data['signature']), |
|
93 | + $key->getPublic(), |
|
94 | + OPENSSL_ALGO_SHA512 |
|
95 | + ); |
|
96 | + } |
|
97 | + } |
|
98 | 98 | |
99 | - return false; |
|
100 | - } |
|
99 | + return false; |
|
100 | + } |
|
101 | 101 | } |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | * @return bool |
78 | 78 | */ |
79 | 79 | public function verify(array $data) { |
80 | - if(isset($data['message']) |
|
80 | + if (isset($data['message']) |
|
81 | 81 | && isset($data['signature']) |
82 | 82 | && isset($data['message']['signer']) |
83 | 83 | ) { |
@@ -85,9 +85,9 @@ discard block |
||
85 | 85 | $userId = substr($data['message']['signer'], 0, $location); |
86 | 86 | |
87 | 87 | $user = $this->userManager->get($userId); |
88 | - if($user !== null) { |
|
88 | + if ($user !== null) { |
|
89 | 89 | $key = $this->keyManager->getKey($user); |
90 | - return (bool)openssl_verify( |
|
90 | + return (bool) openssl_verify( |
|
91 | 91 | json_encode($data['message']), |
92 | 92 | base64_decode($data['signature']), |
93 | 93 | $key->getPublic(), |
@@ -22,25 +22,25 @@ |
||
22 | 22 | namespace OC\Security\IdentityProof; |
23 | 23 | |
24 | 24 | class Key { |
25 | - /** @var string */ |
|
26 | - private $publicKey; |
|
27 | - /** @var string */ |
|
28 | - private $privateKey; |
|
25 | + /** @var string */ |
|
26 | + private $publicKey; |
|
27 | + /** @var string */ |
|
28 | + private $privateKey; |
|
29 | 29 | |
30 | - /** |
|
31 | - * @param string $publicKey |
|
32 | - * @param string $privateKey |
|
33 | - */ |
|
34 | - public function __construct($publicKey, $privateKey) { |
|
35 | - $this->publicKey = $publicKey; |
|
36 | - $this->privateKey = $privateKey; |
|
37 | - } |
|
30 | + /** |
|
31 | + * @param string $publicKey |
|
32 | + * @param string $privateKey |
|
33 | + */ |
|
34 | + public function __construct($publicKey, $privateKey) { |
|
35 | + $this->publicKey = $publicKey; |
|
36 | + $this->privateKey = $privateKey; |
|
37 | + } |
|
38 | 38 | |
39 | - public function getPrivate() { |
|
40 | - return $this->privateKey; |
|
41 | - } |
|
39 | + public function getPrivate() { |
|
40 | + return $this->privateKey; |
|
41 | + } |
|
42 | 42 | |
43 | - public function getPublic() { |
|
44 | - return $this->publicKey; |
|
45 | - } |
|
43 | + public function getPublic() { |
|
44 | + return $this->publicKey; |
|
45 | + } |
|
46 | 46 | } |
@@ -65,13 +65,13 @@ discard block |
||
65 | 65 | * @return string |
66 | 66 | */ |
67 | 67 | private function buildFileNameWithSuffix($absolutePath, $postFix = '') { |
68 | - if($postFix !== '') { |
|
69 | - $postFix = '.' . ltrim($postFix, '.'); |
|
68 | + if ($postFix !== '') { |
|
69 | + $postFix = '.'.ltrim($postFix, '.'); |
|
70 | 70 | $postFix = str_replace(['\\', '/'], '', $postFix); |
71 | 71 | $absolutePath .= '-'; |
72 | 72 | } |
73 | 73 | |
74 | - return $absolutePath . $postFix; |
|
74 | + return $absolutePath.$postFix; |
|
75 | 75 | } |
76 | 76 | |
77 | 77 | /** |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | |
92 | 92 | // If a postfix got specified sanitize it and create a postfixed |
93 | 93 | // temporary file |
94 | - if($postFix !== '') { |
|
94 | + if ($postFix !== '') { |
|
95 | 95 | $fileNameWithPostfix = $this->buildFileNameWithSuffix($file, $postFix); |
96 | 96 | touch($fileNameWithPostfix); |
97 | 97 | chmod($fileNameWithPostfix, 0600); |
@@ -127,11 +127,11 @@ discard block |
||
127 | 127 | $this->current[] = $uniqueFileName; |
128 | 128 | |
129 | 129 | // Build a name without postfix |
130 | - $path = $this->buildFileNameWithSuffix($uniqueFileName . '-folder', $postFix); |
|
130 | + $path = $this->buildFileNameWithSuffix($uniqueFileName.'-folder', $postFix); |
|
131 | 131 | mkdir($path, 0700); |
132 | 132 | $this->current[] = $path; |
133 | 133 | |
134 | - return $path . '/'; |
|
134 | + return $path.'/'; |
|
135 | 135 | } else { |
136 | 136 | $this->log->warning( |
137 | 137 | 'Can not create a temporary folder in directory {dir}. Check it exists and has correct permissions', |
@@ -190,7 +190,7 @@ discard block |
||
190 | 190 | if ($dh) { |
191 | 191 | while (($file = readdir($dh)) !== false) { |
192 | 192 | if (substr($file, 0, 7) === self::TMP_PREFIX) { |
193 | - $path = $this->tmpBaseDir . '/' . $file; |
|
193 | + $path = $this->tmpBaseDir.'/'.$file; |
|
194 | 194 | $mtime = filemtime($path); |
195 | 195 | if ($mtime < $cutOfTime) { |
196 | 196 | $files[] = $path; |
@@ -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_writable($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_writable($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 | } |