Lib.rs

› 密码学 › 神奇豆子 › NiftyGate
#niftygate #proxy #signature #access #certificate #access-control #authentication

bin+lib niftygate-certificate

NiftyGate 独立证书工具

作者 Chris Olstrom

2 个不稳定版本

0.8.0 2022年5月9日
0.7.0 2021年9月10日

#4 in #niftygate


用于 niftygate

MIT 许可证

24KB
574 行

niftygate - 通过 NFT 所有权实现即插即用访问控制

简介

使用任何智能合约（部署在任何区块链上）来访问任何网络上的内容，无需修改您的代码。

概述

如果您将代币视为进入俱乐部门票，那么 NiftyGate 就像是守门人。

  • 兼容典型的代币标准，包括可互换和不可互换的代币（ERC20、ERC721、ERC777 和 ERC1155）。

  • 与通过 WebSockets 与 Web3 通信的任何区块链兼容。

  • 位于任何使用 HTTP 通信的服务的面前。

  • 内置客户端应用程序使用模式。

  • 与支持 HTTP 标头的任何认证系统集成。

  • 包含选择、部署、调试和审计兼容智能合约的工具。

  • 所有这些都作为单个自包含的二进制文件提供。

  • 跨平台（已在 Linux 和 macOS 上进行测试，应该在其他地方也能工作）。

  • 开源（MIT 许可），用 Rust 编写。

这是什么？

niftygate 是一个 HTTP 服务的代理，用于验证签名，为这些服务提供认证层。它还具有自动将签名注入请求中的客户端功能。

我能用它来做什么？

截至 0.2，支持智能合约。这些合约允许使用代币作为可转让的许可，用于访问门控服务。

一些示例

  • 一个允许授权用户下载资产的 OCI 仓库。
  • 一个允许项目支持者获得优先支持的问题跟踪器。
  • 一个允许客户按比例投票权决定功能开发的路线图。
  • 一个需要 N 个授权用户中的 M 个才能发布到生产的部署管道。
  • 一个具有去中心化许可证的应用商店，作者保留许可控制权，而不是平台。
  • 一个数字图书馆，借阅由代币管理，归还由智能合约强制执行。

为什么存在这个？

这实际上是两个问题，让我们来分解一下...

这个概念为什么有用？

基于签名的身份验证避免了基于密码身份验证的许多陷阱。服务器只需要知道公钥，如果那些泄露了...谁会在意呢？它们是公开的公钥。

假设两种情况下都有合理的用户界面，用户可以像更改密码一样轻松地更换密钥。他们可以将一部分权限委托给其他密钥（就像我们在其他地方处理访问令牌一样）。

密钥是用户生成的，而不是用户记忆的。这完全消除了密码重复等问题。

为什么这种方法实用？

以代理的形式实现它，允许在不修改的情况下将其应用于大多数现有的HTTP(S)应用。

将签名与验证分离，可以更细致地控制哪些可以访问私钥。这也意味着代理可以仅在使用时使用。如果客户端应用程序可以本地处理签名，那么它应该这样做。

将其作为一组可组合的中间件实现，使其简单易扩展，并可以（负责任地）试验新功能。

如果您喜欢这种类型的工具，可以将其部署为边车容器。

我如何获得这个卓越的工具？

cargo install niftygate

或者，如果您喜欢Docker

docker pull colstrom/niftygate:0.8.0

我该如何使用它？

首先，您需要某种类型的服务，您希望将其置于代理之前。

为了演示和开发目的，niftygate包含一个嵌入式示例服务，该服务在响应体中打印请求头。

$ niftygate demo
tide::log Logger started
    level DEBUG
tide::server Server listening on http://127.0.0.1:8080

接下来，您需要有一个Ethereum JSON-RPC (Web3)服务，以便niftygate可以与之交互。Ganache是本地使用的优秀选择，因此本文档假定您使用它。

首先，选择您想要用于签名的地址：截图显示如何在Ganache中选择地址

然后，找到此地址的私钥：截图显示在哪里可以找到Ganache中的私钥

将此私钥添加到环境变量中

使用fish

set -x SECRET_KEY_DATA PUT_THE_DATA_HERE

使用旧式外壳如bash

export SECRET_KEY_DATA=PUT_THE_DATA_HERE

现在您可以运行它了！让我们看看帮助信息

$ niftygate web3 --help

niftygate-web3 0.1.0
Runs the proxy service

USAGE:
    niftygate web3 [FLAGS] [OPTIONS]

FLAGS:
    -h, --help                             Prints help information
    -V, --provides-account-verification    verify signatures and provide account addresses
    -B, --provides-balances                provide account balances
    -S, --provides-signatures              provide signatures
        --version                          Prints version information

OPTIONS:
        --address-header <name>        [env: ADDRESS_HEADER=]    [default: X-Web3-Account-Address]
    -b, --backend <url>                [env: BACKEND=]           [default: http://127.0.0.1:8080]
        --balance-header <name>        [env: BALANCE_HEADER=]    [default: X-Web3-Account-Balance]
        --balance-maximum <amount>     [env: BALANCE_MAXIMUM=]
        --balance-minimum <amount>     [env: BALANCE_MINIMUM=]
    -u, --balance-scale <unit>         [env: BALANCE_SCALE=]     [default: Wei]
    -c, --challenge <phrase>           [env: CHALLENGE=]         [default: totes-legit]
    -l, --listen <address>             [env: LISTEN=]            [default: 0.0.0.0:8000]
    -K, --secret-key-data <hex>        [env: SECRET_KEY_DATA=]
    -k, --secret-key-file <path>       [env: SECRET_KEY_FILE=]
        --signature-header <name>      [env: SIGNATURE_HEADER=]  [default: X-Web3-Signature]
    -w, --web3-rpc-url <url>           [env: WEB3_RPC_URL=]      [default: ws://127.0.0.1:7545]

所有这些选项都是可选的，尽管除非您启用至少其中一个选项，否则它不会做任何事情。让我们关注两个场景。

场景1 - 提供签名

在此模式下，niftygate会为它处理的每个请求添加签名。

$ niftygate web3 --provides-signatures
tide::log Logger started
    level DEBUG
tracing::span new
tracing::span build
isahc::agent agent waker listening on 127.0.0.1:61558
isahc::agent agent_thread; port=61558
isahc::agent agent took 409.705µs to start up
tide::server Server listening on http://0.0.0.0:8000

需要秘密（私钥）来签署这些请求，尽管如此。它可以作为文件（--secret-key-file）或十六进制字符串（--secret-key-data）提供。如果两者都提供，则忽略--secret-key-file。这些也可以通过环境变量提供，这正是我们上面所做的。

此密钥用于签署挑战短语（目前由--challenge提供），客户端和服务器都应该知道。它不需要是私有的。

此签名将使用--signature-header提供的头添加到请求中。

场景2 - 提供账户验证

在此模式下，niftygate期望请求包含一个签名头，并将拒绝不包含该头的请求。这些头将被验证，并用于签名的地址将被添加到它处理的每个请求中。

请注意，客户端没有明确提供地址。它们签署一个双方都知道的挑战短语，签名的地址可以从有效的签名中恢复。

$ niftygate web3 --provides-account-verification
tide::log Logger started
    level DEBUG
tracing::span new
tracing::span build
isahc::agent agent waker listening on 127.0.0.1:56181
isahc::agent agent_thread; port=56181
isahc::agent agent took 312.747µs to start up
tide::server Server listening on http://0.0.0.0:8000

如果签名有效，将通过--address-header给出的头将地址添加到请求中。假定后端知道如何处理此头。例如，您可以使用X-Remote-User头将niftygate与Dex集成。

场景3 - 提供账户余额

在此模式下，niftygate期望请求包含一个账户头，并将拒绝不包含该头的请求。此头中给出的地址的余额将被添加到它处理的每个请求中。

$ niftygate web3 --provides-balances
tide::log Logger started
    level DEBUG
tracing::span new
tracing::span build
isahc::agent agent waker listening on 127.0.0.1:54608
isahc::agent agent_thread; port=54608
isahc::agent agent took 313.524µs to start up
tide::server Server listening on http://0.0.0.0:8000

默认情况下，它不会关心余额是多少，它只是将其添加到由--balance-header给出的头中。然而，有一些选项可以基于余额限制访问。

可以使用--balance-minimum选项来要求最低余额。这可以用作“赌注”的一种形式，通过要求非零余额（这可能在防止机器人或协助速率限制方面很有用），或者如果您有其他原因，仅允许大赌注者访问。

可以使用--balance-maximum选项来拒绝余额超过指定金额的账户。这可以用来限制风险，或者如果您愿意，只允许普通百姓访问。

可以使用--balance-unit选项来方便地缩放上述限制。Gwei中有多少个零？无需记住，只需设置--balance-unit=Gwei，niftygate将内部进行缩放。不过，余额头仍然以Wei给出。

说明

上述示例展示了独立使用这些功能，但它们都是作为可组合的中间件实现的。您可以在单个进程中启用所有这些功能。在同一个进程中同时使用签名和验证似乎有些荒谬，但您确实可以这样做。

试试吧！

假设您已启用所有功能，并且代理位于演示应用程序之前，如果您使用curl查询每个应用程序，您将看到以下内容

直接查询演示应用程序

$ curl -s http://127.0.0.1:8080 | sort
accept: ["*/*"]
host: ["127.0.0.1:8080"]
user-agent: ["curl/7.64.1"]

通过代理查询

$ curl -s http://127.0.0.1:8000 | sort
accept-encoding: ["deflate, gzip"]
accept: ["*/*"]
content-length: ["0"]
content-type: ["application/octet-stream"]
forwarded: ["by=127.0.0.1:8000;for=\"127.0.0.1:52698\";host=127.0.0.1:8000;proto=http"]
host: ["127.0.0.1:8000"]
user-agent: ["curl/7.64.1"]
x-web3-address: ["24f9f97c9e540fed57ef81f6c9aeabdb6fc73acd"]
x-web3-balance: ["100000000000000000000"]
x-web3-signature: ["krpQZO9WpgAEso2uk6eAKDy29QjeVtr+gdDZ7iG4bFkYiTfNvTvU5l4bb2iod5F4Ab8a8tJqzXHSXLkyz9U/gRs="]

智能合约

嵌入式预设

为了帮助您开始使用，niftygate嵌入来自OpenZeppelin项目的预设集。它们解决了许多更常见的用例，并且（根据OpenZeppelin文档）是生产就绪的。

目前包括五个预设，以及部署和与每个预设交互的实用程序。这些可以在contract子命令下找到。

为了帮助您确定合适的合约，检查guide子命令。在那里您将找到一个交互式程序，它会问您几个简单的问题，并为您提供建议。

路线图

愿望清单（不分先后顺序）

Infura集成

支持RFC-7486（HTTP源绑定认证）

  • 用随机挑战替换固定消息，添加nonce和过期时间等。

可选端点用于提供嵌入式脚本，以支持浏览器内操作。

X509支持

  • 这将提供一种替代方案，其中更倾向于信任链模型。

PGP支持

  • 这将提供一种替代方案，其中更倾向于信任网络模型。

许可证

niftygate 在MIT许可证下可用。有关完整内容，请参阅LICENSE.txt。

niftygate嵌入合约ABI规范，以及来自OpenZeppelin Contracts的文档摘录。这些内容也按照MIT许可证的条款进行分发此处。

NiftyGate如何帮助我？

我已经有一个网站和一个智能合约

以服务器模式运行niftygate，提供您网站的地址和合约的地址。

我有网站，但我不想使用智能合约

以服务器模式运行niftygate，将niftygate的地址提供给您的网站，然后它将让用户使用他们的钱包登录。

我有非Web应用程序，并且我想与智能合约接口

将niftygate编译为库，并将其嵌入到您的应用程序中。

我有非Web应用程序，但我不想修改我的代码。

以客户端模式运行niftygate，并将您的应用程序指向它。

我正在使用容器平台，如Docker或Kubernetes。

以客户端或服务器模式运行niftygate，作为旁路容器部署。

我正在使用Kubernetes，并且想将智能合约集成到控制器中。

使用contract events --stream模式。这将输出匹配事件作为紧凑的JSON在STDOUT上。

我没有智能合约，但我想有一个。

部署niftygate附带的一个内置合约，无需编写代码！

我不知道我需要什么类型的智能合约。

使用内置的交互式指南。

我没有Ethereum节点要连接。

在infura.io上注册一个账户，并将niftygate指向它。免费账户每天最多允许100k请求，如果您需要更多，他们有付费计划可供选择。

我想使用私有区块链。

试试吧。niftygate的大部分开发都是在私有区块链上完成的。只要它支持JSON-RPC + Web3通过WebSockets，它应该就可以。

Ganache和geth是不错的选择，具体取决于您的需求。

我想使用自己的身份平台。

以服务器模式运行niftygate，并告诉它应该传递哪些头部。

依赖关系

~14MB
~350K SLoC