soul-auth 0.1.0

Framework-agnostic JWT claims and auth error primitives for the Soul platform.
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

# soul-auth

Framework-agnostic JWT claims and auth error primitives for the Soul platform.

Extracted from the Rainbow-Auth service. This crate keeps **only** the
framework-independent core (JWT encode/decode + a unified `AuthError`),
so it can be reused from any HTTP framework, database, or runtime.

## Add to your project

```toml
[dependencies]
soul-auth = "0.1"
```

## Usage

```rust
use soul_auth::{Claims, SubjectType, encode_token, decode_token};

let secret = b"my-secret-key";

let claims = Claims {
    sub: "user:42".into(),
    exp: 9_999_999_999,
    iat: 1_700_000_000,
    session_id: Some("session:1".into()),
    subject_type: Some(SubjectType::Human),
};

let token   = encode_token(&claims, secret).unwrap();
let decoded = decode_token(&token, secret).unwrap();
assert_eq!(decoded.sub, "user:42");
```

## What's included

| Item             | Purpose                                              |
|------------------|------------------------------------------------------|
| `AuthError`      | Unified auth-flow error enum (`thiserror`-derived)   |
| `Result<T>`      | Alias for `Result<T, AuthError>`                     |
| `Claims`         | JWT claims (`sub`, `exp`, `iat`, `session_id`, ...)  |
| `SubjectType`    | `Human` / `Agent` discriminator                      |
| `encode_token`   | HS256 sign helper                                    |
| `decode_token`   | HS256 verify helper                                  |

## License

MIT