Maintenance - go1.19 and deps

Author: rupor-github

CMakeLists.txt

@@ -37,7 +37,7 @@ endif()
 set(DEST_DIR "${PROJECT_SOURCE_DIR}/bin")
 message(STATUS "Installation directory: ${DEST_DIR}")
 
-set(GO_MIN_REQURED_VERSION 1.17)
+set(GO_MIN_REQURED_VERSION 1.19)
 find_package(Go ${GO_MIN_REQURED_VERSION} REQUIRED)
 find_package(Git REQUIRED)
 
@@ -60,7 +60,7 @@ endif()
 # Project version number
 set(PRJ_VERSION_Major "1")
 set(PRJ_VERSION_Minor "6")
-set(PRJ_VERSION_Patch "1")
+set(PRJ_VERSION_Patch "2")
 
 if (EXISTS "${PROJECT_SOURCE_DIR}/.git" AND IS_DIRECTORY "${PROJECT_SOURCE_DIR}/.git")
     execute_process(COMMAND ${CMAKE_SOURCE_DIR}/cmake/githash.sh ${GIT_EXECUTABLE}

README.md

@@ -141,18 +141,14 @@ Options:
 
 ## WSL 2 compatibility
 
-At the moment AF_UNIX interop does not seems to be working with WSL2 VMs. Hopefully this will be sorted out eventually. Meantime there is an easy workaround (proposed by multiple people) which does not use wsl-ssh-agent.exe at all and relies on combination of linux socat tool from your distribution and [npiperelay.exe](https://github.com/jstarks/npiperelay). Put npiperelay.exe somewhere on devfs for interop to work its magic (I have `winhome ⇒ /mnt/c/Users/rupor` in my $HOME directory for that) and add following lines in your .bashrc/.zshrc:
+At the moment AF_UNIX interop does not seems to be working with WSL2 VMs. Hopefully this will be sorted out eventually. Meantime there is an easy workaround (proposed by multiple people) which does not use wsl-ssh-agent.exe at all and relies on combination of linux socat tool from your distribution and [npiperelay.exe](https://github.com/jstarks/npiperelay). For example put `npiperelay.exe` on devfs for interop to work its magic (I have `winhome ⇒ /mnt/c/Users/rupor`, copy [wsl-ssh-agent-relay](docs/wsl-ssh-agent-relay) into your `~/.local/bin directory`, and add following 2 lines to your .bashrc/.zshrc file:
 
 ```bash
-export SSH_AUTH_SOCK=$HOME/.ssh/agent.sock
-ss -a | grep -q $SSH_AUTH_SOCK
-if [ $? -ne 0   ]; then
-    rm -f $SSH_AUTH_SOCK
-    ( setsid socat UNIX-LISTEN:$SSH_AUTH_SOCK,fork EXEC:"$HOME/winhome/.wsl/npiperelay.exe -ei -s //./pipe/openssh-ssh-agent",nofork & ) >/dev/null 2>&1
-fi
+${HOME}/.local/bin/wsl-ssh-agent-relay start
+export SSH_AUTH_SOCK=${HOME}/.ssh/wsl-ssh-agent.sock
 ```
 
-You *really* have to be on WSL 2 in order for this to work - if you see errors like `Cannot open netlink socket: Protocol not supported` - you probably are under WSL 1 and should not use this workaround. Run `wsl.exe -l --all -v` to check what is going on. When on WSL 2 make sure that socat is installed and npiperelay.exe is on windows partition and path is right. For convinience I will be packing pre-build npiperelay.exe with wsl-ssh-agent. Please also ensure that `socat` is installed: `sudo apt install socat`.
+You *really* have to be on WSL 2 in order for this to work - if you see errors like `Cannot open netlink socket: Protocol not supported` - you probably are under WSL 1 and should not use this workaround. Run `wsl.exe -l --all -v` to check what is going on. When on WSL 2 make sure that socat is installed and npiperelay.exe is on windows partition and path is right. For convenience I will be packing pre-build npiperelay.exe with wsl-ssh-agent. Please also ensure that `socat` is installed: `sudo apt install socat`.
 
 ## Example
 

docs/wsl-ssh-agent-relay

@@ -0,0 +1,163 @@
+#!/bin/bash
+
+#### Add following lines to your shell rc file (.zshrc .bashrc)
+# ${HOME}/.local/bin/wsl-ssh-agent-relay start
+# export SSH_AUTH_SOCK=${HOME}/.ssh/wsl-ssh-agent.sock
+
+# For debugging startup problems uncomment next line
+# exec 2> >(tee -a -i "$HOME/error.log")
+
+#### Assuming ~/winhome links to %USERPROFILE on Windows side
+RELAY_BIN="${HOME}/winhome/.wsl/npiperelay.exe"
+
+PIDFILE="${HOME}/.ssh/wsl-ssh-agent-relay.pid"
+WSL_AGENT_SSH_SOCK="${HOME}/.ssh/wsl-ssh-agent.sock"
+
+log() {
+    echo >&2 "$@"
+}
+
+is_pid_running() {
+    if [[ -z "$1" ]]; then
+        return 1
+    fi
+    ps -p "$1" >/dev/null
+    return $?
+}
+
+_cleanup() {
+    log "Cleaning up relay to ${WSL_AGENT_SSH_SOCK}..."
+    if is_pid_running "${SOCAT_WSL_AGENT_SSH_PID}"; then
+        kill -SIGTERM "${SOCAT_WSL_AGENT_SSH_PID}" || log "Failed."
+    fi
+}
+
+die() {
+    if [[ -n "$1" ]]; then
+        log "$1"
+    fi
+    log "Exiting."
+    exit 1
+}
+
+usage() {
+    log "Usage: wsl-ssh-agent-relay [OPTIONS] COMMAND"
+    log ""
+    log "  SUMMARY: Relay Windows openssh named pipe to local SSH socket in order to integrate WSL2 and host."
+    log "           To debug use foreground command"
+    log ""
+    log "  OPTIONS:"
+    log "    -h|--help     this page"
+    log ""
+    log "    -v|--verbose  verbose mode"
+    log ""
+    log "  COMMAND: start, stop, foreground"
+}
+
+fg_opts() {
+    FG_OPTS=()
+    # Generate opts for passing it to foreground version
+    if [[ -n "$VERBOSE" ]]; then
+        FG_OPTS+=("-v")
+    fi
+}
+
+main() {
+
+    POSITIONAL=()
+    VERBOSE=""
+    while (($# > 0)); do
+        case "$1" in
+        -v | --verbose)
+            VERBOSE="ENABLED"
+            shift # shift once since flags have no values
+            ;;
+
+        -h | --help)
+            usage
+            exit 0
+            ;;
+
+        *) # unknown flag/switch
+            POSITIONAL+=("$1")
+            shift
+            if [[ "${#POSITIONAL[@]}" -gt 1 ]]; then
+                usage
+                die
+            fi
+            ;;
+        esac
+    done
+
+    set -- "${POSITIONAL[@]}" # restore positional params
+
+    if [[ -z "$VERBOSE" ]]; then
+        QUIET="QUIET"
+    fi
+
+    case "${POSITIONAL[0]}" in
+    start)
+        fg_opts
+        start-stop-daemon --start --oknodo --pidfile "${PIDFILE}" --name wsl-ssh-agent-r --make-pidfile --background --startas "$0" ${VERBOSE:+--verbose} ${QUIET:+--quiet} -- foreground "${FG_OPTS[@]}"
+        ;;
+
+    stop)
+        start-stop-daemon --pidfile "${PIDFILE}" --stop --remove-pidfile ${VERBOSE:+--verbose} ${QUIET:+--quiet}
+        ;;
+
+    status)
+        start-stop-daemon --pidfile "${PIDFILE}" --status ${VERBOSE:+--verbose} ${QUIET:+--quiet}
+        local result=$?
+        case $result in
+        0) log "$0 is running" ;;
+        1 | 3) log "$0 is not running" ;;
+        4) log "$0 unable to determine status" ;;
+        esac
+        return $result
+        ;;
+
+    foreground)
+        relay
+        ;;
+
+    *)
+        usage
+        die
+        ;;
+    esac
+}
+
+relay() {
+
+    trap _cleanup EXIT
+
+    [[ -f "${RELAY_BIN}" ]] || die "Unable to access ${RELAY_BIN}"
+
+    if pgrep -fx "^ssh-agent\s.+" >/dev/null; then
+        log "Killing previously started local ssh-agent..."
+        SSH_AGENT_PID="$(pidof ssh-agent)" ssh-agent -k >/dev/null 2>&1
+    fi
+
+    if [ -e "${WSL_AGENT_SSH_SOCK}" ]; then
+        log "WSL has been shutdown ungracefully, leaving garbage behind"
+        rm "${WSL_AGENT_SSH_SOCK}"
+    fi
+
+    socat UNIX-LISTEN:"\"${WSL_AGENT_SSH_SOCK}\"",fork EXEC:"\"\'${RELAY_BIN}\' -ei -s \'//./pipe/openssh-ssh-agent\'\"",nofork 1>/dev/null 2>&1 &
+    SOCAT_WSL_AGENT_SSH_PID="$!"
+    if ! is_pid_running "${SOCAT_WSL_AGENT_SSH_PID}"; then
+        log "Relay for ${SOCAT_WSL_AGENT_SSH_PID} failed"
+        return 1
+    fi
+    log "Relay is running with PID: ${SOCAT_WSL_AGENT_SSH_PID}"
+
+    log -n "Polling remote ssh-agent..."
+    SSH_AUTH_SOCK="${WSL_AGENT_SSH_SOCK}" ssh-add -L >/dev/null 2>&1 || die "[$?] Failure communicating with ssh-agent"
+    log "OK"
+
+    # Everything checks, we are ready for actions
+    log "Entering wait..."
+    wait ${SOCAT_WSL_AGENT_SSH_PID}
+}
+
+main "$@"

go.mod

@@ -1,13 +1,13 @@
 module github.com/rupor-github/wsl-ssh-agent
 
-go 1.17
+go 1.19
 
 require (
 	github.com/Microsoft/go-winio v0.5.2
 	github.com/allan-simon/go-singleinstance v0.0.0-20210120080615-d0997106ab37
-	github.com/rupor-github/gclpr v1.2.1
-	golang.org/x/sys v0.0.0-20220422013727-9388b58f7150
-	honnef.co/go/tools v0.3.0
+	github.com/rupor-github/gclpr v1.2.2
+	golang.org/x/sys v0.0.0-20220818161305-2296e01440c6
+	honnef.co/go/tools v0.3.3
 )
 
 require (
@@ -16,7 +16,6 @@ require (
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 // indirect
 	golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 // indirect
 	golang.org/x/exp/typeparams v0.0.0-20220218215828-6cf2b201936e // indirect
-	golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3 // indirect
-	golang.org/x/tools v0.1.11-0.20220316014157-77aa08bb151a // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
+	golang.org/x/tools v0.1.11-0.20220513221640-090b14e8501f // indirect
 )

go.sum

@@ -8,8 +8,8 @@ github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rupor-github/gclpr v1.2.1 h1:LaByitXVainoz4Ezm0uHwQv7KGB5ZookyyItX+8XcrU=
-github.com/rupor-github/gclpr v1.2.1/go.mod h1:PyhH4EaDiGk8gkTOqzlFzidhqCgb4WAMVoRRU7Gbn38=
+github.com/rupor-github/gclpr v1.2.2 h1:oAm6iaky59y29D6gysBDkTdGjLkg+hnTUILzCyA9g4E=
+github.com/rupor-github/gclpr v1.2.2/go.mod h1:PyhH4EaDiGk8gkTOqzlFzidhqCgb4WAMVoRRU7Gbn38=
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 h1:JIAuq3EEf9cgbU6AtGPK4CTG3Zf6CKMNqf0MHTggAUA=
 github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966/go.mod h1:sUM3LWHvSMaG192sy56D9F7CNvL7jUJVXoqM1QKLnog=
@@ -18,15 +18,13 @@ golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 h1:kUhD7nTDoI3fVd9G4ORWrb
 golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp/typeparams v0.0.0-20220218215828-6cf2b201936e h1:qyrTQ++p1afMkO4DPEeLGq/3oTsdlvdH4vqZUBWzUKM=
 golang.org/x/exp/typeparams v0.0.0-20220218215828-6cf2b201936e/go.mod h1:AbB0pIl9nAr9wVwH+Z2ZpaocVmF5I4GyWCDIsVjR0bk=
-golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3 h1:kQgndtyPBW/JIYERgdxfwMYh3AVStj88WQTlNDi2a+o=
-golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 h1:6zppjxzCulZykYSLyVDYbneBfbaBIQPYMevg0bEwv2s=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20220422013727-9388b58f7150 h1:xHms4gcpe1YE7A3yIllJXP16CMAGuqwO2lX1mTyyRRc=
-golang.org/x/sys v0.0.0-20220422013727-9388b58f7150/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/tools v0.1.11-0.20220316014157-77aa08bb151a h1:ofrrl6c6NG5/IOSx/R1cyiQxxjqlur0h/TvbUhkH0II=
-golang.org/x/tools v0.1.11-0.20220316014157-77aa08bb151a/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-honnef.co/go/tools v0.3.0 h1:2LdYUZ7CIxnYgskbUZfY7FPggmqnh6shBqfWa8Tn3XU=
-honnef.co/go/tools v0.3.0/go.mod h1:vlRD9XErLMGT+mDuofSr0mMMquscM/1nQqtRSsh6m70=
+golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 h1:Sx/u41w+OwrInGdEckYmEuU5gHoGSL4QbDz3S9s6j4U=
+golang.org/x/sys v0.0.0-20220818161305-2296e01440c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/tools v0.1.11-0.20220513221640-090b14e8501f h1:OKYpQQVE3DKSc3r3zHVzq46vq5YH7x8xpR3/k9ixmUg=
+golang.org/x/tools v0.1.11-0.20220513221640-090b14e8501f/go.mod h1:SgwaegtQh8clINPpECJMqnxLv9I09HLqnW3RMqW0CA4=
+honnef.co/go/tools v0.3.3 h1:oDx7VAwstgpYpb3wv0oxiZlxY+foCpRAwY7Vk6XpAgA=
+honnef.co/go/tools v0.3.3/go.mod h1:jzwdWgg7Jdq75wlfblQxO4neNaFFSvgc1tD5Wv8U0Yw=