Repository navigation
Expand file tree
/
Copy pathvocs.config.ts
More file actions
799 lines (788 loc) · 42.2 KB
/
Copy pathvocs.config.ts
File metadata and controls
799 lines (788 loc) · 42.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
import { readFileSync } from 'node:fs'
import { Changelog, defineConfig } from 'vocs/config'
function siteVersion(): string {
try {
const raw = readFileSync('VERSION', 'utf8').trim()
if (raw) return raw.startsWith('v') ? raw : `v${raw}`
} catch {}
return 'v0.0.0'
}
const isMainBranch = process.env.CF_PAGES_BRANCH === 'main'
const config = {
srcDir: 'docs',
renderStrategy: 'full-static' as const,
head(path: string) {
const cleanPath = path.replace(/\/index\.html$/, '').replace(/\.html$/, '').replace(/\/$/, '')
return { canonical: `https://frameworks.securityalliance.org${cleanPath || '/'}` }
},
banner: {
content: 'This is a work in progress and releases are experimental. We are looking for volunteers. See [Issues](https://github.com/security-alliance/frameworks/issues) and [Contribution](https://github.com/security-alliance/frameworks/blob/develop/docs/pages/contribute/contributing.mdx) to know how to collaborate, or [chip in to keep this work going](https://securityalliance.org/donate).',
height: '30px',
backgroundColor: '#8b5cf6',
textColor: 'white',
dismissable: false
},
title: 'Security Frameworks by SEAL',
titleTemplate: '%s',
description: 'Comprehensive security framework documentation for Web3 projects and blockchain security best practices.',
logoUrl: 'https://frameworks-static.s3.us-east-2.amazonaws.com/images/logo/frameworks-full.svg',
iconUrl: 'https://frameworks-static.s3.us-east-2.amazonaws.com/images/logo/favicon.svg',
ogImageUrl: 'https://frameworks-static.s3.us-east-2.amazonaws.com/images/logo/frameworks-full-cropped.png',
checkDeadlinks: "warn" as const,
changelog:
typeof Changelog !== 'undefined'
? Changelog.github({ repo: 'security-alliance/frameworks' })
: undefined,
topNav: [
{
text: siteVersion(),
items: [
{ text: 'Changelog', link: '/changelog' },
{ text: 'Contributing', link: '/contribute/contributing' },
{ text: 'Support the project', link: 'https://securityalliance.org/donate' },
],
},
],
sidebar: [
{
text: 'Introduction',
collapsed: false,
items: [
{ text: 'Introduction to Frameworks', link: '/intro/introduction' },
{ text: 'How to Navigate the Website', link: '/intro/how-to-navigate-the-website' },
{ text: 'Overview of each Framework', link: '/intro/overview-of-each-framework' },
]
},
{
text: 'Interactive content',
collapsed: false,
items: [
{ text: 'Attack Surface Overview', link: '/intro/attack-surface' },
{ text: 'Security Map', link: '/intro/security-map' },
]
},
{
text: 'Frameworks',
collapsed: false,
items: [
{
text: 'AI Security',
collapsed: true,
items: [
{ text: 'Overview', link: '/ai-security/overview' },
{ text: 'Prompt Injection Defenses', link: '/ai-security/prompt-injection-defenses' },
{ text: 'AI Browsers', link: '/ai-security/ai-browsers' },
{ text: 'AI Workflows: Developers vs Non-Developers', link: '/ai-security/ai-workflows-developers-vs-non-developers' },
{ text: 'Data Exfiltration via Generative Systems', link: '/ai-security/data-exfiltration-via-generative-systems' },
{ text: 'Execution-Path Enforcement', link: '/ai-security/execution-path-enforcement' },
{ text: 'DevSecOps Isolation & Sandboxing (Brief Reference)', link: '/ai-security/devsecops-isolation-sandboxing-reference' },
]
},
{
text: 'Awareness',
collapsed: true,
items: [
{ text: 'Overview', link: '/awareness/overview' },
{ text: 'Core Awareness Principles', link: '/awareness/core-awareness-principles' },
{ text: 'Understanding Threat Vectors', link: '/awareness/understanding-threat-vectors' },
{ text: 'Cultivating a Security-Aware Mindset', link: '/awareness/cultivating-a-security-aware-mindset' },
{ text: 'Staying Informed & Continuous Learning', link: '/awareness/staying-informed-and-continuous-learning' },
{ text: 'Resources & Further Reading', link: '/awareness/resources-and-further-reading' },
]
},
{
text: 'Community Management',
collapsed: true,
items: [
{ text: 'Overview', link: '/community-management/overview' },
{ text: 'Discord', link: '/community-management/discord' },
{ text: 'Twitter', link: '/community-management/twitter' },
{ text: 'Telegram', link: '/community-management/telegram' },
{ text: 'Matrix', link: '/community-management/matrix' },
{ text: 'Session', link: '/community-management/session' },
{ text: 'SimpleX', link: '/community-management/simplex' },
]
},
{
text: 'DevSecOps',
collapsed: true,
items: [
{ text: 'Overview', link: '/devsecops/overview' },
{
text: 'Isolation & Sandboxing',
collapsed: false,
items: [
{ text: 'Sandboxing & Isolation', link: '/devsecops/isolation/sandboxing-and-isolation' },
{ text: 'Execution Sandboxing', link: '/devsecops/isolation/execution-sandboxing' },
{ text: 'Capability-Based Isolation', link: '/devsecops/isolation/capability-based-isolation' },
{ text: 'Sandboxing for Tool Execution', link: '/devsecops/isolation/sandboxing-for-tool-execution' },
{ text: 'Network & Resource Isolation', link: '/devsecops/isolation/network-and-resource-isolation' },
{ text: 'Sandboxing & Policy Enforcement', link: '/devsecops/isolation/sandboxing-and-policy-enforcement' },
{ text: 'Execution Sandboxing: A Practical Guide', link: '/devsecops/isolation/execution-sandboxing-practical-guide' },
{ text: 'Developer Machine Sandboxing', link: '/devsecops/isolation/developer-machine-sandboxing' },
]
},
{
text: 'Developer-Targeted Intrusions',
collapsed: false,
items: [
{ text: 'Overview', link: '/devsecops/developer-targeted-intrusions/overview' },
{ text: 'Execution Paths in Untrusted Code', link: '/devsecops/developer-targeted-intrusions/execution-paths' },
{ text: 'Handling Untrusted Code', link: '/devsecops/developer-targeted-intrusions/handling-untrusted-code' },
],
},
{ text: 'Code Signing', link: '/devsecops/code-signing' },
{ text: 'Continuous Integration and Deployment', link: '/devsecops/continuous-integration-continuous-deployment' },
{ text: 'Data Security Checklist', link: '/devsecops/data-security-upgrade-checklist' },
{ text: 'Governance Proposal Security Across the SDLC', link: '/devsecops/governance-proposal-security' },
{ text: 'Integrated Development Environments', link: '/devsecops/integrated-development-environments' },
{
text: 'Policy as Code',
collapsed: false,
items: [
{ text: 'Overview', link: '/devsecops/policy-as-code/overview' },
{ text: 'Policy in the CI Pipeline', link: '/devsecops/policy-as-code/ci-pipeline' },
{ text: 'Policy in Release and Runtime', link: '/devsecops/policy-as-code/release-and-runtime' },
{ text: 'Governing the Policy Set', link: '/devsecops/policy-as-code/governance' },
]
},
{ text: 'Repository Hardening', link: '/devsecops/repository-hardening' },
{ text: 'Security Testing', link: '/devsecops/security-testing' },
]
},
{
text: 'DPRK IT Workers',
collapsed: true,
items: [
{ text: 'Overview', link: '/dprk-it-workers/overview' },
{ text: 'General Information', link: '/dprk-it-workers/general-information' },
{ text: 'Techniques, Tactics and Procedures', link: '/dprk-it-workers/techniques-tactics-and-procedures' },
{ text: 'Mitigating DPRK IT Workers', link: '/dprk-it-workers/mitigating-dprk-it-workers' },
{ text: 'Case Studies', link: '/dprk-it-workers/case-studies' },
{ text: 'Summary', link: '/dprk-it-workers/summary' },
]
},
{
text: 'Encryption',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/encryption/overview', dev: true },
{ text: 'Cloud Data Encryption', link: '/encryption/cloud-data-encryption', dev: true },
{ text: 'Communication Encryption', link: '/encryption/communication-encryption', dev: true },
{ text: 'Database Encryption', link: '/encryption/database-encryption', dev: true },
{ text: 'Email Encryption', link: '/encryption/email-encryption', dev: true },
{ text: 'Encryption in Transit', link: '/encryption/encryption-in-transit', dev: true },
{ text: 'File Encryption', link: '/encryption/file-encryption', dev: true },
{ text: 'Full Disk Encryption', link: '/encryption/full-disk-encryption', dev: true },
{ text: 'Hardware Encryption', link: '/encryption/hardware-encryption', dev: true },
{ text: 'Partition Encryption', link: '/encryption/partition-encryption', dev: true },
{ text: 'Volume Encryption', link: '/encryption/volume-encryption', dev: true },
]
},
{
text: 'ENS',
collapsed: true,
items: [
{ text: 'Overview', link: '/ens/overview' },
{ text: 'Data Integrity & Verification', link: '/ens/data-integrity-verification' },
{ text: 'Cross-Chain Compatibility', link: '/ens/cross-chain-compatibility' },
{ text: 'Smart Contract Integration', link: '/ens/smart-contract-integration' },
{ text: 'Interface Compliance', link: '/ens/interface-compliance' },
{ text: 'Name Handling & Normalization', link: '/ens/name-handling-normalization' },
]
},
{
text: 'External Security Reviews',
collapsed: true,
items: [
{ text: 'Overview', link: '/external-security-reviews/overview' },
{
text: 'Smart Contract Audits',
collapsed: false,
items: [
{ text: 'Overview', link: '/external-security-reviews/smart-contracts/overview' },
{ text: 'Manual Review', link: '/external-security-reviews/smart-contracts/manual-review' },
{ text: 'Expectations', link: '/external-security-reviews/smart-contracts/expectation' },
{ text: 'Preparation Guide', link: '/external-security-reviews/smart-contracts/preparation' },
{ text: 'Vendor Selection', link: '/external-security-reviews/smart-contracts/vendor-selection' },
]
},
{ text: 'Security Policies and Procedures', link: '/external-security-reviews/security-policies-procedures' },
]
},
{
text: 'Front-End/Web Application',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/front-end-web-app/overview', dev: true },
{ text: 'Web Application Security', link: '/front-end-web-app/web-application-security', dev: true },
{ text: 'Third-Party Script Security', link: '/front-end-web-app/third-party-script-security', dev: true },
{ text: 'Mobile Application Security', link: '/front-end-web-app/mobile-application-security', dev: true },
{ text: 'Common Vulnerabilities', link: '/front-end-web-app/common-vulnerabilities', dev: true },
{ text: 'Security Tools and Resources', link: '/front-end-web-app/security-tools-resources', dev: true },
]
},
{
text: 'Governance',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/governance/overview', dev: true },
{ text: 'Compliance with Regulatory Requirements', link: '/governance/compliance-regulatory-requirements', dev: true },
{ text: 'Risk Management', link: '/governance/risk-management', dev: true },
{ text: 'Security Metrics and KPIs', link: '/governance/security-metrics-kpis', dev: true },
{ text: 'Security Council Best Practices', link: '/governance/council-best-practices', dev: true },
{ text: 'Rebrands & Reorgs', link: '/governance/rebrands-and-reorgs', dev: true },
]
},
{
text: 'Identity and Access Management IAM',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/iam/overview', dev: true },
{ text: 'Role-Based Access Control', link: '/iam/role-based-access-control', dev: true },
{ text: 'Secure Authentication', link: '/iam/secure-authentication', dev: true },
{ text: 'Access Management Best Practices', link: '/iam/access-management', dev: true },
]
},
{
text: 'Incident Management',
collapsed: true,
items: [
{ text: 'Overview', link: '/incident-management/overview' },
{ text: 'Communication Strategies', link: '/incident-management/communication-strategies' },
{ text: 'Incident Detection and Response', link: '/incident-management/incident-detection-and-response' },
{ text: 'Forensic Readiness', link: '/incident-management/forensic-readiness' },
{ text: 'Lessons Learned', link: '/incident-management/lessons-learned' },
{
text: 'Playbooks',
collapsed: false,
items: [
{ text: 'Overview', link: '/incident-management/playbooks/overview' },
{ text: 'Malware Infection', link: '/incident-management/playbooks/malware' },
{ text: 'North Korea (DPRK) Attack', link: '/incident-management/playbooks/hacked-dprk' },
{ text: 'Wallet Drainer Attack', link: '/incident-management/playbooks/hacked-drainer' },
{ text: 'ELUSIVE COMET Attack', link: '/incident-management/playbooks/hacked-elusive-comet' },
{ text: 'SEAL 911 War Room Guidelines', link: '/incident-management/playbooks/seal-911-war-room-guidelines' },
{ text: 'Decentralized Incident Response Framework (DeIRF)', link: '/incident-management/playbooks/decentralized-ir' },
]
},
{
text: 'Incident Response Template',
collapsed: false,
items: [
{ text: 'Overview', link: '/incident-management/incident-response-template/overview' },
{ text: 'Incident Response Policy', link: '/incident-management/incident-response-template/incident-response-policy' },
{ text: 'Roles and Staffing', link: '/incident-management/incident-response-template/roles-and-staffing' },
{ text: 'Communications', link: '/incident-management/incident-response-template/communications' },
{ text: 'Contacts', link: '/incident-management/incident-response-template/contacts' },
{
text: 'Templates',
collapsed: true,
items: [
{ text: 'Overview', link: '/incident-management/incident-response-template/templates/overview' },
{ text: 'Incident Log Template', link: '/incident-management/incident-response-template/templates/incident-log-template' },
{ text: 'Post-Mortem Template', link: '/incident-management/incident-response-template/templates/post-mortem-template' },
{ text: 'Runbook Template', link: '/incident-management/incident-response-template/templates/runbook-template' },
{ text: 'Example Incident Log', link: '/incident-management/incident-response-template/templates/example-incident-log' },
{ text: 'Example Post-Mortem', link: '/incident-management/incident-response-template/templates/example-post-mortem' },
]
},
{
text: 'Runbooks',
collapsed: true,
items: [
{ text: 'Overview', link: '/incident-management/incident-response-template/runbooks/overview' },
{ text: 'Smart Contract Exploit', link: '/incident-management/incident-response-template/runbooks/smart-contract-exploit' },
{ text: 'Key Compromise', link: '/incident-management/incident-response-template/runbooks/key-compromise' },
{ text: 'Endpoint Compromise', link: '/incident-management/incident-response-template/runbooks/endpoint-compromise' },
{ text: 'Frontend Compromise', link: '/incident-management/incident-response-template/runbooks/frontend-compromise' },
{ text: 'DNS Hijack', link: '/incident-management/incident-response-template/runbooks/dns-hijack' },
{ text: 'CDN/Hosting Compromise', link: '/incident-management/incident-response-template/runbooks/cdn-hosting-compromise' },
{ text: 'Dependency Attack', link: '/incident-management/incident-response-template/runbooks/dependency-attack' },
{ text: 'Build Pipeline Compromise', link: '/incident-management/incident-response-template/runbooks/build-pipeline-compromise' },
{ text: 'DDoS Attack', link: '/incident-management/incident-response-template/runbooks/ddos-attack' },
{ text: 'Third-Party Outage', link: '/incident-management/incident-response-template/runbooks/third-party-outage' },
]
},
]
},
]
},
{
text: 'Infrastructure',
collapsed: true,
items: [
{ text: 'Overview', link: '/infrastructure/overview', dev: true },
{ text: 'Asset Inventory', link: '/infrastructure/asset-inventory', dev: true },
{ text: 'Cloud Infrastructure', link: '/infrastructure/cloud', dev: true },
{ text: 'DDoS Protection', link: '/infrastructure/ddos-protection', dev: true },
{
text: 'Domain & DNS Security',
collapsed: false,
items: [
{ text: 'Overview', link: '/infrastructure/domain-and-dns-security/overview' },
{ text: 'DNS Basics & Common Attacks', link: '/infrastructure/domain-and-dns-security/dns-basics-and-attacks' },
{ text: 'DNSSEC, CAA, SMTP DANE and Email Security', link: '/infrastructure/domain-and-dns-security/dnssec-and-email' },
{ text: 'Registrar Security & Registry Locks', link: '/infrastructure/domain-and-dns-security/registrar-and-locks' },
{ text: 'Monitoring, Alerts, and GitOps', link: '/infrastructure/domain-and-dns-security/monitoring-and-alerting' },
]
},
{ text: 'Identity and Access Management', link: '/infrastructure/identity-and-access-management', dev: true },
{ text: 'Network Security', link: '/infrastructure/network-security', dev: true },
{ text: 'Operating System Security', link: '/infrastructure/operating-system-security', dev: true },
{ text: 'Zero-Trust Principles', link: '/infrastructure/zero-trust-principles', dev: true },
]
},
{
text: 'Monitoring',
collapsed: true,
items: [
{ text: 'Overview', link: '/monitoring/overview' },
{ text: 'Guidelines', link: '/monitoring/guidelines' },
{ text: 'Tools', link: '/monitoring/tools' },
{ text: 'Thresholds', link: '/monitoring/thresholds' },
]
},
{
text: 'Multisig for Protocols',
collapsed: true,
items: [
{ text: 'Overview', link: '/multisig-for-protocols/overview' },
{ text: 'Key Takeaways', link: '/multisig-for-protocols/key-takeaways' },
{
text: 'Multisig Administration',
collapsed: false,
items: [
{ text: 'Planning & Classification', link: '/multisig-for-protocols/planning-and-classification' },
{ text: 'Setup & Configuration', link: '/multisig-for-protocols/setup-and-configuration' },
{ text: 'Registration & Documentation', link: '/multisig-for-protocols/registration-and-documentation' },
{ text: 'Communication Setup', link: '/multisig-for-protocols/communication-setup' },
{ text: 'Use-Case Specific Requirements', link: '/multisig-for-protocols/use-case-specific-requirements' },
{
text: 'Operational Runbooks',
collapsed: false,
items: [
{ text: 'Overview', link: '/multisig-for-protocols/runbooks/overview' },
{ text: 'Token Transfer', link: '/multisig-for-protocols/runbooks/token-transfer', },
{ text: 'Signer Rotation', link: '/multisig-for-protocols/runbooks/signer-rotation', },
{ text: 'Threshold Change', link: '/multisig-for-protocols/runbooks/threshold-change', },
{ text: 'Emergency Pause', link: '/multisig-for-protocols/runbooks/emergency-pause', },
]
},
]
},
{
text: 'For Signers',
collapsed: false,
items: [
{ text: 'Joining a Multisig', link: '/multisig-for-protocols/joining-a-multisig' },
{ text: 'Emergency Procedures', link: '/multisig-for-protocols/emergency-procedures' },
{ text: 'Backup Signing & Infrastructure', link: '/multisig-for-protocols/backup-signing-and-infrastructure' },
{ text: 'Personal Security & OPSEC', link: '/multisig-for-protocols/personal-security-opsec' },
{ text: 'Incident Reporting', link: '/multisig-for-protocols/incident-reporting' },
{ text: 'Offboarding', link: '/multisig-for-protocols/offboarding' },
]
},
{ text: 'Implementation Checklist', link: '/multisig-for-protocols/implementation-checklist' },
]
},
{
text: 'Operational Security',
collapsed: true,
items: [
{ text: 'Overview', link: '/opsec/overview' },
{
text: 'OpSec Core Concepts',
collapsed: false,
items: [
{ text: 'Security Fundamentals', link: '/opsec/core-concepts/security-fundamentals' },
{ text: 'Implementation Process', link: '/opsec/core-concepts/implementation-process' },
{ text: 'Web3 considerations', link: '/opsec/core-concepts/web3-considerations' },
]
},
{ text: 'Secure Operating Systems', link: '/opsec/secure-operating-systems' },
{ text: 'Endpoint Security', link: '/opsec/endpoint/overview' },
{ text: 'Browser Security', link: '/opsec/browser/overview', dev: true },
{ text: 'Multi-Factor Authentication', link: '/opsec/mfa/overview' },
{ text: 'Password Management',
collapsed: false,
items: [
{ text: 'Overview', link: '/opsec/passwords/overview' },
{ text: 'Password Managers', link: '/opsec/passwords/managers' },
{ text: 'Single Sign-on', link: '/opsec/passwords/sso' },
{ text: 'Root Accounts', link: '/opsec/passwords/rootaccounts' }
]
},
{ text: 'Google Workspace Security', link: '/opsec/google/overview', dev: true },
{ text: 'Control Domains', link: '/opsec/control-domains/overview', dev: true },
{ text: 'Continuous Improvement & Metrics', link: '/opsec/continuous-improvement-metrics', dev: true },
{ text: 'Integration & Mapping to Other Frameworks', link: '/opsec/integration/overview' },
{
text: 'While Traveling',
collapsed: true,
items: [
{ text: 'Overview', link: '/opsec/travel/overview' },
{ text: 'Guide', link: '/opsec/travel/guide' },
{ text: 'TL;DR', link: '/opsec/travel/tldr', dev: true },
]
},
{ text: 'Appendices', link: '/opsec/appendices/overview', dev: true }
]
},
{
text: 'Physical Security',
collapsed: true,
items: [
{ text: 'Overview', link: '/physical-security/overview' },
{
text: 'Coercion & Duress',
collapsed: true,
items: [
{ text: 'Overview', link: '/physical-security/coercion-and-duress/overview' },
{ text: 'Threat Model', link: '/physical-security/coercion-and-duress/threat-model' },
{ text: 'Risk Factors and Early Signals', link: '/physical-security/coercion-and-duress/risk-factors-and-early-signals' },
{ text: 'Defensive Design Principles', link: '/physical-security/coercion-and-duress/defensive-design-principles' },
{ text: 'Wallet and Key Architecture', link: '/physical-security/coercion-and-duress/wallet-and-key-architecture' },
{ text: 'Personal and Family Safety', link: '/physical-security/coercion-and-duress/personal-and-family-safety' },
{ text: 'Transaction Flows Under Duress', link: '/physical-security/coercion-and-duress/transaction-flows-under-duress' },
{ text: 'Incident Response', link: '/physical-security/coercion-and-duress/incident-response' },
{ text: 'Recovery and Resilience', link: '/physical-security/coercion-and-duress/recovery-and-resilience' },
{ text: 'Checklist', link: '/physical-security/coercion-and-duress/checklist' },
]
},
{
text: 'Facility & Perimeter Security',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/physical-security/facility-and-perimeter/overview', dev: true },
]
},
{
text: 'Physical Counter-Surveillance',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/physical-security/physical-counter-surveillance/overview', dev: true },
]
},
{
text: 'Supply Chain Physical Integrity',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/physical-security/supply-chain-physical-integrity/overview', dev: true },
]
},
]
},
{
text: 'Privacy',
collapsed: true,
items: [
{ text: 'Overview', link: '/privacy/overview', dev: true },
{ text: 'Secure Browsing', link: '/privacy/secure-browsing', dev: true },
{ text: 'Data Removal Services', link: '/privacy/data-removal-services', dev: true },
{ text: 'Digital Footprint', link: '/privacy/digital-footprint', dev: true },
{ text: 'Encrypted Communication Tools', link: '/privacy/encrypted-communication-tools', dev: true },
{ text: 'Financial Privacy Services', link: '/privacy/financial-privacy-services', dev: true },
{ text: 'Privacy-Focused Operating Systems and Tools', link: '/privacy/privacy-focused-operating-systems-tools', dev: true },
{
text: 'VPN Services',
collapsed: false,
items: [
{ text: 'Overview', link: '/privacy/vpns/overview' },
{ text: 'HTTPS vs VPN', link: '/privacy/vpns/https-vs-vpn' },
{ text: 'Attack Surfaces on Public Networks', link: '/privacy/vpns/attack-surfaces-public-networks' },
{ text: 'When to Use a VPN', link: '/privacy/vpns/when-to-use-vpn' },
{ text: 'VPN Limitations', link: '/privacy/vpns/vpn-limitations' },
{ text: 'VPN Providers and Tools', link: '/privacy/vpns/vpn-providers-and-tools' },
],
},
]
},
{
text: 'Safe Harbor',
collapsed: true,
items: [
{ text: 'Overview', link: '/safe-harbor/overview' },
{ text: 'Safe Harbor Eligibility Checklist', link: '/safe-harbor/self-checklist' },
{ text: 'Self-Adoption Guide', link: '/safe-harbor/self-adoption-guide' },
{ text: 'Safe Harbor Scope Terms', link: '/safe-harbor/scope-terms' },
{ text: 'On-Chain Adoption Guide', link: '/safe-harbor/on-chain-adoption-guide' },
{ text: 'Whitehat', link: '/safe-harbor/whitehat' },
]
},
{
text: 'Secure Software Development',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/secure-software-development/overview', dev: true },
{ text: 'Secure Coding Standards Guidelines', link: '/secure-software-development/secure-coding-standards-guidelines', dev: true },
{ text: 'Code Reviews and Peer Audits', link: '/secure-software-development/code-reviews-peer-audits', dev: true },
{ text: 'Secure Code Repositories and Version Control', link: '/secure-software-development/secure-code-repositories-version-control', dev: true },
{ text: 'Threat Modeling and Secure Design Principles', link: '/secure-software-development/threat-modeling-secure-design-principles', dev: true },
]
},
{
text: 'Security Automation',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/security-automation/overview', dev: true },
{ text: 'Threat Detection and Response', link: '/security-automation/threat-detection-response', dev: true },
{ text: 'Compliance Checks', link: '/security-automation/compliance-checks', dev: true },
{ text: 'Infrastructure as Code', link: '/security-automation/infrastructure-as-code', dev: true },
]
},
{
text: 'Security Testing',
collapsed: true,
items: [
{ text: 'Overview', link: '/security-testing/overview' },
{ text: 'Unit Testing', link: '/security-testing/unit-testing' },
{ text: 'Integration Testing', link: '/security-testing/integration-testing' },
{ text: 'Fuzz Testing', link: '/security-testing/fuzz-testing' },
{ text: 'Static Analysis', link: '/security-testing/static-analysis' },
{ text: 'Formal Verification', link: '/security-testing/formal-verification' },
{ text: 'Mutation Testing', link: '/security-testing/mutation-testing' }
]
},
{
text: 'Supply Chain',
collapsed: true,
items: [
{ text: 'Overview', link: '/supply-chain/overview' },
{ text: 'Supply Chain Levels for Software Artifacts', link: '/supply-chain/supply-chain-levels-software-artifacts' },
{ text: 'Dependency Awareness', link: '/supply-chain/dependency-awareness' },
{ text: 'Private Registries and Package Mirrors', link: '/supply-chain/private-registries-and-mirrors' },
{ text: 'Web3 Supply Chain Threats', link: '/supply-chain/web3-supply-chain-threats' },
{ text: 'Vendor Risk Management', link: '/supply-chain/vendor-risk-management' },
{ text: 'Incident Response', link: '/supply-chain/incident-response-supply-chain' },
]
},
{
text: 'Threat Modeling',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/threat-modeling/overview', dev: true },
{ text: 'Create and Maintain Threat Models', link: '/threat-modeling/create-maintain-threat-models', dev: true },
{ text: 'Identify and Mitigate Threats', link: '/threat-modeling/identity-mitigate-threats', dev: true },
]
},
{
text: 'Treasury Operations',
collapsed: true,
items: [
{ text: 'Overview', link: '/treasury-operations/overview' },
{ text: 'Custodial Inventory & Controls', link: '/treasury-operations/classification' },
{ text: 'Registration Documents', link: '/treasury-operations/registration-documents' },
{ text: 'Enhanced Controls for High-Risk Accounts', link: '/treasury-operations/enhanced-controls' },
{ text: 'Guide: Large Cryptocurrency Transfers', link: '/treasury-operations/transaction-verification' },
]
},
{
text: 'User and Team Security',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/user-team-security/overview', dev: true },
{
text: 'Phishing and Social Engineering',
link: '/user-team-security/phishing-social-engineering',
dev: true,
},
{
text: 'Security-Aware Culture',
link: '/user-team-security/security-aware-culture',
dev: true,
},
{ text: 'Security Training', link: '/user-team-security/security-training', dev: true },
]
},
{
text: 'Vulnerability Disclosure',
collapsed: true,
dev: true,
items: [
{ text: 'Overview', link: '/vulnerability-disclosure/overview', dev: true },
{ text: 'Security Contact', link: '/vulnerability-disclosure/security-contact', dev: true },
{ text: 'Bug Bounties', link: '/vulnerability-disclosure/bug-bounties', dev: true },
]
},
{
text: 'Wallet Security',
collapsed: true,
items: [
{ text: 'Overview', link: '/wallet-security/overview' },
{ text: 'Custodial vs Non-Custodial', link: '/wallet-security/custodial-vs-non-custodial' },
{ text: 'Cold vs Hot Wallet', link: '/wallet-security/cold-vs-hot-wallet' },
{ text: 'Software Wallets', link: '/wallet-security/software-wallets', dev: true },
{ text: 'Hardware Wallets', link: '/wallet-security/hardware-wallets', dev: true },
{ text: 'Wallets For Beginners & Small Balances', link: '/wallet-security/for-beginners-and-small-balances' },
{ text: 'Wallets For Intermediates & Medium Funds', link: '/wallet-security/intermediates-and-medium-funds' },
{ text: 'Multisig Wallets For Advanced Users & High Funds', link: '/wallet-security/secure-multisig-best-practices' },
{ text: 'Account Abstraction Wallets', link: '/wallet-security/account-abstraction' },
{ text: 'TEE-based Encumbered Wallets', link: '/wallet-security/encumbered-wallets' },
{ text: 'Signing Schemes', link: '/wallet-security/signing-schemes', dev: true },
{
text: 'Signing & Verification',
collapsed: false,
items: [
{ text: 'Overview', link: '/wallet-security/signing-and-verification/signing-verification' },
{ text: 'Verifying Standard Transactions (EOA)', link: '/wallet-security/signing-and-verification/verifying-standard-transactions' },
{ text: 'Multisig Signing Process', link: '/wallet-security/signing-and-verification/secure-multisig-signing-process' },
{ text: 'Safe Multisig: Step-by-Step Verification', link: '/wallet-security/signing-and-verification/secure-multisig-safe-verification' },
{ text: 'Squads Multisig: Step-by-Step Verification', link: '/wallet-security/signing-and-verification/secure-multisig-squads-verification' },
{ text: 'Using EIP-7702', link: '/wallet-security/signing-and-verification/verifying-7702' },
]
},
{ text: 'Smart Contract Interaction Security', link: '/wallet-security/smart-contract-interaction-security' },
{ text: 'Seed Phrase Management', link: '/wallet-security/seed-phrase-management' },
{ text: 'Tools & Resources', link: '/wallet-security/tools-and-resources' },
]
},
]
},
{
text: 'Guides',
collapsed: false,
items: [
{ text: 'Overview', link: '/guides/overview' },
{
text: 'Account Management',
collapsed: true,
items: [
{ text: 'Overview', link: '/guides/account-management/overview' },
{ text: 'Discord Security', link: '/guides/account-management/discord' },
{ text: 'GitHub Security', link: '/guides/account-management/github' },
{ text: 'GoDaddy Security', link: '/guides/account-management/godaddy' },
{ text: 'Linear Security', link: '/guides/account-management/linear' },
{ text: 'Matrix Security', link: '/guides/account-management/matrix' },
{ text: 'Mercury Security', link: '/guides/account-management/mercury' },
{ text: 'Notion Security', link: '/guides/account-management/notion' },
{ text: 'Render Security', link: '/guides/account-management/render' },
{ text: 'Sentry Security', link: '/guides/account-management/sentry' },
{ text: 'Session Security', link: '/guides/account-management/session' },
{ text: 'Signal Security', link: '/guides/account-management/signal' },
{ text: 'SimpleX Security', link: '/guides/account-management/simplex' },
{ text: 'Slack Security', link: '/guides/account-management/slack' },
{ text: 'Telegram Security', link: '/guides/account-management/telegram' },
{ text: 'Trello Security', link: '/guides/account-management/trello' },
{ text: 'Twitter/X Security', link: '/guides/account-management/twitter' },
{ text: 'Vercel Security', link: '/guides/account-management/vercel' },
]
},
{
text: 'Endpoint Security',
collapsed: true,
items: [
{ text: 'SSH Client and Key Management Hardening', link: '/guides/endpoint-security/ssh-client-and-key-management-hardening' },
{ text: 'Hardware Security Keys', link: '/guides/endpoint-security/hardware-security-keys' },
{ text: 'Password Manager Endpoint Hardening', link: '/guides/endpoint-security/password-manager-endpoint-hardening' },
{ text: 'Zoom Hardening', link: '/guides/endpoint-security/zoom-hardening' },
]
},
]
},
{
text: 'SEAL Certifications',
collapsed: false,
items: [
{ text: 'Overview', link: '/certs/overview' },
{ text: 'Certified Partners', link: '/certs/certified-partners' },
{
text: 'SEAL Certification Frameworks', collapsed: true, items: [
{ text: 'DevOps & Infrastructure', link: '/certs/sfc-devops-infrastructure' },
{ text: 'DNS Registrar', link: '/certs/sfc-dns-registrar' },
{ text: 'Identity & Accounts', link: '/certs/sfc-identity-accounts' },
{ text: 'Incident Response', link: '/certs/sfc-incident-response' },
{ text: 'Multisig Operations', link: '/certs/sfc-multisig-ops' },
{ text: 'Treasury Operations', link: '/certs/sfc-treasury-ops' },
]
},
{ text: 'Certification Guidelines', link: '/certs/certification-guidelines' },
{ text: 'Changelog', link: '/certs/changelog' },
{ text: 'Contributions', link: '/certs/contributions' },
]
},
{
text: 'About this',
collapsed: false,
items: [
{ text: 'What It Is', link: '/intro/what-is-it' },
{ text: 'What It Isn\'t', link: '/intro/what-it-isnt' },
{
text: 'Contributing',
collapsed: false,
items: [
{ text: 'Overview', link: '/contribute/contributing' },
{ text: 'Content Model', link: '/contribute/content-model' },
{ text: 'Style and Terminology', link: '/contribute/style-and-terminology' },
{ text: 'Docs Normalization Checklist', link: '/contribute/docs-normalization-checklist', dev: true },
{ text: 'Spotlight Zone', link: '/contribute/spotlight-zone' },
{ text: 'Stewardship', link: '/contribute/stewards' },
]
},
{ text: 'LLMs', link: '/intro/llms' },
]
}
],
socials: [
{
icon: 'github' as const,
link: 'https://github.com/security-alliance/frameworks',
},
{
icon: 'discord' as const,
link: 'https://discord.com/invite/securityalliance',
},
],
editLink: {
link: 'https://github.com/security-alliance/frameworks/edit/develop/docs/pages/:path',
text: 'Suggest changes to this page'
}
}
function filterDevItems(items: any[]): any[] {
return items
.filter(item => !item.dev)
.map(item => ({
...item,
items: item.items ? filterDevItems(item.items) : undefined,
}))
}
function collectDevLinks(items: any[], parentIsDev = false): Set<string> {
const links = new Set<string>()
for (const item of items) {
const isDev = item.dev || parentIsDev
if (isDev && item.link) links.add(item.link)
if (item.items) {
for (const link of collectDevLinks(item.items, isDev)) links.add(link)
}
}
return links
}
const devOnlyLinks = collectDevLinks(config.sidebar)
if (!isMainBranch && devOnlyLinks.size > 0) {
const devRoutesLiteral = JSON.stringify([...devOnlyLinks])
// @ts-expect-error - head is rebuilt from source so the dev-route list is
config.head = new Function(
'path',
`
const devOnlyLinks = new Set(${devRoutesLiteral});
const cleanPath = path.replace(/\\/index\\.html$/, '').replace(/\\.html$/, '').replace(/\\/$/, '');
if (devOnlyLinks.has(cleanPath)) return { canonical: false };
return { canonical: 'https://frameworks.securityalliance.org' + (cleanPath || '/') };
`,
)
}
if (isMainBranch) {
config.sidebar = filterDevItems(config.sidebar)
}
export default defineConfig(config)