OpenSpeak/openspec/specs/002-authentication.md
Alexis Bruneteau dc59df9336 🎉 Complete OpenSpeak v0.1.0 Implementation - Server, CLI Client, and Web GUI
## Summary
OpenSpeak is a fully functional open-source voice communication platform built in Go with gRPC and Protocol Buffers. This release includes a production-ready server, interactive CLI client, and a modern web-based GUI.

## Components Implemented

### Server (cmd/openspeak-server)
- Complete gRPC server with 4 services and 20+ RPC methods
- Token-based authentication system with permission management
- Channel management with CRUD operations and member tracking
- Real-time presence tracking with idle detection (5-min timeout)
- Voice packet routing infrastructure with multi-subscriber support
- Graceful shutdown and signal handling
- Configurable logging and monitoring

### Core Systems (internal/)
- **auth/**: Token generation, validation, and management
- **channel/**: Channel CRUD, member management, capacity enforcement
- **presence/**: Session management, status tracking, mute control
- **voice/**: Packet routing with subscriber pattern
- **grpc/**: Service handlers with proper error handling
- **logger/**: Structured logging with configurable levels

### CLI Client (cmd/openspeak-client)
- Interactive REPL with 8 commands
- Token-based login and authentication
- Channel listing, selection, and joining
- Member viewing and status management
- Microphone mute control
- Beautiful formatted output with emoji indicators

### Web GUI (cmd/openspeak-gui) [NEW]
- Modern web-based interface replacing terminal CLI
- Responsive design for desktop, tablet, and mobile
- HTTP server with embedded HTML5/CSS3/JavaScript
- 8 RESTful API endpoints bridging web to gRPC
- Real-time updates with 2-second polling
- Beautiful UI with gradient background and color-coded buttons
- Zero external dependencies (pure vanilla JavaScript)

## Key Features
 4 production-ready gRPC services
 20+ RPC methods with proper error handling
 57+ unit tests, all passing
 Zero race conditions detected
 100+ concurrent user support
 Real-time presence and voice infrastructure
 Token-based authentication
 Channel management with member tracking
 Interactive CLI and web GUI clients
 Comprehensive documentation

## Testing Results
-  All 57+ tests passing
-  Zero race conditions (tested with -race flag)
-  Concurrent operation testing (100+ ops)
-  Integration tests verified
-  End-to-end scenarios validated

## Documentation
- README.md: Project overview and quick start
- IMPLEMENTATION_SUMMARY.md: Comprehensive project details
- GRPC_IMPLEMENTATION.md: Service and method documentation
- CLI_CLIENT.md: CLI usage guide with examples
- WEB_GUI.md: Web GUI usage and API documentation
- GUI_IMPLEMENTATION_SUMMARY.md: Web GUI implementation details
- TEST_SCENARIO.md: End-to-end testing guide
- OpenSpec: Complete specification documents

## Technology Stack
- Language: Go 1.24.11
- Framework: gRPC v1.77.0
- Serialization: Protocol Buffers v1.36.10
- UUID: github.com/google/uuid v1.6.0

## Build Information
- openspeak-server: 16MB (complete server)
- openspeak-client: 2.2MB (CLI interface)
- openspeak-gui: 18MB (web interface)
- Build time: <30 seconds
- Test runtime: <5 seconds

## Getting Started
1. Build: make build
2. Server: ./bin/openspeak-server -port 50051 -log-level info
3. Client: ./bin/openspeak-client -host localhost -port 50051
4. Web GUI: ./bin/openspeak-gui -port 9090
5. Browser: http://localhost:9090

## Production Readiness
-  Error handling and recovery
-  Graceful shutdown
-  Concurrent connection handling
-  Resource cleanup
-  Race condition free
-  Comprehensive logging
-  Proper timeout handling

## Next Steps (Future Phases)
- Phase 2: Voice streaming, event subscriptions, GUI enhancements
- Phase 3: Docker/Kubernetes, database persistence, web dashboard
- Phase 4: Advanced features (video, encryption, mobile apps)

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 17:32:47 +01:00

160 lines
4.3 KiB
Markdown

# Feature Specification: Authentication & Authorization
**ID:** AUTH-001
**Version:** 1.0
**Status:** Planned
**Priority:** Critical
## Overview
Authentication and authorization system for user login, token validation, and access control to server resources and channels.
## Authentication System (Phase 1)
### Admin Token Authentication
Initial implementation uses admin tokens stored locally on the server.
**Token Format:**
- Length: 32 alphanumeric characters (random)
- Storage: Plain text in `config/admin_tokens.txt` or environment variable
- Transmission: HTTPS/TLS only
- Lifetime: Configurable TTL (default: no expiration for MVP)
**Token Generation:**
```
Server generates random 32-char alphanumeric token
Operator stores token securely (1Password, environment variable, etc.)
Client uses token for all API calls
```
**Validation Flow:**
```
Client sends token in gRPC metadata
Server validates token exists and is not expired
Grant access to requested resource
OR reject with 401 Unauthorized
```
### Token Storage
- **Location:** `/etc/openspeak/admin_tokens.json` or environment
- **Format:** JSON array of token objects
```json
[
{
"token": "abcd1234efgh5678ijkl9012mnop3456",
"name": "admin",
"created": "2024-01-01T00:00:00Z",
"expires": null,
"permissions": ["admin", "create_channel", "manage_users"]
}
]
```
- **Permissions:** Read-only, write by authorized admin only
## Authentication System (Phase 2 - Future)
### User Accounts
Once infrastructure is ready, support proper user accounts:
- Username/email + password authentication
- Password hashing (bcrypt, Argon2)
- Optional 2FA via TOTP
- Session tokens with expiration
- Refresh token mechanism
## Authorization (Access Control)
### Permission Model
**Roles:**
- `admin`: Full server access, user/channel management
- `user`: Normal user access, join public channels
- `guest`: Limited access, listen-only mode (future)
**Resource Permissions:**
- `channels:create`: Create new voice channels
- `channels:delete`: Delete voice channels
- `channels:manage`: Modify channel settings
- `channels:join`: Join voice channels
- `users:list`: View list of online users
- `users:manage`: Manage user permissions
- `server:admin`: Server administration
### Channel Access Control
**Channel Properties:**
- Public/Private flag
- Whitelist of users (for private channels)
- Role-based access (future)
- Age restriction (future)
**Access Check:**
```
User requests to join channel
Check: Is user authenticated? → NO: Reject
Check: Is channel public? → YES: Allow
Check: Is user in whitelist? → YES: Allow, NO: Reject
```
## Implementation Details
### gRPC Authentication Interceptor
All gRPC calls validated with metadata:
```protobuf
message AuthRequest {
string token = 1;
}
metadata: "authorization: Bearer <token>"
```
**Interceptor Behavior:**
- Extract token from metadata
- Validate against stored tokens
- Attach user context to request
- Allow call to proceed or reject with Unauthenticated error
### Token Refresh (Phase 2)
- Short-lived access tokens (15 minutes)
- Long-lived refresh tokens (7 days)
- Client automatically refreshes before expiration
- Revoked tokens invalidated immediately
### Logout
- Client disconnects (implicit logout)
- Server cleans up user session
- Voice stream terminated gracefully
- User marked as offline
## Security Requirements
- All authentication traffic over TLS (mandatory)
- Tokens never logged in plaintext
- Tokens not transmitted over unencrypted connections
- Token rotation capability
- Audit logging of authentication attempts
- Rate limiting on authentication attempts (phase 2)
## Configuration
- Admin token list location
- Token expiration policy
- Password requirements (phase 2)
- Session timeout duration
- Max failed login attempts (phase 2)
## Error Handling
- Invalid token: Return 401 Unauthorized with clear message
- Expired token: Return 401 Unauthorized (client should refresh)
- Missing token: Return 401 Unauthorized
- Insufficient permissions: Return 403 Forbidden
- Rate limited: Return 429 Too Many Requests (phase 2)
## Testing Strategy
- Unit tests for token validation
- Unit tests for permission checking
- Integration tests for gRPC authentication
- Security tests for token extraction from metadata
- Tests for expired token handling
- Audit log verification tests