Skip to content

Commit

Permalink
[SCons] Build OpenSSL from source by default
Browse files Browse the repository at this point in the history
Remove prebuilt static libraries for macOS.

Can optionally still use external (static) libraries by supplying the
`openssl_external_*` parameters to scons.
  • Loading branch information
Faless committed Jun 23, 2023
1 parent 3fc541f commit 3eff06f
Show file tree
Hide file tree
Showing 11 changed files with 314 additions and 32 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ extension_api.json
# Mac stuff
.DS_Store

# Vim
*.swp

# Binaries
__pycache__/
build/
bin/
macos/
Expand All @@ -29,4 +33,4 @@ win64/
*.os
*.ilk
*.pdb
!thirdparty/openssl/*
*.pyc
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@
[submodule "thirdparty/ssh2/libssh2"]
path = thirdparty/ssh2/libssh2
url = https://github.com/libssh2/libssh2
[submodule "thirdparty/openssl"]
path = thirdparty/openssl
url = https://github.com/openssl/openssl
20 changes: 10 additions & 10 deletions SConstruct
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,6 @@ opts.Add(PathVariable("target_path",
"The path where the lib is installed.", "demo/addons/godot-git-plugin/"))
opts.Add(PathVariable("target_name", "The library name.",
"libgit_plugin", PathVariable.PathAccept))
opts.Add(PathVariable("macos_openssl", "Path to OpenSSL library root - only used in macOS builds.",
"/usr/local/opt/openssl@1.1/", PathVariable.PathAccept)) # TODO: Find a way to configure this to use the cloned OpenSSL source code, based on `macos_arch`.
opts.Add(PathVariable("macos_openssl_static_ssl", "Path to OpenSSL libssl.a library - only used in macOS builds.",
os.path.join(os.path.abspath(os.getcwd()), "thirdparty/openssl/libssl.a"), PathVariable.PathAccept))
opts.Add(PathVariable("macos_openssl_static_crypto", "Path to OpenSSL libcrypto.a library - only used in macOS builds.",
os.path.join(os.path.abspath(os.getcwd()), "thirdparty/openssl/libcrypto.a"), PathVariable.PathAccept))
opts.Add(PathVariable("linux_openssl_static_ssl", "Path to OpenSSL libssl.a library - only used in Linux builds.",
"/usr/lib/x86_64-linux-gnu/libssl.a", PathVariable.PathAccept))
opts.Add(PathVariable("linux_openssl_static_crypto", "Path to OpenSSL libcrypto.a library - only used in Linux builds.",
"/usr/lib/x86_64-linux-gnu/libcrypto.a", PathVariable.PathAccept))

# Updates the environment with the option variables.
opts.Update(env)
Expand All @@ -33,8 +23,18 @@ if ARGUMENTS.get("custom_api_file", "") != "":

ARGUMENTS["target"] = "editor"
env = SConscript("godot-cpp/SConstruct").Clone()

# OpenSSL Builder
env.Tool("openssl", toolpath=["tools"])

opts.Update(env)

if env["platform"] != "windows": # Windows does not need OpenSSL
ssl = env.OpenSSL()
else:
ssl = []

Export("ssl")
Export("env")

SConscript("thirdparty/SCsub")
Expand Down
5 changes: 1 addition & 4 deletions THIRDPARTY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ The Godot Git Plugin source code uses the following third-party source code:
1. godotengine/godot-cpp - MIT License - https://github.com/godotengine/godot-cpp/tree/02336831735fd6affbe0a6fa252ec98d3e78120c
2. libgit2/libgit2 - GPLv2 with a special Linking Exception - https://github.com/libgit2/libgit2/tree/b7bad55e4bb0a285b073ba5e02b01d3f522fc95d
3. libssh2/libssh2 - BSD-3-Clause License - https://github.com/libssh2/libssh2/tree/635caa90787220ac3773c1d5ba11f1236c22eae8

We also link to these third-party libraries (only in the compiled binary form):

1. OpenSSL - Only on Linux and MacOS - OpenSSL License - http://www.openssl.org/source/openssl-1.1.1s.tar.gz
4. openssl (only on Linux and MacOS) - OpenSSL License - https://github.com/openssl/openssl/tree/26baecb28ce461696966dac9ac889629db0b3b96

## License Texts

Expand Down
9 changes: 4 additions & 5 deletions godot-git-plugin/SCsub
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import os

env = {}
Import("env")
Import("ssl")

# Process some arguments
if env["use_llvm"]:
Expand All @@ -24,8 +25,6 @@ if env["platform"] == "macos":
env["target_path"] += "macos/"

# Force static linkage (https://stackoverflow.com/a/2995999/7370948)
env.Append(LIBS=[File(env["macos_openssl_static_ssl"]),
File(env["macos_openssl_static_crypto"])])

if env["macos_deployment_target"] != "default":
env.Append(CCFLAGS=["-mmacosx-version-min=" +
Expand All @@ -35,8 +34,6 @@ if env["platform"] == "macos":

elif env["platform"] == "linux":
env["target_path"] += "linux/"
env.Append(LIBS=[File(env["linux_openssl_static_ssl"]),
File(env["linux_openssl_static_crypto"])])

elif env["platform"] == "windows":
env["target_path"] += "win64/"
Expand All @@ -50,9 +47,11 @@ env.Append(CPPPATH=["../thirdparty/git2/libgit2/include/"])
env.Append(LIBPATH=["../thirdparty/bin/"])
env.Prepend(LIBS=["git2", "ssh2"])

lib_sources = Glob("src/*.cpp")
env.Depends(lib_sources, ssl)
library = env.SharedLibrary(
target=env["target_path"] +
"{}{}{}".format(env["target_name"], env["suffix"], env["SHLIBSUFFIX"]),
source=Glob("src/*.cpp")
source=lib_sources
)
Default(library)
8 changes: 2 additions & 6 deletions thirdparty/git2/SCsub
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Adopted from https://github.com/goostengine/goost/blob/20d8ce4c7d74c26832d69283305b25a72165784a/modules/git/SCsub

Import("env")
Import("ssl")

env_git = env.Clone()

Expand Down Expand Up @@ -125,11 +126,6 @@ if env_git["platform"] in ["linux", "macos"]:
"UNICODE_BUILTIN"
]
)

if env_git["platform"] == "macos":
env_git.Prepend(CPPPATH=[env_git["macos_openssl"] + "include/"])
static_ssl = File(env_git["macos_openssl_static_ssl"])
static_crypto = File(env_git["macos_openssl_static_crypto"])
env_git.Append(LIBS=[static_ssl, static_crypto])
env_git.Depends(libgit2_sources, ssl)

env_git.StaticLibrary(target="../bin/" + "git2", source=libgit2_sources)
1 change: 1 addition & 0 deletions thirdparty/openssl
Submodule openssl added at 2cf4e9
Binary file removed thirdparty/openssl/libcrypto.a
Binary file not shown.
Binary file removed thirdparty/openssl/libssl.a
Binary file not shown.
8 changes: 2 additions & 6 deletions thirdparty/ssh2/SCsub
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Adopted from https://github.com/nodegit/nodegit/blob/4561dcb7c120474a4553baa27e4c4c2f4be23a2b/vendor/libgit2.gyp

Import("env")
Import("ssl")

env_ssh2 = env.Clone()

Expand Down Expand Up @@ -104,11 +105,6 @@ if env_ssh2["platform"] in ["linux", "macos"]:
("STDC_HEADERS", 1)
]
)

if env_ssh2["platform"] == "macos":
env_ssh2.Append(CPPPATH=[env_ssh2["macos_openssl"] + "include/"])
static_ssl = File(env_ssh2["macos_openssl_static_ssl"])
static_crypto = File(env_ssh2["macos_openssl_static_crypto"])
env_ssh2.Append(LIBS=[static_ssl, static_crypto])
env_ssh2.Depends(libssh2_sources, ssl)

env_ssh2.StaticLibrary(target="../bin/" + "ssh2", source=libssh2_sources)
Loading

0 comments on commit 3eff06f

Please sign in to comment.