From b3b13f96586003241006326aa7887cd269fda79d Mon Sep 17 00:00:00 2001 From: Benjamin Tan Date: Sat, 2 Mar 2024 00:39:53 +0800 Subject: [PATCH] libgit2: Add support for OpenSSH instead of libssh2 This commit changes the original `ssh` feature into two new ones: `ssh-libssh2` and `ssh-openssh`. By default, the `ssh-libssh2` feature is enabled for backwards compatibility. To use OpenSSH instead, the following listing in `Cargo.toml` can be used: git2-rs = { version = "...", default-features = false, features = ["https", "ssh-openssh"] } Note that https://github.com/libgit2/libgit2/pull/6617 has not actually been released in an official libgit2 version, so the prior commit pulled in the latest commit from `main`. Closes #1028. --- Cargo.toml | 8 +++++--- libgit2-sys/Cargo.toml | 3 ++- libgit2-sys/build.rs | 13 ++++++++++--- libgit2-sys/lib.rs | 6 +++--- src/cred.rs | 2 +- systest/Cargo.toml | 2 +- 6 files changed, 22 insertions(+), 12 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 76c4a62f48..87d2d91f9a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -33,12 +33,14 @@ tempfile = "3.1.0" [features] unstable = [] -default = ["ssh", "https", "ssh_key_from_memory"] -ssh = ["libgit2-sys/ssh"] +default = ["ssh-libssh2", "https"] +ssh = ["ssh-libssh2"] +ssh-libssh2 = ["libgit2-sys/ssh-libssh2"] +ssh-openssh = ["libgit2-sys/ssh-openssh"] +ssh_key_from_memory = [] https = ["libgit2-sys/https", "openssl-sys", "openssl-probe"] vendored-libgit2 = ["libgit2-sys/vendored"] vendored-openssl = ["openssl-sys/vendored", "libgit2-sys/vendored-openssl"] -ssh_key_from_memory = ["libgit2-sys/ssh_key_from_memory"] zlib-ng-compat = ["libgit2-sys/zlib-ng-compat"] [workspace] diff --git a/libgit2-sys/Cargo.toml b/libgit2-sys/Cargo.toml index 67eaf8dc8e..6e7ef64c67 100644 --- a/libgit2-sys/Cargo.toml +++ b/libgit2-sys/Cargo.toml @@ -33,7 +33,8 @@ cc = { version = "1.0.43", features = ['parallel'] } openssl-sys = { version = "0.9.45", optional = true } [features] -ssh = ["libssh2-sys"] +ssh-libssh2 = ["libssh2-sys"] +ssh-openssh = [] https = ["openssl-sys"] ssh_key_from_memory = [] vendored = [] diff --git a/libgit2-sys/build.rs b/libgit2-sys/build.rs index 88fce00d6e..8523ee0957 100644 --- a/libgit2-sys/build.rs +++ b/libgit2-sys/build.rs @@ -23,7 +23,8 @@ fn try_system_libgit2() -> Result { fn main() { let https = env::var("CARGO_FEATURE_HTTPS").is_ok(); - let ssh = env::var("CARGO_FEATURE_SSH").is_ok(); + let ssh_libssh2 = env::var("CARGO_FEATURE_SSH_LIBSSH2").is_ok(); + let ssh_openssh = env::var("CARGO_FEATURE_SSH_OPENSSH").is_ok(); let vendored = env::var("CARGO_FEATURE_VENDORED").is_ok(); let zlib_ng_compat = env::var("CARGO_FEATURE_ZLIB_NG_COMPAT").is_ok(); @@ -175,12 +176,18 @@ The build is now aborting. To disable, unset the variable or use `LIBGIT2_NO_VEN features.push_str("#define GIT_ARCH_64 1\n"); } - if ssh { + if ssh_openssh || ssh_libssh2 { if let Some(path) = env::var_os("DEP_SSH2_INCLUDE") { cfg.include(path); } features.push_str("#define GIT_SSH 1\n"); - features.push_str("#define GIT_SSH_MEMORY_CREDENTIALS 1\n"); + if ssh_openssh { + features.push_str("#define GIT_SSH_EXEC 1\n"); + } + if ssh_libssh2 { + features.push_str("#define GIT_SSH_LIBSSH2 1\n"); + features.push_str("#define GIT_SSH_LIBSSH2_MEMORY_CREDENTIALS 1\n"); + } } if https { features.push_str("#define GIT_HTTPS 1\n"); diff --git a/libgit2-sys/lib.rs b/libgit2-sys/lib.rs index 3de6881842..a20c746788 100644 --- a/libgit2-sys/lib.rs +++ b/libgit2-sys/lib.rs @@ -5,7 +5,7 @@ extern crate libz_sys as libz; use libc::{c_char, c_int, c_uchar, c_uint, c_void, size_t}; -#[cfg(feature = "ssh")] +#[cfg(feature = "ssh-libssh2")] use libssh2_sys as libssh2; use std::ffi::CStr; @@ -4311,12 +4311,12 @@ pub fn openssl_init() { #[doc(hidden)] pub fn openssl_init() {} -#[cfg(feature = "ssh")] +#[cfg(feature = "ssh-libssh2")] fn ssh_init() { libssh2::init(); } -#[cfg(not(feature = "ssh"))] +#[cfg(not(feature = "ssh-libssh2"))] fn ssh_init() {} #[doc(hidden)] diff --git a/src/cred.rs b/src/cred.rs index fc4af1e4eb..287b14b459 100644 --- a/src/cred.rs +++ b/src/cred.rs @@ -659,7 +659,7 @@ echo password=$2 } #[test] - #[cfg(feature = "ssh")] + #[cfg(feature = "ssh-libssh2")] fn ssh_key_from_memory() { let cred = Cred::ssh_key_from_memory( "test", diff --git a/systest/Cargo.toml b/systest/Cargo.toml index fe5cabcf23..aacf329caf 100644 --- a/systest/Cargo.toml +++ b/systest/Cargo.toml @@ -6,7 +6,7 @@ build = "build.rs" edition = "2018" [dependencies] -libgit2-sys = { path = "../libgit2-sys", features = ['https', 'ssh'] } +libgit2-sys = { path = "../libgit2-sys", features = ['https', 'ssh-libssh2'] } libc = "0.2" [build-dependencies]