diff --git a/.gitignore b/.gitignore index ad70a98..25aac02 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,6 @@ dist/ .* !.gitignore *.lock -passkey-auth.sqlite -/passkey/frontend-build -/test_*.py -passkey/_version.py +paskia.sqlite +/paskia/frontend-build +/paskia/_version.py diff --git a/API.md b/API.md index bec5b2c..46191bf 100644 --- a/API.md +++ b/API.md @@ -1,6 +1,6 @@ -# PassKey Auth API Documentation +# Paskia API Documentation -This document lists the HTTP and WebSocket endpoints exposed by the PassKey Auth +This document lists the HTTP and WebSocket endpoints exposed by the Paskia service and how they behave depending on whether a dedicated authentication host (`--auth-host` / environment `PASSKEY_AUTH_HOST`) is configured. diff --git a/README.md b/README.md index 212f469..4f7f00c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PasskeyAuth +# Paskia A minimal FastAPI WebAuthn server with WebSocket support for passkey registration. This project demonstrates WebAuthn registration flow with Resident Keys (discoverable credentials) using modern Python tooling. @@ -31,24 +31,23 @@ uv pip install -e .[dev] ### Run (new CLI) -`passkey-auth` now provides subcommands: +`paskia` now provides subcommands: ```text -passkey-auth serve [host:port] [--options] -passkey-auth dev [--options] +paskia serve [host:port] [--options] ``` Examples (fish shell shown): ```fish # Production style (no reload) -passkey-auth serve -passkey-auth serve 0.0.0.0:8080 --rp-id example.com --origin https://example.com +paskia serve +paskia serve 0.0.0.0:8080 --rp-id example.com --origin https://example.com -# Development (auto-reload) -passkey-auth dev # localhost:4401 -passkey-auth dev :5500 # localhost on port 5500 -passkey-auth dev 127.0.0.1 # host only, default port 4401 +# Development (auto-reload via scripts/dev.py) +python scripts/dev.py # localhost:4401 +python scripts/dev.py :5500 # localhost on port 5500 +python scripts/dev.py 127.0.0.1 # host only, default port 4401 ``` Available options (both subcommands): @@ -61,7 +60,7 @@ Available options (both subcommands): ### Legacy Invocation -If you previously used `python -m passkey.fastapi --dev --host ...`, switch to the new form above. The old flags `--host`, `--port`, and `--dev` are replaced by the `[host:port]` positional and the `dev` subcommand. +If you previously used `python -m paskia.fastapi --dev --host ...`, switch to the new form above. The old flags `--host`, `--port`, and `--dev` are replaced by using `scripts/dev.py` for development mode. ## Usage (Web) @@ -90,8 +89,8 @@ hatch run ruff format . ### Project Structure ``` -passkeyauth/ -├── passkeyauth/ +paskia/ +├── paskia/ │ ├── __init__.py │ └── main.py # FastAPI server with WebSocket support ├── static/ diff --git a/e2e/README.md b/e2e/README.md index eb74fae..202ef79 100644 --- a/e2e/README.md +++ b/e2e/README.md @@ -1,6 +1,6 @@ -# PasskeyAuth E2E Tests +# Paskia E2E Tests -End-to-end tests for PasskeyAuth using [Playwright](https://playwright.dev/) with Chrome's **Virtual Authenticator**. +End-to-end tests for Paskia using [Playwright](https://playwright.dev/) with Chrome's **Virtual Authenticator**. ## Overview @@ -33,7 +33,7 @@ npm test ``` This will: -1. Start a fresh PasskeyAuth server with a test database +1. Start a fresh Paskia server with a test database 2. Run all E2E tests against it 3. Clean up the server when done diff --git a/e2e/package.json b/e2e/package.json index 0b8ea5b..6f2f38f 100644 --- a/e2e/package.json +++ b/e2e/package.json @@ -1,8 +1,8 @@ { - "name": "passkey-auth-e2e", + "name": "paskia-e2e", "version": "1.0.0", "private": true, - "description": "E2E tests for PasskeyAuth using Playwright with Virtual Authenticator", + "description": "E2E tests for Paskia using Playwright with Virtual Authenticator", "type": "module", "scripts": { "test": "bunx playwright test", diff --git a/e2e/playwright.config.ts b/e2e/playwright.config.ts index f38b28c..11f5540 100644 --- a/e2e/playwright.config.ts +++ b/e2e/playwright.config.ts @@ -1,7 +1,7 @@ import { defineConfig, devices } from '@playwright/test' /** - * Playwright configuration for PasskeyAuth E2E tests. + * Playwright configuration for Paskia E2E tests. * Uses Chrome's Virtual Authenticator for automated passkey testing. * * Run with: bun run test @@ -23,7 +23,7 @@ export default defineConfig({ globalTeardown: './tests/global-teardown.ts', use: { - // Base URL for the passkey-auth server + // Base URL for the Paskia server baseURL: process.env.BASE_URL || 'http://localhost:4401', // Collect trace on failure for debugging diff --git a/e2e/tests/global-setup.ts b/e2e/tests/global-setup.ts index f02b73f..0455e41 100644 --- a/e2e/tests/global-setup.ts +++ b/e2e/tests/global-setup.ts @@ -45,7 +45,7 @@ export default async function globalSetup() { // Start the server using Node's spawn const serverProcess = spawn('uv', [ - 'run', 'passkey-auth', 'serve', ':4401', + 'run', 'paskia', 'serve', ':4401', '--rp-id', 'localhost', '--origin', 'http://localhost:4401' ], { diff --git a/e2e/tests/passkey.spec.ts b/e2e/tests/passkey.spec.ts index 2f90058..518cdd1 100644 --- a/e2e/tests/passkey.spec.ts +++ b/e2e/tests/passkey.spec.ts @@ -10,7 +10,7 @@ import { } from './fixtures/passkey-helpers' /** - * E2E tests for PasskeyAuth using Chrome's Virtual Authenticator. + * E2E tests for Paskia using Chrome's Virtual Authenticator. * * These tests exercise the complete WebAuthn flow: * 1. Registration via WebSocket using bootstrap reset token diff --git a/examples/index.html b/examples/index.html index cfe8b65..42862eb 100644 --- a/examples/index.html +++ b/examples/index.html @@ -3,7 +3,7 @@ - PassKey Auth - Dev Mode + Paskia - Dev Mode