OpenBazaar Cookbook

This cookbook installs, configures, and maintains the OpenBazaar server components.

Features

• Installs from either the binary or source distributions of OpenBazaar
• Supports installation of a standard OpenBazaar server
• Supports the installation of an OpenBazaar seed server
• Installs the services as daemons
• Enables autostarting of daemons
• Creates a self-signed SSL certificate for secure client to server communications
• Updates source distributions from git repositories on each chef run (keeps it up to date)

Overview

OpenBazaar is an open source project to create a decentralized network for peer to peer commerce online using Bitcoin.

• OpenBazaar Official Site | https://openbazaar.org/
• OpenBazaar Documentation | https://docs.openbazaar.org/

Platform

• Tested on
  • Ubuntu 14.04

Requirements

The below cookbooks are dependencies, either direct or indirect.

packages

• build-essential
• chef_handler
• chef-sugar
• dmg
• git
• libsodium
• openssl
• poise
• poise-archive
• poise-languages
• poise-python
• seven_zip
• windows
• yum
• yum-epel
• zmq

Attributes

Node level defaults provided by the cookbook. (for a sane default environment).

OpenBazaar Installation Flavor Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['deployment_type']</tt>}</td>
<td>_String</td>
<td>_{The type of deployment to use. possible values <tt>'source'</tt>, <tt>'binary'</tt>}</td>
<td>_{<tt>'binary'</tt>}</td>
</tr>
</table>

Binary Deployment Type Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['version']</tt>}</td>
<td>_String</td>
<td>_{The version of the binary to download</td>}
<td>_{<tt>'1.1.2'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['checksum']</tt>}</td>
<td>_String</td>
<td>_{The checksum of the remote binary artifact</td>}
<td>_{<tt>'535e67eadd4e044e7c34c0ce056c244c74d0eb18dd7383c38666c14e6987186d'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['source']</tt>}</td>
<td>_String</td>
<td>_{The download URL for the binary download</td>}
<td>_{<tt>'https://github.com/OpenBazaar/OpenBazaar-Installer/releases/download/'</tt>}</td>
</tr>

</table>

Source Deployment Type Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['ob']['server']['source']</tt></td>
<td>String</td>
<td>Git Repository for OpenBazaar-Server</td>
<td><tt>'https://github.com/OpenBazaar/OpenBazaar-Server.git'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['CONSTANTS']['DATA_FOLDER']</tt></td>
<td>String</td>
<td>OpenBazaar data folder</td>
<td><tt>'/home/openbazaar/.openbazaar'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['CONSTANTS']['KSIZE']</tt></td>
<td>Integer</td>
<td>Kademlia Protocol ksize</td>
<td><tt>20</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['CONSTANTS']['ALPHA']</tt></td>
<td>Integer</td>
<td>Kademlia Protocol alpha</td>
<td><tt>3</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['CONSTANTS']['TRANSACTION_FEE']</tt></td>
<td>Integer</td>
<td>Bitcoin Transaction Fee (in satoshis)</td>
<td><tt>15000</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['CONSTANTS']['RESOLVER']</tt></td>
<td>String</td>
<td>BlockStack Resolver API end-point</td>
<td><tt>'https://resolver.onename.com/'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['LIBBITCOIN_SERVERS']['mainnet_server1']</tt></td>
<td>String</td>
<td>Bitcoind RPC Server (1)</td>
<td><tt>'tcp://libbitcoin1.openbazaar.org:9091'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['LIBBITCOIN_SERVERS']['mainnet_server3']</tt></td>
<td>String</td>
<td>Bitcoind RPC Server (3)</td>
<td><tt>'tcp://libbitcoin3.openbazaar.org:9091'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['LIBBITCOIN_SERVERS_TESTNET']['testnet_server2']</tt></td>
<td>String</td>
<td>TESTNET Bitcoind RPC Server (2)</td>
<td><tt>'tcp://libbitcoin2.openbazaar.org:9091,baihZB[vT(dcVCwkhYLAzah<t2gJ>{3@k?+>T&3'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['LIBBITCOIN_SERVERS_TESTNET']['testnet_server4']</tt></td>
<td>String</td>
<td>TESTNET Bitcoind RPC Server (4)</td>
<td><tt>'tcp://libbitcoin4.openbazaar.org:9091,<Z&{.=LJSPySefIKgCu99w.L%b^6VvuVp0+pbnOM'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['AUTHENTICATION']['SSL']</tt></td>
<td>String</td>
<td>Require SSL between the server and client components</td>
<td><tt>'False'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['AUTHENTICATION']['SSL_CERT']</tt></td>
<td>String</td>
<td>The public certificate component to generate (Self Signed)</td>
<td><tt>'ob_server_cert.pem'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['AUTHENTICATION']['SSL_KEY']</tt></td>
<td>String</td>
<td>The private key for the (Self Signed) certificate to generate</td>
<td><tt>'ob_server_cert.key'</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['AUTHENTICATION']['USERNAME']</tt></td>
<td>String</td>
<td>The name of the user account (client to server)</td>
<td><tt>random changing value (each convergence)</tt></td>
</tr>
<tr>
<td><tt>['ob']['server']['config']['AUTHENTICATION']['PASSWORD']</tt></td>
<td>String</td>
<td>The password for the user account (client to server)</td>
<td><tt>randomly changing value (each convergence)</tt></td>
</tr>
</table>

SSL Certification Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['certificate']['common_name']</tt>}</td>
<td>_String</td>
<td>_{Common Name</td>}
<td>_{<tt>'www.f00bar.com'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['certificate']['org']</tt>}</td>
<td>_String</td>
<td>_{Organization</td>}
<td>_{<tt>'Foo Bar'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['certificate']['org_unit']</tt>}</td>
<td>_String</td>
<td>_{Organizational Unit</td>}
<td>_{<tt>'Lab'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['certificate']['country']</tt>}</td>
<td>_String</td>
<td>_Country</td>
<td>_{<tt>'US'</tt>}</td>
</tr>

</table>

OpenBazaar Remote Seed Server Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['MAINNET_SEEDS']['mainnet_seed2']</tt>}</td>
<td>_String</td>
<td>_{Seed Server (2)</td>}
<td>_{<tt>'seed2.openbazaar.org:8080,8b17082a57d648894a5181cb6e1b8a6f5b3b7e1c347c0671abfcd7deb6f105fe'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['MAINNET_SEEDS']['mainnet_seed3']</tt>}</td>
<td>_String</td>
<td>_{Seed Server (3)</td>}
<td>_{<tt>'seed.obcentral.org:8080,f0ff751b27ddaa86a075aa09785c438cd2cebadb8f0f5a7e16f383911322d4ee'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['TESTNET_SEEDS']['testnet_seed1']</tt>}</td>
<td>_String</td>
<td>_{TESTNET Seed Sever (1)</td>}
<td>_{<tt>'seed.openbazaar.org:8080,5b44be5c18ced1bc9400fe5e79c8ab90204f06bebacc04dd9c70a95eaca6e117'</tt>}</td>
</tr>

</table>

OpenBazaar Service Account Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['server']['ob_service_user']</tt>}</td>
<td>_String</td>
<td>_{Name of the service account to run the daemons under</td>}
<td>_{<tt>'openbazaar'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['ob_service_group']</tt>}</td>
<td>_String</td>
<td>_{Name of the group account to run the daemons under</td>}
<td>_{<tt>'openbazaar'</tt>}</td>
</tr>

</table>

OpenBazaar Remote Administration Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['allowed_admin_ip']</tt>}</td>
<td>_String</td>
<td>_{Allowed IP address for remote administration</td>}
<td>_{<tt>'127.0.0.1'</tt>}</td>
</tr>
</table>

OpenBazaar Additional Command Line Options

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['additional_flags']</tt>}</td>
<td>_String</td>
<td>_{Catch-all for any additional options that need to be passed to the daemons commandline arguments</td>}
<td>_<tt>''</tt></td>
</tr>
</table>

OpenBazaar Server Port Configuration

<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['dht']</tt>}</td>
<td>_String</td>
<td>_{Port used for DHT</td>}
<td>_{<tt>'18467'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['testnet_dht']</tt>}</td>
<td>_String</td>
<td>_{Port used for TESTNET DHT</td>}
<td>_{<tt>'28467'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['rest']</tt>}</td>
<td>_String</td>
<td>_{Port used for RESET API</td>}
<td>_{<tt>'18469'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['websocket']</tt>}</td>
<td>_String</td>
<td>_{Port used for websocket</td>}
<td>_{<tt>'18466'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['heartbeat']</tt>}</td>
<td>_String</td>
<td>_{Port used for heartbeat</td>}
<td>_{<tt>'18470'</tt>}</td>
</tr>
<tr>
<td>_{<tt>['ob']['server']['config']['ports']['seed']</tt>}</td>
<td>_String</td>
<td>_{Port use for seed server connections</td>}
<td>_{<tt>'8080'</tt>}</td>
</tr>

</table>

Configuration

Attributes may be over-ridden in the normal node/role/environment level attribute override_attributes.

Additionally if one exists a data bag definition will take precedence over any above attribute declarations. The data bag items can over-ride all or portions of the node level attributes.
The data bag item is configured to be {CHEF ENVIRONMENT}\ob

Example

{
  "name" : "data_bag_item_dev_ob_ob",
  "json_class" : "Chef::DataBagItem",
  "chef_type" : "data_bag_item",
  "data_bag" : "dev_ob",
  "raw_data" : {
    "id" : "ob",
    "version" : "1.1.2",
    "checksum" : "535e67eadd4e044e7c34c0ce056c244c74d0eb18dd7383c38666c14e6987186d",
    "source": "https://github.com/OpenBazaar/OpenBazaar-Installer/releases/download/",
    "deployment_type": "source",
    "certificate": {
      "common_name": "www.f00bar.com",
      "org": "Foo Bar",
      "org_unit": "Lab",
      "country": "US"
    },
    "server": {
      "source": "https://github.com/OpenBazaar/OpenBazaar-Server.git",
      "ob_service_user" : "openbazaar",
      "ob_service_group": "openbazaar",
      "config": {
        "allowed_admin_ip": "127.0.0.1",
        "additional_flags": "",
        "ports": {
          "dht": "18467",
          "testnet_dht": "28467",
          "rest": "18469",
          "websocket": "18466",
          "heartbeat": "18470",
          "seed": "8080"
        },
        "CONSTANTS": {
          "DATA_FOLDER": "/home/openbazaar/.openbazaar",
          "KSIZE": "20",
          "ALPHA": "3",
          "TRANSACTION_FEE": "15000",
          "RESOLVER": "https://resolver.onename.com/"
        },
        "LIBBITCOIN_SERVERS": {
          "mainnet_server1": "tcp://libbitcoin1.openbazaar.org:9091",
          "mainnet_server3": "tcp://libbitcoin3.openbazaar.org:9091"
        },
        "LIBBITCOIN_SERVERS_TESTNET": {
          "testnet_server2": "tcp://libbitcoin2.openbazaar.org:9091,baihZB[vT(dcVCwkhYLAzah<t2gJ>{3@k?+>T&^3",
          "testnet_server4": "tcp://libbitcoin4.openbazaar.org:9091,<Z&{.=LJSPySefIKgCu99w.L%b^6VvuVp0+pbnOM"
        },
        "AUTHENTICATION": {
          "SSL": "True"
        },
        "MAINNET_SEEDS": {
          "mainnet_seed2": "seed2.openbazaar.org:8080,8b17082a57d648894a5181cb6e1b8a6f5b3b7e1c347c0671abfcd7deb6f105fe",
          "mainnet_seed3": "seed.obcentral.org:8080,f0ff751b27ddaa86a075aa09785c438cd2cebadb8f0f5a7e16f383911322d4ee"
        },
        "TESTNET_SEEDS": {
          "testnet_seed1": "seed.openbazaar.org:8080,5b44be5c18ced1bc9400fe5e79c8ab90204f06bebacc04dd9c70a95eaca6e117"
        }
      }
    },
    "client": {
      "source": "https://github.com/OpenBazaar/OpenBazaar-Client.git"
    }
  }
}

Credentials

In addition to the non-secure attributes noted so far there are several encrypted attributes that are required.

Failure to create these credentials will result in randomly generate values being supplied to the ob.cfg for the username and password on every chef run.

The encrypted data bag item is configured to be {CHEF ENVIRONMENT}\ob_secrets.

Example

{
  "id": "ob_secrets",
  "server": {
    "config": {
      "AUTHENTICATION": {
        "USERNAME": "SUPER_SECRET_ADMIN",
        "PASSWORD": "SUPER_SECRET_PASSWORD"
      }
    }
  }
}

Usage

openbazaar::default

Downloads, compiles, and installs OpenBazaar and dependencies.

Just include openbazaar in your node's run_list:

Exmaple Runlist

{
  "name":"my_node",
  "run_list": [
    "recipe[openbazaar]"
  ]
}

openbazaar::server

Configures an OpenBazaar Server to run under a service account as a daemon.
This includes autostarting with the system.

Example Role

{
  "name": "ob_server",
  "description": "OpenBazaar Server",
  "json_class": "Chef::Role",
  "default_attributes": { },
  "override_attributes": { },
  "chef_type": "role",
  "run_list": [
    "recipe[openbazaar::server]"
  ]
}

openbazaar::seed

Configures an OpenBazaar Seed Server to run under a service account as a daemon.
This includes autostarting with the system.

Example Role

{
  "name": "ob_seed",
  "description": "OpenBazaar Seed Server",
  "json_class": "Chef::Role",
  "default_attributes": { },
  "override_attributes": { },
  "chef_type": "role",
  "run_list": [
    "recipe[openbazaar::seed]"
  ]
}

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors

MIT License

Copyright (c) 2016 Joshua C. Burt

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.