Patrick Plate
973c82f304
- Parent POM: de.platesoft:plate-auth-parent with ${revision} CI-friendly versioning
- plate-auth-starter module: Spring Boot 4.1.0 starter deps (web, jpa, security, validation, jwt, flyway, envers)
- @platesoft/auth npm package skeleton: tsup bundler, conditional exports, TypeScript strict
- Gitea Actions: ci.yml (on push/PR) + release.yml (on v* tag)
- distributionManagement pointing to Gitea Package Registry (Maven + npm)
- Apache-2.0 LICENSE, README with quickstart, CHANGELOG, .editorconfig, .gitignore
- pnpm workspace with packages/auth
- Maven BUILD SUCCESS verified locally
77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
# plate-auth
|
|
|
|
Reusable authentication + multi-tenancy library for Spring Boot 4 + NextAuth v5.
|
|
|
|
## Two artifacts, one contract
|
|
|
|
| Artifact | Registry | Purpose |
|
|
|----------|----------|---------|
|
|
| `de.platesoft:plate-auth-starter` | Gitea Maven | Spring Boot auto-config: JWT, OAuth, memberships, invitations, access requests |
|
|
| `@platesoft/auth` | Gitea npm | NextAuth v5 config factory, HMAC exchange, proxy helpers, React hooks |
|
|
|
|
The wire contract between them is an **HMAC-SHA256 signed exchange envelope** + **JWT bearer tokens**.
|
|
|
|
## Quick start (5 lines)
|
|
|
|
### Backend (Spring Boot 4)
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>de.platesoft</groupId>
|
|
<artifactId>plate-auth-starter</artifactId>
|
|
<version>0.1.0</version>
|
|
</dependency>
|
|
```
|
|
|
|
```yaml
|
|
plate:
|
|
auth:
|
|
jwt:
|
|
secret: ${PLATE_AUTH_JWT_SECRET} # ≥32 chars
|
|
exchange:
|
|
secret: ${PLATE_AUTH_EXCHANGE_SECRET} # ≥32 chars, shared with frontend
|
|
```
|
|
|
|
### Frontend (Next.js 15 + NextAuth v5)
|
|
|
|
```bash
|
|
pnpm add @platesoft/auth@0.1.0 --registry=https://git.plate-software.de/api/packages/pplate/npm/
|
|
```
|
|
|
|
```ts
|
|
// app/api/auth/[...nextauth]/route.ts
|
|
import NextAuth from 'next-auth';
|
|
import { createAuthConfig } from '@platesoft/auth/config';
|
|
|
|
const config = createAuthConfig({
|
|
providers: { google: { clientId: process.env.GOOGLE_CLIENT_ID!, clientSecret: process.env.GOOGLE_CLIENT_SECRET! } },
|
|
exchange: { backendUrl: process.env.NEXT_PUBLIC_BACKEND_URL!, secret: process.env.NEXTAUTH_EXCHANGE_SECRET! },
|
|
});
|
|
export const { handlers, auth, signIn, signOut } = NextAuth(config);
|
|
export const { GET, POST } = handlers;
|
|
```
|
|
|
|
## SPI Extension Points
|
|
|
|
| Interface | Default | Purpose |
|
|
|-----------|---------|---------|
|
|
| `OrgValidator` | `PermissiveOrgValidator` (WARN per call) | Validate `(org_type, org_id)` exists |
|
|
| `OrgDisplayNameResolver` | Returns `type:id` | Pretty-print org |
|
|
| `InvitationMailer` | Logs accept URL | Send invite emails |
|
|
| `AccessRequestMailer` | Logs notifications | Notify on access requests |
|
|
| `OnboardingHook` | No-op | First sign-in hook |
|
|
|
|
Override any bean with `@ConditionalOnMissingBean` — register your own to replace.
|
|
|
|
## Documentation
|
|
|
|
Full docs live in the [plate-auth wiki](https://git.plate-software.de/pplate/plate-auth/wiki/).
|
|
|
|
- [Architecture](https://git.plate-software.de/pplate/plate-auth/wiki/Architecture)
|
|
- [Integration Guide](https://git.plate-software.de/pplate/plate-auth/wiki/Integration-Guide)
|
|
- [Sprint 0 Plan](https://git.plate-software.de/pplate/plate-auth/wiki/Sprint-0-Plan)
|
|
|
|
## License
|
|
|
|
Apache-2.0 — see [LICENSE](LICENSE).
|