Skip to content

Fix/oauth2 jwt scope parking #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
juicycleff wants to merge 5 commits into from
Closed

Fix/oauth2 jwt scope parking #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
391a4fc
fix: park third-party OAuth2 JWTs until a scoped route admits them
juicycleff Oct 13, 2026
2315d74
docs: rewrite the README and add a banner
juicycleff Oct 14, 2026
51f3280
docs: make the docs match the code
juicycleff Oct 14, 2026
a2f4086
docs: point the UI card at the UI overview
juicycleff Oct 14, 2026
1b8de6f
docs: quote frontmatter descriptions that contain a colon
juicycleff Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
483 changes: 259 additions & 224 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions assets/readme-banner.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 18 additions & 18 deletions docs/content/docs/api-reference/go-packages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,27 @@ Root package. Exports the engine constructor, configuration types, and functiona

| Export | Description |
|--------|-------------|
| `New(...Option) (*Engine, error)` | Create an Authsome engine |
| `Config` | Engine configuration struct |
| `PasswordConfig` | Password policy configuration |
| `SessionConfig` | Session behavior configuration |
| `MFAConfig` | Multi-factor authentication configuration |
| `PhoneConfig` | Phone authentication configuration |
| `OAuth2Config` | OAuth2 provider configuration |
| `JWTConfig` | JWT signing configuration |
| `RateLimitConfig` | Rate limiting configuration |
| `NewEngine(...Option) (*Engine, error)` | Create an Authsome engine (needs `WithStore`, `WithChronicle` and `WithWarden`) |
| `Config`, `DefaultConfig()` | Engine configuration and its defaults |
| `PasswordConfig`, `SessionConfig`, `RateLimitConfig`, `LockoutConfig` | Sections of `Config` |
| `RetentionConfig`, `WebhookConfig`, `CSRFConfig`, `TokenEncryptionConfig` | More sections of `Config` |
| `WithStore(store.Store)` | Set the primary data store |
| `WithPlugin(Plugin)` | Register an authentication plugin |
| `WithChronicle(bridge.Chronicle)`, `WithWarden(*warden.Engine)` | The two required bridges |
| `WithDriverName(string)`, `WithDB(*grove.DB)` | Plugin migrations and plugin storage |
| `WithPlugin(Plugin)` | Register a plugin |
| `WithConfig(Config)` | Set engine configuration |
| `WithMFAStore(mfa.Store)` | Set the MFA enrollment store |
| `WithBootstrap(...BootstrapOption)` | Create the platform app, environments and roles on start |
| `WithTokenEncryptor(bridge.Encryptor)` | Encrypt stored tokens with your own encryptor |
| `WithSMSSender(bridge.SMSSender)` | Set the SMS bridge |
| `WithMailer(bridge.Mailer)` | Set the email bridge |
| `WithPasswordHistory(store)` | Set the password history store |
| `WithRateLimiter(ratelimit.Limiter)` | Set the rate limiter |
| `WithLockout(lockout.Lockout)` | Set the account lockout handler |
| `WithLockoutTracker(lockout.Tracker)` | Set the account lockout tracker |
| `WithLogger(logger)` | Set the logger |

### `github.com/xraph/authsome/engine`
### `*authsome.Engine` methods

The central engine with all authentication and management operations.
`Engine` lives in the root package; there's no separate `engine` package. Some of its methods:

| Export | Description |
|--------|-------------|
Expand All @@ -44,7 +42,7 @@ The central engine with all authentication and management operations.
| `Engine.SignUp(ctx, req)` | Create user account and session |
| `Engine.SignIn(ctx, req)` | Authenticate user |
| `Engine.SignOut(ctx, sessionID)` | Revoke a session |
| `Engine.Refresh(ctx, refreshToken)` | Refresh session tokens |
| `Engine.Refresh(ctx, refreshToken, ...RefreshOpts)` | Refresh session tokens |
| `Engine.GetMe(ctx, userID)` | Get user profile |
| `Engine.UpdateMe(ctx, user)` | Update user profile |
| `Engine.DeleteAccount(ctx, userID)` | Delete user account (GDPR) |
Expand All @@ -53,11 +51,13 @@ The central engine with all authentication and management operations.
| `Engine.ResetPassword(ctx, token, newPassword)` | Complete password reset |
| `Engine.ChangePassword(ctx, userID, current, new)` | Change password |
| `Engine.VerifyEmail(ctx, token)` | Verify email address |
| `Engine.Impersonate(ctx, adminID, targetID, appID)` | Create impersonation session |
| `Engine.Impersonate(ctx, adminID, targetID, ...ImpersonateOption)` | Create an impersonation session |
| `Engine.ListSessions(ctx, userID)` | List user sessions |
| `Engine.RevokeSession(ctx, sessionID)` | Revoke a specific session |
| `Engine.RevokeAllSessions(ctx, userID)` | Revoke all user sessions |
| `Engine.ValidateToken(ctx, token)` | Validate a session token |
| `Engine.RevokeOtherUserSessions(ctx, userID, keep)` | Revoke a user's other sessions |
| `Engine.RevokeUserAccess(ctx, userID)` | Revoke all of a user's access |
| `Engine.ResolveSessionByToken(ctx, token)` | Look up the session behind a token |
| `Engine.ValidateJWT(token)` | Validate a JWT access token |
| `Engine.ListUserDevices(ctx, userID)` | List tracked devices |
| `Engine.GetDevice(ctx, deviceID)` | Get device by ID |
| `Engine.DeleteDevice(ctx, deviceID)` | Remove a device |
Expand Down
Loading
Loading