内容

• 依赖项
• 安装
• 用法
  • 文件
  • 消息
  • 配置
    • 白名单
    • 签名证书
    • 种子密钥
• 接收者信息
• 存储
• 更新
• 路线图
• 贡献
• 许可协议
• 技术细节

依赖项

• bash, curl, tar: 安装这些实用程序。

安装

要使用 scs，

yarn add @onboardbase/secure-share # npm i @onboardbase/secure-share

或者，如果你的机器上安装了 Rust

cargo install scs

或者，使用 curl

curl https://onboardbase.github.io/secure-share-sh/ | bash

备注

• 对于 Windows 用户，请使用 Git Bash 或任何其他带有 Bourne Shell 的 CLI。
• 对于使用 Rust 的机器，确保 rustup 目录在您的 PATH 中。

scs --help

您应该会看到一个显示 scs 服务的响应。

Share anything with teammates across machines via CLI.

Usage: scs [OPTIONS] <MODE>

Arguments:
  <MODE>  The mode (send secrets, or receive secrets). e,g `scs send` or `scs receive`
Options:
  -s, --secret <SECRET>
          Separated list of secrets to share. The key-Value pair is separated by a comma. "my_key,my_value"
  -m, --message <MESSAGE>
          List of messages or a message string to deliver to the receiver. e,g -m "Hi there" -m "See me"
  -f, --file <FILE>
          List of file paths of files to deliver to the receiver. e,g -f "/path/to/file1" -f "../path/to/file2"
  -r, --remote-peer-id <REMOTE_PEER_ID>
          Peer ID of the remote to send secrets to
  -p, --port <PORT>
          Port to establish a connection on
  -d, --debug...
          Turn debugging information on
  -h, --help
          Print help
  -V, --version
          Print version

用法

scs 允许在不同机器和不同网络背后的团队成员之间传输秘密或消息。要分享一个秘密，发送者和接收者必须像上面描述的那样获取 scs 并遵循以下说明。

接收者

打开终端或 cd 到 scs 安装的位置，然后

scs receive

scs 以监听模式启动并分配一个 PeerId，并随机选择一个端口开始。可选的 -p 标志可以用来指定端口。应该会显示如下类似的响应

INFO  Your PeerId is: 12D3KooWA768LzHMatxkjD1f9DrYW375GZJr6MHPCNEdDtHeTNRt
INFO  Listening on "/ip4/172.19.192.1/tcp/54654"
INFO  Listening on "/ip4/192.168.0.197/tcp/54654"
INFO  Listening on "/ip4/127.0.0.1/tcp/54654"
INFO  Listening on "/ip4/157.245.40.97/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN/p2p-circuit/p2p/12D3KooWA768LzHMatxkjD1f9DrYW375GZJr6MHPCNEdDtHeTNRt"

发送者

获取您想发送秘密的队友的 PeerId，然后

scs send -r 12D3KooWA768LzHMatxkjD1f9DrYW375GZJr6MHPCNEdDtHeTNRt -s "hello, world"

scs 会打印出您的 IP 地址和您的 PeerId。为了验证连接是否建立以及您的机器是否可以与队友通信，您应该在终端中看到类似以下内容

INFO  Your PeerId is: 12D3KooWRpqX3QUvPNHXW5utkceLbx2b1LKfuAKa3iLdXXBGB2bY
INFO  Listening on "/ip4/127.0.0.1/tcp/40479"
INFO  Listening on "/ip4/192.168.212.254/tcp/40479"
INFO  Established connection to 12D3KooWA768LzHMatxkjD1f9DrYW375GZJr6MHPCNEdDtHeTNRt via /ip4/157.245.40.97/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN/p2p-circuit/p2p/12D3KooWA768LzHMatxkjD1f9DrYW375GZJr6MHPCNEdDtHeTNRt

发送者尝试发送秘密，如果成功，scs 会将消息转发给双方，并通知他们秘密共享会话的状态和进度。

文件

scs 也支持发送文件

scs send -r 12D3KooWLaLnHjKhQmB46jweVXCDKVy4AL58a4S4ZgHZGuJkzBf9 -f ../path/to/file1 -f path/to/file2

消息

普通消息也可以共享

scs send -r 12D3KooWLaLnHjKhQmB46jweVXCDKVy4AL58a4S4ZgHZGuJkzBf9 -m "hi there" -m "foo"

这三个项目也可以一起发送。

配置

截至 v0.0.12，scs 允许传递配置文件。端口、白名单和项目都可以直接配置，而不是作为参数传递。示例配置文件可以在这里找到。例如

port: 5555 #An optional port defaults to 0 if not present
save_path: "default"
secret: # Optional during receive
  - key: foo
    value: bar
  - key: baz
    value: woo
message: # Optional during receive
  - new message from me
  - test message
file: # Optional during receive
  - "./dev_build.sh"
debug: 1 # Compulsory. 0 is for off, and 1 and above for on
blacklists:
  - 34.138.139.178
whitelists:
  - 34.193.14.12
connection: trusted # or self
seed: "scsiscool"

scs receive -c ./config.yml

scs send -r 12D3KooWLaLnHjKhQmB46jweVXCDKVy4AL58a4S4ZgHZGuJkzBf9 -c ./config.yml

scs send -n dante -c config.yml

scs list