Skip to content

Commit

Permalink
logmonitor: docs: add security advisory for config file (#196)
Browse files Browse the repository at this point in the history
As a recommendation from the previous security review,
add an advisory for users on how to restrict write
access for the confg file.

This reduces the possibility of the config file being
used as an attack vector, especially for a low
privilege user.

Signed-off-by: Anthony Nandaa <[email protected]>
  • Loading branch information
profnandaa authored Oct 14, 2024
1 parent d36c314 commit fb712c3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions LogMonitor/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Log File Monitoring](#log-file-monitoring)
- [Process Monitoring](#process-monitoring)
- [Log Format Customization](#log-format-customization)
- [Security Advisory for Config File](#security-advisory-for-config-file)

## Sample Config File

Expand Down Expand Up @@ -478,3 +479,18 @@ For example:
}
}
```

## Security Advisory for Config File

For extra security for cases where you have low privilege users for your container,
you can restrict modification for the config file to only administrators. You
can do this by running this in the container or adding it in your _dockerfile_.

```powershell
# update the path if not using default
icacls C:/LogMonitor/LogMonitorConfig.json /grant Administrators:F /deny Users:W
```

This grants full access (`F`) to `Administrators` group and denies Write (`W`)
permission to the `Users` group, which includes standard users (such as
`ContainerUser` in the container).

0 comments on commit fb712c3

Please sign in to comment.