Documentation
¶
Overview ¶
Package sshcred 是 SSH 网关在本机保存「它代为连接的 SSH 主机的登录凭据」的密封库。
为什么在网关而不是 Hub:经网关接入的 SSH 主机,凭据只应该存在于真正去连接它的那台机器上。 Hub 的数据库、备份与日志里因此没有这些凭据;网关换了数据卷或重建容器,凭据随之消失, Hub 在网关上线时会发现并提示管理员重新填写(见 terminal 包的凭据同步)。
存储方式:
- 目录下的 credentials.json 保存 {"v":1,"items":{<SSH 主机机器码>:<密封后的凭据>}},逐条 AES-256-GCM, 附加数据 = 机器码——把 A 的密文换到 B 的名下无法解开;
- 密封密钥默认是同目录下自动生成的 key 文件(0600);也可以用环境变量外置(Options.Key), 外置后不再生成 key 文件,凭据库单独被拷走就无法解开;
- 写入是「临时文件 + 重命名」,崩溃不会留下半截文件;损坏的文件不会被覆盖,库直接报错,留给人处理。
Index ¶
- Constants
- Variables
- type Options
- type Store
- func (s *Store) Delete(id string) (bool, error)
- func (s *Store) Get(id string) (sshexec.Credential, error)
- func (s *Store) Has(id string) bool
- func (s *Store) Len() int
- func (s *Store) Put(id string, c sshexec.Credential) error
- func (s *Store) Retain(keep []string) (have, dropped []string, err error)
Constants ¶
View Source
const ( // MaxItems 是库里最多保存的凭据数(远多于 Hub 允许登记的 SSH 主机数量)。 MaxItems = termproto.MaxSSHKeep )
Variables ¶
View Source
var ( // ErrNotFound 表示库里没有这台 SSH 主机的凭据。 ErrNotFound = errors.New("sshcred: 没有这台主机的凭据") // ErrUnreadable 表示凭据存在但解不开(密钥换过、文件被改动,或密文被搬到了别的主机名下)。 ErrUnreadable = errors.New("sshcred: 凭据无法解开") // ErrFull 表示库已满。 ErrFull = errors.New("sshcred: 凭据库已满") // ErrBadID 表示键不是合法的机器码。 ErrBadID = errors.New("sshcred: 无效的主机码") )
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// Dir 是凭据库目录;不存在则创建(0700,Windows 上再用 Harden 收紧)。
Dir string
// Key 是外置的密封密钥(通常来自环境变量);为空则使用 Dir 下自动生成的 key 文件。
Key string
// Harden 收紧目录访问权限(Windows 设置 ACL);Unix 为 nil。
Harden func(string) error
}
Options 是打开凭据库的参数。
Click to show internal directories.
Click to hide internal directories.