path: root/vendor/spomky-labs/otphp/src/OTPInterface.php

<?php

declare(strict_types=1);

namespace OTPHP;

interface OTPInterface
{
    public const DEFAULT_DIGITS = 6;

    public const DEFAULT_DIGEST = 'sha1';

    /**
     * Create a OTP object from an existing secret.
     *
     * @param non-empty-string $secret
     */
    public static function createFromSecret(string $secret): self;

    /**
     * Create a new OTP object. A random 64 bytes secret will be generated.
     */
    public static function generate(): self;

    /**
     * @param non-empty-string $secret
     */
    public function setSecret(string $secret): void;

    public function setDigits(int $digits): void;

    /**
     * @param non-empty-string $digest
     */
    public function setDigest(string $digest): void;

    /**
     * @return string Return the OTP at the specified timestamp
     */
    public function at(int $input): string;

    /**
     * Verify that the OTP is valid with the specified input. If no input is provided, the input is set to a default
     * value or false is returned.
     */
    public function verify(string $otp, null|int $input = null, null|int $window = null): bool;

    /**
     * @return string The secret of the OTP
     */
    public function getSecret(): string;

    /**
     * @param string $label The label of the OTP
     */
    public function setLabel(string $label): void;

    /**
     * @return string|null The label of the OTP
     */
    public function getLabel(): null|string;

    /**
     * @return string|null The issuer
     */
    public function getIssuer(): ?string;

    public function setIssuer(string $issuer): void;

    /**
     * @return bool If true, the issuer will be added as a parameter in the provisioning URI
     */
    public function isIssuerIncludedAsParameter(): bool;

    public function setIssuerIncludedAsParameter(bool $issuer_included_as_parameter): void;

    /**
     * @return int Number of digits in the OTP
     */
    public function getDigits(): int;

    /**
     * @return string Digest algorithm used to calculate the OTP. Possible values are 'md5', 'sha1', 'sha256' and 'sha512'
     */
    public function getDigest(): string;

    public function getParameter(string $parameter): mixed;

    public function hasParameter(string $parameter): bool;

    /**
     * @return array<string, mixed>
     */
    public function getParameters(): array;

    public function setParameter(string $parameter, mixed $value): void;

    /**
     * Get the provisioning URI.
     */
    public function getProvisioningUri(): string;

    /**
     * Get the provisioning URI.
     *
     * @param string $uri         The Uri of the QRCode generator with all parameters. This Uri MUST contain a placeholder that will be replaced by the method.
     * @param string $placeholder the placeholder to be replaced in the QR Code generator URI
     */
    public function getQrCodeUri(string $uri, string $placeholder): string;
}