Files
TimeTracker/scripts/verify_csrf_config.sh
Dries Peeters 20824dbcb1 feat: Add customizable Kanban board columns and enhance CSRF configuration
This commit introduces a comprehensive Kanban board customization system and
improves CSRF token configuration for Docker deployments.

## Major Features

### 1. Customizable Kanban Board Columns
Add complete kanban column customization system allowing users to define
custom workflow states beyond the default columns.

**New Components:**
- Add KanbanColumn model with full CRUD operations (app/models/kanban_column.py)
- Add kanban routes blueprint with admin endpoints (app/routes/kanban.py)
- Add kanban column management templates (app/templates/kanban/)
- Add migration 019 for kanban_columns table (migrations/)

**Features:**
- Create unlimited custom columns with unique keys, labels, icons, and colors
- Drag-and-drop column reordering with position persistence
- Toggle column visibility without deletion
- Protected system columns (todo, in_progress, done) prevent accidental deletion
- Complete state marking for columns that should mark tasks as done
- Real-time updates via SocketIO broadcasts when columns change
- Font Awesome icon support (5000+ icons)
- Bootstrap color scheme integration
- Comprehensive validation and error handling

**Integration:**
- Update Task model to work with dynamic column statuses (app/models/task.py)
- Update task routes to use kanban column API (app/routes/tasks.py)
- Update project routes to fetch active columns (app/routes/projects.py)
- Add kanban column management links to base template (app/templates/base.html)
- Update kanban board templates to render dynamic columns (app/templates/tasks/)
- Add cache prevention headers to force fresh column data

**API Endpoints:**
- GET /api/kanban/columns - Fetch all active columns
- POST /api/kanban/columns/reorder - Reorder columns
- GET /kanban/columns - Column management interface (admin only)
- POST /kanban/columns/create - Create new column (admin only)
- POST /kanban/columns/<id>/edit - Edit column (admin only)
- POST /kanban/columns/<id>/delete - Delete column (admin only)
- POST /kanban/columns/<id>/toggle - Toggle column visibility (admin only)

### 2. Enhanced CSRF Configuration
Improve CSRF token configuration and documentation for Docker deployments.

**Configuration Updates:**
- Add WTF_CSRF_ENABLED environment variable to all docker-compose files
- Add WTF_CSRF_TIME_LIMIT environment variable with 1-hour default
- Update app/config.py to read CSRF settings from environment
- Add SECRET_KEY validation in app/__init__.py to prevent production deployment
  with default keys

**Docker Compose Updates:**
- docker-compose.yml: CSRF enabled by default for security testing
- docker-compose.remote.yml: CSRF always enabled in production
- docker-compose.remote-dev.yml: CSRF enabled with production-like settings
- docker-compose.local-test.yml: CSRF can be disabled for local testing
- Add helpful comments explaining each CSRF-related environment variable
- Update env.example with CSRF configuration examples

**Verification Scripts:**
- Add scripts/verify_csrf_config.sh for Unix systems
- Add scripts/verify_csrf_config.bat for Windows systems
- Scripts check SECRET_KEY, CSRF_ENABLED, and CSRF_TIME_LIMIT settings

### 3. Database Initialization Improvements
- Update app/__init__.py to run pending migrations on startup
- Add automatic kanban column initialization after migrations
- Improve error handling and logging during database setup

### 4. Configuration Management
- Update app/config.py with new CSRF and kanban-related settings
- Add environment variable parsing with sensible defaults
- Improve configuration validation and error messages

## Documentation

### New Documentation Files
- CUSTOM_KANBAN_README.md: Quick start guide for kanban customization
- KANBAN_CUSTOMIZATION.md: Detailed technical documentation
- IMPLEMENTATION_SUMMARY.md: Implementation details and architecture
- KANBAN_AUTO_REFRESH_COMPLETE.md: Real-time update system documentation
- KANBAN_REFRESH_FINAL_FIX.md: Cache and refresh troubleshooting
- KANBAN_REFRESH_SOLUTION.md: Technical solution for data freshness
- docs/CSRF_CONFIGURATION.md: Comprehensive CSRF setup guide
- CSRF_DOCKER_CONFIGURATION_SUMMARY.md: Docker-specific CSRF setup
- CSRF_TROUBLESHOOTING.md: Common CSRF issues and solutions
- APPLY_KANBAN_MIGRATION.md: Migration application guide
- APPLY_FIXES_NOW.md: Quick fix reference
- DEBUG_KANBAN_COLUMNS.md: Debugging guide
- DIAGNOSIS_STEPS.md: System diagnosis procedures
- BROWSER_CACHE_FIX.md: Browser cache troubleshooting
- FORCE_NO_CACHE_FIX.md: Cache prevention solutions
- SESSION_CLOSE_ERROR_FIX.md: Session handling fixes
- QUICK_FIX.md: Quick reference for common fixes

### Updated Documentation
- README.md: Add kanban customization feature description
- Update project documentation with new features

## Testing

### New Test Files
- test_kanban_refresh.py: Test kanban column refresh functionality

## Technical Details

**Database Changes:**
- New table: kanban_columns with 11 columns
- Indexes on: key, position
- Default data: 4 system columns (todo, in_progress, review, done)
- Support for both SQLite (development) and PostgreSQL (production)

**Real-Time Updates:**
- SocketIO events: 'kanban_columns_updated' with action type
- Automatic page refresh when columns are created/updated/deleted/reordered
- Prevents stale data by expiring SQLAlchemy caches after changes

**Security:**
- Admin-only access to column management
- CSRF protection on all column mutation endpoints
- API endpoints exempt from CSRF (use JSON and other auth mechanisms)
- System column protection prevents data integrity issues
- Validation prevents deletion of columns with active tasks

**Performance:**
- Efficient querying with position-based ordering
- Cached column data with cache invalidation on changes
- No-cache headers on API responses to prevent stale data
- Optimized database indexes for fast lookups

## Breaking Changes

None. This is a fully backward-compatible addition.

Existing workflows continue to work with the default columns.
Custom columns are opt-in via the admin interface.

## Migration Notes

1. Run migration 019 to create kanban_columns table
2. Default columns are initialized automatically on first run
3. No data migration needed for existing tasks
4. Existing task statuses map to new column keys

## Environment Variables

New environment variables (all optional with defaults):
- WTF_CSRF_ENABLED: Enable/disable CSRF protection (default: true)
- WTF_CSRF_TIME_LIMIT: CSRF token expiration in seconds (default: 3600)
- SECRET_KEY: Required in production, must be cryptographically secure

See env.example for complete configuration reference.

## Deployment Notes
2025-10-11 19:56:45 +02:00

177 lines
5.7 KiB
Bash

#!/bin/bash
# CSRF Configuration Verification Script
# This script verifies that CSRF tokens are properly configured in a Docker deployment
set -e
echo "=================================================="
echo " TimeTracker CSRF Configuration Verification"
echo "=================================================="
echo ""
# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # No Color
# Function to print status
print_status() {
if [ "$1" == "OK" ]; then
echo -e "${GREEN}${NC} $2"
elif [ "$1" == "WARNING" ]; then
echo -e "${YELLOW}${NC} $2"
else
echo -e "${RED}${NC} $2"
fi
}
# Check if container is running
CONTAINER_NAME=${1:-timetracker-app}
echo "Checking container: $CONTAINER_NAME"
echo ""
if ! docker ps | grep -q "$CONTAINER_NAME"; then
print_status "ERROR" "Container '$CONTAINER_NAME' is not running"
echo ""
echo "Available containers:"
docker ps --format "table {{.Names}}\t{{.Status}}"
exit 1
fi
print_status "OK" "Container is running"
echo ""
# Check environment variables
echo "1. Checking environment variables..."
echo "-----------------------------------"
SECRET_KEY=$(docker exec "$CONTAINER_NAME" env | grep "^SECRET_KEY=" | cut -d= -f2)
CSRF_ENABLED=$(docker exec "$CONTAINER_NAME" env | grep "^WTF_CSRF_ENABLED=" | cut -d= -f2 || echo "not set")
CSRF_TIMEOUT=$(docker exec "$CONTAINER_NAME" env | grep "^WTF_CSRF_TIME_LIMIT=" | cut -d= -f2 || echo "not set")
FLASK_ENV=$(docker exec "$CONTAINER_NAME" env | grep "^FLASK_ENV=" | cut -d= -f2 || echo "production")
if [ -z "$SECRET_KEY" ]; then
print_status "ERROR" "SECRET_KEY is not set!"
elif [ "$SECRET_KEY" == "your-secret-key-change-this" ]; then
print_status "ERROR" "SECRET_KEY is using default value - INSECURE!"
echo " Generate a secure key with: python -c \"import secrets; print(secrets.token_hex(32))\""
elif [ "$SECRET_KEY" == "dev-secret-key-change-in-production" ]; then
print_status "ERROR" "SECRET_KEY is using development default - INSECURE!"
elif [ ${#SECRET_KEY} -lt 32 ]; then
print_status "WARNING" "SECRET_KEY is short (${#SECRET_KEY} chars). Recommend 64+ chars"
else
print_status "OK" "SECRET_KEY is set and appears secure (${#SECRET_KEY} chars)"
fi
if [ "$CSRF_ENABLED" == "true" ] || [ "$CSRF_ENABLED" == "not set" ]; then
print_status "OK" "CSRF protection is enabled"
elif [ "$CSRF_ENABLED" == "false" ]; then
if [ "$FLASK_ENV" == "development" ]; then
print_status "WARNING" "CSRF protection is disabled (OK for development)"
else
print_status "ERROR" "CSRF protection is disabled in production!"
fi
else
print_status "WARNING" "CSRF_ENABLED has unexpected value: $CSRF_ENABLED"
fi
if [ "$CSRF_TIMEOUT" == "not set" ]; then
print_status "OK" "CSRF timeout using default (3600s / 1 hour)"
else
print_status "OK" "CSRF timeout set to ${CSRF_TIMEOUT}s ($(($CSRF_TIMEOUT / 60)) minutes)"
fi
echo ""
# Check application logs for CSRF-related issues
echo "2. Checking application logs..."
echo "-------------------------------"
CSRF_ERRORS=$(docker logs "$CONTAINER_NAME" 2>&1 | grep -i "csrf" | grep -i "error\|fail\|invalid" | tail -5)
if [ -n "$CSRF_ERRORS" ]; then
print_status "WARNING" "Found CSRF-related errors in logs:"
echo "$CSRF_ERRORS" | while IFS= read -r line; do
echo " $line"
done
else
print_status "OK" "No CSRF errors found in logs"
fi
echo ""
# Check if app is responding
echo "3. Checking application health..."
echo "---------------------------------"
PORT=$(docker port "$CONTAINER_NAME" 8080 2>/dev/null | cut -d: -f2)
if [ -z "$PORT" ]; then
PORT="8080"
fi
if curl -s -f "http://localhost:$PORT/_health" > /dev/null 2>&1; then
print_status "OK" "Application health check passed"
else
print_status "WARNING" "Health check endpoint not responding"
fi
# Try to fetch login page and check for CSRF token
LOGIN_PAGE=$(curl -s "http://localhost:$PORT/login" || echo "")
if echo "$LOGIN_PAGE" | grep -q "csrf_token"; then
print_status "OK" "CSRF token found in login page"
else
if [ "$CSRF_ENABLED" == "false" ]; then
print_status "OK" "No CSRF token in login page (CSRF is disabled)"
else
print_status "WARNING" "No CSRF token found in login page (might be disabled or error)"
fi
fi
echo ""
# Configuration summary
echo "4. Configuration Summary"
echo "------------------------"
echo "Container: $CONTAINER_NAME"
echo "Flask Environment: $FLASK_ENV"
echo "SECRET_KEY: ${SECRET_KEY:0:10}... (${#SECRET_KEY} chars)"
echo "CSRF Enabled: $CSRF_ENABLED"
echo "CSRF Timeout: $CSRF_TIMEOUT seconds"
echo ""
# Recommendations
echo "5. Recommendations"
echo "------------------"
HAS_ISSUES=0
if [ "$SECRET_KEY" == "your-secret-key-change-this" ] || [ "$SECRET_KEY" == "dev-secret-key-change-in-production" ]; then
echo "⚠️ Generate a secure SECRET_KEY:"
echo " python -c \"import secrets; print(secrets.token_hex(32))\""
echo " Then set it in your .env file or docker-compose.yml"
HAS_ISSUES=1
fi
if [ "$FLASK_ENV" != "development" ] && [ "$CSRF_ENABLED" == "false" ]; then
echo "⚠️ Enable CSRF protection in production:"
echo " Set WTF_CSRF_ENABLED=true in your environment"
HAS_ISSUES=1
fi
if [ "$FLASK_ENV" != "development" ] && [ ${#SECRET_KEY} -lt 32 ]; then
echo "⚠️ Use a longer SECRET_KEY for better security (64+ chars recommended)"
HAS_ISSUES=1
fi
if [ $HAS_ISSUES -eq 0 ]; then
echo -e "${GREEN}${NC} Configuration looks good!"
fi
echo ""
echo "=================================================="
echo "For detailed documentation, see:"
echo " docs/CSRF_CONFIGURATION.md"
echo "=================================================="