initial release

Connects to #1
Change-Type: major

.editorconfig

@@ -0,0 +1,12 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,29 @@
+## Go
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+# Folders
+_obj
+_test
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+_testmain.go
+*.exe
+*.test
+*.prof
+# Output of the go coverage tool
+*.out
+# external packages folder
+vendor/
+
+## Builds
+bin/*
+build/*
+release/*

LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

Makefile

@@ -0,0 +1,48 @@
+PKG := resin
+VERSION := $(shell git describe --abbrev=0 --tags --dirty)
+EXECUTABLE := sshproxy
+
+all: bin/$(EXECUTABLE)
+
+bin/$(EXECUTABLE):
+	go build -o "$@" ./$(PKG)
+
+release: release/$(EXECUTABLE)-$(VERSION)_linux_arm5.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_linux_arm7.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_darwin_386.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_linux_386.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_darwin_amd64.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_freebsd_amd64.tar.bz2 \
+ release/$(EXECUTABLE)-$(VERSION)_linux_amd64.tar.bz2
+
+release-sign: release
+	for f in release/*.tar.bz2; do gpg --armor --detach-sign $$f; done
+
+clean:
+	rm -vrf bin/* build/* release/*
+
+# arm
+build/linux_arm5/$(EXECUTABLE):
+	GOARM=5 GOARCH=arm GOOS=linux go build -o "$@" ./$(PKG)
+build/linux_arm7/$(EXECUTABLE):
+	GOARM=7 GOARCH=arm GOOS=linux go build -o "$@" ./$(PKG)
+
+# 386
+build/darwin_386/$(EXECUTABLE):
+	GOARCH=386 GOOS=darwin go build -o "$@" ./$(PKG)
+build/linux_386/$(EXECUTABLE):
+	GOARCH=386 GOOS=linux go build -o "$@" ./$(PKG)
+
+# amd64
+build/darwin_amd64/$(EXECUTABLE):
+	GOARCH=amd64 GOOS=darwin go build -o "$@" ./$(PKG)
+build/freebsd_amd64/$(EXECUTABLE):
+	GOARCH=amd64 GOOS=freebsd go build -o "$@" ./$(PKG)
+build/linux_amd64/$(EXECUTABLE):
+	GOARCH=amd64 GOOS=linux go build -o "$@" ./$(PKG)
+
+# compressed artifacts
+release/$(EXECUTABLE)-$(VERSION)_%.tar.bz2: build/%/$(EXECUTABLE)
+	tar -jcvf "$@" -C "`dirname $<`" $(EXECUTABLE)
+
+.PHONY: clean release-sign

README.md

@@ -0,0 +1,9 @@
+# sshproxy
+
+[![GoDoc](https://godoc.org/github.com/resin-io/sshproxy?status.svg)](https://godoc.org/github.com/resin-io/sshproxy)
+[![Go Report Card](https://goreportcard.com/badge/github.com/resin-io/sshproxy)](https://goreportcard.com/report/github.com/resin-io/sshproxy)
+
+sshproxy is a simple ssh server library exposing an even simpler API.
+Authentication is handled by providing a ServerConfig, allowing full customisation.
+After authentication control is handed to the specified shell executable, with a PTY
+if requested by the connecting client.

resin/README.md

@@ -0,0 +1,60 @@
+# sshproxy/resin
+
+A "resin-ready" binary, requiring minimal configuration.
+
+Configuration is possible via commandline flags, environment variables
+and config files.
+
+Config files should be named `sshproxy.<ext>` and exist in the sshproxy
+work dir. The following config file formats are supported:
+
+* [YAML](http://yaml.org) (`sshproxy.yml`)
+* [JSON](http://www.json.org) (`sshproxy.json`)
+* [TOML](https://github.com/toml-lang/toml) (`sshproxy.toml`)
+* [HCL](https://github.com/hashicorp/hcl) (`sshproxy.hcl`)
+* [Java .properties](https://en.wikipedia.org/wiki/.properties) (`sshproxy.properties`)
+
+There are a total of 6 configuration options. With the exception of `dir`
+they can all be set via commandline, environment or config file.
+
+| Name     | Commandline      | Environment        | Config    |
+|----------|------------------|--------------------|-----------|
+| API Host | `--apihost` `-H` | `RESIN_API_HOST`   | `apihost` |
+| API Port | `--apiport` `-P` | `RESIN_API_PORT`   | `apiport` |
+| API Key  | `--apikey` `-K`  | `SSHPROXY_API_KEY` | `apikey`  |
+| Dir      | `--dir` `-d`     | `SSHPROXY_DIR`     |           |
+| Port     | `--port` `-p`    | `SSHPROXY_PORT`    | `port`    |
+| Shell    | `--shell` `-s`   | `SSHPROXY_SHELL`   | `shell`   |
+
+```
+Usage of sshproxy:
+  -H, --apihost string   Resin API Host (default "api.resin.io")
+  -K, --apikey string    Resin API Key (required)
+  -P, --apiport string   Resin API Port (default "443")
+  -d, --dir string       Work dir, holds ssh keys and sshproxy config (default "/etc/sshproxy")
+  -p, --port int         Port the ssh service will listen on (default 22)
+  -s, --shell string     Path to shell to execute post-authentication (default "shell.sh")
+```
+
+## Example Usage
+
+```
+% go get github.com/resin-io/sshproxy/resin
+% export SSHPROXY_DIR=$(mktemp -d /tmp/sshproxy.XXXXXXXX)
+% echo -e '#!/usr/bin/env bash\nenv' > ${SSHPROXY_DIR}/shell.sh && chmod +x ${SSHPROXY_DIR}/shell.sh
+  SSHPROXY_PORT=2222 \
+  SSHPROXY_API_KEY=... \
+  go run ${GOPATH}/src/github.com/resin-io/sshproxy/resin/main.go
+...
+% ssh -o 'StrictHostKeyChecking=no' \
+      -o 'UserKnownHostsFile=/dev/null' \
+    resin@localhost -p2222 -- some command
+Warning: Permanently added '[localhost]:2222' (RSA) to the list of known hosts.
+SSH_USER=resin
+PWD=...
+LANG=en_GB.UTF-8
+SHLVL=1
+SSH_ORIGINAL_COMMAND=some command
+LC_CTYPE=en_GB.UTF-8
+_=/usr/bin/env
+```