vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/UserTwoFactor.php line 23

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Bundle\SecurityBundle\Entity;
  14. use JMS\Serializer\Annotation\ExclusionPolicy;
  15. use JMS\Serializer\Annotation\Expose;
  16. use JMS\Serializer\Annotation\Groups;
  17. use JMS\Serializer\Annotation\SerializedName;
  18. use JMS\Serializer\Annotation\VirtualProperty;
  19. use Sulu\Bundle\SecurityBundle\Entity\TwoFactor\TwoFactorInterface;
  20. use Sulu\Component\Security\Authentication\UserInterface;
  22. #[ExclusionPolicy('all')]
  23. class UserTwoFactor
  24. {
  25. private int $id;
  27. private UserInterface $user;
  29. #[Expose]
  30. #[Groups(['profile'])]
  31. private ?string $method = null;
  33. private ?string $options = null;
  35. public function __construct(TwoFactorInterface $user)
  36. {
  37. /** @var UserInterface $user */
  38. $this->user = $user;
  39. }
  41. public function getMethod(): ?string
  42. {
  43. return $this->method;
  44. }
  46. #[VirtualProperty]
  47. #[SerializedName('hasBackupCodes')]
  48. #[Groups(['profile'])]
  49. public function hasBackupCodes(): bool
  50. {
  51. return [] !== ($this->getOptions()['backupCodes'] ?? []);
  52. }
  54. /**
  55. * @return static
  56. */
  57. public function setMethod(?string $twoFactorType)
  58. {
  59. $this->method = $twoFactorType;
  61. return $this;
  62. }
  64. /**
  65. * @return array{
  66. * backupCodes?: string[],
  67. * authCode?: string,
  68. * googleAuthenticatorSecret?: string,
  69. * pendingGoogleAuthenticatorSecret?: string,
  70. * googleAuthenticatorUsername?: string,
  71. * totpSecret?: string,
  72. * pendingTotpSecret?: string,
  73. * trustedVersion?: int,
  74. * }
  75. */
  76. public function getOptions(): ?array
  77. {
  78. if (null === $this->options) {
  79. return null;
  80. }
  82. /**
  83. * @var array{
  84. * backupCodes?: string[],
  85. * authCode?: string,
  86. * googleAuthenticatorSecret?: string,
  87. * pendingGoogleAuthenticatorSecret?: string,
  88. * googleAuthenticatorUsername?: string,
  89. * totpSecret?: string,
  90. * pendingTotpSecret?: string,
  91. * trustedVersion?: int,
  92. * }
  93. */
  94. return \json_decode($this->options, true, flags: \JSON_THROW_ON_ERROR);
  95. }
  97. /**
  98. * @param mixed[] $options
  99. *
  100. * @return static
  101. */
  102. public function setOptions(?array $options)
  103. {
  104. $this->options = $options ? \json_encode($options, \JSON_THROW_ON_ERROR) : null;
  106. return $this;
  107. }
  108. }