Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/content-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ body:
id: suggested_content
attributes:
label: "What content are you suggesting for?"
description: "Be as specific as possible (e.g., new framework about X, new page on Y framework, update section Z in [framework] to include, etc.)"
description: "Be as specific as possible (e.g., new framework about X, a new page in framework Y, or an update to section Z in [framework])."
placeholder: "Describe what new or updated content you are requesting."
validations:
required: true

- type: textarea
id: why_needed
attributes:
label: "Why do you think this update or modification is needed"
label: "Why do you think this update or modification is needed?"
description: "If it is not self-explanatory, or relatively clear, add a few sentences explaining why it is needed."
placeholder: "Add reasoning or context here."
validations:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/non-content-request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Non Content Request
description: Strategy, tech, or other non-content related issues and ideas.
description: Strategy, tech, or other non-content-related issues and ideas.
body:
- type: markdown
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Thank you for contributing to the Security Frameworks! Before you open a PR, mak
- [ ] Describe your changes, substitute this text with the information
- [ ] If you are touching an existing piece of content, tag current contributors from the attribution list
- [ ] If there is a steward for that framework, ask the steward to review it
- [ ] If you're modifying the general outline, make sure to update it in the `vocs.config.tsx` adding the `dev: true` parameter
- [ ] If you're modifying the general outline, make sure to update it in the `vocs.config.ts` adding the `dev: true` parameter
- [ ] If you need feedback for your content from the wider community, share the PR in our Discord
- [ ] Review changes to ensure there are no typos, see instructions below
- [ ] Review changes to ensure there are no typos; see instructions below.

<!--
ℹ️ Checking for typos locally
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ approved, they will be merged into the **main branch** for publication on the st
## Ways to contribute

There are several ways to contribute, depending on your preference and the scope of your changes.
First, check existing PRs or branches to make sure your work has not been previously ****submitted**.**
First, check existing PRs or branches to make sure your work has not been previously submitted.

### 1. Quick edits

Expand All @@ -64,7 +64,7 @@ deployment through the automated preview and make any final adjustments.
5. **Notify reviewers** by tagging a steward or maintainer, requesting reviews directly in your PR.
6. Additionally, you can paste your PR and/or potential associated issues to the `framework-contribs` Discord channel.
7. Once reviewed and approved, your changes will be merged into `develop`.
8. Don't forget to add yourself to the YAML header of the file you're modifying, given that is the way we provide
8. Don't forget to add yourself to the YAML header of the file you're modifying, since that is how we provide
attribution. You should also create your profile inside the contributors list, at `docs/config/contributors.json`.
9. Periodically, reviewed content from `develop` is merged into `main` for the stable site.

Expand All @@ -91,7 +91,7 @@ The easiest way to get started is using our pre-configured devcontainer with VSC
### Option B: DevContainer CLI Only (No VSCode Required)

Since you won't require extensions for the initiative to work, you can just create a devcontainer using the CLI and
access it through whatever mean you think suits you best.
access it through whatever means you think suits you best.

**Using DevContainer CLI (Recommended):**

Expand Down Expand Up @@ -268,7 +268,7 @@ This helps track contributions and ensures proper attribution.

For a complete frontmatter example, see the [template file](/docs/pages/config/template.mdx).

### 3. Sidebar / Navigation
### 2. Sidebar / Navigation

Because of how we handle the `.org` and `.dev` domains in different branches, when contributing **new pages** you must
also **update `vocs.config.tsx`** so that the page appears in the site’s sidebar. For content still in review, remember
Expand Down Expand Up @@ -373,8 +373,8 @@ Pages with minimal content which need more work to cover the topic need to inclu

## Anything else?

This page is also open for contributions! Suggest improvements to our style and guidelines in the github repo.
This page is also open for contributions! Suggest improvements to our style and guidelines in the GitHub repo.

## About this page

Originally inspired by the [Ethereum Protocol Fellows](https://github.com/eth-protocol-fellows/protocol-studies)
Originally inspired by the [Ethereum Protocol Fellows](https://github.com/eth-protocol-fellows/protocol-studies).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Both versions are continuously updated, but only `main` reflects finalized, comm

## Contributing

The Security Framework is an open and collaborative initiative. Whether you are part of the Security Alliance or not,
The Security Frameworks are an open and collaborative initiative. Whether you are part of the Security Alliance or not,
we welcome your contributions! Help us build the documentation and improve security in the ecosystem. If you'd like
to join our effort, feel free to fix typos, contribute new sections, or propose enhancements.

Expand Down
5 changes: 3 additions & 2 deletions components/shared/tagColors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const TAG_COLORS: Record<string, string> = {
'Community & Marketing': '#5B2371',
'HR': '#285AD2',
'Engineer/Developer': '#B2439F',
'Devops': '#5C234A',
'DevOps': '#5C234A',
'SRE': '#2E51BA',
'SEAL/Initiative': '#4339db',
'Cloud': '#0873B5',
Expand All @@ -26,6 +26,7 @@ export const TAG_COLORS: Record<string, string> = {
'Business Tools': '#3ebbc9',
'Communication Platforms': '#bf9504',
'DevOps Accounts': '#f43e7c',
'Devops': '#c094e6',
}

/**
Expand All @@ -44,4 +45,4 @@ export function getTagColor(tag: string): string {
*/
export function getTagId(tag: string): string {
return tag.toLowerCase().replace(/[^a-z0-9]/g, '-')
}
}
2 changes: 1 addition & 1 deletion docs/pages/certs/contributions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ due to the nature of Certifications, contributions are subject to more stringent
by Isaac, the initiative lead, and the other Certifications maintainers.

- If you have suggestions for improving existing Certifications, or ideas for a new Certification, please open an issue
in the frameworks repo with the `certifications` tag. We're welcome to feedback and ideas from the community!
in the frameworks repo with the `certifications` tag. We welcome feedback and ideas from the community!
- If you're a protocol interested in having your project certified, you can reach out to us through our [protocol
interest form](https://securityalliance.typeform.com/CertsWaitlist).
- If you're a security firm interested in becoming a SEAL-approved auditor, please reach out through our [interest form](https://securityalliance.typeform.com/CertsAuditor).
Expand Down
12 changes: 6 additions & 6 deletions docs/pages/certs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@

SEAL Certifications is a certification framework developed by SEAL to provide standardized guidelines and evaluation
criteria for assessing the security of DeFi protocols. SEAL Certifications provides targeted modular certifications
(e.g., [Incident Response](/certs/sfc-incident-response.mdx), [Treasury Ops](/certs/sfc-treasury-ops.mdx)) that can
(e.g., [Incident Response](/certs/sfc-incident-response), [Treasury Ops](/certs/sfc-treasury-ops)) that can
independently validate specific aspects of a protocol's security posture.

Using SEAL Certifications will help ensure that protocols follow best practices for their security operations, and
provides a standard set of criteria for comparing the security of different protocols.
provide a standard set of criteria for comparing the security of different protocols.

SEAL Certifications is fully open-source and freely available for any protocol to use.

## How it Works

Unlike broad certifications like SOC 2 or ISO 27001, SEAL Certifications focus on specific areas based on the highest
impact needs of protocols, based on what SEAL has observed throughout the industry and in interviews with pilot
Unlike broad certifications like SOC 2 or ISO 27001, SEAL Certifications focus on the highest-impact needs of
protocols, based on what SEAL has observed throughout the industry and in interviews with pilot
protocols. Each certification focuses on a specific area of security and includes controls relevant to that area.
Protocols can use certifications independently to evaluate their security posture through self-assessment, or they can
pursue formal certification through a third-party audit by a SEAL-partnered auditor. After completing a certification
Expand All @@ -51,7 +51,7 @@

## Certifications Being Developed

<ExportAllCerts />

Check failure on line 54 in docs/pages/certs/overview.mdx

View workflow job for this annotation

GitHub Actions / lint

Inline HTML

docs/pages/certs/overview.mdx:54:1 MD033/no-inline-html Inline HTML [Element: ExportAllCerts] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md

- **[DevOps & Infrastructure](/certs/sfc-devops-infrastructure.mdx)** - Development environments, CI/CD pipelines,
infrastructure security, supply chain
Expand Down Expand Up @@ -93,7 +93,7 @@
Attestations are certificates issued on-chain through the [Ethereum Attestation Service
(EAS)](https://ethereum.org/en/developers/docs/standards/tokens/eas/) by SEAL to protocols that successfully complete a
certified audit. Attestations serve as verifiable proof that a protocol has met the requirements of a given SEAL
Certifications certification.
certification.

Attestations do not indicate that a protocol is completely secure or free from issues. Blockchain security is always
evolving and novel vulnerabilities arise regularly. Instead, attestations demonstrate that a protocol has implemented a
Expand Down Expand Up @@ -145,7 +145,7 @@
<summary>How can auditors become certified?</summary>

SEAL works with a group of third-party auditing firms to provide certification audits. For more information on the
process or now to become certified, see our [Certified Auditors](/certs/certified-partners.mdx) page.
process or how to become certified, see our [Certified Auditors](/certs/certified-partners) page.

</details>
<details>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/certs/sfc-dns-registrar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ import { TagList, AttributionList, TagProvider, TagFilter, ContributeFooter, Cer

# SFC - DNS Registrar

The SEAL Framework Checklist (SFC) for DNS Registrar provides best practice for securely managing domain names and DNS configurations.
The SEAL Framework Checklist (SFC) for DNS Registrar provides best practices for securely managing domain names and DNS configurations.

For more details on certifications or self-assessments, refer to the [Certification Guidelines](/certs/certification-guidelines).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/certs/sfc-incident-response.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ import { TagList, AttributionList, TagProvider, TagFilter, ContributeFooter, Cer

# SFC - Incident Response

The SEAL Framework Checklist (SFC) for Incident Response provides structured guidelines to help remain prepared for
The SEAL Framework Checklist (SFC) for Incident Response provides structured guidelines to help teams remain prepared for
security incidents affecting blockchain protocols. It covers team structure, monitoring, alerting, and response
procedures.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/certs/sfc-workspace-security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ cert:
- Scoped to devices and accounts with access to sensitive systems or data
- Device inventory tracks make/model, owner, OS version, encryption status,
and EDR/MDM enrollment
- Account inventory covers organizational accounts (eg. email, cloud, social media)
- Account inventory covers organizational accounts (e.g., email, cloud, social media)
with defined ownership
- Updated as devices/accounts are provisioned or decommissioned
title: Asset Inventory
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/community-management/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { TagList, AttributionList, TagProvider, TagFilter, ContributeFooter } fr
<TagList tags={frontmatter.tags} />
<AttributionList contributors={frontmatter.contributors} />

Communities might be the key of many Web3 projects, but they also represent a significant security challenge. From
Communities might be key to many Web3 projects, but they also represent a significant security challenge. From
casual users to top-level executives, everyone within an organization can be targeted by social engineering tactics
across platforms like Telegram, Discord, X (formerly Twitter), Google, and more. When a community channel is
compromised—whether by phishing, fraudulent links, or account takeovers—it can quickly become a vehicle for wider
Expand All @@ -39,7 +39,7 @@ platform-specific recommendations in more depth.
- Secure the email account linked to your community platforms with a unique password and 2FA.
- Always enable 2FA. Prefer hardware-based tokens (e.g., Yubikey) or mobile authenticator apps over SMS-based methods,
which are vulnerable to SIM-swapping.
- If you use an authenticator app like Authy, 1Password, or Aegis to generate time-based one-time passwords (TOTP).
- If you use an authenticator app like Authy, 1Password, or Aegis to generate time-based one-time passwords (TOTP),
Ensure that the secret keys are stored encrypted and protected with robust security measures.
- Configure your app to require a password, PIN, or biometric authentication (e.g., fingerprint or face recognition) to
unlock access to the tokens. This prevents unauthorized access and ensures the tokens remain secure even if someone
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/community-management/twitter.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Twitter/X Security | Security Alliance"
description: "Protect your X (Twitter) account from SIM swapping: remove your phone number, enable 2FA with authenticator app or security key, and enable password reset protection."
description: "Protect your X (Twitter) account from SIM swapping: remove your phone number, enable 2FA with an authenticator app or security key, and enable password reset protection."
tags:
- Community & Marketing
contributors:
Expand Down
6 changes: 4 additions & 2 deletions docs/pages/config/template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ import { TagList, AttributionList, TagProvider, TagFilter, ContributeFooter } fr
<AttributionList contributors={frontmatter.contributors} />

Key Takeaway prompt: Without removing or modifying anything in the document, just after the heading, describe in a
succint way (no more than 40 words), all the key points or tl;dr so that anyone can get a good grasp of the contents
succinct way (no more than 40 words), all the key points or tl;dr so that anyone can get a good grasp of the contents
just by reading it. Don't add unnecessary sentences that sound like conclusions, like "By ensuring this..." "Doing all
these...", "Having these security practinces...". Use the following format > 🔑 **Key Takeaway**:
these...", "Having these security practices...". Use the following format:

> 🔑 **Key Takeaway**:

[Context / Problem statement. In this first part, we introduce the topic, in no more than a few paragraphs. For example
for Threat Modeling inside Operational Security Framework: "Effective security requires understanding **what you're
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/config/using-contributors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This will display contributors in three sections: "Written by", "Reviewed by", a

## Contributors Database Location

The contributors database is stored in `src/config/contributors.json`. Here's an example of what a contributor entry
The contributors database is stored in `docs/pages/config/contributors.json`. Here's an example of what a contributor entry
looks like:

```json
Expand Down
Loading
Loading