Edit

thodg/totp-rs/README.md

Branch :

  • Show log

    Commit

  • Author : hebriel
    Date : 2020-06-21 16:39:00
    Hash : 64faae59
    Message : Changed a bunch of to_string() to to_owned()

  • README.md
  • # totp-rs
    
    This library permits the creation of 2FA authentification tokens per TOTP, the verification of said tokens, with configurable time skew, validity time of each token, algorithm and number of digits! With additional feature "qr", you can use it to generate a base64 png qrcode.
    
    ## How to use
    
    Add it to your `Cargo.toml`:
    ```toml
    [dependencies]
    totp-rs = "~0.3"
    ```
    You can then do something like:
    ```Rust
    use std::time::SystemTime;
    use totp_rs::{Algorithm, TOTP};
    
    let username = "example".to_owned();
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        "supersecret".to_owned().into_bytes(),
    );
    let time = SystemTime::now()
        .duration_since(SystemTime::UNIX_EPOCH).unwrap()
        .as_secs();
    let url = totp.get_url(format!("account:{}", username), "my-org.com".to_owned());
    println!("{}", url);
    let token = totp.generate(time);
    println!("{}", token);
    ```
    
    ### With qrcode generation
    
    Add it to your `Cargo.toml`:
    ```toml
    [dependencies.totp-rs]
    version = "~0.3"
    features = ["qr"]
    ```
    You can then do something like:
    ```Rust
    use totp_rs::{Algorithm, TOTP};
    
    let username = "example".to_owned();
    let totp = TOTP::new(
        Algorithm::SHA1,
        6,
        1,
        30,
        "supersecret".to_owned().into_bytes(),
    );
    let code = totp.get_qr(format!("account:{}", username), "my-org.com".to_owned())?;
    println!("{}", code);
    ```