summaryrefslogtreecommitdiff
path: root/vendor/spomky-labs/otphp/src/TOTPInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/spomky-labs/otphp/src/TOTPInterface.php')
-rw-r--r--vendor/spomky-labs/otphp/src/TOTPInterface.php35
1 files changed, 25 insertions, 10 deletions
diff --git a/vendor/spomky-labs/otphp/src/TOTPInterface.php b/vendor/spomky-labs/otphp/src/TOTPInterface.php
index a19fe7c0b..a79fedcce 100644
--- a/vendor/spomky-labs/otphp/src/TOTPInterface.php
+++ b/vendor/spomky-labs/otphp/src/TOTPInterface.php
@@ -2,28 +2,41 @@
declare(strict_types=1);
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2014-2019 Spomky-Labs
- *
- * This software may be modified and distributed under the terms
- * of the MIT license. See the LICENSE file for details.
- */
-
namespace OTPHP;
interface TOTPInterface extends OTPInterface
{
+ public const DEFAULT_PERIOD = 30;
+
+ public const DEFAULT_EPOCH = 0;
+
/**
* Create a new TOTP object.
*
* If the secret is null, a random 64 bytes secret will be generated.
+ *
+ * @param null|non-empty-string $secret
+ * @param positive-int $period
+ * @param non-empty-string $digest
+ * @param positive-int $digits
+ *
+ * @deprecated Deprecated since v11.1, use ::createFromSecret or ::generate instead
*/
- public static function create(?string $secret = null, int $period = 30, string $digest = 'sha1', int $digits = 6): self;
+ public static function create(
+ null|string $secret = null,
+ int $period = self::DEFAULT_PERIOD,
+ string $digest = self::DEFAULT_DIGEST,
+ int $digits = self::DEFAULT_DIGITS
+ ): self;
+
+ public function setPeriod(int $period): void;
+
+ public function setEpoch(int $epoch): void;
/**
* Return the TOTP at the current time.
+ *
+ * @return non-empty-string
*/
public function now(): string;
@@ -32,5 +45,7 @@ interface TOTPInterface extends OTPInterface
*/
public function getPeriod(): int;
+ public function expiresIn(): int;
+
public function getEpoch(): int;
}