@elizaos/skills 2.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (371) hide show
  1. package/README.md +126 -0
  2. package/package.json +53 -0
  3. package/skills/1password/SKILL.md +70 -0
  4. package/skills/1password/references/cli-examples.md +29 -0
  5. package/skills/1password/references/get-started.md +17 -0
  6. package/skills/apple-notes/SKILL.md +77 -0
  7. package/skills/apple-reminders/SKILL.md +96 -0
  8. package/skills/bear-notes/SKILL.md +107 -0
  9. package/skills/bird/SKILL.md +224 -0
  10. package/skills/blogwatcher/SKILL.md +69 -0
  11. package/skills/blucli/SKILL.md +47 -0
  12. package/skills/bluebubbles/SKILL.md +131 -0
  13. package/skills/camsnap/SKILL.md +45 -0
  14. package/skills/canvas/SKILL.md +203 -0
  15. package/skills/clawhub/SKILL.md +77 -0
  16. package/skills/coding-agent/SKILL.md +284 -0
  17. package/skills/discord/SKILL.md +578 -0
  18. package/skills/eightctl/SKILL.md +50 -0
  19. package/skills/food-order/SKILL.md +48 -0
  20. package/skills/gemini/SKILL.md +43 -0
  21. package/skills/gifgrep/SKILL.md +79 -0
  22. package/skills/github/SKILL.md +77 -0
  23. package/skills/gog/SKILL.md +116 -0
  24. package/skills/goplaces/SKILL.md +52 -0
  25. package/skills/healthcheck/SKILL.md +245 -0
  26. package/skills/himalaya/SKILL.md +257 -0
  27. package/skills/himalaya/references/configuration.md +184 -0
  28. package/skills/himalaya/references/message-composition.md +199 -0
  29. package/skills/imsg/SKILL.md +74 -0
  30. package/skills/local-places/SERVER_README.md +101 -0
  31. package/skills/local-places/SKILL.md +102 -0
  32. package/skills/local-places/pyproject.toml +21 -0
  33. package/skills/local-places/src/local_places/__init__.py +2 -0
  34. package/skills/local-places/src/local_places/google_places.py +314 -0
  35. package/skills/local-places/src/local_places/main.py +65 -0
  36. package/skills/local-places/src/local_places/schemas.py +107 -0
  37. package/skills/mcporter/SKILL.md +61 -0
  38. package/skills/model-usage/SKILL.md +69 -0
  39. package/skills/model-usage/references/codexbar-cli.md +33 -0
  40. package/skills/model-usage/scripts/model_usage.py +310 -0
  41. package/skills/nano-banana-pro/SKILL.md +58 -0
  42. package/skills/nano-banana-pro/scripts/generate_image.py +184 -0
  43. package/skills/nano-pdf/SKILL.md +38 -0
  44. package/skills/notion/SKILL.md +172 -0
  45. package/skills/obsidian/SKILL.md +81 -0
  46. package/skills/openai-image-gen/SKILL.md +89 -0
  47. package/skills/openai-image-gen/scripts/gen.py +240 -0
  48. package/skills/openai-whisper/SKILL.md +38 -0
  49. package/skills/openai-whisper-api/SKILL.md +52 -0
  50. package/skills/openai-whisper-api/scripts/transcribe.sh +85 -0
  51. package/skills/openhue/SKILL.md +51 -0
  52. package/skills/oracle/SKILL.md +125 -0
  53. package/skills/ordercli/SKILL.md +78 -0
  54. package/skills/peekaboo/SKILL.md +190 -0
  55. package/skills/sag/SKILL.md +87 -0
  56. package/skills/security-ask-questions-if-underspecified/.claude-plugin/plugin.json +10 -0
  57. package/skills/security-ask-questions-if-underspecified/README.md +24 -0
  58. package/skills/security-ask-questions-if-underspecified/skills/ask-questions-if-underspecified/SKILL.md +85 -0
  59. package/skills/security-audit-context-building/.claude-plugin/plugin.json +10 -0
  60. package/skills/security-audit-context-building/README.md +58 -0
  61. package/skills/security-audit-context-building/commands/audit-context.md +21 -0
  62. package/skills/security-audit-context-building/skills/audit-context-building/SKILL.md +297 -0
  63. package/skills/security-audit-context-building/skills/audit-context-building/resources/COMPLETENESS_CHECKLIST.md +47 -0
  64. package/skills/security-audit-context-building/skills/audit-context-building/resources/FUNCTION_MICRO_ANALYSIS_EXAMPLE.md +355 -0
  65. package/skills/security-audit-context-building/skills/audit-context-building/resources/OUTPUT_REQUIREMENTS.md +71 -0
  66. package/skills/security-building-secure-contracts/.claude-plugin/plugin.json +10 -0
  67. package/skills/security-building-secure-contracts/README.md +241 -0
  68. package/skills/security-building-secure-contracts/skills/algorand-vulnerability-scanner/SKILL.md +284 -0
  69. package/skills/security-building-secure-contracts/skills/algorand-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +405 -0
  70. package/skills/security-building-secure-contracts/skills/audit-prep-assistant/SKILL.md +409 -0
  71. package/skills/security-building-secure-contracts/skills/cairo-vulnerability-scanner/SKILL.md +329 -0
  72. package/skills/security-building-secure-contracts/skills/cairo-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +722 -0
  73. package/skills/security-building-secure-contracts/skills/code-maturity-assessor/SKILL.md +218 -0
  74. package/skills/security-building-secure-contracts/skills/code-maturity-assessor/resources/ASSESSMENT_CRITERIA.md +355 -0
  75. package/skills/security-building-secure-contracts/skills/code-maturity-assessor/resources/EXAMPLE_REPORT.md +248 -0
  76. package/skills/security-building-secure-contracts/skills/code-maturity-assessor/resources/REPORT_FORMAT.md +33 -0
  77. package/skills/security-building-secure-contracts/skills/cosmos-vulnerability-scanner/SKILL.md +334 -0
  78. package/skills/security-building-secure-contracts/skills/cosmos-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +740 -0
  79. package/skills/security-building-secure-contracts/skills/guidelines-advisor/SKILL.md +252 -0
  80. package/skills/security-building-secure-contracts/skills/guidelines-advisor/resources/ASSESSMENT_AREAS.md +329 -0
  81. package/skills/security-building-secure-contracts/skills/guidelines-advisor/resources/DELIVERABLES.md +118 -0
  82. package/skills/security-building-secure-contracts/skills/guidelines-advisor/resources/EXAMPLE_REPORT.md +298 -0
  83. package/skills/security-building-secure-contracts/skills/secure-workflow-guide/SKILL.md +161 -0
  84. package/skills/security-building-secure-contracts/skills/secure-workflow-guide/resources/EXAMPLE_REPORT.md +279 -0
  85. package/skills/security-building-secure-contracts/skills/secure-workflow-guide/resources/WORKFLOW_STEPS.md +132 -0
  86. package/skills/security-building-secure-contracts/skills/solana-vulnerability-scanner/SKILL.md +389 -0
  87. package/skills/security-building-secure-contracts/skills/solana-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +669 -0
  88. package/skills/security-building-secure-contracts/skills/substrate-vulnerability-scanner/SKILL.md +298 -0
  89. package/skills/security-building-secure-contracts/skills/substrate-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +791 -0
  90. package/skills/security-building-secure-contracts/skills/token-integration-analyzer/SKILL.md +362 -0
  91. package/skills/security-building-secure-contracts/skills/token-integration-analyzer/resources/ASSESSMENT_CATEGORIES.md +571 -0
  92. package/skills/security-building-secure-contracts/skills/token-integration-analyzer/resources/REPORT_TEMPLATES.md +141 -0
  93. package/skills/security-building-secure-contracts/skills/ton-vulnerability-scanner/SKILL.md +388 -0
  94. package/skills/security-building-secure-contracts/skills/ton-vulnerability-scanner/resources/VULNERABILITY_PATTERNS.md +595 -0
  95. package/skills/security-burpsuite-project-parser/.claude-plugin/plugin.json +10 -0
  96. package/skills/security-burpsuite-project-parser/README.md +103 -0
  97. package/skills/security-burpsuite-project-parser/commands/burp-search.md +18 -0
  98. package/skills/security-burpsuite-project-parser/skills/SKILL.md +358 -0
  99. package/skills/security-burpsuite-project-parser/skills/scripts/burp-search.sh +99 -0
  100. package/skills/security-claude-in-chrome-troubleshooting/.claude-plugin/plugin.json +8 -0
  101. package/skills/security-claude-in-chrome-troubleshooting/README.md +31 -0
  102. package/skills/security-claude-in-chrome-troubleshooting/skills/claude-in-chrome-troubleshooting/SKILL.md +251 -0
  103. package/skills/security-constant-time-analysis/.claude-plugin/plugin.json +9 -0
  104. package/skills/security-constant-time-analysis/README.md +381 -0
  105. package/skills/security-constant-time-analysis/commands/ct-check.md +20 -0
  106. package/skills/security-constant-time-analysis/ct_analyzer/__init__.py +49 -0
  107. package/skills/security-constant-time-analysis/ct_analyzer/analyzer.py +1284 -0
  108. package/skills/security-constant-time-analysis/ct_analyzer/script_analyzers.py +3081 -0
  109. package/skills/security-constant-time-analysis/ct_analyzer/tests/__init__.py +1 -0
  110. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_analyzer.py +1397 -0
  111. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/bn_excerpt.js +205 -0
  112. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/decompose_constant_time.c +181 -0
  113. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/decompose_vulnerable.c +74 -0
  114. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/decompose_vulnerable.go +78 -0
  115. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/decompose_vulnerable.rs +92 -0
  116. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.cs +174 -0
  117. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.java +161 -0
  118. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.kt +181 -0
  119. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.php +140 -0
  120. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.py +252 -0
  121. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.rb +188 -0
  122. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.swift +199 -0
  123. package/skills/security-constant-time-analysis/ct_analyzer/tests/test_samples/vulnerable.ts +154 -0
  124. package/skills/security-constant-time-analysis/pyproject.toml +52 -0
  125. package/skills/security-constant-time-analysis/skills/constant-time-analysis/README.md +90 -0
  126. package/skills/security-constant-time-analysis/skills/constant-time-analysis/SKILL.md +219 -0
  127. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/compiled.md +129 -0
  128. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/javascript.md +136 -0
  129. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/kotlin.md +252 -0
  130. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/php.md +172 -0
  131. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/python.md +179 -0
  132. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/ruby.md +198 -0
  133. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/swift.md +288 -0
  134. package/skills/security-constant-time-analysis/skills/constant-time-analysis/references/vm-compiled.md +354 -0
  135. package/skills/security-constant-time-analysis/uv.lock +8 -0
  136. package/skills/security-culture-index/.claude-plugin/plugin.json +8 -0
  137. package/skills/security-culture-index/README.md +79 -0
  138. package/skills/security-culture-index/skills/interpreting-culture-index/SKILL.md +293 -0
  139. package/skills/security-culture-index/skills/interpreting-culture-index/references/anti-patterns.md +255 -0
  140. package/skills/security-culture-index/skills/interpreting-culture-index/references/conversation-starters.md +408 -0
  141. package/skills/security-culture-index/skills/interpreting-culture-index/references/interview-trait-signals.md +253 -0
  142. package/skills/security-culture-index/skills/interpreting-culture-index/references/motivators.md +158 -0
  143. package/skills/security-culture-index/skills/interpreting-culture-index/references/patterns-archetypes.md +147 -0
  144. package/skills/security-culture-index/skills/interpreting-culture-index/references/primary-traits.md +307 -0
  145. package/skills/security-culture-index/skills/interpreting-culture-index/references/secondary-traits.md +228 -0
  146. package/skills/security-culture-index/skills/interpreting-culture-index/references/team-composition.md +148 -0
  147. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/check_deps.py +108 -0
  148. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/culture_index/__init__.py +20 -0
  149. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/culture_index/constants.py +122 -0
  150. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/culture_index/extract.py +187 -0
  151. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/culture_index/models.py +16 -0
  152. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/culture_index/opencv_extractor.py +520 -0
  153. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/extract_pdf.py +237 -0
  154. package/skills/security-culture-index/skills/interpreting-culture-index/scripts/pyproject.toml +18 -0
  155. package/skills/security-culture-index/skills/interpreting-culture-index/templates/burnout-report.md +113 -0
  156. package/skills/security-culture-index/skills/interpreting-culture-index/templates/comparison-report.md +103 -0
  157. package/skills/security-culture-index/skills/interpreting-culture-index/templates/hiring-profile.md +127 -0
  158. package/skills/security-culture-index/skills/interpreting-culture-index/templates/individual-report.md +85 -0
  159. package/skills/security-culture-index/skills/interpreting-culture-index/templates/predicted-profile.md +165 -0
  160. package/skills/security-culture-index/skills/interpreting-culture-index/templates/team-report.md +109 -0
  161. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/analyze-team.md +188 -0
  162. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/coach-manager.md +267 -0
  163. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/compare-profiles.md +188 -0
  164. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/define-hiring-profile.md +220 -0
  165. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/detect-burnout.md +206 -0
  166. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/extract-from-pdf.md +121 -0
  167. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/interpret-individual.md +183 -0
  168. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/interview-debrief.md +234 -0
  169. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/mediate-conflict.md +306 -0
  170. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/plan-onboarding.md +322 -0
  171. package/skills/security-culture-index/skills/interpreting-culture-index/workflows/predict-from-interview.md +250 -0
  172. package/skills/security-differential-review/.claude-plugin/plugin.json +10 -0
  173. package/skills/security-differential-review/README.md +109 -0
  174. package/skills/security-differential-review/commands/diff-review.md +21 -0
  175. package/skills/security-differential-review/skills/differential-review/SKILL.md +220 -0
  176. package/skills/security-differential-review/skills/differential-review/adversarial.md +203 -0
  177. package/skills/security-differential-review/skills/differential-review/methodology.md +234 -0
  178. package/skills/security-differential-review/skills/differential-review/patterns.md +300 -0
  179. package/skills/security-differential-review/skills/differential-review/reporting.md +369 -0
  180. package/skills/security-dwarf-expert/.claude-plugin/plugin.json +10 -0
  181. package/skills/security-dwarf-expert/README.md +38 -0
  182. package/skills/security-dwarf-expert/skills/dwarf-expert/SKILL.md +93 -0
  183. package/skills/security-dwarf-expert/skills/dwarf-expert/reference/coding.md +31 -0
  184. package/skills/security-dwarf-expert/skills/dwarf-expert/reference/dwarfdump.md +50 -0
  185. package/skills/security-dwarf-expert/skills/dwarf-expert/reference/readelf.md +8 -0
  186. package/skills/security-entry-point-analyzer/.claude-plugin/plugin.json +10 -0
  187. package/skills/security-entry-point-analyzer/README.md +74 -0
  188. package/skills/security-entry-point-analyzer/commands/entry-points.md +18 -0
  189. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/SKILL.md +251 -0
  190. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/cosmwasm.md +182 -0
  191. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/move-aptos.md +107 -0
  192. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/move-sui.md +87 -0
  193. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/solana.md +155 -0
  194. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/solidity.md +135 -0
  195. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/ton.md +185 -0
  196. package/skills/security-entry-point-analyzer/skills/entry-point-analyzer/references/vyper.md +141 -0
  197. package/skills/security-firebase-apk-scanner/.claude-plugin/plugin.json +10 -0
  198. package/skills/security-firebase-apk-scanner/README.md +85 -0
  199. package/skills/security-firebase-apk-scanner/commands/scan-apk.md +18 -0
  200. package/skills/security-firebase-apk-scanner/scanner.sh +1408 -0
  201. package/skills/security-firebase-apk-scanner/skills/firebase-apk-scanner/SKILL.md +197 -0
  202. package/skills/security-firebase-apk-scanner/skills/firebase-apk-scanner/references/vulnerabilities.md +803 -0
  203. package/skills/security-fix-review/.claude-plugin/plugin.json +13 -0
  204. package/skills/security-fix-review/README.md +118 -0
  205. package/skills/security-fix-review/commands/fix-review.md +24 -0
  206. package/skills/security-fix-review/skills/fix-review/SKILL.md +264 -0
  207. package/skills/security-fix-review/skills/fix-review/references/bug-detection.md +408 -0
  208. package/skills/security-fix-review/skills/fix-review/references/finding-matching.md +298 -0
  209. package/skills/security-fix-review/skills/fix-review/references/report-parsing.md +398 -0
  210. package/skills/security-insecure-defaults/.claude-plugin/plugin.json +10 -0
  211. package/skills/security-insecure-defaults/README.md +45 -0
  212. package/skills/security-insecure-defaults/skills/insecure-defaults/SKILL.md +117 -0
  213. package/skills/security-insecure-defaults/skills/insecure-defaults/references/examples.md +409 -0
  214. package/skills/security-modern-python/.claude-plugin/plugin.json +10 -0
  215. package/skills/security-modern-python/README.md +58 -0
  216. package/skills/security-modern-python/hooks/hooks.json +16 -0
  217. package/skills/security-modern-python/hooks/intercept-legacy-python.bats +388 -0
  218. package/skills/security-modern-python/hooks/intercept-legacy-python.sh +109 -0
  219. package/skills/security-modern-python/hooks/test_helper.bash +75 -0
  220. package/skills/security-modern-python/skills/modern-python/SKILL.md +333 -0
  221. package/skills/security-modern-python/skills/modern-python/references/dependabot.md +43 -0
  222. package/skills/security-modern-python/skills/modern-python/references/migration-checklist.md +141 -0
  223. package/skills/security-modern-python/skills/modern-python/references/pep723-scripts.md +259 -0
  224. package/skills/security-modern-python/skills/modern-python/references/prek.md +211 -0
  225. package/skills/security-modern-python/skills/modern-python/references/pyproject.md +254 -0
  226. package/skills/security-modern-python/skills/modern-python/references/ruff-config.md +240 -0
  227. package/skills/security-modern-python/skills/modern-python/references/security-setup.md +255 -0
  228. package/skills/security-modern-python/skills/modern-python/references/testing.md +284 -0
  229. package/skills/security-modern-python/skills/modern-python/references/uv-commands.md +200 -0
  230. package/skills/security-modern-python/skills/modern-python/templates/dependabot.yml +36 -0
  231. package/skills/security-modern-python/skills/modern-python/templates/pre-commit-config.yaml +66 -0
  232. package/skills/security-property-based-testing/.claude-plugin/plugin.json +9 -0
  233. package/skills/security-property-based-testing/README.md +47 -0
  234. package/skills/security-property-based-testing/skills/property-based-testing/README.md +88 -0
  235. package/skills/security-property-based-testing/skills/property-based-testing/SKILL.md +109 -0
  236. package/skills/security-property-based-testing/skills/property-based-testing/references/design.md +191 -0
  237. package/skills/security-property-based-testing/skills/property-based-testing/references/generating.md +200 -0
  238. package/skills/security-property-based-testing/skills/property-based-testing/references/libraries.md +130 -0
  239. package/skills/security-property-based-testing/skills/property-based-testing/references/refactoring.md +181 -0
  240. package/skills/security-property-based-testing/skills/property-based-testing/references/reviewing.md +209 -0
  241. package/skills/security-property-based-testing/skills/property-based-testing/references/strategies.md +124 -0
  242. package/skills/semgrep-rule-creator/.claude-plugin/plugin.json +8 -0
  243. package/skills/semgrep-rule-creator/README.md +43 -0
  244. package/skills/semgrep-rule-creator/commands/semgrep-rule.md +26 -0
  245. package/skills/semgrep-rule-creator/skills/semgrep-rule-creator/SKILL.md +168 -0
  246. package/skills/semgrep-rule-creator/skills/semgrep-rule-creator/references/quick-reference.md +203 -0
  247. package/skills/semgrep-rule-creator/skills/semgrep-rule-creator/references/workflow.md +240 -0
  248. package/skills/semgrep-rule-variant-creator/.claude-plugin/plugin.json +9 -0
  249. package/skills/semgrep-rule-variant-creator/README.md +86 -0
  250. package/skills/semgrep-rule-variant-creator/skills/semgrep-rule-variant-creator/SKILL.md +205 -0
  251. package/skills/semgrep-rule-variant-creator/skills/semgrep-rule-variant-creator/references/applicability-analysis.md +250 -0
  252. package/skills/semgrep-rule-variant-creator/skills/semgrep-rule-variant-creator/references/language-syntax-guide.md +324 -0
  253. package/skills/semgrep-rule-variant-creator/skills/semgrep-rule-variant-creator/references/workflow.md +518 -0
  254. package/skills/session-logs/SKILL.md +115 -0
  255. package/skills/sharp-edges/.claude-plugin/plugin.json +10 -0
  256. package/skills/sharp-edges/README.md +48 -0
  257. package/skills/sharp-edges/skills/sharp-edges/SKILL.md +292 -0
  258. package/skills/sharp-edges/skills/sharp-edges/references/auth-patterns.md +252 -0
  259. package/skills/sharp-edges/skills/sharp-edges/references/case-studies.md +274 -0
  260. package/skills/sharp-edges/skills/sharp-edges/references/config-patterns.md +333 -0
  261. package/skills/sharp-edges/skills/sharp-edges/references/crypto-apis.md +190 -0
  262. package/skills/sharp-edges/skills/sharp-edges/references/lang-c.md +205 -0
  263. package/skills/sharp-edges/skills/sharp-edges/references/lang-csharp.md +285 -0
  264. package/skills/sharp-edges/skills/sharp-edges/references/lang-go.md +270 -0
  265. package/skills/sharp-edges/skills/sharp-edges/references/lang-java.md +263 -0
  266. package/skills/sharp-edges/skills/sharp-edges/references/lang-javascript.md +269 -0
  267. package/skills/sharp-edges/skills/sharp-edges/references/lang-kotlin.md +265 -0
  268. package/skills/sharp-edges/skills/sharp-edges/references/lang-php.md +245 -0
  269. package/skills/sharp-edges/skills/sharp-edges/references/lang-python.md +274 -0
  270. package/skills/sharp-edges/skills/sharp-edges/references/lang-ruby.md +273 -0
  271. package/skills/sharp-edges/skills/sharp-edges/references/lang-rust.md +272 -0
  272. package/skills/sharp-edges/skills/sharp-edges/references/lang-swift.md +287 -0
  273. package/skills/sharp-edges/skills/sharp-edges/references/language-specific.md +588 -0
  274. package/skills/sherpa-onnx-tts/SKILL.md +103 -0
  275. package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
  276. package/skills/skill-creator/SKILL.md +370 -0
  277. package/skills/skill-creator/license.txt +202 -0
  278. package/skills/skill-creator/scripts/init_skill.py +378 -0
  279. package/skills/skill-creator/scripts/package_skill.py +111 -0
  280. package/skills/skill-creator/scripts/quick_validate.py +101 -0
  281. package/skills/slack/SKILL.md +144 -0
  282. package/skills/songsee/SKILL.md +49 -0
  283. package/skills/sonoscli/SKILL.md +46 -0
  284. package/skills/spec-to-code-compliance/.claude-plugin/plugin.json +10 -0
  285. package/skills/spec-to-code-compliance/README.md +67 -0
  286. package/skills/spec-to-code-compliance/commands/spec-compliance.md +22 -0
  287. package/skills/spec-to-code-compliance/skills/spec-to-code-compliance/SKILL.md +349 -0
  288. package/skills/spec-to-code-compliance/skills/spec-to-code-compliance/resources/COMPLETENESS_CHECKLIST.md +69 -0
  289. package/skills/spec-to-code-compliance/skills/spec-to-code-compliance/resources/IR_EXAMPLES.md +417 -0
  290. package/skills/spec-to-code-compliance/skills/spec-to-code-compliance/resources/OUTPUT_REQUIREMENTS.md +105 -0
  291. package/skills/spotify-player/SKILL.md +64 -0
  292. package/skills/static-analysis/.claude-plugin/plugin.json +8 -0
  293. package/skills/static-analysis/README.md +59 -0
  294. package/skills/static-analysis/skills/codeql/SKILL.md +315 -0
  295. package/skills/static-analysis/skills/sarif-parsing/SKILL.md +479 -0
  296. package/skills/static-analysis/skills/sarif-parsing/resources/jq-queries.md +162 -0
  297. package/skills/static-analysis/skills/sarif-parsing/resources/sarif_helpers.py +331 -0
  298. package/skills/static-analysis/skills/semgrep/SKILL.md +337 -0
  299. package/skills/summarize/SKILL.md +87 -0
  300. package/skills/testing-handbook-skills/.claude-plugin/plugin.json +8 -0
  301. package/skills/testing-handbook-skills/README.md +241 -0
  302. package/skills/testing-handbook-skills/scripts/pyproject.toml +8 -0
  303. package/skills/testing-handbook-skills/scripts/validate-skills.py +657 -0
  304. package/skills/testing-handbook-skills/skills/address-sanitizer/SKILL.md +341 -0
  305. package/skills/testing-handbook-skills/skills/aflpp/SKILL.md +640 -0
  306. package/skills/testing-handbook-skills/skills/atheris/SKILL.md +515 -0
  307. package/skills/testing-handbook-skills/skills/cargo-fuzz/SKILL.md +454 -0
  308. package/skills/testing-handbook-skills/skills/codeql/SKILL.md +549 -0
  309. package/skills/testing-handbook-skills/skills/constant-time-testing/SKILL.md +507 -0
  310. package/skills/testing-handbook-skills/skills/coverage-analysis/SKILL.md +607 -0
  311. package/skills/testing-handbook-skills/skills/fuzzing-dictionary/SKILL.md +297 -0
  312. package/skills/testing-handbook-skills/skills/fuzzing-obstacles/SKILL.md +426 -0
  313. package/skills/testing-handbook-skills/skills/harness-writing/SKILL.md +614 -0
  314. package/skills/testing-handbook-skills/skills/libafl/SKILL.md +625 -0
  315. package/skills/testing-handbook-skills/skills/libfuzzer/SKILL.md +795 -0
  316. package/skills/testing-handbook-skills/skills/ossfuzz/SKILL.md +426 -0
  317. package/skills/testing-handbook-skills/skills/ruzzy/SKILL.md +443 -0
  318. package/skills/testing-handbook-skills/skills/semgrep/SKILL.md +601 -0
  319. package/skills/testing-handbook-skills/skills/testing-handbook-generator/SKILL.md +372 -0
  320. package/skills/testing-handbook-skills/skills/testing-handbook-generator/agent-prompt.md +280 -0
  321. package/skills/testing-handbook-skills/skills/testing-handbook-generator/discovery.md +452 -0
  322. package/skills/testing-handbook-skills/skills/testing-handbook-generator/templates/domain-skill.md +504 -0
  323. package/skills/testing-handbook-skills/skills/testing-handbook-generator/templates/fuzzer-skill.md +454 -0
  324. package/skills/testing-handbook-skills/skills/testing-handbook-generator/templates/technique-skill.md +527 -0
  325. package/skills/testing-handbook-skills/skills/testing-handbook-generator/templates/tool-skill.md +366 -0
  326. package/skills/testing-handbook-skills/skills/testing-handbook-generator/testing.md +482 -0
  327. package/skills/testing-handbook-skills/skills/wycheproof/SKILL.md +533 -0
  328. package/skills/things-mac/SKILL.md +86 -0
  329. package/skills/tmux/SKILL.md +135 -0
  330. package/skills/tmux/scripts/find-sessions.sh +112 -0
  331. package/skills/tmux/scripts/wait-for-text.sh +83 -0
  332. package/skills/trello/SKILL.md +95 -0
  333. package/skills/variant-analysis/.claude-plugin/plugin.json +8 -0
  334. package/skills/variant-analysis/README.md +41 -0
  335. package/skills/variant-analysis/commands/variants.md +23 -0
  336. package/skills/variant-analysis/skills/variant-analysis/METHODOLOGY.md +327 -0
  337. package/skills/variant-analysis/skills/variant-analysis/SKILL.md +142 -0
  338. package/skills/variant-analysis/skills/variant-analysis/resources/codeql/cpp.ql +119 -0
  339. package/skills/variant-analysis/skills/variant-analysis/resources/codeql/go.ql +69 -0
  340. package/skills/variant-analysis/skills/variant-analysis/resources/codeql/java.ql +71 -0
  341. package/skills/variant-analysis/skills/variant-analysis/resources/codeql/javascript.ql +63 -0
  342. package/skills/variant-analysis/skills/variant-analysis/resources/codeql/python.ql +80 -0
  343. package/skills/variant-analysis/skills/variant-analysis/resources/semgrep/cpp.yaml +98 -0
  344. package/skills/variant-analysis/skills/variant-analysis/resources/semgrep/go.yaml +63 -0
  345. package/skills/variant-analysis/skills/variant-analysis/resources/semgrep/java.yaml +61 -0
  346. package/skills/variant-analysis/skills/variant-analysis/resources/semgrep/javascript.yaml +60 -0
  347. package/skills/variant-analysis/skills/variant-analysis/resources/semgrep/python.yaml +72 -0
  348. package/skills/variant-analysis/skills/variant-analysis/resources/variant-report-template.md +75 -0
  349. package/skills/video-frames/SKILL.md +46 -0
  350. package/skills/video-frames/scripts/frame.sh +81 -0
  351. package/skills/voice-call/SKILL.md +45 -0
  352. package/skills/wacli/SKILL.md +72 -0
  353. package/skills/weather/SKILL.md +54 -0
  354. package/skills/yara-authoring/.claude-plugin/plugin.json +9 -0
  355. package/skills/yara-authoring/README.md +131 -0
  356. package/skills/yara-authoring/skills/yara-rule-authoring/SKILL.md +645 -0
  357. package/skills/yara-authoring/skills/yara-rule-authoring/examples/MAL_Mac_ProtonRAT_Jan25.yar +99 -0
  358. package/skills/yara-authoring/skills/yara-rule-authoring/examples/MAL_NPM_SupplyChain_Jan25.yar +170 -0
  359. package/skills/yara-authoring/skills/yara-rule-authoring/examples/MAL_Win_Remcos_Jan25.yar +103 -0
  360. package/skills/yara-authoring/skills/yara-rule-authoring/examples/SUSP_CRX_SuspiciousPermissions.yar +134 -0
  361. package/skills/yara-authoring/skills/yara-rule-authoring/examples/SUSP_JS_Obfuscation_Jan25.yar +185 -0
  362. package/skills/yara-authoring/skills/yara-rule-authoring/references/crx-module.md +214 -0
  363. package/skills/yara-authoring/skills/yara-rule-authoring/references/dex-module.md +383 -0
  364. package/skills/yara-authoring/skills/yara-rule-authoring/references/performance.md +333 -0
  365. package/skills/yara-authoring/skills/yara-rule-authoring/references/strings.md +433 -0
  366. package/skills/yara-authoring/skills/yara-rule-authoring/references/style-guide.md +257 -0
  367. package/skills/yara-authoring/skills/yara-rule-authoring/references/testing.md +399 -0
  368. package/skills/yara-authoring/skills/yara-rule-authoring/scripts/atom_analyzer.py +526 -0
  369. package/skills/yara-authoring/skills/yara-rule-authoring/scripts/pyproject.toml +25 -0
  370. package/skills/yara-authoring/skills/yara-rule-authoring/scripts/yara_lint.py +631 -0
  371. package/skills/yara-authoring/skills/yara-rule-authoring/workflows/rule-development.md +493 -0
@@ -0,0 +1,26 @@
1
+ ---
2
+ name: trailofbits:semgrep-rule
3
+ description: Creates Semgrep rules with test-first methodology
4
+ argument-hint: "(uses conversation context for detection pattern)"
5
+ allowed-tools:
6
+ - Bash
7
+ - Read
8
+ - Write
9
+ - Edit
10
+ - Glob
11
+ - Grep
12
+ - WebFetch
13
+ ---
14
+
15
+ # Create Semgrep Rule
16
+
17
+ **Arguments:** $ARGUMENTS
18
+
19
+ This command is context-driven. Use conversation context to understand:
20
+ 1. The vulnerability or pattern to detect
21
+ 2. The target language
22
+ 3. Whether taint mode is appropriate
23
+
24
+ If context is unclear, ask for a description of the pattern to detect.
25
+
26
+ Invoke the `semgrep-rule-creator` skill for the full workflow.
@@ -0,0 +1,168 @@
1
+ ---
2
+ name: semgrep-rule-creator
3
+ description: Creates custom Semgrep rules for detecting security vulnerabilities, bug patterns, and code patterns. Use when writing Semgrep rules or building custom static analysis detections.
4
+ allowed-tools:
5
+ - Bash
6
+ - Read
7
+ - Write
8
+ - Edit
9
+ - Glob
10
+ - Grep
11
+ - WebFetch
12
+ ---
13
+
14
+ # Semgrep Rule Creator
15
+
16
+ Create production-quality Semgrep rules with proper testing and validation.
17
+
18
+ ## When to Use
19
+
20
+ **Ideal scenarios:**
21
+ - Writing Semgrep rules for specific bug patterns
22
+ - Writing rules to detect security vulnerabilities in your codebase
23
+ - Writing taint mode rules for data flow vulnerabilities
24
+ - Writing rules to enforce coding standards
25
+
26
+ ## When NOT to Use
27
+
28
+ Do NOT use this skill for:
29
+ - Running existing Semgrep rulesets
30
+ - General static analysis without custom rules (use `static-analysis` skill)
31
+
32
+ ## Rationalizations to Reject
33
+
34
+ When writing Semgrep rules, reject these common shortcuts:
35
+
36
+ - **"The pattern looks complete"** → Still run `semgrep --test --config <rule-id>.yaml <rule-id>.<ext>` to verify. Untested rules have hidden false positives/negatives.
37
+ - **"It matches the vulnerable case"** → Matching vulnerabilities is half the job. Verify safe cases don't match (false positives break trust).
38
+ - **"Taint mode is overkill for this"** → If data flows from user input to a dangerous sink, taint mode gives better precision than pattern matching.
39
+ - **"One test is enough"** → Include edge cases: different coding styles, sanitized inputs, safe alternatives, and boundary conditions.
40
+ - **"I'll optimize the patterns first"** → Write correct patterns first, optimize after all tests pass. Premature optimization causes regressions.
41
+ - **"The AST dump is too complex"** → The AST reveals exactly how Semgrep sees code. Skipping it leads to patterns that miss syntactic variations.
42
+
43
+ ## Anti-Patterns
44
+
45
+ **Too broad** - matches everything, useless for detection:
46
+ ```yaml
47
+ # BAD: Matches any function call
48
+ pattern: $FUNC(...)
49
+
50
+ # GOOD: Specific dangerous function
51
+ pattern: eval(...)
52
+ ```
53
+
54
+ **Missing safe cases in tests** - leads to undetected false positives:
55
+ ```python
56
+ # BAD: Only tests vulnerable case
57
+ # ruleid: my-rule
58
+ dangerous(user_input)
59
+
60
+ # GOOD: Include safe cases to verify no false positives
61
+ # ruleid: my-rule
62
+ dangerous(user_input)
63
+
64
+ # ok: my-rule
65
+ dangerous(sanitize(user_input))
66
+
67
+ # ok: my-rule
68
+ dangerous("hardcoded_safe_value")
69
+ ```
70
+
71
+ **Overly specific patterns** - misses variations:
72
+ ```yaml
73
+ # BAD: Only matches exact format
74
+ pattern: os.system("rm " + $VAR)
75
+
76
+ # GOOD: Matches all os.system calls with taint tracking
77
+ mode: taint
78
+ pattern-sinks:
79
+ - pattern: os.system(...)
80
+ ```
81
+
82
+ ## Strictness Level
83
+
84
+ This workflow is **strict** - do not skip steps:
85
+ - **Read documentation first**: See [Documentation](#documentation) before writing Semgrep rules
86
+ - **Test-first is mandatory**: Never write a rule without tests
87
+ - **100% test pass is required**: "Most tests pass" is not acceptable
88
+ - **Optimization comes last**: Only simplify patterns after all tests pass
89
+ - **Avoid generic patterns**: Rules must be specific, not match broad patterns
90
+ - **Prioritize taint mode**: For data flow vulnerabilities
91
+ - **One YAML file - one Semgrep rule**: Each YAML file must contain only one Semgrep rule; don't combine multiple rules in a single file
92
+ - **No generic rules**: When targeting a specific language for Semgrep rules - avoid generic pattern matching (`languages: generic`)
93
+ - **Forbidden `todook` and `todoruleid` test annotations**: `todoruleid: <rule-id>` and `todook: <rule-id>` annotations in tests files for future rule improvements are forbidden
94
+
95
+ ## Overview
96
+
97
+ This skill guides creation of Semgrep rules that detect security vulnerabilities and code patterns. Rules are created iteratively: analyze the problem, write tests first, analyze AST structure, write the rule, iterate until all tests pass, optimize the rule.
98
+
99
+ **Approach selection:**
100
+ - **Taint mode** (prioritize): Data flow issues where untrusted input reaches dangerous sinks
101
+ - **Pattern matching**: Simple syntactic patterns without data flow requirements
102
+
103
+ **Why prioritize taint mode?** Pattern matching finds syntax but misses context. A pattern `eval($X)` matches both `eval(user_input)` (vulnerable) and `eval("safe_literal")` (safe). Taint mode tracks data flow, so it only alerts when untrusted data actually reaches the sink—dramatically reducing false positives for injection vulnerabilities.
104
+
105
+ **Iterating between approaches:** It's okay to experiment. If you start with taint mode and it's not working well (e.g., taint doesn't propagate as expected, too many false positives/negatives), switch to pattern matching. Conversely, if pattern matching produces too many false positives on safe cases, try taint mode instead. The goal is a working rule—not rigid adherence to one approach.
106
+
107
+ **Output structure** - exactly 2 files in a directory named after the rule-id:
108
+ ```
109
+ <rule-id>/
110
+ ├── <rule-id>.yaml # Semgrep rule
111
+ └── <rule-id>.<ext> # Test file with ruleid/ok annotations
112
+ ```
113
+
114
+ ## Quick Start
115
+
116
+ ```yaml
117
+ rules:
118
+ - id: insecure-eval
119
+ languages: [python]
120
+ severity: HIGH
121
+ message: User input passed to eval() allows code execution
122
+ mode: taint
123
+ pattern-sources:
124
+ - pattern: request.args.get(...)
125
+ pattern-sinks:
126
+ - pattern: eval(...)
127
+ ```
128
+
129
+ Test file (`insecure-eval.py`):
130
+ ```python
131
+ # ruleid: insecure-eval
132
+ eval(request.args.get('code'))
133
+
134
+ # ok: insecure-eval
135
+ eval("print('safe')")
136
+ ```
137
+
138
+ Run tests (from rule directory): `semgrep --test --config <rule-id>.yaml <rule-id>.<ext>`
139
+
140
+ ## Quick Reference
141
+
142
+ - For commands, pattern operators, and taint mode syntax, see [quick-reference.md]({baseDir}/references/quick-reference.md).
143
+ - For detailed workflow and examples, you MUST see [workflow.md]({baseDir}/references/workflow.md)
144
+
145
+ ## Workflow
146
+
147
+ Copy this checklist and track progress:
148
+
149
+ ```
150
+ Semgrep Rule Progress:
151
+ - [ ] Step 1: Analyze the Problem
152
+ - [ ] Step 2: Write Tests First
153
+ - [ ] Step 3: Analyze AST structure
154
+ - [ ] Step 4: Write the rule
155
+ - [ ] Step 5: Iterate until all tests pass (semgrep --test)
156
+ - [ ] Step 6: Optimize the rule (remove redundancies, re-test)
157
+ - [ ] Step 7: Final Run
158
+ ```
159
+
160
+ ## Documentation
161
+
162
+ **REQUIRED**: Before writing any rule, use WebFetch to read **all** of these 4 links with Semgrep documentation:
163
+
164
+ 1. [Rule Syntax](https://semgrep.dev/docs/writing-rules/rule-syntax)
165
+ 2. [Pattern Syntax](https://semgrep.dev/docs/writing-rules/pattern-syntax)
166
+ 3. [ToB Testing Handbook - Semgrep](https://appsec.guide/docs/static-analysis/semgrep/advanced/)
167
+ 4. [Constant propagation](https://semgrep.dev/docs/writing-rules/data-flow/constant-propagation)
168
+ 5. [Writing Rules Index](https://github.com/semgrep/semgrep-docs/tree/main/docs/writing-rules/)
@@ -0,0 +1,203 @@
1
+ # Semgrep Rule Quick Reference
2
+
3
+ ## Required Rule Fields
4
+
5
+ ```yaml
6
+ rules:
7
+ - id: rule-id # Unique identifier (lowercase, hyphens)
8
+ languages: # Target language(s)
9
+ - python
10
+ severity: HIGH # LOW, MEDIUM, HIGH, CRITICAL (ERROR/WARNING/INFO are legacy)
11
+ message: Description # Shown when rule matches
12
+ pattern: code(...) # OR use patterns/pattern-either/mode:taint
13
+ ```
14
+
15
+ ## Pattern Operators
16
+
17
+ ### Basic Matching
18
+ ```yaml
19
+ pattern: foo(...) # Match function call
20
+ patterns: # AND - all must match
21
+ - pattern: $X
22
+ - pattern-not: safe($X)
23
+ pattern-either: # OR - any can match
24
+ - pattern: foo(...)
25
+ - pattern: bar(...)
26
+ pattern-regex: ^foo.*bar$ # PCRE2 regex matching (multiline mode)
27
+ ```
28
+
29
+ ### Metavariables
30
+ - `$VAR` - Match any single expression
31
+ - **Must be uppercase**: `$X`, `$FUNC`, `$VAR_1` (NOT `$x`, `$var`)
32
+ - `$_` - Anonymous metavariable (matches but doesn't bind)
33
+ - `$...VAR` - Match zero or more arguments (ellipsis metavariable)
34
+ - `...` - Ellipsis, match anything in between
35
+
36
+ ### Typed Metavariables
37
+
38
+ Constrain metavariables to specific types (reduces false positives):
39
+
40
+ ```yaml
41
+ # C/C++ - match only int16_t parameters
42
+ pattern: (int16_t $X)
43
+
44
+ # C/C++ - match function with typed parameter
45
+ pattern: some_func((int $ARG))
46
+
47
+ # Java - match Logger type
48
+ pattern: (java.util.logging.Logger $LOGGER).log(...)
49
+
50
+ # Go - match pointer type (uses colon syntax)
51
+ pattern: ($READER : *zip.Reader).Open($INPUT)
52
+
53
+ # TypeScript - match specific type
54
+ pattern: ($X: DomSanitizer).sanitize(...)
55
+
56
+ Use in taint mode to track only specific types as sources:
57
+ pattern-sources:
58
+ - pattern: (int $X) # Only int parameters are taint sources
59
+ - pattern: (int16_t $X) # Only int16_t parameters
60
+ - pattern: int $X = $INIT; # Local variable declarations
61
+
62
+
63
+ ### Deep Expression Matching
64
+ ```yaml
65
+ <... $EXPR ...> # Recursively match pattern in nested expressions
66
+ ```
67
+
68
+ ### Scope Operators
69
+ ```yaml
70
+ pattern-inside: | # Must be inside this pattern
71
+ def $FUNC(...):
72
+ ...
73
+ pattern-not-inside: | # Must NOT be inside this pattern
74
+ with $CTX:
75
+ ...
76
+ ```
77
+
78
+ ### Negation
79
+ ```yaml
80
+ pattern-not: safe(...) # Exclude this pattern
81
+ pattern-not-regex: ^test_ # Exclude by regex
82
+ ```
83
+
84
+ ### Metavariable Filters
85
+ ```yaml
86
+ metavariable-regex:
87
+ metavariable: $FUNC
88
+ regex: (unsafe|dangerous).*
89
+
90
+ metavariable-pattern:
91
+ metavariable: $ARG
92
+ pattern: request.$X
93
+
94
+ metavariable-comparison:
95
+ metavariable: $NUM
96
+ comparison: $NUM > 1024
97
+ ```
98
+
99
+ ### Focus
100
+ ```yaml
101
+ focus-metavariable: $TARGET # Report finding on this metavariable only
102
+ ```
103
+
104
+ ## Taint Mode
105
+
106
+ ```yaml
107
+ rules:
108
+ - id: taint-rule
109
+ mode: taint
110
+ languages: [python]
111
+ severity: HIGH
112
+ message: Tainted data reaches sink
113
+ pattern-sources:
114
+ - pattern: user_input()
115
+ - pattern: request.args.get(...)
116
+ pattern-sinks:
117
+ - pattern: eval(...)
118
+ - pattern: os.system(...)
119
+ pattern-sanitizers: # Optional
120
+ - pattern: sanitize(...)
121
+ - pattern: escape(...)
122
+ ```
123
+
124
+ ### Taint Options
125
+ ```yaml
126
+ pattern-sources:
127
+ - pattern: source(...)
128
+ exact: true # Only exact match is source (default: false)
129
+ by-side-effect: true # Taints variable by side effect
130
+
131
+ pattern-sanitizers:
132
+ - pattern: sanitize($X)
133
+ exact: true # Only exact match (default: false)
134
+ by-side-effect: true # Sanitizes by side effect
135
+
136
+ pattern-sinks:
137
+ - pattern: sink(...)
138
+ exact: false # Subexpressions also sinks (default: true)
139
+ ```
140
+
141
+ ## Test File Annotations
142
+
143
+ Only allowed annotations are `ok: rule-id` and `ok: rule-id`.
144
+
145
+ ```python
146
+ # ruleid: rule-id
147
+ vulnerable_code() # This line MUST match
148
+
149
+ # ok: rule-id
150
+ safe_code() # This line MUST NOT match
151
+ ```
152
+
153
+ DO NOT use multi-line comments for test annotations, for example:
154
+ /* ruleid: ... */
155
+
156
+ ## Debugging Commands
157
+
158
+ ```bash
159
+ # Test rules
160
+ semgrep --test --config <rule-id>.yaml <rule-id>.<ext>
161
+
162
+ # Validate YAML syntax
163
+ semgrep --validate --config <rule-id>.yaml
164
+
165
+ # Run with dataflow traces (for taint mode rules)
166
+ semgrep --dataflow-traces -f <rule-id>.yaml <rule-id>.<ext>
167
+
168
+ # Dump AST to understand code structure
169
+ semgrep --dump-ast -l <language> <rule-id>.<ext>
170
+
171
+ # Run single rule
172
+ semgrep -f <rule-id>.yaml <rule-id>.<ext>
173
+ ```
174
+
175
+ ## Troubleshooting
176
+
177
+ ### Common Pitfalls
178
+
179
+ 1. **Wrong annotation line**: `ruleid:` must be on the line IMMEDIATELY BEFORE the finding. No other text or code
180
+ 2. **Too generic patterns**: Avoid `pattern: $X` without constraints
181
+ 3. **YAML syntax errors**: Validate with `semgrep --validate`
182
+
183
+ ### Pattern Not Matching
184
+
185
+ 1. Check AST structure: `semgrep --dump-ast -l <language> <rule-id>.<ext>`
186
+ 2. Verify metavariable binding
187
+ 3. Check for whitespace/formatting differences
188
+ 4. Try more general pattern first, then narrow down
189
+
190
+ ### Taint Not Propagating
191
+
192
+ 1. Use `--dataflow-traces` to see flow
193
+ 2. Check if sanitizer is too broad
194
+ 3. Verify source pattern matches
195
+ 4. Check sink focus-metavariable
196
+
197
+ ### Too Many False Positives
198
+
199
+ 1. Add `pattern-not` for safe cases
200
+ 2. Add sanitizers for validation functions
201
+ 3. Use `pattern-inside` to limit scope
202
+ 4. Use `metavariable-regex` to filter
203
+
@@ -0,0 +1,240 @@
1
+ # Semgrep Rule Creation Workflow
2
+
3
+ Detailed workflow for creating production-quality Semgrep rules.
4
+
5
+ ## Step 1: Analyze the Problem
6
+
7
+ Before writing any code:
8
+
9
+ 1. **Fetch external documentation**: See [Documentation](../SKILL.md#documentation) for required reading
10
+ 2. **Understand the exact bug pattern and explain the bug for a junior developer**: What vulnerability, issue or pattern should be detected?
11
+ 3. **Identify the target language**: What is specific about the bug and that language?
12
+ 4. **Determine the approach**:
13
+ - **Pattern matching**: Syntactic patterns without data flow
14
+ - **Taint mode**: Data flows from untrusted source to dangerous sink
15
+
16
+ ### When to Use Taint Mode
17
+
18
+ Taint mode is a powerful feature in Semgrep that can track the flow of data from one location to another. By using taint mode, you can:
19
+
20
+ - **Track data flow across multiple variables**: Trace how data moves across different variables, functions, components, and identify insecure flow paths (e.g., situations where a specific sanitizer is not used).
21
+ - **Find injection vulnerabilities**: Identify injection vulnerabilities such as SQL injection, command injection, and XSS attacks.
22
+ - **Write simple and resilient Semgrep rules**: Simplify rules that are resilient to code patterns nested in if statements, loops, and other structures.
23
+
24
+ ## Step 2: Write Tests First
25
+
26
+ **Why test-first?** Writing tests before the rule forces you to think about both vulnerable AND safe cases. Rules written without tests often have hidden false positives (matching safe cases) or false negatives (missing vulnerable variants). Tests make these visible immediately.
27
+
28
+ Create directory and test file with annotations (`# ruleid:`, `# ok:` only). See [quick-reference.md]({baseDir}/references/quick-reference.md#test-file-annotations) for full syntax.
29
+
30
+ ### Directory Structure
31
+
32
+ ```
33
+ <rule-id>/
34
+ ├── <rule-id>.yaml # Semgrep rule
35
+ └── <rule-id>.<ext> # Test file with ruleid/ok annotations
36
+ ```
37
+
38
+ **CRITICAL**:
39
+ 1. The comment (`# ruleid:` or `# ok:` ) must be on the line IMMEDIATELY BEFORE the code. Semgrep reports findings on the line after the annotation.
40
+ 2. The comment must contain ONLY the comment marker and annotation (e.g., `# ruleid: my-rule`). No other text, comments, or code on the same line.
41
+
42
+ ### Test Case Design
43
+
44
+ You must include test cases for:
45
+ - Clear vulnerable cases (must match)
46
+ - Clear safe cases (must not match)
47
+ - Edge cases and variations
48
+ - Different coding styles
49
+ - Sanitized/validated input (must not match)
50
+ - Unrelated code (must not match) - normal code with no relation to the rule's target pattern
51
+ - Nested structures (e.g., inside if statements, loops, try/catch blocks, callbacks)
52
+
53
+ ## Step 3: Analyze AST Structure
54
+
55
+ **Why analyze AST?** Semgrep matches against the AST, not raw text. Code that looks similar may parse differently (e.g., `foo.bar()` vs `foo().bar`). The AST dump shows exactly what Semgrep sees, preventing patterns that fail due to unexpected tree structure. Understanding how exactly Semgrep parses code is crucial for writing precise patterns.
56
+
57
+ ```bash
58
+ semgrep --dump-ast -l <language> <rule-id>.<ext>
59
+ ```
60
+
61
+ Example output helps understand:
62
+ - How function calls are represented
63
+ - How variables are bound
64
+ - How control flow is structured
65
+
66
+ ## Step 4: Write the Rule
67
+
68
+ Choose the appropriate pattern operators and write the rule.
69
+
70
+ For pattern operator syntax (basic matching, scope operators, metavariable filters, focus), see [quick-reference.md](quick-reference.md).
71
+
72
+ ### Validate and Test
73
+
74
+ #### Validate YAML Syntax
75
+
76
+ ```bash
77
+ semgrep --validate --config <rule-id>.yaml
78
+ ```
79
+
80
+ #### Run Tests
81
+
82
+ ```bash
83
+ cd <rule-directory>
84
+ semgrep --test --config <rule-id>.yaml <rule-id>.<ext>
85
+ ```
86
+
87
+ #### Expected Output
88
+
89
+ ```
90
+ 1/1: ✓ All tests passed
91
+ ```
92
+
93
+ #### Debug Failures
94
+
95
+ If tests fail, check:
96
+ 1. **Missed lines**: Rule didn't match when it should
97
+ - Pattern too specific
98
+ - Missing pattern variant
99
+ 2. **Incorrect lines**: Rule matched when it shouldn't
100
+ - Pattern too broad
101
+ - Need `pattern-not` exclusion
102
+
103
+ #### Debug Taint Mode Rules
104
+
105
+ ```bash
106
+ semgrep --dataflow-traces -f <rule-id>.yaml <rule-id>.<ext>
107
+ ```
108
+
109
+ Shows:
110
+ - Source locations
111
+ - Sink locations
112
+ - Data flow path
113
+ - Why taint didn't propagate (if applicable)
114
+
115
+ ## Step 5: Iterate Until Tests Pass
116
+ Work on writing Semgrep rule (patterns) iteratively to ensure the Semgrep rule works correctly.
117
+
118
+ Each time when you introduce any changes, test Semgrep rule:
119
+
120
+ ```bash
121
+ semgrep --test --config <rule-id>.yaml <rule-id>.<ext>
122
+ ```
123
+
124
+ For debugging taint mode rules:
125
+ ```bash
126
+ semgrep --dataflow-traces -f <rule-id>.yaml <rule-id>.<ext>
127
+ ```
128
+
129
+ **Verification checkpoint**: Output MUST show "All tests passed". **Only proceed when validation passes**.
130
+
131
+
132
+ **Verification checkpoint**: Proceed to Step 6: Optimize the Rule when:
133
+ - "All tests passed"
134
+ - No "missed lines" (false negatives)
135
+ - No "incorrect lines" (false positives)
136
+
137
+ ### Common Fixes
138
+
139
+ | Problem | Solution |
140
+ |---------|----------|
141
+ | Too many matches | Add `pattern-not` exclusions |
142
+ | Missing matches | Add `pattern-either` variants |
143
+ | Wrong line matched | Adjust `focus-metavariable` |
144
+ | Taint not flowing | Check sanitizers aren't too broad |
145
+ | Taint false positive | Add sanitizer pattern |
146
+
147
+ ## Step 6: Optimize the Rule
148
+
149
+ After all tests pass, remove redundant patterns (quote variants, ellipsis subsets, redundant patterns).
150
+
151
+ ### Semgrep Pattern Equivalences
152
+
153
+ Semgrep treats certain patterns as equivalent:
154
+
155
+ | Written | Also Matches | Reason |
156
+ |---------|--------------|--------|
157
+ | `"string"` | `'string'` | Quote style normalized (in languages where both are equivalent) |
158
+ | `func(...)` | `func()`, `func(a)`, `func(a,b)` | Ellipsis matches zero or more |
159
+ | `func($X, ...)` | `func($X)`, `func($X, a, b)` | Trailing ellipsis is optional |
160
+
161
+ ### Common Redundancies to Remove
162
+
163
+ **1. Quote Variants** (depends on the language)
164
+
165
+ Before:
166
+ ```yaml
167
+ pattern-either:
168
+ - pattern: hashlib.new("md5", ...)
169
+ - pattern: hashlib.new('md5', ...)
170
+ ```
171
+
172
+ After:
173
+ ```yaml
174
+ pattern-either:
175
+ - pattern: hashlib.new("md5", ...)
176
+ ```
177
+
178
+ **2. Ellipsis Subsets**
179
+
180
+ Before:
181
+ ```yaml
182
+ pattern-either:
183
+ - pattern: dangerous($X, ...)
184
+ - pattern: dangerous($X)
185
+ - pattern: dangerous($X, $Y)
186
+ ```
187
+
188
+ After:
189
+ ```yaml
190
+ pattern: dangerous($X, ...)
191
+ ```
192
+
193
+ **3. Consolidate with Metavariables**
194
+
195
+ Before:
196
+ ```yaml
197
+ pattern-either:
198
+ - pattern: md5($X)
199
+ - pattern: sha1($X)
200
+ - pattern: sha256($X)
201
+ ```
202
+
203
+ After:
204
+ ```yaml
205
+ patterns:
206
+ - pattern: $FUNC($X)
207
+ - metavariable-regex:
208
+ metavariable: $FUNC
209
+ regex: ^(md5|sha1|sha256)$
210
+ ```
211
+
212
+ ### Optimization Checklist
213
+
214
+ 1. Remove patterns differing only in quote style
215
+ 2. Remove patterns that are subsets of `...` patterns
216
+ 3. Consolidate similar patterns using metavariable-regex
217
+ 4. Remove duplicate patterns in pattern-either
218
+ 5. Simplify nested pattern-either when possible
219
+ 6. Replace complex regex patterns with metavariable-comparison
220
+ 7. **Re-run tests after each optimization**
221
+
222
+ ### Verify After Optimization
223
+
224
+ ```bash
225
+ semgrep --test --config <rule-id>.yaml <rule-id>.<ext>
226
+ ```
227
+
228
+ **CRITICAL**: Always re-run tests after optimization. Some "redundant" patterns may actually be necessary due to AST structure differences. If any test fails, revert the optimization that caused it.
229
+
230
+ **Task complete ONLY when**: All tests pass after optimization.
231
+
232
+
233
+ ## Step 7: Final Run
234
+ Run the Semgrep rule you created using: `semgrep --config <rule-id>.yaml <rule-id>.<ext>`.
235
+
236
+ Ensure that message:
237
+ 1. Contains a short and concise explanation of the matched pattern
238
+ 2. Has no uninterpolated metavariables (e.g., $OP, $VAR). All metavariables referenced in the message must be captured by the pattern so they interpolate to actual code.
239
+
240
+ Fix any message issues and re-run that Semgrep rule after each fix.
@@ -0,0 +1,9 @@
1
+ {
2
+ "name": "semgrep-rule-variant-creator",
3
+ "version": "1.0.0",
4
+ "description": "Creates language variants of existing Semgrep rules with proper applicability analysis and test-driven validation",
5
+ "author": {
6
+ "name": "Maciej Domanski",
7
+ "email": "opensource@trailofbits.com"
8
+ }
9
+ }