mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-16 23:03:21 +01:00
bd4c7ce578
This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
142 lines
5.7 KiB
Markdown
142 lines
5.7 KiB
Markdown
---
|
||
date: "2023-05-23T09:00:00+08:00"
|
||
title: "GPG 提交签名"
|
||
slug: "signing"
|
||
sidebar_position: 50
|
||
toc: false
|
||
draft: false
|
||
aliases:
|
||
- /zh-cn/signing
|
||
menu:
|
||
sidebar:
|
||
parent: "administration"
|
||
name: "GPG 提交签名"
|
||
sidebar_position: 50
|
||
identifier: "signing"
|
||
---
|
||
|
||
# GPG 提交签名
|
||
|
||
Gitea 将通过检查提交是否由 Gitea 数据库中的密钥签名，或者提交是否与 Git 的默认密钥匹配，来验证提供的树中的 GPG 提交签名。
|
||
|
||
密钥不会被检查以确定它们是否已过期或撤销。密钥也不会与密钥服务器进行检查。
|
||
|
||
如果找不到用于验证提交的密钥，提交将被标记为灰色的未锁定图标。如果提交被标记为红色的未锁定图标，则表示它使用带有 ID 的密钥签名。
|
||
|
||
请注意：提交的签署者不必是提交的作者或提交者。
|
||
|
||
此功能要求 Git >= 1.7.9，但要实现全部功能，需要 Git >= 2.0.0。
|
||
|
||
## 自动签名
|
||
|
||
有许多地方 Gitea 会生成提交：
|
||
|
||
- 仓库初始化
|
||
- Wiki 更改
|
||
- 使用编辑器或 API 进行的 CRUD 操作
|
||
- 从合并请求进行合并
|
||
|
||
根据配置和服务器信任，您可能希望 Gitea 对这些提交进行签名。
|
||
|
||
## 安装和生成 Gitea 的 GPG 密钥
|
||
|
||
如何安装签名密钥由服务器管理员决定。Gitea 目前使用服务器的 `git` 命令生成所有提交，因此将使用服务器的 `gpg` 进行签名（如果配置了）。管理员应该审查 GPG 的最佳实践 - 特别是可能建议仅安装签名的子密钥，而不是主签名和认证的密钥。
|
||
|
||
## 通用配置
|
||
|
||
Gitea 的签名配置可以在 `app.ini` 的 `[repository.signing]` 部分找到：
|
||
|
||
```ini
|
||
...
|
||
[repository.signing]
|
||
SIGNING_KEY = default
|
||
SIGNING_NAME =
|
||
SIGNING_EMAIL =
|
||
INITIAL_COMMIT = always
|
||
CRUD_ACTIONS = pubkey, twofa, parentsigned
|
||
WIKI = never
|
||
MERGES = pubkey, twofa, basesigned, commitssigned
|
||
|
||
...
|
||
```
|
||
|
||
### `SIGNING_KEY`
|
||
|
||
首先讨论的选项是 `SIGNING_KEY`。有三个主要选项：
|
||
|
||
- `none` - 这将阻止 Gitea 对任何提交进行签名
|
||
- `default` - Gitea 将使用 `git config` 中配置的默认密钥
|
||
- `KEYID` - Gitea 将使用具有 ID `KEYID` 的 GPG 密钥对提交进行签名。在这种情况下，您应该提供 `SIGNING_NAME` 和 `SIGNING_EMAIL`，以便显示此密钥的信息。
|
||
|
||
`default` 选项将读取 `git config` 中的 `commit.gpgsign` 选项 - 如果设置了该选项，它将使用 `user.signingkey`、`user.name` 和 `user.email` 的结果。
|
||
|
||
请注意：通过在 Gitea 的仓库中调整 Git 的 `config` 文件，可以使用 `SIGNING_KEY=default` 为每个仓库提供不同的签名密钥。然而，这显然不是一个理想的用户界面，因此可能会发生更改。
|
||
|
||
**自 1.17 起**，Gitea 在自己的主目录 `[git].HOME_PATH`（默认为 `%(APP_DATA_PATH)/home`）中运行 git，并使用自己的配置文件 `{[git].HOME_PATH}/.gitconfig`。
|
||
如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。
|
||
与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。
|
||
如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。
|
||
|
||
### `INITIAL_COMMIT`
|
||
|
||
此选项确定在创建仓库时，Gitea 是否应该对初始提交进行签名。可能的取值有：
|
||
|
||
- `never`：从不签名
|
||
- `pubkey`：仅在用户拥有公钥时进行签名
|
||
- `twofa`：仅在用户使用 2FA 登录时进行签名
|
||
- `always`：始终签名
|
||
|
||
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true，则提交将被签名。
|
||
|
||
### `WIKI`
|
||
|
||
此选项确定 Gitea 是否应该对 Wiki 的提交进行签名。可能的取值有：
|
||
|
||
- `never`：从不签名
|
||
- `pubkey`：仅在用户拥有公钥时进行签名
|
||
- `twofa`：仅在用户使用 2FA 登录时进行签名
|
||
- `parentsigned`：仅在父提交已签名时进行签名。
|
||
- `always`：始终签名
|
||
|
||
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true，则提交将被签名。
|
||
|
||
### `CRUD_ACTIONS`
|
||
|
||
此选项确定 Gitea 是否应该对 Web 编辑器或 API CRUD 操作的提交进行签名。可能的取值有：
|
||
|
||
- `never`：从不签名
|
||
- `pubkey`：仅在用户拥有公钥时进行签名
|
||
- `twofa`：仅在用户使用 2FA 登录时进行签名
|
||
- `parentsigned`：仅在父提交已签名时进行签名。
|
||
- `always`：始终签名
|
||
|
||
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true，则更改将被签名。
|
||
|
||
### `MERGES`
|
||
|
||
此选项确定 Gitea 是否应该对 PR 的合并提交进行签名。可能的选项有：
|
||
|
||
- `never`：从不签名
|
||
- `pubkey`：仅在用户拥有公钥时进行签名
|
||
- `twofa`：仅在用户使用 2FA 登录时进行签名
|
||
- `basesigned`：仅在基础仓库中的父提交已签名时进行签名。
|
||
- `headsigned`：仅在头分支中的头提交已签名时进行签名。
|
||
- `commitssigned`：仅在头分支中的所有提交到合并点的提交都已签名时进行签名。
|
||
- `approved`：仅对已批准的合并到受保护分支的提交进行签名。
|
||
- `always`：始终签名
|
||
|
||
除了 `never` 和 `always` 之外的选项可以组合为逗号分隔的列表。如果所有选择的选项都为 true，则合并将被签名。
|
||
|
||
## 获取签名密钥的公钥
|
||
|
||
用于签署 Gitea 提交的公钥可以通过 API 获取：
|
||
|
||
```sh
|
||
/api/v1/signing-key.gpg
|
||
```
|
||
|
||
在存在特定于仓库的密钥的情况下，可以通过以下方式获取：
|
||
|
||
```sh
|
||
/api/v1/repos/:username/:reponame/signing-key.gpg
|
||
```
|