Dev

.travis.yml

@@ -26,7 +26,7 @@ before_script:
   - cd ..
   - git clone --depth 1 -b ${OPENSSL_BRANCH} https://github.com/openssl/openssl.git
   - cd openssl
-  - git apply ../bee2evp/btls/openssl111i.patch
+  - git apply ../bee2evp/btls/patch/${OPENSSL_BRANCH}.patch
   - cp ../bee2evp/btls/btls.c ./ssl/
   - cp ../bee2evp/btls/btls.h ./ssl/
   - mkdir build

btls/README.md

@@ -0,0 +1,33 @@
+# OpenSSL patching
+
+There are two patching methods available:
+1. Using a patch generated by git diff.
+2. Using a slightly smarter patch that doesn't depend on line numbers and can be 
+applied to different versions of openssl.
+
+## Option 1
+
+Can only be used for **OpenSSL_1_1_1i** version .
+
+## Option 2
+
+| version | test results |
+| :--- | :---: |
+| OpenSSL_1_1_1i | :heavy_check_mark:      |
+| OpenSSL_1_1_1j | :heavy_check_mark:      |
+| OpenSSL_1_1_1k | :heavy_check_mark:      |
+| OpenSSL_1_1_1l | :heavy_check_mark:      |
+| OpenSSL_1_1_1m | :heavy_check_mark:      |
+| OpenSSL_1_1_1n | :heavy_multiplication_x: (see [issue](https://github.com/bcrypto/bee2evp/issues/11#issue-1179528056))|
+
+## Build script
+
+Run script build.sh. Usage:
+```text
+"Script for patching OpenSSL."
+
+"Syntax: build [-v|m]"
+   "options:"
+   "v     OpenSSL version"
+   "m     Mode: 0 (simple patching) or 1 (smart patching)"
+```

btls/build.sh

@@ -0,0 +1,138 @@
+#!/bin/bash
+############################################################
+# help                                                     #
+############################################################
+help()
+{
+   # Display Help
+   echo "Script for patching openssl."
+   echo
+   echo "Syntax: build [-v|m|h]"
+   echo "options:"
+   echo "v     OpenSSL version"
+   echo "m     Mode: 0 (simple patching) or 1 (smart patching)"
+   echo
+}
+
+############################################################
+# Process the input options. Add options as needed.        #
+############################################################
+# Get the options
+while getopts 'hv:m:' flag ; do
+  case "$flag" in
+    h)
+      help
+      exit;;
+    v)
+      openssl_branch=$OPTARG
+      ;;
+    m)
+      mode=$OPTARG;
+      ;;
+    \?) # Invalid option
+      echo "Error: Invalid option"
+      exit;;
+  esac
+done
+
+echo "version=$openssl_branch"
+echo "mode=${mode}"
+
+bee2evp=$(pwd)/..
+build_root=$bee2evp/build_$openssl_branch
+bee2=$bee2evp/bee2
+openssl=$bee2evp/openssl
+build_bee2evp=$build_root/build_bee2evp
+build_bee2=$build_root/build_bee2
+build_openssl=$build_root/build_openssl
+local=$build_root/local
+# openssl_branch=OpenSSL_1_1_1i
+openssl_patch=$openssl_branch.patch
+
+install_prereq(){
+  sudo apt-get update
+  sudo apt-get install git gcc cmake python3 python3-pip
+}
+
+clean(){
+  rm -rf $build_root
+  rm -rf $openssl
+}
+
+update_repos(){
+  echo $openssl_branch
+  git submodule update --init
+  git clone -b $openssl_branch --depth 1 https://github.com/openssl/openssl $openssl
+}
+
+patch_openssl(){
+  cd $openssl
+  cp $bee2evp/btls/btls.c ./ssl/
+  cp $bee2evp/btls/btls.h ./ssl/
+if [[ $mode -eq "1" ]]
+then
+  cp $bee2evp/btls/patch/patching.py ./
+  cp $bee2evp/btls/patch/patch.json ./
+  pip3 install multiline
+  python3 patching.py
+else
+  git apply $bee2evp/btls/patch/$openssl_patch
+fi
+}
+
+build_bee2(){
+  mkdir -p $build_bee2 && mkdir -p $local && cd $build_bee2
+  cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_PIC=ON -DCMAKE_INSTALL_PREFIX=$local $bee2
+  make -j$(nproc) && ctest && make install
+  ls -la $local/lib/libbee2_static.a
+}
+
+build_openssl(){
+  mkdir -p $build_openssl && mkdir -p $local && cd $build_openssl
+  $openssl/config shared -d --prefix=$local --openssldir=$local
+  make -j$(nproc) all
+  make install > build.log 2>&1 || (cat build.log && exit 1)
+  ls -la $local/lib/libcrypto.a
+  ls -la $local/lib/libssl.a
+  ls -la $local/lib/libcrypto.so
+  ls -la $local/lib/libssl.so
+}
+
+build_bee2evp(){
+  mkdir -p $build_bee2evp && cd $build_bee2evp
+  cmake -DCMAKE_BUILD_TYPE=Release \
+    -DBEE2_LIBRARY_DIRS=$local/lib -DBEE2_INCLUDE_DIRS=$local/include \
+    -DOPENSSL_LIBRARY_DIRS=$local/lib -DOPENSSL_INCLUDE_DIRS=$local/include \
+    -DLIB_INSTALL_DIR=$local/lib -DCMAKE_INSTALL_PREFIX=$local $bee2evp
+  make -j$(nproc) && make install
+  ls -la $local/lib/libbee2evp.so
+}
+
+attach_bee2evp(){
+  #cp $bee2evp/doc/bee2evp.cnf $local/openssl.cnf
+  #sed -i "s|#path/to/bee2evp|$local/lib/libbee2evp.so|g" $local/openssl.cnf
+  mv $local/openssl.cnf.dist $local/openssl.cnf
+  sed -i "/\[ new\_oids\ ]/i openssl_conf = openssl_init\n[ openssl_init ]\nengines = engine_section\n[ engine_section ]\nbee2evp = bee2evp_section\n[ bee2evp_section ]\nengine_id = bee2evp\ndynamic_path = $local/lib/libbee2evp.so\ndefault_algorithms = ALL" $local/openssl.cnf
+}
+
+test_bee2evp(){
+  export LD_LIBRARY_PATH="$local/lib:${LD_LIBRARY_PATH:-}"
+  cd $local/bin || exit
+  ./openssl version
+  ./openssl engine -c -t bee2evp
+}
+
+if [ "$#" -eq 0 ];
+then
+  help 
+else
+  install_prereq
+  clean
+  update_repos
+  patch_openssl
+  build_bee2
+  build_openssl
+  build_bee2evp
+  attach_bee2evp
+  test_bee2evp
+fi