Merge branch 'master' into master

Author: bvavala

BUILD.md

@@ -59,11 +59,11 @@ First, make sure environment variables are set as described in the
 [prerequisites](#prerequisites) section.
 
 The quickstart build will set up a python virtual environment to install things
-into. Set `CONTRACTHOME` to point to the target install directory for PDO
+into. Set `PDO_HOME` to point to the target install directory for PDO
 components. You will need this environment variable set in every shell session
 where you interact with PDO.
 ```
-export CONTRACTHOME=`pwd`/__tools__/build/_dev/opt/pdo
+export PDO_HOME=`pwd`/__tools__/build/_dev/opt/pdo
 ```
 
 Change to the quickstart build directory:
@@ -91,7 +91,7 @@ Run the test suite to check that the installation is working correctly. Replace
 the URL with the URL for the REST API of your Sawtooth installation.
 ```
 cd ..
-LEDGER_URL=http://127.0.0.1:8008 ./run-tests.sh
+PDO_LEDGER_URL=http://127.0.0.1:8008 ./run-tests.sh
 ```
 
 # <a name="manual-install"></a>Building and installing PDO manually
@@ -134,11 +134,11 @@ pip install --upgrade pyparsing
 ```
 
 If you are using this recommended virtual environment setup, you will also need
-to export the environment variable `CONTRACTHOME`. This is used by PDO to find
+to export the environment variable `PDO_HOME`. This is used by PDO to find
 configuration files and encryption keys. Set this variable in your current
 shell session with:
 ```
-export CONTRACTHOME=`pwd`/venv/opt/pdo
+export PDO_HOME=`pwd`/venv/opt/pdo
 ```
 
 ## <a name="common"></a>Compiling the Common C++ Libraries

PREREQUISITES.md

@@ -160,7 +160,7 @@ For information on how to create and register a certificate with IAS see [here](
 Ledger registration can be done after build through a script in the eservice directory,
 given the required environment variables are set. You will need:
 
-- `LEDGER_URL`
+- `PDO_LEDGER_URL`
 The URL of the ledger you wish to register with.
 
 - `PDO_LEDGER_KEY`

__tools__/build/Makefile

@@ -12,16 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# SRCDIR defaults to the current directory
+# SCRIPTDIR defaults to the current directory
+# PDO_SOURCE_ROOT defaults to root of the parent directory
 # DSTDIR defaults to _dev under the current directory
 # Both can be overridden with environment variables
-SRCDIR?=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
-DSTDIR?=$(abspath $(SRCDIR)/_dev)
-ROOTDIR=$(abspath $(SRCDIR)/../..)
+SCRIPTDIR ?= $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 
-KEYGEN=$(abspath $(SRCDIR)/../make-keys)
-CNFGEN=$(abspath $(SRCDIR)/../expand-config)
-PKGGEN=$(abspath $(SRCDIR)/../rebuild.sh)
+DSTDIR ?= $(or $(PDO_INSTALL_ROOT),$(PDO_INSTALL_ROOT),$(SCRIPTDIR)/_dev)
+SRCDIR ?= $(SCRIPTDIR)/../..
+
+KEYGEN=$(abspath $(SCRIPTDIR)/../make-keys)
+CNFGEN=$(abspath $(SCRIPTDIR)/../expand-config)
+PKGGEN=$(abspath $(SCRIPTDIR)/../rebuild.sh)
 
 PY_VERSION=${shell python3 --version | sed 's/Python \(3\.[0-9]\).*/\1/'}
 PYTHON_DIR=$(DSTDIR)/lib/python$(PY_VERSION)/site-packages/
@@ -65,16 +67,20 @@ keys :
 conf :
 	@ echo Create configuration files from templates
 	@ . $(abspath $(DSTDIR)/bin/activate) ; \
-		$(CNFGEN) --template eservice.toml --template-directory $(SRCDIR)/opt/pdo/etc/template  --output-directory $(DSTDIR)/opt/pdo/etc \
+		$(CNFGEN) --template eservice.toml --template-directory $(SCRIPTDIR)/opt/pdo/etc/template \
+		--output-directory $(DSTDIR)/opt/pdo/etc \
 		multiple --file-base eservice --http-base 7100 --count 5
 	@ . $(abspath $(DSTDIR)/bin/activate) ; \
-		$(CNFGEN) --template pservice.toml --template-directory $(SRCDIR)/opt/pdo/etc/template  --output-directory $(DSTDIR)/opt/pdo/etc \
+		$(CNFGEN) --template pservice.toml --template-directory $(SCRIPTDIR)/opt/pdo/etc/template \
+		--output-directory $(DSTDIR)/opt/pdo/etc \
 		multiple --file-base pservice --http-base 7000 --count 5
 	@ . $(abspath $(DSTDIR)/bin/activate) ; \
-		$(CNFGEN) --template enclave.toml --template-directory $(SRCDIR)/opt/pdo/etc/template  --output-directory $(DSTDIR)/opt/pdo/etc \
+		$(CNFGEN) --template enclave.toml --template-directory $(SCRIPTDIR)/opt/pdo/etc/template \
+		--output-directory $(DSTDIR)/opt/pdo/etc \
 		single --file enclave.toml
 	@ . $(abspath $(DSTDIR)/bin/activate) ; \
-		$(CNFGEN) --template pcontract.toml --template-directory $(SRCDIR)/opt/pdo/etc/template  --output-directory $(DSTDIR)/opt/pdo/etc \
+		$(CNFGEN) --template pcontract.toml --template-directory $(SCRIPTDIR)/opt/pdo/etc/template \
+		--output-directory $(DSTDIR)/opt/pdo/etc \
 		single --file pcontract.toml
 
 template :

__tools__/common-config.sh

@@ -0,0 +1,103 @@
+#!/bin/bash
+
+# Copyright 2018 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
+PDO_SOURCE_ROOT="$(realpath ${SCRIPTDIR}/..)"
+
+# -----------------------------------------------------------------
+# TINY_SCHEME_SRC points to the installation of the tinyscheme
+# source in order to build the library used to debug and test
+# contracts outside of the contract enclave
+# -----------------------------------------------------------------
+export TINY_SCHEME_SRC="${TINY_SCHEME_SRC:-/}"
+
+# -----------------------------------------------------------------
+# SGX_MODE determines the SGX mode of operation. When the variable is
+# set to "SIM", then the SGX enclaves will be compiled for simulator
+# mode. When the variable is set to "HW", the enclaves will be compiled
+# to run in a real SGX enclave.
+# -----------------------------------------------------------------
+export SGX_MODE="${SGX_MODE:-SIM}"
+
+# -----------------------------------------------------------------
+# SGX_DEBUG determines whether additional debugging functions
+# will be compiled into the enclaves. Since SGX_DEBUG potentially
+# exposes information about what is happening inside a contract, do
+# not use with confidential contracts.
+# -----------------------------------------------------------------
+export SGX_DEBUG="${SGX_DEBUG:-1}"
+
+# -----------------------------------------------------------------
+# PDO_INSTALL_ROOT is the root of the directory in which the virtual
+# enviroment will be built; this is equivalent to the old DSTDIR,
+# generally PDO_HOME will point to PDO_INSTALL_ROOT/opt/pdo
+# -----------------------------------------------------------------
+export PDO_INSTALL_ROOT="${PDO_INSTALL_ROOT:-${PDO_SOURCE_ROOT}/__tools__/build/_dev}"
+
+# -----------------------------------------------------------------
+# PDO_HOME is the directory where PDO-specific files
+# are stored include configuration files, data files, compiled
+# contracts, contract user keys and service scripts.
+# -----------------------------------------------------------------
+export PDO_HOME="${PDO_HOME:-${PDO_INSTALL_ROOT}/opt/pdo}"
+
+# -----------------------------------------------------------------
+# PDO_KEY_ROOT is the root directory where the keys are stored
+# for SGX, IAS, and Sawtooth integration; files in this directory
+# are not automatically generated.
+# -----------------------------------------------------------------
+export PDO_KEY_ROOT="${PDO_KEY_ROOT:-${PDO_INSTALL_ROOT}/opt/pdo/keys}"
+
+# -----------------------------------------------------------------
+# PDO_ENCLAVE_PEM contains the name of the file containing the key
+# used to sign the enclave. The key is generated by the command:
+# openssl genrsa -3 -out ${PDO_ENCLAVE_PEM} 3072
+# -----------------------------------------------------------------
+export PDO_ENCLAVE_PEM="${PDO_KEY_ROOT}/pdo_enclave.pem"
+
+# -----------------------------------------------------------------
+# The path of the PEM file containing the public key used to verify
+# quotes from the Intel Attestation Service.
+# <<HOW TO GET>>
+# -----------------------------------------------------------------
+export PDO_IAS_KEY="${PDO_KEY_ROOT}/pdo_ias_key.pem"
+
+# -----------------------------------------------------------------
+# PDO_LEDGER_KEY is used to update settings in the Sawtooth validator.
+# This is the key used by the Sawtooth ledger and is generally
+# found in the file .sawtooth/keys/sawtooth.priv in the
+# Sawtooth installation directory hiearchy.
+# -----------------------------------------------------------------
+export PDO_LEDGER_KEY="${PDO_KEY_ROOT}/pdo_validator.priv"
+
+# -----------------------------------------------------------------
+# PDO_PDO_LEDGER_URL is the URL is to submit transactions to the
+# Sawtooth ledger.
+# -----------------------------------------------------------------
+export PDO_LEDGER_URL="${PDO_LEDGER_URL:-http://127.0.0.1:8008}"
+
+# -----------------------------------------------------------------
+# PDO_SPID is the ID that accompanies the certificate registered
+# with the Intel Attestation Service.
+# -----------------------------------------------------------------
+export PDO_SPID="${PDO_SPID:-$(cat ${PDO_KEY_ROOT}/sgx_spid.txt)}"
+
+# -----------------------------------------------------------------
+# PDO_SPID_CERT_FILE is the name of the file that contains the
+# PEM-encoded certificate that was submitted to Intel in order to
+# obtain the SPID
+# -----------------------------------------------------------------
+export PDO_SPID_CERT_FILE="${PDO_SPID_CERT_FILE:-${PDO_KEY_ROOT}/sgx_spid_cert.pem}"

__tools__/expand-config

@@ -25,14 +25,14 @@ from string import Template
 
 ## -----------------------------------------------------------------
 ContractHost = os.environ.get("HOSTNAME", "localhost")
-ContractHome = os.environ.get("CONTRACTHOME") or os.path.realpath("/opt/pdo")
-ContractEtc = os.environ.get("CONTRACTETC") or os.path.join(ContractHome, "etc")
-ContractKeys = os.environ.get("CONTRACTKEYS") or os.path.join(ContractHome, "keys")
-ContractLogs = os.environ.get("CONTRACTLOGS") or os.path.join(ContractHome, "logs")
-ContractData = os.environ.get("CONTRACTDATA") or os.path.join(ContractHome, "data")
+ContractHome = os.environ.get("PDO_HOME") or os.path.realpath("/opt/pdo")
+ContractEtc = os.path.join(ContractHome, "etc")
+ContractKeys = os.path.join(ContractHome, "keys")
+ContractLogs = os.path.join(ContractHome, "logs")
+ContractData = os.path.join(ContractHome, "data")
 HttpsProxy = os.environ.get("https_proxy", "")
 
-LedgerURL = os.environ.get("LEDGER_URL", "http://127.0.0.1:8008/")
+LedgerURL = os.environ.get("PDO_LEDGER_URL", "http://127.0.0.1:8008/")
 SPID = os.environ.get("PDO_SPID",'DEADBEEF00000000DEADBEEF00000000')
 SPID_CERT_FILE = os.environ.get("PDO_SPID_CERT_FILE",'/etc/sawtooth/ias_rk_pub.pem')
 

__tools__/rebuild.sh

@@ -58,7 +58,7 @@ function try() {
 yell --------------- CONFIG AND ENVIRONMENT CHECK ---------------
 
 : "${TINY_SCHEME_SRC?Missing environment variable TINY_SCHEME_SRC}"
-: "${CONTRACTHOME?Missing environment variable CONTRACTHOME}"
+: "${PDO_HOME?Missing environment variable PDO_HOME}"
 : "${PDO_ENCLAVE_PEM?Missing environment variable PDO_ENCLAVE_PEM}"
 : "${SGX_SSL?Missing environment variable SGX_SSL}"
 : "${SGX_SDK?Missing environment variable SGXSDKInstallPath}"
@@ -90,8 +90,8 @@ try command -v make
 try command -v g++
 try command -v tinyscheme
 
-if [ ! -d "${CONTRACTHOME}" ]; then
-    die CONTRACTHOME directory does not exist
+if [ ! -d "${PDO_HOME}" ]; then
+    die PDO_HOME directory does not exist
 fi
 
 # Automatically determine how many cores the host system has

__tools__/run-tests.sh

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-: ${LEDGER_URL:=http://127.0.0.1:8008}
+: ${PDO_LEDGER_URL:=http://127.0.0.1:8008}
 
 PY3_VERSION=$(python --version | sed 's/Python 3\.\([0-9]\).*/\1/')
 if [[ $PY3_VERSION -lt 5 ]]; then
@@ -62,8 +62,8 @@ trap cleanup EXIT
 
 # start the provisioning and enclave services
 yell start enclave and provisioning services
-try ${VIRTUAL_ENV}/opt/pdo/bin/ps-start.sh --count 5 --ledger ${LEDGER_URL} --clean > /dev/null
-try ${VIRTUAL_ENV}/opt/pdo/bin/es-start.sh --count 5 --ledger ${LEDGER_URL} --clean > /dev/null
+try ${VIRTUAL_ENV}/opt/pdo/bin/ps-start.sh --count 5 --ledger ${PDO_LEDGER_URL} --clean > /dev/null
+try ${VIRTUAL_ENV}/opt/pdo/bin/es-start.sh --count 5 --ledger ${PDO_LEDGER_URL} --clean > /dev/null
 
 cd ${SRCDIR}/eservice/tests
 yell start secrets test
@@ -100,19 +100,19 @@ try python test-contract.py --no-ledger --contract mock-contract \
     --logfile __screen__ --loglevel warn
 
 yell start request test with provisioning and enclave services
-try python test-request.py --ledger ${LEDGER_URL} \
+try python test-request.py --ledger ${PDO_LEDGER_URL} \
     --pservice http://localhost:7001/ http://localhost:7002 http://localhost:7003 \
     --eservice http://localhost:7101/ \
      --logfile __screen__ --loglevel warn
 
 yell start contract test with provisioning and enclave services
-try python test-contract.py --ledger ${LEDGER_URL} --contract integer-key \
+try python test-contract.py --ledger ${PDO_LEDGER_URL} --contract integer-key \
     --pservice http://localhost:7001/ http://localhost:7002 http://localhost:7003 \
     --eservice http://localhost:7101/ \
      --logfile __screen__ --loglevel warn
 
 yell start mock contract test with ledger, this should fail dependency check
-python test-contract.py --ledger ${LEDGER_URL} --contract mock-contract \
+python test-contract.py --ledger ${PDO_LEDGER_URL} --contract mock-contract \
        --logfile __screen__ --loglevel warn
 if [ $? == 0 ]; then
     die mock contract test succeeded though it should have failed
@@ -123,24 +123,24 @@ yell ---------- start pdo-create and pdo-update tests ----------
 ## -----------------------------------------------------------------
 
 # make sure we have the necessary files in place
-CONFIG_FILE=${CONTRACTHOME}/etc/pcontract.toml
+CONFIG_FILE=${PDO_HOME}/etc/pcontract.toml
 if [ ! -f ${CONFIG_FILE} ]; then
     die missing client configuration file, ${CONFIG_FILE}
 fi
 
-CONTRACT_FILE=${CONTRACTHOME}/contracts/_mock-contract.scm
+CONTRACT_FILE=${PDO_HOME}/contracts/_mock-contract.scm
 if [ ! -f ${CONTRACT_FILE} ]; then
     die missing contract source file, ${CONTRACT_FILE}
 fi
 
 yell create the contract
-try pdo-create --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+try pdo-create --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
      --logfile __screen__ --loglevel warn \
     --identity user1 --save-file ${SAVE_FILE} \
     --contract mock-contract --source _mock-contract.scm
 
 yell increment the value with a simple expression
-value=$(pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+value=$(pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
                    --logfile __screen__ --loglevel warn \
                    --identity user1 --save-file ${SAVE_FILE} \
                    "'(inc-value)")
@@ -149,7 +149,7 @@ if [ $value != "1" ]; then
 fi
 
 yell increment the value with a evaluated expression
-value=$(pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+value=$(pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
                    --logfile __screen__ --loglevel warn \
                    --identity user1 --save-file ${SAVE_FILE} \
                    "(list 'inc-value)")
@@ -158,7 +158,7 @@ if [ $value != "2" ]; then
 fi
 
 yell get the value and check it
-value=$(pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+value=$(pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
                    --logfile __screen__ --loglevel warn \
                    --identity user1 --save-file ${SAVE_FILE} \
                    "'(get-value)")
@@ -167,7 +167,7 @@ if [ $value != "2" ]; then
 fi
 
 yell invalid method, this should fail
-pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
            --logfile __screen__ --loglevel warn \
            --identity user1 --save-file ${SAVE_FILE} \
            "'(no-such-method)"
@@ -176,7 +176,7 @@ if [ $? == 0 ]; then
 fi
 
 yell invalid expression, this should fail
-pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
            --logfile __screen__ --loglevel warn \
            --identity user1 --save-file ${SAVE_FILE} \
            "'(no-such-method"
@@ -185,7 +185,7 @@ if [ $? == 0 ]; then
 fi
 
 yell policy violation with identity, this should fail
-pdo-update --config ${CONFIG_FILE} --ledger ${LEDGER_URL} \
+pdo-update --config ${CONFIG_FILE} --ledger ${PDO_LEDGER_URL} \
            --logfile __screen__ --loglevel warn \
            --identity user2 --save-file ${SAVE_FILE} \
            "'(get-value)"

client/docs/BUILD.md

@@ -32,16 +32,16 @@ where you can install the common Python modules. The rest of these
 instructions assume that you have set up a virtual environment for
 Python3 and have activated it.
 
-The environment variable ``CONTRACTHOME`` should be set to the directory where
+The environment variable ``PDO_HOME`` should be set to the directory where
 you expect to configure and run the client utilities. Generally the variable is
 set to the path to your virtual environment root plus ``opt/pdo``.
 
 For example:
 ```bash
-prompt> export CONTRACTHOME=$VIRTUAL_ENV/opt/pdo
+prompt> export PDO_HOME=$VIRTUAL_ENV/opt/pdo
 ```
 
-For production deployment, ``CONTRACTHOME`` should be set to ``/opt/pdo``.
+For production deployment, ``PDO_HOME`` should be set to ``/opt/pdo``.
 
 ## <a name="install">Build & Install the Modules
 

client/pdo/client/scripts/AuctionTestCLI.py

@@ -372,12 +372,12 @@ def LocalMain(config) :
 
 ## -----------------------------------------------------------------
 ContractHost = os.environ.get("HOSTNAME", "localhost")
-ContractHome = os.environ.get("CONTRACTHOME") or os.path.realpath("/opt/pdo")
-ContractEtc = os.environ.get("CONTRACTETC") or os.path.join(ContractHome, "etc")
-ContractKeys = os.environ.get("CONTRACTKEYS") or os.path.join(ContractHome, "keys")
-ContractLogs = os.environ.get("CONTRACTLOGS") or os.path.join(ContractHome, "logs")
-ContractData = os.environ.get("CONTRACTDATA") or os.path.join(ContractHome, "data")
-LedgerURL = os.environ.get("LEDGER_URL", "http://127.0.0.1:8008/")
+ContractHome = os.environ.get("PDO_HOME") or os.path.realpath("/opt/pdo")
+ContractEtc = os.path.join(ContractHome, "etc")
+ContractKeys = os.path.join(ContractHome, "keys")
+ContractLogs = os.path.join(ContractHome, "logs")
+ContractData = os.path.join(ContractHome, "data")
+LedgerURL = os.environ.get("PDO_LEDGER_URL", "http://127.0.0.1:8008/")
 ScriptBase = os.path.splitext(os.path.basename(sys.argv[0]))[0]
 
 config_map = {