跳至主要內容

audit rules

瀏覽、啟用、停用並自訂稽核規則。

skillshare audit rules                          # 互動式 TUI 規則瀏覽器
skillshare audit rules --no-tui # 純文字表格
skillshare audit rules --pattern credential-access # 依 pattern 篩選
skillshare audit rules --severity high # 依嚴重程度篩選
skillshare audit rules --disabled # 只顯示已停用的規則
skillshare audit rules --format json # JSON 輸出

skillshare audit rules disable prompt-injection-0 # 停用單一規則
skillshare audit rules disable --pattern credential-access # 停用整個群組
skillshare audit rules enable prompt-injection-0 # 重新啟用規則
skillshare audit rules enable --pattern credential-access # 重新啟用群組

skillshare audit rules severity destructive-commands-2 medium # 降級單一規則
skillshare audit rules severity --pattern destructive-commands low # 降級整個群組
skillshare audit rules reset # 移除所有自訂規則,還原預設值

skillshare audit rules init # 建立起始 audit-rules.yaml
skillshare audit rules init -p # 建立 project 層級的 rules 檔案

Pattern 層級規則

你可以在 audit-rules.yaml 中停用或覆寫整個 pattern 群組:

rules:
# Disable all credential-access rules
- pattern: credential-access
enabled: false

# But keep .env detection
- id: credential-access-env-file
enabled: true

# Downgrade all destructive-commands to MEDIUM
- pattern: destructive-commands
severity: MEDIUM

Pattern 層級的項目使用 pattern 而不使用 id。合併順序:pattern 層級規則會先套用,然後 id 層級規則可以覆寫已停用群組中的個別項目。

Custom Rules

你可以使用 YAML 檔案新增、覆寫或停用稽核規則。規則會依序合併:built-in → global 使用者 → project 使用者

使用 --init-rules(或 audit rules init)建立一個帶有註解範例的起始檔案:

skillshare audit --init-rules         # Create global rules file
skillshare audit -p --init-rules # Create project rules file

檔案位置

Scope路徑
Global~/.config/skillshare/audit-rules.yaml
Project.skillshare/audit-rules.yaml

格式

rules:
# Add a new rule
- id: my-custom-rule
severity: HIGH
pattern: custom-check
message: "Custom pattern detected"
regex: 'DANGEROUS_PATTERN'

# Add a rule with an exclude (suppress matches on certain lines)
- id: url-check
severity: MEDIUM
pattern: url-usage
message: "External URL detected"
regex: 'https?://\S+'
exclude: 'https?://(localhost|127\.0\.0\.1)'

# Override an existing built-in rule (match by id)
- id: destructive-commands-2
severity: MEDIUM
pattern: destructive-commands
message: "Sudo usage (downgraded to MEDIUM)"
regex: '(?i)\bsudo\s+'

# Disable a built-in rule
- id: insecure-http-0
enabled: false

# Disable the dangling-link structural check
- id: dangling-link
enabled: false

欄位

欄位必要說明
id穩定的識別碼。相符的 ID 會覆寫內建規則。
severity是*CRITICALHIGHMEDIUMLOWINFO
pattern是*規則分類名稱(例如 prompt-injection
message是*顯示於發現項目中的人類可讀說明
regex是*用於比對每一行的正規表示式
exclude若一行同時符合 regexexclude,該發現項目會被抑制
enabled設為 false 以停用規則。停用時只需要 id

*除非 enabled: false,否則為必要欄位。

合併語意

每一層(global,再來是 project)都會疊加在前一層之上:

  • 相同 id + enabled: false → 停用該規則
  • 相同 id + 其他欄位 → 取代整條規則
  • 新的 id → 附加為自訂規則
  • 只有 pattern(沒有 id)+ enabled: false → 停用所有符合該 pattern 的規則
  • 只有 pattern + severity → 覆寫所有符合規則的嚴重程度
  • Pattern 後接 id → id 層級的項目可以在已停用的 pattern 群組中重新啟用個別規則

實務範本

以此作為實際政策調整的起點:

rules:
# Downgrade hardcoded-secret to MEDIUM for educational/reference skills
- pattern: hardcoded-secret
severity: MEDIUM

# Override built-in suspicious-fetch with internal allowlist
- id: suspicious-fetch-0
severity: MEDIUM
pattern: suspicious-fetch
message: "External URL used in command context"
regex: '(?i)(curl|wget|invoke-webrequest|iwr)\s+https?://'
exclude: '(?i)https?://(localhost|127\.0\.0\.1|artifacts\.company\.internal|registry\.company\.internal)'

# Governance exception: disable noisy insecure-http signal
- id: insecure-http-0
enabled: false

使用 init 快速開始

audit rules init(或 audit --init-rules)會建立一個帶有註解範例的起始 audit-rules.yaml,你可以取消註解並自行調整:

skillshare audit rules init          # → ~/.config/skillshare/audit-rules.yaml
skillshare audit rules init -p # → .skillshare/audit-rules.yaml

產生的檔案內容如下:

# Custom audit rules for skillshare.
# Rules are merged on top of built-in rules in order:
# built-in → global (~/.config/skillshare/audit-rules.yaml)
# → project (.skillshare/audit-rules.yaml)
#
# Each rule needs: id, severity, pattern, message, regex.
# Optional: exclude (suppress match), enabled (false to disable).

rules:
# Example: flag TODO comments as informational
# - id: flag-todo
# severity: MEDIUM
# pattern: todo-comment
# message: "TODO comment found"
# regex: '(?i)\bTODO\b'

# Example: disable a built-in rule by id
# - id: insecure-http-0
# enabled: false

# Example: disable the dangling-link structural check
# - id: dangling-link
# enabled: false

# Example: override a built-in rule (match by id, change severity)
# - id: destructive-commands-2
# severity: MEDIUM
# pattern: destructive-commands
# message: "Sudo usage (downgraded)"
# regex: '(?i)\bsudo\s+'

如果檔案已存在,init 會以錯誤結束——它絕不會覆寫現有規則。

工作流程:修正誤判

自訂規則的常見原因,是一個合法的 skill 觸發了內建規則。以下是逐步範例:

1. 執行 audit 並看到誤判:

$ skillshare audit ci-helper
[1/1] ! ci-helper 0.2s
└─ HIGH: Destructive command pattern (SKILL.md:42)
"sudo apt-get install -y jq"

2. 從內建規則表中找出規則 ID:

pattern destructive-commands 搭配 sudo 符合規則 destructive-commands-2

3. 建立自訂規則檔案(若尚未建立):

skillshare audit rules init

4. 加入規則覆寫以抑制或降級:

# ~/.config/skillshare/audit-rules.yaml
rules:
# Downgrade sudo to MEDIUM for CI automation skills
- id: destructive-commands-2
severity: MEDIUM
pattern: destructive-commands
message: "Sudo usage (downgraded for CI automation)"
regex: '(?i)\bsudo\s+'

或是完全停用它:

rules:
- id: destructive-commands-2
enabled: false

5. 重新執行 audit 以確認:

$ skillshare audit ci-helper
[1/1] ✓ ci-helper 0.1s # Now passes (or shows MEDIUM instead of HIGH)

驗證變更

編輯規則後,重新執行 audit 以驗證:

skillshare audit                     # Check all skills
skillshare audit <name> # Check a specific skill
skillshare audit --json | jq '.skills[].findings' # Inspect findings programmatically

摘要解讀:

  • Failed 計算的是發現項目達到或超過目前門檻的 skills。
  • Warning 計算的是發現項目低於門檻但高於 clean 的 skills(例如門檻為 CRITICAL 時的 HIGH/MEDIUM/LOW/INFO)。

Built-in Rule IDs

使用 id 值來覆寫或停用特定的內建規則:

以正規表示式為基礎的規則,其真實來源為: internal/audit/rules.yaml

結構性、分層與跨 skill 檢查

dangling-linkcontent-tamperedcontent-oversizecontent-missingcontent-unexpected結構性檢查(檔案系統查找與雜湊比對,並非正規表示式)。low-analyzability 是由 Analyzability Score 產生的可分析性發現項目tier-stealthtier-destructive-networktier-network-heavytier-interpretertier-interpreter-network 是由 Command Safety Tiering 設定檔產生的分層組合發現項目cross-skill-* 發現項目是由 Cross-Skill Interaction Detection 產生。以上這些都會出現在下方表格中,但並未定義於 rules.yaml 中。

IDPatternSeverity
prompt-injection-0prompt-injectionCRITICAL
prompt-injection-1prompt-injectionCRITICAL
prompt-injection-2prompt-injectionHIGH
prompt-injection-3prompt-injectionCRITICAL
prompt-injection-4prompt-injectionCRITICAL
hidden-unicode-1invisible-payloadCRITICAL
data-exfiltration-0data-exfiltrationCRITICAL
data-exfiltration-1data-exfiltrationCRITICAL
data-exfiltration-2data-exfiltrationMEDIUM
data-exfiltration-3data-exfiltrationHIGH
credential-access-ssh-private-keycredential-accessCRITICAL
credential-access-env-filecredential-accessCRITICAL
credential-access-aws-credentialscredential-accessCRITICAL
credential-access-etc-shadowcredential-accessCRITICAL
credential-access-git-credentialscredential-accessCRITICAL
credential-access-netrccredential-accessCRITICAL
credential-access-gnupgcredential-accessCRITICAL
credential-access-kube-configcredential-accessCRITICAL
credential-access-vault-tokencredential-accessCRITICAL
credential-access-terraform-credscredential-accessCRITICAL
credential-access-gnome-keyringcredential-accessCRITICAL
credential-access-npmrccredential-accessCRITICAL
credential-access-pypirccredential-accessCRITICAL
credential-access-gem-credentialscredential-accessCRITICAL
credential-access-ssl-privatecredential-accessCRITICAL
credential-access-ssh-host-keycredential-accessCRITICAL
credential-access-pgpasscredential-accessCRITICAL
credential-access-mysql-cnfcredential-accessCRITICAL
credential-access-etc-passwdcredential-accessMEDIUM
credential-access-azure-credscredential-accessHIGH
credential-access-gcloud-credscredential-accessHIGH
credential-access-docker-configcredential-accessHIGH
credential-access-gh-cli-tokencredential-accessHIGH
credential-access-password-storecredential-accessHIGH
credential-access-macos-keychain-usercredential-accessHIGH
credential-access-macos-keychain-syscredential-accessHIGH
credential-access-terraformrccredential-accessHIGH
credential-access-cargo-credentialscredential-accessHIGH
credential-access-op-clicredential-accessHIGH
credential-access-age-keyscredential-accessHIGH
credential-access-shell-historycredential-accessLOW
credential-access-openvpncredential-accessLOW
credential-access-auth-logcredential-accessINFO
credential-access-unknown-dotdircredential-accessINFO

注意: 上方每一個 credential 項目也會依存取方式產生額外的變體 ID:-copy-redirect-dd-exfil(例如 credential-access-ssh-private-key-copy)。若要停用特定變體,請在你的 audit-rules.yaml 中使用其完整 ID。

IDPatternSeverity
hidden-unicode-0hidden-unicodeHIGH
hidden-unicode-2hidden-unicodeHIGH
config-manipulation-0config-manipulationHIGH
hidden-comment-injection-1hidden-comment-injectionHIGH
self-propagation-0self-propagationHIGH
destructive-commands-0destructive-commandsHIGH
destructive-commands-1destructive-commandsHIGH
destructive-commands-2destructive-commandsHIGH
destructive-commands-3destructive-commandsHIGH
destructive-commands-4destructive-commandsHIGH
dynamic-code-exec-0dynamic-code-execHIGH
dynamic-code-exec-1dynamic-code-execHIGH
shell-execution-0shell-executionHIGH
hidden-comment-injection-0hidden-comment-injectionHIGH
obfuscation-0obfuscationHIGH
fetch-with-pipe-0fetch-with-pipeHIGH
fetch-with-pipe-1fetch-with-pipeHIGH
fetch-with-pipe-2fetch-with-pipeHIGH
hardcoded-secret-0hardcoded-secretHIGH
hardcoded-secret-1hardcoded-secretHIGH
hardcoded-secret-2hardcoded-secretHIGH
hardcoded-secret-3hardcoded-secretHIGH
hardcoded-secret-4hardcoded-secretHIGH
hardcoded-secret-5hardcoded-secretHIGH
hardcoded-secret-6hardcoded-secretHIGH
hardcoded-secret-7hardcoded-secretHIGH
hardcoded-secret-8hardcoded-secretHIGH
hardcoded-secret-9hardcoded-secretHIGH
data-uri-0data-uriMEDIUM
escape-obfuscation-0escape-obfuscationMEDIUM
suspicious-fetch-0suspicious-fetchMEDIUM
ip-address-url-0ip-address-urlMEDIUM
hidden-unicode-3hidden-unicodeMEDIUM
untrusted-install-0untrusted-installMEDIUM
untrusted-install-1untrusted-installMEDIUM
insecure-http-0insecure-httpLOW
external-link-0external-linkLOW
dangling-linkdangling-linkLOW
content-tamperedcontent-tamperedMEDIUM
content-oversizecontent-oversizeMEDIUM
content-missingcontent-missingLOW
content-unexpectedcontent-unexpectedLOW
shell-chain-0shell-chainINFO
low-analyzabilitylow-analyzabilityINFO
tier-stealthtier-stealthCRITICAL
tier-destructive-networktier-destructive-networkHIGH
tier-network-heavytier-network-heavyMEDIUM
tier-interpretertier-interpreterINFO
tier-interpreter-networktier-interpreter-networkMEDIUM
cross-skill-exfiltrationcross-skill-exfiltrationHIGH
cross-skill-privilege-networkcross-skill-privilege-networkMEDIUM
cross-skill-stealthcross-skill-stealthHIGH
cross-skill-cred-interpretercross-skill-cred-interpreterMEDIUM

Subcommands

Subcommand說明
rules瀏覽、啟用並停用稽核規則
rules disable <id>依 ID 停用單一規則
rules disable --pattern <p>停用所有符合 pattern 的規則
rules enable <id>依 ID 重新啟用單一規則
rules enable --pattern <p>重新啟用所有符合 pattern 的規則
rules severity <id> <level>覆寫單一規則的嚴重程度
rules severity --pattern <p> <level>覆寫某個 pattern 群組中所有規則的嚴重程度
rules reset移除所有自訂規則(還原內建預設值)
rules init建立起始 audit-rules.yaml(與 audit --init-rules 相同)

另請參閱