virgil-crypto 2.3.0 → 3.6.2

data/ext/native/src/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.5

data/ext/native/src/benchmark.md

@@ -0,0 +1,140 @@
+# Benchmark tests
+
+This file contain benchmark of the Virgil Crypto library:
+
+## Environment for tests
+
+These tests were made on MacBook Pro with the next specifications:
+
+| Property      | Specifications                            |
+|---------------|-------------------------------------------|
+| Model         | MacBook Pro (Retina, 13-inch, Early 2015) |
+| Processor     | 3.1 GHz Intel Core i7                     |
+| Memory        | 16 GB 1867 MHz DDR3                       |
+| MacOS version | High Sierra (version 10.13.3)             |
+
+## Tests
+
+### Hashing
+
+| algorithm | samples | ns/op |
+|-----------|---------|-------|
+| MD5       | 100000  | 19314 |
+| SHA-256   | 50000   | 38695 |
+| SHA-384   | 50000   | 25606 |
+| SHA-512   | 50000   | 25438 |
+
+### Key pair generation
+
+| algorithm                | samples | ns/op      |
+|--------------------------|---------|------------|
+| RSA 2048                 | 5       | 202676085  |
+| RSA 3072                 | 5       | 761719258  |
+| RSA 4096                 | 1       | 4606853434 |
+| curve25519               | 50000   | 20493      |
+| ed25519                  | 100000  | 16226      |
+| 224-bits NIST curve      | 1000    | 1344291    |
+| 256-bits NIST curve      | 1000    | 1911181    |
+| 384-bits NIST curve      | 500     | 2565290    |
+| 521-bits NIST curve      | 500     | 3758969    |
+| 256-bits Brainpool curve | 100     | 13363189   |
+| 384-bits Brainpool curve | 50      | 24520962   |
+| 512-bits Brainpool curve | 50      | 45844118   |
+| 192-bits Koblitz curve   | 1000    | 1601368    |
+| 224-bits Koblitz curve   | 1000    | 1935883    |
+| 256-bits Koblitz curve   | 500     | 2119124    |
+
+### Key Export
+
+| operation                              | samples | ns/op    |
+|----------------------------------------|---------|----------|
+| Public Key to DER                      | 2000000 | 577      |
+| Public Key to PEM                      | 1000000 | 1560     |
+| Private Key to DER (no password)       | 5000000 | 336      |
+| Private Key to PEM (no password)       | 2000000 | 879      |
+| Private Key to DER (with password)     | 100     | 14168461 |
+| Private Key to PEM (with password)     | 100     | 13862879 |
+| Public Key DER to PEM                  | 500     | 4426590  |
+| Public Key PEM to DER                  | 500     | 4461710  |
+| Private Key PEM to DER (no password)   | 500     | 4451291  |
+| Private Key DER to PEM (no password)   | 500     | 4408890  |
+| Private Key DER to PEM (with password) | 50      | 25451292 |
+| Private Key PEM to DER (with password) | 50      | 29305614 |
+
+### Encryption
+
+| algorithm                | samples | ns/op |
+|--------------------------|---------|-------|
+| RSA 2048                 | 200000  | 9458  |
+| RSA 3072                 | 100000  | 10776 |
+| RSA 4096                 | 100000  | 11220 |
+| Curve25519 curve         | 200000  | 9672  |
+| Ed25519 curve            | 100000  | 11692 |
+| 224-bits NIST curve      | 100000  | 10114 |
+| 256-bits NIST curve      | 100000  | 11664 |
+| 384-bits NIST curve      | 100000  | 13421 |
+| 521-bits NIST curve      | 100000  | 10327 |
+| 256-bits Brainpool curve | 100000  | 10152 |
+| 384-bits Brainpool curve | 100000  | 10485 |
+| 512-bits Brainpool curve | 100000  | 11166 |
+| 192-bits Koblitz curve   | 100000  | 11069 |
+| 224-bits Koblitz curve   | 200000  | 9631  |
+| 256-bits Koblitz curve   | 200000  | 9740  |
+
+### Decryption
+
+| algorithm                | samples | ns/op    |
+|--------------------------|---------|----------|
+| RSA 2048                 | 200     | 8709333  |
+| RSA 3072                 | 100     | 14597898 |
+| RSA 4096                 | 50      | 24189009 |
+| curve25519               | 500     | 4603996  |
+| ed25519                  | 500     | 4545415  |
+| 224-bits NIST curve      | 200     | 6140846  |
+| 256-bits NIST curve      | 200     | 7106018  |
+| 384-bits NIST curve      | 200     | 7754033  |
+| 521-bits NIST curve      | 200     | 9074803  |
+| 256-bits Brainpool curve | 100     | 19708554 |
+| 384-bits Brainpool curve | 50      | 32892030 |
+| 512-bits Brainpool curve | 20      | 57748835 |
+| 192-bits Koblitz curve   | 200     | 6485849  |
+| 224-bits Koblitz curve   | 200     | 6944859  |
+| 256-bits Koblitz curve   | 200     | 7362125  |
+
+### Sign
+
+| algorithm                | samples | ns/op    |
+|--------------------------|---------|----------|
+| RSA 2048                 | 500     | 4061518  |
+| RSA 3072                 | 200     | 9937662  |
+| RSA 4096                 | 100     | 19593122 |
+| 224-bits NIST curve      | 1000    | 1397832  |
+| 256-bits NIST curve      | 500     | 2040942  |
+| 384-bits NIST curve      | 500     | 2732660  |
+| 521-bits NIST curve      | 500     | 3897379  |
+| 256-bits Brainpool curve | 100     | 13377896 |
+| 384-bits Brainpool curve | 50      | 25024584 |
+| 512-bits Brainpool curve | 50      | 47017466 |
+| 192-bits Koblitz curve   | 1000    | 1708163  |
+| 224-bits Koblitz curve   | 500     | 2083555  |
+| 256-bits Koblitz curve   | 500     | 2247125  |
+| Ed25519 curve            | 20000   | 52751    |
+
+### Verify
+
+| algorithm                | samples | ns/op    |
+|--------------------------|---------|----------|
+| RSA 2048                 | 20000   | 94365    |
+| RSA 3072                 | 10000   | 186789   |
+| RSA 4096                 | 5000    | 298092   |
+| 224-bits NIST curve      | 500     | 2694377  |
+| 256-bits NIST curve      | 500     | 3983349  |
+| 384-bits NIST curve      | 200     | 5237961  |
+| 521-bits NIST curve      | 200     | 7485531  |
+| 256-bits Brainpool curve | 50      | 26543606 |
+| 384-bits Brainpool curve | 50      | 48791525 |
+| 512-bits Brainpool curve | 20      | 91268881 |
+| 192-bits Koblitz curve   | 500     | 3233918  |
+| 224-bits Koblitz curve   | 500     | 4083664  |
+| 256-bits Koblitz curve   | 500     | 4345015  |
+| Ed25519 curve            | 20000   | 59837    |

data/ext/native/src/benchmark/benchmark_pythia.cxx

@@ -0,0 +1,61 @@
+/**
+ * Copyright (C) 2015-2018 Virgil Security Inc.
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     (1) Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *     (2) Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *     (3) Neither the name of the copyright holder nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+ */
+
+#define BENCHPRESS_CONFIG_MAIN
+
+#include "benchpress.hpp"
+
+
+#if VIRGIL_CRYPTO_FEATURE_PYTHIA
+
+
+#include <virgil/crypto/VirgilByteArrayUtils.h>
+#include <virgil/crypto/pythia/VirgilPythia.h>
+
+using virgil::crypto::VirgilByteArrayUtils;
+using virgil::crypto::pythia::VirgilPythia;
+
+BENCHMARK("pythia init", [](benchpress::context* ctx) {
+
+    ctx->run_parallel([](benchpress::parallel_context* pctx) {
+        while (pctx->next()) {
+            VirgilPythia pythia;
+            auto result = pythia.blind(VirgilByteArrayUtils::stringToBytes("password"));
+        }
+    });
+})
+
+#endif /* VIRGIL_CRYPTO_FEATURE_PYTHIA */

data/ext/native/src/ci/install-dependencies.sh

@@ -50,6 +50,9 @@ travis_retry sudo apt-get -qq update
 ######################################## Utils
 travis_retry sudo apt-get install -y -qq software-properties-common
 
+######################################## Doxygen
+travis_retry sudo apt-get install -y --force-yes -qq doxygen
+
 ######################################## Compilers
 if [[ "${CC}" == "gcc-5" ]]; then
     travis_retry sudo apt-add-repository -y ppa:ubuntu-toolchain-r/test
@@ -75,10 +78,10 @@ else
     tar xvfz cmake-${CMAKE_VERSION}.tar.gz
     cd cmake-${CMAKE_VERSION}
     ./bootstrap
-    make -j4
+    make -j8 >/dev/null
 fi
 
-sudo make install
+sudo make install >/dev/null
 
 cd -
 
@@ -91,21 +94,14 @@ else
     travis_retry wget http://downloads.sourceforge.net/swig/swig-${SWIG_VERSION}.tar.gz
     tar -xzf swig-${SWIG_VERSION}.tar.gz
     cd swig-${SWIG_VERSION}
-    ./configure
-    make -j4
+    ./configure >/dev/null
+    make -j8 >/dev/null
 fi
 
-sudo make install
+sudo make install >/dev/null
 
 cd -
 
-######################################## Doxygen
-echo "Download Doxygen version ${DOXYGEN_VERSION} ..."
-travis_retry wget http://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
-tar -xzf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
-sudo mv doxygen-${DOXYGEN_VERSION}/bin/doxygen /usr/bin/doxygen
-cd -
-
 ####################################### PHP & PHPUnit
 if [[ "${LANG}" == "php" ]]; then
     PHP_VERSION=${LANG_VERSION_MAJOR}.${LANG_VERSION_MINOR}

data/ext/native/src/ci/publish-docs.sh

@@ -35,42 +35,60 @@
 # Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 #
 
-set -ev
+set -e
 
-if [[ "${PUBLISH_DOCS}" == "ON" ]] && [[ "${TRAVIS_BRANCH}" == "master" ]]; then
+# Build documentation from the known tags pattern
+if [ "${PUBLISH_DOCS}" == "ON" ] && [ -n "${TRAVIS_TAG}" ]; then
     # Settings
     REPO_PATH=git@github.com:VirgilSecurity/virgil-crypto.git
     HTML_PATH_DST="${PROJECT_ROOT}/build/docs/html"
     COMMIT_USER="Travis CI documentation builder."
     COMMIT_EMAIL="sergey.seroshtan@gmail.com"
     CHANGESET=$(git rev-parse --verify HEAD)
+    HOST_PLATFORM=$(uname -s)
 
-    # Get a clean version of the HTML documentation repo.
+    echo "Get a clean version of the HTML documentation repo..."
     rm -rf ${HTML_PATH_DST}
     mkdir -p ${HTML_PATH_DST}
     git clone -b gh-pages "${REPO_PATH}" --single-branch ${HTML_PATH_DST}
 
-    # Define SDK versions
-    VIRGIL_CRYPTO_VERSION=`cat ${PROJECT_ROOT}/VERSION | awk -F"." '{ printf "v%d.%d",$1,$2 }'`
+    echo "Define library version..."
+    if [[ ${TRAVIS_TAG} == *-* ]]; then
+        # Featured tag
+        VIRGIL_CRYPTO_VERSION=${TRAVIS_TAG}
+    else
+        VIRGIL_CRYPTO_VERSION=$(echo ${TRAVIS_TAG#v} | awk -F"." '{ printf "v%d.%d",$1,$2 }')
+    fi
+    echo "Library tag    : ${TRAVIS_TAG}"
+    echo "Library version: ${VIRGIL_CRYPTO_VERSION}"
+
     VIRGIL_CRYPTO_HTML_PATH_DST="${HTML_PATH_DST}/${VIRGIL_CRYPTO_VERSION}"
 
-    # Prepare destination folders
+    echo "Prepare destination folder: ${VIRGIL_CRYPTO_HTML_PATH_DST}..."
     rm -fr "${VIRGIL_CRYPTO_HTML_PATH_DST}" && mkdir -p "${VIRGIL_CRYPTO_HTML_PATH_DST}"
 
-    # Generate the HTML documentation.
+    echo "Generate the HTML documentation..."
     cmake --build "${PROJECT_ROOT}/build" --target doc
 
-    # Copy new documentation
+    echo "Copy new documentation..."
+    echo "    From: ${PROJECT_ROOT}/docs/html"
+    echo "    To: ${VIRGIL_CRYPTO_HTML_PATH_DST}"
     cp -af "${PROJECT_ROOT}/docs/html/." "${VIRGIL_CRYPTO_HTML_PATH_DST}"
 
-    # Fix source file names
+    echo "Fix source file names..."
     function fix_html_source_file_names {
         cd "${1}"
         for f in _*.html; do
             old_name=$f
             new_name=${f/${f:0:1}/}
+            echo "    Rename"
+            echo "        from: ${old_name}"
+            echo "        to  : ${new_name}"
             mv $old_name $new_name
-            if [ "$(uname -s)" == "Darwin" ]; then
+
+            echo "        change file name in references..."
+            echo ""
+            if [ "${HOST_PLATFORM}" == "Darwin" ]; then
                 sed -i "" -e "s/[[:<:]]$old_name[[:>:]]/$new_name/g" *.html
             else
                 sed -i"" "s/\b$old_name\b/$new_name/g" *.html
@@ -78,19 +96,83 @@ if [[ "${PUBLISH_DOCS}" == "ON" ]] && [[ "${TRAVIS_BRANCH}" == "master" ]]; then
         done
         cd -
     }
-
     fix_html_source_file_names "${VIRGIL_CRYPTO_HTML_PATH_DST}"
 
-    # Generate root HTML file
-    function get_dir_names {
-        local DIRS=`find "$1" -maxdepth 1 -type d -name "$2"`
-        local DIR_NAMES=()
-        for dir in ${DIRS}; do
-            DIR_NAMES+=("${dir#${1}/}")
+    echo "Get version directories list..."
+    function define_VERSION_DIRS {
+        VERSION_DIRS=()
+        for dir in `find "${HTML_PATH_DST}" -maxdepth 1 -type d -name "v*" | sort -r`; do
+            VERSION_DIRS+=("${dir##*/}")
+        done
+    }
+
+    echo "---"
+    echo "Initial versions:"
+    define_VERSION_DIRS
+    for dir in ${VERSION_DIRS[*]}; do
+        echo "    - ${dir}"
+    done
+
+    echo "---"
+    echo "Cleanup versions..."
+    function find_feature_of_version {
+        local feature=${1}
+        local short_version=${2}
+
+        local found_versions=()
+        for available_version in ${@:3}; do
+            if [[ "${available_version}" = *"${short_version}-${feature}"* ]]; then
+                found_versions+=("${available_version}")
+            fi
+        done
+
+        echo "${found_versions[@]}"
+    }
+
+    function remove_stale_docs_if_relevant_exists {
+        local feature_to_reduce=${1}
+        local features_up_to_date=("${@:2}")
+        echo "    ---"
+        echo "    - Attempt to reduce docs for feature: ${feature_to_reduce} ..."
+        echo "    - By using docs from features       : ${features_up_to_date[*]} ..."
+
+        for version_dir in ${VERSION_DIRS[*]}; do
+            if [[ ${version_dir} = *"${feature_to_reduce}"* ]]; then
+                local version="${version_dir}"
+                local short_version="${version/%-*/}"
+                local release_version=$(echo ${version#v} | awk -F"." '{ printf "v%d.%d",$1,$2 }')
+                echo ""
+                echo "    - Processing version: ${version} ..."
+
+                if [[ " ${VERSION_DIRS[@]} " =~ " ${release_version} " ]]; then
+                    echo "        - Remove docs because production version found: ${release_version} ..."
+                    rm -fr -- "${HTML_PATH_DST}/${version_dir}"
+                    continue
+                fi
+
+                for replacement_feature in ${features_up_to_date[@]}; do
+                    local replacement_feature_versions=$(find_feature_of_version "${replacement_feature}" "${short_version}" "${VERSION_DIRS[@]}")
+
+                    if [ ! -z "${replacement_feature_versions}" ]; then
+                        echo "        - Remove docs because more relevant version(s) are found: ${replacement_feature_versions} ..."
+                        rm -fr -- "${HTML_PATH_DST}/${version_dir}"
+                    fi
+                done
+            fi
         done
-        echo ${DIR_NAMES[*]}
     }
+    remove_stale_docs_if_relevant_exists "beta" "rc"
+    remove_stale_docs_if_relevant_exists "rc"
 
+    echo "---"
+    echo "Reduced versions:"
+    define_VERSION_DIRS
+    for dir in ${VERSION_DIRS[*]}; do
+        echo "    - ${dir}"
+    done
+
+
+    echo "Generate root HTML file..."
     cat >"${HTML_PATH_DST}/index.html" <<EOL
 <!DOCTYPE HTML>
 <html>
@@ -103,7 +185,7 @@ if [[ "${PUBLISH_DOCS}" == "ON" ]] && [[ "${TRAVIS_BRANCH}" == "master" ]]; then
         <ul>
 EOL
 
-    for dir in `get_dir_names "${VIRGIL_CRYPTO_HTML_PATH_DST}/.." "v*"`; do
+    for dir in ${VERSION_DIRS[*]}; do
         echo "            <li><p><a href=\"${dir}/index.html\">${dir}</a></p></li>" >> "${HTML_PATH_DST}/index.html"
     done
 
@@ -113,15 +195,18 @@ EOL
 </html>
 EOL
 
-    # Create and commit the documentation repo.
+    cat "${HTML_PATH_DST}/index.html"
+    cd ${HTML_PATH_DST}
+
     git update-index -q --refresh
     if ! git diff-index --quiet HEAD --; then
-        cd ${HTML_PATH_DST}
+        echo "Commit documentation to the repo..."
         git add .
         git config user.name "${COMMIT_USER}"
         git config user.email "${COMMIT_EMAIL}"
         git commit -m "Automated documentation build for changeset ${CHANGESET}."
         git push origin gh-pages
-        cd -
     fi
+
+    cd -
 fi