Skip to content

docs: create README for goauth#1

Merged
veverkap merged 1 commit into
mainfrom
copilot/create-readme-and-documentation
Apr 16, 2026
Merged

docs: create README for goauth#1
veverkap merged 1 commit into
mainfrom
copilot/create-readme-and-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 16, 2026

The repository had an empty README with no documentation. This adds a complete reference covering all three packages.

Changes

  • Quick start — end-to-end wiring example (JWT setup → middleware → handler mounting)
  • auth packageJWTManager, Middleware/AdminMiddleware, RateLimiter (including trusted-proxy config), and crypto utilities (HashHighEntropyToken, GenerateRandomHex, SecretEncrypter)
  • Store interfacesUserStore, APIKeyStore, PasskeyStore with sentinel error contracts (sql.ErrNoRows, auth.ErrEmailExists)
  • handler package — route tables and config structs for AuthHandler, OIDCHandler (PKCE + account-linking flow), APIKeyHandler, and PasskeyHandler (discoverable WebAuthn login)
  • smtp package — environment variable reference and LoadConfig/Validate/Send usage
  • Security notes — secret length minimums, timing-safe login, PKCE, rate limiting placement, cookie flags, trusted proxy CIDR scoping

Agent-Logs-Url: https://github.com/amalgamated-tools/goauth/sessions/cb7ddbfe-f67e-4139-9b6d-671c7ca36b99

Co-authored-by: veverkap <22348+veverkap@users.noreply.github.com>
@veverkap veverkap marked this pull request as ready for review April 16, 2026 18:06
@veverkap veverkap merged commit cd34e17 into main Apr 16, 2026
2 checks passed
@veverkap veverkap deleted the copilot/create-readme-and-documentation branch April 19, 2026 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants