mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* Add comprehensive event logging system with OS-specific location and rotation Features: - Event logging for security-relevant events (malware detection, installations) - OS-specific default log locations (~/.pmg/logs/ on macOS/Linux, %LOCALAPPDATA%\pmg\logs\ on Windows) - Automatic 7-day log rotation with daily log files (YYYYMMDD-pmg.log format) - Support for custom log files via --log flag - Thread-safe JSON logging with zero external dependencies Implementation: - New internal/eventlog package with comprehensive logging functionality - Integration with guard.go to log malware detections and blocks - Integration with main.go for initialization and cleanup - Log file naming: YYYYMMDD-pmg.log (e.g., 20251216-pmg.log) - Fail-safe design - PMG continues if logging fails Event Types: - malware_blocked: Malicious package blocked from installation - malware_confirmed: User proceeded with flagged package - install_allowed: Clean package installation allowed - install_started: Package manager command initiated - error: Error events Testing: - Comprehensive test suite with 6 passing tests - Verified with real malware detection (e.g., @postman/tunnel-agent) - Works with all package managers (npm, pip, etc.) Technical Details: - Thread-safe with mutex protection - JSON format for easy parsing - Automatic cleanup of logs >7 days old - Background cleanup goroutine - Uses only Go standard library (encoding/json, os, path/filepath, sync, time) * Add update command support and improve event logging robustness Features: - Add support for npm/pnpm/bun/yarn update/upgrade/ci commands - These commands now scan packages for malware before updating - Closes security gap where update commands bypassed PMG protection Improvements: - Make event logging more defensive (graceful failure when not initialized) - Add nil check for packageManager in guard to prevent test failures - Add comprehensive tests for update commands Testing: - All 33+ unit tests passing - Integration tests verified with real malware detection - Tested with npm update, npm ci, npm upgrade, pnpm update, yarn upgrade Files changed: - packagemanager/npm.go: Added update/upgrade/ci to InstallCommands - packagemanager/npm_test.go: Added 4 new test cases for update commands - guard/guard.go: Added nil check for packageManager - internal/eventlog/eventlog.go: Made logging more defensive * Address review feedback: use log.Warnf instead of silently failing Replace silent error handling in cleanupOldLogs with log.Warnf to avoid completely swallowing errors when reading log directory. Fixes reviewer feedback from abhisek. * Remove update/upgrade command support, keep logging improvements - Remove update/upgrade/ci commands from InstallCommands for npm, pnpm, bun, yarn - Remove special handling for update/upgrade/ci commands in ParseCommand - Remove update command test cases and restore original test - Preserve logging improvements (nil check in guard.go, defensive check in eventlog.go) All tests passing.
255 lines
6.5 KiB
Go
255 lines
6.5 KiB
Go
package eventlog
|
|
|
|
import (
|
|
"encoding/json"
|
|
"os"
|
|
"path/filepath"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
func TestGetDefaultLogDir(t *testing.T) {
|
|
logDir, err := GetDefaultLogDir()
|
|
if err != nil {
|
|
t.Fatalf("GetDefaultLogDir() failed: %v", err)
|
|
}
|
|
|
|
if logDir == "" {
|
|
t.Error("Expected non-empty log directory")
|
|
}
|
|
|
|
// Check that it contains expected path components
|
|
expectedDir := ".pmg"
|
|
if filepath.Base(filepath.Dir(logDir)) != expectedDir && filepath.Base(filepath.Dir(filepath.Dir(logDir))) != expectedDir {
|
|
t.Errorf("Expected log directory to contain %s, got: %s", expectedDir, logDir)
|
|
}
|
|
}
|
|
|
|
func TestLoggerInitialization(t *testing.T) {
|
|
// Create a temporary directory for testing
|
|
tmpDir := t.TempDir()
|
|
logDir := filepath.Join(tmpDir, ".pmg", "logs")
|
|
|
|
// Initialize logger
|
|
err := InitializeWithDir(logDir)
|
|
if err != nil {
|
|
t.Fatalf("Failed to initialize logger: %v", err)
|
|
}
|
|
defer Close()
|
|
|
|
// Check that directory was created
|
|
if _, err := os.Stat(logDir); os.IsNotExist(err) {
|
|
t.Errorf("Log directory was not created: %s", logDir)
|
|
}
|
|
|
|
// Check that log file was created
|
|
expectedLogFile := filepath.Join(logDir, time.Now().Format("20060102")+"-pmg.log")
|
|
if _, err := os.Stat(expectedLogFile); os.IsNotExist(err) {
|
|
t.Errorf("Log file was not created: %s", expectedLogFile)
|
|
}
|
|
}
|
|
|
|
func TestLogEvent(t *testing.T) {
|
|
// Create a temporary directory for testing
|
|
tmpDir := t.TempDir()
|
|
logDir := filepath.Join(tmpDir, ".pmg", "logs")
|
|
|
|
// Initialize logger
|
|
err := reinitializeForTest(logDir)
|
|
if err != nil {
|
|
t.Fatalf("Failed to initialize logger: %v", err)
|
|
}
|
|
defer Close()
|
|
|
|
// Log an event
|
|
event := Event{
|
|
EventType: EventTypeMalwareBlocked,
|
|
Message: "Test malware blocked",
|
|
PackageName: "evil-package",
|
|
Version: "1.0.0",
|
|
Ecosystem: "npm",
|
|
Details: map[string]interface{}{
|
|
"reason": "Known malicious",
|
|
},
|
|
}
|
|
|
|
err = LogEvent(event)
|
|
if err != nil {
|
|
t.Fatalf("Failed to log event: %v", err)
|
|
}
|
|
|
|
// Read the log file and verify the event was written
|
|
logFilePath := filepath.Join(logDir, time.Now().Format("20060102")+"-pmg.log")
|
|
data, err := os.ReadFile(logFilePath)
|
|
if err != nil {
|
|
t.Fatalf("Failed to read log file: %v", err)
|
|
}
|
|
|
|
// Parse the JSON
|
|
var loggedEvent Event
|
|
err = json.Unmarshal(data, &loggedEvent)
|
|
if err != nil {
|
|
t.Fatalf("Failed to parse logged event: %v", err)
|
|
}
|
|
|
|
// Verify the event
|
|
if loggedEvent.EventType != EventTypeMalwareBlocked {
|
|
t.Errorf("Expected event type %s, got %s", EventTypeMalwareBlocked, loggedEvent.EventType)
|
|
}
|
|
if loggedEvent.PackageName != "evil-package" {
|
|
t.Errorf("Expected package name 'evil-package', got '%s'", loggedEvent.PackageName)
|
|
}
|
|
}
|
|
|
|
func TestLogMalwareBlocked(t *testing.T) {
|
|
// Create a temporary directory for testing
|
|
tmpDir := t.TempDir()
|
|
logDir := filepath.Join(tmpDir, ".pmg", "logs")
|
|
|
|
// Initialize logger
|
|
err := reinitializeForTest(logDir)
|
|
if err != nil {
|
|
t.Fatalf("Failed to initialize logger: %v", err)
|
|
}
|
|
defer Close()
|
|
|
|
// Log malware blocked event
|
|
LogMalwareBlocked("malicious-pkg", "2.0.0", "pypi", "Contains known malware", nil)
|
|
|
|
// Read and verify
|
|
logFilePath := filepath.Join(logDir, time.Now().Format("20060102")+"-pmg.log")
|
|
data, err := os.ReadFile(logFilePath)
|
|
if err != nil {
|
|
t.Fatalf("Failed to read log file: %v", err)
|
|
}
|
|
|
|
var event Event
|
|
err = json.Unmarshal(data, &event)
|
|
if err != nil {
|
|
t.Fatalf("Failed to parse event: %v", err)
|
|
}
|
|
|
|
if event.EventType != EventTypeMalwareBlocked {
|
|
t.Errorf("Expected event type %s, got %s", EventTypeMalwareBlocked, event.EventType)
|
|
}
|
|
if event.PackageName != "malicious-pkg" {
|
|
t.Errorf("Expected package 'malicious-pkg', got '%s'", event.PackageName)
|
|
}
|
|
if event.Ecosystem != "pypi" {
|
|
t.Errorf("Expected ecosystem 'pypi', got '%s'", event.Ecosystem)
|
|
}
|
|
}
|
|
|
|
func TestInitializeWithFile(t *testing.T) {
|
|
// Create a temporary directory for testing
|
|
tmpDir := t.TempDir()
|
|
logFile := filepath.Join(tmpDir, "custom.log")
|
|
|
|
// Initialize logger with custom file
|
|
err := reinitializeForTest("")
|
|
if err == nil {
|
|
Close()
|
|
}
|
|
|
|
// Reset for custom file
|
|
once = sync.Once{}
|
|
err = InitializeWithFile(logFile)
|
|
if err != nil {
|
|
t.Fatalf("Failed to initialize logger with file: %v", err)
|
|
}
|
|
defer Close()
|
|
|
|
// Log an event
|
|
event := Event{
|
|
EventType: EventTypeMalwareBlocked,
|
|
Message: "Test custom file logging",
|
|
PackageName: "test-package",
|
|
Version: "1.0.0",
|
|
Ecosystem: "npm",
|
|
}
|
|
|
|
err = LogEvent(event)
|
|
if err != nil {
|
|
t.Fatalf("Failed to log event: %v", err)
|
|
}
|
|
|
|
// Verify the custom log file was created and contains the event
|
|
if _, err := os.Stat(logFile); os.IsNotExist(err) {
|
|
t.Errorf("Custom log file was not created: %s", logFile)
|
|
}
|
|
|
|
data, err := os.ReadFile(logFile)
|
|
if err != nil {
|
|
t.Fatalf("Failed to read custom log file: %v", err)
|
|
}
|
|
|
|
if len(data) == 0 {
|
|
t.Error("Custom log file is empty")
|
|
}
|
|
|
|
var loggedEvent Event
|
|
err = json.Unmarshal(data, &loggedEvent)
|
|
if err != nil {
|
|
t.Fatalf("Failed to parse logged event: %v", err)
|
|
}
|
|
|
|
if loggedEvent.PackageName != "test-package" {
|
|
t.Errorf("Expected package 'test-package', got '%s'", loggedEvent.PackageName)
|
|
}
|
|
}
|
|
|
|
func TestCleanupOldLogs(t *testing.T) {
|
|
// Create a temporary directory for testing
|
|
tmpDir := t.TempDir()
|
|
logDir := filepath.Join(tmpDir, ".pmg", "logs")
|
|
err := os.MkdirAll(logDir, 0755)
|
|
if err != nil {
|
|
t.Fatalf("Failed to create log directory: %v", err)
|
|
}
|
|
|
|
// Create old log files
|
|
oldDate := time.Now().AddDate(0, 0, -10)
|
|
oldLogFile := filepath.Join(logDir, oldDate.Format("20060102")+"-pmg.log")
|
|
err = os.WriteFile(oldLogFile, []byte("old log"), 0644)
|
|
if err != nil {
|
|
t.Fatalf("Failed to create old log file: %v", err)
|
|
}
|
|
|
|
// Change the modification time to make it appear old
|
|
oldTime := time.Now().AddDate(0, 0, -10)
|
|
err = os.Chtimes(oldLogFile, oldTime, oldTime)
|
|
if err != nil {
|
|
t.Fatalf("Failed to change file time: %v", err)
|
|
}
|
|
|
|
// Create a recent log file
|
|
recentLogFile := filepath.Join(logDir, time.Now().Format("20060102")+"-pmg.log")
|
|
err = os.WriteFile(recentLogFile, []byte("recent log"), 0644)
|
|
if err != nil {
|
|
t.Fatalf("Failed to create recent log file: %v", err)
|
|
}
|
|
|
|
// Initialize logger (which triggers cleanup)
|
|
logger := &Logger{}
|
|
err = logger.init(logDir)
|
|
if err != nil {
|
|
t.Fatalf("Failed to initialize logger: %v", err)
|
|
}
|
|
defer logger.Close()
|
|
|
|
// Give cleanup goroutine time to run
|
|
time.Sleep(100 * time.Millisecond)
|
|
|
|
// Check that old file was deleted
|
|
if _, err := os.Stat(oldLogFile); !os.IsNotExist(err) {
|
|
t.Error("Old log file should have been deleted")
|
|
}
|
|
|
|
// Check that recent file still exists
|
|
if _, err := os.Stat(recentLogFile); os.IsNotExist(err) {
|
|
t.Error("Recent log file should still exist")
|
|
}
|
|
}
|
|
|