g1t/services/identity/src/lib.rs

578 lines20,419 bytesCodeBlame
1//! The identity service: accounts, sessions, SSH keys and access tokens.
2//!
3//! Reached only through service bindings; see `g1t_contracts::identity` for
4//! the methods and their arguments.
5
6mod crypto;
7mod device;
8mod email;
9
10use g1t_contracts::identity::*;
11use g1t_contracts::{FailureCode, Outcome, User, Viewer, is_valid_namespace, new_id};
12use g1t_kit::{args, now_ms, reply, rpc_method};
13use serde::Deserialize;
14use worker::wasm_bindgen::JsValue;
15use worker::{Context, D1Database, Env, Request, Response, Result, event};
16
17const SESSION_TTL_SECONDS: u32 = 30 * 24 * 60 * 60;
18const VERIFY_TTL_SECONDS: u32 = 24 * 60 * 60;
19const RESET_TTL_SECONDS: u32 = 60 * 60;
20const TOKEN_PREFIX: &str = "g1t_";
21const MIN_PASSWORD_LENGTH: usize = 10;
22const PASSWORD_TOO_SHORT: &str = "Use a password of at least 10 characters.";
23
24/// A user as selected from the database; `verified` arrives as 0 or 1.
25#[derive(Deserialize)]
26struct Account {
27 id: String,
28 username: String,
29 verified: u8,
30}
31
32impl From<Account> for User {
33 fn from(row: Account) -> Self {
34 User {
35 id: row.id,
36 username: row.username,
37 verified: row.verified != 0,
38 }
39 }
40}
41
42#[derive(Deserialize)]
43struct UserRow {
44 id: String,
45 username: String,
46 password_hash: String,
47 verified: u8,
48}
49
50/// The owner of an emailed token.
51#[derive(Deserialize)]
52struct TokenOwner {
53 id: String,
54 username: String,
55 email: Option<String>,
56}
57
58#[derive(Deserialize)]
59struct KeyRow {
60 id: String,
61 title: String,
62 fingerprint: String,
63 created_at: u64,
64}
65
66impl From<KeyRow> for SshKey {
67 fn from(row: KeyRow) -> Self {
68 SshKey {
69 id: row.id,
70 title: row.title,
71 fingerprint: row.fingerprint,
72 created_at: row.created_at * 1000,
73 }
74 }
75}
76
77#[derive(Deserialize)]
78struct TokenRow {
79 id: String,
80 name: String,
81 created_at: u64,
82}
83
84impl From<TokenRow> for AccessToken {
85 fn from(row: TokenRow) -> Self {
86 AccessToken {
87 id: row.id,
88 name: row.name,
89 created_at: row.created_at * 1000,
90 }
91 }
92}
93
94struct Identity {
95 db: D1Database,
96 env: Env,
97}
98
99impl Identity {
100 /// Runs a query that returns at most one user.
101 async fn find_user(&self, sql: &str, param: &str) -> Result<Viewer> {
102 Ok(self
103 .db
104 .prepare(sql)
105 .bind(&[JsValue::from(param)])?
106 .first::<Account>(None)
107 .await?
108 .map(User::from))
109 }
110
111 /// Stores a one-time token of `kind` for the user and returns it.
112 async fn issue_email_token(&self, user_id: &str, kind: &str, ttl: u32) -> Result<String> {
113 let token = crypto::random_hex(32);
114 self.db
115 .prepare(
116 "INSERT INTO email_tokens (id, user_id, kind, expires_at)
117 VALUES (?, ?, ?, unixepoch() + ?)",
118 )
119 .bind(&[
120 crypto::sha256_hex(&token).into(),
121 user_id.into(),
122 kind.into(),
123 ttl.into(),
124 ])?
125 .run()
126 .await?;
127 Ok(token)
128 }
129
130 /// Consumes a token of `kind`, returning its owner if it was valid.
131 async fn redeem_email_token(&self, token: &str, kind: &str) -> Result<Option<TokenOwner>> {
132 let id = crypto::sha256_hex(token);
133 let owner = self
134 .db
135 .prepare(
136 "SELECT users.id, users.username, users.email FROM email_tokens
137 JOIN users ON users.id = email_tokens.user_id
138 WHERE email_tokens.id = ? AND email_tokens.kind = ?
139 AND email_tokens.expires_at > unixepoch()",
140 )
141 .bind(&[id.as_str().into(), kind.into()])?
142 .first::<TokenOwner>(None)
143 .await?;
144 if let Some(owner) = &owner {
145 // Every outstanding token of this kind dies with the one used.
146 self.db
147 .prepare("DELETE FROM email_tokens WHERE user_id = ? AND kind = ?")
148 .bind(&[owner.id.as_str().into(), kind.into()])?
149 .run()
150 .await?;
151 }
152 Ok(owner)
153 }
154
155 async fn send_verification(&self, user: &User, email: &str) -> Result<()> {
156 let token = self
157 .issue_email_token(&user.id, "verify", VERIFY_TTL_SECONDS)
158 .await?;
159 email::send_verification(&self.env, email, &user.username, &token).await
160 }
161
162 async fn resend_verification(&self, a: UserArgs) -> Result<Outcome<bool>> {
163 let row = self
164 .db
165 .prepare(
166 "SELECT id, username, email FROM users WHERE id = ? AND email_verified_at IS NULL",
167 )
168 .bind(&[a.user.id.as_str().into()])?
169 .first::<TokenOwner>(None)
170 .await?;
171 let Some(TokenOwner {
172 email: Some(email), ..
173 }) = row
174 else {
175 return Ok(Outcome::fail(
176 FailureCode::Conflict,
177 "This account's email is already confirmed.",
178 ));
179 };
180 self.send_verification(&a.user, &email).await?;
181 Ok(Outcome::Ok(true))
182 }
183
184 async fn verify_email(&self, a: EmailTokenArgs) -> Result<Outcome<User>> {
185 let Some(owner) = self.redeem_email_token(&a.token, "verify").await? else {
186 return Ok(Outcome::fail(
187 FailureCode::Invalid,
188 "This confirmation link is not valid or has expired.",
189 ));
190 };
191 self.db
192 .prepare("UPDATE users SET email_verified_at = unixepoch() WHERE id = ?")
193 .bind(&[owner.id.as_str().into()])?
194 .run()
195 .await?;
196 Ok(Outcome::Ok(User {
197 id: owner.id,
198 username: owner.username,
199 verified: true,
200 }))
201 }
202
203 async fn request_password_reset(&self, a: EmailArgs) -> Result<bool> {
204 let row = self
205 .db
206 .prepare("SELECT id, username, email FROM users WHERE email = ?")
207 .bind(&[a.email.trim().to_lowercase().into()])?
208 .first::<TokenOwner>(None)
209 .await?;
210 if let Some(TokenOwner {
211 id,
212 username,
213 email: Some(email),
214 }) = row
215 {
216 let token = self
217 .issue_email_token(&id, "reset", RESET_TTL_SECONDS)
218 .await?;
219 email::send_password_reset(&self.env, &email, &username, &token).await?;
220 }
221 // The same answer either way, so addresses cannot be probed.
222 Ok(true)
223 }
224
225 async fn reset_password(&self, a: ResetPasswordArgs) -> Result<Outcome<User>> {
226 if a.password.chars().count() < MIN_PASSWORD_LENGTH {
227 return Ok(Outcome::fail(FailureCode::Invalid, PASSWORD_TOO_SHORT));
228 }
229 let Some(owner) = self.redeem_email_token(&a.token, "reset").await? else {
230 return Ok(Outcome::fail(
231 FailureCode::Invalid,
232 "This reset link is not valid or has expired.",
233 ));
234 };
235 // Following an emailed link also proves the address.
236 self.db
237 .prepare(
238 "UPDATE users SET password_hash = ?,
239 email_verified_at = COALESCE(email_verified_at, unixepoch())
240 WHERE id = ?",
241 )
242 .bind(&[
243 crypto::hash_password(&a.password).into(),
244 owner.id.as_str().into(),
245 ])?
246 .run()
247 .await?;
248 // Anyone signed in with the old password is signed out.
249 self.db
250 .prepare("DELETE FROM sessions WHERE user_id = ?")
251 .bind(&[owner.id.as_str().into()])?
252 .run()
253 .await?;
254 Ok(Outcome::Ok(User {
255 id: owner.id,
256 username: owner.username,
257 verified: true,
258 }))
259 }
260
261 async fn user_for_password(&self, username: &str, password: &str) -> Result<Viewer> {
262 let row = self
263 .db
264 .prepare("SELECT id, username, password_hash, email_verified_at IS NOT NULL AS verified FROM users WHERE username = ?")
265 .bind(&[JsValue::from(username.to_lowercase())])?
266 .first::<UserRow>(None)
267 .await?;
268 Ok(row
269 .filter(|row| crypto::verify_password(password, &row.password_hash))
270 .map(|row| User {
271 id: row.id,
272 username: row.username,
273 verified: row.verified != 0,
274 }))
275 }
276
277 async fn register(&self, a: RegisterArgs) -> Result<Outcome<SignedIn>> {
278 let username = a.username.trim().to_lowercase();
279 let email = a.email.trim().to_lowercase();
280 let invalid = |message: &str| Ok(Outcome::fail(FailureCode::Invalid, message));
281 if !is_valid_namespace(&username) {
282 return invalid(
283 "Usernames use lowercase letters, digits and single hyphens, up to 39 characters.",
284 );
285 }
286 let well_formed_email = email
287 .split_once('@')
288 .is_some_and(|(local, domain)| !local.is_empty() && domain.contains('.'))
289 && !email.contains(char::is_whitespace);
290 if !well_formed_email {
291 return invalid("Enter a valid email address.");
292 }
293 if a.password.chars().count() < MIN_PASSWORD_LENGTH {
294 return invalid(PASSWORD_TOO_SHORT);
295 }
296 let taken = self
297 .db
298 .prepare("SELECT username FROM users WHERE username = ? OR email = ?")
299 .bind(&[username.as_str().into(), email.as_str().into()])?
300 .first::<serde_json::Value>(None)
301 .await?;
302 if taken.is_some() {
303 return Ok(Outcome::fail(
304 FailureCode::Conflict,
305 "That username or email is already registered.",
306 ));
307 }
308 let user = User {
309 id: new_id("usr", now_ms()),
310 username,
311 verified: false,
312 };
313 self.db
314 .prepare("INSERT INTO users (id, username, email, password_hash) VALUES (?, ?, ?, ?)")
315 .bind(&[
316 user.id.as_str().into(),
317 user.username.as_str().into(),
318 email.as_str().into(),
319 crypto::hash_password(&a.password).into(),
320 ])?
321 .run()
322 .await?;
323 // The account exists either way; the email can be sent again later.
324 if let Err(error) = self.send_verification(&user, &email).await {
325 worker::console_error!("verification email failed: {error}");
326 }
327 self.start_session(user).await
328 }
329
330 async fn sign_in(&self, a: SignInArgs) -> Result<Outcome<SignedIn>> {
331 let Some(user) = self.user_for_password(&a.username, &a.password).await? else {
332 return Ok(Outcome::fail(
333 FailureCode::Unauthenticated,
334 "Incorrect username or password.",
335 ));
336 };
337 self.start_session(user).await
338 }
339
340 async fn start_session(&self, user: User) -> Result<Outcome<SignedIn>> {
341 let session_token = crypto::random_hex(32);
342 self.db
343 .prepare(
344 "INSERT INTO sessions (id, user_id, expires_at) VALUES (?, ?, unixepoch() + ?)",
345 )
346 .bind(&[
347 crypto::sha256_hex(&session_token).into(),
348 user.id.as_str().into(),
349 SESSION_TTL_SECONDS.into(),
350 ])?
351 .run()
352 .await?;
353 Ok(Outcome::Ok(SignedIn {
354 user,
355 session_token,
356 }))
357 }
358
359 async fn sign_out(&self, a: SessionArgs) -> Result<()> {
360 self.db
361 .prepare("DELETE FROM sessions WHERE id = ?")
362 .bind(&[crypto::sha256_hex(&a.session_token).into()])?
363 .run()
364 .await?;
365 Ok(())
366 }
367
368 async fn user_for_session(&self, a: SessionArgs) -> Result<Viewer> {
369 self.find_user(
370 "SELECT users.id, users.username, users.email_verified_at IS NOT NULL AS verified FROM sessions
371 JOIN users ON users.id = sessions.user_id
372 WHERE sessions.id = ? AND sessions.expires_at > unixepoch()",
373 &crypto::sha256_hex(&a.session_token),
374 )
375 .await
376 }
377
378 async fn user_for_access_token(&self, token: &str) -> Result<Viewer> {
379 if !token.starts_with(TOKEN_PREFIX) {
380 return Ok(None);
381 }
382 self.find_user(
383 "SELECT users.id, users.username, users.email_verified_at IS NOT NULL AS verified FROM access_tokens
384 JOIN users ON users.id = access_tokens.user_id
385 WHERE token_hash = ?
386 AND (access_tokens.expires_at IS NULL OR access_tokens.expires_at > unixepoch())",
387 &crypto::sha256_hex(token),
388 )
389 .await
390 }
391
392 async fn user_for_git_credentials(&self, a: GitCredentialsArgs) -> Result<Viewer> {
393 // Like GitHub, a token alone identifies its user.
394 if a.secret.starts_with(TOKEN_PREFIX) {
395 self.user_for_access_token(&a.secret).await
396 } else {
397 self.user_for_password(&a.username, &a.secret).await
398 }
399 }
400
401 async fn user_for_ssh_key(&self, a: FingerprintArgs) -> Result<Viewer> {
402 self.find_user(
403 "SELECT users.id, users.username, users.email_verified_at IS NOT NULL AS verified FROM ssh_keys
404 JOIN users ON users.id = ssh_keys.user_id
405 WHERE fingerprint = ?",
406 &a.fingerprint,
407 )
408 .await
409 }
410
411 async fn user_by_username(&self, a: UsernameArgs) -> Result<Viewer> {
412 self.find_user(
413 "SELECT id, username, email_verified_at IS NOT NULL AS verified FROM users WHERE username = ?",
414 &a.username.to_lowercase(),
415 )
416 .await
417 }
418
419 async fn list_ssh_keys(&self, a: UserArgs) -> Result<Vec<SshKey>> {
420 let rows = self
421 .db
422 .prepare("SELECT id, title, fingerprint, created_at FROM ssh_keys WHERE user_id = ? ORDER BY id")
423 .bind(&[a.user.id.into()])?
424 .all()
425 .await?
426 .results::<KeyRow>()?;
427 Ok(rows.into_iter().map(SshKey::from).collect())
428 }
429
430 async fn add_ssh_key(&self, a: AddSshKeyArgs) -> Result<Outcome<SshKey>> {
431 let Some(key) = crypto::parse_ssh_key(&a.public_key) else {
432 return Ok(Outcome::fail(
433 FailureCode::Invalid,
434 "That is not a valid OpenSSH public key.",
435 ));
436 };
437 let taken = self
438 .db
439 .prepare("SELECT id FROM ssh_keys WHERE fingerprint = ?")
440 .bind(&[key.fingerprint.as_str().into()])?
441 .first::<serde_json::Value>(None)
442 .await?;
443 if taken.is_some() {
444 return Ok(Outcome::fail(
445 FailureCode::Conflict,
446 "That key is already registered.",
447 ));
448 }
449 let now = now_ms();
450 let title = [a.title.trim(), key.comment.as_str(), "SSH key"]
451 .into_iter()
452 .find(|candidate| !candidate.is_empty())
453 .unwrap_or_default()
454 .to_owned();
455 let row = KeyRow {
456 id: new_id("key", now),
457 title,
458 fingerprint: key.fingerprint,
459 created_at: now / 1000,
460 };
461 self.db
462 .prepare(
463 "INSERT INTO ssh_keys (id, user_id, title, public_key, fingerprint, created_at)
464 VALUES (?, ?, ?, ?, ?, ?)",
465 )
466 .bind(&[
467 row.id.as_str().into(),
468 a.user.id.into(),
469 row.title.as_str().into(),
470 key.public_key.into(),
471 row.fingerprint.as_str().into(),
472 (row.created_at as f64).into(),
473 ])?
474 .run()
475 .await?;
476 Ok(Outcome::Ok(row.into()))
477 }
478
479 async fn list_access_tokens(&self, a: UserArgs) -> Result<Vec<AccessToken>> {
480 let rows = self
481 .db
482 // Expiring tokens belong to hosted attempts, not to the user's list.
483 .prepare(
484 "SELECT id, name, created_at FROM access_tokens
485 WHERE user_id = ? AND expires_at IS NULL ORDER BY id",
486 )
487 .bind(&[a.user.id.into()])?
488 .all()
489 .await?
490 .results::<TokenRow>()?;
491 Ok(rows.into_iter().map(AccessToken::from).collect())
492 }
493
494 async fn create_access_token(&self, a: CreateAccessTokenArgs) -> Result<CreatedAccessToken> {
495 let token = format!("{TOKEN_PREFIX}{}", crypto::random_hex(20));
496 let now = now_ms();
497 let name = match a.name.trim() {
498 "" => "Access token",
499 name => name,
500 };
501 let row = TokenRow {
502 id: new_id("tok", now),
503 name: name.to_owned(),
504 created_at: now / 1000,
505 };
506 self.db
507 .prepare(
508 "INSERT INTO access_tokens (id, user_id, name, token_hash, created_at, expires_at)
509 VALUES (?, ?, ?, ?, ?, ?)",
510 )
511 .bind(&[
512 row.id.as_str().into(),
513 a.user.id.into(),
514 row.name.as_str().into(),
515 crypto::sha256_hex(&token).into(),
516 (row.created_at as f64).into(),
517 a.ttl_seconds
518 .map_or(JsValue::NULL, |ttl| ((row.created_at + ttl) as f64).into()),
519 ])?
520 .run()
521 .await?;
522 Ok(CreatedAccessToken {
523 token,
524 info: row.into(),
525 })
526 }
527
528 /// Deletes a row the user owns from `table`.
529 async fn remove(&self, table: &str, a: RemoveArgs) -> Result<()> {
530 self.db
531 .prepare(format!("DELETE FROM {table} WHERE id = ? AND user_id = ?"))
532 .bind(&[a.id.into(), a.user.id.into()])?
533 .run()
534 .await?;
535 Ok(())
536 }
537}
538
539#[event(fetch)]
540async fn fetch(mut request: Request, env: Env, _ctx: Context) -> Result<Response> {
541 let Some(method) = rpc_method(&request) else {
542 return Response::error("Not found", 404);
543 };
544 let body: serde_json::Value = request.json().await?;
545 let identity = Identity {
546 db: env.d1("DB")?,
547 env,
548 };
549
550 match method.as_str() {
551 "register" => reply(&identity.register(args(body)?).await?),
552 "sign_in" => reply(&identity.sign_in(args(body)?).await?),
553 "device_start" => reply(&identity.device_start(args(body)?).await?),
554 "device_lookup" => reply(&identity.device_lookup(args(body)?).await?),
555 "device_resolve" => reply(&identity.device_resolve(args(body)?).await?),
556 "device_claim" => reply(&identity.device_claim(args(body)?).await?),
557 "resend_verification" => reply(&identity.resend_verification(args(body)?).await?),
558 "verify_email" => reply(&identity.verify_email(args(body)?).await?),
559 "request_password_reset" => reply(&identity.request_password_reset(args(body)?).await?),
560 "reset_password" => reply(&identity.reset_password(args(body)?).await?),
561 "sign_out" => reply(&identity.sign_out(args(body)?).await?),
562 "user_for_session" => reply(&identity.user_for_session(args(body)?).await?),
563 "user_for_git_credentials" => reply(&identity.user_for_git_credentials(args(body)?).await?),
564 "user_for_access_token" => {
565 let a: TokenArgs = args(body)?;
566 reply(&identity.user_for_access_token(&a.token).await?)
567 }
568 "user_for_ssh_key" => reply(&identity.user_for_ssh_key(args(body)?).await?),
569 "user_by_username" => reply(&identity.user_by_username(args(body)?).await?),
570 "list_ssh_keys" => reply(&identity.list_ssh_keys(args(body)?).await?),
571 "add_ssh_key" => reply(&identity.add_ssh_key(args(body)?).await?),
572 "remove_ssh_key" => reply(&identity.remove("ssh_keys", args(body)?).await?),
573 "list_access_tokens" => reply(&identity.list_access_tokens(args(body)?).await?),
574 "create_access_token" => reply(&identity.create_access_token(args(body)?).await?),
575 "remove_access_token" => reply(&identity.remove("access_tokens", args(body)?).await?),
576 _ => Response::error("Unknown method", 404),
577 }
578}