Moving to go1.17.9

Updating all dependencies
Using up to date gclpr backend
Linting

Author: rupor-github

.gitignore

@@ -8,16 +8,15 @@
 *.prof
 *.mprof
 *.log
-*.syso
 *.7z
-*.zip
-*.minisig
+*.syso
 
-release/
 build/
-bin/
 
 # build specific
 misc/version.go
-resources.rc
-manifest.xml
+cmd/*/resources.rc
+cmd/*/manifest.xml
+wsl-ssh-agent.zip
+wsl-ssh-agent.zip.minisig
+wsl-ssh-agent.json

CMakeLists.txt

@@ -37,7 +37,8 @@ endif()
 set(DEST_DIR "${PROJECT_SOURCE_DIR}/bin")
 message(STATUS "Installation directory: ${DEST_DIR}")
 
-find_package(Go 1.15 REQUIRED)
+set(GO_MIN_REQURED_VERSION 1.17)
+find_package(Go ${GO_MIN_REQURED_VERSION} REQUIRED)
 find_package(Git REQUIRED)
 
 # Make sure we setup go properly
@@ -58,8 +59,8 @@ endif()
 
 # Project version number
 set(PRJ_VERSION_Major "1")
-set(PRJ_VERSION_Minor "5")
-set(PRJ_VERSION_Patch "2")
+set(PRJ_VERSION_Minor "6")
+set(PRJ_VERSION_Patch "0")
 
 if (EXISTS "${PROJECT_SOURCE_DIR}/.git" AND IS_DIRECTORY "${PROJECT_SOURCE_DIR}/.git")
     execute_process(COMMAND ${CMAKE_SOURCE_DIR}/cmake/githash.sh ${GIT_EXECUTABLE}
@@ -74,12 +75,15 @@ else()
     set(GIT_HASH "no-git")
 endif()
 configure_file("${PROJECT_SOURCE_DIR}/cmake/version.go.in" "${PROJECT_SOURCE_DIR}/misc/version.go")
-configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.rc.in" "${PROJECT_SOURCE_DIR}/resources.rc")
-configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.xml.in" "${PROJECT_SOURCE_DIR}/manifest.xml")
+configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.rc.in" "${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc")
+configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.xml.in" "${PROJECT_SOURCE_DIR}/cmd/agent/manifest.xml")
+configure_file("${PROJECT_SOURCE_DIR}/cmake/wsl-ssh-agent.json.in" "${PROJECT_SOURCE_DIR}/wsl-ssh-agent.json")
+
+# for user convinience
+execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/../../jstarks/npiperelay/npiperelay.exe ${PROJECT_BINARY_DIR})
 
 # distribute history
 execute_process(COMMAND ${CMAKE_COMMAND} -E env ${GIT_EXECUTABLE} changelog --all --tag "v${PRJ_VERSION_Major}.${PRJ_VERSION_Minor}.${PRJ_VERSION_Patch}" --stdout OUTPUT_FILE ${PROJECT_BINARY_DIR}/changelog.txt ERROR_QUIET)
-install(FILES ${PROJECT_BINARY_DIR}/changelog.txt DESTINATION ${DEST_DIR} CONFIGURATIONS Release)
 
 message(STATUS "Building version \"${PRJ_VERSION_Major}.${PRJ_VERSION_Minor}.${PRJ_VERSION_Patch}\" git \"${GIT_HASH}\"")
 
@@ -94,33 +98,55 @@ endif()
 # Some contexts dependent settings
 ########################################################################################################
 
+list(APPEND GO_ENV
+    GOPATH=${GO_PATH}
+    GOOS=${CROSS_GOOS}
+    GOARCH=${CROSS_GOARCH}
+    )
+
 if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-    set(TEST_RUN_ARGS "-v")
+    set(GO_ARGS "-mod=mod")
 else()
-    set(GO_MOD_ARGS "-mod=vendor")
+    set(GO_ARGS "-mod=vendor")
 endif()
 
 ########################################################################################################
 # main target - always out of date, "go build" will figure it out
 ########################################################################################################
 
+add_custom_target(release
+    DEPENDS ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip
+        ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.json
+    COMMAND ${CMAKE_SOURCE_DIR}/cmake/sign.sh
+    COMMENT "Building release..."
+    WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
+
+add_custom_command(OUTPUT ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip
+    DEPENDS ${PROJECT_BINARY_DIR}/changelog.txt
+        ${PROJECT_BINARY_DIR}/npiperelay${CMAKE_EXECUTABLE_SUFFIX}
+        ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    COMMAND ${CMAKE_COMMAND} -E tar "cfv" ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip --format=zip
+        changelog.txt npiperelay${CMAKE_EXECUTABLE_SUFFIX} wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    COMMENT "Archiving release..."
+    WORKING_DIRECTORY "${PROJECT_BINARY_DIR}")
+
 add_custom_target(bin_agent ALL
-    DEPENDS ${PROJECT_SOURCE_DIR}/resources.syso
-    COMMAND GOPATH=${GO_PATH} GO111MODULE=on GOOS=${CROSS_GOOS} GOARCH=${CROSS_GOARCH}
-        ${GO_EXECUTABLE} build -trimpath -o ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    DEPENDS ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
+    BYPRODUCTS ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    COMMAND ${GO_ENV} ${GO_EXECUTABLE} build -trimpath -o ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
         -ldflags='-H=windowsgui'
-        ${GO_MOD_ARGS}
+        ${GO_ARGS}
+        ./cmd/agent
     COMMENT "Building wsl-ssh-agent-gui..."
     WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
-install(PROGRAMS ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX} DESTINATION ${DEST_DIR} CONFIGURATIONS Release)
 
-add_custom_command(OUTPUT ${PROJECT_SOURCE_DIR}/resources.syso
-     DEPENDS ${PROJECT_SOURCE_DIR}/resources.rc
-         ${PROJECT_SOURCE_DIR}/manifest.xml
-         ${PROJECT_SOURCE_DIR}/icon.ico
+add_custom_command(OUTPUT ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
+     DEPENDS ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
+         ${PROJECT_SOURCE_DIR}/cmd/agent/manifest.xml
+         ${PROJECT_SOURCE_DIR}/cmd/agent/icon.ico
      COMMAND ${CMAKE_RC_COMPILER} -O coff
-         -o ${PROJECT_SOURCE_DIR}/resources.syso
-         -i ${PROJECT_SOURCE_DIR}/resources.rc
+         -o ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
+         -i ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
      WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
      COMMENT "Building wsl-ssh-agent-gui resources...")
 
@@ -134,32 +160,16 @@ if(CMAKE_BUILD_TYPE STREQUAL "Debug")
     # Go linter
     ########################################################################################################
 
-
-    # Running linters on main target
-    find_program(GO_LINTER golangci-lint PATHS ${PROJECT_BINARY_DIR} NO_DEFAULT_PATH)
-    if(NOT GO_LINTER)
-        set(golangci-lint-ver "1.33.0")
-        message(STATUS "Preparing golangci-lint ${golangci-lint-ver}")
-        file(DOWNLOAD "https://github.com/golangci/golangci-lint/releases/download/v${golangci-lint-ver}/golangci-lint-${golangci-lint-ver}-linux-amd64.tar.gz" ${PROJECT_BINARY_DIR}/golangci-lint.tar.gz
-            INACTIVITY_TIMEOUT 60
-            TIMEOUT 300
-            STATUS DOWNLOAD_RES
-            EXPECTED_HASH SHA256=e2d6082f1df53c5d2c280765000f9e82783ea909ba419c6c4e172936b076031e)
-        list(GET DOWNLOAD_RES 0 RES)
-        list(GET DOWNLOAD_RES 1 MSG)
-        if(RES)
-            message(FATAL_ERROR "${MSG} : ${RES}")
-        endif()
-        execute_process(COMMAND ${CMAKE_COMMAND} -E tar xf golangci-lint.tar.gz WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-        execute_process(COMMAND ${CMAKE_COMMAND} -E copy golangci-lint-${golangci-lint-ver}-linux-amd64/golangci-lint golangci-lint WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-        execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory golangci-lint-${golangci-lint-ver}-linux-amd64 WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-        execute_process(COMMAND ${CMAKE_COMMAND} -E remove golangci-lint.tar.gz WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
-        set(GO_LINTER ${PROJECT_BINARY_DIR}/golangci-lint)
-    endif()
+    add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/staticcheck
+        COMMAND GOPATH=${GO_PATH} GOOS= GOARCH= ${GO_EXECUTABLE} build ${GO_MOD_ARGS} -o ${PROJECT_BINARY_DIR}/staticcheck
+            honnef.co/go/tools/cmd/staticcheck
+        WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
+        COMMENT "Building staticcheck executable...")
 
     add_custom_target(lint
-        COMMAND GOPATH=${GO_PATH} GO111MODULE=on GOOS=${CROSS_GOOS} GOARCH=${CROSS_GOARCH} ${GO_LINTER} run
-        COMMENT "Mega-linting project with ${GO_LINTER}..."
+        DEPENDS ${PROJECT_BINARY_DIR}/staticcheck
+        COMMAND ${PROJECT_BINARY_DIR}/staticcheck -f stylish -tests=false ./...
+        COMMENT "Linting project..."
         WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
 
     ########################################################################################################
@@ -168,14 +178,21 @@ if(CMAKE_BUILD_TYPE STREQUAL "Debug")
 
     add_custom_target(deps_tidy
         SOURCES ${PROJECT_SOURCE_DIR}/go.mod
-        COMMAND GOPATH=${GO_PATH} GO111MODULE=on GOOS=${CROSS_GOOS} GOARCH=${CROSS_GOARCH} ${GO_EXECUTABLE} mod tidy
+        COMMAND ${GO_ENV} ${GO_EXECUTABLE} mod tidy -compat=${GO_MIN_REQURED_VERSION}
         WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
         COMMENT "Cleaning dependencies (go mod tidy)"
         VERBATIM)
 
+    add_custom_target(deps_download
+        SOURCES ${PROJECT_SOURCE_DIR}/go.mod
+        COMMAND ${GO_ENV} ${GO_EXECUTABLE} mod download all
+        WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
+        COMMENT "Downloading dependencies (go mod download)"
+        VERBATIM)
+
     add_custom_target(deps_vendor
         SOURCES ${PROJECT_SOURCE_DIR}/go.mod
-        COMMAND GOPATH=${GO_PATH} GO111MODULE=on GOOS=${CROSS_GOOS} GOARCH=${CROSS_GOARCH} ${GO_EXECUTABLE} mod vendor
+        COMMAND ${GO_ENV} ${GO_EXECUTABLE} mod vendor
         WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
         COMMENT "Creating vendor directory (go mod vendor)"
         VERBATIM)

README.md

@@ -10,18 +10,19 @@
     <hr>
 </p>
 
-Windows 10 has very convenient `ssh-agent` service (with support for persistence and Windows security). Unfortunately it is not accessible from WSL. This project aims to correct this situation by enabling access to SSH keys held by Windows own `ssh-agent` service from inside the [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about).
+Windows has very convenient `ssh-agent` service (with support for persistence and Windows security). Unfortunately it is not accessible from WSL. This project aims to correct this situation by enabling access to SSH keys held by Windows own `ssh-agent` service from inside the [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about).
 
 My first attempt - [ssh-agent-wsl](https://github.com/rupor-github/ssh-agent-wsl) was successful, but due to Windows interop restrictions it required elaborate life-time management on the WSL side. Starting with build 17063 (which was many updates ago) Windows implemented AF_UNIX sockets. This makes it possible to remove all trickery from WSL side greatly simplifying everything. 
 
 **NOTE:** If you need access to more functionality (smard cards, identity management) provided by [GnuPG](https://www.gnupg.org/) set of tools on Windows or if you are looking for compatibility with wider set of utilities, like Git for Windows, Putty, Cygwin - you may want to take a look at [win-gpg-agent](https://github.com/rupor-github/win-gpg-agent) instead.
 
-`wsl-ssh-agent-gui.exe` is a simple "notification tray" applet which maintains AF_UNIX ssh-agent compatible socket on Windows end. It proxes all requests from this socket to ssh-agent.exe via named pipe. The only thing required on WSL end for it to work is to make sure that WSL `SSH_AGENT_SOCK` points to proper socket path. The same socket could be shared by any/all WSL sessions.
+`wsl-ssh-agent-gui.exe` is a simple "notification tray" applet which maintains AF_UNIX ssh-agent compatible socket on Windows end. It proxies all requests from this socket to ssh-agent.exe via named pipe. The only thing required on WSL end for it to work is to make sure that WSL `SSH_AGENT_SOCK` points to proper socket path. The same socket could be shared by any/all WSL sessions.
 
 As an additional bonus `wsl-ssh-agent-gui.exe` could work as remote clipboard server so you could send your clipboard from tmux or neovim remote session back to your windows box over SSH secured connection easily. 
 
 **NOTE: BREAKING CHANGE** Version 1.5.0 introduces breaking change. If you were not using `wsl-ssh-agent-gui.exe` as `lemonade` clipboard backend - this should not concern you at the slightest. Otherwise lemonade support no longer - it has been replaced with [gclpr](https://github.com/rupor-github/gclpr) which is more secure.
 
+**NOTE: BREAKING CHANGE** Version 1.6.0 introduces breaking change. If you were not using `wsl-ssh-agent-gui.exe` as `gclpr` clipboard backend - this should not concern you at the slightest. Otherwise starting with v1.1.0 gclpr server backend (included with v1.6.0) enforces protocol visioning and may require upgrade of gclpr tools.
 
 **SECURITY NOTICE:** All the usual security caveats applicable to WSL apply. Most importantly, all interaction with the Win32 world happens with the credentials of the user who started the WSL environment. In practice, *if you allow someone else to log in to your WSL environment remotely, they may be able to access the SSH keys stored in your ssh-agent.* This is a fundamental feature of WSL; if you are not sure of what you're doing, do not allow remote access to your WSL environment (i.e. by starting an SSH server).
 
@@ -31,11 +32,22 @@ starting with 1809 - beginning with insider build 17063 and would not work on ol
 
 ## Installation
 
-### From binaries
+```
+    scoop install https://github.com/rupor-github/wsl-ssh-agent/releases/latest/download/wsl-ssh-agent.json
+```
+and updating:
+```
+    scoop update wsl-ssh-agent
+```
+
+Alternatively download from the [releases page](https://github.com/rupor-github/wsl-ssh-agent/releases) and unpack it in a convenient location.
 
-Download from the [releases page](https://github.com/rupor-github/wsl-ssh-agent/releases) and unpack it in a convenient location.
+Starting with v1.5.1 releases are packed with zip and signed with [minisign](https://jedisct1.github.io/minisign/). Here is public key for verification:
 
-Starting with v1.5.1 releases are packed with zip and signed with [minisign](https://jedisct1.github.io/minisign/). Here is public key for verification: ![key](docs/build_key.png) RWTNh1aN8DrXq26YRmWO3bPBx4m8jBATGXt4Z96DF4OVSzdCBmoAU+Vq
+<p>
+    <img src="docs/build_key.svg" style="vertical-align:middle; width:15%" align="absmiddle"/>
+    <span style="vertical-align:middle;">&nbsp;&nbsp;RWTNh1aN8DrXq26YRmWO3bPBx4m8jBATGXt4Z96DF4OVSzdCBmoAU+Vq</span>
+</p>
 
 ## Usage
 

cmake/sign.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+gopass show -o build/minisign | minisign -S -s ${HOME}/.minisign/build.key -c "wsl-ssh-agent release signature" -m wsl-ssh-agent.zip
+sed -i "s/__CURRENT_HASH__/$(sha256sum -z wsl-ssh-agent.zip | awk '{ print $1; }')/g" wsl-ssh-agent.json

cmake/wsl-ssh-agent.json.in

@@ -0,0 +1,28 @@
+{
+    "version": "@PRJ_VERSION_Major@.@PRJ_VERSION_Minor@.@PRJ_VERSION_Patch@",
+    "description": "Simple set of tools to make working with SSH keys easier on Windows.",
+    "homepage": "https://github.com/rupor-github/wsl-ssh-agent",
+    "license": "GPL-3.0",
+    "architecture": {
+        "64bit": {
+            "url": "https://github.com/rupor-github/wsl-ssh-agent/releases/download/v@PRJ_VERSION_Major@.@PRJ_VERSION_Minor@.@PRJ_VERSION_Patch@/wsl-ssh-agent.zip",
+            "hash": "__CURRENT_HASH__"
+        }
+    },
+    "shortcuts": [
+        [
+            "wsl-ssh-agent-gui.exe",
+            "wsl-ssh-agent"
+        ]
+    ],
+    "checkver": {
+        "github": "https://github.com/rupor-github/wsl-ssh-agent"
+    },
+    "autoupdate": {
+        "architecture": {
+            "64bit": {
+                "url": "https://github.com/rupor-github/wsl-ssh-agent/releases/download/v$version/wsl-ssh-agent.zip"
+            }
+        }
+    }
+}

icon.ico cmd/agent/icon.icoicon.ico renamed to cmd/agent/icon.ico

@@ -20,6 +20,7 @@ import (
 	"github.com/Microsoft/go-winio"
 	si "github.com/allan-simon/go-singleinstance"
 	clip "github.com/rupor-github/gclpr/server"
+	cliputil "github.com/rupor-github/gclpr/util"
 	"golang.org/x/sys/windows"
 
 	"github.com/rupor-github/wsl-ssh-agent/misc"
@@ -259,8 +260,7 @@ func clipServe() error {
 		return err
 	}
 
-	var pkeys map[[32]byte]struct{}
-	pkeys, err = util.ReadTrustedKeys(home)
+	pkeys, err := cliputil.ReadTrustedKeys(home)
 	if err != nil {
 		if !os.IsNotExist(err) {
 			return err
@@ -272,7 +272,8 @@ func clipServe() error {
 		// we have possible clients for remote clipboard
 		clipHelp = fmt.Sprintf("gclpr is serving %d key(s) on port %d", len(pkeys), clipPort)
 		go func() {
-			if err := clip.Serve(clipCtx, clipPort, clipLE, pkeys); err != nil {
+			compatibleMagic := []byte{'g', 'c', 'l', 'p', 'r', 1, 1, 0}
+			if err := clip.Serve(clipCtx, clipPort, clipLE, pkeys, compatibleMagic); err != nil {
 				log.Printf("gclpr serve() returned error: %s", err.Error())
 				clipHelp = "gclpr is not served"
 			}

gui.go cmd/agent/main.gogui.go renamed to cmd/agent/main.go

@@ -1,10 +1,22 @@
 module github.com/rupor-github/wsl-ssh-agent
 
-go 1.13
+go 1.17
 
 require (
-	github.com/Microsoft/go-winio v0.4.14
-	github.com/allan-simon/go-singleinstance v0.0.0-20160830203053-79edcfdc2dfc
-	github.com/rupor-github/gclpr v1.0.5
-	golang.org/x/sys v0.0.0-20191026070338-33540a1f6037
+	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.0
+	golang.org/x/sys v0.0.0-20220422013727-9388b58f7150
+	honnef.co/go/tools v0.3.0
+)
+
+require (
+	github.com/BurntSushi/toml v0.4.1 // indirect
+	github.com/atotto/clipboard v0.1.4 // indirect
+	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
 )