cycode 3.25.2.dev4__tar.gz → 3.26.1.dev1__tar.gz

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cycode
-Version: 3.25.2.dev4
+Version: 3.26.1.dev1
 Summary: Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.
 License-Expression: MIT
 License-File: LICENCE

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/__init__.py

@@ -5,4 +5,4 @@ import time as _time
 # end-to-end scan duration from the moment the user actually triggered it.
 _BOOT_WALL: float = _time.time()
 
-__version__ = '3.25.2.dev4'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
+__version__ = '3.26.1.dev1'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/ides/base.py

@@ -47,6 +47,16 @@ class HookDecision:
     user_message: str | None = None
     agent_message: str | None = None
 
+    @property
+    def model_message(self) -> str:
+        """What a tool deny tells the model: the findings the user sees, then the agent's instructions."""
+        return '\n'.join(message for message in (self.user_message, self.agent_message) if message)
+
+    @property
+    def permission_reason(self) -> str:
+        """A PreToolUse permissionDecisionReason: a deny reason goes to the model, an ask reason to the user."""
+        return self.model_message if self.action == DecisionAction.DENY else self.user_message or ''
+
     @classmethod
     def allow(cls, event_type: AiHookEventType) -> 'HookDecision':
         return cls(action=DecisionAction.ALLOW, event_type=event_type)

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/ides/claude_code.py

@@ -397,8 +397,13 @@ class ClaudeCode(IDE):
         if decision.event_type == AiHookEventType.PROMPT:
             if decision.action == DecisionAction.ALLOW:
                 return {}
-            # Both DENY and (unexpected) ASK on prompts collapse to a block.
-            return {'decision': 'block', 'reason': decision.user_message or ''}
+            # Both DENY and (unexpected) ASK on prompts collapse to a block. Claude Code echoes the blocked
+            # prompt (secret included) under the reason unless suppressed; the reason already locates the finding.
+            return {
+                'decision': 'block',
+                'reason': decision.user_message or '',
+                'hookSpecificOutput': {'hookEventName': 'UserPromptSubmit', 'suppressOriginalPrompt': True},
+            }
 
         # FILE_READ / MCP_EXECUTION → hookSpecificOutput shape.
         if decision.action == DecisionAction.ALLOW:
@@ -412,7 +417,7 @@ class ClaudeCode(IDE):
             'hookSpecificOutput': {
                 'hookEventName': 'PreToolUse',
                 'permissionDecision': decision.action.value,  # 'deny' or 'ask'
-                'permissionDecisionReason': decision.user_message or '',
+                'permissionDecisionReason': decision.permission_reason,
             }
         }
 

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/ides/codex.py

@@ -319,7 +319,7 @@ class Codex(IDE):
             'hookSpecificOutput': {
                 'hookEventName': 'PreToolUse',
                 'permissionDecision': decision.action.value,  # 'deny' or 'ask'
-                'permissionDecisionReason': decision.user_message or '',
+                'permissionDecisionReason': decision.permission_reason,
             }
         }
 

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/ides/copilot.py

@@ -474,7 +474,8 @@ class Copilot(IDE):
             'hookSpecificOutput': {
                 'hookEventName': 'PreToolUse',
                 'permissionDecision': decision.action.value,  # 'deny' or 'ask'
-                'permissionDecisionReason': decision.user_message or '',
+                # Copilot VS Code shows a deny reason to the user rather than the model, which is harmless
+                'permissionDecisionReason': decision.permission_reason,
             }
         }
 

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/ides/cursor.py

@@ -149,10 +149,13 @@ class Cursor(IDE):
         # FILE_READ / MCP_EXECUTION → permission shape
         if decision.action == DecisionAction.ALLOW:
             return {'permission': 'allow'}
+        # beforeReadFile has no agent_message; its deny user_message is what reaches the model
+        file_read_deny = decision.event_type == AiHookEventType.FILE_READ and decision.action == DecisionAction.DENY
         return {
             'permission': decision.action.value,  # 'deny' or 'ask'
-            'user_message': decision.user_message or '',
-            'agent_message': decision.agent_message or '',
+            'user_message': decision.model_message if file_read_deny else decision.user_message or '',
+            # The agent does not see user_message, and needs the findings (their sha) to act on its instructions
+            'agent_message': decision.model_message,
         }
 
     def build_session_payload(self, raw_payload: dict) -> AIHookPayload:

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/scan/handlers.py

@@ -10,9 +10,11 @@ touching any handler in this module.
 
 import json
 import os
+import sys
 import threading
 from collections.abc import Callable
 from dataclasses import dataclass
+from gettext import ngettext
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 import typer
@@ -46,12 +48,53 @@ logger = get_logger('AI Guardrails')
 HandlerFn = Callable[[typer.Context, AIHookPayload, dict], HookDecision]
 
 
+def _ignore_commands(shas: tuple[str, ...]) -> list[str]:
+    """Ready-to-run ignore commands, one per finding, in the order the findings are listed.
+
+    Names the binary running this hook, which may not be on PATH (e.g. MDM installs). Repo scope: it lands in
+    the cwd's .cycode/config.yaml, which matches where the hook reads it as long as the agent runs it.
+    """
+    executable = sys.executable if getattr(sys, 'frozen', False) else sys.argv[0]
+    if ' ' in executable:
+        executable = f'"{executable}"'
+    return [f'`{executable} ignore --by-sha {sha}`' for sha in shas]
+
+
+def _with_ignore_commands(shas: tuple[str, ...], one: str, many: str) -> str:
+    """`one` formatted with the single command, or `many` followed by the commands as a list; '' without shas."""
+    commands = _ignore_commands(shas)
+    if len(commands) == 1:
+        return one.format(command=commands[0])
+    if commands:
+        return many + ''.join(f'\n  {command}' for command in commands)
+    return ''
+
+
+def _false_positive_user_hint(shas: tuple[str, ...]) -> str:
+    # The agent never saw the blocked prompt, so the command has to be complete for the developer to pass on
+    return _with_ignore_commands(
+        shas,
+        one='Not a real secret? Ask your code agent to run {command}, then resend.',
+        many='Not real secrets? Ask your code agent to run the command for each one, then resend:',
+    )
+
+
+def _false_positive_agent_hint(shas: tuple[str, ...]) -> str:
+    # Ignoring is the developer's call; the agent may run it for them, but only once they confirm
+    return 'Tell the user what was blocked.' + _with_ignore_commands(
+        shas,
+        one=' Only if the user confirms it is a false positive, run {command} and retry.',
+        many=' Only for a finding the user confirms is a false positive, run its command and retry:',
+    )
+
+
 class ScanOutcome(NamedTuple):
     """What one guardrail scan came back with; the verdict is the server's, which applied the tenant's floors."""
 
     violation_summary: str | None = None
     scan_id: str | None = None
     verdict: GuardrailsMode | None = None
+    shas: tuple[str, ...] = ()
 
 
 NO_SCAN = ScanOutcome()
@@ -96,7 +139,10 @@ def handle_before_submit_prompt(ctx: typer.Context, payload: AIHookPayload, poli
             block_reason = SECRETS_BLOCK_REASON_BY_EVENT_TYPE[AiHookEventType.PROMPT]
             if scan_outcome.verdict == GuardrailsMode.BLOCK:
                 outcome = AIHookOutcome.BLOCKED
-                user_message = f'Remove secrets before sending. {scan_outcome.violation_summary}'
+                secrets = ngettext('secret', 'secrets', len(scan_outcome.shas))
+                user_message = f'{scan_outcome.violation_summary}\nRemove the {secrets} and resend.'
+                if scan_outcome.shas:
+                    user_message += f'\n{_false_positive_user_hint(scan_outcome.shas)}'
                 return HookDecision.deny(AiHookEventType.PROMPT, user_message)
             outcome = AIHookOutcome.WARNED
         return HookDecision.allow(AiHookEventType.PROMPT)
@@ -164,14 +210,15 @@ def handle_before_read_file(ctx: typer.Context, payload: AIHookPayload, policy:
                 block_reason = SECRETS_BLOCK_REASON_BY_EVENT_TYPE[AiHookEventType.FILE_READ]
                 if scan_outcome.verdict == GuardrailsMode.BLOCK:
                     outcome = AIHookOutcome.BLOCKED
-                    user_message = f'Cycode blocked reading {file_path}. {scan_outcome.violation_summary}'
+                    user_message = (
+                        f'Cycode blocked reading {file_path} because it contains a secret.\n'
+                        f'{scan_outcome.violation_summary}'
+                    )
                     return HookDecision.deny(
-                        AiHookEventType.FILE_READ,
-                        user_message,
-                        'Secrets detected; do not send this file to the model.',
+                        AiHookEventType.FILE_READ, user_message, _false_positive_agent_hint(scan_outcome.shas)
                     )
                 outcome = AIHookOutcome.WARNED
-                user_message = f'Cycode detected secrets in {file_path}. {scan_outcome.violation_summary}'
+                user_message = f'Cycode detected secrets in {file_path}.\n{scan_outcome.violation_summary}'
                 return HookDecision.ask(
                     AiHookEventType.FILE_READ,
                     user_message,
@@ -282,7 +329,7 @@ def _handle_arg_scan(
                 return HookDecision.deny(
                     feature.event_type,
                     feature.deny_message(scan_outcome.violation_summary),
-                    feature.deny_agent_message,
+                    f'{feature.deny_agent_message} {_false_positive_agent_hint(scan_outcome.shas)}',
                 )
             outcome = AIHookOutcome.WARNED
             return HookDecision.ask(
@@ -360,9 +407,11 @@ def handle_before_mcp_execution(ctx: typer.Context, payload: AIHookPayload, poli
         policy,
         _ArgScanFeature(
             event_type=AiHookEventType.MCP_EXECUTION,
-            deny_message=lambda v: f'Cycode blocked MCP tool call "{tool}". {v}',
+            deny_message=lambda v: (
+                f'Cycode blocked MCP tool call "{tool}" because its arguments contain a secret.\n{v}'
+            ),
             deny_agent_message='Do not pass secrets to tools. Use secret references (name/id) instead.',
-            ask_message=lambda v: f'Allow MCP tool call "{tool}"? {v}',
+            ask_message=lambda v: f'Allow MCP tool call "{tool}"?\n{v}',
             ask_agent_message='Possible secrets detected in tool arguments; proceed with caution.',
             scan_enabled=get_policy_value(policy, 'mcp', 'scan_args', default=True),
         ),
@@ -478,11 +527,14 @@ def _perform_scan(
     if not local_scan_result:
         return NO_SCAN
 
-    violation_summary = build_violation_summary([local_scan_result]) if local_scan_result.issue_detected else None
+    violation_summary, shas = (
+        build_violation_summary([local_scan_result]) if local_scan_result.issue_detected else (None, ())
+    )
     return ScanOutcome(
         violation_summary=violation_summary,
         scan_id=local_scan_result.scan_id,
         verdict=_parse_verdict(local_scan_result.verdict),
+        shas=shas,
     )
 
 

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/cycode/cli/apps/ai_guardrails/scan/utils.py

@@ -8,14 +8,17 @@ import json
 import os
 import sys
 from collections import defaultdict
+from gettext import ngettext
 from pathlib import Path
 from typing import TYPE_CHECKING
 
 from cycode.cli.apps.ai_guardrails.scan.policy import get_policy_value
 from cycode.cli.cli_types import SeverityOption
+from cycode.cli.utils.string_utils import obfuscate_text
 
 if TYPE_CHECKING:
     from cycode.cli.models import LocalScanResult
+    from cycode.cyclient.models import Detection
 
 # Keeps the hook message readable when a single file trips dozens of detections
 MAX_VIOLATION_DETAIL_LINES = 5
@@ -98,35 +101,50 @@ def output_json(obj: dict) -> None:
     print(json.dumps(obj), end='')  # noqa: T201
 
 
-def _build_detection_lines(
+def _describe_detection(detection: 'Detection', content: str) -> str:
+    details = detection.detection_details
+    description = detection.type or detection.message
+
+    line = details.get('line')
+    if isinstance(line, int) and line >= 0:
+        description += f' (line {line + 1})'  # the scanner reports 0-based lines
+
+    start, length = details.get('start_position'), details.get('length')
+    if isinstance(start, int) and isinstance(length, int) and start >= 0 and length > 0:
+        value = content[start : start + length]
+        if value:
+            description += f': {obfuscate_text(value)}'
+
+    return description
+
+
+def build_violation_summary(
     local_scan_results: list['LocalScanResult'], max_lines: int = MAX_VIOLATION_DETAIL_LINES
-) -> str:
-    """One line per distinct finding: what it is, and the value hash identifying it.
+) -> tuple[str, tuple[str, ...]]:
+    """One line per distinct finding (what it is, where, the masked value), and the value hashes to ignore them by.
 
-    The value hash is safe to display; the value itself is not. Detections excluded by an existing
+    The masked value and hash are safe to display; the value itself is not. Detections excluded by an existing
     ignore rule are already gone from `document_detections`, so only what actually blocked is listed.
     """
-    type_by_sha = {}
+    # Keyed by value hash so a repeated value is listed once; detections without one key by their description
+    finding_by_key = {}
     for local_scan_result in local_scan_results:
         for document_detections in local_scan_result.document_detections:
             for detection in document_detections.detections:
+                description = _describe_detection(detection, document_detections.document.content)
                 sha = detection.detection_details.get('sha512')
-                if sha and sha not in type_by_sha:
-                    type_by_sha[sha] = detection.type or detection.message
-
-    if not type_by_sha:
-        return ''
+                finding_by_key.setdefault(sha or description, (sha, description))
 
-    lines = [f'  - {detection_type}: {sha}' for sha, detection_type in list(type_by_sha.items())[:max_lines]]
-    remaining = len(type_by_sha) - len(lines)
+    listed = list(finding_by_key.values())[:max_lines]
+    lines = [_build_severity_line(local_scan_results)] + [f'  - {description}' for _, description in listed]
+    remaining = len(finding_by_key) - len(listed)
     if remaining:
         lines.append(f'  - ...and {remaining} more')
 
-    return '\n' + '\n'.join(lines)
+    return '\n'.join(lines), tuple(sha for sha, _ in listed if sha)
 
 
-def build_violation_summary(local_scan_results: list['LocalScanResult']) -> str:
-    """Build violation summary string with severity breakdown and emojis."""
+def _build_severity_line(local_scan_results: list['LocalScanResult']) -> str:
     detections_count = 0
     severity_counts = defaultdict(int)
 
@@ -143,5 +161,5 @@ def build_violation_summary(local_scan_results: list['LocalScanResult']) -> str:
         count = severity_counts[severity]
         severity_parts.append(f'{emoji} {severity.upper()} - {count}')
 
-    summary = f'Cycode found {detections_count} violations: {" | ".join(severity_parts)}'
-    return summary + _build_detection_lines(local_scan_results)
+    violations = ngettext('violation', 'violations', detections_count)
+    return f'Cycode found {detections_count} {violations}: {" | ".join(severity_parts)}'

{cycode-3.25.2.dev4 → cycode-3.26.1.dev1}/pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
     "Programming Language :: Python :: 3.14",
 ]
 dynamic = ["dependencies"]
-version = "3.25.2.dev4"
+version = "3.26.1.dev1"
 
 [project.scripts]
 cycode = "cycode.cli.app:app"