consensys.web3signer

Ansibleロール: Web3Signer

説明

Ansibleロールは、Web3Signerをインストール、設定、実行するためのもので、オープンソースの署名サービスです。

目次

対応プラットフォーム

* Debian
* Ubuntu
* Redhat(CentOS/Fedora)
* Amazon

依存関係

  • JDK 11以上
  • eth2のスラッシング保護が有効な場合はPostgreSQLデータベース

ロール変数:

上書きできるすべての変数は、defaults/main.ymlファイルに保存されています。 これらの変数は主に設定オプションです。 詳細については、Web3Signerのドキュメントを参照してください。

名称 デフォルト値 説明
web3signer_version develop インストールするバージョン
web3signer_user web3signer web3signerを作成・実行するOSユーザー
web3signer_group web3signer OSグループ
web3signer_app_home /opt/web3signer アプリのインストール場所
web3signer_config_path /etc/web3signer 設定ファイルの場所
web3signer_log_path /var/log/web3signer ログファイルの場所
web3signer_log_filename web3signer.log ログファイル名。場所はweb3signer_log_path
web3signer_data_home /data/web3signer 永続データを保存する場所。キーはサブフォルダkeysに保存されます
web3signer_db_verify_connection True データベースの可用性をチェックする
web3signer_db_host PostgreSQLデータベースのインスタンスホスト
web3signer_db_name PostgreSQLデータベース名
web3signer_db_username PostgreSQLデータベースユーザー
web3signer_db_password PostgreSQLデータベースユーザーパスワード
web3signer_flyway_version 7.3.0 Flywayマイグレーション用のCLIバージョン
web3signer_service_name web3signer Systemdサービス名
web3signer_config_filename web3signer.yml 設定ファイル名。場所はweb3signer_config_path
web3signer_command eth2 Web3signerコマンド。サポートされるのはeth1, eth2, filecoin
web3signer_keys [] 設定するキーを指定します。詳細は下記の注意事項を参照してください
web3signer_logging INFO ログの冗長性レベル: OFF, FATAL, WARN, INFO, DEBUG, TRACE, ALL
web3signer_http_listen_host 127.0.0.1 HTTPのリッスンホスト
web3signer_http_listen_port 9000 HTTPのリッスンポート
web3signer_http_host_allowlist ['127.0.0.1'] HTTPアクセスを許可するホスト名のカンマ区切りリスト、または*で任意のホストを受け入れます
web3signer_metrics_enabled False メトリクスエクスポーターを開始する設定
web3signer_metrics_host 127.0.0.1 メトリクスエクスポーターのリッスンホスト
web3signer_metrics_port 9001 メトリクスエクスポーターのリッスンポート
web3signer_metrics_categories ['HTTP', 'SIGNING', 'FILECOIN', 'JVM', 'PROCESS', 'ETH2_SLASHING_PROTECTION'] メトリクスを追跡するためのカテゴリのカンマ区切りリスト
web3signer_metrics_host_allowlist ['127.0.0.1'] メトリクスアクセスを許可するホスト名のカンマ区切りリスト、または*で任意のホストを受け入れます
web3signer_idle_connection_timeout_seconds 30 アイドル接続が切断されるまでの秒数
web3signer_swagger_ui_enabled False Swagger UIを有効にする
web3signer_tls_keystore_file TLSを有効にするために使用するPKCS#12形式のキーストアのパス
web3signer_tls_keystore_password_file キーストアを暗号解除するために使用されるパスワードを含むファイルのパス
web3signer_tls_allow_any_client 定義されている場合、提示された証明書に関係なく、クライアントが接続できます。ホワイトリストまたはCAクライアントが有効な場合、これは設定できません
web3signer_tls_known_client_file 認可されたクライアントのフィンガープリントを含むファイルのパス
web3signer_tls_allow_ca_clients 定義されている場合、CAによって認可されたクライアントがEthSignerに接続できるようになります
web3signer_log4j_config_file 未定義 カスタムlog4j設定ファイル
web3_signer_additional_configuration {} 設定ファイルに設定する追加設定のマップ。Ansibleロールが最近導入されたパラメータで更新されていない場合に設定するのに役立ちます。

署名キーの設定:

ファイルシステムに設定する署名キーは、パラメータweb3signer_keysを使用してマップとして提供する必要があります。マップのキーはキーファイルの名前として使用されます。各キーはキーのファイルを作成します。現在は暗号化されていないキーをサポートしており、他の種類のキーのサポートも近日中に追加予定です。

web3signer_keys:
  key1:
    type: 'file-raw'
    keyType: 'BLS'
    privateKey: '0x6eeb32dd0fe010051825e3ef402b1a7c66fd6daa9c61eb351c5d760684de8e6a'

例のプレイブック:

単一のVMにPostgreSQL、Java、Web3Signerをインストールする例のプレイブック

- name: Web3Signerのインストール
  hosts: web3signer
  remote_user: vagrant
  vars:
    web3signer_http_listen_host: '0.0.0.0'
    web3signer_db_host: 'localhost'
    web3signer_db_name: 'web3signer'
    web3signer_db_username: 'web3signer'
    web3signer_db_password: 'somepassword'
    web3signer_keys:
      key1:
        type: 'file-raw'
        keyType: 'BLS'
        privateKey: '0x6eeb32dd0fe010051825e3ef402b1a7c66fd6daa9c61eb351c5d760684de8e6a'
    postgresql_hba_entries:
      - { type: local, database: all, user: postgres, auth_method: trust }
      - { type: host, database: web3signer, user: web3signer, address: localhost, auth_method: password }
    postgresql_users:
      - name: 'web3signer'
        password: 'somepassword'
    postgresql_databases:
      - name: 'web3signer'

  roles:
    - role: geerlingguy.postgresql
      become: True
    - role: lean_delivery.java
      become: True
    - role: consensys.web3signer

ライセンス

Apache

著者情報

Consensys, 2020

プロジェクトについて

Web3Signer is an open-source signing service developed under the Apache 2.0 license and written in Java.

インストール
ansible-galaxy install consensys.web3signer
ライセンス
Unknown
ダウンロード
10k
所有者
Consensys is the software engineering leader of the blockchain space. Our full-stack Ethereum products help developers build next-generation networks.