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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
use crate::hash::HashAlgorithm;
use crate::hash::{hash_password, verify_password};
use snafu::{OptionExt, ResultExt, Snafu};
use std::collections::HashMap;
use std::collections::hash_map::Entry;
use std::fs::{self, File, OpenOptions};
use std::io::{BufRead, BufReader, Write};
#[cfg(unix)]
use std::os::unix::fs::OpenOptionsExt;
use std::path::{Path, PathBuf};

/// Errors that can occur during htpasswd file operations.
#[derive(Debug, Snafu)]
pub enum Error {
    /// User was not found in the htpasswd file.
    #[snafu(display("User '{username}' not found"))]
    UserNotFound {
        /// The username that was not found.
        username: String,
    },

    /// User already exists in the htpasswd file.
    #[snafu(display("User '{username}' already exists"))]
    UserAlreadyExists {
        /// The username that already exists.
        username: String,
    },

    /// Username cannot be empty.
    #[snafu(display("Username cannot be empty"))]
    UsernameEmpty,

    /// Username contains invalid character.
    #[snafu(display("Username '{}' contains invalid character ':'", username))]
    UsernameInvalidCharacter {
        /// The invalid username.
        username: String,
    },

    /// Failed to open htpasswd file.
    #[snafu(display("Failed to open htpasswd file '{}'", path.display()))]
    FileOpen {
        /// The underlying I/O error.
        source: std::io::Error,
        /// The file path that could not be opened.
        path: PathBuf,
    },

    /// Failed to read from htpasswd file.
    #[snafu(display("Failed to read htpasswd file '{}'", path.display()))]
    FileRead {
        /// The underlying I/O error.
        source: std::io::Error,
        /// The file path that could not be read.
        path: PathBuf,
    },

    /// Failed to save htpasswd file.
    #[snafu(display("Failed to save htpasswd file '{}'", path.display()))]
    FileSave {
        /// The underlying I/O error.
        source: std::io::Error,
        /// The file path that could not be saved.
        path: PathBuf,
    },

    /// Failed to create parent directory.
    #[snafu(display("Failed to create parent directory '{}'", path.display()))]
    CreateDir {
        /// The underlying I/O error.
        source: std::io::Error,
        /// The directory path that could not be created.
        path: PathBuf,
    },

    /// Failed to hash password.
    #[snafu(display("Failed to hash password"))]
    Hash {
        /// The underlying hash error.
        source: crate::hash::Error,
    },

    /// Failed to verify password.
    #[snafu(display("Failed to verify password"))]
    Verify {
        /// The underlying verification error.
        source: crate::hash::Error,
    },
}

/// Represents an htpasswd file with user credentials.
pub struct Htpasswd {
    entries: HashMap<String, String>,
    comments: Vec<String>,
    path: PathBuf,
    file_existed: bool,
}

impl Htpasswd {
    /// Open an htpasswd file, creating it if it doesn't exist.
    pub fn open(path: impl AsRef<Path>) -> Result<Self, Error> {
        let path = path.as_ref();
        let file_existed = path.exists();

        let mut entries = HashMap::new();
        let mut comments = Vec::new();

        if file_existed {
            let file = File::open(path).context(FileOpenSnafu {
                path: path.to_path_buf(),
            })?;
            let reader = BufReader::new(file);

            for line in reader.lines() {
                let line = line.context(FileReadSnafu {
                    path: path.to_path_buf(),
                })?;
                let trimmed = line.trim();

                // Skip empty lines
                if trimmed.is_empty() {
                    continue;
                }

                // Store comment lines
                if trimmed.starts_with('#') {
                    comments.push(trimmed.to_string());
                    continue;
                }

                // Parse username:hash entries
                if let Some((username, hash)) = trimmed.split_once(':') {
                    snafu::ensure!(!username.is_empty(), UsernameEmptySnafu);
                    snafu::ensure!(
                        !username.contains(':'),
                        UsernameInvalidCharacterSnafu { username }
                    );
                    entries.insert(username.to_string(), hash.to_string());
                }
            }
        }

        Ok(Self {
            entries,
            comments,
            path: path.to_path_buf(),
            file_existed,
        })
    }

    /// Save the htpasswd file.
    pub fn save(&self) -> Result<(), Error> {
        // Create parent directories if needed
        if let Some(parent) = self.path.parent()
            && !parent.exists()
        {
            fs::create_dir_all(parent).context(CreateDirSnafu {
                path: parent.to_path_buf(),
            })?;
        }

        // Store reference to avoid repeated clones
        let path = self.path.as_path();

        // Set restrictive permissions when creating new file
        #[cfg(unix)]
        let mut file = if self.file_existed {
            OpenOptions::new()
                .write(true)
                .create(true)
                .truncate(true)
                .open(&self.path)
                .context(FileSaveSnafu { path })?
        } else {
            OpenOptions::new()
                .write(true)
                .create(true)
                .truncate(true)
                .mode(0o600)
                .open(&self.path)
                .context(FileSaveSnafu { path })?
        };

        #[cfg(not(unix))]
        let mut file = OpenOptions::new()
            .write(true)
            .create(true)
            .truncate(true)
            .open(&self.path)
            .context(FileSaveSnafu { path })?;

        // Write comments first
        for comment in &self.comments {
            writeln!(file, "{}", comment).context(FileSaveSnafu { path })?;
        }

        // Write entries
        for (username, hash) in &self.entries {
            writeln!(file, "{}:{}", username, hash).context(FileSaveSnafu { path })?;
        }

        file.flush().context(FileSaveSnafu { path })?;
        Ok(())
    }

    /// Reload the htpasswd file from disk.
    pub fn reload(&mut self) -> Result<(), Error> {
        *self = Self::open(&self.path)?;
        Ok(())
    }

    /// Add a new user with the given password and hash algorithm.
    pub fn add_user(
        &mut self,
        username: &str,
        password: &str,
        algorithm: HashAlgorithm,
    ) -> Result<(), Error> {
        match self.entries.entry(username.to_string()) {
            Entry::Occupied(_) => UserAlreadyExistsSnafu { username }.fail(),
            Entry::Vacant(entry) => {
                let hash = hash_password(password, algorithm).context(HashSnafu)?;
                entry.insert(hash);
                Ok(())
            }
        }
    }

    /// Update an existing user's password with the specified algorithm.
    pub fn update_user(
        &mut self,
        username: &str,
        password: &str,
        algorithm: HashAlgorithm,
    ) -> Result<(), Error> {
        let entry = self
            .entries
            .get_mut(username)
            .context(UserNotFoundSnafu { username })?;
        *entry = hash_password(password, algorithm).context(HashSnafu)?;
        Ok(())
    }

    /// Delete a user from the htpasswd file.
    pub fn delete_user(&mut self, username: &str) -> Result<(), Error> {
        self.entries
            .remove(username)
            .context(UserNotFoundSnafu { username })?;
        Ok(())
    }

    /// Verify a user's password.
    pub fn verify_user(&self, username: &str, password: &str) -> Result<bool, Error> {
        let hash = self
            .entries
            .get(username)
            .context(UserNotFoundSnafu { username })?;

        verify_password(password, hash).context(VerifySnafu)
    }

    /// List all usernames in the htpasswd file.
    pub fn list_users(&self) -> Vec<String> {
        let mut users: Vec<String> = self.entries.keys().cloned().collect();
        users.sort();
        users
    }

    /// Check if a user exists in the htpasswd file.
    pub fn user_exists(&self, username: &str) -> bool {
        self.entries.contains_key(username)
    }

    /// Get the number of users in the htpasswd file.
    pub fn user_count(&self) -> usize {
        self.entries.len()
    }

    /// Get the file path.
    pub fn path(&self) -> &Path {
        &self.path
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::tempdir;

    #[test]
    fn test_create_and_save() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd
            .add_user("bob", "password456", HashAlgorithm::Sha256)
            .unwrap();
        htpasswd.save().unwrap();

        // Verify file exists and has correct content
        assert!(file_path.exists());
        let content = fs::read_to_string(&file_path).unwrap();
        assert!(content.contains("alice:"));
        assert!(content.contains("bob:"));
        // SHA-256 hashes now use SHA-crypt format: $5$rounds=5000$salt$hash
        assert!(content.contains("$5$"));
    }

    #[test]
    fn test_add_duplicate_user() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        let result = htpasswd.add_user("alice", "password456", HashAlgorithm::Bcrypt);
        assert!(matches!(result, Err(Error::UserAlreadyExists { .. })));
    }

    #[test]
    fn test_verify_user() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd.save().unwrap();

        // Reload and verify
        let htpasswd = Htpasswd::open(&file_path).unwrap();
        assert!(htpasswd.verify_user("alice", "password123").unwrap());
        assert!(!htpasswd.verify_user("alice", "wrongpassword").unwrap());
        assert!(htpasswd.verify_user("nonexistent", "password").is_err());
    }

    #[test]
    fn test_delete_user() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd.delete_user("alice").unwrap();
        htpasswd.save().unwrap();

        let htpasswd = Htpasswd::open(&file_path).unwrap();
        assert!(!htpasswd.user_exists("alice"));
    }

    #[test]
    fn test_delete_nonexistent_user() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        let result = htpasswd.delete_user("nonexistent");
        assert!(matches!(result, Err(Error::UserNotFound { .. })));
    }

    #[test]
    fn test_update_user() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd
            .update_user("alice", "newpassword", HashAlgorithm::Sha512)
            .unwrap();
        htpasswd.save().unwrap();

        let htpasswd = Htpasswd::open(&file_path).unwrap();
        assert!(!htpasswd.verify_user("alice", "password123").unwrap());
        assert!(htpasswd.verify_user("alice", "newpassword").unwrap());
    }

    #[test]
    fn test_list_users() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        htpasswd
            .add_user("charlie", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd
            .add_user("alice", "password456", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd
            .add_user("bob", "password789", HashAlgorithm::Bcrypt)
            .unwrap();

        let users = htpasswd.list_users();
        assert_eq!(users, vec!["alice", "bob", "charlie"]);
    }

    #[test]
    fn test_user_exists() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        assert!(!htpasswd.user_exists("alice"));

        htpasswd
            .add_user("alice", "password123", HashAlgorithm::Bcrypt)
            .unwrap();
        assert!(htpasswd.user_exists("alice"));
        assert!(!htpasswd.user_exists("bob"));
    }

    #[test]
    fn test_comment_preservation() {
        let dir = tempdir().unwrap();
        let file_path = dir.path().join("test.htpasswd");

        // Create file with comments
        {
            let mut file = File::create(&file_path).unwrap();
            writeln!(file, "# This is a comment").unwrap();
            writeln!(file, "# Another comment").unwrap();
            writeln!(file, "alice:$2b$12$testhash").unwrap();
        }

        let mut htpasswd = Htpasswd::open(&file_path).unwrap();
        assert_eq!(htpasswd.comments.len(), 2);

        htpasswd
            .add_user("bob", "password456", HashAlgorithm::Bcrypt)
            .unwrap();
        htpasswd.save().unwrap();

        // Verify comments are preserved
        let content = fs::read_to_string(&file_path).unwrap();
        assert!(content.contains("# This is a comment"));
        assert!(content.contains("# Another comment"));
    }
}