Changelog for 3.x . PR #127

CHANGELOG.md

@@ -8,9 +8,35 @@
 
 Version 3.x requires at least PHP 8.2.
 
+### Constructor signature change
+
+In order to ensure users of this library make a conscious choice of QR Code Provider, the QR Code Provider is now a mandatory argument, in first place.
+
+If you didn't provide one explicitly before, you can get the old behavior with:
+
+~~~php
+use RobThree\Auth\TwoFactorAuth;
+use RobThree\Auth\Providers\Qr\QRServerProvider;
+$tfa = new TwoFactorAuth(new QRServerProvider());
+~~~
+
+If you provided one before, the order of the parameters have been changed, so simply move the QRCodeProvider argument to the first place or use named arguments.
+
+Documentation on selecting a QR Code Provider is available here: [QR Code Provider documentation](https://robthree.github.io/TwoFactorAuth/qr-codes.html).
+
+### Default secret length
+
+The default secret length has been increased from 80 bits to 160 bits (RFC4226) PR #117. This might cause an issue in your application if you were previously storing secrets in a column with restricted size. This change doesn't impact existing secrets, only new ones will get longer.
+
+Previously a secret was 16 characters, now it needs to be stored in a 32 characters width column.
+
+You can keep the old behavior by setting `80` as argument to `createSecret()` (not recommended, see [#117](https://github.com/RobThree/TwoFactorAuth/pull/117) for further discussion).
+
 ## Other changes
 
 * The new PHP attribute [SensitiveParameter](https://www.php.net/manual/en/class.sensitiveparameter.php) was added to the code, to prevent accidental leak of secrets in stack traces.
+* Likely not breaking anything, but now all external QR Code providers use HTTPS with a verified certificate, see #126.
+* The CSPRNG is now exclusively using `random_bytes()` PHP function. Previously a fallback to `openssl` or non cryptographically secure PRNG existed, they have been removed (#122)
 
 # Version 2.x