htauth 0.1.2

A library for managing htpasswd files
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# htauth

A Rust library for managing htpasswd files with support for bcrypt, SHA-256, SHA-512, and APR1-MD5 password hashing algorithms.

[![Crates.io](https://img.shields.io/crates/v/htauth.svg)](https://crates.io/crates/htauth)
[![Documentation](https://docs.rs/htauth/badge.svg)](https://docs.rs/htauth)
[![License](https://img.shields.io/crates/l/htauth.svg)](https://github.com/mexus/htauth#license)

[API Documentation](https://docs.rs/htauth) | [Repository](https://github.com/mexus/htauth)

## Usage

```rust
use htauth::{Htpasswd, HashAlgorithm};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Open or create an htpasswd file
    let mut htpasswd = Htpasswd::open(".htpasswd")?;

    // Add a new user with bcrypt hashing
    htpasswd.add_user("alice", "password123", HashAlgorithm::Bcrypt)?;

    // Verify credentials
    if htpasswd.verify_user("alice", "password123")? {
        println!("Authentication successful");
    }

    // List all usernames
    for username in htpasswd.list_users() {
        println!("{}", username);
    }

    // Remove a user
    htpasswd.delete_user("alice")?;

    // Persist changes to disk
    htpasswd.save()?;

    Ok(())
}
```

## Supported Hash Algorithms

| Algorithm | Identifier | Format |
|-----------|------------|--------|
| bcrypt | `Bcrypt` | `$2y$` / `$2b$` |
| SHA-256 | `Sha256` | `$5$` |
| SHA-512 | `Sha512` | `$6$` |
| APR1-MD5 | `Apr1` | `$apr1$` |

The library can read and verify all formats. Use `detect_algorithm` to determine the algorithm of an existing hash.

## API Overview

- **`Htpasswd`** — Main type for loading, modifying, and saving password files
- **`HashAlgorithm`** — Enum representing supported hash algorithms
- **`hash_password`** / **`verify_password`** — Standalone functions for password hashing
- **`detect_algorithm`** — Detect algorithm from an existing hash string

## Error Handling

The library uses [`snafu`](https://docs.rs/snafu) for structured error handling. Error types are re-exported at the crate level:

- `HashError` — password hashing errors
- `HtpasswdError` — file parsing and I/O errors
- `Apr1Md5Error` — APR1-MD5 specific errors

## Apache Compatibility

Files generated by this library are fully compatible with Apache's `htpasswd` tool and vice versa.

## CLI

For a command-line interface, see the [`htauth-cli`](https://crates.io/crates/htauth-cli) crate.

## License

Licensed under either of [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) or [MIT license](https://opensource.org/licenses/MIT) at your option.