Keli Grubb
e61e6bc7e3
All checks were successful
ci/woodpecker/push/push Pipeline was successful
## Added - CoT (Cursor on Target) server on port 8089 enabling ATAK/iTAK device connectivity - Support for TAK stream protocol and traditional XML CoT messages - TLS/SSL support with automatic fallback to plain TCP - Username/password authentication for CoT connections - Real-time device position tracking with TTL-based expiration (90s default) - API endpoints: `/api/cot/config`, `/api/cot/server-package`, `/api/cot/truststore`, `/api/me/cot-password` - TAK Server section in Settings with QR code for iTAK setup - ATAK password management in Account page for OIDC users - CoT device markers on map showing real-time positions - Comprehensive documentation in `docs/` directory - Environment variables: `COT_PORT`, `COT_TTL_MS`, `COT_REQUIRE_AUTH`, `COT_SSL_CERT`, `COT_SSL_KEY`, `COT_DEBUG` - Dependencies: `fast-xml-parser`, `jszip`, `qrcode` ## Changed - Authentication system supports CoT password management for OIDC users - Database schema includes `cot_password_hash` field - Test suite refactored to follow functional design principles ## Removed - Consolidated utility modules: `authConfig.js`, `authSkipPaths.js`, `bootstrap.js`, `poiConstants.js`, `session.js` ## Security - XML entity expansion protection in CoT parser - Enhanced input validation and SQL injection prevention - Authentication timeout to prevent hanging connections ## Breaking Changes - Port 8089 must be exposed for CoT server. Update firewall rules and Docker/Kubernetes configurations. ## Migration Notes - OIDC users must set ATAK password via Account settings before connecting - Docker: expose port 8089 (`-p 8089:8089`) - Kubernetes: update Helm values to expose port 8089 Co-authored-by: Madison Grubb <madison@elastiflow.com> Reviewed-on: #6
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
# Authentication
|
|
|
|
KestrelOS supports **local login** (username/email + password) and optional **OIDC** (SSO). All users must sign in.
|
|
|
|
## Local Login
|
|
|
|
**First run:** On first start, KestrelOS creates an admin account:
|
|
- If `BOOTSTRAP_EMAIL` and `BOOTSTRAP_PASSWORD` are set → that account is created
|
|
- Otherwise → default admin (`admin`) with random password printed in terminal
|
|
|
|
**Sign in:** Open `/login`, enter identifier and password. Change password or add users via **Members** (admin only).
|
|
|
|
## OIDC (SSO)
|
|
|
|
**Enable:** Set `OIDC_ISSUER`, `OIDC_CLIENT_ID`, `OIDC_CLIENT_SECRET`. Optional: `OIDC_LABEL`, `OIDC_REDIRECT_URI`, `OIDC_SCOPES`.
|
|
|
|
**IdP setup:**
|
|
1. Create OIDC client in your IdP (Keycloak, Auth0, etc.)
|
|
2. Set redirect URI: `https://<your-host>/api/auth/oidc/callback`
|
|
3. Copy Client ID and Secret to env vars
|
|
|
|
**Sign up:** Users sign up at the IdP. First OIDC login in KestrelOS creates their account automatically.
|
|
|
|
**Redirect URI:** Defaults to `{APP_URL}/api/auth/oidc/callback` (uses `NUXT_APP_URL`/`APP_URL` or falls back to `HOST`/`PORT`).
|
|
|
|
## OIDC Users and ATAK/iTAK
|
|
|
|
OIDC users don't have a KestrelOS password. To use ATAK/iTAK:
|
|
1. Sign in with OIDC
|
|
2. Go to **Account** → set **ATAK password**
|
|
3. Use KestrelOS username + ATAK password in TAK client
|
|
|
|
## Roles
|
|
|
|
- **Admin** - Manage users, edit POIs, add/edit devices (API)
|
|
- **Leader** - Edit POIs, add/edit devices (API)
|
|
- **Member** - View map/cameras/POIs, use Share live
|
|
|
|
Only admins can change roles (Members page).
|