godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/mbedtls/SCsub

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

131 lines
3.1 KiB
Plaintext
Raw Normal View History

Add mbedtls module
2018-02-09 14:03:34 +00:00
#!/usr/bin/env python
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted.
2020-03-30 06:28:32 +00:00
Import("env")
Import("env_modules")
Add mbedtls module
2018-02-09 14:03:34 +00:00
env_mbed_tls = env_modules.Clone()
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
# Thirdparty source files
thirdparty_obj = []
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted.
2020-03-30 06:28:32 +00:00
if env["builtin_mbedtls"]:
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
thirdparty_sources = [
"aes.c",
"aesni.c",
"arc4.c",
Bump mbedTLS to version 2.10.0
2018-06-07 14:25:01 +00:00
"aria.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"asn1parse.c",
"asn1write.c",
"base64.c",
"bignum.c",
"blowfish.c",
"camellia.c",
"ccm.c",
"certs.c",
mbedtls: Update to upstream version 2.12.0 _WIN32_WINNT redefinition fix is no longer needed as it was merged upstream. PR 1453 is still not merged, diff updated to current state.
2018-07-28 09:16:41 +00:00
"chacha20.c",
"chachapoly.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"cipher.c",
"cipher_wrap.c",
"cmac.c",
"ctr_drbg.c",
Bump mbedTLS version to 2.28.0 (new LTS). Keep applying the windows entropy patch (UWP support). Remove no longer needed padlock patch. Update thirdparty README to reflect changes, and new source inclusion criteria.
2021-12-21 11:54:05 +00:00
"constant_time.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"debug.c",
"des.c",
"dhm.c",
"ecdh.c",
"ecdsa.c",
"ecjpake.c",
"ecp.c",
"ecp_curves.c",
"entropy.c",
"entropy_poll.c",
"error.c",
"gcm.c",
"havege.c",
mbedtls: Update to upstream version 2.12.0 _WIN32_WINNT redefinition fix is no longer needed as it was merged upstream. PR 1453 is still not merged, diff updated to current state.
2018-07-28 09:16:41 +00:00
"hkdf.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"hmac_drbg.c",
"md2.c",
"md4.c",
"md5.c",
"md.c",
"memory_buffer_alloc.c",
Bump mbedTLS version to 2.28.0 (new LTS). Keep applying the windows entropy patch (UWP support). Remove no longer needed padlock patch. Update thirdparty README to reflect changes, and new source inclusion criteria.
2021-12-21 11:54:05 +00:00
"mps_reader.c",
"mps_trace.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"net_sockets.c",
mbedtls: Update to upstream version 2.12.0 _WIN32_WINNT redefinition fix is no longer needed as it was merged upstream. PR 1453 is still not merged, diff updated to current state.
2018-07-28 09:16:41 +00:00
"nist_kw.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"oid.c",
"padlock.c",
"pem.c",
"pk.c",
"pkcs11.c",
"pkcs12.c",
"pkcs5.c",
"pkparse.c",
"pk_wrap.c",
"pkwrite.c",
"platform.c",
Bump mbedTLS to version 2.10.0
2018-06-07 14:25:01 +00:00
"platform_util.c",
mbedtls: Update to upstream version 2.12.0 _WIN32_WINNT redefinition fix is no longer needed as it was merged upstream. PR 1453 is still not merged, diff updated to current state.
2018-07-28 09:16:41 +00:00
"poly1305.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"ripemd160.c",
"rsa.c",
"rsa_internal.c",
"sha1.c",
"sha256.c",
"sha512.c",
"ssl_cache.c",
"ssl_ciphersuites.c",
"ssl_cli.c",
"ssl_cookie.c",
Bump mbedTLS version to 2.28.0 (new LTS). Keep applying the windows entropy patch (UWP support). Remove no longer needed padlock patch. Update thirdparty README to reflect changes, and new source inclusion criteria.
2021-12-21 11:54:05 +00:00
"ssl_msg.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"ssl_srv.c",
"ssl_ticket.c",
"ssl_tls.c",
Bump mbedTLS version to 2.28.0 (new LTS). Keep applying the windows entropy patch (UWP support). Remove no longer needed padlock patch. Update thirdparty README to reflect changes, and new source inclusion criteria.
2021-12-21 11:54:05 +00:00
"ssl_tls13_keys.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
"threading.c",
"timing.c",
"version.c",
"version_features.c",
"x509.c",
"x509_create.c",
"x509_crl.c",
"x509_crt.c",
"x509_csr.c",
"x509write_crt.c",
"x509write_csr.c",
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted.
2020-03-30 06:28:32 +00:00
"xtea.c",
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
]
Add mbedtls module
2018-02-09 14:03:34 +00:00
Allow building with system wide mbedtls on X11 Using builtin_mbedtls=yes is still the default as many distributions do not ship with mbedtls included.
2018-02-10 13:06:38 +00:00
thirdparty_dir = "#thirdparty/mbedtls/library/"
thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]
SCons: Build thirdparty code in own env, disable warnings Also remove unnecessary `Export('env')` in other SCsubs, Export should only be used when exporting *new* objects.
2018-09-28 11:29:52 +00:00
Use Prepend instead of Append for mbedTLS include Fixes build on FreeBSD when system-wide mbedTLS and/or openSSL are installed
2018-02-28 18:00:49 +00:00
env_mbed_tls.Prepend(CPPPATH=["#thirdparty/mbedtls/include/"])
mbedTLS: disable weak crypto and TLS versions. This commit adds a new mbedTLS configuration header to customize the built-in library (and can be optionally replaced by a platform-specific one). Currently, it disables most weak cryptographic functions (with the notable exceptions of MD5 and SHA-1), along with removing support for TLS versions 1.0 and 1.1 (making TLSv1.2 the only supported one).
2023-04-11 13:39:07 +00:00
env_mbed_tls.Append(
CPPDEFINES=[("MBEDTLS_CONFIG_FILE", '\\"thirdparty/mbedtls/include/godot_module_mbedtls_config.h\\"')]
)
Add mbedtls module
2018-02-09 14:03:34 +00:00
SCons: Build thirdparty code in own env, disable warnings Also remove unnecessary `Export('env')` in other SCsubs, Export should only be used when exporting *new* objects.
2018-09-28 11:29:52 +00:00
env_thirdparty = env_mbed_tls.Clone()
env_thirdparty.disable_warnings()
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)
mbedTLS: disable weak crypto and TLS versions. This commit adds a new mbedTLS configuration header to customize the built-in library (and can be optionally replaced by a platform-specific one). Currently, it disables most weak cryptographic functions (with the notable exceptions of MD5 and SHA-1), along with removing support for TLS versions 1.0 and 1.1 (making TLSv1.2 the only supported one).
2023-04-11 13:39:07 +00:00
env_thirdparty.Depends(thirdparty_obj, "#thirdparty/mbedtls/include/godot_module_mbedtls_config.h")
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
env.modules_sources += thirdparty_obj
# Godot source files
SCons: Build thirdparty code in own env, disable warnings Also remove unnecessary `Export('env')` in other SCsubs, Export should only be used when exporting *new* objects.
2018-09-28 11:29:52 +00:00
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
module_obj = []
env_mbed_tls.add_source_files(module_obj, "*.cpp")
feat: HMAC support in Crypto APIs
2020-11-14 12:42:47 +00:00
if env["tests"]:
env_mbed_tls.Append(CPPDEFINES=["TESTS_ENABLED"])
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
env_mbed_tls.add_source_files(module_obj, "./tests/*.cpp")
Add unit tests for CryptoKey
2024-03-01 07:17:59 +00:00
if env["disable_exceptions"]:
env_mbed_tls.Append(CPPDEFINES=["DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS"])
SCons: Add explicit dependencies on thirdparty code in cloned env Since we clone the environments to build thirdparty code, we don't get an explicit dependency on the build objects produced by that environment. So when we update thirdparty code, Godot code using it is not necessarily rebuilt (I think it is for changed headers, but not for changed .c/.cpp files), which can lead to an invalid compilation output (linking old Godot .o files with a newer, potentially ABI breaking version of thirdparty code). This was only seen as really problematic with bullet updates (leading to crashes when rebuilding Godot after a bullet update without cleaning .o files), but it's safer to fix it everywhere, even if it's a LOT of hacky boilerplate.
2020-12-17 15:01:36 +00:00
env.modules_sources += module_obj
# Needed to force rebuilding the module files when the thirdparty library is updated.
env.Depends(module_obj, thirdparty_obj)