Deprecate ::create API, add ::createFromSecret and ::generate APIs

[Slamdunk]

Q	A
Branch?	v11
Bug fix?	no
New feature?	yes
Deprecations?	yes
Tickets	Fix #165
License	MIT

[gitguardian]

⚠️ GitGuardian has uncovered 13 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
-	Generic High Entropy Secret	5275d3d	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	5275d3d	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/HOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/TOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/TOTPTest.php	View secret
-	Generic High Entropy Secret	c7135f4	tests/TOTPTest.php	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

<sup>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sup>

[Spomky]

Excellent. Many thanks.
By the way, I am wondering if it is necessary to have all these optional arguments in the named constructors:

int $period = 30,
string $digest = 'sha1',
int $digits = 6,
int $epoch = 0

It could be a good opportunity to refactor here and have explicit setters:

$otp = TOTP::createFromSecret($mySecret) // or ::generate()
    ->withPeriod(42)
    ->withDigits(12)
;

Note that the setters already exist (e.g. here), but do not return $this.
WDYT?

[Slamdunk]

$otp = TOTP::createFromSecret($mySecret) // or ::generate()
    ->withPeriod(42)
    ->withDigits(12)
;

Abolutely yes, but:

return $this.

Absolutely NO fluent interfaces please.
If we aim at that kind of factories, OTP should became @immutable just like
https://www.php-fig.org/psr/psr-7/#31-psrhttpmessagemessageinterface

That means:

public function withPeriod(int $digits): static
{
    $new = clone $this;
    $new->digits = $digits;

    return $new;
}

I can propose a full PR here to:

1. Add all the necessary new methods
2. Deprecate existing ones in favour of the new with* variant

And after that you can branch off the new v12 were I can propose a PR to drop all deprecated methods and add the new magic @immutable, see PSalm and PHPStan notes

Ping me if you agree before I start the whole work

[Spomky]

What Marco wrote is legit to me.
This is fine and still readable:

$otp = TOTP::createFromSecret($mySecret); // or ::generate()
$otp->setPeriod(42);
$otp->setDigits(12);

Keep It Simple. We can just drop the optional parameters from the static methods.

[Slamdunk]

Done

[Spomky]

Excellent 👌! Many thanks