Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.86 KB

README.md

File metadata and controls

78 lines (56 loc) · 2.86 KB
Raw

Rustastic Password

Build Status Build status Chat on Discord

rpassword package allows you to safely read passwords in a console application on Linux, OSX and Windows.

Supporting rpassword

rpassword is currently being maintained as a side-project, during nights and weekends, next to my full-time job. I am looking for a way to sustain my work on open source. If you find value in what I do and you would like to contribute, please consider:

Usage

Add rpassword as a dependency in Cargo.toml:

[dependencies]
rpassword = "4.0"

Use rpassword within your code:

extern crate rpassword;

fn main() {
    // Prompt for a password on TTY (safest but not default for backwards compatibility)
    let pass = rpassword::read_password_from_tty(Some("Password: ")).unwrap();
    println!("Your password is {}", pass);
    
    // Prompt for a password on STDOUT
    let pass = rpassword::prompt_password_stdout("Password: ").unwrap();
    println!("Your password is {}", pass);

    // Prompt for a password on STDERR
    let pass = rpassword::prompt_password_stderr("Password: ").unwrap();
    println!("Your password is {}", pass);

    // Read a password without prompt
    let pass = rpassword::read_password().unwrap();
    println!("Your password is {}", pass);
}

The full API documentation is available at https://docs.rs/rpassword.

Contributors

We welcome contribution from everyone. Feel free to open an issue or a pull request at any time.

Here's a list of existing rpassword contributors:

Thank you very much for your help! 😃 ❤️

License

The source code is released under the Apache 2.0 license.