update new website config (#8)

Tongsuo-Project · May 23, 2024 · c6d8703 · c6d8703
1 parent 85beb76
commit c6d8703
Show file tree

Hide file tree

Showing 49 changed files with 1,728 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Website
 
+[![Netlify Status](https://api.netlify.com/api/v1/badges/12a17f40-c30e-4876-ae84-93b321e34af2/deploy-status)](https://app.netlify.com/sites/tongsuo/deploys)
+
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation

diff --git a/docs/developers/community.md b/docs/developers/community.md
@@ -0,0 +1,23 @@
+---
+sidebar_position: 0
+title: 社区
+---
+
+铜锁密码学开源社区一直致力于保持中立性和多样化，以便更多的社会力量参与其中，提供更多普遍适用的安全技术，为社会创造一个更加安全的互联网环境。
+
+## 铜锁开源社区管理制度
+
+铜锁已经从单一的密码学底层算法库，成长为了一个拥有多个密码学基础设施开源项目的开源社区。为了让社区更好的得到治理和发展，基于实际情况，我们制定了《铜锁开源社区管理制度》并在铜锁官网对社会公开发布：[铜锁开源社区管理制度](https://www.tongsuo.net/bylaws/)
+
+## 铜锁项目管理委员会
+
+铜锁项目管理委员会，简称铜锁PMC，依照《铜锁开源社区管理制度》设立，是铜锁开源社区的对外官方代表和决策机构，行使铜锁开源社区的治理权利。现公布铜锁PMC成员代表（委员）名单和联络方式如下（排名不分先后）：
+
+| 成员姓名 | PMC公司 | 邮箱                          |
+|------|-------|-----------------------------|
+| 张天佳  | 阿里云   | tianjia.ztj@alibaba-inc.com |
+| 李延昭  | 天威诚信  | li_yanzhao@itrus.com.cn     |
+| 杨洋   | 蚂蚁集团  | paul@tongsuo.net            |
+| 金添   | 问天量子  | jintian@qasky.com           |
+| 张志磊  | 360   | zhangzhilei@360.cn          |
+| 李昆阳  | 豪符检测  | li_kunyang@cdhfct.com       |
diff --git a/docs/eco.md b/docs/eco.md
@@ -0,0 +1,26 @@
+---
+sidebar_position: 8
+title: 生态合作
+---
+
+铜锁密码库为应用程序提供密码学算法和安全通信协议的相关能力，同时对底层密码学硬件（包括加密卡等硬件密码模块、加密机、CPU特定指令集等）进行抽象，实现应用程序和硬件设备的无感结合。由此，围绕铜锁密码库可以构建出一种生态效应，即通过铜锁上下游共同对用户提供诸如使用铜锁密码库构建的产品和服务、可以被铜锁调用的密码学硬件设备、围绕铜锁而产生的实用工具等等。
+
+本页面列举出铜锁开源社区的生态伙伴和合作方，旨在为用户提供更加完整的密码学产品和服务。
+
+铜锁开源社区目前不直接提供有偿的商业服务，我们计划由铜锁的生态合作方展开相关业务。
+
+## 开源项目
+
+| 项目 | 说明 |
+| ------ | ------ |
+| Angie | Angie是由原NGINX团队的核心成员创建的新型Web服务器和反向代理服务器，目前已经实现了对Tongsuo的全面集成。Angie和NGINX在ABI层面兼容，因此建议寻求NGINX+Tongsuo的用户可以使用Angie来替代NGINX。 |
+
+## 商业产品、系统和服务
+
+| 厂商   | 说明 |
+|------|------|
+| 天威诚信 | 天威诚信是国内最具影响力的CA厂商，同时也提供多种电子认证相关产品和服务。天威诚信使用铜锁构建其基础密码学能力。如果存在数字证书（如SM2证书等）、电子证据等方面的需求可咨询天威诚信。                                                   |
+| 问天量子 | 问天量子是我国首批从事量子信息技术产业化的企业，也是密标委指定的量子密码标准制定工作组牵头单位。问天量子的商用密码系列产品，如量子随机数生成器，可增强铜锁的真随机数能力，帮助应用程序提升安全水位。                                             |
+| 阿里云  | 阿里云是领先的云计算提供商，其多个云服务使用铜锁提供基础的密码学以及合规能力。此外，龙蜥操作系统对国密也有特定支持，其中龙蜥国密版集成了铜锁，详情可咨询阿里云。                                                               |
+| BTQ  | BTQ是一家注册于列支敦士登的初创公司，其主营业务是提供抗量子计算攻击的前沿密码学产品以期望解决Web3和区块链领域未来的量子威胁。BTQ公司的零知识证明语言编译器Keelung和零知识证明算法加速硬件Kenting分别位列铜锁的上下游环节。与铜锁一起可实现完整的零知识证明解决方案。 |
+| 蚂蚁集团 | 蚂蚁集团起步于2004年诞生的支付宝，是具有影响力的金融科技企业，也是铜锁项目的创始公司和捐赠方。蚂蚁集团自主研发的多种硬件密码设备，例如国密加密卡、同态加密算法加速芯片等，均已实现了和铜锁的适配，可通过铜锁对上层应用程序进行无感支持。 |
diff --git a/docs/intro.md b/docs/intro.md
@@ -14,20 +14,22 @@ title: 关于铜锁
 
 - 技术合规能力
   - 符合GM/T 0028《密码模块安全技术要求》的”软件密码模块安全一级”资质
+  - 符合 GM/T 0005-2021《随机性检测规范》
 - 零知识证明（ZKP）
   - Bulletproofs (Range)
-  - Bulletproofs (R1CS)*
+  - [Bulletproofs (R1CS)](https://www.yuque.com/tsdoc/ts/bulletproofs)
 - 密码学算法
   - 中国商用密码算法：SM2、SM3、SM4、[祖冲之](https://www.yuque.com/tsdoc/ts/copzp3)等
-  - 国际主流算法：ECDSA、RSA、AES、SHA等
-  - 同态加密算法：[EC-ElGamal](https://www.yuque.com/tsdoc/misc/ec-elgamal)、[Paillier](https://www.yuque.com/tsdoc/misc/rdibad)等
-  - 后量子密码学*：LAC、NTRU、Saber、Dilithium等
+  - 国际主流算法：ECDSA、RSA、AES、SHA 等
+  - 同态加密算法：[EC-ElGamal](https://www.yuque.com/tsdoc/misc/ec-elgamal)、[Paillier](https://www.yuque.com/tsdoc/misc/rdibad) 等
+  - 后量子密码学*：LAC、NTRU、Saber、Dilithium 等
 - 安全通信协议
-  - 支持GB/T 38636-2020 TLCP标准，即[双证书国密](https://www.yuque.com/tsdoc/ts/hedgqf)通信协议
-  - 支持[RFC 8998](https://datatracker.ietf.org/doc/html/rfc8998)，即TLS 1.3 +[国密单证书](https://www.yuque.com/tsdoc/ts/grur3x)
-  - 支持[QUIC](https://datatracker.ietf.org/doc/html/rfc9000) API
-  - 支持[Delegated Credentials](https://www.yuque.com/tsdoc/ts/leubbg)功能，基于[draft-ietf-tls-subcerts-10](https://www.ietf.org/archive/id/draft-ietf-tls-subcerts-10.txt)
-  - 支持[TLS证书压缩](https://www.yuque.com/tsdoc/ts/df5pyi)
+  - 支持 GB/T 38636-2020 TLCP 标准，即[双证书国密](https://www.yuque.com/tsdoc/ts/hedgqf)通信协议
+  - 支持 [RFC 8998](https://datatracker.ietf.org/doc/html/rfc8998)，即TLS 1.3+ [国密单证书](https://www.yuque.com/tsdoc/ts/grur3x)
+  - 支持 [QUIC](https://datatracker.ietf.org/doc/html/rfc9000) API
+  - 支持 [Delegated Credentials](https://www.yuque.com/tsdoc/ts/leubbg) 功能，基于 [draft-ietf-tls-subcerts-10](https://www.ietf.org/archive/id/draft-ietf-tls-subcerts-10.txt)
+  - 支持 [TLS 证书压缩](https://www.yuque.com/tsdoc/ts/df5pyi)
   - 支持紧凑TLS协议*
-注：*号表示正在支持中
+
+**注：\*号表示正在支持中**
 
diff --git a/docs/minisuo.md b/docs/minisuo.md
@@ -0,0 +1,51 @@
+---
+sidebar_position: 7
+title: 铜锁迷你版
+---
+铜锁迷你版（tongsuo-mini），简称“迷你锁”，是一个轻量级的密码学算法库，专为嵌入式系统和物联网设备等资源受限场景提供常用的密码学算法和安全传输协议，并可以适应超低内存和存储的极限要求。“迷你锁”通过高度模块化，允许用户在编译时只开启需要的功能，不浪费存储空间。 同时，通过紧凑的内存对齐等方式，压缩运行时内存。
+
+代码仓库地址：https://github.com/Tongsuo-Project/tongsuo-mini
+
+## 构建依赖
+迷你锁依赖于cmake进行构建，以及python工具链进行自动化测试，具体来说，有：
+
+cmake
+python
+pytest
+上述工具在不同操作系统的安装方式也有所不同，请参考对应操作系统的安装说明。以下是在macOS上安装上述构建依赖的一个典型例子（基于homebrew）：
+
+```bash
+brew install cmake
+brew install python
+sudo pip3 install -r test/requirements.txt
+```
+
+## 构建
+
+构建使用cmake，下载源代码后进入源代码根目录执行：
+
+```bash
+mkdir build
+cd build
+cmake ..
+make
+make test
+```
+
+## 特性
+迷你锁（tongsuo-mini）提供如下特性：
+
+- 高度可定制的模块化编译
+- 轻量级密码学算法
+    - ASCON AEAD
+    - ASCON HASH
+- 轻量级安全通信协议
+    - OSCORE
+    - EDHOC
+- 基于可预测逻辑的动态二进制加载能力
+- 传统密码学算法
+    - 商用密码算法：SM2，SM3，SM4
+    - 国际密码学算法：AES，SHA系列，RSA，ECDSA，EdDSA
+- 传统安全通信协议
+    - TLS协议
+    - TLCP协议
diff --git a/docs/release-note/index.md b/docs/release-note/index.md
@@ -4,4 +4,61 @@ title: "版本发布"
 ---
 import DocCardList from '@theme/DocCardList';
 
-<DocCardList />
+<DocCardList />
+
+## 源码包
+
+基于 Github Release 发布版本，下载页面：
+
+https://github.com/Tongsuo-Project/Tongsuo/releases
+
+| 版本    | 维护状态            |
+|-------|-----------------|
+| 8.4.x | 长期维护，至少维护至2029年 |
+| 8.3.x | 长期维护，至少维护至2028年 |
+| 8.2.x | 停止维护            |
+
+## 生态软件
+
+### curl，支持发送国密HTTPS请求
+
+| 操作系统          | 文件               | 签名  |
+|---------------|------------------|-----|
+| Linux         | [curl-Linux](https://gitee.com/Tongsuo/download/raw/master/curl-Linux)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/curl-Linux.asc) |
+| macOS(x86_64) | [curl-macOS](https://gitee.com/Tongsuo/download/raw/master/curl-macOS)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/curl-macOS.asc) |
+| Windows       | [curl-Windows.exe](https://gitee.com/Tongsuo/download/raw/master/curl-Windows.exe) | [gpg](https://gitee.com/Tongsuo/download/raw/master/curl-Windows.exe.asc) |
+
+### wrk，支持国密HTTPS性能测试
+
+| 操作系统          | 文件               | 签名         |
+|-----|-----|-----|
+| Linux         | [wrk-Linux](https://gitee.com/Tongsuo/download/raw/master/wrk-Linux)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/wrk-Linux.asc) |
+| macOS(x86_64) | [wrk-macOS](https://gitee.com/Tongsuo/download/raw/master/wrk-macOS)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/wrk-macOS.asc) |
+
+
+### wget，支持从国密Web服务器下载文件
+
+| 操作系统          | 文件               | 签名  |
+|---------------|------------------|-----|
+| Linux         | [wget-Linux](https://gitee.com/Tongsuo/download/raw/master/wget-Linux)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/wget-Linux.asc) |
+| macOS(x86_64) | [wget-macOS](https://gitee.com/Tongsuo/download/raw/master/wget-macOS)       | [gpg](https://gitee.com/Tongsuo/download/raw/master/wget-macOS.asc) |
+| Windows       | [wget-Windows.exe](https://gitee.com/Tongsuo/download/raw/master/wget-Windows.exe) | [gpg](https://gitee.com/Tongsuo/download/raw/master/wget-Windows.exe.asc) |
+
+
+## 项目公钥
+
+Tongsuo 在发布新版本的时候，会使用项目的私钥对源码包或二进制进行签名，可以使用公钥进行验签，以防止内容被篡改。公钥内容如下：
+
+[Tongsuo-public.key](https://gitee.com/Tongsuo/download/raw/master/Tongsuo-public.key)，验证Tongsuo源码包和生态软件的签名。
+
+注意：对于 Tongsuo < 8.3.3 的源码包，验签使用 [BabaSSL-public.key](https://gitee.com/Tongsuo/download/raw/master/BabaSSL-public.key)。
+
+```bash
+# 下载公钥后导入
+gpg --import Tongsuo-public.key
+
+# 下载软件和对应的签名文件
+
+# 使用公钥验证签名
+gpg --verify --default-key "Tongsuo Project Team" curl-Linux.asc curl-Linux
+```
diff --git a/docs/security.md b/docs/security.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 9
+title: 安全制度
+---
+
+## 报告安全问题
+
+Tongsuo 目前使用蚂蚁集团提供的漏洞收集渠道来接受第三方漏洞的反馈。可以通过：https://security.alipay.com 进行安全漏洞的提交。
+
+## 漏洞等级
+
+Tongsuo 根据漏洞的严重程度和影响范围定义如下几个漏洞等级：
+
+- 高危漏洞：该等级的漏洞一般较容易被利用，并造成严重损失。例如内存内容泄露、用户机密数据泄露、远程拒绝服务等。
+- 中危漏洞：该等级的漏洞相比高危漏洞具有相对较低的风险，并且不是很容易的被利用。
+- 低危漏洞：该等级的漏洞的风险相对较小，一般不会对生产环境引起重大危害。
+
+## 漏洞优先披露制度
+
+对于高危和中危漏洞，Tongsuo 会优先向特定的群体披露漏洞细节和修复方案，在一段时间后（可能是数天或者数周），再对Tongsuo进行公开修复并公告漏洞详情。这样做是为了防止严重的漏洞对关键互联网应用产生重大影响。上述特定的群体包括：
+
+- 默认集成了 Tongsuo 的重要操作系统发行版
+- Tongsuo的 重要商业用户
+- 其他 Tongsuo 技术委员会认为有必要通知的个人或组织
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -5,16 +5,16 @@ import remarkMath from 'remark-math';
 import rehypeKatex from 'rehype-katex';
 
 const config: Config = {
-  title: '铜锁',
-  tagline: 'Tongsuo are so cool',
+  title: 'OpenAtom 铜锁/Tongsuo',
+  tagline: '现代密码学算法和安全通信协议的开源基础密码库',
   favicon: 'img/logo-white.png',
 
   // Set the production url of your site here
-  url: process.env.URL || 'https://Tongsuo-Project.github.io/',
+  url: process.env.URL || 'https://tongsuo.net',
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   // baseUrl: '/docs',
-  baseUrl: process.env.BASEURL || '/docs',
+  baseUrl: process.env.BASEURL || '/',
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
@@ -46,7 +46,7 @@ const config: Config = {
       'classic',
       {
         docs: {
-          routeBasePath: '/',
+          // routeBasePath: '/',
           sidebarPath: './sidebars.ts',
           remarkPlugins: [remarkMath],
           rehypePlugins: [rehypeKatex],
@@ -66,7 +66,7 @@ const config: Config = {
           editUrl:
             'https://github.com/Tongsuo-Project/docs/tree/main',
         },
-        pages: false,
+        // pages: false,
         theme: {
           customCss: './src/css/custom.css',
         },
@@ -103,10 +103,13 @@ const config: Config = {
           type: 'docSidebar',
           sidebarId: 'tutorialSidebar',
           position: 'left',
-          label: '文档',
+          label: '📑 文档',
         },
-        {to: '/blog', label: '博客', position: 'left'},
-        {to: '/release-note', label: '版本发布', position: 'right'},
+        {to: '/blog', label: '🌐 博客', position: 'left'},
+        {to: '/docs/minisuo', label: '铜锁迷你版', position: 'right'},
+        {to: '/docs/eco', label: '生态合作', position: 'right'},
+        {to: '/docs/release-note', label: '版本发布', position: 'right'},
+        {to: '/docs/developers/community', label: '社区', position: 'right'},
         {href: 'https://www.yuque.com/tsdoc/api', label: 'API', position: 'right'},
         {
           href: 'https://github.com/Tongsuo-Project/Tongsuo',
@@ -121,22 +124,50 @@ const config: Config = {
     },
     footer: {
       style: 'dark',
-      logo: {
-        alt: 'OpenAtom Logo',
-        src: 'img/atom-logo.svg',
-        href: 'https://openatom.cn/',
-        width: 200,
-      },
       links: [
         {
-            html: `
-            <div style="text-align: center;">
-            Tongsuo is a <a href="https://www.openatom.org/">OpenAtom Foundation</a> incubation project.
-            <div>
-              `,
+        title: '文档',
+        items: [{
+            label: '📜 关于铜锁',
+            to: '/docs',
+        },{
+            label: '🔖  文档贡献指南',
+            to: '/docs/developers/docs-deployment',
+        }],
+      }, {
+        title: '社区',
+        items: [
+        {
+          html: `
+            <a class="footer-link footer__link-item">
+            📌 微信公众号 
+              <img src="img/tongsuo-public-qr.jpg" class="footer-hover-image" />
+            </a>
+          `,
         },
-      ],
-      copyright: `Copyright © ${new Date().getFullYear()} OpenAtom Tongsuo Built with Docusaurus.`,
+        {
+          label: '🔗 钉钉',
+          href: 'https://qr.dingtalk.com/action/joingroup?code=v1,k1,xVyEWk6BdAnER48i9DR8r0C2im4bAF64/NyQW5fqOz0=&_dt_no_comment=1&origin=11? 郭旭东邀请你加入钉钉群聊铜锁社区交流群，点击进入查看详情',
+        },],
+      }, 
+      {
+        title: '更多',
+        items: [{
+          label: '🦀 RustyVault',
+          href: `https://github.com/Tongsuo-Project/RustyVault`,
+        }, {
+          label: '📦 Crates',
+          href: 'https://crates.io/crates/rusty_vault',
+        }],
+      },
+    ],
+    logo: {
+      alt: 'OpenAtom Logo',
+      src: 'img/atom-logo.svg',
+      href: 'https://openatom.cn/',
+      // width: 200,
+    },
+    copyright: `Copyright © 2021-${new Date().getFullYear()} OpenAtom Tongsuo Built with Docusaurus. <br/><a class="footer__link-item" href="https://beian.miit.gov.cn/">网站备案：京ICP备15032932号-36`,
     },
     prism: {
       additionalLanguages: [

diff --git a/package.json b/package.json
@@ -23,6 +23,10 @@
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
+    "react-icons": "^5.2.1",
+    "react-markdown": "^9.0.1",
+    "react-spring": "^9.7.3",
+    "react-swipeable": "^7.0.1",
     "rehype-katex": "7",
     "remark-math": "6"
   },