Skip to content

Use custom electron for non-static builds on linux and fix cross-compilation #2033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zawata merged 3 commits into from
Nov 21, 2025
Merged

Use custom electron for non-static builds on linux and fix cross-compilation #2033

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2962d5
always use custom openssl for linux electron builds
zawata Nov 19, 2025
7404623
cross-compilation fixes for openssl and libss2
zawata Nov 19, 2025
9977abb
fix ssh-key-related tests
zawata Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
always use custom openssl for linux electron builds
  • Loading branch information
@zawata
zawata committed Nov 19, 2025
commit c2962d5d3080c4e16cb107021daae7c0a6e9640d
29 changes: 18 additions & 11 deletions generate/templates/templates/binding.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,21 +155,28 @@
"-std=c++<(cxx_version)"
],
}],
["<(is_electron) == 1 and <(electron_openssl_static) == 1", {
["<(is_electron) == 1", {
"conditions": [
["<(electron_openssl_static) == 1", {
"libraries": [
"<(electron_openssl_root)/lib/libssl.a",
"<(electron_openssl_root)/lib/libcrypto.a"
]
}],
["<(electron_openssl_static) != 1", {
"library_dirs": [
"<(electron_openssl_root)/lib"
],
"libraries": [
"-lcrypto",
"-lssl"
]
}]
],
"include_dirs": [
"<(electron_openssl_root)/include"
],
"libraries": [
"<(electron_openssl_root)/lib64/libssl.a",
"<(electron_openssl_root)/lib64/libcrypto.a"
]
}],
["<(is_electron) == 1 and <(electron_openssl_static) != 1", {
"libraries": [
"-lcrypto",
"-lssl"
]
}]
],
}],
[
Expand Down
2 changes: 1 addition & 1 deletion guides/install/from-source/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ npm install nodegit --msvs_version=2013
```

### Electron and OpenSSL ###
A local version of OpenSSL is required when building for Electron on Windows and macOS. This is due to Electron using BoringSSL, as we are not able to link to it like we are OpenSSL in Node. Additionally, OpenSSL can be statically linked on Linux by setting the `NODEGIT_OPENSSL_STATIC_LINK` environment variable to `1`.
A local version of OpenSSL is required when building for Electron. This is due to Electron using BoringSSL, as we are not able to link to it like we are OpenSSL in Node.

`acquireOpenSSL.js` will attempt to download OpenSSL prebuilts from S3. If preferred, it can also be built locally by setting the environment variable `npm_config_openssl_bin_url=skip`. On macOS, this should Just Work(tm). On Windows, things are a little trickier.

Expand Down
29 changes: 7 additions & 22 deletions utils/acquireOpenSSL.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,20 +152,13 @@ const buildLinux = async (buildCwd) => {

const configureArgs = [
buildConfig,
// Electron(at least on centos7) imports the libcups library at runtime, which has a
// dependency on the system libssl/libcrypto which causes symbol conflicts and segfaults.
// To fix this we need to hide all the openssl symbols to prevent them from being overridden
// by the runtime linker.
// "-fvisibility=hidden",
// compile static libraries
"no-shared",
// disable ssl2, ssl3, and compression
"no-ssl2",
// disable ssl3, and compression
"no-ssl3",
"no-comp",
// set install directory
`--prefix="${extractPath}"`,
`--openssldir="${extractPath}"`
`--openssldir="${extractPath}"`,
"--libdir=lib",
];
await execPromise(`./Configure ${configureArgs.join(" ")}`, {
cwd: buildCwd
Expand All @@ -175,11 +168,13 @@ const buildLinux = async (buildCwd) => {

// only build the libraries, not the fuzzer or apps
await execPromise("make build_libs", {
cwd: buildCwd
cwd: buildCwd,
maxBuffer: 10 * 1024 * 1024
}, { pipeOutput: true });

await execPromise("make test", {
cwd: buildCwd
cwd: buildCwd,
maxBuffer: 10 * 1024 * 1024
}, { pipeOutput: true });

// only install software, not the docs
Expand Down Expand Up @@ -341,11 +336,6 @@ const buildOpenSSLIfNecessary = async ({
return;
}

if (process.platform === "linux" && process.env.NODEGIT_OPENSSL_STATIC_LINK !== "1") {
console.log(`Skipping OpenSSL build, NODEGIT_OPENSSL_STATIC_LINK !== 1`);
return;
}

await removeOpenSSLIfOudated(openSSLVersion);

try {
Expand Down Expand Up @@ -396,11 +386,6 @@ const downloadOpenSSLIfNecessary = async ({
return;
}

if (process.platform === "linux" && process.env.NODEGIT_OPENSSL_STATIC_LINK !== "1") {
console.log(`Skipping OpenSSL download, NODEGIT_OPENSSL_STATIC_LINK !== 1`);
return;
}

try {
await fs.stat(extractPath);
console.log("Skipping OpenSSL download, dir exists");
Expand Down
7 changes: 3 additions & 4 deletions vendor/libgit2.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"is_clang%": 0,
"is_IBMi%": "<!(node -p \"os.platform() == 'aix' && os.type() == 'OS400' ? 1 : 0\")",
"electron_openssl_root%": "<!(node ../utils/getElectronOpenSSLRoot.js <(module_root_dir))",
"electron_openssl_static%": "<!(node -p \"process.platform !== 'linux' || process.env.NODEGIT_OPENSSL_STATIC_LINK === '1' ? 1 : 0\")",
},
"targets": [
{
Expand Down Expand Up @@ -238,7 +237,7 @@
}],
["OS=='mac' or OS=='linux' or OS.endswith('bsd') or <(is_IBMi) == 1", {
"conditions": [
["<(is_electron) == 1 and <(electron_openssl_static) == 1", {
["<(is_electron) == 1", {
"dependencies": [
"./libssh2.gyp:acquireOpenSSL",
],
Expand Down Expand Up @@ -487,7 +486,7 @@
"conditions": [
["OS=='mac' or OS=='linux' or OS.endswith('bsd') or <(is_IBMi) == 1", {
"conditions": [
["<(is_electron) == 1 and <(electron_openssl_static) == 1", {
["<(is_electron) == 1", {
"include_dirs": [
"<(electron_openssl_root)/include"
]
Expand Down Expand Up @@ -559,7 +558,7 @@
}],
["OS=='linux'", {
"conditions": [
["<(is_electron) == 1 and <(electron_openssl_static) == 1", {
["<(is_electron) == 1", {
"include_dirs": ["<(electron_openssl_root)/include"]
}]
],
Expand Down