Nits and Bugfixes (#2)

Author: webdestroya

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: golangci-lint
+on:
+  # push:
+  #   branches:
+  #     - master
+  pull_request:
+    branches:
+      - main
+  # schedule:
+  #   # Trigger every day at 16:00 UTC
+  #   - cron:  '0 16 * * *'
+jobs:
+  golangci-pr:
+    if: github.ref != 'refs/heads/main'
+    name: lint-pr-changes
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.48.0
+          only-new-issues: true
+
+  # golangci-main:
+  #   if: github.ref == 'refs/heads/main'
+  #   name: lint-main-all
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/setup-go@v3
+  #     - uses: actions/checkout@v3
+  #     - name: golangci-lint
+  #       uses: golangci/golangci-lint-action@v3
+  #       with:
+  #         version: v1.48.0
+  #         only-new-issues: true
+  #         args: --issues-exit-code=0

.github/workflows/main.yml

@@ -11,22 +11,18 @@ on:
   pull_request:
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        go-version: ['1.19']
-
     steps:
 
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Set up Go ${{ matrix.go-version }}
+      - name: Set up Go 1.19
         uses: actions/setup-go@v3
         with:
-          go-version: ${{ matrix.go-version }}
+          go-version: 1.19
           cache: true
 
       - name: Display Go Version

Makefile

@@ -1,24 +1,49 @@
+AWS_ACCOUNTID=$$(aws sts get-caller-identity --query Account --output text)
+
+.PHONY: build
 build:
-	docker build --progress plain -t webdestroya/remote-shell:latest -f docker/Dockerfile .
+	docker build --progress plain -t ghcr.io/webdestroya/remote-shell:latest -f docker/Dockerfile .
 
+.PHONY: buildtest
 buildtest:
 	docker build -t shelltest:latest -f docker/Dockerfile.usage .
 
-runtest:
-	docker run --rm -p 8722:8722 --privileged cloud87/shelltest:latest /cloud87/bin/remote-shell -user webdestroya
-
-runversion:
-	docker run --rm shelltest:latest /cloud87/bin/remote-shell -version
-
-compile:
+.PHONY: clean
+clean:
 	rm -f remote-shell
-	go build -a -o remote-shell
 
-compile-version:
-	go build -ldflags="-X 'main.buildVersion=v1'" -a -o remote-shell
+.PHONY: compile
+compile: clean
+	go build -a -o remote-shell
 
-gomod:
+.PHONY: tidy
+tidy:
+	go mod verify
 	go mod tidy
+	@if ! git diff --quiet go.mod go.sum; then \
+		echo "please run go mod tidy and check in changes, you might have to use the same version of Go as the CI"; \
+		exit 1; \
+	fi
+
+# lint:
+# 	docker run --rm -v $$(pwd):/app -w /app golangci/golangci-lint:v1.49.0 golangci-lint run -v
 
+.PHONY: lint-install
+lint-install:
+	@echo "Installing golangci-lint"
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.46.2
+
+.PHONY: lint
 lint:
-	docker run --rm -v $$(pwd):/app -w /app golangci/golangci-lint:v1.49.0 golangci-lint run -v
+	@which golangci-lint >/dev/null 2>&1 || { \
+		echo "golangci-lint not found, please run: make lint-install"; \
+		exit 1; \
+	}
+	golangci-lint run
+
+# This is for easy testing
+.PHONY: pushtest
+pushtest: build buildtest
+	aws ecr get-login-password | docker login --username AWS --password-stdin $(AWS_ACCOUNTID).dkr.ecr.us-east-1.amazonaws.com
+	docker tag shelltest:latest $(AWS_ACCOUNTID).dkr.ecr.us-east-1.amazonaws.com/cloud87/remote-shell-test:latest
+	docker push $(AWS_ACCOUNTID).dkr.ecr.us-east-1.amazonaws.com/cloud87/remote-shell-test:latest

README.md

@@ -12,13 +12,13 @@ This will pull your public keys from GitHub and use those for SSH authentication
 ## Configuration
 | Flag  | Description | 
 | ------------- | ------------- |
-| `-user`  | The GitHub user to pull keys for<br>**Required** | 
-| `-port`  | The remote port for the SSH server<br>Default: `8722` |
-| `-shell`  | The shell command to execute.<br>Default: `/bin/bash` or `/bin/sh` |
-| `-idletime`  | If the connection is idle for more than X seconds, terminate the connection. Setting to `0` disables.<br>Default: `0` (disabled) |
-| `-maxtime`  | Maximum duration of a session.<br>Default: `12h` |
-| `-grace`  | How long to wait for a connection before we just terminate.<br>Default: `30m` |
-| `-insecure` | If you do not have CA Certificates installed, you can bypass SSL verification.<br>Not Recommended in production<br>Default: `false`
+| `user`  | The GitHub user to pull keys for<br>**Required** | 
+| `port`  | The remote port for the SSH server<br>Default: `8722` |
+| `shell`  | The shell command to execute.<br>Default: `/bin/bash` or `/bin/sh` |
+| `idletime`  | If the connection is idle for more than X seconds, terminate the connection. Setting to `0` disables.<br>Default: `0` (disabled) |
+| `maxtime`  | Maximum duration of a session.<br>Default: `12h` |
+| `grace`  | How long to wait for a connection before we just terminate.<br>Default: `30m` |
+| `insecure` | If you do not have CA Certificates installed, you can bypass SSL verification.<br>Not Recommended in production<br>Default: `false`
 
 > Note: Any of the arguments can be provided using environment variables by prefixing the flag with `C87RS_` (i.e. `C87RS_PORT`)
 
@@ -46,7 +46,7 @@ This image contains a binary that was built on Alpine Linux. If you are using an
 
 In your `Dockerfile`:
 
-```docker
+```dockerfile
 FROM anything
 # ... 
 
@@ -57,12 +57,12 @@ COPY --from=ghrc.io/webdestroya/remote-shell:latest /cloud87 /cloud87
 Then you can launch the container:
 
 ```
-$ docker run --rm -p 8722:8722 myapp:latest /cloud87/bin/remote-shell -user your-github-username
+$ docker run -p 8722:8722 myapp:latest /cloud87/bin/remote-shell -user your-github-username
 ```
 
 And connect to it on your client:
 
-```
+```sh
 ssh -p 8722 \
   -o StrictHostKeyChecking=no \
   -o "UserKnownHostsFile=/dev/null" \

docker/Dockerfile.usage

@@ -1,17 +1,12 @@
 FROM ubuntu
 
-
 # You don't need to install all this, it's just helpful for debugging
 RUN apt-get update \
   && apt-get install -y --no-install-recommends \
-    curl \
     ca-certificates \
-    vim \
     strace \
     \
   && rm -rf /var/lib/apt/lists/*
 
-COPY --from=cloud87/remote-shell:latest /cloud87 /cloud87
-COPY --from=cloud87/remote-shell:latest /cloud87-alpine /cloud87-alpine
-
+COPY --from=ghcr.io/webdestroya/remote-shell:latest /cloud87 /cloud87
 

options.go

@@ -6,7 +6,6 @@ import (
 	"log"
 	"os"
 	"os/exec"
-	"os/user"
 	"path/filepath"
 	"time"
 )
@@ -27,7 +26,7 @@ type RemoteShellOptions struct {
 	// TODO: should we allow multiple sessions?
 	allowMultipleSessions bool
 
-	currentUser *user.User
+	currentUserName string
 }
 
 func determineDefaultShell() string {
@@ -106,8 +105,7 @@ func parseCommandFlags() RemoteShellOptions {
 	shellCommand, err := exec.LookPath(shellCommandFlag)
 	check(err)
 
-	curUser, err := user.Current()
-	check(err)
+	curUserName := fetchEnvValue("USER", fetchEnvValue("LOGNAME", "root"))
 
 	return RemoteShellOptions{
 		username:              usernameFlag,
@@ -119,6 +117,6 @@ func parseCommandFlags() RemoteShellOptions {
 		connectionGrace:       graceFlag,
 		insecureMode:          insecureModeFlag,
 		allowMultipleSessions: false,
-		currentUser:           curUser,
+		currentUserName:       curUserName,
 	}
 }

ssh.go

@@ -55,8 +55,8 @@ func sessionHandler(options *RemoteShellOptions, notify chan bool, s ssh.Session
 		cmd.Env = append(filteredEnvironmentVars(),
 			fmt.Sprintf("TERM=%s", ptyReq.Term),
 			fmt.Sprintf("HOME=%s", options.homeDir),
-			fmt.Sprintf("USER=%s", options.currentUser.Username),
-			fmt.Sprintf("LOGNAME=%s", options.currentUser.Username),
+			fmt.Sprintf("USER=%s", options.currentUserName),
+			fmt.Sprintf("LOGNAME=%s", options.currentUserName),
 			fmt.Sprintf("SHELL=%s", options.shellCommand),
 			fmt.Sprintf("C87RS_SESSIONID=%s", s.Context().SessionID()),
 		)