owncloud /
core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Session often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Session, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 86 | class Session implements IUserSession, Emitter { |
||
| 87 | |||
| 88 | use EventEmitterTrait; |
||
| 89 | /** @var IUserManager | PublicEmitter $manager */ |
||
| 90 | private $manager; |
||
| 91 | |||
| 92 | /** @var ISession $session */ |
||
| 93 | private $session; |
||
| 94 | |||
| 95 | /** @var ITimeFactory */ |
||
| 96 | private $timeFactory; |
||
| 97 | |||
| 98 | /** @var IProvider */ |
||
| 99 | private $tokenProvider; |
||
| 100 | |||
| 101 | /** @var IConfig */ |
||
| 102 | private $config; |
||
| 103 | |||
| 104 | /** @var User $activeUser */ |
||
| 105 | protected $activeUser; |
||
| 106 | |||
| 107 | /** @var IServiceLoader */ |
||
| 108 | private $serviceLoader; |
||
| 109 | |||
| 110 | /** @var SyncService */ |
||
| 111 | protected $userSyncService; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * @param IUserManager $manager |
||
| 115 | * @param ISession $session |
||
| 116 | * @param ITimeFactory $timeFactory |
||
| 117 | * @param IProvider $tokenProvider |
||
| 118 | * @param IConfig $config |
||
| 119 | * @param IServiceLoader $serviceLoader |
||
| 120 | * @param SyncService $userSyncService |
||
| 121 | */ |
||
| 122 | public function __construct(IUserManager $manager, ISession $session, |
||
| 123 | ITimeFactory $timeFactory, IProvider $tokenProvider, |
||
| 124 | IConfig $config, IServiceLoader $serviceLoader, |
||
| 125 | SyncService $userSyncService) { |
||
| 126 | $this->manager = $manager; |
||
| 127 | $this->session = $session; |
||
| 128 | $this->timeFactory = $timeFactory; |
||
| 129 | $this->tokenProvider = $tokenProvider; |
||
| 130 | $this->config = $config; |
||
| 131 | $this->serviceLoader = $serviceLoader; |
||
| 132 | $this->userSyncService = $userSyncService; |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * @param IProvider $provider |
||
| 137 | */ |
||
| 138 | public function setTokenProvider(IProvider $provider) { |
||
| 139 | $this->tokenProvider = $provider; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * @param string $scope |
||
| 144 | * @param string $method |
||
| 145 | * @param callable $callback |
||
| 146 | */ |
||
| 147 | public function listen($scope, $method, callable $callback) { |
||
| 148 | $this->manager->listen($scope, $method, $callback); |
||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * @param string $scope optional |
||
| 153 | * @param string $method optional |
||
| 154 | * @param callable $callback optional |
||
| 155 | */ |
||
| 156 | public function removeListener($scope = null, $method = null, callable $callback = null) { |
||
| 157 | $this->manager->removeListener($scope, $method, $callback); |
||
| 158 | } |
||
| 159 | |||
| 160 | /** |
||
| 161 | * get the session object |
||
| 162 | * |
||
| 163 | * @return ISession |
||
| 164 | */ |
||
| 165 | public function getSession() { |
||
| 166 | return $this->session; |
||
| 167 | } |
||
| 168 | |||
| 169 | /** |
||
| 170 | * set the session object |
||
| 171 | * |
||
| 172 | * @param ISession $session |
||
| 173 | */ |
||
| 174 | public function setSession(ISession $session) { |
||
| 175 | if ($this->session instanceof ISession) { |
||
| 176 | $this->session->close(); |
||
| 177 | } |
||
| 178 | $this->session = $session; |
||
| 179 | $this->activeUser = null; |
||
| 180 | } |
||
| 181 | |||
| 182 | /** |
||
| 183 | * set the currently active user |
||
| 184 | * |
||
| 185 | * @param IUser|null $user |
||
| 186 | */ |
||
| 187 | public function setUser($user) { |
||
| 188 | if (null === $user) { |
||
| 189 | $this->session->remove('user_id'); |
||
| 190 | } else { |
||
| 191 | $this->session->set('user_id', $user->getUID()); |
||
| 192 | } |
||
| 193 | $this->activeUser = $user; |
||
|
|
|||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Get the current active user. If user is in incognito mode, user is not |
||
| 198 | * considered as active |
||
| 199 | * |
||
| 200 | * @return IUser|null Current user, otherwise null |
||
| 201 | */ |
||
| 202 | public function getUser() { |
||
| 203 | // FIXME: This is a quick'n dirty work-around for the incognito mode as |
||
| 204 | // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155 |
||
| 205 | if (OC_User::isIncognitoMode()) { |
||
| 206 | return null; |
||
| 207 | } |
||
| 208 | if (null === $this->activeUser) { |
||
| 209 | $uid = $this->session->get('user_id'); |
||
| 210 | if (null === $uid) { |
||
| 211 | return null; |
||
| 212 | } |
||
| 213 | $this->activeUser = $this->manager->get($uid); |
||
| 214 | if (null === $this->activeUser) { |
||
| 215 | return null; |
||
| 216 | } |
||
| 217 | } |
||
| 218 | return $this->activeUser; |
||
| 219 | } |
||
| 220 | |||
| 221 | /** |
||
| 222 | * Validate whether the current session is valid |
||
| 223 | * |
||
| 224 | * - For token-authenticated clients, the token validity is checked |
||
| 225 | * - For browsers, the session token validity is checked |
||
| 226 | */ |
||
| 227 | public function validateSession() { |
||
| 228 | if (!$this->getUser()) { |
||
| 229 | return; |
||
| 230 | } |
||
| 231 | |||
| 232 | $token = null; |
||
| 233 | $appPassword = $this->session->get('app_password'); |
||
| 234 | |||
| 235 | if (null === $appPassword) { |
||
| 236 | try { |
||
| 237 | $token = $this->session->getId(); |
||
| 238 | } catch (SessionNotAvailableException $ex) { |
||
| 239 | return; |
||
| 240 | } |
||
| 241 | } else { |
||
| 242 | $token = $appPassword; |
||
| 243 | } |
||
| 244 | |||
| 245 | if (!$this->validateToken($token)) { |
||
| 246 | // Session was invalidated |
||
| 247 | $this->logout(); |
||
| 248 | } |
||
| 249 | } |
||
| 250 | |||
| 251 | /** |
||
| 252 | * Checks whether the user is logged in |
||
| 253 | * |
||
| 254 | * @return bool if logged in |
||
| 255 | */ |
||
| 256 | public function isLoggedIn() { |
||
| 264 | |||
| 265 | /** |
||
| 266 | * set the login name |
||
| 267 | * |
||
| 268 | * @param string|null $loginName for the logged in user |
||
| 269 | */ |
||
| 270 | public function setLoginName($loginName) { |
||
| 277 | |||
| 278 | /** |
||
| 279 | * get the login name of the current user |
||
| 280 | * |
||
| 281 | * @return string |
||
| 282 | */ |
||
| 283 | public function getLoginName() { |
||
| 284 | if ($this->activeUser) { |
||
| 285 | return $this->session->get('loginname'); |
||
| 286 | } |
||
| 287 | |||
| 288 | $uid = $this->session->get('user_id'); |
||
| 289 | if ($uid) { |
||
| 290 | $this->activeUser = $this->manager->get($uid); |
||
| 291 | return $this->session->get('loginname'); |
||
| 292 | } |
||
| 293 | |||
| 294 | return null; |
||
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * try to log in with the provided credentials |
||
| 299 | * |
||
| 300 | * @param string $uid |
||
| 301 | * @param string $password |
||
| 302 | * @return boolean|null |
||
| 303 | * @throws LoginException |
||
| 304 | */ |
||
| 305 | public function login($uid, $password) { |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Tries to log in a client |
||
| 316 | * |
||
| 317 | * Checks token auth enforced |
||
| 318 | * Checks 2FA enabled |
||
| 319 | * |
||
| 320 | * @param string $user |
||
| 321 | * @param string $password |
||
| 322 | * @param IRequest $request |
||
| 323 | * @throws \InvalidArgumentException |
||
| 324 | * @throws LoginException |
||
| 325 | * @throws PasswordLoginForbiddenException |
||
| 326 | * @return boolean |
||
| 327 | */ |
||
| 328 | public function logClientIn($user, $password, IRequest $request) { |
||
| 329 | $isTokenPassword = $this->isTokenPassword($password); |
||
| 330 | if ($user === null || trim($user) === '') { |
||
| 331 | throw new \InvalidArgumentException('$user cannot be empty'); |
||
| 332 | } |
||
| 333 | if (!$isTokenPassword && $this->isTokenAuthEnforced()) { |
||
| 334 | throw new PasswordLoginForbiddenException(); |
||
| 335 | } |
||
| 336 | if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) { |
||
| 337 | throw new PasswordLoginForbiddenException(); |
||
| 338 | } |
||
| 339 | if (!$this->login($user, $password) ) { |
||
| 340 | $users = $this->manager->getByEmail($user); |
||
| 341 | if (count($users) === 1) { |
||
| 342 | return $this->login($users[0]->getUID(), $password); |
||
| 343 | } |
||
| 344 | return false; |
||
| 345 | } |
||
| 346 | |||
| 347 | if ($isTokenPassword) { |
||
| 348 | $this->session->set('app_password', $password); |
||
| 349 | } else if($this->supportsCookies($request)) { |
||
| 350 | // Password login, but cookies supported -> create (browser) session token |
||
| 351 | $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password); |
||
| 352 | } |
||
| 353 | |||
| 354 | return true; |
||
| 355 | } |
||
| 356 | |||
| 357 | protected function supportsCookies(IRequest $request) { |
||
| 358 | if (null !== $request->getCookie('cookie_test')) { |
||
| 359 | return true; |
||
| 360 | } |
||
| 361 | setcookie('cookie_test', 'test', $this->timeFactory->getTime() + 3600); |
||
| 362 | return false; |
||
| 363 | } |
||
| 364 | |||
| 365 | private function isTokenAuthEnforced() { |
||
| 366 | return $this->config->getSystemValue('token_auth_enforced', false); |
||
| 367 | } |
||
| 368 | |||
| 369 | protected function isTwoFactorEnforced($username) { |
||
| 370 | Util::emitHook( |
||
| 371 | '\OCA\Files_Sharing\API\Server2Server', |
||
| 372 | 'preLoginNameUsedAsUserName', |
||
| 373 | ['uid' => &$username] |
||
| 374 | ); |
||
| 375 | $user = $this->manager->get($username); |
||
| 376 | if (null === $user) { |
||
| 377 | $users = $this->manager->getByEmail($username); |
||
| 378 | if (empty($users)) { |
||
| 379 | return false; |
||
| 380 | } |
||
| 381 | if (count($users) !== 1) { |
||
| 382 | return true; |
||
| 383 | } |
||
| 384 | $user = $users[0]; |
||
| 385 | } |
||
| 386 | // DI not possible due to cyclic dependencies :'-/ |
||
| 387 | return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user); |
||
| 388 | } |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Check if the given 'password' is actually a device token |
||
| 392 | * |
||
| 393 | * @param string $password |
||
| 394 | * @return boolean |
||
| 395 | */ |
||
| 396 | public function isTokenPassword($password) { |
||
| 397 | try { |
||
| 398 | $this->tokenProvider->getToken($password); |
||
| 399 | return true; |
||
| 400 | } catch (InvalidTokenException $ex) { |
||
| 401 | return false; |
||
| 402 | } |
||
| 403 | } |
||
| 404 | |||
| 405 | /** |
||
| 406 | * Unintentional public |
||
| 407 | * |
||
| 408 | * @param bool $firstTimeLogin |
||
| 409 | */ |
||
| 410 | public function prepareUserLogin($firstTimeLogin = false) { |
||
| 411 | // TODO: mock/inject/use non-static |
||
| 412 | // Refresh the token |
||
| 413 | \OC::$server->getCsrfTokenManager()->refreshToken(); |
||
| 414 | //we need to pass the user name, which may differ from login name |
||
| 415 | $user = $this->getUser()->getUID(); |
||
| 416 | OC_Util::setupFS($user); |
||
| 417 | |||
| 418 | if ($firstTimeLogin) { |
||
| 419 | // TODO: lock necessary? |
||
| 420 | //trigger creation of user home and /files folder |
||
| 421 | $userFolder = \OC::$server->getUserFolder($user); |
||
| 422 | |||
| 423 | try { |
||
| 424 | // copy skeleton |
||
| 425 | \OC_Util::copySkeleton($user, $userFolder); |
||
| 426 | } catch (NotPermittedException $ex) { |
||
| 427 | // possible if files directory is in an readonly jail |
||
| 428 | \OC::$server->getLogger()->warning( |
||
| 429 | 'Skeleton not created due to missing write permission' |
||
| 430 | ); |
||
| 431 | } catch (NoReadAccessException $ex) { |
||
| 432 | // possible if the skeleton directory does not have read access |
||
| 433 | \OC::$server->getLogger()->warning( |
||
| 434 | 'Skeleton not created due to missing read permission in skeleton directory' |
||
| 435 | ); |
||
| 436 | } catch(HintException $hintEx) { |
||
| 437 | // only if Skeleton no existing Dir |
||
| 438 | \OC::$server->getLogger()->error($hintEx->getMessage()); |
||
| 439 | } |
||
| 440 | |||
| 441 | // trigger any other initialization |
||
| 442 | \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser())); |
||
| 443 | } |
||
| 444 | } |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Tries to login the user with HTTP Basic Authentication |
||
| 448 | * |
||
| 449 | * @todo do not allow basic auth if the user is 2FA enforced |
||
| 450 | * @param IRequest $request |
||
| 451 | * @return boolean if the login was successful |
||
| 452 | */ |
||
| 453 | public function tryBasicAuthLogin(IRequest $request) { |
||
| 454 | if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) { |
||
| 455 | try { |
||
| 456 | if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request)) { |
||
| 457 | /** |
||
| 458 | * Add DAV authenticated. This should in an ideal world not be |
||
| 459 | * necessary but the iOS App reads cookies from anywhere instead |
||
| 460 | * only the DAV endpoint. |
||
| 461 | * This makes sure that the cookies will be valid for the whole scope |
||
| 462 | * @see https://github.com/owncloud/core/issues/22893 |
||
| 463 | */ |
||
| 464 | $this->session->set( |
||
| 465 | Auth::DAV_AUTHENTICATED, $this->getUser()->getUID() |
||
| 466 | ); |
||
| 467 | return true; |
||
| 468 | } |
||
| 469 | } catch (PasswordLoginForbiddenException $ex) { |
||
| 470 | // Nothing to do |
||
| 471 | } |
||
| 472 | } |
||
| 473 | return false; |
||
| 474 | } |
||
| 475 | |||
| 476 | /** |
||
| 477 | * Log an user in via login name and password |
||
| 478 | * |
||
| 479 | * @param string $uid |
||
| 480 | * @param string $password |
||
| 481 | * @return boolean |
||
| 482 | * @throws LoginException if an app canceld the login process or the user is not enabled |
||
| 483 | */ |
||
| 484 | private function loginWithPassword($uid, $password) { |
||
| 485 | return $this->emittingCall(function () use (&$uid, &$password) { |
||
| 486 | $this->manager->emit('\OC\User', 'preLogin', [$uid, $password]); |
||
| 487 | $user = $this->manager->checkPassword($uid, $password); |
||
| 488 | View Code Duplication | if ($user === false) { |
|
| 489 | $this->manager->emit('\OC\User', 'failedLogin', [$uid]); |
||
| 490 | return false; |
||
| 491 | } |
||
| 492 | |||
| 493 | if ($user->isEnabled()) { |
||
| 494 | $this->setUser($user); |
||
| 495 | $this->setLoginName($uid); |
||
| 496 | $firstTimeLogin = $user->updateLastLoginTimestamp(); |
||
| 497 | $this->manager->emit('\OC\User', 'postLogin', [$user, $password]); |
||
| 498 | View Code Duplication | if ($this->isLoggedIn()) { |
|
| 499 | $this->prepareUserLogin($firstTimeLogin); |
||
| 500 | return true; |
||
| 501 | } else { |
||
| 502 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 503 | $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
||
| 504 | throw new LoginException($message); |
||
| 505 | } |
||
| 506 | } else { |
||
| 507 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 508 | $message = \OC::$server->getL10N('lib')->t('User disabled'); |
||
| 509 | throw new LoginException($message); |
||
| 510 | } |
||
| 511 | }, ['before' => ['uid' => $uid, 'password' => $password], 'after' => ['uid' => $uid, 'password' => $password]], 'user', 'login'); |
||
| 512 | } |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Log an user in with a given token (id) |
||
| 516 | * |
||
| 517 | * @param string $token |
||
| 518 | * @return boolean |
||
| 519 | * @throws LoginException if an app canceld the login process or the user is not enabled |
||
| 520 | */ |
||
| 521 | private function loginWithToken($token) { |
||
| 522 | try { |
||
| 523 | $dbToken = $this->tokenProvider->getToken($token); |
||
| 524 | } catch (InvalidTokenException $ex) { |
||
| 525 | return false; |
||
| 526 | } |
||
| 527 | $uid = $dbToken->getUID(); |
||
| 528 | |||
| 529 | // When logging in with token, the password must be decrypted first before passing to login hook |
||
| 530 | $password = ''; |
||
| 531 | try { |
||
| 532 | $password = $this->tokenProvider->getPassword($dbToken, $token); |
||
| 533 | } catch (PasswordlessTokenException $ex) { |
||
| 534 | // Ignore and use empty string instead |
||
| 535 | } |
||
| 536 | |||
| 537 | $this->manager->emit('\OC\User', 'preLogin', [$uid, $password]); |
||
| 538 | |||
| 539 | $user = $this->manager->get($uid); |
||
| 540 | if (null === $user) { |
||
| 541 | // user does not exist |
||
| 542 | return false; |
||
| 543 | } |
||
| 544 | View Code Duplication | if (!$user->isEnabled()) { |
|
| 545 | // disabled users can not log in |
||
| 546 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 547 | $message = \OC::$server->getL10N('lib')->t('User disabled'); |
||
| 548 | throw new LoginException($message); |
||
| 549 | } |
||
| 550 | |||
| 551 | //login |
||
| 552 | $this->setUser($user); |
||
| 553 | $this->setLoginName($dbToken->getLoginName()); |
||
| 554 | $this->manager->emit('\OC\User', 'postLogin', [$user, $password]); |
||
| 555 | |||
| 556 | View Code Duplication | if ($this->isLoggedIn()) { |
|
| 557 | $this->prepareUserLogin(); |
||
| 558 | } else { |
||
| 559 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 560 | $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
||
| 561 | throw new LoginException($message); |
||
| 562 | } |
||
| 563 | |||
| 564 | // set the app password |
||
| 565 | $this->session->set('app_password', $token); |
||
| 566 | |||
| 567 | return true; |
||
| 568 | } |
||
| 569 | |||
| 570 | /** |
||
| 571 | * Try to login a user, assuming authentication |
||
| 572 | * has already happened (e.g. via Single Sign On). |
||
| 573 | * |
||
| 574 | * Log in a user and regenerate a new session. |
||
| 575 | * |
||
| 576 | * @param \OCP\Authentication\IApacheBackend $apacheBackend |
||
| 577 | * @return bool |
||
| 578 | * @throws LoginException |
||
| 579 | */ |
||
| 580 | public function loginWithApache(IApacheBackend $apacheBackend) { |
||
| 581 | |||
| 582 | $uidAndBackend = $apacheBackend->getCurrentUserId(); |
||
| 583 | if (is_array($uidAndBackend) |
||
| 584 | && count($uidAndBackend) === 2 |
||
| 585 | && $uidAndBackend[0] !== '' |
||
| 586 | && $uidAndBackend[0] !== null |
||
| 587 | && $uidAndBackend[1] instanceof UserInterface |
||
| 588 | ) { |
||
| 589 | list($uid, $backend) = $uidAndBackend; |
||
| 590 | } else if (is_string($uidAndBackend)) { |
||
| 591 | $uid = $uidAndBackend; |
||
| 592 | if ($apacheBackend instanceof UserInterface) { |
||
| 593 | $backend = $apacheBackend; |
||
| 594 | } else { |
||
| 595 | \OC::$server->getLogger()->error('Apache backend failed to provide a valid backend for the user'); |
||
| 596 | return false; |
||
| 597 | } |
||
| 598 | } else { |
||
| 599 | \OC::$server->getLogger()->debug('No valid user detected from apache user backend'); |
||
| 600 | return false; |
||
| 601 | } |
||
| 602 | |||
| 603 | if ($this->getUser() !== null && $uid === $this->getUser()->getUID()) { |
||
| 604 | return true; // nothing to do |
||
| 605 | } |
||
| 606 | $this->session->regenerateId(); |
||
| 607 | |||
| 608 | $this->manager->emit('\OC\User', 'preLogin', [$uid, '']); |
||
| 609 | |||
| 610 | // Die here if not valid |
||
| 611 | if(!$apacheBackend->isSessionActive()) { |
||
| 612 | return false; |
||
| 613 | } |
||
| 614 | |||
| 615 | // Now we try to create the account or sync |
||
| 616 | $this->userSyncService->createOrSyncAccount($uid, $backend); |
||
| 617 | |||
| 618 | $user = $this->manager->get($uid); |
||
| 619 | View Code Duplication | if ($user === null) { |
|
| 620 | $this->manager->emit('\OC\User', 'failedLogin', [$uid]); |
||
| 621 | return false; |
||
| 622 | } |
||
| 623 | |||
| 624 | if ($user->isEnabled()) { |
||
| 625 | $this->setUser($user); |
||
| 626 | $this->setLoginName($uid); |
||
| 627 | |||
| 628 | $request = OC::$server->getRequest(); |
||
| 629 | $this->createSessionToken($request, $uid, $uid); |
||
| 630 | |||
| 631 | // setup the filesystem |
||
| 632 | OC_Util::setupFS($uid); |
||
| 633 | // first call the post_login hooks, the login-process needs to be |
||
| 634 | // completed before we can safely create the users folder. |
||
| 635 | // For example encryption needs to initialize the users keys first |
||
| 636 | // before we can create the user folder with the skeleton files |
||
| 637 | |||
| 638 | $firstTimeLogin = $user->updateLastLoginTimestamp(); |
||
| 639 | $this->manager->emit('\OC\User', 'postLogin', [$user, '']); |
||
| 640 | View Code Duplication | if ($this->isLoggedIn()) { |
|
| 641 | $this->prepareUserLogin($firstTimeLogin); |
||
| 642 | return true; |
||
| 643 | } else { |
||
| 644 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 645 | $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
||
| 646 | throw new LoginException($message); |
||
| 647 | } |
||
| 648 | } else { |
||
| 649 | // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
||
| 650 | $message = \OC::$server->getL10N('lib')->t('User disabled'); |
||
| 651 | throw new LoginException($message); |
||
| 652 | } |
||
| 653 | } |
||
| 654 | |||
| 655 | /** |
||
| 656 | * Create a new session token for the given user credentials |
||
| 657 | * |
||
| 658 | * @param IRequest $request |
||
| 659 | * @param string $uid user UID |
||
| 660 | * @param string $loginName login name |
||
| 661 | * @param string $password |
||
| 662 | * @return boolean |
||
| 663 | */ |
||
| 664 | public function createSessionToken(IRequest $request, $uid, $loginName, $password = null) { |
||
| 681 | |||
| 682 | /** |
||
| 683 | * Checks if the given password is a token. |
||
| 684 | * If yes, the password is extracted from the token. |
||
| 685 | * If no, the same password is returned. |
||
| 686 | * |
||
| 687 | * @param string $password either the login password or a device token |
||
| 688 | * @return string|null the password or null if none was set in the token |
||
| 689 | */ |
||
| 690 | private function getPassword($password) { |
||
| 706 | |||
| 707 | /** |
||
| 708 | * @param IToken $dbToken |
||
| 709 | * @param string $token |
||
| 710 | * @return boolean |
||
| 711 | */ |
||
| 712 | private function checkTokenCredentials(IToken $dbToken, $token) { |
||
| 753 | |||
| 754 | /** |
||
| 755 | * Check if the given token exists and performs password/user-enabled checks |
||
| 756 | * |
||
| 757 | * Invalidates the token if checks fail |
||
| 758 | * |
||
| 759 | * @param string $token |
||
| 760 | * @param string $user login name |
||
| 761 | * @return boolean |
||
| 762 | */ |
||
| 763 | private function validateToken($token, $user = null) { |
||
| 786 | |||
| 787 | /** |
||
| 788 | * Tries to login the user with auth token header |
||
| 789 | * |
||
| 790 | * @param IRequest $request |
||
| 791 | * @todo check remember me cookie |
||
| 792 | * @return boolean |
||
| 793 | */ |
||
| 794 | public function tryTokenLogin(IRequest $request) { |
||
| 815 | |||
| 816 | /** |
||
| 817 | * Tries to login with an AuthModule provided by an app |
||
| 818 | * |
||
| 819 | * @param IRequest $request The request |
||
| 820 | * @return bool True if request can be authenticated, false otherwise |
||
| 821 | * @throws Exception If the auth module could not be loaded |
||
| 822 | */ |
||
| 823 | public function tryAuthModuleLogin(IRequest $request) { |
||
| 833 | |||
| 834 | /** |
||
| 835 | * Log an user in |
||
| 836 | * |
||
| 837 | * @param IUser $user The user |
||
| 838 | * @param String $password The user's password |
||
| 839 | * @return boolean True if the user can be authenticated, false otherwise |
||
| 840 | * @throws LoginException if an app canceld the login process or the user is not enabled |
||
| 841 | */ |
||
| 842 | private function loginUser($user, $password) { |
||
| 870 | |||
| 871 | /** |
||
| 872 | * perform login using the magic cookie (remember login) |
||
| 873 | * |
||
| 874 | * @param string $uid the username |
||
| 875 | * @param string $currentToken |
||
| 876 | * @return bool |
||
| 877 | */ |
||
| 878 | public function loginWithCookie($uid, $currentToken) { |
||
| 905 | |||
| 906 | /** |
||
| 907 | * logout the user from the session |
||
| 908 | * |
||
| 909 | * @return bool |
||
| 910 | */ |
||
| 911 | public function logout() { |
||
| 939 | |||
| 940 | /** |
||
| 941 | * Set cookie value to use in next page load |
||
| 942 | * |
||
| 943 | * @param string $username username to be set |
||
| 944 | * @param string $token |
||
| 945 | */ |
||
| 946 | public function setMagicInCookie($username, $token) { |
||
| 953 | |||
| 954 | /** |
||
| 955 | * Remove cookie for "remember username" |
||
| 956 | */ |
||
| 957 | public function unsetMagicInCookie() { |
||
| 973 | |||
| 974 | /** |
||
| 975 | * Update password of the browser session token if there is one |
||
| 976 | * |
||
| 977 | * @param string $password |
||
| 978 | */ |
||
| 979 | public function updateSessionTokenPassword($password) { |
||
| 990 | |||
| 991 | public function verifyAuthHeaders($request) { |
||
| 992 | $shallLogout = false; |
||
| 993 | try { |
||
| 994 | $lastUser = null; |
||
| 995 | foreach ($this->getAuthModules(true) as $module) { |
||
| 996 | $user = $module->auth($request); |
||
| 997 | if ($user !== null) { |
||
| 998 | if ($this->isLoggedIn() && $this->getUser()->getUID() !== $user->getUID()) { |
||
| 999 | $shallLogout = true; |
||
| 1000 | break; |
||
| 1001 | } |
||
| 1020 | |||
| 1021 | /** |
||
| 1022 | * @param $includeBuiltIn |
||
| 1023 | * @return \Generator | IAuthModule[] |
||
| 1024 | * @throws Exception |
||
| 1025 | */ |
||
| 1026 | protected function getAuthModules($includeBuiltIn) { |
||
| 1044 | } |
||
| 1045 |
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.
For example, imagine you have a variable
$accountIdthat can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to theidproperty of an instance of theAccountclass. This class holds a proper account, so the id value must no longer be false.Either this assignment is in error or a type check should be added for that assignment.