reinhardt-auth 0.1.2

Authentication and authorization system
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
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::fmt::Display;
use unicode_normalization::UnicodeNormalization;

use crate::core::hasher::PasswordHasher;

/// BaseUser trait - Django-style authentication
///
/// This trait provides the core user authentication functionality, including
/// password hashing and verification. It is inspired by Django's AbstractBaseUser.
///
/// # Type Parameters
///
/// * `PrimaryKey` - The type of the user's primary key (e.g., `Uuid`, `i64`)
/// * `Hasher` - The password hasher implementation (default: `Argon2Hasher`)
///
/// # Examples
///
/// ```
/// use reinhardt_auth::{BaseUser, PasswordHasher};
/// #[cfg(feature = "argon2-hasher")]
/// use reinhardt_auth::Argon2Hasher;
/// use uuid::Uuid;
/// use chrono::{DateTime, Utc};
/// use serde::{Serialize, Deserialize};
///
/// #[derive(Serialize, Deserialize)]
/// struct MyUser {
///     id: Uuid,
///     email: String,
///     password_hash: Option<String>,
///     last_login: Option<DateTime<Utc>>,
///     is_active: bool,
/// }
///
/// #[cfg(feature = "argon2-hasher")]
/// impl BaseUser for MyUser {
///     type PrimaryKey = Uuid;
///     type Hasher = Argon2Hasher;
///
///     fn get_username_field() -> &'static str { "email" }
///     fn get_username(&self) -> &str { &self.email }
///     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
///     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
///     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
///     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
///     fn is_active(&self) -> bool { self.is_active }
/// }
///
/// # #[cfg(feature = "argon2-hasher")]
/// # {
/// let mut user = MyUser {
///     id: Uuid::now_v7(),
///     email: "user@example.com".to_string(),
///     password_hash: None,
///     last_login: None,
///     is_active: true,
/// };
///
/// // Set password
/// user.set_password("secure_password123").unwrap();
/// assert!(user.has_usable_password());
///
/// // Check password
/// assert!(user.check_password("secure_password123").unwrap());
/// assert!(!user.check_password("wrong_password").unwrap());
/// # }
/// ```
pub trait BaseUser: Send + Sync + Serialize + for<'de> Deserialize<'de> {
	/// The type of the primary key (e.g., Uuid, i64)
	type PrimaryKey: Clone + Send + Sync + Display;

	/// The password hasher to use (e.g., Argon2Hasher)
	type Hasher: PasswordHasher + Default;

	/// Returns the name of the username field
	///
	/// This is typically "username" or "email", depending on your user model.
	fn get_username_field() -> &'static str;

	/// Returns the username value
	fn get_username(&self) -> &str;

	/// Returns the hashed password, if set
	fn password_hash(&self) -> Option<&str>;

	/// Sets the hashed password
	fn set_password_hash(&mut self, hash: String);

	/// Returns the last login time
	fn last_login(&self) -> Option<DateTime<Utc>>;

	/// Sets the last login time
	fn set_last_login(&mut self, time: DateTime<Utc>);

	/// Returns whether the user account is active
	fn is_active(&self) -> bool;

	/// Normalizes the username for consistent storage
	///
	/// By default, applies NFKC Unicode normalization. Override this method
	/// if you need different normalization behavior.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// # #[cfg(feature = "argon2-hasher")]
	/// # {
	/// let normalized = MyUser::normalize_username("Åsa@example.com");
	/// assert_eq!(normalized, "Åsa@example.com"); // NFKC normalized
	/// # }
	/// ```
	fn normalize_username(username: &str) -> String {
		username.nfkc().collect()
	}

	/// Sets the password, hashing it first
	///
	/// # Examples
	///
	/// ```
	/// # use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// # #[cfg(feature = "argon2-hasher")]
	/// # {
	/// let mut user = MyUser {
	///     id: Uuid::now_v7(),
	///     email: "user@example.com".to_string(),
	///     password_hash: None,
	///     last_login: None,
	///     is_active: true,
	/// };
	///
	/// user.set_password("my_secure_password").unwrap();
	/// assert!(user.password_hash().is_some());
	/// # }
	/// ```
	fn set_password(&mut self, password: &str) -> Result<(), reinhardt_core::exception::Error> {
		let hasher = Self::Hasher::default();
		let hash = hasher.hash(password)?;
		self.set_password_hash(hash);
		Ok(())
	}

	/// Checks if the given password is correct
	///
	/// # Examples
	///
	/// ```
	/// # use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// # #[cfg(feature = "argon2-hasher")]
	/// # {
	/// let mut user = MyUser {
	///     id: Uuid::now_v7(),
	///     email: "user@example.com".to_string(),
	///     password_hash: None,
	///     last_login: None,
	///     is_active: true,
	/// };
	///
	/// user.set_password("correct_password").unwrap();
	///
	/// assert!(user.check_password("correct_password").unwrap());
	/// assert!(!user.check_password("wrong_password").unwrap());
	/// # }
	/// ```
	fn check_password(&self, password: &str) -> Result<bool, reinhardt_core::exception::Error> {
		// Return false early if password is not usable (e.g., "!" marker)
		if !self.has_usable_password() {
			return Ok(false);
		}

		match self.password_hash() {
			Some(hash) => {
				let hasher = Self::Hasher::default();
				hasher.verify(password, hash)
			}
			None => Ok(false),
		}
	}

	/// Sets an unusable password (user cannot log in with password)
	///
	/// # Examples
	///
	/// ```no_run
	/// # use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// let mut user = MyUser {
	///     id: Uuid::now_v7(),
	///     email: "user@example.com".to_string(),
	///     password_hash: None,
	///     last_login: None,
	///     is_active: true,
	/// };
	///
	/// user.set_unusable_password();
	/// assert!(!user.has_usable_password());
	/// ```
	fn set_unusable_password(&mut self) {
		self.set_password_hash("!".to_string());
	}

	/// Returns whether the user has a usable password
	///
	/// # Examples
	///
	/// ```
	/// # use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// # #[cfg(feature = "argon2-hasher")]
	/// # {
	/// let mut user = MyUser {
	///     id: Uuid::now_v7(),
	///     email: "user@example.com".to_string(),
	///     password_hash: None,
	///     last_login: None,
	///     is_active: true,
	/// };
	///
	/// assert!(!user.has_usable_password());
	///
	/// user.set_password("password123").unwrap();
	/// assert!(user.has_usable_password());
	///
	/// user.set_unusable_password();
	/// assert!(!user.has_usable_password());
	/// # }
	/// ```
	fn has_usable_password(&self) -> bool {
		match self.password_hash() {
			Some(hash) => !hash.is_empty() && hash != "!",
			None => false,
		}
	}

	/// Returns a hash of the session authentication credentials
	///
	/// Uses HMAC-SHA256 with the provided secret as key material combined with the
	/// password hash. The secret should be a server-side secret (e.g., `SECRET_KEY`
	/// from settings) to prevent session forgery.
	///
	/// # Arguments
	///
	/// * `secret` - A server-side secret used as HMAC key material. This should be
	///   the application's `SECRET_KEY` or equivalent cryptographic secret.
	///
	/// # Examples
	///
	/// ```
	/// # use reinhardt_auth::BaseUser;
	/// # use reinhardt_auth::PasswordHasher;
	/// # #[cfg(feature = "argon2-hasher")]
	/// # use reinhardt_auth::Argon2Hasher;
	/// # use uuid::Uuid;
	/// # use chrono::{DateTime, Utc};
	/// # use serde::{Serialize, Deserialize};
	/// # #[derive(Serialize, Deserialize)]
	/// # struct MyUser { id: Uuid, email: String, password_hash: Option<String>,
	/// #   last_login: Option<DateTime<Utc>>, is_active: bool }
	/// # #[cfg(feature = "argon2-hasher")]
	/// # impl BaseUser for MyUser {
	/// #     type PrimaryKey = Uuid;
	/// #     type Hasher = Argon2Hasher;
	/// #     fn get_username_field() -> &'static str { "email" }
	/// #     fn get_username(&self) -> &str { &self.email }
	/// #     fn password_hash(&self) -> Option<&str> { self.password_hash.as_deref() }
	/// #     fn set_password_hash(&mut self, hash: String) { self.password_hash = Some(hash); }
	/// #     fn last_login(&self) -> Option<DateTime<Utc>> { self.last_login }
	/// #     fn set_last_login(&mut self, time: DateTime<Utc>) { self.last_login = Some(time); }
	/// #     fn is_active(&self) -> bool { self.is_active }
	/// # }
	///
	/// # #[cfg(feature = "argon2-hasher")]
	/// # {
	/// let mut user = MyUser {
	///     id: Uuid::now_v7(),
	///     email: "user@example.com".to_string(),
	///     password_hash: None,
	///     last_login: None,
	///     is_active: true,
	/// };
	///
	/// let secret = "my-server-secret-key";
	/// user.set_password("password123").unwrap();
	/// let hash1 = user.get_session_auth_hash(secret);
	///
	/// user.set_password("new_password").unwrap();
	/// let hash2 = user.get_session_auth_hash(secret);
	///
	/// assert_ne!(hash1, hash2); // Hash changes when password changes
	/// # }
	/// ```
	fn get_session_auth_hash(&self, secret: &str) -> String {
		use hmac::{Hmac, Mac};
		use sha2::Sha256;

		let password_hash = self.password_hash().unwrap_or("");
		// Derive HMAC key from the server secret combined with a domain separator
		let key = format!("reinhardt.auth.session_hash:{}", secret);

		let mut mac =
			Hmac::<Sha256>::new_from_slice(key.as_bytes()).expect("HMAC can take key of any size");
		mac.update(password_hash.as_bytes());

		hex::encode(mac.finalize().into_bytes())
	}
}