Breaking

This is a BIG API change. Please check MIGRATION.md for more details.

What's new

• MSRV was bumped to 1.88.
• Edition was bumped to 2024.
• [no_std] support with #87 and #88.
• We now use the builder pattern to instanciate a Totp struct.
• Error types were unified into one Error type.

Changes

• Types and methods were renamed to more idiomatic alternatives.
• Functions that check the validity of a token now return the matched step to give user more tools to prevent token reuse. #63 ans #75.
• Secret serializes to an unpadded base32 string in human-readable formats (JSON, TOML, ...) and to a raw byte string in binary formats. Deserialization accepts both, plus integer sequences from formats without a native byte type.
• Totp now implements PartialEq and Eq, using Secret's constant-time comparison for the secret field.

Special thanks

• @bushrat011899 For huge work on #87, #88.
• @Amandeepsinghghai and @sidrubs For pointing out something should be done about to avoid token reuse.

Breaking

This is a BIG API change. Please check MIGRATION.md for more details.

What's new

• MSRV was bumped to 1.88.
• Edition was bumped to 2024.
• [no_std] support with #87 and #88.
• We now use the builder pattern to instanciate a Totp struct.
• Error types were unified into one Error type.

Changes

• Types and methods were renamed to more idiomatic alternatives.
• Functions that check the validity of a token now return the matched step to give user more tools to prevent token reuse. #63 ans #75.
• Secret serializes to an unpadded base32 string in human-readable formats (JSON, TOML, ...) and to a raw byte string in binary formats. Deserialization accepts both, plus integer sequences from formats without a native byte type.
• Totp now implements PartialEq and Eq, using Secret's constant-time comparison for the secret field.

Special thanks

• @bushrat011899 For huge work on #87, #88.
• @Amandeepsinghghai and @sidrubs For pointing out something should be done about to avoid token reuse.

Fix

• Parse algorithm from URLs more consistently. #90

Special thanks

• @deade1e for proposing a PR to fix that. It was changed in v6 but might as well fix it now.

Fix

• Parse algorithm from URLs more consistently. #90

Special thanks

• @deade1e for proposing a PR to fix that. It was changed in v6 but might as well fix it now.

Fix

• Secret gets zeroized more consistently. #81

Special thanks

• @dev-void-7 for pointing out and giving feedback on #81.

Note

This last month has seen a lot of activity on the big 6.0. No date yet, but it has gone from a nebulous "it will happen"
to a "most refactor has been done, a lot of code has been either removed or heavily changed, and the API is becoming clearer".

Fix

• Secret gets zeroized more consistently. #81

Special thanks

• @dev-void-7 for pointing out and giving feedback on #81.

Note

This last month has seen a lot of activity on the big 6.0. No date yet, but it has gone from a nebulous "it will happen" to a "most refactor has been done, a lot of code has been either removed or heavily changed, and the API is becoming clearer".

Breaking changes.

• MSRV has been set to Rust 1.66.

Changes

• Updated base32 crate to 0.5.
• Updated constant_time_eq crate to 0.3.
• Updated rand crate to 0.9.
• Added a bit of documentation.

Note

This is probably the last version update before the big 6.0, which will be a big rewrite, and the 2024 edition.
The goal will be to expose the same feature as before, but in a more harmonized and idiomatic way.

Breaking changes.

• MSRV has been set to Rust 1.66.

Changes

• Updated base32 crate to 0.5.
• Updated constant_time_eq crate to 0.3.
• Updated rand crate to 0.9.
• Added a bit of documentation.

Note

This is probably the last version update before the big 6.0, which will be a big rewrite, and the 2024 edition. The goal will be to expose the same feature as before, but in a more harmonized and idiomatic way.

Changes

• qrcodegen-image has now been moved to its own repo.

Changes

• qrcodegen-image has now been moved to its own repo.

Changes

• Documentation now indicates required feature.

Special thanks

• @AntonnMal for his work on #64.

Full Changelog: v5.4.0...v5.5.0

Changes

• Documentation now indicates required feature.

Special thanks

• @AntonnMal for his work on #64.

5.4.0 (04/10/2023)

Changes

• SecretParseError now implements std::error::Error.

Special thanks

• @FliegendeWurst for their work on #62.

Changes

• SecretParseError now implements std::error::Error.

Special thanks

• @FliegendeWurst for their work on #62.

Compare

What's new

• Creation of a new qrcodegen-image subcrate to handle image creation, as the wrapper is actually nice and could be used in placed not related to totp-rs. (#61)

Changes

• TOTP::get_qr was deprecated in favour of TOTP::get_qr_base64 and TOTP::get_qr_png.

Special thanks

• @tmpfs for their work on #60 and implementation in #61.

Changes

• Updated url crate to 2.4.

What's new

• Added some more documentation.

Fix

• Removed unnecessary allocation for Secret.Display for the Raw variant.

Fix

• Fix skew overflowing if value is over 128.

Special thanks

• @carl-wallace for discovering #58.

Changes

• Normalize dependencies specifications since cargo uses range dependency by default.

Special thanks

• @bestia-dev for pointing out discrepancies in my dependency requirements.

Fixes

• TotpUrlError was unexported. This is now fixed. (#29)
• base32 was reexported instead. It is now private, and will need to be an explicit dependency for the user to encore/decode base32 data.

Changes

• Secret comparison is now done in constant time.

Special thanks

• @alexanderkja for discovering #29.

What's changed

• Disabled default image features to only enable png