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 aConfigBuilderthat 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
rpasswordon 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_bufreadfunctions have been deprecated. You are encouraged to migrate to_with_configfunctions. 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-sysdependency. - 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.