userp 0.0.4

Userp is a user account system inspired by Next Auth, with OAuth, password and email support, a ready-made Axum router with Askama templates, and more on the way!
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

#[cfg(feature = "email")]
use crate::email::{EmailChallenge, UserEmail};
#[cfg(feature = "oauth")]
use crate::oauth::{OAuthToken, UnmatchedOAuthToken};
use crate::{
    enums::LoginMethod,
    traits::{LoginSession, User},
};
use async_trait::async_trait;
#[cfg(feature = "email")]
use chrono::{DateTime, Utc};
use uuid::Uuid;

#[async_trait]
pub trait UserpStore: Send + Sync {
    type User: User;
    type LoginSession: LoginSession;
    type Error: std::error::Error + Send;

    #[cfg(feature = "email")]
    type UserEmail: UserEmail;
    #[cfg(feature = "email")]
    type EmailChallenge: EmailChallenge;
    #[cfg(feature = "oauth")]
    type OAuthToken: OAuthToken;

    // basic store
    async fn get_user(&self, user_id: Uuid) -> Result<Option<Self::User>, Self::Error>;
    async fn create_session(
        &self,
        user_id: Uuid,
        method: LoginMethod,
    ) -> Result<Self::LoginSession, Self::Error>;
    async fn get_session(
        &self,
        session_id: Uuid,
    ) -> Result<Option<Self::LoginSession>, Self::Error>;
    async fn delete_session(&self, session_id: Uuid) -> Result<(), Self::Error>;

    // password store
    #[cfg(feature = "password")]
    async fn password_get_user_by_password_id(
        &self,
        password_id: &str,
    ) -> Result<Option<Self::User>, Self::Error>;
    #[cfg(feature = "password")]
    async fn password_create_user(
        &self,
        password_id: &str,
        password_hash: &str,
    ) -> Result<Self::User, Self::Error>;

    // email store
    #[cfg(feature = "email")]
    async fn email_get_user_by_email_address(
        &self,
        address: &str,
    ) -> Result<Option<(Self::User, Self::UserEmail)>, Self::Error>;
    #[cfg(feature = "email")]
    async fn email_create_user_by_email_address(
        &self,
        address: &str,
    ) -> Result<(Self::User, Self::UserEmail), Self::Error>;
    #[cfg(feature = "email")]
    async fn email_set_verified(&self, address: &str) -> Result<(), Self::Error>;
    #[cfg(feature = "email")]
    async fn email_create_challenge(
        &self,
        address: String,
        code: String,
        next: Option<String>,
        expires: DateTime<Utc>,
    ) -> Result<Self::EmailChallenge, Self::Error>;
    #[cfg(feature = "email")]
    async fn email_consume_challenge(
        &self,
        code: String,
    ) -> Result<Option<Self::EmailChallenge>, Self::Error>;

    // oauth store
    #[cfg(feature = "oauth")]
    async fn update_token_by_unmatched_token(
        &self,
        token_id: Uuid,
        unmatched_token: UnmatchedOAuthToken,
    ) -> Result<Self::OAuthToken, Self::Error>;
    #[cfg(feature = "oauth")]
    async fn oauth_get_token_by_id(
        &self,
        token_id: Uuid,
    ) -> Result<Option<Self::OAuthToken>, Self::Error>;
    #[cfg(feature = "oauth")]
    async fn get_token_by_unmatched_token(
        &self,
        unmatched_token: UnmatchedOAuthToken,
    ) -> Result<Option<Self::OAuthToken>, Self::Error>;
    #[cfg(feature = "oauth")]
    async fn create_user_token_from_unmatched_token(
        &self,
        user_id: Uuid,
        unmatched_token: UnmatchedOAuthToken,
    ) -> Result<Self::OAuthToken, Self::Error>;
    #[cfg(feature = "oauth")]
    async fn create_user_from_unmatched_token(
        &self,
        unmatched_token: UnmatchedOAuthToken,
    ) -> Result<(Self::User, Self::OAuthToken), Self::Error>;
    #[cfg(feature = "oauth")]
    async fn get_user_by_unmatched_token(
        &self,
        unmatched_token: UnmatchedOAuthToken,
    ) -> Result<Option<(Self::User, Self::OAuthToken)>, Self::Error>;

    // account store
    #[cfg(feature = "account")]
    async fn get_user_sessions(
        &self,
        user_id: Uuid,
    ) -> Result<Vec<Self::LoginSession>, Self::Error>;
    #[cfg(all(feature = "account", feature = "oauth"))]
    async fn get_user_oauth_tokens(
        &self,
        user_id: Uuid,
    ) -> Result<Vec<Self::OAuthToken>, Self::Error>;
    #[cfg(all(feature = "account", feature = "oauth"))]
    async fn delete_oauth_token(&self, token_id: Uuid) -> Result<(), Self::Error>;
    #[cfg(feature = "account")]
    async fn delete_user(&self, id: Uuid) -> Result<(), Self::Error>;
    #[cfg(all(feature = "account", feature = "password"))]
    async fn clear_user_password_hash(
        &self,
        user_id: Uuid,
        session_id: Uuid,
    ) -> Result<(), Self::Error>;
    #[cfg(all(feature = "account", feature = "email"))]
    async fn get_user_emails(&self, user_id: Uuid) -> Result<Vec<Self::UserEmail>, Self::Error>;
    #[cfg(all(feature = "account", feature = "password"))]
    async fn set_user_password_hash(
        &self,
        user_id: Uuid,
        password_hash: String,
        session_id: Uuid,
    ) -> Result<(), Self::Error>;
    #[cfg(all(feature = "account", feature = "email"))]
    async fn set_user_email_allow_link_login(
        &self,
        user_id: Uuid,
        address: String,
        allow_login: bool,
    ) -> Result<(), Self::Error>;
    #[cfg(all(feature = "account", feature = "email"))]
    async fn add_user_email(&self, user_id: Uuid, address: String) -> Result<(), Self::Error>;
    #[cfg(all(feature = "account", feature = "email"))]
    async fn delete_user_email(&self, user_id: Uuid, address: String) -> Result<(), Self::Error>;
}