@mandujs/mcp 0.13.0 → 0.17.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 (136) hide show
  1. package/README.md +102 -7
  2. package/package.json +3 -2
  3. package/src/adapters/index.ts +20 -20
  4. package/src/adapters/monitor-adapter.ts +100 -100
  5. package/src/adapters/tool-adapter.ts +88 -88
  6. package/src/executor/error-handler.ts +250 -250
  7. package/src/executor/index.ts +22 -22
  8. package/src/executor/tool-executor.ts +148 -148
  9. package/src/hooks/config-watcher.ts +174 -174
  10. package/src/hooks/index.ts +23 -23
  11. package/src/hooks/mcp-hooks.ts +227 -227
  12. package/src/logging/index.ts +15 -15
  13. package/src/logging/mcp-transport.ts +134 -134
  14. package/src/registry/index.ts +13 -13
  15. package/src/registry/mcp-tool-registry.ts +298 -298
  16. package/src/resources/skills/guides.ts +1136 -1136
  17. package/src/resources/skills/index.ts +12 -12
  18. package/src/resources/skills/loader.ts +218 -218
  19. package/src/resources/skills/mandu-composition/SKILL.md +91 -91
  20. package/src/resources/skills/mandu-composition/metadata.json +13 -13
  21. package/src/resources/skills/mandu-composition/rules/_sections.md +26 -26
  22. package/src/resources/skills/mandu-composition/rules/_template.md +77 -77
  23. package/src/resources/skills/mandu-composition/rules/comp-arch-avoid-boolean-props.md +146 -146
  24. package/src/resources/skills/mandu-composition/rules/comp-arch-compound-components.md +164 -164
  25. package/src/resources/skills/mandu-composition/rules/comp-island-event.md +161 -161
  26. package/src/resources/skills/mandu-composition/rules/comp-island-slot-split.md +167 -167
  27. package/src/resources/skills/mandu-composition/rules/comp-pattern-children.md +149 -149
  28. package/src/resources/skills/mandu-composition/rules/comp-state-context-interface.md +148 -148
  29. package/src/resources/skills/mandu-composition/rules/comp-state-lift-state.md +150 -150
  30. package/src/resources/skills/mandu-deployment/SKILL.md +92 -92
  31. package/src/resources/skills/mandu-deployment/_sections.md +41 -41
  32. package/src/resources/skills/mandu-deployment/_template.md +38 -38
  33. package/src/resources/skills/mandu-deployment/metadata.json +13 -13
  34. package/src/resources/skills/mandu-deployment/rules/deploy-build-bun.md +109 -109
  35. package/src/resources/skills/mandu-deployment/rules/deploy-build-output.md +115 -115
  36. package/src/resources/skills/mandu-deployment/rules/deploy-cicd-github.md +219 -219
  37. package/src/resources/skills/mandu-deployment/rules/deploy-docker-bun.md +150 -150
  38. package/src/resources/skills/mandu-deployment/rules/deploy-docker-compose.md +223 -223
  39. package/src/resources/skills/mandu-deployment/rules/deploy-platform-fly.md +152 -152
  40. package/src/resources/skills/mandu-deployment/rules/deploy-platform-render.md +179 -179
  41. package/src/resources/skills/mandu-deployment/rules/deploy-platform-supabase.md +323 -323
  42. package/src/resources/skills/mandu-deployment/rules/deploy-platform-vercel.md +140 -140
  43. package/src/resources/skills/mandu-fs-routes/SKILL.md +82 -82
  44. package/src/resources/skills/mandu-fs-routes/metadata.json +12 -12
  45. package/src/resources/skills/mandu-fs-routes/rules/_sections.md +36 -36
  46. package/src/resources/skills/mandu-fs-routes/rules/_template.md +69 -69
  47. package/src/resources/skills/mandu-fs-routes/rules/routes-api-methods.md +65 -65
  48. package/src/resources/skills/mandu-fs-routes/rules/routes-dynamic-param.md +93 -93
  49. package/src/resources/skills/mandu-fs-routes/rules/routes-naming-page.md +55 -55
  50. package/src/resources/skills/mandu-guard/SKILL.md +129 -129
  51. package/src/resources/skills/mandu-guard/metadata.json +12 -12
  52. package/src/resources/skills/mandu-guard/rules/_sections.md +36 -36
  53. package/src/resources/skills/mandu-guard/rules/_template.md +82 -82
  54. package/src/resources/skills/mandu-guard/rules/guard-config-rules.md +100 -100
  55. package/src/resources/skills/mandu-guard/rules/guard-layer-direction.md +76 -76
  56. package/src/resources/skills/mandu-guard/rules/guard-preset-mandu.md +81 -81
  57. package/src/resources/skills/mandu-guard/rules/guard-validate-import.md +80 -80
  58. package/src/resources/skills/mandu-hydration/SKILL.md +91 -91
  59. package/src/resources/skills/mandu-hydration/metadata.json +12 -12
  60. package/src/resources/skills/mandu-hydration/rules/_sections.md +31 -31
  61. package/src/resources/skills/mandu-hydration/rules/_template.md +72 -72
  62. package/src/resources/skills/mandu-hydration/rules/hydration-data-event.md +109 -109
  63. package/src/resources/skills/mandu-hydration/rules/hydration-directive-use-client.md +55 -55
  64. package/src/resources/skills/mandu-hydration/rules/hydration-island-setup.md +113 -113
  65. package/src/resources/skills/mandu-hydration/rules/hydration-priority-visible.md +68 -68
  66. package/src/resources/skills/mandu-performance/SKILL.md +85 -85
  67. package/src/resources/skills/mandu-performance/metadata.json +14 -14
  68. package/src/resources/skills/mandu-performance/rules/_sections.md +31 -31
  69. package/src/resources/skills/mandu-performance/rules/_template.md +64 -64
  70. package/src/resources/skills/mandu-performance/rules/perf-async-defer-await.md +103 -103
  71. package/src/resources/skills/mandu-performance/rules/perf-async-parallel.md +95 -95
  72. package/src/resources/skills/mandu-performance/rules/perf-bun-file.md +124 -124
  73. package/src/resources/skills/mandu-performance/rules/perf-bun-serve.md +125 -125
  74. package/src/resources/skills/mandu-performance/rules/perf-bundle-imports.md +80 -80
  75. package/src/resources/skills/mandu-performance/rules/perf-bundle-island-lazy.md +145 -145
  76. package/src/resources/skills/mandu-performance/rules/perf-cache-react.md +98 -98
  77. package/src/resources/skills/mandu-performance/rules/perf-render-transitions.md +154 -154
  78. package/src/resources/skills/mandu-security/SKILL.md +87 -87
  79. package/src/resources/skills/mandu-security/metadata.json +13 -13
  80. package/src/resources/skills/mandu-security/rules/_sections.md +31 -31
  81. package/src/resources/skills/mandu-security/rules/_template.md +74 -74
  82. package/src/resources/skills/mandu-security/rules/sec-auth-guard.md +127 -127
  83. package/src/resources/skills/mandu-security/rules/sec-env-management.md +133 -133
  84. package/src/resources/skills/mandu-security/rules/sec-input-validate.md +148 -148
  85. package/src/resources/skills/mandu-security/rules/sec-protect-csrf.md +146 -146
  86. package/src/resources/skills/mandu-security/rules/sec-protect-headers.md +138 -138
  87. package/src/resources/skills/mandu-slot/SKILL.md +85 -85
  88. package/src/resources/skills/mandu-slot/metadata.json +12 -12
  89. package/src/resources/skills/mandu-slot/rules/_sections.md +36 -36
  90. package/src/resources/skills/mandu-slot/rules/_template.md +63 -63
  91. package/src/resources/skills/mandu-slot/rules/slot-basic-structure.md +38 -38
  92. package/src/resources/skills/mandu-slot/rules/slot-ctx-response.md +56 -56
  93. package/src/resources/skills/mandu-slot/rules/slot-guard-auth.md +59 -59
  94. package/src/resources/skills/mandu-slot/rules/slot-http-methods.md +64 -64
  95. package/src/resources/skills/mandu-styling/SKILL.md +154 -154
  96. package/src/resources/skills/mandu-styling/_sections.md +43 -43
  97. package/src/resources/skills/mandu-styling/_template.md +32 -32
  98. package/src/resources/skills/mandu-styling/metadata.json +15 -15
  99. package/src/resources/skills/mandu-styling/rules/style-component-compound.md +235 -235
  100. package/src/resources/skills/mandu-styling/rules/style-component-slots.md +255 -255
  101. package/src/resources/skills/mandu-styling/rules/style-component-tokens.md +205 -205
  102. package/src/resources/skills/mandu-styling/rules/style-island-animations.md +272 -272
  103. package/src/resources/skills/mandu-styling/rules/style-island-scoping.md +167 -167
  104. package/src/resources/skills/mandu-styling/rules/style-island-variants.md +221 -221
  105. package/src/resources/skills/mandu-styling/rules/style-perf-critical.md +209 -209
  106. package/src/resources/skills/mandu-styling/rules/style-perf-purge.md +192 -192
  107. package/src/resources/skills/mandu-styling/rules/style-setup-modules.md +162 -162
  108. package/src/resources/skills/mandu-styling/rules/style-setup-panda.md +164 -164
  109. package/src/resources/skills/mandu-styling/rules/style-setup-tailwind.md +170 -170
  110. package/src/resources/skills/mandu-styling/rules/style-tailwind-v4-gotchas.md +179 -179
  111. package/src/resources/skills/mandu-styling/rules/style-theme-darkmode.md +229 -229
  112. package/src/resources/skills/mandu-testing/SKILL.md +99 -99
  113. package/src/resources/skills/mandu-testing/metadata.json +13 -13
  114. package/src/resources/skills/mandu-testing/rules/_sections.md +26 -26
  115. package/src/resources/skills/mandu-testing/rules/_template.md +65 -65
  116. package/src/resources/skills/mandu-testing/rules/test-component-island.md +195 -195
  117. package/src/resources/skills/mandu-testing/rules/test-e2e-playwright.md +196 -196
  118. package/src/resources/skills/mandu-testing/rules/test-mock-fetch.md +219 -219
  119. package/src/resources/skills/mandu-testing/rules/test-slot-unit.md +192 -192
  120. package/src/resources/skills/mandu-ui/SKILL.md +117 -117
  121. package/src/resources/skills/mandu-ui/_sections.md +23 -23
  122. package/src/resources/skills/mandu-ui/_template.md +32 -32
  123. package/src/resources/skills/mandu-ui/metadata.json +13 -13
  124. package/src/resources/skills/mandu-ui/rules/ui-accessibility-aria.md +232 -232
  125. package/src/resources/skills/mandu-ui/rules/ui-accessibility-focus.md +238 -238
  126. package/src/resources/skills/mandu-ui/rules/ui-composition-patterns.md +259 -259
  127. package/src/resources/skills/mandu-ui/rules/ui-island-integration.md +258 -258
  128. package/src/resources/skills/mandu-ui/rules/ui-radix-patterns.md +213 -213
  129. package/src/resources/skills/mandu-ui/rules/ui-shadcn-setup.md +209 -209
  130. package/src/resources/skills/recipes.ts +932 -932
  131. package/src/tools/ate.ts +219 -0
  132. package/src/tools/index.ts +4 -1
  133. package/src/tools/project.ts +334 -334
  134. package/src/tools/runtime.ts +497 -497
  135. package/src/tools/seo.ts +417 -417
  136. package/src/utils/withWarnings.ts +83 -83
@@ -1,74 +1,74 @@
1
- # Rule Template
2
-
3
- Use this template when creating new rules for mandu-security.
4
-
5
- ---
6
-
7
- ```markdown
8
- ---
9
- title: Rule Title Here
10
- impact: CRITICAL | HIGH | MEDIUM | LOW
11
- impactDescription: 영향 설명 (예: "Prevents unauthorized access")
12
- tags: security, tag1, tag2
13
- ---
14
-
15
- ## Rule Title Here
16
-
17
- **Impact: {LEVEL} ({impactDescription})**
18
-
19
- 보안 규칙의 목적과 중요성을 설명합니다.
20
-
21
- **Vulnerable (취약한 코드):**
22
-
23
- \`\`\`typescript
24
- // ❌ 보안 취약점이 있는 코드
25
- export default Mandu.filling()
26
- .get(async (ctx) => {
27
- // 인증 없이 민감 데이터 반환
28
- const users = await db.user.findMany();
29
- return ctx.ok({ users });
30
- });
31
- \`\`\`
32
-
33
- **Secure (안전한 코드):**
34
-
35
- \`\`\`typescript
36
- // ✅ 보안이 강화된 코드
37
- export default Mandu.filling()
38
- .guard((ctx) => {
39
- if (!ctx.get("user")?.isAdmin) {
40
- return ctx.forbidden("Admin access required");
41
- }
42
- })
43
- .get(async (ctx) => {
44
- const users = await db.user.findMany();
45
- return ctx.ok({ users });
46
- });
47
- \`\`\`
48
-
49
- ## Attack Vector
50
-
51
- 이 취약점이 어떻게 악용될 수 있는지 설명합니다.
52
-
53
- ## Mitigation
54
-
55
- 추가적인 방어 방법을 설명합니다.
56
-
57
- Reference: [OWASP 관련 문서](https://owasp.org/)
58
- ```
59
-
60
- ---
61
-
62
- ## Naming Convention
63
-
64
- - 파일명: `sec-{category}-{rule-name}.md`
65
- - 예시: `sec-auth-guard.md`, `sec-input-validate.md`
66
-
67
- ## OWASP Top 10 Reference
68
-
69
- | # | Category | Related Rules |
70
- |---|----------|---------------|
71
- | 1 | Broken Access Control | sec-auth-* |
72
- | 2 | Cryptographic Failures | sec-data-* |
73
- | 3 | Injection | sec-input-* |
74
- | 7 | XSS | sec-protect-xss |
1
+ # Rule Template
2
+
3
+ Use this template when creating new rules for mandu-security.
4
+
5
+ ---
6
+
7
+ ```markdown
8
+ ---
9
+ title: Rule Title Here
10
+ impact: CRITICAL | HIGH | MEDIUM | LOW
11
+ impactDescription: 영향 설명 (예: "Prevents unauthorized access")
12
+ tags: security, tag1, tag2
13
+ ---
14
+
15
+ ## Rule Title Here
16
+
17
+ **Impact: {LEVEL} ({impactDescription})**
18
+
19
+ 보안 규칙의 목적과 중요성을 설명합니다.
20
+
21
+ **Vulnerable (취약한 코드):**
22
+
23
+ \`\`\`typescript
24
+ // ❌ 보안 취약점이 있는 코드
25
+ export default Mandu.filling()
26
+ .get(async (ctx) => {
27
+ // 인증 없이 민감 데이터 반환
28
+ const users = await db.user.findMany();
29
+ return ctx.ok({ users });
30
+ });
31
+ \`\`\`
32
+
33
+ **Secure (안전한 코드):**
34
+
35
+ \`\`\`typescript
36
+ // ✅ 보안이 강화된 코드
37
+ export default Mandu.filling()
38
+ .guard((ctx) => {
39
+ if (!ctx.get("user")?.isAdmin) {
40
+ return ctx.forbidden("Admin access required");
41
+ }
42
+ })
43
+ .get(async (ctx) => {
44
+ const users = await db.user.findMany();
45
+ return ctx.ok({ users });
46
+ });
47
+ \`\`\`
48
+
49
+ ## Attack Vector
50
+
51
+ 이 취약점이 어떻게 악용될 수 있는지 설명합니다.
52
+
53
+ ## Mitigation
54
+
55
+ 추가적인 방어 방법을 설명합니다.
56
+
57
+ Reference: [OWASP 관련 문서](https://owasp.org/)
58
+ ```
59
+
60
+ ---
61
+
62
+ ## Naming Convention
63
+
64
+ - 파일명: `sec-{category}-{rule-name}.md`
65
+ - 예시: `sec-auth-guard.md`, `sec-input-validate.md`
66
+
67
+ ## OWASP Top 10 Reference
68
+
69
+ | # | Category | Related Rules |
70
+ |---|----------|---------------|
71
+ | 1 | Broken Access Control | sec-auth-* |
72
+ | 2 | Cryptographic Failures | sec-data-* |
73
+ | 3 | Injection | sec-input-* |
74
+ | 7 | XSS | sec-protect-xss |
@@ -1,127 +1,127 @@
1
- ---
2
- title: Use guard() for Authentication Checks
3
- impact: CRITICAL
4
- impactDescription: Prevents unauthorized access
5
- tags: security, auth, guard, slot
6
- ---
7
-
8
- ## Use guard() for Authentication Checks
9
-
10
- **Impact: CRITICAL (Prevents unauthorized access)**
11
-
12
- 모든 보호된 slot에서 `guard()`를 사용하여 인증을 확인하세요. guard는 핸들러 실행 전에 검사됩니다.
13
-
14
- **Vulnerable (인증 없음):**
15
-
16
- ```typescript
17
- // ❌ 인증 체크 없이 민감 데이터 노출
18
- export default Mandu.filling()
19
- .get(async (ctx) => {
20
- const users = await db.user.findMany();
21
- return ctx.ok({ users }); // 누구나 접근 가능!
22
- });
23
- ```
24
-
25
- **Secure (guard로 인증):**
26
-
27
- ```typescript
28
- // ✅ guard로 인증 체크
29
- export default Mandu.filling()
30
- .guard((ctx) => {
31
- const user = ctx.get("user");
32
- if (!user) {
33
- return ctx.unauthorized("Authentication required");
34
- }
35
- // void 반환 시 계속 진행
36
- })
37
- .get(async (ctx) => {
38
- const users = await db.user.findMany();
39
- return ctx.ok({ users });
40
- });
41
- ```
42
-
43
- ## 역할 기반 접근 제어 (RBAC)
44
-
45
- ```typescript
46
- export default Mandu.filling()
47
- .guard((ctx) => {
48
- const user = ctx.get("user");
49
-
50
- if (!user) {
51
- return ctx.unauthorized("Login required");
52
- }
53
-
54
- if (!user.roles.includes("admin")) {
55
- return ctx.forbidden("Admin access required");
56
- }
57
- })
58
- .get(async (ctx) => {
59
- // 관리자만 접근 가능
60
- const sensitiveData = await db.audit.findMany();
61
- return ctx.ok({ data: sensitiveData });
62
- });
63
- ```
64
-
65
- ## 리소스 소유권 검증
66
-
67
- ```typescript
68
- export default Mandu.filling()
69
- .guard(async (ctx) => {
70
- const user = ctx.get("user");
71
- const resourceId = ctx.params.id;
72
-
73
- if (!user) {
74
- return ctx.unauthorized("Login required");
75
- }
76
-
77
- // 리소스 소유권 확인
78
- const resource = await db.resource.findUnique({
79
- where: { id: resourceId },
80
- });
81
-
82
- if (resource?.ownerId !== user.id) {
83
- return ctx.forbidden("You don't own this resource");
84
- }
85
-
86
- // 나중에 사용할 수 있도록 저장
87
- ctx.set("resource", resource);
88
- })
89
- .get((ctx) => {
90
- const resource = ctx.get("resource");
91
- return ctx.ok({ resource });
92
- })
93
- .delete(async (ctx) => {
94
- const resource = ctx.get("resource");
95
- await db.resource.delete({ where: { id: resource.id } });
96
- return ctx.noContent();
97
- });
98
- ```
99
-
100
- ## 다중 guard 체이닝
101
-
102
- ```typescript
103
- const requireAuth = (ctx) => {
104
- if (!ctx.get("user")) {
105
- return ctx.unauthorized("Login required");
106
- }
107
- };
108
-
109
- const requireAdmin = (ctx) => {
110
- if (!ctx.get("user")?.isAdmin) {
111
- return ctx.forbidden("Admin required");
112
- }
113
- };
114
-
115
- export default Mandu.filling()
116
- .guard(requireAuth)
117
- .guard(requireAdmin) // 순차적으로 실행
118
- .get(/* ... */);
119
- ```
120
-
121
- ## 주의사항
122
-
123
- - guard에서 응답을 반환하면 핸들러가 실행되지 않음
124
- - void 반환 시 다음 guard 또는 핸들러로 진행
125
- - 인증 미들웨어에서 `ctx.set("user", user)`로 사용자 정보 저장
126
-
127
- Reference: [OWASP Broken Access Control](https://owasp.org/Top10/A01_2021-Broken_Access_Control/)
1
+ ---
2
+ title: Use guard() for Authentication Checks
3
+ impact: CRITICAL
4
+ impactDescription: Prevents unauthorized access
5
+ tags: security, auth, guard, slot
6
+ ---
7
+
8
+ ## Use guard() for Authentication Checks
9
+
10
+ **Impact: CRITICAL (Prevents unauthorized access)**
11
+
12
+ 모든 보호된 slot에서 `guard()`를 사용하여 인증을 확인하세요. guard는 핸들러 실행 전에 검사됩니다.
13
+
14
+ **Vulnerable (인증 없음):**
15
+
16
+ ```typescript
17
+ // ❌ 인증 체크 없이 민감 데이터 노출
18
+ export default Mandu.filling()
19
+ .get(async (ctx) => {
20
+ const users = await db.user.findMany();
21
+ return ctx.ok({ users }); // 누구나 접근 가능!
22
+ });
23
+ ```
24
+
25
+ **Secure (guard로 인증):**
26
+
27
+ ```typescript
28
+ // ✅ guard로 인증 체크
29
+ export default Mandu.filling()
30
+ .guard((ctx) => {
31
+ const user = ctx.get("user");
32
+ if (!user) {
33
+ return ctx.unauthorized("Authentication required");
34
+ }
35
+ // void 반환 시 계속 진행
36
+ })
37
+ .get(async (ctx) => {
38
+ const users = await db.user.findMany();
39
+ return ctx.ok({ users });
40
+ });
41
+ ```
42
+
43
+ ## 역할 기반 접근 제어 (RBAC)
44
+
45
+ ```typescript
46
+ export default Mandu.filling()
47
+ .guard((ctx) => {
48
+ const user = ctx.get("user");
49
+
50
+ if (!user) {
51
+ return ctx.unauthorized("Login required");
52
+ }
53
+
54
+ if (!user.roles.includes("admin")) {
55
+ return ctx.forbidden("Admin access required");
56
+ }
57
+ })
58
+ .get(async (ctx) => {
59
+ // 관리자만 접근 가능
60
+ const sensitiveData = await db.audit.findMany();
61
+ return ctx.ok({ data: sensitiveData });
62
+ });
63
+ ```
64
+
65
+ ## 리소스 소유권 검증
66
+
67
+ ```typescript
68
+ export default Mandu.filling()
69
+ .guard(async (ctx) => {
70
+ const user = ctx.get("user");
71
+ const resourceId = ctx.params.id;
72
+
73
+ if (!user) {
74
+ return ctx.unauthorized("Login required");
75
+ }
76
+
77
+ // 리소스 소유권 확인
78
+ const resource = await db.resource.findUnique({
79
+ where: { id: resourceId },
80
+ });
81
+
82
+ if (resource?.ownerId !== user.id) {
83
+ return ctx.forbidden("You don't own this resource");
84
+ }
85
+
86
+ // 나중에 사용할 수 있도록 저장
87
+ ctx.set("resource", resource);
88
+ })
89
+ .get((ctx) => {
90
+ const resource = ctx.get("resource");
91
+ return ctx.ok({ resource });
92
+ })
93
+ .delete(async (ctx) => {
94
+ const resource = ctx.get("resource");
95
+ await db.resource.delete({ where: { id: resource.id } });
96
+ return ctx.noContent();
97
+ });
98
+ ```
99
+
100
+ ## 다중 guard 체이닝
101
+
102
+ ```typescript
103
+ const requireAuth = (ctx) => {
104
+ if (!ctx.get("user")) {
105
+ return ctx.unauthorized("Login required");
106
+ }
107
+ };
108
+
109
+ const requireAdmin = (ctx) => {
110
+ if (!ctx.get("user")?.isAdmin) {
111
+ return ctx.forbidden("Admin required");
112
+ }
113
+ };
114
+
115
+ export default Mandu.filling()
116
+ .guard(requireAuth)
117
+ .guard(requireAdmin) // 순차적으로 실행
118
+ .get(/* ... */);
119
+ ```
120
+
121
+ ## 주의사항
122
+
123
+ - guard에서 응답을 반환하면 핸들러가 실행되지 않음
124
+ - void 반환 시 다음 guard 또는 핸들러로 진행
125
+ - 인증 미들웨어에서 `ctx.set("user", user)`로 사용자 정보 저장
126
+
127
+ Reference: [OWASP Broken Access Control](https://owasp.org/Top10/A01_2021-Broken_Access_Control/)
@@ -1,133 +1,133 @@
1
- ---
2
- title: Secure Environment Variable Management
3
- impact: HIGH
4
- impactDescription: Prevents secret exposure
5
- tags: security, env, secrets, configuration
6
- ---
7
-
8
- ## Secure Environment Variable Management
9
-
10
- **Impact: HIGH (Prevents secret exposure)**
11
-
12
- 시크릿과 민감한 설정은 환경 변수로 관리하고, 절대 코드에 하드코딩하지 마세요.
13
-
14
- **Vulnerable (하드코딩된 시크릿):**
15
-
16
- ```typescript
17
- // ❌ 코드에 시크릿 하드코딩
18
- const db = new Database({
19
- host: "prod-db.example.com",
20
- password: "super_secret_password", // 위험!
21
- });
22
-
23
- const stripe = new Stripe("sk_live_abc123xyz"); // 위험!
24
- ```
25
-
26
- **Secure (환경 변수 사용):**
27
-
28
- ```typescript
29
- // ✅ 환경 변수에서 로드
30
- const db = new Database({
31
- host: process.env.DATABASE_HOST,
32
- password: process.env.DATABASE_PASSWORD,
33
- });
34
-
35
- const stripe = new Stripe(process.env.STRIPE_SECRET_KEY!);
36
- ```
37
-
38
- ## 환경 변수 검증
39
-
40
- ```typescript
41
- // lib/env.ts
42
- import { z } from "zod";
43
-
44
- const envSchema = z.object({
45
- // 필수
46
- DATABASE_URL: z.string().url(),
47
- SESSION_SECRET: z.string().min(32),
48
- STRIPE_SECRET_KEY: z.string().startsWith("sk_"),
49
-
50
- // 선택 (기본값)
51
- NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
52
- PORT: z.coerce.number().default(3000),
53
-
54
- // 프로덕션에서만 필수
55
- SENTRY_DSN: z.string().url().optional(),
56
- });
57
-
58
- // 앱 시작 시 검증
59
- export const env = envSchema.parse(process.env);
60
-
61
- // 타입 안전한 접근
62
- console.log(env.DATABASE_URL); // string
63
- console.log(env.PORT); // number
64
- ```
65
-
66
- ## .env 파일 관리
67
-
68
- ```bash
69
- # .env.example (커밋됨 - 템플릿)
70
- DATABASE_URL=postgresql://user:password@localhost:5432/db
71
- SESSION_SECRET=change_me_to_random_32_char_string
72
- STRIPE_SECRET_KEY=sk_test_xxx
73
-
74
- # .env.local (커밋 안 됨 - 실제 값)
75
- DATABASE_URL=postgresql://admin:real_password@prod-db:5432/myapp
76
- SESSION_SECRET=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
77
- STRIPE_SECRET_KEY=sk_live_real_key_here
78
- ```
79
-
80
- ## .gitignore 설정
81
-
82
- ```gitignore
83
- # 환경 변수 파일
84
- .env
85
- .env.local
86
- .env.*.local
87
-
88
- # 시크릿 관련
89
- *.pem
90
- *.key
91
- credentials.json
92
- ```
93
-
94
- ## 클라이언트에 노출되지 않도록 주의
95
-
96
- ```typescript
97
- // ❌ 클라이언트 번들에 포함됨
98
- // app/page.tsx
99
- const apiKey = process.env.API_SECRET_KEY; // 위험!
100
-
101
- // ✅ 서버에서만 사용
102
- // spec/slots/api.slot.ts
103
- export default Mandu.filling()
104
- .get(async (ctx) => {
105
- // 서버 측에서만 접근
106
- const apiKey = process.env.API_SECRET_KEY;
107
- const data = await fetchExternalApi(apiKey);
108
- return ctx.ok({ data }); // apiKey는 반환하지 않음
109
- });
110
- ```
111
-
112
- ## 시크릿 로테이션
113
-
114
- ```typescript
115
- // 여러 버전의 시크릿 지원
116
- const CURRENT_SECRET = process.env.SESSION_SECRET!;
117
- const PREVIOUS_SECRET = process.env.SESSION_SECRET_PREVIOUS;
118
-
119
- function verifyToken(token: string): boolean {
120
- // 현재 시크릿으로 먼저 검증
121
- if (verify(token, CURRENT_SECRET)) return true;
122
-
123
- // 이전 시크릿으로도 검증 (로테이션 기간)
124
- if (PREVIOUS_SECRET && verify(token, PREVIOUS_SECRET)) {
125
- // 토큰 갱신 권장
126
- return true;
127
- }
128
-
129
- return false;
130
- }
131
- ```
132
-
133
- Reference: [12-Factor App Config](https://12factor.net/config)
1
+ ---
2
+ title: Secure Environment Variable Management
3
+ impact: HIGH
4
+ impactDescription: Prevents secret exposure
5
+ tags: security, env, secrets, configuration
6
+ ---
7
+
8
+ ## Secure Environment Variable Management
9
+
10
+ **Impact: HIGH (Prevents secret exposure)**
11
+
12
+ 시크릿과 민감한 설정은 환경 변수로 관리하고, 절대 코드에 하드코딩하지 마세요.
13
+
14
+ **Vulnerable (하드코딩된 시크릿):**
15
+
16
+ ```typescript
17
+ // ❌ 코드에 시크릿 하드코딩
18
+ const db = new Database({
19
+ host: "prod-db.example.com",
20
+ password: "super_secret_password", // 위험!
21
+ });
22
+
23
+ const stripe = new Stripe("sk_live_abc123xyz"); // 위험!
24
+ ```
25
+
26
+ **Secure (환경 변수 사용):**
27
+
28
+ ```typescript
29
+ // ✅ 환경 변수에서 로드
30
+ const db = new Database({
31
+ host: process.env.DATABASE_HOST,
32
+ password: process.env.DATABASE_PASSWORD,
33
+ });
34
+
35
+ const stripe = new Stripe(process.env.STRIPE_SECRET_KEY!);
36
+ ```
37
+
38
+ ## 환경 변수 검증
39
+
40
+ ```typescript
41
+ // lib/env.ts
42
+ import { z } from "zod";
43
+
44
+ const envSchema = z.object({
45
+ // 필수
46
+ DATABASE_URL: z.string().url(),
47
+ SESSION_SECRET: z.string().min(32),
48
+ STRIPE_SECRET_KEY: z.string().startsWith("sk_"),
49
+
50
+ // 선택 (기본값)
51
+ NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
52
+ PORT: z.coerce.number().default(3000),
53
+
54
+ // 프로덕션에서만 필수
55
+ SENTRY_DSN: z.string().url().optional(),
56
+ });
57
+
58
+ // 앱 시작 시 검증
59
+ export const env = envSchema.parse(process.env);
60
+
61
+ // 타입 안전한 접근
62
+ console.log(env.DATABASE_URL); // string
63
+ console.log(env.PORT); // number
64
+ ```
65
+
66
+ ## .env 파일 관리
67
+
68
+ ```bash
69
+ # .env.example (커밋됨 - 템플릿)
70
+ DATABASE_URL=postgresql://user:password@localhost:5432/db
71
+ SESSION_SECRET=change_me_to_random_32_char_string
72
+ STRIPE_SECRET_KEY=sk_test_xxx
73
+
74
+ # .env.local (커밋 안 됨 - 실제 값)
75
+ DATABASE_URL=postgresql://admin:real_password@prod-db:5432/myapp
76
+ SESSION_SECRET=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
77
+ STRIPE_SECRET_KEY=sk_live_real_key_here
78
+ ```
79
+
80
+ ## .gitignore 설정
81
+
82
+ ```gitignore
83
+ # 환경 변수 파일
84
+ .env
85
+ .env.local
86
+ .env.*.local
87
+
88
+ # 시크릿 관련
89
+ *.pem
90
+ *.key
91
+ credentials.json
92
+ ```
93
+
94
+ ## 클라이언트에 노출되지 않도록 주의
95
+
96
+ ```typescript
97
+ // ❌ 클라이언트 번들에 포함됨
98
+ // app/page.tsx
99
+ const apiKey = process.env.API_SECRET_KEY; // 위험!
100
+
101
+ // ✅ 서버에서만 사용
102
+ // spec/slots/api.slot.ts
103
+ export default Mandu.filling()
104
+ .get(async (ctx) => {
105
+ // 서버 측에서만 접근
106
+ const apiKey = process.env.API_SECRET_KEY;
107
+ const data = await fetchExternalApi(apiKey);
108
+ return ctx.ok({ data }); // apiKey는 반환하지 않음
109
+ });
110
+ ```
111
+
112
+ ## 시크릿 로테이션
113
+
114
+ ```typescript
115
+ // 여러 버전의 시크릿 지원
116
+ const CURRENT_SECRET = process.env.SESSION_SECRET!;
117
+ const PREVIOUS_SECRET = process.env.SESSION_SECRET_PREVIOUS;
118
+
119
+ function verifyToken(token: string): boolean {
120
+ // 현재 시크릿으로 먼저 검증
121
+ if (verify(token, CURRENT_SECRET)) return true;
122
+
123
+ // 이전 시크릿으로도 검증 (로테이션 기간)
124
+ if (PREVIOUS_SECRET && verify(token, PREVIOUS_SECRET)) {
125
+ // 토큰 갱신 권장
126
+ return true;
127
+ }
128
+
129
+ return false;
130
+ }
131
+ ```
132
+
133
+ Reference: [12-Factor App Config](https://12factor.net/config)