diff --git a/dashboard/src/atproto.rs b/dashboard/src/atproto.rs
index c3cb49038c9e471d1337d48e2c6ffca44f8ec16f..de5708f4d9c6e5094e2a5032a1698967f2183896 100644
--- a/dashboard/src/atproto.rs
+++ b/dashboard/src/atproto.rs
@@ -403,7 +403,8 @@ async fn post(
Err(reject())
}
-pub async fn start(auth: &auth::Store, identifier: &str, next: &str) -> Result<(String, String)> {
+/// The DID, PDS, and bidirectionally verified handle for a handle or DID.
+pub async fn resolve(identifier: &str) -> Result<(String, Url, Option)> {
let identifier = identifier.trim().trim_start_matches('@');
let did = if identifier.starts_with("did:") {
did_url(identifier)?;
@@ -417,6 +418,11 @@ pub async fn start(auth: &auth::Store, identifier: &str, next: &str) -> Result<(
{
return Err(reject());
}
+ Ok((did, pds, handle))
+}
+
+pub async fn start(auth: &auth::Store, identifier: &str, next: &str) -> Result<(String, String)> {
+ let (did, pds, _) = resolve(identifier).await?;
let server = server(&pds).await?;
let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?;
let key = EcKey::generate(&group)?;
diff --git a/dashboard/src/guest.rs b/dashboard/src/guest.rs
index 1a2ad837201615e5659007260aa04f1a4f50dead..561d484cfb6aeea573f61b0f6f70391ddde343dc 100644
--- a/dashboard/src/guest.rs
+++ b/dashboard/src/guest.rs
@@ -309,7 +309,7 @@ async fn exchange(
code: &str,
callback: &str,
flow: &Value,
-) -> Result<(String, String, Option)> {
+) -> Result<(String, String, Option, Option)> {
let form = [
("client_id", client),
("client_secret", secret),
@@ -366,7 +366,7 @@ async fn exchange(
"GitHub couldn't verify your account. Return to Shale and try again.",
)
})?;
- return Ok((id.to_string(), login.to_owned(), None));
+ return Ok((id.to_string(), login.to_owned(), None, None));
}
let mut form = form.to_vec();
form.push(("state", "none"));
@@ -451,7 +451,42 @@ async fn exchange(
&& url.password().is_none()
})
.map(String::from);
- Ok((string(&profile["sub"]).to_owned(), name, picture))
+ Ok((
+ string(&profile["sub"]).to_owned(),
+ name,
+ picture,
+ profile["preferred_username"]
+ .as_str()
+ .map(str::to_lowercase),
+ ))
+}
+
+fn username(provider: &str, subject: &str) -> String {
+ let suffix = if provider == "github" {
+ subject.to_owned()
+ } else {
+ mcp::hash(subject)[..24].to_owned()
+ };
+ format!("guest-{provider}-{suffix}")
+}
+
+fn create(
+ db: &Connection,
+ provider: &str,
+ username: &str,
+ name: &str,
+ picture: Option<&str>,
+) -> Result {
+ let id = uuid::Uuid::new_v4().to_string();
+ let mut profile = json!({"kind":"guest","guestProvider":provider,"username":username,"enabled":true,"email":null,"emailVerified":false,"firstName":name,"lastName":null,"requiredActions":[],"attributes":{},"createdTimestamp":(now()*1000.0) as i64});
+ if let Some(picture) = picture {
+ profile["attributes"]["picture"] = json!([picture]);
+ }
+ db.execute(
+ "INSERT INTO users(id,profile) VALUES (?,?)",
+ sql![id, profile.to_string()],
+ )?;
+ Ok(id)
}
fn account(
@@ -485,20 +520,7 @@ fn account(
tx.commit()?;
return Ok(id);
}
- let id = uuid::Uuid::new_v4().to_string();
- let suffix = if provider == "github" {
- subject.to_owned()
- } else {
- mcp::hash(subject)[..24].to_owned()
- };
- let mut profile = json!({"kind":"guest","guestProvider":provider,"username":format!("guest-{provider}-{suffix}"),"enabled":true,"email":null,"emailVerified":false,"firstName":name,"lastName":null,"requiredActions":[],"attributes":{},"createdTimestamp":(now()*1000.0) as i64});
- if let Some(picture) = picture {
- profile["attributes"]["picture"] = json!([picture]);
- }
- tx.execute(
- "INSERT INTO users(id,profile) VALUES (?,?)",
- sql![id, profile.to_string()],
- )?;
+ let id = create(&tx, provider, &username(provider, subject), name, picture)?;
tx.execute(
"INSERT INTO external_identities VALUES (?,?,?)",
sql![provider, subject, id],
@@ -507,6 +529,138 @@ fn account(
Ok(id)
}
+/// Astheno's per-client subjects require binding reserved names at verified sign-in.
+fn claim(auth: &auth::Store, subject: &str, username: &str) -> Result<()> {
+ auth.db.lock().unwrap().execute(
+ "INSERT OR IGNORE INTO external_identities SELECT 'astheno',?,id FROM users WHERE username=? AND id NOT IN (SELECT user_id FROM external_identities)",
+ sql![subject, format!("guest-astheno-{username}")],
+ )?;
+ Ok(())
+}
+
+fn grant(auth: &auth::Store, provider: &str, subject: Option<&str>, name: &str) -> Result {
+ let mut db = auth.db.lock().unwrap();
+ let tx = db.transaction()?;
+ let known: Vec = match subject {
+ Some(subject) => vec![subject.to_owned()],
+ None => tx
+ .prepare("SELECT subject FROM external_identities JOIN users ON users.id=user_id WHERE provider=? AND lower(json_extract(profile,'$.firstName'))=?")?
+ .query_map(sql![provider, name], |r| r.get(0))?
+ .collect::>()?,
+ };
+ if known.len() > 1 {
+ return Err(Error::new(
+ 409,
+ "Several accounts have signed in with that name. Open the right one under guests and join it to knife-native.",
+ ));
+ }
+ let username = match known.first() {
+ Some(subject) => username(provider, subject),
+ None => format!("guest-{provider}-{name}"),
+ };
+ let existing: Option = tx
+ .query_row("SELECT id FROM users WHERE username=?", [&username], |r| r.get(0))
+ .optional()?;
+ let id = match &existing {
+ Some(id) => id.clone(),
+ None => {
+ let id = create(&tx, provider, &username, name, None)?;
+ if let Some(subject) = subject {
+ tx.execute(
+ "INSERT INTO external_identities VALUES (?,?,?)",
+ sql![provider, subject, id],
+ )?;
+ }
+ id
+ }
+ };
+ tx.execute(
+ "INSERT OR IGNORE INTO memberships SELECT ?,id FROM roles WHERE name='knife-native'",
+ [&id],
+ )?;
+ tx.commit()?;
+ Ok(json!({"id":id,"created":existing.is_none()}))
+}
+
+async fn github_user(http: &reqwest::Client, login: &str) -> Result<(u64, String)> {
+ if login.is_empty()
+ || login.len() > 39
+ || login.starts_with('-')
+ || !login.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'-')
+ {
+ return Err(Error::new(400, "Enter a GitHub username."));
+ }
+ let unavailable = || Error::new(502, "GitHub didn't answer. Try again in a minute.");
+ let response = http
+ .get(format!("https://api.github.com/users/{login}"))
+ .send()
+ .await
+ .map_err(|_| unavailable())?;
+ if response.status() == StatusCode::NOT_FOUND {
+ return Err(Error::new(404, format!("GitHub has no user named {login}.")));
+ }
+ let profile = json_bytes(&response_bytes(response).await.map_err(|_| unavailable())?)
+ .map_err(|_| unavailable())?;
+ match (profile["id"].as_u64(), profile["login"].as_str()) {
+ (Some(id), Some(name)) if id > 0 && name.eq_ignore_ascii_case(login) => {
+ Ok((id, name.to_owned()))
+ }
+ _ => Err(unavailable()),
+ }
+}
+
+pub async fn add(auth: &auth::Store, provider: &str, handle: &str) -> Result {
+ let label = known(provider)?;
+ let registered: bool = auth.db.lock().unwrap().query_row(
+ "SELECT ?1='atproto' OR EXISTS(SELECT 1 FROM guest_providers WHERE id=?1)",
+ [provider],
+ |r| r.get(0),
+ )?;
+ if !registered {
+ return Err(Error::new(
+ 409,
+ format!("{label} sign-in isn't set up. Register it with tools/guest-provider.py {provider}."),
+ ));
+ }
+ let handle = handle.trim().trim_start_matches('@');
+ match provider {
+ "github" => {
+ let (id, login) = github_user(&http()?, handle).await?;
+ grant(auth, provider, Some(&id.to_string()), &login)
+ }
+ "atproto" => {
+ let (did, _, handle) = atproto::resolve(handle).await.map_err(|_| {
+ Error::new(404, "Couldn't find that AT handle. Check the spelling.")
+ })?;
+ let name = handle.unwrap_or_else(|| did.clone());
+ grant(auth, provider, Some(&did), &name)
+ }
+ _ => {
+ let name = handle.to_lowercase();
+ if name.len() > 16
+ || !name.starts_with(|c: char| c.is_ascii_alphanumeric())
+ || !name.bytes().all(|b| b.is_ascii_alphanumeric() || b"._-".contains(&b))
+ {
+ return Err(Error::new(400, "Enter an Astheno username."));
+ }
+ grant(auth, provider, None, &name)
+ }
+ }
+}
+
+fn http() -> Result {
+ Ok(reqwest::Client::builder()
+ .timeout(Duration::from_secs(10))
+ .redirect(reqwest::redirect::Policy::none())
+ .user_agent("Snow Globe guest sign-in")
+ .default_headers({
+ let mut headers = HeaderMap::new();
+ headers.insert("accept", "application/json".parse().unwrap());
+ headers
+ })
+ .build()?)
+}
+
fn fields(query: &str) -> Result> {
let mut map = HashMap::new();
for (k, v) in url::form_urlencoded::parse(query.as_bytes()) {
@@ -709,18 +863,11 @@ async fn handle(app: &App, request: Request) -> Result {
return auth.create_session(&id, "dashboard", headers, None);
}
let (client, secret) = registration(auth, provider)?;
- let http = reqwest::Client::builder()
- .timeout(Duration::from_secs(10))
- .redirect(reqwest::redirect::Policy::none())
- .user_agent("Snow Globe guest sign-in")
- .default_headers({
- let mut headers = HeaderMap::new();
- headers.insert("accept", "application/json".parse().unwrap());
- headers
- })
- .build()?;
- let (subject, name, picture) =
- exchange(&http, provider, &client, &secret, code, &callback, &flow).await?;
+ let (subject, name, picture, handle) =
+ exchange(&http()?, provider, &client, &secret, code, &callback, &flow).await?;
+ if let Some(handle) = handle {
+ claim(auth, &subject, &handle)?;
+ }
let id = account(auth, provider, &subject, &name, picture.as_deref())?;
auth.create_session(&id, "dashboard", headers, None)
}
@@ -1011,4 +1158,82 @@ mod tests {
drop(auth);
std::fs::remove_dir_all(path).unwrap();
}
+
+ fn members(auth: &auth::Store, id: &str) -> Value {
+ auth::user(&auth.db.lock().unwrap(), id).unwrap()["groups"].clone()
+ }
+
+ #[test]
+ fn added_guests_are_the_accounts_their_first_sign_in_finds() {
+ let path = std::env::temp_dir().join(format!("guest-add-test-{}", uuid::Uuid::new_v4()));
+ let auth = auth::Store::new(
+ &path,
+ "https://snowglobe.paperclover.net",
+ "https://file.paperclover.net",
+ "auth.paperclover.net",
+ )
+ .unwrap();
+ for (provider, subject) in [("github", "123"), ("atproto", "did:plc:ewvi7nxzyoun6zhxrhs64oiz")] {
+ let added = grant(&auth, provider, Some(subject), "octo").unwrap();
+ let id = string(&added["id"]);
+ assert_eq!(added["created"], true);
+ assert_eq!(members(&auth, id)[0]["name"], "knife-native");
+ assert_eq!(account(&auth, provider, subject, "renamed", None).unwrap(), id);
+ assert_eq!(grant(&auth, provider, Some(subject), "octo").unwrap()["created"], false);
+ assert_eq!(members(&auth, id).as_array().unwrap().len(), 1);
+ }
+
+ let reserved = string(&grant(&auth, "astheno", None, "alice").unwrap()["id"]).to_owned();
+ let identities = |id: &str| -> i64 {
+ auth.db.lock().unwrap().query_row("SELECT count(*) FROM external_identities WHERE user_id=?", [id], |r| r.get(0)).unwrap()
+ };
+ assert_eq!(identities(&reserved), 0);
+ claim(&auth, "sub-2", "mallory").unwrap();
+ assert_eq!(identities(&reserved), 0);
+ let stranger = account(&auth, "astheno", "sub-2", "mallory", None).unwrap();
+ assert_ne!(stranger, reserved);
+ assert_eq!(members(&auth, &stranger), json!([]));
+ claim(&auth, "sub-1", "alice").unwrap();
+ assert_eq!(account(&auth, "astheno", "sub-1", "alice", None).unwrap(), reserved);
+ assert_eq!(members(&auth, &reserved)[0]["name"], "knife-native");
+ claim(&auth, "sub-3", "alice").unwrap();
+ let impostor = account(&auth, "astheno", "sub-3", "alice", None).unwrap();
+ assert_ne!(impostor, reserved);
+ assert_eq!(members(&auth, &impostor), json!([]));
+
+ let earlier = account(&auth, "astheno", "sub-9", "carol", None).unwrap();
+ let added = grant(&auth, "astheno", None, "carol").unwrap();
+ assert_eq!((string(&added["id"]), &added["created"]), (earlier.as_str(), &json!(false)));
+ assert_eq!(members(&auth, &earlier)[0]["name"], "knife-native");
+ account(&auth, "astheno", "sub-5", "dave", None).unwrap();
+ account(&auth, "astheno", "sub-6", "dave", None).unwrap();
+ assert_eq!(grant(&auth, "astheno", None, "dave").unwrap_err().status, 409);
+ drop(auth);
+ std::fs::remove_dir_all(path).unwrap();
+ }
+
+ #[tokio::test]
+ async fn adding_needs_a_registered_provider_and_a_plausible_name() {
+ let path = std::env::temp_dir().join(format!("guest-add-test-{}", uuid::Uuid::new_v4()));
+ let auth = auth::Store::new(
+ &path,
+ "https://snowglobe.paperclover.net",
+ "https://file.paperclover.net",
+ "auth.paperclover.net",
+ )
+ .unwrap();
+ assert_eq!(add(&auth, "astheno", "alice").await.unwrap_err().status, 409);
+ assert_eq!(add(&auth, "gitlab", "alice").await.unwrap_err().status, 404);
+ provision(&auth, json!({"provider":"astheno","enabled":true,"clientId":"client","clientSecret":"0123456789abcdef"})).unwrap();
+ for name in ["", "has space", "-alice", "a-name-over-sixteen"] {
+ assert_eq!(add(&auth, "astheno", name).await.unwrap_err().status, 400, "{name}");
+ }
+ let added = add(&auth, "astheno", " @Alice ").await.unwrap();
+ assert_eq!(
+ auth::user(&auth.db.lock().unwrap(), string(&added["id"])).unwrap()["username"],
+ "guest-astheno-alice"
+ );
+ drop(auth);
+ std::fs::remove_dir_all(path).unwrap();
+ }
}
diff --git a/dashboard/src/users.rs b/dashboard/src/users.rs
index 86d19c7f121dd3f937d4a2fa9a9f435b28d0a5e2..4a5fb834a67f58a93c5484101547d97aa8fabd05 100644
--- a/dashboard/src/users.rs
+++ b/dashboard/src/users.rs
@@ -200,6 +200,12 @@ pub async fn route(
}
return Ok(StatusCode::NO_CONTENT.into_response());
}
+ if parts == ["guests"] && method == Method::POST {
+ return Ok(axum::Json(
+ guest::add(&app.auth, string(&body["provider"]), string(&body["handle"])).await?,
+ )
+ .into_response());
+ }
if parts.is_empty() && method == Method::GET {
let db = app.auth.db.lock().unwrap();
let mut statement = db.prepare("SELECT id FROM users WHERE coalesce(json_extract(profile,'$.kind'),'')!='ai' ORDER BY username")?;
diff --git a/dashboard/web/api.contract.ts b/dashboard/web/api.contract.ts
index 0eedf850d545391daf2f1a53668d99e9fa8b3282..9fb1fb88e141b0d456c5f3baded7abcdb66e6748 100644
--- a/dashboard/web/api.contract.ts
+++ b/dashboard/web/api.contract.ts
@@ -231,6 +231,9 @@ export type Api = Hono<{}, {
$get: Endpoint<{users:(User & {sessions:Session[]})[]; groups:Group[]}>;
$post: Endpoint<{ id: string; url: string | null }, { json: { profile: { email: string; firstName: string; lastName: string; username: string; }; groups: string[]; setup: { kind: "invite"; } | { kind: "password"; password: string; }; }; }, 201>;
};
+ "/users/guests": {
+ $post: Endpoint<{ id: string; created: boolean }, { json: { provider: "github" | "astheno" | "atproto"; handle: string; }; }>;
+ };
"/users/:id": {
$patch: Endpoint;
$delete: Endpoint;
diff --git a/dashboard/web/pages/Users.css b/dashboard/web/pages/Users.css
index 1be08f4fff1df896edbe64790a9d5826704662bd..8ac0c3fad95b52ab51e6251590d71e9eff196068 100644
--- a/dashboard/web/pages/Users.css
+++ b/dashboard/web/pages/Users.css
@@ -28,6 +28,24 @@
.grant :is(img, .monogram, .icon) { flex: none; width: 15px; height: 15px; font-size: 9px; border-radius: 22%; }
.grant.dash .icon { color: var(--muted); border-radius: 0; }
+.guest-menu {
+ inset: auto;
+ top: anchor(bottom);
+ right: anchor(right);
+ min-width: 190px;
+ margin: 6px 0 0;
+ padding: 4px;
+ border: 1px solid var(--line);
+ border-radius: var(--radius-lg);
+ background: var(--surface);
+ color: var(--text);
+ box-shadow: 0 8px 28px #0005;
+ font-size: 13px;
+}
+.guest-menu:popover-open { animation: menu-in 200ms var(--ease-out); }
+.guest-menu button { display: block; width: 100%; padding: 7px 10px; border: 0; border-radius: var(--radius); background: none; color: inherit; font: inherit; text-align: left; cursor: pointer; }
+.guest-menu button:is(:hover, :focus-visible) { background: var(--hover); }
+
.users-toolbar { display: flex; align-items: center; gap: 8px; margin: 6px 0 8px; }
.users-toolbar .count { margin-left: 6px; opacity: 0.7; font-variant-numeric: tabular-nums; }
diff --git a/dashboard/web/pages/Users.tsx b/dashboard/web/pages/Users.tsx
index 290c67cab986898948353b76e45c5e828a8bc4fd..af1fd3e8581e83bc27f715868e4785a15a52ce76 100644
--- a/dashboard/web/pages/Users.tsx
+++ b/dashboard/web/pages/Users.tsx
@@ -1,5 +1,6 @@
import { A, useNavigate, useParams, useSearchParams } from "@solidjs/router";
import ArrowLeft from "lucide-solid/icons/arrow-left";
+import ChevronDown from "lucide-solid/icons/chevron-down";
import Search from "lucide-solid/icons/search";
import UserPlus from "lucide-solid/icons/user-plus";
import X from "lucide-solid/icons/x";
@@ -27,6 +28,12 @@ import { FolderAccess } from "./Shares.tsx";
const STEPS: [string, string][] = [["SETUP", "finish setup"], ["UPDATE_PASSWORD", "new password"], ["UPDATE_PROFILE", "check profile"]];
+const GUESTS = {
+ github: { name: "GitHub", field: "GitHub username", placeholder: "octocat" },
+ astheno: { name: "Astheno", field: "Astheno username", placeholder: "janedoe" },
+ atproto: { name: "AT Protocol", field: "AT handle", placeholder: "alice.bsky.social" },
+} as const;
+
const STATES = { all: "users", guests: "guests", disabled: "disabled", pending: "setup pending" } as const;
type Params = { q?: string; group?: string; state?: keyof typeof STATES };
@@ -214,6 +221,28 @@ function List(props: { data: Resource; ready: Accessor;
.toSorted((a, b) => a.username.localeCompare(b.username));
};
const selectable = () => shown(ready()?.users ?? []).filter((user) => user.kind !== "guest");
+ let guestMenu!: HTMLDivElement;
+ let guestTrigger!: HTMLButtonElement;
+ const addGuest = (provider: keyof typeof GUESTS) => {
+ const guest = GUESTS[provider];
+ guestMenu.hidePopover();
+ showTextDialog({
+ title: `Add ${guest.name} guest`,
+ description: "They can sign in to Shale and open The Knife’s Native UI.",
+ label: guest.field,
+ placeholder: guest.placeholder,
+ body: provider === "astheno" ? () => Astheno can’t look names up. The first person to sign in with this username gets the access.
: undefined,
+ confirmLabel: "add guest",
+ returnFocus: guestTrigger,
+ onConfirm: async (handle) => {
+ const { id, created } = await parseResponse(api.users.guests.$post({ json: { provider, handle } }));
+ await props.refetch();
+ const user = ready()?.users.find((user) => user.id === id);
+ if (user) open(user);
+ if (!created) toast(`${user?.username ?? "That person"} was already a guest`);
+ },
+ });
+ };
const create = (groups: Group[]) => showConfirmDialog({
title: "New user",
confirmLabel: "create user",
@@ -277,6 +306,14 @@ function List(props: { data: Resource; ready: Accessor;
+
+
@@ -601,7 +638,7 @@ function Profile(props: { user: User; data: Data; refetch: () => unknown }) {
- signs in with {props.user.guestProvider === "github" ? "GitHub" : "Astheno"}
}>
+ signs in with {GUESTS[props.user.guestProvider ?? "github"].name}}>
}>
{(list) => {
diff --git a/dashboard/web/types/users.ts b/dashboard/web/types/users.ts
index 308e25b1dec701e734c4f60d0aa4ec21ec8fb789..dad83b8ecbb7104fcba6ebc81d332557733a1d6b 100644
--- a/dashboard/web/types/users.ts
+++ b/dashboard/web/types/users.ts
@@ -2,7 +2,7 @@ export interface User {
id: string;
username: string;
kind?: "guest";
- guestProvider?: "github" | "astheno";
+ guestProvider?: "github" | "astheno" | "atproto";
email: string | null;
firstName: string | null;
lastName: string | null;
diff --git a/tools/dashboard-oidc-test.py b/tools/dashboard-oidc-test.py
index 6d72ab1b61717a223dd021af83188f987da10478..d6ee6e8f7a24066c9c4b70ef7a9825660dc756ac 100644
--- a/tools/dashboard-oidc-test.py
+++ b/tools/dashboard-oidc-test.py
@@ -185,14 +185,14 @@ def main():
assert request('/auth/status?' + urllib.parse.urlencode({'next': target}))['service'] == 'shale'
forged = target.replace(urllib.parse.quote(callback, safe=''), urllib.parse.quote('https://evil.example/callback', safe=''))
assert request('/auth/status?' + urllib.parse.urlencode({'next': forged}))['service'] == 'snow globe'
- assert request('/auth/status?' + urllib.parse.urlencode({'next': target}))['providers'] == [{'id':'github','name':'GitHub'}]
+ assert request('/auth/status?' + urllib.parse.urlencode({'next': target}))['providers'] == [{'id':'github','name':'GitHub'},{'id':'atproto','name':'AT / tangled / bsky'}]
request('/auth/guest/start/github?' + urllib.parse.urlencode({'next': '/'}), status=400)
started = request('/auth/guest/start/github?' + urllib.parse.urlencode({'next': target}), status=302)
external = urllib.parse.urlparse(started['location']); parameters = urllib.parse.parse_qs(external.query)
assert external.netloc == 'github.com' and parameters['scope'] == ['read:user'] and parameters['code_challenge_method'] == ['S256']
state = parameters['state'][0]
request('/auth/guest/callback/github?state=' + state, session=False, status=403)
- request('/auth/guest/callback/astheno?state=' + state, status=503)
+ request('/auth/guest/callback/astheno?state=' + state, status=403)
declined = request('/auth/guest/callback/github?' + urllib.parse.urlencode({'state':state,'error':'access_denied'}), status=302)['location']
assert 'guest_error=1' in declined
request('/auth/guest/callback/github?state=' + state, status=403)