From f41ff295ccf770d77dd58293c9998322b8dba2b0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Charaoui?= <jerome@riseup.net>
Date: Sat, 11 Feb 2023 23:34:32 -0500
Subject: [PATCH] borg: don't hardcode ssh port default (DEBBUG-993951)

Adding the port parameter to the borg handler with a default value of 22
is causing issues for users who had been using the standard ssh config
file to set the remote port, since the -p cli argument overrides the
configuration. This removes the default port number and only uses it in
the connection string if defined.
---
 CHANGELOG.md     |  1 +
 handlers/borg.in |  8 ++++----
 test/borg.bats   | 19 +++++++++----------
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2d3d207..ba08259 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- [borg] don't hardcode ssh port default (DEBBUG-993951)
 - [core] allow for disabling reports by email
 
 ### Fixed
diff --git a/handlers/borg.in b/handlers/borg.in
index 582e0a6..845f3d5 100644
--- a/handlers/borg.in
+++ b/handlers/borg.in
@@ -41,7 +41,7 @@ getconf ignore_missing
 setsection dest
 getconf user
 getconf host
-getconf port 22
+getconf port
 getconf directory
 # strip trailing /
 directory=${directory%/}
@@ -69,7 +69,7 @@ fi
 if [ "$host" != "localhost" ]; then
    [ -n "$user" ] || fatal "Destination user not set"
    [ -n "$host" ] || fatal "Destination host not set"
-  execstr_repository="ssh://${user}@${host}:${port}${directory}"
+  execstr_repository="ssh://${user}@${host}${port:+:${port}}${directory}"
 else
   execstr_repository="$directory"
 fi
@@ -104,8 +104,8 @@ fi
 # check the connection at the source and destination
 [ -n "$test" ] || test=0
 if [ "$host" != "localhost" ] && ([ "$testconnect" = "yes" ] || [ "${test}" -eq 1 ]); then
-   debug "ssh $sshoptions -o PasswordAuthentication=no $host -p $port -l $user 'echo -n 1'"
-   local ret=`ssh $sshoptions -o PasswordAuthentication=no $host -p $port -l $user 'echo -n 1'`
+   debug "ssh $sshoptions -o PasswordAuthentication=no ${host}${port:+ -p ${port}} -l $user 'echo -n 1'"
+   local ret=`ssh $sshoptions -o PasswordAuthentication=no ${host}${port:+ -p ${port}} -l $user 'echo -n 1'`
    if [ "$ret" = 1 ]; then
       debug "Connected to $host as $user successfully"
    else
diff --git a/test/borg.bats b/test/borg.bats
index a0a9e22..0a454ac 100644
--- a/test/borg.bats
+++ b/test/borg.bats
@@ -28,7 +28,6 @@ cache_directory =
 [dest]
 user =
 host = localhost
-port = 22
 directory = ${BN_BACKUPDIR}/testborg
 archive =
 compression = lz4
@@ -243,8 +242,8 @@ finish_borg() {
     setconfig dest user "$BN_REMOTEUSER"
     setconfig dest host "$BN_REMOTEHOST"
     testaction
-    greplog "Debug: ssh\s\+-o PasswordAuthentication=no ${BN_REMOTEHOST} -p 22 -l ${BN_REMOTEUSER} 'echo -n 1'"
-    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}:22${BN_BACKUPDIR}/testborg::"
+    greplog "Debug: ssh\s\+-o PasswordAuthentication=no ${BN_REMOTEHOST} -l ${BN_REMOTEUSER} 'echo -n 1'"
+    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}${BN_BACKUPDIR}/testborg::"
 }
 
 @test "check config parameter dest/host" {
@@ -258,18 +257,18 @@ finish_borg() {
     setconfig dest user "$BN_REMOTEUSER"
     setconfig dest host "$BN_REMOTEHOST"
     testaction
-    greplog "Debug: ssh\s\+-o PasswordAuthentication=no ${BN_REMOTEHOST} -p 22 -l ${BN_REMOTEUSER} 'echo -n 1'"
-    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}:22${BN_BACKUPDIR}/testborg::"
+    greplog "Debug: ssh\s\+-o PasswordAuthentication=no ${BN_REMOTEHOST} -l ${BN_REMOTEUSER} 'echo -n 1'"
+    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}${BN_BACKUPDIR}/testborg::"
 }
 
 @test "check config parameter dest/port" {
-    # absent parameter, defaults to 22
+    # absent parameter, port not specified
     setconfig dest user "$BN_REMOTEUSER"
     setconfig dest host "$BN_REMOTEHOST"
     delconfig dest port
     testaction
-    greplog "Debug: ssh\s\+ -o PasswordAuthentication=no ${BN_REMOTEHOST} -p 22 -l ${BN_REMOTEUSER} 'echo -n 1'"
-    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}:22${BN_BACKUPDIR}/testborg::"
+    greplog "Debug: ssh\s\+-o PasswordAuthentication=no ${BN_REMOTEHOST} -l ${BN_REMOTEUSER} 'echo -n 1'"
+    greplog 'Debug: executing borg create$' "\bssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}${BN_BACKUPDIR}/testborg::"
 
     # defined parameter
     setconfig dest port 7722
@@ -385,8 +384,8 @@ finish_borg() {
 
 @test "verify remote backup with encryption" {
     export BORG_PASSPHRASE="123foo"
-    run borg extract --dry-run "ssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}:22${BN_BACKUPDIR}/testborg::testarchive"
+    run borg extract --dry-run "ssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}${BN_BACKUPDIR}/testborg::testarchive"
     [ "$status" -eq 2 ]
     export BORG_PASSPHRASE="123test"
-    borg extract --dry-run "ssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}:22${BN_BACKUPDIR}/testborg::testarchive"
+    borg extract --dry-run "ssh://${BN_REMOTEUSER}@${BN_REMOTEHOST}${BN_BACKUPDIR}/testborg::testarchive"
 }