@@ -197,7 +197,7 @@ discard block |
||
| 197 | 197 | * @return string|false |
| 198 | 198 | */ |
| 199 | 199 | public function loginName2UserName($loginName) { |
| 200 | - $id = 'LOGINNAME,' . $loginName; |
|
| 200 | + $id = 'LOGINNAME,'.$loginName; |
|
| 201 | 201 | return $this->handleRequest($id, 'loginName2UserName', [$loginName]); |
| 202 | 202 | } |
| 203 | 203 | |
@@ -208,7 +208,7 @@ discard block |
||
| 208 | 208 | * @return string|false with the username |
| 209 | 209 | */ |
| 210 | 210 | public function dn2UserName($dn) { |
| 211 | - $id = 'DN,' . $dn; |
|
| 211 | + $id = 'DN,'.$dn; |
|
| 212 | 212 | return $this->handleRequest($id, 'dn2UserName', [$dn]); |
| 213 | 213 | } |
| 214 | 214 | |
@@ -38,351 +38,351 @@ |
||
| 38 | 38 | use OCP\User\Backend\ICountUsersBackend; |
| 39 | 39 | |
| 40 | 40 | class User_Proxy extends Proxy implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP, ICountUsersBackend { |
| 41 | - private $backends = []; |
|
| 42 | - /** @var User_LDAP */ |
|
| 43 | - private $refBackend = null; |
|
| 41 | + private $backends = []; |
|
| 42 | + /** @var User_LDAP */ |
|
| 43 | + private $refBackend = null; |
|
| 44 | 44 | |
| 45 | - public function __construct( |
|
| 46 | - Helper $helper, |
|
| 47 | - ILDAPWrapper $ldap, |
|
| 48 | - IConfig $ocConfig, |
|
| 49 | - INotificationManager $notificationManager, |
|
| 50 | - IUserSession $userSession, |
|
| 51 | - UserPluginManager $userPluginManager |
|
| 52 | - ) { |
|
| 53 | - parent::__construct($ldap); |
|
| 54 | - $serverConfigPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
| 55 | - foreach ($serverConfigPrefixes as $configPrefix) { |
|
| 56 | - $this->backends[$configPrefix] = |
|
| 57 | - new User_LDAP($this->getAccess($configPrefix), $ocConfig, $notificationManager, $userSession, $userPluginManager); |
|
| 45 | + public function __construct( |
|
| 46 | + Helper $helper, |
|
| 47 | + ILDAPWrapper $ldap, |
|
| 48 | + IConfig $ocConfig, |
|
| 49 | + INotificationManager $notificationManager, |
|
| 50 | + IUserSession $userSession, |
|
| 51 | + UserPluginManager $userPluginManager |
|
| 52 | + ) { |
|
| 53 | + parent::__construct($ldap); |
|
| 54 | + $serverConfigPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
| 55 | + foreach ($serverConfigPrefixes as $configPrefix) { |
|
| 56 | + $this->backends[$configPrefix] = |
|
| 57 | + new User_LDAP($this->getAccess($configPrefix), $ocConfig, $notificationManager, $userSession, $userPluginManager); |
|
| 58 | 58 | |
| 59 | - if (is_null($this->refBackend)) { |
|
| 60 | - $this->refBackend = &$this->backends[$configPrefix]; |
|
| 61 | - } |
|
| 62 | - } |
|
| 63 | - } |
|
| 59 | + if (is_null($this->refBackend)) { |
|
| 60 | + $this->refBackend = &$this->backends[$configPrefix]; |
|
| 61 | + } |
|
| 62 | + } |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Tries the backends one after the other until a positive result is returned from the specified method |
|
| 67 | - * |
|
| 68 | - * @param string $id the uid connected to the request |
|
| 69 | - * @param string $method the method of the user backend that shall be called |
|
| 70 | - * @param array $parameters an array of parameters to be passed |
|
| 71 | - * @return mixed the result of the method or false |
|
| 72 | - */ |
|
| 73 | - protected function walkBackends($id, $method, $parameters) { |
|
| 74 | - $uid = $id; |
|
| 75 | - $cacheKey = $this->getUserCacheKey($uid); |
|
| 76 | - foreach ($this->backends as $configPrefix => $backend) { |
|
| 77 | - $instance = $backend; |
|
| 78 | - if (!method_exists($instance, $method) |
|
| 79 | - && method_exists($this->getAccess($configPrefix), $method)) { |
|
| 80 | - $instance = $this->getAccess($configPrefix); |
|
| 81 | - } |
|
| 82 | - if ($result = call_user_func_array([$instance, $method], $parameters)) { |
|
| 83 | - if (!$this->isSingleBackend()) { |
|
| 84 | - $this->writeToCache($cacheKey, $configPrefix); |
|
| 85 | - } |
|
| 86 | - return $result; |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - return false; |
|
| 90 | - } |
|
| 65 | + /** |
|
| 66 | + * Tries the backends one after the other until a positive result is returned from the specified method |
|
| 67 | + * |
|
| 68 | + * @param string $id the uid connected to the request |
|
| 69 | + * @param string $method the method of the user backend that shall be called |
|
| 70 | + * @param array $parameters an array of parameters to be passed |
|
| 71 | + * @return mixed the result of the method or false |
|
| 72 | + */ |
|
| 73 | + protected function walkBackends($id, $method, $parameters) { |
|
| 74 | + $uid = $id; |
|
| 75 | + $cacheKey = $this->getUserCacheKey($uid); |
|
| 76 | + foreach ($this->backends as $configPrefix => $backend) { |
|
| 77 | + $instance = $backend; |
|
| 78 | + if (!method_exists($instance, $method) |
|
| 79 | + && method_exists($this->getAccess($configPrefix), $method)) { |
|
| 80 | + $instance = $this->getAccess($configPrefix); |
|
| 81 | + } |
|
| 82 | + if ($result = call_user_func_array([$instance, $method], $parameters)) { |
|
| 83 | + if (!$this->isSingleBackend()) { |
|
| 84 | + $this->writeToCache($cacheKey, $configPrefix); |
|
| 85 | + } |
|
| 86 | + return $result; |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + return false; |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Asks the backend connected to the server that supposely takes care of the uid from the request. |
|
| 94 | - * |
|
| 95 | - * @param string $id the uid connected to the request |
|
| 96 | - * @param string $method the method of the user backend that shall be called |
|
| 97 | - * @param array $parameters an array of parameters to be passed |
|
| 98 | - * @param mixed $passOnWhen the result matches this variable |
|
| 99 | - * @return mixed the result of the method or false |
|
| 100 | - */ |
|
| 101 | - protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen) { |
|
| 102 | - $uid = $id; |
|
| 103 | - $cacheKey = $this->getUserCacheKey($uid); |
|
| 104 | - $prefix = $this->getFromCache($cacheKey); |
|
| 105 | - //in case the uid has been found in the past, try this stored connection first |
|
| 106 | - if (!is_null($prefix)) { |
|
| 107 | - if (isset($this->backends[$prefix])) { |
|
| 108 | - $instance = $this->backends[$prefix]; |
|
| 109 | - if (!method_exists($instance, $method) |
|
| 110 | - && method_exists($this->getAccess($prefix), $method)) { |
|
| 111 | - $instance = $this->getAccess($prefix); |
|
| 112 | - } |
|
| 113 | - $result = call_user_func_array([$instance, $method], $parameters); |
|
| 114 | - if ($result === $passOnWhen) { |
|
| 115 | - //not found here, reset cache to null if user vanished |
|
| 116 | - //because sometimes methods return false with a reason |
|
| 117 | - $userExists = call_user_func_array( |
|
| 118 | - [$this->backends[$prefix], 'userExistsOnLDAP'], |
|
| 119 | - [$uid] |
|
| 120 | - ); |
|
| 121 | - if (!$userExists) { |
|
| 122 | - $this->writeToCache($cacheKey, null); |
|
| 123 | - } |
|
| 124 | - } |
|
| 125 | - return $result; |
|
| 126 | - } |
|
| 127 | - } |
|
| 128 | - return false; |
|
| 129 | - } |
|
| 92 | + /** |
|
| 93 | + * Asks the backend connected to the server that supposely takes care of the uid from the request. |
|
| 94 | + * |
|
| 95 | + * @param string $id the uid connected to the request |
|
| 96 | + * @param string $method the method of the user backend that shall be called |
|
| 97 | + * @param array $parameters an array of parameters to be passed |
|
| 98 | + * @param mixed $passOnWhen the result matches this variable |
|
| 99 | + * @return mixed the result of the method or false |
|
| 100 | + */ |
|
| 101 | + protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen) { |
|
| 102 | + $uid = $id; |
|
| 103 | + $cacheKey = $this->getUserCacheKey($uid); |
|
| 104 | + $prefix = $this->getFromCache($cacheKey); |
|
| 105 | + //in case the uid has been found in the past, try this stored connection first |
|
| 106 | + if (!is_null($prefix)) { |
|
| 107 | + if (isset($this->backends[$prefix])) { |
|
| 108 | + $instance = $this->backends[$prefix]; |
|
| 109 | + if (!method_exists($instance, $method) |
|
| 110 | + && method_exists($this->getAccess($prefix), $method)) { |
|
| 111 | + $instance = $this->getAccess($prefix); |
|
| 112 | + } |
|
| 113 | + $result = call_user_func_array([$instance, $method], $parameters); |
|
| 114 | + if ($result === $passOnWhen) { |
|
| 115 | + //not found here, reset cache to null if user vanished |
|
| 116 | + //because sometimes methods return false with a reason |
|
| 117 | + $userExists = call_user_func_array( |
|
| 118 | + [$this->backends[$prefix], 'userExistsOnLDAP'], |
|
| 119 | + [$uid] |
|
| 120 | + ); |
|
| 121 | + if (!$userExists) { |
|
| 122 | + $this->writeToCache($cacheKey, null); |
|
| 123 | + } |
|
| 124 | + } |
|
| 125 | + return $result; |
|
| 126 | + } |
|
| 127 | + } |
|
| 128 | + return false; |
|
| 129 | + } |
|
| 130 | 130 | |
| 131 | - protected function activeBackends(): int { |
|
| 132 | - return count($this->backends); |
|
| 133 | - } |
|
| 131 | + protected function activeBackends(): int { |
|
| 132 | + return count($this->backends); |
|
| 133 | + } |
|
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * Check if backend implements actions |
|
| 137 | - * |
|
| 138 | - * @param int $actions bitwise-or'ed actions |
|
| 139 | - * @return boolean |
|
| 140 | - * |
|
| 141 | - * Returns the supported actions as int to be |
|
| 142 | - * compared with \OC\User\Backend::CREATE_USER etc. |
|
| 143 | - */ |
|
| 144 | - public function implementsActions($actions) { |
|
| 145 | - //it's the same across all our user backends obviously |
|
| 146 | - return $this->refBackend->implementsActions($actions); |
|
| 147 | - } |
|
| 135 | + /** |
|
| 136 | + * Check if backend implements actions |
|
| 137 | + * |
|
| 138 | + * @param int $actions bitwise-or'ed actions |
|
| 139 | + * @return boolean |
|
| 140 | + * |
|
| 141 | + * Returns the supported actions as int to be |
|
| 142 | + * compared with \OC\User\Backend::CREATE_USER etc. |
|
| 143 | + */ |
|
| 144 | + public function implementsActions($actions) { |
|
| 145 | + //it's the same across all our user backends obviously |
|
| 146 | + return $this->refBackend->implementsActions($actions); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Backend name to be shown in user management |
|
| 151 | - * |
|
| 152 | - * @return string the name of the backend to be shown |
|
| 153 | - */ |
|
| 154 | - public function getBackendName() { |
|
| 155 | - return $this->refBackend->getBackendName(); |
|
| 156 | - } |
|
| 149 | + /** |
|
| 150 | + * Backend name to be shown in user management |
|
| 151 | + * |
|
| 152 | + * @return string the name of the backend to be shown |
|
| 153 | + */ |
|
| 154 | + public function getBackendName() { |
|
| 155 | + return $this->refBackend->getBackendName(); |
|
| 156 | + } |
|
| 157 | 157 | |
| 158 | - /** |
|
| 159 | - * Get a list of all users |
|
| 160 | - * |
|
| 161 | - * @param string $search |
|
| 162 | - * @param null|int $limit |
|
| 163 | - * @param null|int $offset |
|
| 164 | - * @return string[] an array of all uids |
|
| 165 | - */ |
|
| 166 | - public function getUsers($search = '', $limit = 10, $offset = 0) { |
|
| 167 | - //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends |
|
| 168 | - $users = []; |
|
| 169 | - foreach ($this->backends as $backend) { |
|
| 170 | - $backendUsers = $backend->getUsers($search, $limit, $offset); |
|
| 171 | - if (is_array($backendUsers)) { |
|
| 172 | - $users = array_merge($users, $backendUsers); |
|
| 173 | - } |
|
| 174 | - } |
|
| 175 | - return $users; |
|
| 176 | - } |
|
| 158 | + /** |
|
| 159 | + * Get a list of all users |
|
| 160 | + * |
|
| 161 | + * @param string $search |
|
| 162 | + * @param null|int $limit |
|
| 163 | + * @param null|int $offset |
|
| 164 | + * @return string[] an array of all uids |
|
| 165 | + */ |
|
| 166 | + public function getUsers($search = '', $limit = 10, $offset = 0) { |
|
| 167 | + //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends |
|
| 168 | + $users = []; |
|
| 169 | + foreach ($this->backends as $backend) { |
|
| 170 | + $backendUsers = $backend->getUsers($search, $limit, $offset); |
|
| 171 | + if (is_array($backendUsers)) { |
|
| 172 | + $users = array_merge($users, $backendUsers); |
|
| 173 | + } |
|
| 174 | + } |
|
| 175 | + return $users; |
|
| 176 | + } |
|
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * check if a user exists |
|
| 180 | - * |
|
| 181 | - * @param string $uid the username |
|
| 182 | - * @return boolean |
|
| 183 | - */ |
|
| 184 | - public function userExists($uid) { |
|
| 185 | - $existsOnLDAP = false; |
|
| 186 | - $existsLocally = $this->handleRequest($uid, 'userExists', [$uid]); |
|
| 187 | - if ($existsLocally) { |
|
| 188 | - $existsOnLDAP = $this->userExistsOnLDAP($uid); |
|
| 189 | - } |
|
| 190 | - if ($existsLocally && !$existsOnLDAP) { |
|
| 191 | - try { |
|
| 192 | - $user = $this->getLDAPAccess($uid)->userManager->get($uid); |
|
| 193 | - if ($user instanceof User) { |
|
| 194 | - $user->markUser(); |
|
| 195 | - } |
|
| 196 | - } catch (\Exception $e) { |
|
| 197 | - // ignore |
|
| 198 | - } |
|
| 199 | - } |
|
| 200 | - return $existsLocally; |
|
| 201 | - } |
|
| 178 | + /** |
|
| 179 | + * check if a user exists |
|
| 180 | + * |
|
| 181 | + * @param string $uid the username |
|
| 182 | + * @return boolean |
|
| 183 | + */ |
|
| 184 | + public function userExists($uid) { |
|
| 185 | + $existsOnLDAP = false; |
|
| 186 | + $existsLocally = $this->handleRequest($uid, 'userExists', [$uid]); |
|
| 187 | + if ($existsLocally) { |
|
| 188 | + $existsOnLDAP = $this->userExistsOnLDAP($uid); |
|
| 189 | + } |
|
| 190 | + if ($existsLocally && !$existsOnLDAP) { |
|
| 191 | + try { |
|
| 192 | + $user = $this->getLDAPAccess($uid)->userManager->get($uid); |
|
| 193 | + if ($user instanceof User) { |
|
| 194 | + $user->markUser(); |
|
| 195 | + } |
|
| 196 | + } catch (\Exception $e) { |
|
| 197 | + // ignore |
|
| 198 | + } |
|
| 199 | + } |
|
| 200 | + return $existsLocally; |
|
| 201 | + } |
|
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * check if a user exists on LDAP |
|
| 205 | - * |
|
| 206 | - * @param string|\OCA\User_LDAP\User\User $user either the Nextcloud user |
|
| 207 | - * name or an instance of that user |
|
| 208 | - */ |
|
| 209 | - public function userExistsOnLDAP($user, bool $ignoreCache = false): bool { |
|
| 210 | - $id = ($user instanceof User) ? $user->getUsername() : $user; |
|
| 211 | - return $this->handleRequest($id, 'userExistsOnLDAP', [$user, $ignoreCache]); |
|
| 212 | - } |
|
| 203 | + /** |
|
| 204 | + * check if a user exists on LDAP |
|
| 205 | + * |
|
| 206 | + * @param string|\OCA\User_LDAP\User\User $user either the Nextcloud user |
|
| 207 | + * name or an instance of that user |
|
| 208 | + */ |
|
| 209 | + public function userExistsOnLDAP($user, bool $ignoreCache = false): bool { |
|
| 210 | + $id = ($user instanceof User) ? $user->getUsername() : $user; |
|
| 211 | + return $this->handleRequest($id, 'userExistsOnLDAP', [$user, $ignoreCache]); |
|
| 212 | + } |
|
| 213 | 213 | |
| 214 | - /** |
|
| 215 | - * Check if the password is correct |
|
| 216 | - * |
|
| 217 | - * @param string $uid The username |
|
| 218 | - * @param string $password The password |
|
| 219 | - * @return bool |
|
| 220 | - * |
|
| 221 | - * Check if the password is correct without logging in the user |
|
| 222 | - */ |
|
| 223 | - public function checkPassword($uid, $password) { |
|
| 224 | - return $this->handleRequest($uid, 'checkPassword', [$uid, $password]); |
|
| 225 | - } |
|
| 214 | + /** |
|
| 215 | + * Check if the password is correct |
|
| 216 | + * |
|
| 217 | + * @param string $uid The username |
|
| 218 | + * @param string $password The password |
|
| 219 | + * @return bool |
|
| 220 | + * |
|
| 221 | + * Check if the password is correct without logging in the user |
|
| 222 | + */ |
|
| 223 | + public function checkPassword($uid, $password) { |
|
| 224 | + return $this->handleRequest($uid, 'checkPassword', [$uid, $password]); |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * returns the username for the given login name, if available |
|
| 229 | - * |
|
| 230 | - * @param string $loginName |
|
| 231 | - * @return string|false |
|
| 232 | - */ |
|
| 233 | - public function loginName2UserName($loginName) { |
|
| 234 | - $id = 'LOGINNAME,' . $loginName; |
|
| 235 | - return $this->handleRequest($id, 'loginName2UserName', [$loginName]); |
|
| 236 | - } |
|
| 227 | + /** |
|
| 228 | + * returns the username for the given login name, if available |
|
| 229 | + * |
|
| 230 | + * @param string $loginName |
|
| 231 | + * @return string|false |
|
| 232 | + */ |
|
| 233 | + public function loginName2UserName($loginName) { |
|
| 234 | + $id = 'LOGINNAME,' . $loginName; |
|
| 235 | + return $this->handleRequest($id, 'loginName2UserName', [$loginName]); |
|
| 236 | + } |
|
| 237 | 237 | |
| 238 | - /** |
|
| 239 | - * returns the username for the given LDAP DN, if available |
|
| 240 | - * |
|
| 241 | - * @param string $dn |
|
| 242 | - * @return string|false with the username |
|
| 243 | - */ |
|
| 244 | - public function dn2UserName($dn) { |
|
| 245 | - $id = 'DN,' . $dn; |
|
| 246 | - return $this->handleRequest($id, 'dn2UserName', [$dn]); |
|
| 247 | - } |
|
| 238 | + /** |
|
| 239 | + * returns the username for the given LDAP DN, if available |
|
| 240 | + * |
|
| 241 | + * @param string $dn |
|
| 242 | + * @return string|false with the username |
|
| 243 | + */ |
|
| 244 | + public function dn2UserName($dn) { |
|
| 245 | + $id = 'DN,' . $dn; |
|
| 246 | + return $this->handleRequest($id, 'dn2UserName', [$dn]); |
|
| 247 | + } |
|
| 248 | 248 | |
| 249 | - /** |
|
| 250 | - * get the user's home directory |
|
| 251 | - * |
|
| 252 | - * @param string $uid the username |
|
| 253 | - * @return boolean |
|
| 254 | - */ |
|
| 255 | - public function getHome($uid) { |
|
| 256 | - return $this->handleRequest($uid, 'getHome', [$uid]); |
|
| 257 | - } |
|
| 249 | + /** |
|
| 250 | + * get the user's home directory |
|
| 251 | + * |
|
| 252 | + * @param string $uid the username |
|
| 253 | + * @return boolean |
|
| 254 | + */ |
|
| 255 | + public function getHome($uid) { |
|
| 256 | + return $this->handleRequest($uid, 'getHome', [$uid]); |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | - /** |
|
| 260 | - * get display name of the user |
|
| 261 | - * |
|
| 262 | - * @param string $uid user ID of the user |
|
| 263 | - * @return string display name |
|
| 264 | - */ |
|
| 265 | - public function getDisplayName($uid) { |
|
| 266 | - return $this->handleRequest($uid, 'getDisplayName', [$uid]); |
|
| 267 | - } |
|
| 259 | + /** |
|
| 260 | + * get display name of the user |
|
| 261 | + * |
|
| 262 | + * @param string $uid user ID of the user |
|
| 263 | + * @return string display name |
|
| 264 | + */ |
|
| 265 | + public function getDisplayName($uid) { |
|
| 266 | + return $this->handleRequest($uid, 'getDisplayName', [$uid]); |
|
| 267 | + } |
|
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * set display name of the user |
|
| 271 | - * |
|
| 272 | - * @param string $uid user ID of the user |
|
| 273 | - * @param string $displayName new display name |
|
| 274 | - * @return string display name |
|
| 275 | - */ |
|
| 276 | - public function setDisplayName($uid, $displayName) { |
|
| 277 | - return $this->handleRequest($uid, 'setDisplayName', [$uid, $displayName]); |
|
| 278 | - } |
|
| 269 | + /** |
|
| 270 | + * set display name of the user |
|
| 271 | + * |
|
| 272 | + * @param string $uid user ID of the user |
|
| 273 | + * @param string $displayName new display name |
|
| 274 | + * @return string display name |
|
| 275 | + */ |
|
| 276 | + public function setDisplayName($uid, $displayName) { |
|
| 277 | + return $this->handleRequest($uid, 'setDisplayName', [$uid, $displayName]); |
|
| 278 | + } |
|
| 279 | 279 | |
| 280 | - /** |
|
| 281 | - * checks whether the user is allowed to change his avatar in Nextcloud |
|
| 282 | - * |
|
| 283 | - * @param string $uid the Nextcloud user name |
|
| 284 | - * @return boolean either the user can or cannot |
|
| 285 | - */ |
|
| 286 | - public function canChangeAvatar($uid) { |
|
| 287 | - return $this->handleRequest($uid, 'canChangeAvatar', [$uid], true); |
|
| 288 | - } |
|
| 280 | + /** |
|
| 281 | + * checks whether the user is allowed to change his avatar in Nextcloud |
|
| 282 | + * |
|
| 283 | + * @param string $uid the Nextcloud user name |
|
| 284 | + * @return boolean either the user can or cannot |
|
| 285 | + */ |
|
| 286 | + public function canChangeAvatar($uid) { |
|
| 287 | + return $this->handleRequest($uid, 'canChangeAvatar', [$uid], true); |
|
| 288 | + } |
|
| 289 | 289 | |
| 290 | - /** |
|
| 291 | - * Get a list of all display names and user ids. |
|
| 292 | - * |
|
| 293 | - * @param string $search |
|
| 294 | - * @param int|null $limit |
|
| 295 | - * @param int|null $offset |
|
| 296 | - * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 297 | - */ |
|
| 298 | - public function getDisplayNames($search = '', $limit = null, $offset = null) { |
|
| 299 | - //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends |
|
| 300 | - $users = []; |
|
| 301 | - foreach ($this->backends as $backend) { |
|
| 302 | - $backendUsers = $backend->getDisplayNames($search, $limit, $offset); |
|
| 303 | - if (is_array($backendUsers)) { |
|
| 304 | - $users = $users + $backendUsers; |
|
| 305 | - } |
|
| 306 | - } |
|
| 307 | - return $users; |
|
| 308 | - } |
|
| 290 | + /** |
|
| 291 | + * Get a list of all display names and user ids. |
|
| 292 | + * |
|
| 293 | + * @param string $search |
|
| 294 | + * @param int|null $limit |
|
| 295 | + * @param int|null $offset |
|
| 296 | + * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 297 | + */ |
|
| 298 | + public function getDisplayNames($search = '', $limit = null, $offset = null) { |
|
| 299 | + //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends |
|
| 300 | + $users = []; |
|
| 301 | + foreach ($this->backends as $backend) { |
|
| 302 | + $backendUsers = $backend->getDisplayNames($search, $limit, $offset); |
|
| 303 | + if (is_array($backendUsers)) { |
|
| 304 | + $users = $users + $backendUsers; |
|
| 305 | + } |
|
| 306 | + } |
|
| 307 | + return $users; |
|
| 308 | + } |
|
| 309 | 309 | |
| 310 | - /** |
|
| 311 | - * delete a user |
|
| 312 | - * |
|
| 313 | - * @param string $uid The username of the user to delete |
|
| 314 | - * @return bool |
|
| 315 | - * |
|
| 316 | - * Deletes a user |
|
| 317 | - */ |
|
| 318 | - public function deleteUser($uid) { |
|
| 319 | - return $this->handleRequest($uid, 'deleteUser', [$uid]); |
|
| 320 | - } |
|
| 310 | + /** |
|
| 311 | + * delete a user |
|
| 312 | + * |
|
| 313 | + * @param string $uid The username of the user to delete |
|
| 314 | + * @return bool |
|
| 315 | + * |
|
| 316 | + * Deletes a user |
|
| 317 | + */ |
|
| 318 | + public function deleteUser($uid) { |
|
| 319 | + return $this->handleRequest($uid, 'deleteUser', [$uid]); |
|
| 320 | + } |
|
| 321 | 321 | |
| 322 | - /** |
|
| 323 | - * Set password |
|
| 324 | - * |
|
| 325 | - * @param string $uid The username |
|
| 326 | - * @param string $password The new password |
|
| 327 | - * @return bool |
|
| 328 | - * |
|
| 329 | - */ |
|
| 330 | - public function setPassword($uid, $password) { |
|
| 331 | - return $this->handleRequest($uid, 'setPassword', [$uid, $password]); |
|
| 332 | - } |
|
| 322 | + /** |
|
| 323 | + * Set password |
|
| 324 | + * |
|
| 325 | + * @param string $uid The username |
|
| 326 | + * @param string $password The new password |
|
| 327 | + * @return bool |
|
| 328 | + * |
|
| 329 | + */ |
|
| 330 | + public function setPassword($uid, $password) { |
|
| 331 | + return $this->handleRequest($uid, 'setPassword', [$uid, $password]); |
|
| 332 | + } |
|
| 333 | 333 | |
| 334 | - /** |
|
| 335 | - * @return bool |
|
| 336 | - */ |
|
| 337 | - public function hasUserListings() { |
|
| 338 | - return $this->refBackend->hasUserListings(); |
|
| 339 | - } |
|
| 334 | + /** |
|
| 335 | + * @return bool |
|
| 336 | + */ |
|
| 337 | + public function hasUserListings() { |
|
| 338 | + return $this->refBackend->hasUserListings(); |
|
| 339 | + } |
|
| 340 | 340 | |
| 341 | - /** |
|
| 342 | - * Count the number of users |
|
| 343 | - * |
|
| 344 | - * @return int|bool |
|
| 345 | - */ |
|
| 346 | - public function countUsers() { |
|
| 347 | - $users = false; |
|
| 348 | - foreach ($this->backends as $backend) { |
|
| 349 | - $backendUsers = $backend->countUsers(); |
|
| 350 | - if ($backendUsers !== false) { |
|
| 351 | - $users += $backendUsers; |
|
| 352 | - } |
|
| 353 | - } |
|
| 354 | - return $users; |
|
| 355 | - } |
|
| 341 | + /** |
|
| 342 | + * Count the number of users |
|
| 343 | + * |
|
| 344 | + * @return int|bool |
|
| 345 | + */ |
|
| 346 | + public function countUsers() { |
|
| 347 | + $users = false; |
|
| 348 | + foreach ($this->backends as $backend) { |
|
| 349 | + $backendUsers = $backend->countUsers(); |
|
| 350 | + if ($backendUsers !== false) { |
|
| 351 | + $users += $backendUsers; |
|
| 352 | + } |
|
| 353 | + } |
|
| 354 | + return $users; |
|
| 355 | + } |
|
| 356 | 356 | |
| 357 | - /** |
|
| 358 | - * Return access for LDAP interaction. |
|
| 359 | - * |
|
| 360 | - * @param string $uid |
|
| 361 | - * @return Access instance of Access for LDAP interaction |
|
| 362 | - */ |
|
| 363 | - public function getLDAPAccess($uid) { |
|
| 364 | - return $this->handleRequest($uid, 'getLDAPAccess', [$uid]); |
|
| 365 | - } |
|
| 357 | + /** |
|
| 358 | + * Return access for LDAP interaction. |
|
| 359 | + * |
|
| 360 | + * @param string $uid |
|
| 361 | + * @return Access instance of Access for LDAP interaction |
|
| 362 | + */ |
|
| 363 | + public function getLDAPAccess($uid) { |
|
| 364 | + return $this->handleRequest($uid, 'getLDAPAccess', [$uid]); |
|
| 365 | + } |
|
| 366 | 366 | |
| 367 | - /** |
|
| 368 | - * Return a new LDAP connection for the specified user. |
|
| 369 | - * The connection needs to be closed manually. |
|
| 370 | - * |
|
| 371 | - * @param string $uid |
|
| 372 | - * @return resource|\LDAP\Connection The LDAP connection |
|
| 373 | - */ |
|
| 374 | - public function getNewLDAPConnection($uid) { |
|
| 375 | - return $this->handleRequest($uid, 'getNewLDAPConnection', [$uid]); |
|
| 376 | - } |
|
| 367 | + /** |
|
| 368 | + * Return a new LDAP connection for the specified user. |
|
| 369 | + * The connection needs to be closed manually. |
|
| 370 | + * |
|
| 371 | + * @param string $uid |
|
| 372 | + * @return resource|\LDAP\Connection The LDAP connection |
|
| 373 | + */ |
|
| 374 | + public function getNewLDAPConnection($uid) { |
|
| 375 | + return $this->handleRequest($uid, 'getNewLDAPConnection', [$uid]); |
|
| 376 | + } |
|
| 377 | 377 | |
| 378 | - /** |
|
| 379 | - * Creates a new user in LDAP |
|
| 380 | - * |
|
| 381 | - * @param $username |
|
| 382 | - * @param $password |
|
| 383 | - * @return bool |
|
| 384 | - */ |
|
| 385 | - public function createUser($username, $password) { |
|
| 386 | - return $this->handleRequest($username, 'createUser', [$username, $password]); |
|
| 387 | - } |
|
| 378 | + /** |
|
| 379 | + * Creates a new user in LDAP |
|
| 380 | + * |
|
| 381 | + * @param $username |
|
| 382 | + * @param $password |
|
| 383 | + * @return bool |
|
| 384 | + */ |
|
| 385 | + public function createUser($username, $password) { |
|
| 386 | + return $this->handleRequest($username, 'createUser', [$username, $password]); |
|
| 387 | + } |
|
| 388 | 388 | } |
@@ -26,13 +26,13 @@ |
||
| 26 | 26 | namespace OCA\User_LDAP; |
| 27 | 27 | |
| 28 | 28 | abstract class BackendUtility { |
| 29 | - protected $access; |
|
| 29 | + protected $access; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * constructor, make sure the subclasses call this one! |
|
| 33 | - * @param Access $access an instance of Access for LDAP interaction |
|
| 34 | - */ |
|
| 35 | - public function __construct(Access $access) { |
|
| 36 | - $this->access = $access; |
|
| 37 | - } |
|
| 31 | + /** |
|
| 32 | + * constructor, make sure the subclasses call this one! |
|
| 33 | + * @param Access $access an instance of Access for LDAP interaction |
|
| 34 | + */ |
|
| 35 | + public function __construct(Access $access) { |
|
| 36 | + $this->access = $access; |
|
| 37 | + } |
|
| 38 | 38 | } |
@@ -38,12 +38,12 @@ |
||
| 38 | 38 | |
| 39 | 39 | $newConfig = new \OCA\User_LDAP\Configuration($nk, false); |
| 40 | 40 | if (isset($_POST['copyConfig'])) { |
| 41 | - $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
| 42 | - $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
| 41 | + $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
| 42 | + $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
| 43 | 43 | } else { |
| 44 | - $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
| 45 | - $newConfig->setConfiguration($configuration->getDefaults()); |
|
| 46 | - $resultData['defaults'] = $configuration->getDefaults(); |
|
| 44 | + $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
| 45 | + $newConfig->setConfiguration($configuration->getDefaults()); |
|
| 46 | + $resultData['defaults'] = $configuration->getDefaults(); |
|
| 47 | 47 | } |
| 48 | 48 | $newConfig->saveConfiguration(); |
| 49 | 49 | |
@@ -33,7 +33,7 @@ |
||
| 33 | 33 | $serverConnections = $helper->getServerConfigurationPrefixes(); |
| 34 | 34 | sort($serverConnections); |
| 35 | 35 | $lk = array_pop($serverConnections); |
| 36 | -$ln = (int)str_replace('s', '', $lk); |
|
| 36 | +$ln = (int) str_replace('s', '', $lk); |
|
| 37 | 37 | $nk = 's'.str_pad($ln + 1, 2, '0', STR_PAD_LEFT); |
| 38 | 38 | |
| 39 | 39 | $resultData = ['configPrefix' => $nk]; |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | * @return bool |
| 168 | 168 | */ |
| 169 | 169 | public function userHasFiles($uid) { |
| 170 | - return $this->files->file_exists($uid . '/files'); |
|
| 170 | + return $this->files->file_exists($uid.'/files'); |
|
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | /** |
@@ -183,7 +183,7 @@ discard block |
||
| 183 | 183 | if (count($parts) > 1) { |
| 184 | 184 | $owner = $parts[1]; |
| 185 | 185 | if ($this->userManager->userExists($owner) === false) { |
| 186 | - throw new \BadMethodCallException('Unknown user: ' . |
|
| 186 | + throw new \BadMethodCallException('Unknown user: '. |
|
| 187 | 187 | 'method expects path to a user folder relative to the data folder'); |
| 188 | 188 | } |
| 189 | 189 | } |
@@ -36,164 +36,164 @@ |
||
| 36 | 36 | use OCP\PreConditionNotMetException; |
| 37 | 37 | |
| 38 | 38 | class Util { |
| 39 | - /** |
|
| 40 | - * @var View |
|
| 41 | - */ |
|
| 42 | - private $files; |
|
| 43 | - /** |
|
| 44 | - * @var Crypt |
|
| 45 | - */ |
|
| 46 | - private $crypt; |
|
| 47 | - /** |
|
| 48 | - * @var ILogger |
|
| 49 | - */ |
|
| 50 | - private $logger; |
|
| 51 | - /** |
|
| 52 | - * @var bool|IUser |
|
| 53 | - */ |
|
| 54 | - private $user; |
|
| 55 | - /** |
|
| 56 | - * @var IConfig |
|
| 57 | - */ |
|
| 58 | - private $config; |
|
| 59 | - /** |
|
| 60 | - * @var IUserManager |
|
| 61 | - */ |
|
| 62 | - private $userManager; |
|
| 39 | + /** |
|
| 40 | + * @var View |
|
| 41 | + */ |
|
| 42 | + private $files; |
|
| 43 | + /** |
|
| 44 | + * @var Crypt |
|
| 45 | + */ |
|
| 46 | + private $crypt; |
|
| 47 | + /** |
|
| 48 | + * @var ILogger |
|
| 49 | + */ |
|
| 50 | + private $logger; |
|
| 51 | + /** |
|
| 52 | + * @var bool|IUser |
|
| 53 | + */ |
|
| 54 | + private $user; |
|
| 55 | + /** |
|
| 56 | + * @var IConfig |
|
| 57 | + */ |
|
| 58 | + private $config; |
|
| 59 | + /** |
|
| 60 | + * @var IUserManager |
|
| 61 | + */ |
|
| 62 | + private $userManager; |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Util constructor. |
|
| 66 | - * |
|
| 67 | - * @param View $files |
|
| 68 | - * @param Crypt $crypt |
|
| 69 | - * @param ILogger $logger |
|
| 70 | - * @param IUserSession $userSession |
|
| 71 | - * @param IConfig $config |
|
| 72 | - * @param IUserManager $userManager |
|
| 73 | - */ |
|
| 74 | - public function __construct(View $files, |
|
| 75 | - Crypt $crypt, |
|
| 76 | - ILogger $logger, |
|
| 77 | - IUserSession $userSession, |
|
| 78 | - IConfig $config, |
|
| 79 | - IUserManager $userManager |
|
| 80 | - ) { |
|
| 81 | - $this->files = $files; |
|
| 82 | - $this->crypt = $crypt; |
|
| 83 | - $this->logger = $logger; |
|
| 84 | - $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser() : false; |
|
| 85 | - $this->config = $config; |
|
| 86 | - $this->userManager = $userManager; |
|
| 87 | - } |
|
| 64 | + /** |
|
| 65 | + * Util constructor. |
|
| 66 | + * |
|
| 67 | + * @param View $files |
|
| 68 | + * @param Crypt $crypt |
|
| 69 | + * @param ILogger $logger |
|
| 70 | + * @param IUserSession $userSession |
|
| 71 | + * @param IConfig $config |
|
| 72 | + * @param IUserManager $userManager |
|
| 73 | + */ |
|
| 74 | + public function __construct(View $files, |
|
| 75 | + Crypt $crypt, |
|
| 76 | + ILogger $logger, |
|
| 77 | + IUserSession $userSession, |
|
| 78 | + IConfig $config, |
|
| 79 | + IUserManager $userManager |
|
| 80 | + ) { |
|
| 81 | + $this->files = $files; |
|
| 82 | + $this->crypt = $crypt; |
|
| 83 | + $this->logger = $logger; |
|
| 84 | + $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser() : false; |
|
| 85 | + $this->config = $config; |
|
| 86 | + $this->userManager = $userManager; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * check if recovery key is enabled for user |
|
| 91 | - * |
|
| 92 | - * @param string $uid |
|
| 93 | - * @return bool |
|
| 94 | - */ |
|
| 95 | - public function isRecoveryEnabledForUser($uid) { |
|
| 96 | - $recoveryMode = $this->config->getUserValue($uid, |
|
| 97 | - 'encryption', |
|
| 98 | - 'recoveryEnabled', |
|
| 99 | - '0'); |
|
| 89 | + /** |
|
| 90 | + * check if recovery key is enabled for user |
|
| 91 | + * |
|
| 92 | + * @param string $uid |
|
| 93 | + * @return bool |
|
| 94 | + */ |
|
| 95 | + public function isRecoveryEnabledForUser($uid) { |
|
| 96 | + $recoveryMode = $this->config->getUserValue($uid, |
|
| 97 | + 'encryption', |
|
| 98 | + 'recoveryEnabled', |
|
| 99 | + '0'); |
|
| 100 | 100 | |
| 101 | - return ($recoveryMode === '1'); |
|
| 102 | - } |
|
| 101 | + return ($recoveryMode === '1'); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * check if the home storage should be encrypted |
|
| 106 | - * |
|
| 107 | - * @return bool |
|
| 108 | - */ |
|
| 109 | - public function shouldEncryptHomeStorage() { |
|
| 110 | - $encryptHomeStorage = $this->config->getAppValue( |
|
| 111 | - 'encryption', |
|
| 112 | - 'encryptHomeStorage', |
|
| 113 | - '1' |
|
| 114 | - ); |
|
| 104 | + /** |
|
| 105 | + * check if the home storage should be encrypted |
|
| 106 | + * |
|
| 107 | + * @return bool |
|
| 108 | + */ |
|
| 109 | + public function shouldEncryptHomeStorage() { |
|
| 110 | + $encryptHomeStorage = $this->config->getAppValue( |
|
| 111 | + 'encryption', |
|
| 112 | + 'encryptHomeStorage', |
|
| 113 | + '1' |
|
| 114 | + ); |
|
| 115 | 115 | |
| 116 | - return ($encryptHomeStorage === '1'); |
|
| 117 | - } |
|
| 116 | + return ($encryptHomeStorage === '1'); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * set the home storage encryption on/off |
|
| 121 | - * |
|
| 122 | - * @param bool $encryptHomeStorage |
|
| 123 | - */ |
|
| 124 | - public function setEncryptHomeStorage($encryptHomeStorage) { |
|
| 125 | - $value = $encryptHomeStorage ? '1' : '0'; |
|
| 126 | - $this->config->setAppValue( |
|
| 127 | - 'encryption', |
|
| 128 | - 'encryptHomeStorage', |
|
| 129 | - $value |
|
| 130 | - ); |
|
| 131 | - } |
|
| 119 | + /** |
|
| 120 | + * set the home storage encryption on/off |
|
| 121 | + * |
|
| 122 | + * @param bool $encryptHomeStorage |
|
| 123 | + */ |
|
| 124 | + public function setEncryptHomeStorage($encryptHomeStorage) { |
|
| 125 | + $value = $encryptHomeStorage ? '1' : '0'; |
|
| 126 | + $this->config->setAppValue( |
|
| 127 | + 'encryption', |
|
| 128 | + 'encryptHomeStorage', |
|
| 129 | + $value |
|
| 130 | + ); |
|
| 131 | + } |
|
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * check if master key is enabled |
|
| 135 | - * |
|
| 136 | - * @return bool |
|
| 137 | - */ |
|
| 138 | - public function isMasterKeyEnabled() { |
|
| 139 | - $userMasterKey = $this->config->getAppValue('encryption', 'useMasterKey', '1'); |
|
| 140 | - return ($userMasterKey === '1'); |
|
| 141 | - } |
|
| 133 | + /** |
|
| 134 | + * check if master key is enabled |
|
| 135 | + * |
|
| 136 | + * @return bool |
|
| 137 | + */ |
|
| 138 | + public function isMasterKeyEnabled() { |
|
| 139 | + $userMasterKey = $this->config->getAppValue('encryption', 'useMasterKey', '1'); |
|
| 140 | + return ($userMasterKey === '1'); |
|
| 141 | + } |
|
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * @param $enabled |
|
| 145 | - * @return bool |
|
| 146 | - */ |
|
| 147 | - public function setRecoveryForUser($enabled) { |
|
| 148 | - $value = $enabled ? '1' : '0'; |
|
| 143 | + /** |
|
| 144 | + * @param $enabled |
|
| 145 | + * @return bool |
|
| 146 | + */ |
|
| 147 | + public function setRecoveryForUser($enabled) { |
|
| 148 | + $value = $enabled ? '1' : '0'; |
|
| 149 | 149 | |
| 150 | - try { |
|
| 151 | - $this->config->setUserValue($this->user->getUID(), |
|
| 152 | - 'encryption', |
|
| 153 | - 'recoveryEnabled', |
|
| 154 | - $value); |
|
| 155 | - return true; |
|
| 156 | - } catch (PreConditionNotMetException $e) { |
|
| 157 | - return false; |
|
| 158 | - } |
|
| 159 | - } |
|
| 150 | + try { |
|
| 151 | + $this->config->setUserValue($this->user->getUID(), |
|
| 152 | + 'encryption', |
|
| 153 | + 'recoveryEnabled', |
|
| 154 | + $value); |
|
| 155 | + return true; |
|
| 156 | + } catch (PreConditionNotMetException $e) { |
|
| 157 | + return false; |
|
| 158 | + } |
|
| 159 | + } |
|
| 160 | 160 | |
| 161 | - /** |
|
| 162 | - * @param string $uid |
|
| 163 | - * @return bool |
|
| 164 | - */ |
|
| 165 | - public function userHasFiles($uid) { |
|
| 166 | - return $this->files->file_exists($uid . '/files'); |
|
| 167 | - } |
|
| 161 | + /** |
|
| 162 | + * @param string $uid |
|
| 163 | + * @return bool |
|
| 164 | + */ |
|
| 165 | + public function userHasFiles($uid) { |
|
| 166 | + return $this->files->file_exists($uid . '/files'); |
|
| 167 | + } |
|
| 168 | 168 | |
| 169 | - /** |
|
| 170 | - * get owner from give path, path relative to data/ expected |
|
| 171 | - * |
|
| 172 | - * @param string $path relative to data/ |
|
| 173 | - * @return string |
|
| 174 | - * @throws \BadMethodCallException |
|
| 175 | - */ |
|
| 176 | - public function getOwner($path) { |
|
| 177 | - $owner = ''; |
|
| 178 | - $parts = explode('/', $path, 3); |
|
| 179 | - if (count($parts) > 1) { |
|
| 180 | - $owner = $parts[1]; |
|
| 181 | - if ($this->userManager->userExists($owner) === false) { |
|
| 182 | - throw new \BadMethodCallException('Unknown user: ' . |
|
| 183 | - 'method expects path to a user folder relative to the data folder'); |
|
| 184 | - } |
|
| 185 | - } |
|
| 169 | + /** |
|
| 170 | + * get owner from give path, path relative to data/ expected |
|
| 171 | + * |
|
| 172 | + * @param string $path relative to data/ |
|
| 173 | + * @return string |
|
| 174 | + * @throws \BadMethodCallException |
|
| 175 | + */ |
|
| 176 | + public function getOwner($path) { |
|
| 177 | + $owner = ''; |
|
| 178 | + $parts = explode('/', $path, 3); |
|
| 179 | + if (count($parts) > 1) { |
|
| 180 | + $owner = $parts[1]; |
|
| 181 | + if ($this->userManager->userExists($owner) === false) { |
|
| 182 | + throw new \BadMethodCallException('Unknown user: ' . |
|
| 183 | + 'method expects path to a user folder relative to the data folder'); |
|
| 184 | + } |
|
| 185 | + } |
|
| 186 | 186 | |
| 187 | - return $owner; |
|
| 188 | - } |
|
| 187 | + return $owner; |
|
| 188 | + } |
|
| 189 | 189 | |
| 190 | - /** |
|
| 191 | - * get storage of path |
|
| 192 | - * |
|
| 193 | - * @param string $path |
|
| 194 | - * @return \OC\Files\Storage\Storage|null |
|
| 195 | - */ |
|
| 196 | - public function getStorage($path) { |
|
| 197 | - return $this->files->getMount($path)->getStorage(); |
|
| 198 | - } |
|
| 190 | + /** |
|
| 191 | + * get storage of path |
|
| 192 | + * |
|
| 193 | + * @param string $path |
|
| 194 | + * @return \OC\Files\Storage\Storage|null |
|
| 195 | + */ |
|
| 196 | + public function getStorage($path) { |
|
| 197 | + return $this->files->getMount($path)->getStorage(); |
|
| 198 | + } |
|
| 199 | 199 | } |
@@ -34,126 +34,126 @@ |
||
| 34 | 34 | |
| 35 | 35 | class DecryptAll { |
| 36 | 36 | |
| 37 | - /** @var Util */ |
|
| 38 | - protected $util; |
|
| 39 | - |
|
| 40 | - /** @var QuestionHelper */ |
|
| 41 | - protected $questionHelper; |
|
| 42 | - |
|
| 43 | - /** @var Crypt */ |
|
| 44 | - protected $crypt; |
|
| 45 | - |
|
| 46 | - /** @var KeyManager */ |
|
| 47 | - protected $keyManager; |
|
| 48 | - |
|
| 49 | - /** @var Session */ |
|
| 50 | - protected $session; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * @param Util $util |
|
| 54 | - * @param KeyManager $keyManager |
|
| 55 | - * @param Crypt $crypt |
|
| 56 | - * @param Session $session |
|
| 57 | - * @param QuestionHelper $questionHelper |
|
| 58 | - */ |
|
| 59 | - public function __construct( |
|
| 60 | - Util $util, |
|
| 61 | - KeyManager $keyManager, |
|
| 62 | - Crypt $crypt, |
|
| 63 | - Session $session, |
|
| 64 | - QuestionHelper $questionHelper |
|
| 65 | - ) { |
|
| 66 | - $this->util = $util; |
|
| 67 | - $this->keyManager = $keyManager; |
|
| 68 | - $this->crypt = $crypt; |
|
| 69 | - $this->session = $session; |
|
| 70 | - $this->questionHelper = $questionHelper; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * prepare encryption module to decrypt all files |
|
| 75 | - * |
|
| 76 | - * @param InputInterface $input |
|
| 77 | - * @param OutputInterface $output |
|
| 78 | - * @param $user |
|
| 79 | - * @return bool |
|
| 80 | - */ |
|
| 81 | - public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
| 82 | - $question = new Question('Please enter the recovery key password: '); |
|
| 83 | - |
|
| 84 | - if ($this->util->isMasterKeyEnabled()) { |
|
| 85 | - $output->writeln('Use master key to decrypt all files'); |
|
| 86 | - $user = $this->keyManager->getMasterKeyId(); |
|
| 87 | - $password = $this->keyManager->getMasterKeyPassword(); |
|
| 88 | - } else { |
|
| 89 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 90 | - if (!empty($user)) { |
|
| 91 | - $output->writeln('You can only decrypt the users files if you know'); |
|
| 92 | - $output->writeln('the users password or if he activated the recovery key.'); |
|
| 93 | - $output->writeln(''); |
|
| 94 | - $questionUseLoginPassword = new ConfirmationQuestion( |
|
| 95 | - 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
| 96 | - false |
|
| 97 | - ); |
|
| 98 | - $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
| 99 | - if ($useLoginPassword) { |
|
| 100 | - $question = new Question('Please enter the user\'s login password: '); |
|
| 101 | - } elseif ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
| 102 | - $output->writeln('No recovery key available for user ' . $user); |
|
| 103 | - return false; |
|
| 104 | - } else { |
|
| 105 | - $user = $recoveryKeyId; |
|
| 106 | - } |
|
| 107 | - } else { |
|
| 108 | - $output->writeln('You can only decrypt the files of all users if the'); |
|
| 109 | - $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
| 110 | - $output->writeln(''); |
|
| 111 | - $user = $recoveryKeyId; |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - $question->setHidden(true); |
|
| 115 | - $question->setHiddenFallback(false); |
|
| 116 | - $password = $this->questionHelper->ask($input, $output, $question); |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - $privateKey = $this->getPrivateKey($user, $password); |
|
| 120 | - if ($privateKey !== false) { |
|
| 121 | - $this->updateSession($user, $privateKey); |
|
| 122 | - return true; |
|
| 123 | - } else { |
|
| 124 | - $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - return false; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * get the private key which will be used to decrypt all files |
|
| 133 | - * |
|
| 134 | - * @param string $user |
|
| 135 | - * @param string $password |
|
| 136 | - * @return bool|string |
|
| 137 | - * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
| 138 | - */ |
|
| 139 | - protected function getPrivateKey($user, $password) { |
|
| 140 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 141 | - $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
| 142 | - if ($user === $recoveryKeyId) { |
|
| 143 | - $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
| 144 | - $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
| 145 | - } elseif ($user === $masterKeyId) { |
|
| 146 | - $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
| 147 | - $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
| 148 | - } else { |
|
| 149 | - $userKey = $this->keyManager->getPrivateKey($user); |
|
| 150 | - $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - return $privateKey; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - protected function updateSession($user, $privateKey) { |
|
| 157 | - $this->session->prepareDecryptAll($user, $privateKey); |
|
| 158 | - } |
|
| 37 | + /** @var Util */ |
|
| 38 | + protected $util; |
|
| 39 | + |
|
| 40 | + /** @var QuestionHelper */ |
|
| 41 | + protected $questionHelper; |
|
| 42 | + |
|
| 43 | + /** @var Crypt */ |
|
| 44 | + protected $crypt; |
|
| 45 | + |
|
| 46 | + /** @var KeyManager */ |
|
| 47 | + protected $keyManager; |
|
| 48 | + |
|
| 49 | + /** @var Session */ |
|
| 50 | + protected $session; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * @param Util $util |
|
| 54 | + * @param KeyManager $keyManager |
|
| 55 | + * @param Crypt $crypt |
|
| 56 | + * @param Session $session |
|
| 57 | + * @param QuestionHelper $questionHelper |
|
| 58 | + */ |
|
| 59 | + public function __construct( |
|
| 60 | + Util $util, |
|
| 61 | + KeyManager $keyManager, |
|
| 62 | + Crypt $crypt, |
|
| 63 | + Session $session, |
|
| 64 | + QuestionHelper $questionHelper |
|
| 65 | + ) { |
|
| 66 | + $this->util = $util; |
|
| 67 | + $this->keyManager = $keyManager; |
|
| 68 | + $this->crypt = $crypt; |
|
| 69 | + $this->session = $session; |
|
| 70 | + $this->questionHelper = $questionHelper; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * prepare encryption module to decrypt all files |
|
| 75 | + * |
|
| 76 | + * @param InputInterface $input |
|
| 77 | + * @param OutputInterface $output |
|
| 78 | + * @param $user |
|
| 79 | + * @return bool |
|
| 80 | + */ |
|
| 81 | + public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
| 82 | + $question = new Question('Please enter the recovery key password: '); |
|
| 83 | + |
|
| 84 | + if ($this->util->isMasterKeyEnabled()) { |
|
| 85 | + $output->writeln('Use master key to decrypt all files'); |
|
| 86 | + $user = $this->keyManager->getMasterKeyId(); |
|
| 87 | + $password = $this->keyManager->getMasterKeyPassword(); |
|
| 88 | + } else { |
|
| 89 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 90 | + if (!empty($user)) { |
|
| 91 | + $output->writeln('You can only decrypt the users files if you know'); |
|
| 92 | + $output->writeln('the users password or if he activated the recovery key.'); |
|
| 93 | + $output->writeln(''); |
|
| 94 | + $questionUseLoginPassword = new ConfirmationQuestion( |
|
| 95 | + 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
| 96 | + false |
|
| 97 | + ); |
|
| 98 | + $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
| 99 | + if ($useLoginPassword) { |
|
| 100 | + $question = new Question('Please enter the user\'s login password: '); |
|
| 101 | + } elseif ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
| 102 | + $output->writeln('No recovery key available for user ' . $user); |
|
| 103 | + return false; |
|
| 104 | + } else { |
|
| 105 | + $user = $recoveryKeyId; |
|
| 106 | + } |
|
| 107 | + } else { |
|
| 108 | + $output->writeln('You can only decrypt the files of all users if the'); |
|
| 109 | + $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
| 110 | + $output->writeln(''); |
|
| 111 | + $user = $recoveryKeyId; |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + $question->setHidden(true); |
|
| 115 | + $question->setHiddenFallback(false); |
|
| 116 | + $password = $this->questionHelper->ask($input, $output, $question); |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + $privateKey = $this->getPrivateKey($user, $password); |
|
| 120 | + if ($privateKey !== false) { |
|
| 121 | + $this->updateSession($user, $privateKey); |
|
| 122 | + return true; |
|
| 123 | + } else { |
|
| 124 | + $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + return false; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * get the private key which will be used to decrypt all files |
|
| 133 | + * |
|
| 134 | + * @param string $user |
|
| 135 | + * @param string $password |
|
| 136 | + * @return bool|string |
|
| 137 | + * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
| 138 | + */ |
|
| 139 | + protected function getPrivateKey($user, $password) { |
|
| 140 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 141 | + $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
| 142 | + if ($user === $recoveryKeyId) { |
|
| 143 | + $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
| 144 | + $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
| 145 | + } elseif ($user === $masterKeyId) { |
|
| 146 | + $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
| 147 | + $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
| 148 | + } else { |
|
| 149 | + $userKey = $this->keyManager->getPrivateKey($user); |
|
| 150 | + $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + return $privateKey; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + protected function updateSession($user, $privateKey) { |
|
| 157 | + $this->session->prepareDecryptAll($user, $privateKey); |
|
| 158 | + } |
|
| 159 | 159 | } |
@@ -99,7 +99,7 @@ |
||
| 99 | 99 | if ($useLoginPassword) { |
| 100 | 100 | $question = new Question('Please enter the user\'s login password: '); |
| 101 | 101 | } elseif ($this->util->isRecoveryEnabledForUser($user) === false) { |
| 102 | - $output->writeln('No recovery key available for user ' . $user); |
|
| 102 | + $output->writeln('No recovery key available for user '.$user); |
|
| 103 | 103 | return false; |
| 104 | 104 | } else { |
| 105 | 105 | $user = $recoveryKeyId; |
@@ -28,13 +28,13 @@ |
||
| 28 | 28 | |
| 29 | 29 | class PrivateKeyMissingException extends GenericEncryptionException { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @param string $userId |
|
| 33 | - */ |
|
| 34 | - public function __construct($userId) { |
|
| 35 | - if (empty($userId)) { |
|
| 36 | - $userId = "<no-user-id-given>"; |
|
| 37 | - } |
|
| 38 | - parent::__construct("Private Key missing for user: $userId"); |
|
| 39 | - } |
|
| 31 | + /** |
|
| 32 | + * @param string $userId |
|
| 33 | + */ |
|
| 34 | + public function __construct($userId) { |
|
| 35 | + if (empty($userId)) { |
|
| 36 | + $userId = "<no-user-id-given>"; |
|
| 37 | + } |
|
| 38 | + parent::__construct("Private Key missing for user: $userId"); |
|
| 39 | + } |
|
| 40 | 40 | } |
@@ -25,13 +25,13 @@ |
||
| 25 | 25 | |
| 26 | 26 | class PublicKeyMissingException extends GenericEncryptionException { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $userId |
|
| 30 | - */ |
|
| 31 | - public function __construct($userId) { |
|
| 32 | - if (empty($userId)) { |
|
| 33 | - $userId = "<no-user-id-given>"; |
|
| 34 | - } |
|
| 35 | - parent::__construct("Public Key missing for user: $userId"); |
|
| 36 | - } |
|
| 28 | + /** |
|
| 29 | + * @param string $userId |
|
| 30 | + */ |
|
| 31 | + public function __construct($userId) { |
|
| 32 | + if (empty($userId)) { |
|
| 33 | + $userId = "<no-user-id-given>"; |
|
| 34 | + } |
|
| 35 | + parent::__construct("Public Key missing for user: $userId"); |
|
| 36 | + } |
|
| 37 | 37 | } |
@@ -32,63 +32,63 @@ |
||
| 32 | 32 | |
| 33 | 33 | class Personal implements ISettings { |
| 34 | 34 | |
| 35 | - /** @var IConfig */ |
|
| 36 | - private $config; |
|
| 37 | - /** @var Session */ |
|
| 38 | - private $session; |
|
| 39 | - /** @var Util */ |
|
| 40 | - private $util; |
|
| 41 | - /** @var IUserSession */ |
|
| 42 | - private $userSession; |
|
| 35 | + /** @var IConfig */ |
|
| 36 | + private $config; |
|
| 37 | + /** @var Session */ |
|
| 38 | + private $session; |
|
| 39 | + /** @var Util */ |
|
| 40 | + private $util; |
|
| 41 | + /** @var IUserSession */ |
|
| 42 | + private $userSession; |
|
| 43 | 43 | |
| 44 | - public function __construct(IConfig $config, Session $session, Util $util, IUserSession $userSession) { |
|
| 45 | - $this->config = $config; |
|
| 46 | - $this->session = $session; |
|
| 47 | - $this->util = $util; |
|
| 48 | - $this->userSession = $userSession; |
|
| 49 | - } |
|
| 44 | + public function __construct(IConfig $config, Session $session, Util $util, IUserSession $userSession) { |
|
| 45 | + $this->config = $config; |
|
| 46 | + $this->session = $session; |
|
| 47 | + $this->util = $util; |
|
| 48 | + $this->userSession = $userSession; |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
| 53 | - * @since 9.1 |
|
| 54 | - */ |
|
| 55 | - public function getForm() { |
|
| 56 | - $recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled'); |
|
| 57 | - $privateKeySet = $this->session->isPrivateKeySet(); |
|
| 51 | + /** |
|
| 52 | + * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
| 53 | + * @since 9.1 |
|
| 54 | + */ |
|
| 55 | + public function getForm() { |
|
| 56 | + $recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled'); |
|
| 57 | + $privateKeySet = $this->session->isPrivateKeySet(); |
|
| 58 | 58 | |
| 59 | - if (!$recoveryAdminEnabled && $privateKeySet) { |
|
| 60 | - return new TemplateResponse('settings', 'settings/empty', [], ''); |
|
| 61 | - } |
|
| 59 | + if (!$recoveryAdminEnabled && $privateKeySet) { |
|
| 60 | + return new TemplateResponse('settings', 'settings/empty', [], ''); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - $userId = $this->userSession->getUser()->getUID(); |
|
| 64 | - $recoveryEnabledForUser = $this->util->isRecoveryEnabledForUser($userId); |
|
| 63 | + $userId = $this->userSession->getUser()->getUID(); |
|
| 64 | + $recoveryEnabledForUser = $this->util->isRecoveryEnabledForUser($userId); |
|
| 65 | 65 | |
| 66 | - $parameters = [ |
|
| 67 | - 'recoveryEnabled' => $recoveryAdminEnabled, |
|
| 68 | - 'recoveryEnabledForUser' => $recoveryEnabledForUser, |
|
| 69 | - 'privateKeySet' => $privateKeySet, |
|
| 70 | - 'initialized' => $this->session->getStatus(), |
|
| 71 | - ]; |
|
| 72 | - return new TemplateResponse('encryption', 'settings-personal', $parameters, ''); |
|
| 73 | - } |
|
| 66 | + $parameters = [ |
|
| 67 | + 'recoveryEnabled' => $recoveryAdminEnabled, |
|
| 68 | + 'recoveryEnabledForUser' => $recoveryEnabledForUser, |
|
| 69 | + 'privateKeySet' => $privateKeySet, |
|
| 70 | + 'initialized' => $this->session->getStatus(), |
|
| 71 | + ]; |
|
| 72 | + return new TemplateResponse('encryption', 'settings-personal', $parameters, ''); |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @return string the section ID, e.g. 'sharing' |
|
| 77 | - * @since 9.1 |
|
| 78 | - */ |
|
| 79 | - public function getSection() { |
|
| 80 | - return 'security'; |
|
| 81 | - } |
|
| 75 | + /** |
|
| 76 | + * @return string the section ID, e.g. 'sharing' |
|
| 77 | + * @since 9.1 |
|
| 78 | + */ |
|
| 79 | + public function getSection() { |
|
| 80 | + return 'security'; |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * @return int whether the form should be rather on the top or bottom of |
|
| 85 | - * the admin section. The forms are arranged in ascending order of the |
|
| 86 | - * priority values. It is required to return a value between 0 and 100. |
|
| 87 | - * |
|
| 88 | - * E.g.: 70 |
|
| 89 | - * @since 9.1 |
|
| 90 | - */ |
|
| 91 | - public function getPriority() { |
|
| 92 | - return 80; |
|
| 93 | - } |
|
| 83 | + /** |
|
| 84 | + * @return int whether the form should be rather on the top or bottom of |
|
| 85 | + * the admin section. The forms are arranged in ascending order of the |
|
| 86 | + * priority values. It is required to return a value between 0 and 100. |
|
| 87 | + * |
|
| 88 | + * E.g.: 70 |
|
| 89 | + * @since 9.1 |
|
| 90 | + */ |
|
| 91 | + public function getPriority() { |
|
| 92 | + return 80; |
|
| 93 | + } |
|
| 94 | 94 | } |
@@ -23,10 +23,10 @@ |
||
| 23 | 23 | namespace OCA\Encryption\Hooks\Contracts; |
| 24 | 24 | |
| 25 | 25 | interface IHook { |
| 26 | - /** |
|
| 27 | - * Connects Hooks |
|
| 28 | - * |
|
| 29 | - * @return null |
|
| 30 | - */ |
|
| 31 | - public function addHooks(); |
|
| 26 | + /** |
|
| 27 | + * Connects Hooks |
|
| 28 | + * |
|
| 29 | + * @return null |
|
| 30 | + */ |
|
| 31 | + public function addHooks(); |
|
| 32 | 32 | } |