Allow building OWT SDK with OpenSSL on Linux. (#681)

Author: jianjunz

README.md

@@ -18,7 +18,6 @@ You need [Doxygen](http://www.doxygen.nl/) in your path.
 
 ### Prepare the development environment
 Before you start, make sure you have the following prerequisites installed/configured:
-
 - [WebRTC stack build dependencies](https://webrtc.googlesource.com/src/+/refs/heads/master/docs/native-code/development/prerequisite-sw/index.md).
 - [Proxy settings](https://github.com/open-webrtc-toolkit/owt-client-native/wiki/Proxy-config-for-building-native-SDK).
 
@@ -66,7 +65,7 @@ target_os = []
 Common build options shared by Windows and Linux:
   - By default `x86|Debug` library will be created. Specify `--arch x64` if you want to build x64 libraries; Specify `--scheme release` if release version of library is to be built.
   - The built binary will be under path specified by `--output_path`. If `--output_path` is not set, the built binary will be under `src/out` directory.
-  - The optional `--ssl_root` should be set to the root directory of lastest OpenSSL 1.1.1 binary. If specified, SDK will link to external openssl library instead of boringssl.
+  - The optional `--ssl_root` should be set to the root directory of lastest OpenSSL 3.0 series directory. If specified, build tool will search external OpenSSL headers in `ssl_root/include` and OpenSSL binaries in `ssl_root/bin`. But binaries are not included in OWT SDK, so applications still need to link libcrypto and libssl.
   - Use `--gn_gen` to generate args.gn during the first build or when you change either `ssl_root`/`msdk_root`/`quic_root` options.
   - The optional `--quic_root` should point to the directory containing WebTransport library pre-built from owt-sdk-quic repo. This will build the SDK with WebTransport enabled for 
   conference mode. Refer to [README.webtransport](https://github.com/open-webrtc-toolkit/owt-client-native/blob/main/README.webtransport) for the version of webtransport library to be used.

scripts/build-win.py

@@ -55,9 +55,9 @@ def gngen(arch, ssl_root, msdk_root, quic_root, scheme, tests, runtime):
         gn_args.append('is_debug=true')
         gn_args.append('enable_iterator_debugging=true')
     if ssl_root:
-        gn_args.append('owt_use_openssl=true')
-        gn_args.append('owt_openssl_header_root="%s"' % (ssl_root + r'\include'))
-        gn_args.append('owt_openssl_lib_root="%s"' % (ssl_root + r'\lib'))
+        gn_args.append('rtc_build_ssl=false')
+        gn_args.append('rtc_ssl_root="%s/include"' % ssl_root)
+        gn_args.append('libsrtp_ssl_root="%s/include"' % ssl_root)
     if msdk_root:
         if arch == 'x86':
             msdk_lib = msdk_root + r'\lib\win32'
@@ -103,32 +103,12 @@ def ninjabuild(arch, scheme):
     return True
 
 
-def _getlibs(arch, scheme, ssl_root):
-    '''Returns an array contains all .lib files' path
-    '''
-    result = []
-    owt_path = os.path.join(OUT_PATH, r'%s-%s\obj\talk\owt\owt.lib' % (scheme, arch))
-    result.append(owt_path)
-    ssl_lib_path = os.path.join(ssl_root, 'lib')
-    for root, dirs, files in os.walk(ssl_lib_path):
-        for file in files:
-            name, ext = os.path.splitext(file)
-            if ext == '.lib' and name not in LIB_BLACK_LIST and 'test' not in name:
-                result.append(os.path.abspath(os.path.join(root, file)))
-                print('Merged %s.lib' % name)
-            elif ext == '.lib':
-                print('Skip %s.lib' % name)
-    return result
-
-
-def _mergelibs(arch, scheme, ssl_root):
+def _copylibs(arch, scheme):
     out_lib = OUT_LIB % {'scheme': scheme}
     if os.path.exists(os.path.join(OUT_PATH, out_lib)):
         os.remove(os.path.join(OUT_PATH, out_lib))
-    libs = _getlibs(arch, scheme, ssl_root)
-    command = ['lib.exe', '/OUT:out\%s' % out_lib]
-    command.extend(libs)
-    subprocess.call(command, cwd=HOME_PATH)
+    owt_path = os.path.join(OUT_PATH, r'%s-%s\obj\talk\owt\owt.lib' % (scheme, arch))
+    shutil.copy(owt_path, os.path.join('out',out_lib))
 
 
 # Run unit tests on simulator. Return True if all tests are passed.
@@ -202,6 +182,8 @@ def main():
     if opts.ssl_root and not os.path.exists(os.path.expanduser(opts.ssl_root)):
         print('Invalid ssl_root.')
         return 1
+    if opts.ssl_root:
+        print('As ssl_root is specified, please link OpenSSL binaries into your application.')
     if opts.msdk_root and not os.path.exists(os.path.expanduser(opts.msdk_root)):
         print('Invalid msdk_root')
         return 1
@@ -216,7 +198,7 @@ def main():
         if not ninjabuild(opts.arch, opts.scheme):
             return 1
         else:
-            _mergelibs(opts.arch, opts.scheme, opts.ssl_root)
+            _copylibs(opts.arch, opts.scheme)
     if opts.tests:
         if not runtest(opts.arch, opts.scheme):
             return 1

scripts/build.py

@@ -63,8 +63,8 @@ def gngen(arch, ssl_root, scheme):
   else:
     gn_args += (' is_debug=true')
   if ssl_root:
-    gn_args += (' owt_use_openssl=true owt_openssl_header_root="%s" '\
-        'owt_openssl_lib_root="%s"'%(ssl_root+'/include',ssl_root+'/lib'))
+    gn_args += (' rtc_build_ssl=false rtc_ssl_root="%s" '\
+        'libsrtp_ssl_root="%s"'%(ssl_root+'/include', ssl_root+'/include'))
   ret = subprocess.call(['gn', 'gen', getoutputpath(arch, scheme), '--args=%s' % gn_args],
                         cwd=HOME_PATH, shell=False)
   if ret == 0:
@@ -90,12 +90,6 @@ def copyheaders(headers_target_folder):
       copy_framework_header.Process(os.path.join(
           HEADER_PATH, file_name), os.path.join(headers_target_folder, file_name))
 
-def getexternalliblist(ssl_root):
-  libs = []
-  libs.append('%s/lib/libcrypto.a'%ssl_root)
-  libs.append('%s/lib/libssl.a'%ssl_root)
-  return libs
-
 def buildframework():
   '''Create OWT.framework in out/'''
   if os.path.exists(OUT_FRAMEWORK_ROOT):
@@ -125,7 +119,7 @@ def buildwebrtcframework(arch_list, scheme):
     subprocess.call(cmd, cwd=HOME_PATH)
     return True
 
-def dist(arch_list, scheme, ssl_root):
+def dist(arch_list, scheme):
   buildwebrtcframework(arch_list, scheme)
   out_lib_path = os.path.join(OUT_PATH, OUT_LIB_NAME)
   if os.path.exists(out_lib_path):
@@ -136,9 +130,6 @@ def dist(arch_list, scheme, ssl_root):
   for target_arch in arch_list:
     for sdk_target in SDK_TARGETS:
       argu.append('%s/obj/talk/owt/lib%s.a'%(getoutputpath(target_arch, scheme), sdk_target))
-  # Add external libs.
-  if ssl_root:
-    argu.extend(getexternalliblist(ssl_root))
   subprocess.call(argu, cwd=HOME_PATH)
   if scheme == 'release':
     subprocess.call(['strip', '-S', '-x', '%s/out/libowt.a'%HOME_PATH],
@@ -199,7 +190,7 @@ def main():
           return 1
       if not ninjabuild(arch_item, opts.scheme, SDK_TARGETS):
         return 1
-  dist(opts.arch, opts.scheme, opts.ssl_root)
+  dist(opts.arch, opts.scheme)
   if not opts.skip_tests:
     if not opts.skip_gn_gen:
       if not gngen(TEST_ARCH, opts.ssl_root, TEST_SCHEME):

scripts/build_linux.py

@@ -29,8 +29,6 @@
     'enable_libaom=true',
     'is_component_build=false',
     'rtc_build_examples=false',
-    # Disable usage of GTK.
-    'rtc_use_gtk=false',
     # When is_clang is false, we're not using sysroot in tree.
     'use_sysroot=false',
     # For Linux build we expect application built with gcc/g++. Set SDK to use
@@ -55,11 +53,11 @@ def gngen(arch, ssl_root, msdk_root, quic_root, scheme, tests, use_gcc, fake_aud
     else:
         gn_args.append('is_debug=true')
     if ssl_root:
-        gn_args.append('owt_use_openssl=true')
-        gn_args.append('owt_openssl_header_root="%s"' % (ssl_root + r'/include'))
-        gn_args.append('owt_openssl_lib_root="%s"' % (ssl_root + r'/lib'))
+        gn_args.append('rtc_build_ssl=false')
+        gn_args.append('rtc_ssl_root="%s/include"' % ssl_root)
+        gn_args.append('libsrtp_ssl_root="%s/include"' % ssl_root)
     else:
-        gn_args.append('owt_use_openssl=false')
+        gn_args.append('rtc_build_ssl=true')
     if msdk_root:
         if arch == 'x86':
             msdk_lib = msdk_root + r'/lib32'

scripts/prepare_dev.py

@@ -34,7 +34,6 @@
 patchList = [
     # TODO: Update these patches for the latest branch.
     # ('0001-Use-OpenSSL-for-usrsctp.patch', THIRD_PARTY_PATH),
-    # ('0002-Use-OpenSSL-for-libsrtp.patch', LIBSRTP_PATH),
     # ('0003-Enable-Wunused-but-set-variable.patch', BUILD_PATH),
     # ('0004-Remove-webrtc_overrides.patch', THIRD_PARTY_PATH),
     # ('0005-Fixed-compile-issue-and-disable-thin-archive.patch', BUILD_PATH),
@@ -55,7 +54,8 @@
     ('0022-Apply-Wno-shadow-for-clang-only.patch', THIRD_PARTY_PATH),
     ('0023-Fix-FFMPEG-config-for-MSVC-build.patch', FFMPEG_PATH),
     ('0024-Getting-install-build-deps-to-work-on-Ubuntu-22.04-L.patch', BUILD_PATH),
-    ('0025-Allow-ffmpeg_branding-OWT.patch', FFMPEG_PATH)
+    ('0025-Allow-ffmpeg_branding-OWT.patch', FFMPEG_PATH),
+    ('0026-Add-an-GN-variable-for-using-BoringSSL.patch', LIBSRTP_PATH)
 ]
 
 def _patch(ignoreFailures=False):

talk/owt/BUILD.gn

@@ -97,6 +97,20 @@ if (!is_ios) {
       if (rtc_enable_protobuf) {
         deps += [ "//third_party/protobuf:protobuf_lite" ]
       }
+
+      if (!rtc_build_ssl) {
+        if (is_win) {
+          libs = [
+            "libcrypto.lib",
+            "libssl.lib",
+          ]
+        } else {
+          libs = [
+            "crypto",
+            "ssl",
+          ]
+        }
+      }
     }
   } else {
     static_library("owt") {

talk/owt/patches/0002-Use-OpenSSL-for-libsrtp.patch

@@ -0,0 +1,41 @@
+From 6daad52e10d89d820648fd017f501541dd9b6a9d Mon Sep 17 00:00:00 2001
+From: Jianjun Zhu <[email protected]>
+Date: Fri, 10 Feb 2023 16:03:37 +0800
+Subject: [PATCH] Add an GN variable for using BoringSSL.
+
+---
+ BUILD.gn | 11 ++++++++---
+ 1 file changed, 8 insertions(+), 3 deletions(-)
+
+diff --git a/BUILD.gn b/BUILD.gn
+index 0f0f9e5..18f517d 100644
+--- a/BUILD.gn
++++ b/BUILD.gn
+@@ -8,6 +8,7 @@ declare_args() {
+   # Tests may not be appropriate for some build environments, e.g. Windows.
+   # Rather than enumerate valid options, we just let clients ask for them.
+   build_libsrtp_tests = false
++  libsrtp_ssl_root = ""
+ }
+ 
+ config("libsrtp_config") {
+@@ -133,9 +134,13 @@ static_library("libsrtp") {
+     # "crypto/cipher/aes_icm_nss.c",
+   ]
+ 
+-  public_deps = [
+-    "//third_party/boringssl:boringssl",
+-  ]
++  if (libsrtp_ssl_root == "") {
++    public_deps = [
++      "//third_party/boringssl:boringssl",
++    ]
++  } else {
++    include_dirs = [ libsrtp_ssl_root ]
++  }
+ }
+ 
+ if (build_libsrtp_tests) {
+-- 
+2.37.1.windows.1
+