rpassword

Fixes a Unicode parsing bug which could lead to unwarranted panic (6c19a1e).

Backwards compatible. No breaking change.

This release fixes a cross-platform compilation issue that appeared in v.7.5.0 (60ee071).

Thanks @aharpervc for bringing this to my attention in #126.

Backwards compatible. No breaking change.

This release comes with lots of stuff. It should be fully backward compatible.

New features

• Support for masking or partially masking a password as it's being typed. Thank you, @chipsenkbeil, for your contribution.
• New API. The documentation has been vastly improved to support this, see https://docs.rs/rpassword/. To sum up, you can now call read_password_with_config(config) and there is a ConfigBuilder that allows you to configure how passwords should be read. This makes the library much more flexible and means new options will be added without breaking existing code.

Fixes

• Fix for CVE-2025-64170 which affects rpassword on versions v7.4.0 and below. Thank you, @squell and @DevLaTron, for reporting this.
• Better support for multibyte characters and more reliable handling of control characters and terminal escape sequences. Thank you again, @chipsenkbeil, for your contribution.

Deprecations

• _from_bufread functions have been deprecated. You are encouraged to migrate to _with_config functions. See UPGRADE.md as well as the documentation which has examples that you can most likely drop into your code without other changes.

Misc

• Update of the windows-sys dependency.
• Update Rust edition from 2018 to 2024.
• Better cross-platform testing, through more unit tests and a CI that runs Linux, Windows and Wasm.

Feedback is very much welcome.

Changes and updates in this release:

• Updates windows-sys from 0.52 to 0.59, see cb2244a;
• Improves Chinese character handling, the commit is in the rtoolbox crate (https://github.com/conradkleinespel/rtoolbox). Thank you @Jordan-Haidee for providing a fix in #97.

I've noticed after publishing the release that the size of the crate on crates.io went from 7KiB to 121KiB. That's due to the addition of an image in the README.md, which I did not anticipate would be distributed to everyone. The fix (7c30111) will be included in the next release.

No functionality changes in this release. It is backwards compatible.

This release updates the README.md, so the latest version appears on crates.io.

No functionality changes in this release. It is backwards compatible.

The winapi package has been replaced with the windows-sys package developed by Microsoft. Thanks for your help, @messense!

No functionality changes in this release. It is backwards compatible.

This release completely removes the dependency on serde. It adds a new dependency rtoolbox which are utility functions I use in multiple projects. This change is meant to improve supply chain security. I don't own serde but I do own rtoolbox. Code for rtoolbox is available here: https://github.com/conradkleinespel/rtoolbox.

No functionality changes in this release. It is backwards compatible.

This release includes a fix from @LSchallot which allows users to hit Ctrl-U to remove the password and start from scratch, similar to when you hit Ctrl-U in your terminal to clear the line.

It also specifies a minimum Rust version in Cargo.toml.