agentsentinel-cli 0.6.0__tar.gz → 0.7.0__tar.gz

agentsentinel_cli-0.7.0/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+*.egg
+.eggs/
+
+# Build & dist
+dist/
+build/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing & coverage
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.tox/
+
+# Environment & secrets
+.env
+.env.*
+
+# Sentinel analyst memory (local state, not for commit)
+.sentinel/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Editors
+.idea/
+.vscode/
+*.swp
+~$*

{agentsentinel_cli-0.6.0 → agentsentinel_cli-0.7.0}/DOCUMENTATION.md

@@ -20,6 +20,7 @@ No server required. No Docker. Works on any Python agent file or live HTTP endpo
   - [sentinel mcp scan](#sentinel-mcp-scan)
   - [sentinel probe](#sentinel-probe)
   - [sentinel ai-probe](#sentinel-ai-probe)
+- [Finding Suppression](#finding-suppression)
 - [Real-World Workflows](#real-world-workflows)
 - [CI/CD Integration](#cicd-integration)
 - [Reference](#reference)
@@ -119,6 +120,7 @@ TARGET can be a Python file, a directory, or a live HTTP endpoint URL.
 | `--model TEXT` | `claude-haiku-4-5-20251001` | Claude model for AI summary |
 | `--auth-header HEADER` | — | HTTP auth header for live endpoints, e.g. `Authorization: Bearer token` |
 | `--fail-on [CRITICAL\|HIGH\|MEDIUM\|LOW]` | — | Exit code 1 if findings reach this severity |
+| `--ignore-rule RULE_ID` | — | Suppress a finding by rule ID. Repeatable. Also reads `.sentinelignore` in the target directory |
 
 #### What it shows
 
@@ -155,6 +157,9 @@ sentinel inspect http://my-agent.internal/chat \
 # JSON output — pipe into jq, SIEM, dashboards
 sentinel inspect my_agent.py --format json | jq '.fingerprint'
 
+# Suppress a known-accepted finding while still gating on CRITICAL
+sentinel inspect my_agent.py --fail-on CRITICAL --ignore-rule DANGEROUS_GRANTS
+
 # CI gate — fail if any CRITICAL finding
 sentinel inspect my_agent.py --fail-on CRITICAL
 ```
@@ -220,6 +225,7 @@ TARGET defaults to `.` (current directory, scanned recursively).
 |------|---------|-------------|
 | `--format [text\|json]` | `text` | Output format |
 | `--fail-on [CRITICAL\|HIGH\|MEDIUM\|LOW]` | — | Exit code 1 if findings reach this severity |
+| `--ignore-rule RULE_ID` | — | Suppress a finding by rule ID. Repeatable. Also reads `.sentinelignore` in the target directory |
 | `--connect URL` | — | Pull live behavior data from a running AgentSentinel instance |
 | `--api-key TEXT` | `$AGENTSENTINEL_API_KEY` | API key for `--connect` |
 
@@ -268,6 +274,14 @@ sentinel scan my_agent.py --format json
 
 # Include live behavior data from a running AgentSentinel instance
 sentinel scan my_agent.py --connect http://localhost:9000 --api-key $AGENTSENTINEL_KEY
+
+# Suppress a noisy LOW finding and still gate on HIGH
+sentinel scan ./agents/ --fail-on HIGH --ignore-rule MISSING_RATE_LIMIT
+
+# Stack multiple suppressions
+sentinel scan ./agents/ --fail-on CRITICAL \
+  --ignore-rule MISSING_RATE_LIMIT \
+  --ignore-rule TOOL_SPRAWL
 ```
 
 #### Example output
@@ -342,6 +356,7 @@ sentinel secrets ~/.claude/projects/ --severity LOW
 | `--format [text\|json]` | `text` | Output format |
 | `--fail-on [CRITICAL\|HIGH\|MEDIUM\|LOW]` | — | Exit code 1 if findings reach this severity |
 | `--no-redact` | off | Show full matched values instead of masking them |
+| `--ignore-rule RULE_ID` | — | Suppress a finding by rule ID. Repeatable. Also reads `.sentinelignore` in the target directory |
 
 #### Choosing the right scope
 
@@ -597,8 +612,8 @@ Common false positives and how to handle them:
 | `SG_UEN` | 9-digit numbers that happen to end in a letter | UENs are common in business documents — confirm the surrounding context |
 
 If a finding is a confirmed false positive, it does not affect the finding count for `--fail-on`
-evaluation — you still need to address it or suppress it by restructuring the content.
-Suppression via ignore-lists is not yet implemented (planned for v0.6).
+evaluation — you still need to address it, suppress it with `--ignore-rule`, or restructure the
+content to remove the match. See [Finding Suppression](#finding-suppression).
 
 ---
 
@@ -692,6 +707,7 @@ sentinel mcp scan --stdio "CMD" [OPTIONS]
 | `--format [text\|json]` | `text` | Output format |
 | `--timeout SECONDS` | `10.0` | Connection timeout |
 | `--fail-on [CRITICAL\|HIGH\|MEDIUM\|LOW]` | — | Exit code 1 if findings reach this severity |
+| `--ignore-rule RULE_ID` | — | Suppress a finding by rule ID. Repeatable. Also reads `.sentinelignore` in the working directory |
 
 #### Transport support
 
@@ -740,6 +756,9 @@ sentinel mcp scan http://localhost:3000 --fail-on CRITICAL
 
 # Longer timeout for slow servers
 sentinel mcp scan http://remote-server.com/mcp --timeout 30
+
+# CI gate — suppress a finding accepted at the infrastructure layer
+sentinel mcp scan http://localhost:3000 --fail-on CRITICAL --ignore-rule NO_AUTH
 ```
 
 #### Example output
@@ -958,6 +977,87 @@ sentinel ai-probe http://my-agent.com/chat --fail-on CRITICAL
 
 ---
 
+## Finding Suppression
+
+Use `--ignore-rule` and `.sentinelignore` to suppress specific findings by rule ID. Suppressed findings are excluded from both output display and `--fail-on` evaluation — they never break a CI gate.
+
+Supported commands: `sentinel scan`, `sentinel mcp scan`, `sentinel supply-chain`, `sentinel secrets`, `sentinel inspect`.
+
+### --ignore-rule flag
+
+Suppress one or more rules for a single run. The flag is repeatable.
+
+```bash
+# Suppress a single rule
+sentinel scan ./agents/ --fail-on HIGH --ignore-rule MISSING_RATE_LIMIT
+
+# Stack multiple suppressions
+sentinel mcp scan http://localhost:3001 --fail-on CRITICAL \
+  --ignore-rule NO_AUTH \
+  --ignore-rule UNBOUNDED_INPUT
+
+# Suppress during secrets scan
+sentinel secrets . --fail-on HIGH --ignore-rule SG_UEN
+```
+
+### .sentinelignore file
+
+For persistent, project-level suppressions, create a `.sentinelignore` file and commit it to source control. sentinel walks up from the target directory to find it — same discovery pattern as `.gitignore`.
+
+```
+# .sentinelignore
+
+# Comments start with #. Blank lines are ignored.
+# Rule IDs are case-insensitive.
+
+MISSING_RATE_LIMIT          # rate limiting enforced at API gateway layer
+SC03_HIDDEN_NETWORK_FIELDS  # webhook field is for audit logging — verified safe
+NO_AUTH                     # MCP server is behind an authenticated reverse proxy
+```
+
+sentinel searches for `.sentinelignore` starting from the target path and walking up to the filesystem root. For URL targets (`sentinel mcp scan`, `sentinel supply-chain`), it searches from the current working directory.
+
+### Suppression notice
+
+When findings are suppressed, sentinel prints a dim notice at the end of text output:
+
+```
+  1 finding suppressed by .sentinelignore / --ignore-rule: MISSING_RATE_LIMIT
+```
+
+In JSON output, suppressed findings are absent from the `findings` array. The `--fail-on` threshold is evaluated only against the active (non-suppressed) findings.
+
+### What to suppress — and what not to
+
+Suppressions are appropriate for findings where the risk is genuinely accepted at another layer:
+
+| Scenario | Appropriate suppression |
+|----------|------------------------|
+| Rate limiting handled at API gateway | `MISSING_RATE_LIMIT` |
+| MCP server behind authenticated proxy | `NO_AUTH` |
+| Known webhook field verified safe | `SC03_HIDDEN_NETWORK_FIELDS` |
+| Agent description intentionally omitted | `UNDESCRIBED_WRITE_AGENT` |
+
+Do not suppress CRITICAL findings (`EXFILTRATION_PATH`, `CODE_EXECUTION_GRANT`, `HARDCODED_CREDENTIALS`, `SC01_DESCRIPTION_INJECTION`) without a very specific, documented reason. These represent confirmed active risk paths, not configuration preferences.
+
+### Incremental CI adoption
+
+The `.sentinelignore` + `--fail-on` combination is the recommended way to adopt CI gates incrementally:
+
+```bash
+# Week 1 — gate only on CRITICAL, suppress anything that isn't actually critical
+sentinel scan ./agents/ --fail-on CRITICAL
+
+# Week 2 — raise threshold to HIGH, suppress accepted HIGH findings
+echo "DANGEROUS_GRANTS" >> .sentinelignore
+sentinel scan ./agents/ --fail-on HIGH
+
+# Week 3 — full posture gate, suppressions document accepted risk
+sentinel scan ./agents/ --fail-on MEDIUM
+```
+
+---
+
 ## Real-World Workflows
 
 ### Workflow 1: Unknown agent found in production
@@ -1121,6 +1221,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        # .sentinelignore in the repo root is picked up automatically
 
       - name: Install sentinel
         run: pip install "agentsentinel-cli[all]"
@@ -1146,6 +1247,13 @@ jobs:
         run: sentinel mcp scan http://localhost:3000 --fail-on CRITICAL
 ```
 
+Add a `.sentinelignore` at the repo root to suppress known-accepted findings without weakening the gate threshold:
+
+```
+# .sentinelignore — committed to source control
+MISSING_RATE_LIMIT    # rate limiting handled at infra layer
+```
+
 ### GitLab CI
 
 ```yaml

agentsentinel_cli-0.7.0/LICENSE

@@ -0,0 +1,185 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contribution
+      embodied within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as separate terms and conditions for use,
+      reproduction, or distribution of Your modifications, or for any
+      such Derivative Works as a whole, provided Your use, reproduction,
+      and distribution of the Work otherwise complies with the conditions
+      stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License and for a fee that covers
+      the cost of such liability obligations and/or rights consistent with
+      this License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Jayden Aung
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.