codeply-cli 0.5.6 → 0.6.0

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 (429) hide show
  1. package/LICENSE +21 -21
  2. package/THIRD_PARTY_NOTICES.md +65 -65
  3. package/bin/codeply.js +8 -3
  4. package/lib/agent.mjs +2596 -2268
  5. package/lib/ai.js +135 -27
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/autopilot.js +84 -0
  12. package/lib/bot-mail.js +46 -0
  13. package/lib/bots.js +142 -15
  14. package/lib/brain.js +914 -0
  15. package/lib/call-assist.js +120 -0
  16. package/lib/chatgpt.js +282 -282
  17. package/lib/cloud-browser.mjs +143 -143
  18. package/lib/cloud.mjs +1396 -1320
  19. package/lib/commands.js +103 -103
  20. package/lib/computer.js +136 -0
  21. package/lib/design-library/assemble-artifact.mjs +21 -21
  22. package/lib/design-library/cleanup.mjs +45 -45
  23. package/lib/design-library/index.json +22379 -22379
  24. package/lib/design-library/make-table-data.mjs +39 -39
  25. package/lib/design-tools.mjs +173 -0
  26. package/lib/diagnostics.js +192 -192
  27. package/lib/dsh-acp.mjs +444 -0
  28. package/lib/edit-engine.js +364 -364
  29. package/lib/github-agent.mjs +326 -326
  30. package/lib/handoff.mjs +245 -0
  31. package/lib/history.js +78 -75
  32. package/lib/life-sources.js +319 -0
  33. package/lib/life-store.js +356 -0
  34. package/lib/life-triggers.js +286 -0
  35. package/lib/life.js +487 -0
  36. package/lib/mail-watch.js +3 -3
  37. package/lib/mcp.js +258 -258
  38. package/lib/native-tools.mjs +17 -5
  39. package/lib/oauth-connectors.js +76 -21
  40. package/lib/permissions.js +109 -109
  41. package/lib/plugins.js +356 -353
  42. package/lib/reach.js +67 -67
  43. package/lib/render-md.mjs +647 -617
  44. package/lib/screen.js +77 -0
  45. package/lib/server.mjs +458 -457
  46. package/lib/session-db.js +220 -220
  47. package/lib/share.js +208 -168
  48. package/lib/skills.js +4 -1
  49. package/lib/snapshot.js +146 -146
  50. package/lib/subagents.js +4 -2
  51. package/lib/telemetry.js +105 -105
  52. package/lib/terminal-hints.js +154 -154
  53. package/lib/textarea.mjs +264 -258
  54. package/lib/tools.mjs +326 -40
  55. package/lib/tui.mjs +1459 -1086
  56. package/lib/typecheck-worker.js +147 -147
  57. package/lib/web-tools.js +209 -209
  58. package/package.json +1 -1
  59. package/skills/SOURCE.md +58 -58
  60. package/skills/accessibility/SKILL.md +147 -147
  61. package/skills/agent-architecture-audit/SKILL.md +257 -257
  62. package/skills/agent-eval/SKILL.md +147 -147
  63. package/skills/agent-harness-construction/SKILL.md +74 -74
  64. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  65. package/skills/agent-payment-x402/SKILL.md +225 -225
  66. package/skills/agent-self-evaluation/SKILL.md +182 -182
  67. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  68. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  69. package/skills/agent-sort/SKILL.md +216 -216
  70. package/skills/agentic-engineering/SKILL.md +64 -64
  71. package/skills/agentic-os/SKILL.md +388 -388
  72. package/skills/ai-first-engineering/SKILL.md +52 -52
  73. package/skills/ai-regression-testing/SKILL.md +386 -386
  74. package/skills/android-clean-architecture/SKILL.md +340 -340
  75. package/skills/angular-developer/SKILL.md +155 -155
  76. package/skills/angular-developer/references/angular-animations.md +160 -160
  77. package/skills/angular-developer/references/angular-aria.md +410 -410
  78. package/skills/angular-developer/references/cli.md +86 -86
  79. package/skills/angular-developer/references/component-harnesses.md +59 -59
  80. package/skills/angular-developer/references/component-styling.md +91 -91
  81. package/skills/angular-developer/references/components.md +117 -117
  82. package/skills/angular-developer/references/creating-services.md +97 -97
  83. package/skills/angular-developer/references/data-resolvers.md +69 -69
  84. package/skills/angular-developer/references/define-routes.md +67 -67
  85. package/skills/angular-developer/references/defining-providers.md +72 -72
  86. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  87. package/skills/angular-developer/references/e2e-testing.md +56 -56
  88. package/skills/angular-developer/references/effects.md +83 -83
  89. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  90. package/skills/angular-developer/references/host-elements.md +80 -80
  91. package/skills/angular-developer/references/injection-context.md +63 -63
  92. package/skills/angular-developer/references/inputs.md +101 -101
  93. package/skills/angular-developer/references/linked-signal.md +59 -59
  94. package/skills/angular-developer/references/loading-strategies.md +61 -61
  95. package/skills/angular-developer/references/mcp.md +108 -108
  96. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  97. package/skills/angular-developer/references/outputs.md +86 -86
  98. package/skills/angular-developer/references/reactive-forms.md +122 -122
  99. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  100. package/skills/angular-developer/references/resource.md +77 -77
  101. package/skills/angular-developer/references/route-animations.md +56 -56
  102. package/skills/angular-developer/references/route-guards.md +52 -52
  103. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  104. package/skills/angular-developer/references/router-testing.md +87 -87
  105. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  106. package/skills/angular-developer/references/signal-forms.md +795 -795
  107. package/skills/angular-developer/references/signals-overview.md +94 -94
  108. package/skills/angular-developer/references/tailwind-css.md +69 -69
  109. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  110. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  111. package/skills/api-connector-builder/SKILL.md +121 -121
  112. package/skills/api-design/SKILL.md +524 -524
  113. package/skills/architecture-decision-records/SKILL.md +180 -180
  114. package/skills/article-writing/SKILL.md +80 -80
  115. package/skills/automation-audit-ops/SKILL.md +143 -143
  116. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  117. package/skills/autonomous-loops/SKILL.md +611 -611
  118. package/skills/backend-patterns/SKILL.md +562 -562
  119. package/skills/benchmark/SKILL.md +95 -95
  120. package/skills/benchmark-methodology/SKILL.md +191 -191
  121. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  122. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  123. package/skills/blueprint/SKILL.md +106 -106
  124. package/skills/brand-discovery/SKILL.md +145 -145
  125. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  126. package/skills/brand-discovery/references/20_positioning.md +44 -44
  127. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  128. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  129. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  130. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  131. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  132. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  133. package/skills/brand-voice/SKILL.md +98 -98
  134. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  135. package/skills/browser-qa/SKILL.md +105 -105
  136. package/skills/bun-runtime/SKILL.md +85 -85
  137. package/skills/canary-watch/SKILL.md +108 -108
  138. package/skills/carrier-relationship-management/SKILL.md +212 -212
  139. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  140. package/skills/ck/SKILL.md +148 -148
  141. package/skills/claude-devfleet/SKILL.md +112 -112
  142. package/skills/click-path-audit/SKILL.md +245 -245
  143. package/skills/clickhouse-io/SKILL.md +445 -445
  144. package/skills/code-tour/SKILL.md +254 -254
  145. package/skills/codebase-onboarding/SKILL.md +234 -234
  146. package/skills/codehealth-mcp/SKILL.md +167 -167
  147. package/skills/codeply-taste/LICENSE +21 -0
  148. package/skills/codeply-taste/SKILL.md +100 -0
  149. package/skills/codeply-taste/SOURCE.md +10 -0
  150. package/skills/codeply-taste/assets/base.css +100 -0
  151. package/skills/codeply-taste/assets/base.js +37 -0
  152. package/skills/codeply-taste/library/directions.json +1078 -0
  153. package/skills/codeply-taste/library/heroes.json +894 -0
  154. package/skills/codeply-taste/library/motions.json +57 -0
  155. package/skills/codeply-taste/library/palettes.json +1485 -0
  156. package/skills/codeply-taste/library/photos.json +7240 -0
  157. package/skills/codeply-taste/library/sections.json +4136 -0
  158. package/skills/codeply-taste/library/sites.json +7274 -0
  159. package/skills/codeply-taste/library/type.json +2024 -0
  160. package/skills/codeply-taste/references/colour.md +141 -0
  161. package/skills/codeply-taste/references/copy.md +177 -0
  162. package/skills/codeply-taste/references/critique.md +171 -0
  163. package/skills/codeply-taste/references/imagery.md +377 -0
  164. package/skills/codeply-taste/references/layout.md +178 -0
  165. package/skills/codeply-taste/references/motion.md +292 -0
  166. package/skills/codeply-taste/references/research.md +306 -0
  167. package/skills/codeply-taste/references/tells.md +115 -0
  168. package/skills/codeply-taste/references/type.md +170 -0
  169. package/skills/codeply-taste/scripts/assets.mjs +865 -0
  170. package/skills/codeply-taste/scripts/draw.mjs +525 -0
  171. package/skills/codeply-taste/scripts/inspect.mjs +205 -0
  172. package/skills/codeply-taste/scripts/lib/cdp.mjs +205 -0
  173. package/skills/codeply-taste/scripts/lib/probe.mjs +569 -0
  174. package/skills/codeply-taste/scripts/lib/rules.mjs +137 -0
  175. package/skills/codeply-taste/scripts/lint.mjs +108 -0
  176. package/skills/coding-standards/SKILL.md +551 -551
  177. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  178. package/skills/competitive-report-structure/SKILL.md +162 -162
  179. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  180. package/skills/config-gc/SKILL.md +120 -120
  181. package/skills/configure-ecc/SKILL.md +385 -385
  182. package/skills/connections-optimizer/SKILL.md +190 -190
  183. package/skills/content-engine/SKILL.md +132 -132
  184. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  185. package/skills/context-budget/SKILL.md +136 -136
  186. package/skills/continuous-agent-loop/SKILL.md +46 -46
  187. package/skills/continuous-learning/SKILL.md +132 -132
  188. package/skills/continuous-learning-v2/SKILL.md +361 -361
  189. package/skills/contract-first/SKILL.md +287 -287
  190. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  191. package/skills/cost-tracking/SKILL.md +97 -97
  192. package/skills/council/SKILL.md +204 -204
  193. package/skills/cpp-coding-standards/SKILL.md +724 -724
  194. package/skills/cpp-testing/SKILL.md +325 -325
  195. package/skills/crosspost/SKILL.md +112 -112
  196. package/skills/csharp-testing/SKILL.md +322 -322
  197. package/skills/customer-billing-ops/SKILL.md +141 -141
  198. package/skills/customs-trade-compliance/SKILL.md +263 -263
  199. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  200. package/skills/dashboard-builder/SKILL.md +109 -109
  201. package/skills/data-scraper-agent/SKILL.md +765 -765
  202. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  203. package/skills/database-migrations/SKILL.md +430 -430
  204. package/skills/deep-research/SKILL.md +160 -160
  205. package/skills/defi-amm-security/SKILL.md +167 -167
  206. package/skills/delivery-gate/SKILL.md +126 -126
  207. package/skills/deployment-patterns/SKILL.md +428 -428
  208. package/skills/design-system/SKILL.md +83 -83
  209. package/skills/django-celery/SKILL.md +458 -458
  210. package/skills/django-patterns/SKILL.md +735 -735
  211. package/skills/django-security/SKILL.md +644 -644
  212. package/skills/django-tdd/SKILL.md +730 -730
  213. package/skills/django-verification/SKILL.md +470 -470
  214. package/skills/dmux-workflows/SKILL.md +192 -192
  215. package/skills/docker-patterns/SKILL.md +365 -365
  216. package/skills/documentation-lookup/SKILL.md +91 -91
  217. package/skills/dotnet-patterns/SKILL.md +322 -322
  218. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  219. package/skills/e2e-testing/SKILL.md +327 -327
  220. package/skills/ecc-guide/SKILL.md +190 -190
  221. package/skills/ecc-recipes/SKILL.md +149 -149
  222. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  223. package/skills/email-ops/SKILL.md +122 -122
  224. package/skills/energy-procurement/SKILL.md +228 -228
  225. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  226. package/skills/error-handling/SKILL.md +377 -377
  227. package/skills/eval-harness/SKILL.md +271 -271
  228. package/skills/evm-token-decimals/SKILL.md +131 -131
  229. package/skills/exa-search/SKILL.md +108 -108
  230. package/skills/fal-ai-media/SKILL.md +289 -289
  231. package/skills/fastapi-patterns/SKILL.md +514 -514
  232. package/skills/finance-billing-ops/SKILL.md +128 -128
  233. package/skills/flox-environments/SKILL.md +497 -497
  234. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  235. package/skills/foundation-models-on-device/SKILL.md +243 -243
  236. package/skills/frontend-a11y/SKILL.md +446 -446
  237. package/skills/frontend-design-direction/SKILL.md +93 -93
  238. package/skills/frontend-patterns/SKILL.md +657 -657
  239. package/skills/frontend-slides/SKILL.md +185 -185
  240. package/skills/fsharp-testing/SKILL.md +281 -281
  241. package/skills/gan-style-harness/SKILL.md +279 -279
  242. package/skills/gateguard/SKILL.md +133 -133
  243. package/skills/generating-python-installer/SKILL.md +820 -820
  244. package/skills/git-workflow/SKILL.md +716 -716
  245. package/skills/github-ops/SKILL.md +145 -145
  246. package/skills/golang-patterns/SKILL.md +676 -676
  247. package/skills/golang-testing/SKILL.md +721 -721
  248. package/skills/google-workspace-ops/SKILL.md +96 -96
  249. package/skills/growth-log/SKILL.md +128 -128
  250. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  251. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  252. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  253. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  254. package/skills/hermes-imports/SKILL.md +89 -89
  255. package/skills/hexagonal-architecture/SKILL.md +277 -277
  256. package/skills/hipaa-compliance/SKILL.md +79 -79
  257. package/skills/homelab-network-readiness/SKILL.md +170 -170
  258. package/skills/homelab-network-setup/SKILL.md +130 -130
  259. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  260. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  261. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  262. package/skills/hookify-rules/SKILL.md +128 -128
  263. package/skills/inherit-legacy-style/SKILL.md +157 -157
  264. package/skills/intent-driven-development/SKILL.md +360 -360
  265. package/skills/inventory-demand-planning/SKILL.md +247 -247
  266. package/skills/investor-materials/SKILL.md +97 -97
  267. package/skills/investor-outreach/SKILL.md +92 -92
  268. package/skills/ios-icon-gen/SKILL.md +158 -158
  269. package/skills/iterative-retrieval/SKILL.md +212 -212
  270. package/skills/ito-basket-compare/SKILL.md +64 -64
  271. package/skills/ito-compute/SKILL.md +129 -129
  272. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  273. package/skills/ito-market-intelligence/SKILL.md +61 -61
  274. package/skills/ito-trade-planner/SKILL.md +68 -68
  275. package/skills/java-coding-standards/SKILL.md +384 -384
  276. package/skills/jira-integration/SKILL.md +303 -303
  277. package/skills/jpa-patterns/SKILL.md +152 -152
  278. package/skills/knowledge-ops/SKILL.md +155 -155
  279. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  280. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  281. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  282. package/skills/kotlin-patterns/SKILL.md +712 -712
  283. package/skills/kotlin-testing/SKILL.md +825 -825
  284. package/skills/kubernetes-patterns/SKILL.md +756 -756
  285. package/skills/laravel-patterns/SKILL.md +416 -416
  286. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  287. package/skills/laravel-security/SKILL.md +948 -948
  288. package/skills/laravel-tdd/SKILL.md +675 -675
  289. package/skills/laravel-verification/SKILL.md +180 -180
  290. package/skills/latency-critical-systems/SKILL.md +75 -75
  291. package/skills/lead-intelligence/SKILL.md +322 -322
  292. package/skills/liquid-glass-design/SKILL.md +279 -279
  293. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  294. package/skills/logistics-exception-management/SKILL.md +222 -222
  295. package/skills/loop-design-check/SKILL.md +143 -143
  296. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  297. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  298. package/skills/manim-video/SKILL.md +90 -90
  299. package/skills/market-research/SKILL.md +76 -76
  300. package/skills/marketing-campaign/SKILL.md +114 -114
  301. package/skills/mcp-server-patterns/SKILL.md +70 -70
  302. package/skills/messages-ops/SKILL.md +105 -105
  303. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  304. package/skills/mle-workflow/SKILL.md +348 -348
  305. package/skills/motion-advanced/SKILL.md +596 -596
  306. package/skills/motion-foundations/SKILL.md +299 -299
  307. package/skills/motion-patterns/SKILL.md +434 -434
  308. package/skills/motion-ui/SKILL.md +576 -576
  309. package/skills/mysql-patterns/SKILL.md +413 -413
  310. package/skills/nanoclaw-repl/SKILL.md +34 -34
  311. package/skills/nestjs-patterns/SKILL.md +231 -231
  312. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  313. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  314. package/skills/network-config-validation/SKILL.md +211 -211
  315. package/skills/network-interface-health/SKILL.md +153 -153
  316. package/skills/nextjs-turbopack/SKILL.md +58 -58
  317. package/skills/nodejs-keccak256/SKILL.md +103 -103
  318. package/skills/nutrient-document-processing/SKILL.md +168 -168
  319. package/skills/nuxt4-patterns/SKILL.md +101 -101
  320. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  321. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  322. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  323. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  324. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  325. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  326. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  327. package/skills/opensource-pipeline/SKILL.md +256 -256
  328. package/skills/orch-add-feature/SKILL.md +45 -45
  329. package/skills/orch-build-mvp/SKILL.md +49 -49
  330. package/skills/orch-change-feature/SKILL.md +43 -43
  331. package/skills/orch-fix-defect/SKILL.md +43 -43
  332. package/skills/orch-pipeline/SKILL.md +121 -121
  333. package/skills/orch-refine-code/SKILL.md +44 -44
  334. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  335. package/skills/perl-patterns/SKILL.md +505 -505
  336. package/skills/perl-security/SKILL.md +504 -504
  337. package/skills/perl-testing/SKILL.md +476 -476
  338. package/skills/plan-canvas/SKILL.md +153 -153
  339. package/skills/plan-orchestrate/SKILL.md +263 -263
  340. package/skills/plankton-code-quality/SKILL.md +237 -237
  341. package/skills/postgres-patterns/SKILL.md +148 -148
  342. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  343. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  344. package/skills/premium-web-design/SKILL.md +154 -154
  345. package/skills/prisma-patterns/SKILL.md +401 -401
  346. package/skills/product-capability/SKILL.md +142 -142
  347. package/skills/product-lens/SKILL.md +93 -93
  348. package/skills/production-audit/SKILL.md +207 -207
  349. package/skills/production-scheduling/SKILL.md +238 -238
  350. package/skills/project-flow-ops/SKILL.md +112 -112
  351. package/skills/prompt-optimizer/SKILL.md +398 -398
  352. package/skills/python-patterns/SKILL.md +751 -751
  353. package/skills/python-testing/SKILL.md +817 -817
  354. package/skills/pytorch-patterns/SKILL.md +397 -397
  355. package/skills/quality-nonconformance/SKILL.md +260 -260
  356. package/skills/quarkus-patterns/SKILL.md +723 -723
  357. package/skills/quarkus-security/SKILL.md +468 -468
  358. package/skills/quarkus-tdd/SKILL.md +812 -812
  359. package/skills/quarkus-verification/SKILL.md +480 -480
  360. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  361. package/skills/react-native-patterns/SKILL.md +326 -326
  362. package/skills/react-patterns/SKILL.md +342 -342
  363. package/skills/react-performance/SKILL.md +575 -575
  364. package/skills/react-testing/SKILL.md +424 -424
  365. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  366. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  367. package/skills/redis-patterns/SKILL.md +404 -404
  368. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  369. package/skills/remotion-video-creation/SKILL.md +43 -43
  370. package/skills/repo-scan/SKILL.md +79 -79
  371. package/skills/research-ops/SKILL.md +113 -113
  372. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  373. package/skills/rules-distill/SKILL.md +265 -265
  374. package/skills/rust-patterns/SKILL.md +500 -500
  375. package/skills/rust-testing/SKILL.md +501 -501
  376. package/skills/safety-guard/SKILL.md +76 -76
  377. package/skills/santa-method/SKILL.md +307 -307
  378. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  379. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  380. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  381. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  382. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  383. package/skills/search-first/SKILL.md +183 -183
  384. package/skills/security-bounty-hunter/SKILL.md +100 -100
  385. package/skills/security-review/SKILL.md +504 -504
  386. package/skills/security-scan/SKILL.md +166 -166
  387. package/skills/seo/SKILL.md +155 -155
  388. package/skills/skill-comply/SKILL.md +59 -59
  389. package/skills/skill-scout/SKILL.md +141 -141
  390. package/skills/skill-stocktake/SKILL.md +195 -195
  391. package/skills/social-graph-ranker/SKILL.md +155 -155
  392. package/skills/social-publisher/SKILL.md +130 -130
  393. package/skills/springboot-patterns/SKILL.md +315 -315
  394. package/skills/springboot-security/SKILL.md +273 -273
  395. package/skills/springboot-tdd/SKILL.md +159 -159
  396. package/skills/springboot-verification/SKILL.md +232 -232
  397. package/skills/strategic-compact/SKILL.md +142 -142
  398. package/skills/swift-actor-persistence/SKILL.md +144 -144
  399. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  400. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  401. package/skills/swiftui-patterns/SKILL.md +259 -259
  402. package/skills/taste/SKILL.md +264 -264
  403. package/skills/taste/references/genre-taxonomy.md +87 -87
  404. package/skills/tdd-workflow/SKILL.md +583 -583
  405. package/skills/team-agent-orchestration/SKILL.md +111 -111
  406. package/skills/team-builder/SKILL.md +169 -169
  407. package/skills/terminal-ops/SKILL.md +110 -110
  408. package/skills/tinystruct-patterns/SKILL.md +279 -279
  409. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  410. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  411. package/skills/tinystruct-patterns/references/database.md +99 -99
  412. package/skills/tinystruct-patterns/references/routing.md +64 -64
  413. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  414. package/skills/tinystruct-patterns/references/testing.md +72 -72
  415. package/skills/token-budget-advisor/SKILL.md +134 -134
  416. package/skills/ui-demo/SKILL.md +466 -466
  417. package/skills/ui-to-vue/SKILL.md +135 -135
  418. package/skills/uncloud/SKILL.md +344 -344
  419. package/skills/unified-memory/SKILL.md +170 -170
  420. package/skills/unified-notifications-ops/SKILL.md +188 -188
  421. package/skills/verification-loop/SKILL.md +129 -129
  422. package/skills/video-editing/SKILL.md +311 -311
  423. package/skills/videodb/SKILL.md +375 -375
  424. package/skills/visa-doc-translate/SKILL.md +117 -117
  425. package/skills/vite-patterns/SKILL.md +450 -450
  426. package/skills/vue-patterns/SKILL.md +471 -471
  427. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  428. package/skills/workspace-surface-audit/SKILL.md +126 -126
  429. package/skills/x-api/SKILL.md +235 -235
@@ -1,644 +1,644 @@
1
- ---
2
- name: django-security
3
- description: Django security best practices, authentication, authorization, CSRF protection, SQL injection prevention, XSS prevention, and secure deployment configurations.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Django Security Best Practices
9
-
10
- Comprehensive security guidelines for Django applications to protect against common vulnerabilities.
11
-
12
- ## When to Activate
13
-
14
- - Setting up Django authentication and authorization
15
- - Implementing user permissions and roles
16
- - Configuring production security settings
17
- - Reviewing Django application for security issues
18
- - Deploying Django applications to production
19
-
20
- ## Core Security Settings
21
-
22
- ### Production Settings Configuration
23
-
24
- ```python
25
- # settings/production.py
26
- import os
27
-
28
- DEBUG = False # CRITICAL: Never use True in production
29
-
30
- ALLOWED_HOSTS = os.environ.get('ALLOWED_HOSTS', '').split(',')
31
-
32
- # Security headers
33
- SECURE_SSL_REDIRECT = True
34
- SESSION_COOKIE_SECURE = True
35
- CSRF_COOKIE_SECURE = True
36
- SECURE_HSTS_SECONDS = 31536000 # 1 year
37
- SECURE_HSTS_INCLUDE_SUBDOMAINS = True
38
- SECURE_HSTS_PRELOAD = True
39
- SECURE_CONTENT_TYPE_NOSNIFF = True
40
- SECURE_BROWSER_XSS_FILTER = True
41
- X_FRAME_OPTIONS = 'DENY'
42
-
43
- # HTTPS and Cookies
44
- SESSION_COOKIE_HTTPONLY = True
45
- CSRF_COOKIE_HTTPONLY = True
46
- SESSION_COOKIE_SAMESITE = 'Lax'
47
- CSRF_COOKIE_SAMESITE = 'Lax'
48
-
49
- # Secret key (must be set via environment variable)
50
- SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY')
51
- if not SECRET_KEY:
52
- raise ImproperlyConfigured('DJANGO_SECRET_KEY environment variable is required')
53
-
54
- # Password validation
55
- AUTH_PASSWORD_VALIDATORS = [
56
- {
57
- 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
58
- },
59
- {
60
- 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
61
- 'OPTIONS': {
62
- 'min_length': 12,
63
- }
64
- },
65
- {
66
- 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
67
- },
68
- {
69
- 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
70
- },
71
- ]
72
- ```
73
-
74
- ## Authentication
75
-
76
- ### Custom User Model
77
-
78
- ```python
79
- # apps/users/models.py
80
- from django.contrib.auth.models import AbstractUser
81
- from django.db import models
82
-
83
- class User(AbstractUser):
84
- """Custom user model for better security."""
85
-
86
- email = models.EmailField(unique=True)
87
- phone = models.CharField(max_length=20, blank=True)
88
-
89
- USERNAME_FIELD = 'email' # Use email as username
90
- REQUIRED_FIELDS = ['username']
91
-
92
- class Meta:
93
- db_table = 'users'
94
- verbose_name = 'User'
95
- verbose_name_plural = 'Users'
96
-
97
- def __str__(self):
98
- return self.email
99
-
100
- # settings/base.py
101
- AUTH_USER_MODEL = 'users.User'
102
- ```
103
-
104
- ### Password Hashing
105
-
106
- ```python
107
- # Django uses PBKDF2 by default. For stronger security:
108
- PASSWORD_HASHERS = [
109
- 'django.contrib.auth.hashers.Argon2PasswordHasher',
110
- 'django.contrib.auth.hashers.PBKDF2PasswordHasher',
111
- 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
112
- 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher',
113
- ]
114
- ```
115
-
116
- ### Session Management
117
-
118
- ```python
119
- # Session configuration
120
- SESSION_ENGINE = 'django.contrib.sessions.backends.cache' # Or 'db'
121
- SESSION_CACHE_ALIAS = 'default'
122
- SESSION_COOKIE_AGE = 3600 * 24 * 7 # 1 week
123
- SESSION_SAVE_EVERY_REQUEST = False
124
- SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Better UX, but less secure
125
- ```
126
-
127
- ## Authorization
128
-
129
- ### Permissions
130
-
131
- ```python
132
- # models.py
133
- from django.db import models
134
- from django.contrib.auth.models import Permission
135
-
136
- class Post(models.Model):
137
- title = models.CharField(max_length=200)
138
- content = models.TextField()
139
- author = models.ForeignKey(User, on_delete=models.CASCADE)
140
-
141
- class Meta:
142
- permissions = [
143
- ('can_publish', 'Can publish posts'),
144
- ('can_edit_others', 'Can edit posts of others'),
145
- ]
146
-
147
- def user_can_edit(self, user):
148
- """Check if user can edit this post."""
149
- return self.author == user or user.has_perm('app.can_edit_others')
150
-
151
- # views.py
152
- from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin
153
- from django.views.generic import UpdateView
154
-
155
- class PostUpdateView(LoginRequiredMixin, PermissionRequiredMixin, UpdateView):
156
- model = Post
157
- permission_required = 'app.can_edit_others'
158
- raise_exception = True # Return 403 instead of redirect
159
-
160
- def get_queryset(self):
161
- """Only allow users to edit their own posts."""
162
- return Post.objects.filter(author=self.request.user)
163
- ```
164
-
165
- ### Custom Permissions
166
-
167
- ```python
168
- # permissions.py
169
- from rest_framework import permissions
170
-
171
- class IsOwnerOrReadOnly(permissions.BasePermission):
172
- """Allow only owners to edit objects."""
173
-
174
- def has_object_permission(self, request, view, obj):
175
- # Read permissions allowed for any request
176
- if request.method in permissions.SAFE_METHODS:
177
- return True
178
-
179
- # Write permissions only for owner
180
- return obj.author == request.user
181
-
182
- class IsAdminOrReadOnly(permissions.BasePermission):
183
- """Allow admins to do anything, others read-only."""
184
-
185
- def has_permission(self, request, view):
186
- if request.method in permissions.SAFE_METHODS:
187
- return True
188
- return request.user and request.user.is_staff
189
-
190
- class IsVerifiedUser(permissions.BasePermission):
191
- """Allow only verified users."""
192
-
193
- def has_permission(self, request, view):
194
- return request.user and request.user.is_authenticated and request.user.is_verified
195
- ```
196
-
197
- ### Role-Based Access Control (RBAC)
198
-
199
- ```python
200
- # models.py
201
- from django.contrib.auth.models import AbstractUser, Group
202
-
203
- class User(AbstractUser):
204
- ROLE_CHOICES = [
205
- ('admin', 'Administrator'),
206
- ('moderator', 'Moderator'),
207
- ('user', 'Regular User'),
208
- ]
209
- role = models.CharField(max_length=20, choices=ROLE_CHOICES, default='user')
210
-
211
- def is_admin(self):
212
- return self.role == 'admin' or self.is_superuser
213
-
214
- def is_moderator(self):
215
- return self.role in ['admin', 'moderator']
216
-
217
- # Mixins
218
- class AdminRequiredMixin:
219
- """Mixin to require admin role."""
220
-
221
- def dispatch(self, request, *args, **kwargs):
222
- if not request.user.is_authenticated or not request.user.is_admin():
223
- from django.core.exceptions import PermissionDenied
224
- raise PermissionDenied
225
- return super().dispatch(request, *args, **kwargs)
226
- ```
227
-
228
- ## SQL Injection Prevention
229
-
230
- ### Django ORM Protection
231
-
232
- ```python
233
- # GOOD: Django ORM automatically escapes parameters
234
- def get_user(username):
235
- return User.objects.get(username=username) # Safe
236
-
237
- # GOOD: Using parameters with raw()
238
- def search_users(query):
239
- return User.objects.raw('SELECT * FROM users WHERE username = %s', [query])
240
-
241
- # BAD: Never directly interpolate user input
242
- def get_user_bad(username):
243
- return User.objects.raw(f'SELECT * FROM users WHERE username = {username}') # VULNERABLE!
244
-
245
- # GOOD: Using filter with proper escaping
246
- def get_users_by_email(email):
247
- return User.objects.filter(email__iexact=email) # Safe
248
-
249
- # GOOD: Using Q objects for complex queries
250
- from django.db.models import Q
251
- def search_users_complex(query):
252
- return User.objects.filter(
253
- Q(username__icontains=query) |
254
- Q(email__icontains=query)
255
- ) # Safe
256
- ```
257
-
258
- ### Extra Security with raw()
259
-
260
- ```python
261
- # If you must use raw SQL, always use parameters
262
- User.objects.raw(
263
- 'SELECT * FROM users WHERE email = %s AND status = %s',
264
- [user_input_email, status]
265
- )
266
- ```
267
-
268
- ## XSS Prevention
269
-
270
- ### Template Escaping
271
-
272
- ```django
273
- {# Django auto-escapes variables by default - SAFE #}
274
- {{ user_input }} {# Escaped HTML #}
275
-
276
- {# Explicitly mark safe only for trusted content #}
277
- {{ trusted_html|safe }} {# Not escaped #}
278
-
279
- {# Use template filters for safe HTML #}
280
- {{ user_input|escape }} {# Same as default #}
281
- {{ user_input|striptags }} {# Remove all HTML tags #}
282
-
283
- {# JavaScript escaping #}
284
- <script>
285
- var username = {{ username|escapejs }};
286
- </script>
287
- ```
288
-
289
- ### Safe String Handling
290
-
291
- ```python
292
- from django.utils.safestring import mark_safe
293
- from django.utils.html import escape
294
-
295
- # BAD: Never mark user input as safe without escaping
296
- def render_bad(user_input):
297
- return mark_safe(user_input) # VULNERABLE!
298
-
299
- # GOOD: Escape first, then mark safe
300
- def render_good(user_input):
301
- return mark_safe(escape(user_input))
302
-
303
- # GOOD: Use format_html for HTML with variables
304
- from django.utils.html import format_html
305
-
306
- def greet_user(username):
307
- return format_html('<span class="user">{}</span>', escape(username))
308
- ```
309
-
310
- ### HTTP Headers
311
-
312
- ```python
313
- # settings.py
314
- SECURE_CONTENT_TYPE_NOSNIFF = True # Prevent MIME sniffing
315
- SECURE_BROWSER_XSS_FILTER = True # Enable XSS filter
316
- X_FRAME_OPTIONS = 'DENY' # Prevent clickjacking
317
-
318
- # Custom middleware
319
- from django.conf import settings
320
-
321
- class SecurityHeaderMiddleware:
322
- def __init__(self, get_response):
323
- self.get_response = get_response
324
-
325
- def __call__(self, request):
326
- response = self.get_response(request)
327
- response['X-Content-Type-Options'] = 'nosniff'
328
- response['X-Frame-Options'] = 'DENY'
329
- response['X-XSS-Protection'] = '1; mode=block'
330
- response['Content-Security-Policy'] = "default-src 'self'"
331
- return response
332
- ```
333
-
334
- ## CSRF Protection
335
-
336
- ### Default CSRF Protection
337
-
338
- ```python
339
- # settings.py - CSRF is enabled by default
340
- CSRF_COOKIE_SECURE = True # Only send over HTTPS
341
- CSRF_COOKIE_HTTPONLY = True # Prevent JavaScript access
342
- CSRF_COOKIE_SAMESITE = 'Lax' # Prevent CSRF in some cases
343
- CSRF_TRUSTED_ORIGINS = ['https://example.com'] # Trusted domains
344
-
345
- # Template usage
346
- <form method="post">
347
- {% csrf_token %}
348
- {{ form.as_p }}
349
- <button type="submit">Submit</button>
350
- </form>
351
-
352
- # AJAX requests
353
- function getCookie(name) {
354
- let cookieValue = null;
355
- if (document.cookie && document.cookie !== '') {
356
- const cookies = document.cookie.split(';');
357
- for (let i = 0; i < cookies.length; i++) {
358
- const cookie = cookies[i].trim();
359
- if (cookie.substring(0, name.length + 1) === (name + '=')) {
360
- cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
361
- break;
362
- }
363
- }
364
- }
365
- return cookieValue;
366
- }
367
-
368
- fetch('/api/endpoint/', {
369
- method: 'POST',
370
- headers: {
371
- 'X-CSRFToken': getCookie('csrftoken'),
372
- 'Content-Type': 'application/json',
373
- },
374
- body: JSON.stringify(data)
375
- });
376
- ```
377
-
378
- ### Exempting Views (Use Carefully)
379
-
380
- ```python
381
- from django.views.decorators.csrf import csrf_exempt
382
-
383
- @csrf_exempt # Only use when absolutely necessary!
384
- def webhook_view(request):
385
- # Webhook from external service
386
- pass
387
- ```
388
-
389
- ## File Upload Security
390
-
391
- ### File Validation
392
-
393
- ```python
394
- import os
395
- import magic # pip install python-magic
396
- from django.core.exceptions import ValidationError
397
-
398
- ALLOWED_MIMES = {
399
- 'image/jpeg', 'image/png', 'image/gif', 'application/pdf',
400
- }
401
-
402
- MIME_TO_EXTENSIONS = {
403
- 'image/jpeg': {'.jpg', '.jpeg'},
404
- 'image/png': {'.png'},
405
- 'image/gif': {'.gif'},
406
- 'application/pdf': {'.pdf'},
407
- }
408
-
409
- def validate_file_type(value):
410
- """Validate file type using magic bytes and cross-check extension."""
411
- mime = magic.from_buffer(value.read(2048), mime=True)
412
- value.seek(0)
413
-
414
- if mime not in ALLOWED_MIMES:
415
- raise ValidationError('Unsupported file type.')
416
-
417
- ext = os.path.splitext(value.name)[1].lower()
418
- if ext not in MIME_TO_EXTENSIONS.get(mime, set()):
419
- raise ValidationError('File extension does not match file content.')
420
-
421
- def validate_file_size(value):
422
- """Validate file size (max 5MB)."""
423
- if value.size > 5 * 1024 * 1024:
424
- raise ValidationError('File too large. Max size is 5MB.')
425
-
426
- # models.py
427
- class Document(models.Model):
428
- file = models.FileField(
429
- upload_to='documents/',
430
- validators=[validate_file_type, validate_file_size]
431
- )
432
-
433
- ```
434
-
435
- For environments where installing libmagic is difficult (e.g., minimal containers),
436
- use the pure-Python `filetype` package as an alternative:
437
-
438
- ```python
439
- import os
440
- from django.core.exceptions import ValidationError
441
-
442
- import filetype # pip install filetype
443
-
444
- ALLOWED_MIMES = {
445
- 'image/jpeg', 'image/png', 'image/gif', 'application/pdf',
446
- }
447
-
448
- MIME_TO_EXTENSIONS = {
449
- 'image/jpeg': {'.jpg', '.jpeg'},
450
- 'image/png': {'.png'},
451
- 'image/gif': {'.gif'},
452
- 'application/pdf': {'.pdf'},
453
- }
454
-
455
- def validate_file_type(value):
456
- """Validate file type using magic bytes."""
457
- kind = filetype.guess(value.read(2048))
458
- value.seek(0)
459
-
460
- if kind is None or kind.mime not in ALLOWED_MIMES:
461
- raise ValidationError('Unsupported file type.')
462
-
463
- ext = os.path.splitext(value.name)[1].lower()
464
- if ext not in MIME_TO_EXTENSIONS.get(kind.mime, set()):
465
- raise ValidationError('File extension does not match file content.')
466
- ```
467
-
468
- ### Secure File Storage
469
-
470
- ```python
471
- # settings.py
472
- MEDIA_ROOT = '/var/www/media/'
473
- MEDIA_URL = '/media/'
474
-
475
- # Use a separate domain for media in production
476
- MEDIA_DOMAIN = 'https://media.example.com'
477
-
478
- # Don't serve user uploads directly
479
- # Use whitenoise or a CDN for static files
480
- # Use a separate server or S3 for media files
481
- ```
482
-
483
- ## API Security
484
-
485
- ### Rate Limiting
486
-
487
- ```python
488
- # settings.py
489
- REST_FRAMEWORK = {
490
- 'DEFAULT_THROTTLE_CLASSES': [
491
- 'rest_framework.throttling.AnonRateThrottle',
492
- 'rest_framework.throttling.UserRateThrottle'
493
- ],
494
- 'DEFAULT_THROTTLE_RATES': {
495
- 'anon': '100/day',
496
- 'user': '1000/day',
497
- 'upload': '10/hour',
498
- }
499
- }
500
-
501
- # Custom throttle
502
- from rest_framework.throttling import UserRateThrottle
503
-
504
- class BurstRateThrottle(UserRateThrottle):
505
- scope = 'burst'
506
- rate = '60/min'
507
-
508
- class SustainedRateThrottle(UserRateThrottle):
509
- scope = 'sustained'
510
- rate = '1000/day'
511
- ```
512
-
513
- ### Authentication for APIs
514
-
515
- ```python
516
- # settings.py
517
- REST_FRAMEWORK = {
518
- 'DEFAULT_AUTHENTICATION_CLASSES': [
519
- 'rest_framework.authentication.TokenAuthentication',
520
- 'rest_framework.authentication.SessionAuthentication',
521
- 'rest_framework_simplejwt.authentication.JWTAuthentication',
522
- ],
523
- 'DEFAULT_PERMISSION_CLASSES': [
524
- 'rest_framework.permissions.IsAuthenticated',
525
- ],
526
- }
527
-
528
- # views.py
529
- from rest_framework.decorators import api_view, permission_classes
530
- from rest_framework.permissions import IsAuthenticated
531
-
532
- @api_view(['GET', 'POST'])
533
- @permission_classes([IsAuthenticated])
534
- def protected_view(request):
535
- return Response({'message': 'You are authenticated'})
536
- ```
537
-
538
- ## Security Headers
539
-
540
- ### Content Security Policy
541
-
542
- ```python
543
- # settings.py
544
- CSP_DEFAULT_SRC = "'self'"
545
- CSP_SCRIPT_SRC = "'self' https://cdn.example.com"
546
- CSP_STYLE_SRC = "'self' 'unsafe-inline'"
547
- CSP_IMG_SRC = "'self' data: https:"
548
- CSP_CONNECT_SRC = "'self' https://api.example.com"
549
-
550
- # Middleware
551
- class CSPMiddleware:
552
- def __init__(self, get_response):
553
- self.get_response = get_response
554
-
555
- def __call__(self, request):
556
- response = self.get_response(request)
557
- response['Content-Security-Policy'] = (
558
- f"default-src {CSP_DEFAULT_SRC}; "
559
- f"script-src {CSP_SCRIPT_SRC}; "
560
- f"style-src {CSP_STYLE_SRC}; "
561
- f"img-src {CSP_IMG_SRC}; "
562
- f"connect-src {CSP_CONNECT_SRC}"
563
- )
564
- return response
565
- ```
566
-
567
- ## Environment Variables
568
-
569
- ### Managing Secrets
570
-
571
- ```python
572
- # Use python-decouple or django-environ
573
- import environ
574
-
575
- env = environ.Env(
576
- # set casting, default value
577
- DEBUG=(bool, False)
578
- )
579
-
580
- # reading .env file
581
- environ.Env.read_env()
582
-
583
- SECRET_KEY = env('DJANGO_SECRET_KEY')
584
- DATABASE_URL = env('DATABASE_URL')
585
- ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
586
-
587
- # .env file (never commit this)
588
- DEBUG=False
589
- SECRET_KEY=your-secret-key-here
590
- DATABASE_URL=postgresql://user:password@localhost:5432/dbname
591
- ALLOWED_HOSTS=example.com,www.example.com
592
- ```
593
-
594
- ## Logging Security Events
595
-
596
- ```python
597
- # settings.py
598
- LOGGING = {
599
- 'version': 1,
600
- 'disable_existing_loggers': False,
601
- 'handlers': {
602
- 'file': {
603
- 'level': 'WARNING',
604
- 'class': 'logging.FileHandler',
605
- 'filename': '/var/log/django/security.log',
606
- },
607
- 'console': {
608
- 'level': 'INFO',
609
- 'class': 'logging.StreamHandler',
610
- },
611
- },
612
- 'loggers': {
613
- 'django.security': {
614
- 'handlers': ['file', 'console'],
615
- 'level': 'WARNING',
616
- 'propagate': True,
617
- },
618
- 'django.request': {
619
- 'handlers': ['file'],
620
- 'level': 'ERROR',
621
- 'propagate': False,
622
- },
623
- },
624
- }
625
- ```
626
-
627
- ## Quick Security Checklist
628
-
629
- | Check | Description |
630
- |-------|-------------|
631
- | `DEBUG = False` | Never run with DEBUG in production |
632
- | HTTPS only | Force SSL, secure cookies |
633
- | Strong secrets | Use environment variables for SECRET_KEY |
634
- | Password validation | Enable all password validators |
635
- | CSRF protection | Enabled by default, don't disable |
636
- | XSS prevention | Django auto-escapes, don't use `&#124;safe` with user input |
637
- | SQL injection | Use ORM, never concatenate strings in queries |
638
- | File uploads | Validate file type and size |
639
- | Rate limiting | Throttle API endpoints |
640
- | Security headers | CSP, X-Frame-Options, HSTS |
641
- | Logging | Log security events |
642
- | Updates | Keep Django and dependencies updated |
643
-
644
- Remember: Security is a process, not a product. Regularly review and update your security practices.
1
+ ---
2
+ name: django-security
3
+ description: Django security best practices, authentication, authorization, CSRF protection, SQL injection prevention, XSS prevention, and secure deployment configurations.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Django Security Best Practices
9
+
10
+ Comprehensive security guidelines for Django applications to protect against common vulnerabilities.
11
+
12
+ ## When to Activate
13
+
14
+ - Setting up Django authentication and authorization
15
+ - Implementing user permissions and roles
16
+ - Configuring production security settings
17
+ - Reviewing Django application for security issues
18
+ - Deploying Django applications to production
19
+
20
+ ## Core Security Settings
21
+
22
+ ### Production Settings Configuration
23
+
24
+ ```python
25
+ # settings/production.py
26
+ import os
27
+
28
+ DEBUG = False # CRITICAL: Never use True in production
29
+
30
+ ALLOWED_HOSTS = os.environ.get('ALLOWED_HOSTS', '').split(',')
31
+
32
+ # Security headers
33
+ SECURE_SSL_REDIRECT = True
34
+ SESSION_COOKIE_SECURE = True
35
+ CSRF_COOKIE_SECURE = True
36
+ SECURE_HSTS_SECONDS = 31536000 # 1 year
37
+ SECURE_HSTS_INCLUDE_SUBDOMAINS = True
38
+ SECURE_HSTS_PRELOAD = True
39
+ SECURE_CONTENT_TYPE_NOSNIFF = True
40
+ SECURE_BROWSER_XSS_FILTER = True
41
+ X_FRAME_OPTIONS = 'DENY'
42
+
43
+ # HTTPS and Cookies
44
+ SESSION_COOKIE_HTTPONLY = True
45
+ CSRF_COOKIE_HTTPONLY = True
46
+ SESSION_COOKIE_SAMESITE = 'Lax'
47
+ CSRF_COOKIE_SAMESITE = 'Lax'
48
+
49
+ # Secret key (must be set via environment variable)
50
+ SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY')
51
+ if not SECRET_KEY:
52
+ raise ImproperlyConfigured('DJANGO_SECRET_KEY environment variable is required')
53
+
54
+ # Password validation
55
+ AUTH_PASSWORD_VALIDATORS = [
56
+ {
57
+ 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
58
+ },
59
+ {
60
+ 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
61
+ 'OPTIONS': {
62
+ 'min_length': 12,
63
+ }
64
+ },
65
+ {
66
+ 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
67
+ },
68
+ {
69
+ 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
70
+ },
71
+ ]
72
+ ```
73
+
74
+ ## Authentication
75
+
76
+ ### Custom User Model
77
+
78
+ ```python
79
+ # apps/users/models.py
80
+ from django.contrib.auth.models import AbstractUser
81
+ from django.db import models
82
+
83
+ class User(AbstractUser):
84
+ """Custom user model for better security."""
85
+
86
+ email = models.EmailField(unique=True)
87
+ phone = models.CharField(max_length=20, blank=True)
88
+
89
+ USERNAME_FIELD = 'email' # Use email as username
90
+ REQUIRED_FIELDS = ['username']
91
+
92
+ class Meta:
93
+ db_table = 'users'
94
+ verbose_name = 'User'
95
+ verbose_name_plural = 'Users'
96
+
97
+ def __str__(self):
98
+ return self.email
99
+
100
+ # settings/base.py
101
+ AUTH_USER_MODEL = 'users.User'
102
+ ```
103
+
104
+ ### Password Hashing
105
+
106
+ ```python
107
+ # Django uses PBKDF2 by default. For stronger security:
108
+ PASSWORD_HASHERS = [
109
+ 'django.contrib.auth.hashers.Argon2PasswordHasher',
110
+ 'django.contrib.auth.hashers.PBKDF2PasswordHasher',
111
+ 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
112
+ 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher',
113
+ ]
114
+ ```
115
+
116
+ ### Session Management
117
+
118
+ ```python
119
+ # Session configuration
120
+ SESSION_ENGINE = 'django.contrib.sessions.backends.cache' # Or 'db'
121
+ SESSION_CACHE_ALIAS = 'default'
122
+ SESSION_COOKIE_AGE = 3600 * 24 * 7 # 1 week
123
+ SESSION_SAVE_EVERY_REQUEST = False
124
+ SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Better UX, but less secure
125
+ ```
126
+
127
+ ## Authorization
128
+
129
+ ### Permissions
130
+
131
+ ```python
132
+ # models.py
133
+ from django.db import models
134
+ from django.contrib.auth.models import Permission
135
+
136
+ class Post(models.Model):
137
+ title = models.CharField(max_length=200)
138
+ content = models.TextField()
139
+ author = models.ForeignKey(User, on_delete=models.CASCADE)
140
+
141
+ class Meta:
142
+ permissions = [
143
+ ('can_publish', 'Can publish posts'),
144
+ ('can_edit_others', 'Can edit posts of others'),
145
+ ]
146
+
147
+ def user_can_edit(self, user):
148
+ """Check if user can edit this post."""
149
+ return self.author == user or user.has_perm('app.can_edit_others')
150
+
151
+ # views.py
152
+ from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin
153
+ from django.views.generic import UpdateView
154
+
155
+ class PostUpdateView(LoginRequiredMixin, PermissionRequiredMixin, UpdateView):
156
+ model = Post
157
+ permission_required = 'app.can_edit_others'
158
+ raise_exception = True # Return 403 instead of redirect
159
+
160
+ def get_queryset(self):
161
+ """Only allow users to edit their own posts."""
162
+ return Post.objects.filter(author=self.request.user)
163
+ ```
164
+
165
+ ### Custom Permissions
166
+
167
+ ```python
168
+ # permissions.py
169
+ from rest_framework import permissions
170
+
171
+ class IsOwnerOrReadOnly(permissions.BasePermission):
172
+ """Allow only owners to edit objects."""
173
+
174
+ def has_object_permission(self, request, view, obj):
175
+ # Read permissions allowed for any request
176
+ if request.method in permissions.SAFE_METHODS:
177
+ return True
178
+
179
+ # Write permissions only for owner
180
+ return obj.author == request.user
181
+
182
+ class IsAdminOrReadOnly(permissions.BasePermission):
183
+ """Allow admins to do anything, others read-only."""
184
+
185
+ def has_permission(self, request, view):
186
+ if request.method in permissions.SAFE_METHODS:
187
+ return True
188
+ return request.user and request.user.is_staff
189
+
190
+ class IsVerifiedUser(permissions.BasePermission):
191
+ """Allow only verified users."""
192
+
193
+ def has_permission(self, request, view):
194
+ return request.user and request.user.is_authenticated and request.user.is_verified
195
+ ```
196
+
197
+ ### Role-Based Access Control (RBAC)
198
+
199
+ ```python
200
+ # models.py
201
+ from django.contrib.auth.models import AbstractUser, Group
202
+
203
+ class User(AbstractUser):
204
+ ROLE_CHOICES = [
205
+ ('admin', 'Administrator'),
206
+ ('moderator', 'Moderator'),
207
+ ('user', 'Regular User'),
208
+ ]
209
+ role = models.CharField(max_length=20, choices=ROLE_CHOICES, default='user')
210
+
211
+ def is_admin(self):
212
+ return self.role == 'admin' or self.is_superuser
213
+
214
+ def is_moderator(self):
215
+ return self.role in ['admin', 'moderator']
216
+
217
+ # Mixins
218
+ class AdminRequiredMixin:
219
+ """Mixin to require admin role."""
220
+
221
+ def dispatch(self, request, *args, **kwargs):
222
+ if not request.user.is_authenticated or not request.user.is_admin():
223
+ from django.core.exceptions import PermissionDenied
224
+ raise PermissionDenied
225
+ return super().dispatch(request, *args, **kwargs)
226
+ ```
227
+
228
+ ## SQL Injection Prevention
229
+
230
+ ### Django ORM Protection
231
+
232
+ ```python
233
+ # GOOD: Django ORM automatically escapes parameters
234
+ def get_user(username):
235
+ return User.objects.get(username=username) # Safe
236
+
237
+ # GOOD: Using parameters with raw()
238
+ def search_users(query):
239
+ return User.objects.raw('SELECT * FROM users WHERE username = %s', [query])
240
+
241
+ # BAD: Never directly interpolate user input
242
+ def get_user_bad(username):
243
+ return User.objects.raw(f'SELECT * FROM users WHERE username = {username}') # VULNERABLE!
244
+
245
+ # GOOD: Using filter with proper escaping
246
+ def get_users_by_email(email):
247
+ return User.objects.filter(email__iexact=email) # Safe
248
+
249
+ # GOOD: Using Q objects for complex queries
250
+ from django.db.models import Q
251
+ def search_users_complex(query):
252
+ return User.objects.filter(
253
+ Q(username__icontains=query) |
254
+ Q(email__icontains=query)
255
+ ) # Safe
256
+ ```
257
+
258
+ ### Extra Security with raw()
259
+
260
+ ```python
261
+ # If you must use raw SQL, always use parameters
262
+ User.objects.raw(
263
+ 'SELECT * FROM users WHERE email = %s AND status = %s',
264
+ [user_input_email, status]
265
+ )
266
+ ```
267
+
268
+ ## XSS Prevention
269
+
270
+ ### Template Escaping
271
+
272
+ ```django
273
+ {# Django auto-escapes variables by default - SAFE #}
274
+ {{ user_input }} {# Escaped HTML #}
275
+
276
+ {# Explicitly mark safe only for trusted content #}
277
+ {{ trusted_html|safe }} {# Not escaped #}
278
+
279
+ {# Use template filters for safe HTML #}
280
+ {{ user_input|escape }} {# Same as default #}
281
+ {{ user_input|striptags }} {# Remove all HTML tags #}
282
+
283
+ {# JavaScript escaping #}
284
+ <script>
285
+ var username = {{ username|escapejs }};
286
+ </script>
287
+ ```
288
+
289
+ ### Safe String Handling
290
+
291
+ ```python
292
+ from django.utils.safestring import mark_safe
293
+ from django.utils.html import escape
294
+
295
+ # BAD: Never mark user input as safe without escaping
296
+ def render_bad(user_input):
297
+ return mark_safe(user_input) # VULNERABLE!
298
+
299
+ # GOOD: Escape first, then mark safe
300
+ def render_good(user_input):
301
+ return mark_safe(escape(user_input))
302
+
303
+ # GOOD: Use format_html for HTML with variables
304
+ from django.utils.html import format_html
305
+
306
+ def greet_user(username):
307
+ return format_html('<span class="user">{}</span>', escape(username))
308
+ ```
309
+
310
+ ### HTTP Headers
311
+
312
+ ```python
313
+ # settings.py
314
+ SECURE_CONTENT_TYPE_NOSNIFF = True # Prevent MIME sniffing
315
+ SECURE_BROWSER_XSS_FILTER = True # Enable XSS filter
316
+ X_FRAME_OPTIONS = 'DENY' # Prevent clickjacking
317
+
318
+ # Custom middleware
319
+ from django.conf import settings
320
+
321
+ class SecurityHeaderMiddleware:
322
+ def __init__(self, get_response):
323
+ self.get_response = get_response
324
+
325
+ def __call__(self, request):
326
+ response = self.get_response(request)
327
+ response['X-Content-Type-Options'] = 'nosniff'
328
+ response['X-Frame-Options'] = 'DENY'
329
+ response['X-XSS-Protection'] = '1; mode=block'
330
+ response['Content-Security-Policy'] = "default-src 'self'"
331
+ return response
332
+ ```
333
+
334
+ ## CSRF Protection
335
+
336
+ ### Default CSRF Protection
337
+
338
+ ```python
339
+ # settings.py - CSRF is enabled by default
340
+ CSRF_COOKIE_SECURE = True # Only send over HTTPS
341
+ CSRF_COOKIE_HTTPONLY = True # Prevent JavaScript access
342
+ CSRF_COOKIE_SAMESITE = 'Lax' # Prevent CSRF in some cases
343
+ CSRF_TRUSTED_ORIGINS = ['https://example.com'] # Trusted domains
344
+
345
+ # Template usage
346
+ <form method="post">
347
+ {% csrf_token %}
348
+ {{ form.as_p }}
349
+ <button type="submit">Submit</button>
350
+ </form>
351
+
352
+ # AJAX requests
353
+ function getCookie(name) {
354
+ let cookieValue = null;
355
+ if (document.cookie && document.cookie !== '') {
356
+ const cookies = document.cookie.split(';');
357
+ for (let i = 0; i < cookies.length; i++) {
358
+ const cookie = cookies[i].trim();
359
+ if (cookie.substring(0, name.length + 1) === (name + '=')) {
360
+ cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
361
+ break;
362
+ }
363
+ }
364
+ }
365
+ return cookieValue;
366
+ }
367
+
368
+ fetch('/api/endpoint/', {
369
+ method: 'POST',
370
+ headers: {
371
+ 'X-CSRFToken': getCookie('csrftoken'),
372
+ 'Content-Type': 'application/json',
373
+ },
374
+ body: JSON.stringify(data)
375
+ });
376
+ ```
377
+
378
+ ### Exempting Views (Use Carefully)
379
+
380
+ ```python
381
+ from django.views.decorators.csrf import csrf_exempt
382
+
383
+ @csrf_exempt # Only use when absolutely necessary!
384
+ def webhook_view(request):
385
+ # Webhook from external service
386
+ pass
387
+ ```
388
+
389
+ ## File Upload Security
390
+
391
+ ### File Validation
392
+
393
+ ```python
394
+ import os
395
+ import magic # pip install python-magic
396
+ from django.core.exceptions import ValidationError
397
+
398
+ ALLOWED_MIMES = {
399
+ 'image/jpeg', 'image/png', 'image/gif', 'application/pdf',
400
+ }
401
+
402
+ MIME_TO_EXTENSIONS = {
403
+ 'image/jpeg': {'.jpg', '.jpeg'},
404
+ 'image/png': {'.png'},
405
+ 'image/gif': {'.gif'},
406
+ 'application/pdf': {'.pdf'},
407
+ }
408
+
409
+ def validate_file_type(value):
410
+ """Validate file type using magic bytes and cross-check extension."""
411
+ mime = magic.from_buffer(value.read(2048), mime=True)
412
+ value.seek(0)
413
+
414
+ if mime not in ALLOWED_MIMES:
415
+ raise ValidationError('Unsupported file type.')
416
+
417
+ ext = os.path.splitext(value.name)[1].lower()
418
+ if ext not in MIME_TO_EXTENSIONS.get(mime, set()):
419
+ raise ValidationError('File extension does not match file content.')
420
+
421
+ def validate_file_size(value):
422
+ """Validate file size (max 5MB)."""
423
+ if value.size > 5 * 1024 * 1024:
424
+ raise ValidationError('File too large. Max size is 5MB.')
425
+
426
+ # models.py
427
+ class Document(models.Model):
428
+ file = models.FileField(
429
+ upload_to='documents/',
430
+ validators=[validate_file_type, validate_file_size]
431
+ )
432
+
433
+ ```
434
+
435
+ For environments where installing libmagic is difficult (e.g., minimal containers),
436
+ use the pure-Python `filetype` package as an alternative:
437
+
438
+ ```python
439
+ import os
440
+ from django.core.exceptions import ValidationError
441
+
442
+ import filetype # pip install filetype
443
+
444
+ ALLOWED_MIMES = {
445
+ 'image/jpeg', 'image/png', 'image/gif', 'application/pdf',
446
+ }
447
+
448
+ MIME_TO_EXTENSIONS = {
449
+ 'image/jpeg': {'.jpg', '.jpeg'},
450
+ 'image/png': {'.png'},
451
+ 'image/gif': {'.gif'},
452
+ 'application/pdf': {'.pdf'},
453
+ }
454
+
455
+ def validate_file_type(value):
456
+ """Validate file type using magic bytes."""
457
+ kind = filetype.guess(value.read(2048))
458
+ value.seek(0)
459
+
460
+ if kind is None or kind.mime not in ALLOWED_MIMES:
461
+ raise ValidationError('Unsupported file type.')
462
+
463
+ ext = os.path.splitext(value.name)[1].lower()
464
+ if ext not in MIME_TO_EXTENSIONS.get(kind.mime, set()):
465
+ raise ValidationError('File extension does not match file content.')
466
+ ```
467
+
468
+ ### Secure File Storage
469
+
470
+ ```python
471
+ # settings.py
472
+ MEDIA_ROOT = '/var/www/media/'
473
+ MEDIA_URL = '/media/'
474
+
475
+ # Use a separate domain for media in production
476
+ MEDIA_DOMAIN = 'https://media.example.com'
477
+
478
+ # Don't serve user uploads directly
479
+ # Use whitenoise or a CDN for static files
480
+ # Use a separate server or S3 for media files
481
+ ```
482
+
483
+ ## API Security
484
+
485
+ ### Rate Limiting
486
+
487
+ ```python
488
+ # settings.py
489
+ REST_FRAMEWORK = {
490
+ 'DEFAULT_THROTTLE_CLASSES': [
491
+ 'rest_framework.throttling.AnonRateThrottle',
492
+ 'rest_framework.throttling.UserRateThrottle'
493
+ ],
494
+ 'DEFAULT_THROTTLE_RATES': {
495
+ 'anon': '100/day',
496
+ 'user': '1000/day',
497
+ 'upload': '10/hour',
498
+ }
499
+ }
500
+
501
+ # Custom throttle
502
+ from rest_framework.throttling import UserRateThrottle
503
+
504
+ class BurstRateThrottle(UserRateThrottle):
505
+ scope = 'burst'
506
+ rate = '60/min'
507
+
508
+ class SustainedRateThrottle(UserRateThrottle):
509
+ scope = 'sustained'
510
+ rate = '1000/day'
511
+ ```
512
+
513
+ ### Authentication for APIs
514
+
515
+ ```python
516
+ # settings.py
517
+ REST_FRAMEWORK = {
518
+ 'DEFAULT_AUTHENTICATION_CLASSES': [
519
+ 'rest_framework.authentication.TokenAuthentication',
520
+ 'rest_framework.authentication.SessionAuthentication',
521
+ 'rest_framework_simplejwt.authentication.JWTAuthentication',
522
+ ],
523
+ 'DEFAULT_PERMISSION_CLASSES': [
524
+ 'rest_framework.permissions.IsAuthenticated',
525
+ ],
526
+ }
527
+
528
+ # views.py
529
+ from rest_framework.decorators import api_view, permission_classes
530
+ from rest_framework.permissions import IsAuthenticated
531
+
532
+ @api_view(['GET', 'POST'])
533
+ @permission_classes([IsAuthenticated])
534
+ def protected_view(request):
535
+ return Response({'message': 'You are authenticated'})
536
+ ```
537
+
538
+ ## Security Headers
539
+
540
+ ### Content Security Policy
541
+
542
+ ```python
543
+ # settings.py
544
+ CSP_DEFAULT_SRC = "'self'"
545
+ CSP_SCRIPT_SRC = "'self' https://cdn.example.com"
546
+ CSP_STYLE_SRC = "'self' 'unsafe-inline'"
547
+ CSP_IMG_SRC = "'self' data: https:"
548
+ CSP_CONNECT_SRC = "'self' https://api.example.com"
549
+
550
+ # Middleware
551
+ class CSPMiddleware:
552
+ def __init__(self, get_response):
553
+ self.get_response = get_response
554
+
555
+ def __call__(self, request):
556
+ response = self.get_response(request)
557
+ response['Content-Security-Policy'] = (
558
+ f"default-src {CSP_DEFAULT_SRC}; "
559
+ f"script-src {CSP_SCRIPT_SRC}; "
560
+ f"style-src {CSP_STYLE_SRC}; "
561
+ f"img-src {CSP_IMG_SRC}; "
562
+ f"connect-src {CSP_CONNECT_SRC}"
563
+ )
564
+ return response
565
+ ```
566
+
567
+ ## Environment Variables
568
+
569
+ ### Managing Secrets
570
+
571
+ ```python
572
+ # Use python-decouple or django-environ
573
+ import environ
574
+
575
+ env = environ.Env(
576
+ # set casting, default value
577
+ DEBUG=(bool, False)
578
+ )
579
+
580
+ # reading .env file
581
+ environ.Env.read_env()
582
+
583
+ SECRET_KEY = env('DJANGO_SECRET_KEY')
584
+ DATABASE_URL = env('DATABASE_URL')
585
+ ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
586
+
587
+ # .env file (never commit this)
588
+ DEBUG=False
589
+ SECRET_KEY=your-secret-key-here
590
+ DATABASE_URL=postgresql://user:password@localhost:5432/dbname
591
+ ALLOWED_HOSTS=example.com,www.example.com
592
+ ```
593
+
594
+ ## Logging Security Events
595
+
596
+ ```python
597
+ # settings.py
598
+ LOGGING = {
599
+ 'version': 1,
600
+ 'disable_existing_loggers': False,
601
+ 'handlers': {
602
+ 'file': {
603
+ 'level': 'WARNING',
604
+ 'class': 'logging.FileHandler',
605
+ 'filename': '/var/log/django/security.log',
606
+ },
607
+ 'console': {
608
+ 'level': 'INFO',
609
+ 'class': 'logging.StreamHandler',
610
+ },
611
+ },
612
+ 'loggers': {
613
+ 'django.security': {
614
+ 'handlers': ['file', 'console'],
615
+ 'level': 'WARNING',
616
+ 'propagate': True,
617
+ },
618
+ 'django.request': {
619
+ 'handlers': ['file'],
620
+ 'level': 'ERROR',
621
+ 'propagate': False,
622
+ },
623
+ },
624
+ }
625
+ ```
626
+
627
+ ## Quick Security Checklist
628
+
629
+ | Check | Description |
630
+ |-------|-------------|
631
+ | `DEBUG = False` | Never run with DEBUG in production |
632
+ | HTTPS only | Force SSL, secure cookies |
633
+ | Strong secrets | Use environment variables for SECRET_KEY |
634
+ | Password validation | Enable all password validators |
635
+ | CSRF protection | Enabled by default, don't disable |
636
+ | XSS prevention | Django auto-escapes, don't use `&#124;safe` with user input |
637
+ | SQL injection | Use ORM, never concatenate strings in queries |
638
+ | File uploads | Validate file type and size |
639
+ | Rate limiting | Throttle API endpoints |
640
+ | Security headers | CSP, X-Frame-Options, HSTS |
641
+ | Logging | Log security events |
642
+ | Updates | Keep Django and dependencies updated |
643
+
644
+ Remember: Security is a process, not a product. Regularly review and update your security practices.