use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
-use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface;
-use Scheb\TwoFactorBundle\Model\TrustedComputerInterface;
use FOS\UserBundle\Model\User as BaseUser;
-use JMS\Serializer\Annotation\ExclusionPolicy;
-use JMS\Serializer\Annotation\Expose;
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\Groups;
+use JMS\Serializer\Annotation\XmlRoot;
+use Scheb\TwoFactorBundle\Model\BackupCodeInterface;
+use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface as EmailTwoFactorInterface;
+use Scheb\TwoFactorBundle\Model\Google\TwoFactorInterface as GoogleTwoFactorInterface;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Security\Core\User\UserInterface;
+use Wallabag\ApiBundle\Entity\Client;
use Wallabag\CoreBundle\Entity\Config;
use Wallabag\CoreBundle\Entity\Entry;
+use Wallabag\CoreBundle\Helper\EntityTimestampsTrait;
/**
* User.
*
+ * @XmlRoot("user")
* @ORM\Entity(repositoryClass="Wallabag\UserBundle\Repository\UserRepository")
* @ORM\Table(name="`user`")
* @ORM\HasLifecycleCallbacks()
- * @ExclusionPolicy("all")
*
* @UniqueEntity("email")
* @UniqueEntity("username")
*/
-class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterface
+class User extends BaseUser implements EmailTwoFactorInterface, GoogleTwoFactorInterface, BackupCodeInterface
{
+ use EntityTimestampsTrait;
+
+ /** @Serializer\XmlAttribute */
/**
* @var int
*
- * @Expose
* @ORM\Column(name="id", type="integer")
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
+ *
+ * @Groups({"user_api", "user_api_with_client"})
*/
protected $id;
* @var string
*
* @ORM\Column(name="name", type="text", nullable=true)
+ *
+ * @Groups({"user_api", "user_api_with_client"})
*/
protected $name;
/**
- * @var date
+ * @var string
+ *
+ * @Groups({"user_api", "user_api_with_client"})
+ */
+ protected $username;
+
+ /**
+ * @var string
+ *
+ * @Groups({"user_api", "user_api_with_client"})
+ */
+ protected $email;
+
+ /**
+ * @var \DateTime
*
* @ORM\Column(name="created_at", type="datetime")
+ *
+ * @Groups({"user_api", "user_api_with_client"})
*/
protected $createdAt;
/**
- * @var date
+ * @var \DateTime
*
* @ORM\Column(name="updated_at", type="datetime")
+ *
+ * @Groups({"user_api", "user_api_with_client"})
*/
protected $updatedAt;
*/
protected $config;
+ /**
+ * @var ArrayCollection
+ *
+ * @ORM\OneToMany(targetEntity="Wallabag\CoreBundle\Entity\SiteCredential", mappedBy="user", cascade={"remove"})
+ */
+ protected $siteCredentials;
+
+ /**
+ * @var ArrayCollection
+ *
+ * @ORM\OneToMany(targetEntity="Wallabag\ApiBundle\Entity\Client", mappedBy="user", cascade={"remove"})
+ */
+ protected $clients;
+
+ /**
+ * @see getFirstClient() below
+ *
+ * @Groups({"user_api_with_client"})
+ * @Accessor(getter="getFirstClient")
+ */
+ protected $default_client;
+
/**
* @ORM\Column(type="integer", nullable=true)
*/
private $authCode;
/**
- * @var bool Enabled yes/no
- * @ORM\Column(type="boolean")
+ * @ORM\Column(name="googleAuthenticatorSecret", type="string", nullable=true)
*/
- private $twoFactorAuthentication = false;
+ private $googleAuthenticatorSecret;
/**
* @ORM\Column(type="json_array", nullable=true)
*/
- private $trusted;
+ private $backupCodes;
+
+ /**
+ * @var bool
+ *
+ * @ORM\Column(type="boolean")
+ */
+ private $emailTwoFactor = false;
public function __construct()
{
$this->roles = ['ROLE_USER'];
}
- /**
- * @ORM\PrePersist
- * @ORM\PreUpdate
- */
- public function timestamps()
- {
- if (is_null($this->createdAt)) {
- $this->createdAt = new \DateTime();
- }
-
- $this->updatedAt = new \DateTime();
- }
-
/**
* Set name.
*
}
/**
- * @return string
+ * @return \DateTime
*/
public function getCreatedAt()
{
}
/**
- * @return string
+ * @return \DateTime
*/
public function getUpdatedAt()
{
/**
* @return bool
*/
- public function isTwoFactorAuthentication()
+ public function isEmailTwoFactor()
{
- return $this->twoFactorAuthentication;
+ return $this->emailTwoFactor;
}
/**
- * @param bool $twoFactorAuthentication
+ * @param bool $emailTwoFactor
*/
- public function setTwoFactorAuthentication($twoFactorAuthentication)
+ public function setEmailTwoFactor($emailTwoFactor)
{
- $this->twoFactorAuthentication = $twoFactorAuthentication;
+ $this->emailTwoFactor = $emailTwoFactor;
}
- public function isEmailAuthEnabled()
+ /**
+ * Used in the user config form to be "like" the email option.
+ */
+ public function isGoogleTwoFactor()
{
- return $this->twoFactorAuthentication;
+ return $this->isGoogleAuthenticatorEnabled();
}
- public function getEmailAuthCode()
+ /**
+ * {@inheritdoc}
+ */
+ public function isEmailAuthEnabled(): bool
+ {
+ return $this->emailTwoFactor;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getEmailAuthCode(): string
{
return $this->authCode;
}
- public function setEmailAuthCode($authCode)
+ /**
+ * {@inheritdoc}
+ */
+ public function setEmailAuthCode(string $authCode): void
{
$this->authCode = $authCode;
}
- public function addTrustedComputer($token, \DateTime $validUntil)
+ /**
+ * {@inheritdoc}
+ */
+ public function getEmailAuthRecipient(): string
+ {
+ return $this->email;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isGoogleAuthenticatorEnabled(): bool
+ {
+ return $this->googleAuthenticatorSecret ? true : false;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getGoogleAuthenticatorUsername(): string
+ {
+ return $this->username;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getGoogleAuthenticatorSecret(): string
+ {
+ return $this->googleAuthenticatorSecret;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setGoogleAuthenticatorSecret(?string $googleAuthenticatorSecret): void
+ {
+ $this->googleAuthenticatorSecret = $googleAuthenticatorSecret;
+ }
+
+ public function setBackupCodes(array $codes = null)
{
- $this->trusted[$token] = $validUntil->format('r');
+ $this->backupCodes = $codes;
}
- public function isTrustedComputer($token)
+ public function getBackupCodes()
{
- if (isset($this->trusted[$token])) {
- $now = new \DateTime();
- $validUntil = new \DateTime($this->trusted[$token]);
+ return $this->backupCodes;
+ }
- return $now < $validUntil;
+ /**
+ * {@inheritdoc}
+ */
+ public function isBackupCode(string $code): bool
+ {
+ return false === $this->findBackupCode($code) ? false : true;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function invalidateBackupCode(string $code): void
+ {
+ $key = $this->findBackupCode($code);
+
+ if (false !== $key) {
+ unset($this->backupCodes[$key]);
+ }
+ }
+
+ /**
+ * @param Client $client
+ *
+ * @return User
+ */
+ public function addClient(Client $client)
+ {
+ $this->clients[] = $client;
+
+ return $this;
+ }
+
+ /**
+ * @return ArrayCollection<Entry>
+ */
+ public function getClients()
+ {
+ return $this->clients;
+ }
+
+ /**
+ * Only used by the API when creating a new user it'll also return the first client (which was also created at the same time).
+ *
+ * @return Client
+ */
+ public function getFirstClient()
+ {
+ if (!empty($this->clients)) {
+ return $this->clients->first();
+ }
+ }
+
+ /**
+ * Try to find a backup code from the list of backup codes of the current user.
+ *
+ * @param string $code Given code from the user
+ *
+ * @return string|false
+ */
+ private function findBackupCode(string $code)
+ {
+ foreach ($this->backupCodes as $key => $backupCode) {
+ // backup code are hashed using `password_hash`
+ // see ConfigController->otpAppAction
+ if (password_verify($code, $backupCode)) {
+ return $key;
+ }
}
return false;
projects / github / wallabag / wallabag.git / blobdiff