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
/*!
# Supabase Auth
[](https://crates.io/crates/supabase-auth)
[](https://crates.io/crates/supabase-auth)
[](https://github.com/proziam/supabase-auth-rs)
[](https://docs.rs/supabase-auth/latest/supabase_auth/index.html)
A Rust implementation of the [supabase js auth client](https://github.com/supabase/gotrue-js).
The goal is to have feature parity and an easy-to-use API.
Currently this software is functional, but not yet battle-tested. The goal is to go to 1.0.0
by the end of December, 2024.
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
supabase-auth = "0.1.0"
```
Or use cargo-add:
```bash
cargo add supabase-auth
```
## Usage
### Create an Auth Client
```rust
// You can manually pass in the values
let auth_client = AuthClient::new(project_url, api_key, jwt_secret).unwrap();
// Or you can use environment variables
// Requires `SUPABASE_URL`, `SUPABASE_API_KEY`, and `SUPABASE_JWT_SECRET` environment variables
let auth_client = AuthClient::new_from_env().unwrap();
```
### Sign Up
```rust
// Sign up methods return the session which you can use for creating cookies
let session = auth_client
.sign_up_with_email_and_password(demo_email, demo_password)
.await
.unwrap();
// You can also sign up using a phone number and password
let session = auth_client
.sign_up_with_phone_and_password(demo_phone, demo_password)
.await
.unwrap();
```
### Sign In
```rust
// Sign in methods return the session which you can use for creating cookies
let session = auth_client
.login_with_email(&demo_email, &demo_password)
.await
.unwrap();
// You can also login using a phone number
let session = auth_client
.login_with_phone(demo_phone, demo_password)
.await
.unwrap();
```
### OAuth
```rust
// Returns the provider and the url where the user will continue the auth flow
let oauth_response = auth_client
.login_with_oauth(Provider::Github, None)
.await
.unwrap();
// You can also customize the options like so:
let mut query_params = HashMap::new();
query_params.insert("key".to_string(), "value".to_string());
query_params.insert("second_key".to_string(), "second_value".to_string());
query_params.insert("third_key".to_string(), "third_value".to_string());
let options = SignInWithOAuthOptions {
query_params: Some(query_params),
redirect_to: Some("your-redirect-url".to_string()),
scopes: Some("repo gist notifications".to_string()),
skip_browser_redirect: Some(true),
};
let response = auth_client
.login_with_oauth(Provider::Github, Some(options))
.await
.unwrap();
```
### SSO
NOTE: Requires an SSO Provider and Supabase Pro plan
```rust
let params = SignInWithSSO {
domain: Some(demo_domain),
options: None,
provider_id: None,
};
// Returns the URL where the user will continue the auth flow with your SSO provider
let url = auth_client.sso(params).await.unwrap();
```
## Features
* ✓ Create Client
* ✓ Sign In with Email & Password
* ✓ Sign In with Phone & Password
* ✓ Sign Up with Email & Password
* ✓ Sign Up with Phone & Password
* ✓ Sign In with Third Party Auth (OAuth)
* ✓ Sign In with Magic Link
* ✓ Send Sign-In OTP (Email, SMS, Whatsapp)
* ✓ Sign In with OTP
* ✓ Refresh Session
* ✓ Resend OTP Tokens (Email & SMS)
* ✓ Retrieve User
* ✓ Reset Password
* ✓ Change User Data (e.g., Email or password)
* ✓ SSO
*/