add ssh sign feature

Author: yanganto

Cargo.lock

@@ -59,7 +59,7 @@ tempfile = "3.4"
 maintenance = { status = "actively-developed" }
 
 [features]
-default = ["ghemoji", "regex-fancy", "trace-libgit", "vendor-openssl"]
+default = ["asyncgit/common-lib", "ghemoji", "regex-fancy", "trace-libgit", "vendor-openssl"]
 ghemoji = ["gh-emoji"]
 # regex-* features are mutually exclusive.
 regex-fancy = ["syntect/regex-fancy"]

Cargo.toml

@@ -27,6 +27,7 @@ rayon = "1.8"
 rayon-core = "1.12"
 scopetime = { path = "../scopetime", version = "0.1" }
 serde = { version = "1.0", features = ["derive"] }
+ssh-key = { version = "0.6.4", features = ["crypto", "encryption"] }
 thiserror = "1.0"
 unicode-truncate = "0.2.0"
 url = "2.5"
@@ -39,6 +40,7 @@ serial_test = "1.0"
 tempfile = "3.4"
 
 [features]
-default = ["trace-libgit"]
+common-lib = []
+default = ["common-lib", "trace-libgit"]
 trace-libgit = []
 vendor-openssl = ["openssl-sys"]

asyncgit/Cargo.toml

@@ -84,6 +84,10 @@ pub enum Error {
 	///
 	#[error("git hook error: {0}")]
 	Hooks(#[from] git2_hooks::HooksError),
+
+	///
+	#[error("ssh key error: {0}")]
+	SshKeyError(#[from] ssh_key::Error),
 }
 
 ///

asyncgit/src/error.rs

@@ -75,6 +75,8 @@ pub use crate::{
 	treefiles::AsyncTreeFilesJob,
 };
 pub use git2::message_prettify;
+#[cfg(feature = "common-lib")]
+pub use ssh_key;
 use std::{
 	collections::hash_map::DefaultHasher,
 	hash::{Hash, Hasher},

asyncgit/src/lib.rs

@@ -175,7 +175,7 @@ mod tests {
 		File::create(root.join(file_path))?.write_all(b"line 1\n")?;
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "first commit")?;
+		commit(repo_path, "first commit", None)?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -199,7 +199,7 @@ mod tests {
 		file.write(b"line 2\n")?;
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "second commit")?;
+		commit(repo_path, "second commit", None)?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -233,7 +233,7 @@ mod tests {
 		assert_eq!(blame.lines.len(), 2);
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "third commit")?;
+		commit(repo_path, "third commit", None)?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -258,7 +258,7 @@ mod tests {
 			.unwrap();
 
 		stage_add_file(repo_path, file_path).unwrap();
-		commit(repo_path, "first commit").unwrap();
+		commit(repo_path, "first commit", None).unwrap();
 
 		assert!(blame_file(repo_path, "bar\\foo", None).is_ok());
 	}

asyncgit/src/sync/blame.rs

@@ -5,6 +5,7 @@ use crate::{
 };
 use git2::{ErrorCode, ObjectType, Repository, Signature};
 use scopetime::scope_time;
+use ssh_key::{HashAlg, LineEnding, PrivateKey};
 
 ///
 pub fn amend(
@@ -61,7 +62,11 @@ pub(crate) fn signature_allow_undefined_name(
 }
 
 /// this does not run any git hooks, git-hooks have to be executed manually, checkout `hooks_commit_msg` for example
-pub fn commit(repo_path: &RepoPath, msg: &str) -> Result<CommitId> {
+pub fn commit(
+	repo_path: &RepoPath,
+	msg: &str,
+	sk: Option<&PrivateKey>,
+) -> Result<CommitId> {
 	scope_time!("commit");
 
 	let repo = repo(repo_path)?;
@@ -78,17 +83,49 @@ pub fn commit(repo_path: &RepoPath, msg: &str) -> Result<CommitId> {
 	};
 
 	let parents = parents.iter().collect::<Vec<_>>();
-
-	Ok(repo
-		.commit(
-			Some("HEAD"),
+	if let Some(sk) = sk {
+		let buffer = repo.commit_create_buffer(
 			&signature,
 			&signature,
 			msg,
 			&tree,
 			parents.as_slice(),
-		)?
-		.into())
+		)?;
+		let content = String::from_utf8(buffer.to_vec())?;
+		let sig = sk
+			.sign("git", HashAlg::Sha256, &buffer)?
+			.to_pem(LineEnding::LF)?;
+		let commit_id = repo.commit_signed(&content, &sig, None)?;
+		match repo.head() {
+			Ok(mut head) => {
+				head.set_target(commit_id, msg)?;
+			}
+			Err(_) => {
+				let config = repo.config()?;
+				let default_branch_name = config
+					.get_str("init.defaultBranch")
+					.unwrap_or("master");
+				repo.reference(
+					&format!("refs/heads/{}", default_branch_name),
+					commit_id,
+					true,
+					msg,
+				)?;
+			}
+		}
+		Ok(commit_id.into())
+	} else {
+		Ok(repo
+			.commit(
+				Some("HEAD"),
+				&signature,
+				&signature,
+				msg,
+				&tree,
+				parents.as_slice(),
+			)?
+			.into())
+	}
 }
 
 /// Tag a commit.
@@ -162,7 +199,7 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (0, 1));
 
-		commit(repo_path, "commit msg").unwrap();
+		commit(repo_path, "commit msg", None).unwrap();
 
 		assert_eq!(get_statuses(repo_path), (0, 0));
 	}
@@ -188,7 +225,7 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (0, 1));
 
-		commit(repo_path, "commit msg").unwrap();
+		commit(repo_path, "commit msg", None).unwrap();
 
 		assert_eq!(get_statuses(repo_path), (0, 0));
 	}
@@ -205,7 +242,7 @@ mod tests {
 		File::create(root.join(file_path1))?.write_all(b"test1")?;
 
 		stage_add_file(repo_path, file_path1)?;
-		let id = commit(repo_path, "commit msg")?;
+		let id = commit(repo_path, "commit msg", None)?;
 
 		assert_eq!(count_commits(&repo, 10), 1);
 
@@ -244,7 +281,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let new_id = commit(repo_path, "commit msg")?;
+		let new_id = commit(repo_path, "commit msg", None)?;
 
 		tag_commit(repo_path, &new_id, "tag", None)?;
 
@@ -286,7 +323,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let new_id = commit(repo_path, "commit msg")?;
+		let new_id = commit(repo_path, "commit msg", None)?;
 
 		tag_commit(repo_path, &new_id, "tag", Some("tag-message"))?;
 
@@ -322,13 +359,13 @@ mod tests {
 
 		repo.config()?.remove("user.email")?;
 
-		let error = commit(repo_path, "commit msg");
+		let error = commit(repo_path, "commit msg", None);
 
 		assert!(matches!(error, Err(_)));
 
 		repo.config()?.set_str("user.email", "email")?;
 
-		let success = commit(repo_path, "commit msg");
+		let success = commit(repo_path, "commit msg", None);
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 1);
@@ -358,7 +395,7 @@ mod tests {
 
 		repo.config()?.remove("user.name")?;
 
-		let mut success = commit(repo_path, "commit msg");
+		let mut success = commit(repo_path, "commit msg", None);
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 1);
@@ -371,7 +408,7 @@ mod tests {
 
 		repo.config()?.set_str("user.name", "name")?;
 
-		success = commit(repo_path, "commit msg");
+		success = commit(repo_path, "commit msg", None);
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 2);

asyncgit/src/sync/commit.rs

@@ -144,7 +144,7 @@ mod tests {
 		stage_add_file(repo_path, file_path).unwrap();
 
 		let msg = invalidstring::invalid_utf8("test msg");
-		let id = commit(repo_path, msg.as_str()).unwrap();
+		let id = commit(repo_path, msg.as_str(), None).unwrap();
 
 		let res = get_commit_details(repo_path, id).unwrap();
 

asyncgit/src/sync/commit_details.rs

@@ -180,7 +180,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let id = commit(repo_path, "commit msg")?;
+		let id = commit(repo_path, "commit msg", None)?;
 
 		let diff = get_commit_files(repo_path, id, None)?;
 
@@ -222,7 +222,7 @@ mod tests {
 
 		File::create(root.join(file_path1))?.write_all(b"test")?;
 		stage_add_file(repo_path, file_path1)?;
-		commit(repo_path, "c1")?;
+		commit(repo_path, "c1", None)?;
 
 		File::create(root.join(file_path1))?
 			.write_all(b"modified")?;

asyncgit/src/sync/commit_files.rs

@@ -4,6 +4,7 @@ use crate::{
 	sync::{repository::repo, utils::read_file},
 };
 use scopetime::scope_time;
+use ssh_key::PrivateKey;
 
 const GIT_REVERT_HEAD_FILE: &str = "REVERT_HEAD";
 
@@ -40,10 +41,11 @@ pub fn revert_head(repo_path: &RepoPath) -> Result<CommitId> {
 pub fn commit_revert(
 	repo_path: &RepoPath,
 	msg: &str,
+	sk: Option<&PrivateKey>,
 ) -> Result<CommitId> {
 	scope_time!("commit_revert");
 
-	let id = crate::sync::commit(repo_path, msg)?;
+	let id = crate::sync::commit(repo_path, msg, sk)?;
 
 	repo(repo_path)?.cleanup_state()?;