readpass 1.0.2

A tiny library for reading passwords without displaying them on the terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# readpass

[![CI](https://img.shields.io/github/actions/workflow/status/acuteenvy/readpass/ci.yml?label=CI&logo=github&style=flat-square)](https://github.com/acuteenvy/readpass/actions/workflows/ci.yml)
[![crates.io](https://img.shields.io/crates/v/readpass?logo=rust&style=flat-square&color=orange)][crate]
[![MSRV](https://img.shields.io/crates/msrv/readpass?logo=rust&style=flat-square&color=teal)][crate]
[![crates.io downloads](https://img.shields.io/crates/d/readpass?logo=rust&style=flat-square)][crate]
[![license](https://img.shields.io/github/license/acuteenvy/readpass?style=flat-square&color=purple)](/LICENSE-APACHE)
<br>
[![docs.rs](https://img.shields.io/docsrs/readpass?logo=rust&style=flat-square)](https://docs.rs/readpass)

A tiny library for reading passwords without displaying them on the terminal.
It's similar to the C function `getpass()` or Python's `getpass` module.

## Usage

Read a password without displaying it on the terminal:

```rust
let passwd = readpass::from_tty()?;
```

If you want to display a prompt, print it to stdout or stderr before reading:

```rust
use std::io::{self, Write};

write!(io::stderr(), "Please enter a password: ")?;
let passwd = readpass::from_tty()?;
```

Strings returned by `readpass` are wrapped in [`Zeroizing`](https://docs.rs/zeroize/latest/zeroize/struct.Zeroizing.html)
to ensure the password is zeroized from memory after it's `Drop`ped.

Docs: <https://docs.rs/readpass>.

## License

The source code is released under the Apache 2.0 license.
<br><br>
This is a fork of [rpassword](https://github.com/conradkleinespel/rpassword) by Conrad Kleinespel.
The original library appears unmaintained, and rolls its own version of [zeroize](https://github.com/RustCrypto/utils/tree/master/zeroize)
in [rtoolbox](https://docs.rs/rtoolbox/0.0.2/rtoolbox/safe_string/struct.SafeString.html).
This crate aims to change that.

[crate]: https://crates.io/crates/readpass