Skip to content

feat: Add comprehensive security enhancements #1664

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
104 changes: 104 additions & 0 deletions internal/apiserver/apiserver.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package apiserver

import (
"context"
"net/http"
"time"

"github.com/gin-gonic/gin"
"github.com/hyperledger/firefly-common/pkg/ffapi"
"github.com/hyperledger/firefly-common/pkg/i18n"
"github.com/hyperledger/firefly/internal/coremsgs"
"github.com/hyperledger/firefly/internal/orchestrator"
"github.com/hyperledger/firefly/pkg/core"
"github.com/hyperledger/firefly/pkg/database"
"golang.org/x/time/rate"
)

type apiServer struct {
orchestrator orchestrator.Orchestrator
limiter *rate.Limiter
ipLimiter map[string]*rate.Limiter
}

func NewAPIServer(or orchestrator.Orchestrator) *apiServer {
return &apiServer{
orchestrator: or,
limiter: rate.NewLimiter(rate.Every(time.Second), 100), // Global rate limit
ipLimiter: make(map[string]*rate.Limiter),
}
}

func (s *apiServer) rateLimit() gin.HandlerFunc {
return func(c *gin.Context) {
// Get client IP
clientIP := c.ClientIP()

// Check global rate limit
if !s.limiter.Allow() {
c.JSON(http.StatusTooManyRequests, gin.H{
"error": "Global rate limit exceeded",
})
c.Abort()
return
}

// Check IP-specific rate limit
s.mu.Lock()
ipLimiter, exists := s.ipLimiter[clientIP]
if !exists {
ipLimiter = rate.NewLimiter(rate.Every(time.Second), 10) // 10 requests per second per IP
s.ipLimiter[clientIP] = ipLimiter
}
s.mu.Unlock()

if !ipLimiter.Allow() {
c.JSON(http.StatusTooManyRequests, gin.H{
"error": "IP rate limit exceeded",
})
c.Abort()
return
}

c.Next()
}
}

func (s *apiServer) securityHeaders() gin.HandlerFunc {
return func(c *gin.Context) {
// Security headers
c.Header("X-Content-Type-Options", "nosniff")
c.Header("X-Frame-Options", "DENY")
c.Header("X-XSS-Protection", "1; mode=block")
c.Header("Strict-Transport-Security", "max-age=31536000; includeSubDomains; preload")
c.Header("Content-Security-Policy", "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data:; connect-src 'self' https:;")
c.Header("Referrer-Policy", "strict-origin-when-cross-origin")
c.Header("Permissions-Policy", "geolocation=(), microphone=(), camera=()")
c.Header("Cache-Control", "no-store, no-cache, must-revalidate, proxy-revalidate")
c.Header("Pragma", "no-cache")
c.Header("Expires", "0")

// Prevent clickjacking
c.Header("X-Frame-Options", "DENY")

// Prevent MIME type sniffing
c.Header("X-Content-Type-Options", "nosniff")

// Enable XSS protection
c.Header("X-XSS-Protection", "1; mode=block")

c.Next()
}
}

func (s *apiServer) Start() error {
router := gin.Default()

// Add security headers middleware
router.Use(s.securityHeaders())

// Add rate limiting
router.Use(s.rateLimit())

// ... rest of existing code ...
}
190 changes: 190 additions & 0 deletions internal/audit/audit.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
package audit

import (
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"strings"
"sync"
"time"

"github.com/hyperledger/firefly-common/pkg/fftypes"
"github.com/hyperledger/firefly-common/pkg/log"
)

const (
maxLogSize = 100 * 1024 * 1024 // 100MB
maxLogAge = 30 * 24 * time.Hour // 30 days
maxLogBackups = 10
)

// AuditEvent represents a security audit event
type AuditEvent struct {
Timestamp time.Time `json:"timestamp"`
EventType string `json:"eventType"`
UserID string `json:"userId"`
Action string `json:"action"`
Resource string `json:"resource"`
IPAddress string `json:"ipAddress"`
UserAgent string `json:"userAgent"`
Details map[string]interface{} `json:"details"`
Status string `json:"status"`
Error string `json:"error,omitempty"`
}

// AuditLogger handles security audit logging
type AuditLogger struct {
mu sync.RWMutex
logFile *os.File
basePath string
size int64
}

// NewAuditLogger creates a new audit logger
func NewAuditLogger(basePath string) (*AuditLogger, error) {
if err := os.MkdirAll(basePath, 0700); err != nil {
return nil, fmt.Errorf("failed to create audit log directory: %v", err)
}

// Create a new log file with timestamp
timestamp := time.Now().Format("2006-01-02")
logPath := filepath.Join(basePath, fmt.Sprintf("audit-%s.log", timestamp))
logFile, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
if err != nil {
return nil, fmt.Errorf("failed to create audit log file: %v", err)
}

// Get initial file size
info, err := logFile.Stat()
if err != nil {
logFile.Close()
return nil, fmt.Errorf("failed to get log file info: %v", err)
}

return &AuditLogger{
logFile: logFile,
basePath: basePath,
size: info.Size(),
}, nil
}

// LogEvent logs a security audit event
func (al *AuditLogger) LogEvent(ctx context.Context, event *AuditEvent) error {
al.mu.Lock()
defer al.mu.Unlock()

// Ensure timestamp is set
if event.Timestamp.IsZero() {
event.Timestamp = time.Now()
}

// Marshal event to JSON
data, err := json.Marshal(event)
if err != nil {
return fmt.Errorf("failed to marshal audit event: %v", err)
}

// Add newline for log file
data = append(data, '\n')

// Check if we need to rotate the log
if al.size+int64(len(data)) > maxLogSize {
if err := al.rotateLog(); err != nil {
return fmt.Errorf("failed to rotate log: %v", err)
}
}

// Write to log file
n, err := al.logFile.Write(data)
if err != nil {
return fmt.Errorf("failed to write audit event: %v", err)
}

// Update size
al.size += int64(n)

// Also log to standard logger for monitoring
log.L(ctx).Infof("AUDIT: %s - %s - %s - %s - %s",
event.EventType,
event.UserID,
event.Action,
event.Resource,
event.Status)

return nil
}

// Close closes the audit logger
func (al *AuditLogger) Close() error {
al.mu.Lock()
defer al.mu.Unlock()

if al.logFile != nil {
return al.logFile.Close()
}
return nil
}

// RotateLog rotates the audit log file
func (al *AuditLogger) rotateLog() error {
// Close current file
if al.logFile != nil {
al.logFile.Close()
}

// Create new file with current timestamp
timestamp := time.Now().Format("2006-01-02")
logPath := filepath.Join(al.basePath, fmt.Sprintf("audit-%s.log", timestamp))
logFile, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
if err != nil {
return fmt.Errorf("failed to create new audit log file: %v", err)
}

al.logFile = logFile
al.size = 0

// Clean up old log files
if err := al.cleanupOldLogs(); err != nil {
return fmt.Errorf("failed to cleanup old logs: %v", err)
}

return nil
}

// cleanupOldLogs removes old log files
func (al *AuditLogger) cleanupOldLogs() error {
entries, err := os.ReadDir(al.basePath)
if err != nil {
return err
}

now := time.Now()
for _, entry := range entries {
if entry.IsDir() {
continue
}

// Check if file is an audit log
if !strings.HasPrefix(entry.Name(), "audit-") || !strings.HasSuffix(entry.Name(), ".log") {
continue
}

// Parse timestamp from filename
timestamp, err := time.Parse("2006-01-02", strings.TrimSuffix(strings.TrimPrefix(entry.Name(), "audit-"), ".log"))
if err != nil {
continue
}

// Check if file is too old
if now.Sub(timestamp) > maxLogAge {
path := filepath.Join(al.basePath, entry.Name())
if err := os.Remove(path); err != nil {
return fmt.Errorf("failed to remove old log file %s: %v", path, err)
}
}
}

return nil
}
Loading