Skip to content

Commit eb09640

Browse files
committed
docs: finalize readme
1 parent 6444366 commit eb09640

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
> ⚠️ **Important:** This package is one layer in a defense-in-depth strategy.
99
> It does **not** replace endpoint protection, sandboxing, input validation, or other security controls.
1010
11+
> ⚠️ **Important:** This package uses the Microsoft Antimalware Scan Interface (AMSI) and will submit content to the installed antimalware engine on the host (_e.g., Microsoft Defender_). Malicious samples or test files (_such as the EICAR test file_) may trigger alerts and incidents in your security monitoring. Make sure your security/operations team is aware of this integration before running tests in shared or production environments.
12+
1113
## Features
1214

1315
- **AMSI-based** implementation of `IAntimalwareScanner` for `ByteGuard.FileValidator`
@@ -21,7 +23,6 @@
2123
- An AMSI-integrated antimalware engine installed and enabled (_e.g. Microsoft Defender Antivirus_).
2224
- **Core packages**
2325
- [`ByteGuard.FileValidator`](https://www.nuget.org/packages/ByteGuard.FileValidator)
24-
- Optionally [`ByteGuard.FileValidator.Extensions.DependencyInjection`](https://www.nuget.org/packages/ByteGuard.FileValidator.Extensions.DependencyInjection) for `Microsoft.Extensions.DependencyInjection` integration
2526

2627
## Getting Started
2728

@@ -89,6 +90,15 @@ public async Task<IActionResult> Upload(IFormFile file)
8990
}
9091
```
9192

93+
### Testing the AMSI integration
94+
95+
If you verify the integration using known test signatures (for example, the EICAR test file), be aware that:
96+
97+
- The installed AV engine may quarantine or block the file.
98+
- Alerts may be raised and forwarded to your SIEM / security team.
99+
- In tightly monitored environments, you should coordinate with your security team before running such tests.
100+
101+
92102
## Security notes & limitations
93103

94104
- AMSI relies on the underlying antimalware provider for detection. If the provider is disabled, misconfigured, or missing signatures, detection quality will be affected.

0 commit comments

Comments
 (0)