openauth-core 0.0.3

Core types and primitives for OpenAuth.
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

use std::fmt;
use std::sync::Arc;

use http::Request;

use crate::db::User;
use crate::error::OpenAuthError;

/// Payload passed to an email verification sender.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct VerificationEmail {
    pub user: User,
    pub url: String,
    pub token: String,
}

/// Synchronous email verification sender hook.
pub trait SendVerificationEmail: Send + Sync + 'static {
    fn send_verification_email(
        &self,
        email: VerificationEmail,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError>;
}

impl<F> SendVerificationEmail for F
where
    F: for<'a> Fn(VerificationEmail, Option<&'a Request<Vec<u8>>>) -> Result<(), OpenAuthError>
        + Send
        + Sync
        + 'static,
{
    fn send_verification_email(
        &self,
        email: VerificationEmail,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError> {
        self(email, request)
    }
}

/// Payload passed to email verification lifecycle callbacks.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EmailVerificationCallbackPayload {
    pub user: User,
}

/// Hook invoked before an email is marked as verified or changed.
pub trait BeforeEmailVerification: Send + Sync + 'static {
    fn before_email_verification(
        &self,
        payload: EmailVerificationCallbackPayload,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError>;
}

impl<F> BeforeEmailVerification for F
where
    F: for<'a> Fn(
            EmailVerificationCallbackPayload,
            Option<&'a Request<Vec<u8>>>,
        ) -> Result<(), OpenAuthError>
        + Send
        + Sync
        + 'static,
{
    fn before_email_verification(
        &self,
        payload: EmailVerificationCallbackPayload,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError> {
        self(payload, request)
    }
}

/// Hook invoked after an email is marked as verified or changed.
pub trait AfterEmailVerification: Send + Sync + 'static {
    fn after_email_verification(
        &self,
        payload: EmailVerificationCallbackPayload,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError>;
}

impl<F> AfterEmailVerification for F
where
    F: for<'a> Fn(
            EmailVerificationCallbackPayload,
            Option<&'a Request<Vec<u8>>>,
        ) -> Result<(), OpenAuthError>
        + Send
        + Sync
        + 'static,
{
    fn after_email_verification(
        &self,
        payload: EmailVerificationCallbackPayload,
        request: Option<&Request<Vec<u8>>>,
    ) -> Result<(), OpenAuthError> {
        self(payload, request)
    }
}

/// Email verification configuration.
#[derive(Clone, Default)]
pub struct EmailVerificationOptions {
    pub send_verification_email: Option<Arc<dyn SendVerificationEmail>>,
    pub before_email_verification: Option<Arc<dyn BeforeEmailVerification>>,
    pub after_email_verification: Option<Arc<dyn AfterEmailVerification>>,
    pub expires_in: Option<u64>,
    pub auto_sign_in_after_verification: bool,
}

impl fmt::Debug for EmailVerificationOptions {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("EmailVerificationOptions")
            .field(
                "send_verification_email",
                &self
                    .send_verification_email
                    .as_ref()
                    .map(|_| "<send-verification-email>"),
            )
            .field(
                "before_email_verification",
                &self
                    .before_email_verification
                    .as_ref()
                    .map(|_| "<before-email-verification>"),
            )
            .field(
                "after_email_verification",
                &self
                    .after_email_verification
                    .as_ref()
                    .map(|_| "<after-email-verification>"),
            )
            .field("expires_in", &self.expires_in)
            .field(
                "auto_sign_in_after_verification",
                &self.auto_sign_in_after_verification,
            )
            .finish()
    }
}