Skip to content

Adapt new NAP detection #1099

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Adapt new NAP detection #1099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions internal/watcher/instance/instance_watcher_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ type (
instancesChannel chan<- InstanceUpdatesMessage
nginxConfigContextChannel chan<- NginxConfigContextMessage
nginxParser processParser
nginxAppProtectProcessParser processParser
nginxAppProtectProcessParser *NginxAppProtectParser
cacheMutex sync.Mutex
}

Expand Down Expand Up @@ -78,7 +78,7 @@ func NewInstanceWatcherService(agentConfig *config.Config) *InstanceWatcherServi
agentConfig: agentConfig,
processOperator: process.NewProcessOperator(),
nginxParser: NewNginxProcessParser(),
nginxAppProtectProcessParser: NewNginxAppProtectProcessParser(),
nginxAppProtectProcessParser: NewNginxAppProtectParser(),
nginxConfigParser: parser.NewNginxConfigParser(agentConfig),
instanceCache: make(map[string]*mpi.Instance),
cacheMutex: sync.Mutex{},
Expand Down Expand Up @@ -263,7 +263,7 @@ func (iw *InstanceWatcherService) instanceUpdates(ctx context.Context) (
) {
iw.cacheMutex.Lock()
defer iw.cacheMutex.Unlock()
nginxProcesses, nginxAppProtectProcesses, err := iw.processOperator.Processes(ctx)
nginxProcesses, _, err := iw.processOperator.Processes(ctx)
if err != nil {
return instanceUpdates, err
}
Expand All @@ -278,7 +278,7 @@ func (iw *InstanceWatcherService) instanceUpdates(ctx context.Context) (
instancesFound[instance.GetInstanceMeta().GetInstanceId()] = instance
}

nginxAppProtectInstances := iw.nginxAppProtectProcessParser.Parse(ctx, nginxAppProtectProcesses)
nginxAppProtectInstances := iw.nginxAppProtectProcessParser.Parse(ctx)
for _, instance := range nginxAppProtectInstances {
instancesFound[instance.GetInstanceMeta().GetInstanceId()] = instance
}
Expand Down
80 changes: 40 additions & 40 deletions internal/watcher/instance/nginx_app_protect_process_parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package instance

import (
"context"
"errors"
"log/slog"
"os"
"strings"
Expand All @@ -26,72 +27,71 @@ const (
)

type (
NginxAppProtectProcessParser struct {
NginxAppProtectParser struct {
versionFilePath string
releaseFilePath string
attackSignatureVersionFilePath string
threatCampaignVersionFilePath string
}
)

var _ processParser = (*NginxAppProtectProcessParser)(nil)

func NewNginxAppProtectProcessParser() *NginxAppProtectProcessParser {
return &NginxAppProtectProcessParser{
func NewNginxAppProtectParser() *NginxAppProtectParser {
return &NginxAppProtectParser{
versionFilePath: versionFilePath,
releaseFilePath: releaseFilePath,
attackSignatureVersionFilePath: attackSignatureVersionFilePath,
threatCampaignVersionFilePath: threatCampaignVersionFilePath,
}
}

func (n NginxAppProtectProcessParser) Parse(
func (n NginxAppProtectParser) Parse(
ctx context.Context,
processes []*nginxprocess.Process,
) map[string]*mpi.Instance {
instanceMap := make(map[string]*mpi.Instance) // key is instanceID

for _, process := range processes {
if process.Name == processName {
instanceID := n.instanceID(process)

binaryPath := process.Exe
if binaryPath == "" {
binaryPath = strings.Split(process.Cmd, " ")[0]
}

instanceMap[instanceID] = &mpi.Instance{
InstanceMeta: &mpi.InstanceMeta{
InstanceId: instanceID,
InstanceType: mpi.InstanceMeta_INSTANCE_TYPE_NGINX_APP_PROTECT,
Version: n.instanceVersion(ctx),
},
InstanceConfig: &mpi.InstanceConfig{},
InstanceRuntime: &mpi.InstanceRuntime{
ProcessId: process.PID,
BinaryPath: binaryPath,
ConfigPath: "",
Details: &mpi.InstanceRuntime_NginxAppProtectRuntimeInfo{
NginxAppProtectRuntimeInfo: &mpi.NGINXAppProtectRuntimeInfo{
Release: n.release(ctx),
AttackSignatureVersion: n.attackSignatureVersion(ctx),
ThreatCampaignVersion: n.threatCampaignVersion(ctx),
},
if n.isNAPInstance() {
instanceID := id.Generate("")
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel like missing something. This instanceID, ProcessId and BinaryPath we will no longer have(needed) in the new design?


instanceMap[instanceID] = &mpi.Instance{
InstanceMeta: &mpi.InstanceMeta{
InstanceId: instanceID,
InstanceType: mpi.InstanceMeta_INSTANCE_TYPE_NGINX_APP_PROTECT,
Version: n.instanceVersion(ctx),
},
InstanceConfig: &mpi.InstanceConfig{},
InstanceRuntime: &mpi.InstanceRuntime{
ProcessId: 0,
BinaryPath: "",
ConfigPath: "",
Details: &mpi.InstanceRuntime_NginxAppProtectRuntimeInfo{
NginxAppProtectRuntimeInfo: &mpi.NGINXAppProtectRuntimeInfo{
Release: n.release(ctx),
AttackSignatureVersion: n.attackSignatureVersion(ctx),
ThreatCampaignVersion: n.threatCampaignVersion(ctx),
},
InstanceChildren: make([]*mpi.InstanceChild, 0),
},
}
InstanceChildren: make([]*mpi.InstanceChild, 0),
},
}
}

return instanceMap
}

func (n NginxAppProtectProcessParser) instanceID(process *nginxprocess.Process) string {
func (n NginxAppProtectParser) isNAPInstance() bool {
_, errVersion := os.Stat(n.versionFilePath)
_, errRelease := os.Stat(n.releaseFilePath)
if errors.Is(errVersion, os.ErrNotExist) || errors.Is(errRelease, os.ErrNotExist) {
return false
}
return true
}

func (n NginxAppProtectParser) instanceID(process *nginxprocess.Process) string {
return id.Generate("%s", process.Exe)
}

func (n NginxAppProtectProcessParser) instanceVersion(ctx context.Context) string {
func (n NginxAppProtectParser) instanceVersion(ctx context.Context) string {
version, err := os.ReadFile(n.versionFilePath)
if err != nil {
slog.WarnContext(ctx, "Unable to read NAP version file", "file_path", n.versionFilePath, "error", err)
Expand All @@ -101,7 +101,7 @@ func (n NginxAppProtectProcessParser) instanceVersion(ctx context.Context) strin
return strings.TrimSuffix(string(version), "\n")
}

func (n NginxAppProtectProcessParser) release(ctx context.Context) string {
func (n NginxAppProtectParser) release(ctx context.Context) string {
release, err := os.ReadFile(n.releaseFilePath)
if err != nil {
slog.WarnContext(ctx, "Unable to read NAP release file", "file_path", n.releaseFilePath, "error", err)
Expand All @@ -111,7 +111,7 @@ func (n NginxAppProtectProcessParser) release(ctx context.Context) string {
return strings.TrimSuffix(string(release), "\n")
}

func (n NginxAppProtectProcessParser) attackSignatureVersion(ctx context.Context) string {
func (n NginxAppProtectParser) attackSignatureVersion(ctx context.Context) string {
attackSignatureVersion, err := os.ReadFile(n.attackSignatureVersionFilePath)
if err != nil {
slog.WarnContext(
Expand All @@ -127,7 +127,7 @@ func (n NginxAppProtectProcessParser) attackSignatureVersion(ctx context.Context
return string(attackSignatureVersion)
}

func (n NginxAppProtectProcessParser) threatCampaignVersion(ctx context.Context) string {
func (n NginxAppProtectParser) threatCampaignVersion(ctx context.Context) string {
threatCampaignVersion, err := os.ReadFile(n.threatCampaignVersionFilePath)
if err != nil {
slog.WarnContext(
Expand Down
2 changes: 1 addition & 1 deletion internal/watcher/instance/nginx_app_protect_process_parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@
_, err = threatCampaignVersionFile.WriteString("2024.12.02")
require.NoError(t, err)

nginxAppProtectProcessParser := NewNginxAppProtectProcessParser()
nginxAppProtectProcessParser := NewNginxAppProtectParser()
nginxAppProtectProcessParser.versionFilePath = versionFile.Name()
nginxAppProtectProcessParser.releaseFilePath = releaseFile.Name()
nginxAppProtectProcessParser.attackSignatureVersionFilePath = attackSignatureVersionFile.Name()
nginxAppProtectProcessParser.threatCampaignVersionFilePath = threatCampaignVersionFile.Name()

instances := nginxAppProtectProcessParser.Parse(ctx, processes)

Check failure on line 107 in internal/watcher/instance/nginx_app_protect_process_parser_test.go

View workflow job for this annotation

GitHub Actions / Unit tests with race condition detection 

too many arguments in call to nginxAppProtectProcessParser.Parse

Check failure on line 107 in internal/watcher/instance/nginx_app_protect_process_parser_test.go

View workflow job for this annotation

GitHub Actions / Unit Tests 

too many arguments in call to nginxAppProtectProcessParser.Parse

Check failure on line 107 in internal/watcher/instance/nginx_app_protect_process_parser_test.go

View workflow job for this annotation

GitHub Actions / Performance Tests 

too many arguments in call to nginxAppProtectProcessParser.Parse

assert.Len(t, instances, 1)

Expand Down
Loading