Merge branch 'master' into master

Author: jovfer

CHANGELOG.md

@@ -0,0 +1,43 @@
+# 1.4.0
+
+* Indy CLI tool added.
+* Switching from DID-based crypto to keys-based crypto:
+  * All DID-based crypto functions (`signus` module) are removed.
+  * Added key-based `crypto` module.
+  * Added functions to resolve keys for DIDs.
+* Agent API moved into `crypto` module.
+* Support the latest version of CL crypto (through `indy-crypto` library):
+  * Added nonce for all protocol steps.
+  * Added consistency proofs for protocol steps.
+  * Representation of Proofs changed (sub-proofs now are ordered).
+* Support of complete Credentials Revocation workflow in Anoncreds API:
+  * Support large Tails handling through BlobStorage API.
+  * Support new Revocation transactions.
+  * Add calls for remote Witness calculation.
+  * State-less approach in Credential issuance process.
+  * Unified reference approach for Anoncreds entities.
+* Extend DID API: added some methods for iteration over entities in the wallet. 
+* Bugfixes.
+
+Notes:
+* There is [migration guide](doc/migration-guide.md) about API changes.
+* The changes for Credential Revocation invalidates any Anoncreds made with SDK 1.3. They must be reissued.
+* This release is intended for development purposes only. The 1.5.0 release of the SDK will contain changes to the wallet format. If you plan to put durable artifacts in the wallet, let us know so we can discuss migration to the future format.
+
+# 1.3.0
+
+* Encryption option for default wallet is added.
+
+# 1.2.0
+
+* indy_key_for_local_did added.
+
+# 1.1.0
+
+* Replaced Agent2Agent API.
+* New Crypto API.
+* Updated Signus API.
+
+# 1.0.0
+
+* Initial release.

Jenkinsfile.cd

@@ -550,6 +550,11 @@ def publishingRCtoStable() {
                 echo 'Moving RC artifacts to Stable: Checkout csm'
                 checkout scm
 
+                echo 'Moving RC artifacts to Stable: Download packaging utils'
+                dir('sovrin-packaging') {
+                    downloadPackagingUtils()
+                }
+
                 version = getSrcVersion()
 
                 echo 'Moving Windows RC artifacts to Stable: libindy'
@@ -629,10 +634,9 @@ def publishLibindyCliDebRCtoStable(testEnv, version) {
 
 def uploadDebianFilesToStable() {
     withCredentials([file(credentialsId: 'SovrinRepoSSHKey', variable: 'sovrin_key')]) {
-        downloadPackagingUtils()
         path = sh(returnStdout: true, script: 'pwd').trim()
 
-        sh "./upload_debs.py $path $SOVRIN_SDK_REPO_NAME stable --host $SOVRIN_REPO_HOST --ssh-key $sovrin_key"
+        sh "./sovrin-packaging/upload_debs.py $path $SOVRIN_SDK_REPO_NAME stable --host $SOVRIN_REPO_HOST --ssh-key $sovrin_key"
     }
 }
 

README.md

@@ -1,46 +1,67 @@
-
-## Before you Continue
-
-If you haven't done so already, please visit the main resource for all things "Indy" to get acquainted with the code base, helpful resources, and up-to-date information: [Hyperledger Wiki-Indy](https://wiki.hyperledger.org/projects/indy).
-
 # Indy SDK
-
+![logo](https://raw.githubusercontent.com/hyperledger/indy-node/master/collateral/logos/indy-logo.png)
 This is the official SDK for [Hyperledger Indy](https://www.hyperledger.org/projects),
-which provides a distributed-ledger-based foundation for [self-sovereign identity](https://sovrin.org).
+which provides a distributed-ledger-based foundation for [self-sovereign identity](https://sovrin.org). Indy provides a software ecosystem for private, secure, and powerful identity, and the Indy SDK enables clients for it.
 The major artifact of the SDK is a c-callable
 library; there are also convenience wrappers for various programming languages and Indy CLI tool.
 
-All bugs, stories, and backlog for this project are managed through [Hyperledger's Jira](https://jira.hyperledger.org)
-in project IS (note that regular Indy tickets are in the INDY project instead...). Also, join
-us on [Hyperledger's Rocket.Chat](https://chat.hyperledger.org/) at #indy-sdk to discuss.
+All bugs, stories, and backlog for this project are managed through [Hyperledger's Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa)
+in project IS (note that regular Indy tickets are in the INDY project instead...). Also, make sure to join
+us on [Hyperledger's Rocket.Chat](https://chat.hyperledger.org/) at #indy-sdk to discuss. You will need a Linux Foundation login to get access to these channels
+
+## Understanding Hyperledger Indy
+
+If you have just started learning about self-sovereign identity, here are some resources to increase your understanding:
+
+* This extended tutorial introduces Indy, explains how the whole ecosystem works, and how the
+functions in the SDK can be used to construct rich clients: [Indy-SDK Getting-Started Guide](doc/getting-started/getting-started.md)
+
+* A recent webinar explaining self-sovereign identity using Hyperledger Indy and Sovrin: [SSI Meetup Webinar](https://youtu.be/RllH91rcFdE?t=4m30s)
+
+* Visit the main resource for all things "Indy" to get acquainted with the code base, helpful resources, and up-to-date information: [Hyperledger Wiki-Indy](https://wiki.hyperledger.org/projects/indy).
+
+* You may also want to look at the [older guide](https://github.com/hyperledger/indy-node/blob/stable/getting-started.md)
+that explored the ecosystem via command line. That material is being
+rewritten but still contains some useful ideas.
+
+## How-To Tutorials
+
+Short, simple tutorials that demonstrate how to accomplish common tasks
+are also available. See the [doc/how-tos](doc/how-tos) folder.
 
+1. [Write a DID and Query Its Verkey](doc/how-tos/write-did-and-query-verkey/README.md)
+2. [Rotate a Key](doc/how-tos/rotate-key/README.md)
+3. [Save a Schema and Cred Def](doc/how-tos/save-schema-and-cred-def/README.md)
+4. [Issue a Credential](doc/how-tos/issue-credential/README.md)
+5. [Negotiate a Proof](doc/how-tos/negotiate-proof/README.md)
+6. [Send a Secure Message](doc/how-tos/send-secure-msg/README.md)
 
-## Installation
+## Installing the SDK
 ### Release channels
-Indy SDK release process defines the following release channels:
+The Indy SDK release process defines the following release channels:
 
 * `master` - development builds for each push to master branch.
 * `rc` - release candidates.
 * `stable` - stable releases.
 
-Please refer to [release workflow](doc/release-workflow.md) for more details.
+Please refer to our [release workflow](doc/release-workflow.md) for more details.
 
 ### Ubuntu based distributions (Ubuntu 16.04)
-It is recommended to install packages with APT:
+It is recommended to install the SDK packages with APT:
 
-    apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
+    sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
     sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial {release channel}"
     sudo apt-get update
     sudo apt-get install -y libindy
 
 {release channel} must be replaced with master, rc or stable to define corresponded release channel.
-See section "Release channels" for more details.
+Please See the section "Release channels" above for more details.
 
 ### Windows
 
-1. follow to https://repo.sovrin.org/windows/libindy/{release-channel}.
-2. download last version of libindy.
-3. unzip archives to directory, where you want to save working library.
+1. Go to https://repo.sovrin.org/windows/libindy/{release-channel}.
+2. Download last version of libindy.
+3. Unzip archives to the directory where you want to save working library.
 4. After unzip you will get next structure of files:
 
 * `Your working directory`
@@ -71,7 +92,7 @@ See [wrapper iOS install documentation](wrappers/ios/README.md "How to install")
 Pre-built libraries are not provided for MacOS. Please look [here](doc/mac-build.md)
 for details on building from source for MacOS.
 
-After building `libindy`, add the path containing the library the `LD_LIBRARY_PATH` and
+ **Note:** After building `libindy`, add the path containing the library the `LD_LIBRARY_PATH` and
 `DYLD_LIBRARY_PATH` environment variables. This is necessary for dynamically linking
 your application with `libindy`. The dynamic linker will first check for the library in
 `LD_LIBRARY_PATH` if the library in your application doesn't include directory names.
@@ -87,23 +108,24 @@ After successfully compiling `libindy`, you will need to add the path containing
 `LD_LIBRARY_PATH` environment variable. This is required for your application to link to
 `libindy`.
 
-## How to build
+## How to build Indy SDK from source
 
 * [Ubuntu based distributions (Ubuntu 16.04)](doc/ubuntu-build.md)
 * [RHEL based distributions (Amazon Linux 2017.03)](doc/rhel-build.md)
 * [Windows](doc/windows-build.md)
 * [MacOS](doc/mac-build.md)
 
 ## How to start local nodes pool with docker
+To test the SDK codebase with a virtual Indy node network, you can start a pool of local nodes using docker:
 
-Start local nodes pool on `127.0.0.1:9701-9708` with Docker:
+Start the pool of local nodes on `127.0.0.1:9701-9708` with Docker by running:
 
 ```
 docker build -f ci/indy-pool.dockerfile -t indy_pool .
 docker run -itd -p 9701-9708:9701-9708 indy_pool
 ```
 
- Dockerfile `ci/indy-pool.dockerfile` supports optional pool_ip param that allows
+ Dockerfile `ci/indy-pool.dockerfile` supports an optional pool_ip param that allows
  changing ip of pool nodes in generated pool configuration. The following commands
  allow to start local nodes pool in custom docker network and access this pool
  by custom ip in docker network:
@@ -115,7 +137,7 @@ docker run -itd -p 9701-9708:9701-9708 indy_pool
  ```
  Note that for Windows and MacOS this approach has some issues. Docker for these OS run in
  their virtual environment. First command creates network for container and host can't
- get access to that network because container placed on virtual machine. You must appropriate set up 
+ get access to that network because container placed on virtual machine. You must appropriate set up
  networking on your virtual environment. See the instructions for MacOS below.
 
 ### Docker port mapping on MacOS
@@ -159,23 +181,9 @@ details.
 * [iOS](wrappers/ios/README.md)
 
 ## Indy CLI documentation
-* [Indy CLI](cli/README.md)
-
-## Getting started
-
-This extended tutorial shows how the whole ecosystem works, and how
-functions in the SDK can be used to construct rich clients. (You may also
-want to look at the [older guide](https://github.com/hyperledger/indy-node/blob/stable/getting-started.md)
-that explored the ecosystem via command line. That material is being
-rewritten but still contains some useful ideas.)
-
-* [Libindy Getting-Started Guide](doc/getting-started/getting-started.md)
-
-## How Tos
-
-Short, simple tutorials that demonstrate how to accomplish common tasks
-are also available. See [the doc/how-tos folder](doc/how-tos).
+* An explanation of how to install the official command line interface for that provides commands to manage wallets and interactions with the ledger: [Indy CLI](cli/README.md)
 
 ## How to migrate
-The documents that provide necessary information for Libindy migration.
+The documents that provide necessary information for Libindy migration. This document is written for developers using Libindy 1.3.0 to provide necessary information and
+to simplify their transition to API of Libindy 1.4.0.
 * [v1.3.0 → v1.4.0](doc/migration-guide.md)

Specs/libindy-objc/1.4.0/libindy-objc.podspec.json

@@ -0,0 +1,23 @@
+{
+    "name": "libindy-objc",
+    "version": "1.4.0",
+    "summary": "Summary TODO.",
+    "homepage": "TODO",
+    "license": {
+        "type": "Apache License 2.0",
+        "file": "LICENSE"
+    },
+    "authors": {
+        "Daniel Hardman": "[email protected]"
+    },
+    "source": {
+        "http": "https://repo.sovrin.org/ios/libindy/stable/indy-objc/1.4.0/libindy-objc.zip"
+    },
+    "platforms": {
+        "ios": "10.0"
+    },
+    "ios": {
+        "vendored_frameworks": "libindy-objc/Indy.framework"
+    },
+    "module_name": "Indy"
+}

Specs/libindy/1.4.0/libindy.podspec.json

@@ -0,0 +1,23 @@
+{
+  "name": "libindy",
+  "version": "1.4.0",
+  "summary": "Summary TODO.",
+  "description": "Description TODO.",
+  "homepage": "TODO",
+  "license": {
+    "type": "Apache License 2.0",
+    "file": "LICENSE"
+  },
+  "authors": {
+    "Daniel Hardman": "[email protected]"
+  },
+  "platforms": {
+    "ios": "10.0"
+  },
+  "source": {
+    "http": "https://repo.sovrin.org/ios/libindy/stable/libindy-core/1.4.0/libindy.tar.gz"
+  },
+  "source_files": "*.h",
+  "vendored_libraries": "*.a",
+  "requires_arc": false
+}

ci/acceptance/ubuntu_acceptance.dockerfile

@@ -14,8 +14,11 @@ RUN apt-get update && \
 RUN add-apt-repository ppa:jonathonf/python-3.6
 RUN apt-get update && \
       apt-get install -y \
-      python3.6 \
-      python3-pip
+      python3.5 \
+      python3-pip \
+      vim
+
+RUN pip3 install -U pip
 
 ARG indy_sdk_deb
 RUN echo ${indy_sdk_deb}
@@ -24,5 +27,5 @@ ADD ${indy_sdk_deb} indy-sdk.deb
 RUN dpkg -i indy-sdk.deb || apt-get install -y -f
 
 RUN useradd -ms /bin/bash indy
-WORKDIR /home/indy
 USER indy
+WORKDIR /home/indy

cli/README.md

@@ -14,7 +14,7 @@ Pre-Built binaries can be downloaded from https://repo.sovrin.org/:
 
 On Ubuntu it is recommended to install packages with APT (change stable to `master` or `rc` if needed):
 ```
-apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
+sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
 sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial stable"
 sudo apt-get update
 sudo apt-get install -y indy-cli

cli/src/commands/ledger.rs

@@ -627,9 +627,9 @@ pub mod pool_config_command {
 pub mod pool_restart_command {
     use super::*;
 
-    command!(CommandMetadata::build("pool-restart", "Send instructions to nodes to update themselves.")
+    command!(CommandMetadata::build("pool-restart", "Send instructions to nodes to restart themselves.")
                 .add_required_param("action", "Restart type. Either start or cancel.")
-                .add_optional_param("datetime", "Node restart datetime. Datetime is mandatory for action=start.")
+                .add_optional_param("datetime", "Node restart datetime (only for action=start).")
                 .add_example(r#"ledger pool-restart action=start datetime=2020-01-25T12:49:05.258870+00:00"#)
                 .add_example(r#"ledger pool-restart action=cancel"#)
                 .finalize()
@@ -643,7 +643,7 @@ pub mod pool_restart_command {
         let (wallet_handle, wallet_name) = ensure_opened_wallet(&ctx)?;
 
         let action = get_str_param("action", params).map_err(error_err!())?;
-        let datetime = get_str_param("datetime", params).map_err(error_err!())?;
+        let datetime = get_opt_str_param("datetime", params).map_err(error_err!())?;
 
         let response = Ledger::indy_build_pool_restart_request(&submitter_did, action, datetime)
             .and_then(|request| Ledger::sign_and_submit_request(pool_handle, wallet_handle, &submitter_did, &request));

cli/src/libindy/ledger.rs

@@ -223,12 +223,12 @@ impl Ledger {
         super::results::result_to_string(err, receiver)
     }
 
-    pub fn indy_build_pool_restart_request(submitter_did: &str, action: &str, datetime: &str) -> Result<String, ErrorCode> {
+    pub fn indy_build_pool_restart_request(submitter_did: &str, action: &str, datetime: Option<&str>) -> Result<String, ErrorCode> {
         let (receiver, command_handle, cb) = super::callbacks::_closure_to_cb_ec_string();
 
         let submitter_did = CString::new(submitter_did).unwrap();
         let action = CString::new(action).unwrap();
-        let datetime = CString::new(datetime).unwrap();
+        let datetime = datetime.map(|s| CString::new(s).unwrap()).unwrap_or(CString::new("").unwrap());
 
         let err = unsafe {
             indy_build_pool_restart_request(command_handle,