Ansible Role: Web3Signer

Description

This Ansible role installs, configures, and runs Web3Signer, an open-source signing service.

Table of Contents

• Supported Platforms
• Dependencies
• Role Variables
• Configure Signing Keys
• Example Playbook
• License
• Author Information

Supported Platforms

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

Dependencies

• JDK 11 or higher
• PostgreSQL database if slashing protection is enabled for eth2

Role Variables

You can override all variables stored in the defaults/main.yml file. Most of these are configuration options. For more details, check the Web3Signer docs.

Configure Signing Keys

Signing keys must be provided as a parameter web3signer_keys in a map format. The key name is used as the filename for the key. Currently, it supports unencrypted keys, with plans for added support soon.

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

Example Playbook

Here’s an example playbook to install PostgreSQL, Java, and Web3Signer on a single VM.

- name: Web3Signer Installation
  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

License

Apache

Author Information

Consensys, 2020