First draft for the v2 API

ContainerSSH · Apr 15, 2021 · 1765db2 · 1765db2
1 parent 7781d4d
commit 1765db2
Show file tree

Hide file tree

Showing 70 changed files with 159 additions and 159 deletions.
diff --git a/AbstractHandler.go b/AbstractHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/AbstractNetworkConnectionHandler.go b/AbstractNetworkConnectionHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"
@@ -11,15 +11,15 @@ type AbstractNetworkConnectionHandler struct {
 
 // OnAuthPassword is called when a user attempts a password authentication. The implementation must always supply
 //                AuthResponse and may supply error as a reason description.
-func (a *AbstractNetworkConnectionHandler) OnAuthPassword(_ string, _ []byte) (response AuthResponse, reason error) {
-	return AuthResponseUnavailable, nil
+func (a *AbstractNetworkConnectionHandler) OnAuthPassword(_ string, _ []byte, _ string) (response AuthResponse, metadata map[string]string, reason error) {
+	return AuthResponseUnavailable, nil, nil
 }
 
 // OnAuthPassword is called when a user attempts a pubkey authentication. The implementation must always supply
 //                AuthResponse and may supply error as a reason description. The pubKey parameter is an SSH key in
 //               the form of "ssh-rsa KEY HERE".
-func (a *AbstractNetworkConnectionHandler) OnAuthPubKey(_ string, _ string) (response AuthResponse, reason error) {
-	return AuthResponseUnavailable, nil
+func (a *AbstractNetworkConnectionHandler) OnAuthPubKey(_ string, _ string, _ string) (response AuthResponse, metadata map[string]string, reason error) {
+	return AuthResponseUnavailable, nil, nil
 }
 
 // OnAuthKeyboardInteractive is a callback for interactive authentication. The implementer will be passed a callback
@@ -31,8 +31,9 @@ func (a *AbstractNetworkConnectionHandler) OnAuthKeyboardInteractive(
 		instruction string,
 		questions KeyboardInteractiveQuestions,
 	) (answers KeyboardInteractiveAnswers, err error),
-) (response AuthResponse, reason error) {
-	return AuthResponseUnavailable, nil
+	_ string,
+) (response AuthResponse, metadata map[string]string, reason error) {
+	return AuthResponseUnavailable, nil, nil
 }
 
 // OnHandshakeFailed is called when the SSH handshake failed. This method is also called after an authentication

diff --git a/AbstractSSHConnectionHandler.go b/AbstractSSHConnectionHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/AbstractSessionChannelHandler.go b/AbstractSessionChannelHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/Cipher.go b/Cipher.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/CipherList.go b/CipherList.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // CipherList is a list of supported ciphers
 type CipherList []Cipher

diff --git a/Config.go b/Config.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"bytes"

diff --git a/ConformanceTestBackendFactory.go b/ConformanceTestBackendFactory.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"github.com/containerssh/log"

diff --git a/Kex.go b/Kex.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/KexList.go b/KexList.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/KeyAlgo.go b/KeyAlgo.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/KeyAlgoList.go b/KeyAlgoList.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/MAC.go b/MAC.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/MACList.go b/MACList.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/New.go b/New.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"sync"

diff --git a/NewTestAuthenticationHandler.go b/NewTestAuthenticationHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // NewTestAuthenticationHandler creates a new backend that authenticates a user based on the users variable and passes
 // all further calls to the backend.

diff --git a/NewTestClient.go b/NewTestClient.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"github.com/containerssh/log"

diff --git a/NewTestHandler.go b/NewTestHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // NewTestHandler creates a conformanceTestHandler that can be used for testing purposes. It does not authenticate, that can be done
 // using the NewTestAuthenticationHandler

diff --git a/NewTestServer.go b/NewTestServer.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/NewTestUser.go b/NewTestUser.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // NewTestUser creates a user that can be used with NewTestHandler and NewTestClient.
 func NewTestUser(username string) *TestUser {

diff --git a/RunConformanceTests.go b/RunConformanceTests.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"testing"

diff --git a/Server.go b/Server.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"github.com/containerssh/service"

diff --git a/ServerVersion.go b/ServerVersion.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"fmt"

diff --git a/Server_test.go b/Server_test.go
@@ -1,4 +1,4 @@
-package sshserver_test
+package v2_test
 
 import (
 	"bytes"
@@ -18,7 +18,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"golang.org/x/crypto/ssh"
 
-	"github.com/containerssh/sshserver"
+	sshserver "github.com/containerssh/sshserver/v2"
 )
 
 //region Tests
@@ -497,21 +497,22 @@ type fullNetworkConnectionHandler struct {
 func (f *fullNetworkConnectionHandler) OnAuthPassword(
 	username string,
 	password []byte,
-) (response sshserver.AuthResponse, reason error) {
+	_ string,
+) (response sshserver.AuthResponse, metadata map[string]string, reason error) {
 	if storedPassword, ok := f.handler.passwords[username]; ok && bytes.Equal(storedPassword, password) {
-		return sshserver.AuthResponseSuccess, nil
+		return sshserver.AuthResponseSuccess, nil, nil
 	}
-	return sshserver.AuthResponseFailure, fmt.Errorf("authentication failed")
+	return sshserver.AuthResponseFailure, nil, fmt.Errorf("authentication failed")
 }
 
-func (f *fullNetworkConnectionHandler) OnAuthPubKey(username string, pubKey string) (response sshserver.AuthResponse, reason error) {
+func (f *fullNetworkConnectionHandler) OnAuthPubKey(username string, pubKey string, _ string,) (response sshserver.AuthResponse, metadata map[string]string, reason error) {
 	if storedPubKey, ok := f.handler.pubKeys[username]; ok && storedPubKey == pubKey {
-		return sshserver.AuthResponseSuccess, nil
+		return sshserver.AuthResponseSuccess, nil, nil
 	}
-	return sshserver.AuthResponseFailure, fmt.Errorf("authentication failed")
+	return sshserver.AuthResponseFailure, nil, fmt.Errorf("authentication failed")
 }
 
-func (f *fullNetworkConnectionHandler) OnHandshakeSuccess(_ string) (connection sshserver.SSHConnectionHandler, failureReason error) {
+func (f *fullNetworkConnectionHandler) OnHandshakeSuccess(_ string, _ string, _ map[string]string) (connection sshserver.SSHConnectionHandler, failureReason error) {
 	return &fullSSHConnectionHandler{
 		handler: f.handler,
 	}, nil

diff --git a/TestClient.go b/TestClient.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"errors"

diff --git a/TestClientConnection.go b/TestClientConnection.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // TestClientConnection is an individual established connection to the server
 type TestClientConnection interface {

diff --git a/TestClientSession.go b/TestClientSession.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/TestServer.go b/TestServer.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"time"

diff --git a/TestUser.go b/TestUser.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"bytes"

diff --git a/channelWrapper.go b/channelWrapper.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"errors"

diff --git a/codes.go b/codes.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 // A user has connected over SSH.
 const MConnected = "SSH_CONNECTED"

diff --git a/codes_doc.go b/codes_doc.go
@@ -1,3 +1,3 @@
-package sshserver
+package v2
 
 //go:generate containerssh-generate-codes
diff --git a/conformanceShellCommand.go b/conformanceShellCommand.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/conformanceTestHandler.go b/conformanceTestHandler.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"net"

diff --git a/conformanceTestSuite.go b/conformanceTestSuite.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"context"

diff --git a/connectionid.go b/connectionid.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 import (
 	"encoding/hex"

diff --git a/envRequestPayload.go b/envRequestPayload.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 type envRequestPayload struct {
 	Name  string

diff --git a/execRequestPayload.go b/execRequestPayload.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 type execRequestPayload struct {
 	Exec string

diff --git a/exitSignalPayload.go b/exitSignalPayload.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 type exitSignalPayload struct {
 	Signal       string

diff --git a/exitStatusPayload.go b/exitStatusPayload.go
@@ -1,4 +1,4 @@
-package sshserver
+package v2
 
 type exitStatusPayload struct {
 	ExitStatus uint32

diff --git a/go.mod b/go.mod
@@ -1,15 +1,13 @@
-module github.com/containerssh/sshserver
+module github.com/containerssh/sshserver/v2
 
-go 1.14
+go 1.16
 
 require (
 	github.com/containerssh/log v1.0.0
 	github.com/containerssh/service v1.0.0
 	github.com/containerssh/structutils v1.0.0
 	github.com/containerssh/unixutils v1.0.0
 	github.com/google/uuid v1.2.0
-	github.com/imdario/mergo v0.3.12 // indirect
-	github.com/mattn/go-shellwords v1.0.11 // indirect
 	github.com/stretchr/testify v1.7.0
 	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
 	golang.org/x/sys v0.0.0-20210331175145-43e1dd70ce54 // indirect

diff --git a/go.sum b/go.sum
@@ -1,22 +1,9 @@
-github.com/containerssh/log v0.9.10/go.mod h1:NBMzkhOLZ4z45ShSBKQ/Ij6Hqqg15DgOKy6HlSITx0s=
-github.com/containerssh/log v0.9.11 h1:CLpl9mhxBg4giLZjcZB+FjddYypm2f2x1bCY3iissdA=
-github.com/containerssh/log v0.9.11/go.mod h1:uVuUPoZsJYi2KoV9+lgPeB/gWuXeUTD3AoVxc4y+tKY=
-github.com/containerssh/log v0.9.13 h1:jBSrFaxZNGwkjHU6y/efYI8lyG8KIFR5aOIeOnNzquE=
-github.com/containerssh/log v0.9.13/go.mod h1:uVuUPoZsJYi2KoV9+lgPeB/gWuXeUTD3AoVxc4y+tKY=
 github.com/containerssh/log v1.0.0 h1:nOSqNqh7cXIa+Iy+Lx2CA+wpkrqDqcQh4EVoEvSaxU8=
 github.com/containerssh/log v1.0.0/go.mod h1:7Gy+sx0H1UDtjYBySvK0CnXRRHPHZPXMsa9MYmLBI0I=
-github.com/containerssh/service v0.9.2 h1:+EZ7s7sxSme+IosYBR24oNhVlPTz3GJTXBZ0HaSD9rU=
-github.com/containerssh/service v0.9.2/go.mod h1:nbA2I+GL0vU7ls0JEQKI+QOJfbUjlIDmmUSQqx/G7ro=
-github.com/containerssh/service v0.9.3 h1:mYpvZ9zxUrKL8OpBen86heXfGtdUGdtfZ3Y7P605zvQ=
-github.com/containerssh/service v0.9.3/go.mod h1:Yeq3hwfM6js9TfpkrQAQhv5IRfurrGEkM+AbFEC9KCE=
 github.com/containerssh/service v1.0.0 h1:+AcBsmeaR0iMDnemXJ6OgeTEYB3C0YJF3h03MNIo1Ak=
 github.com/containerssh/service v1.0.0/go.mod h1:FmYg3jc56WBvxyx5rvXCkJbIsmweNTeYSr/9z2n2qsI=
-github.com/containerssh/structutils v0.9.0 h1:pz4xl5ZrPnpdSx7B/ru8Fj3oU3vOtx1jprIuSkm5s7o=
-github.com/containerssh/structutils v0.9.0/go.mod h1:zirdwNXan3kuTpsJp9Gl3W6VQz0fexqMySqxmfviSjw=
 github.com/containerssh/structutils v1.0.0 h1:XwNSnjmoJpMP8hxX5YbDJRGcU66znRWP5jKUYI2Kh4s=
 github.com/containerssh/structutils v1.0.0/go.mod h1:Dp5tCtnkT19A9BFNP4+flL5R+THvBgp95eO640fR+ow=
-github.com/containerssh/unixutils v0.9.0 h1:9Bh2UiQW6DIuVW6upc1uUU38tKK1IUn2hxZqi9w3cQc=
-github.com/containerssh/unixutils v0.9.0/go.mod h1:k1Z/lsIUK95UzrlqRw2JWDDi6LGeL7wG+V+N+TWkCbU=
 github.com/containerssh/unixutils v1.0.0 h1:V6zwRxOycwpXY3hjjzFVfgV/4vOsqPVJ63rR2V7EYM8=
 github.com/containerssh/unixutils v1.0.0/go.mod h1:UK2dMXp9Iy2ILHrcrzOU5jWZDgPkuChyg75wrdcIZjU=
 github.com/creasty/defaults v1.5.1 h1:j8WexcS3d/t4ZmllX4GEkl4wIB/trOr035ajcLHCISM=
@@ -26,15 +13,11 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs=
 github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/imdario/mergo v0.3.11 h1:3tnifQM4i+fbajXKBHXWEH+KvNHqojZ778UH75j3bGA=
-github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
 github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=
 github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/mattn/go-shellwords v1.0.10 h1:Y7Xqm8piKOO3v10Thp7Z36h4FYFjt5xB//6XvOrs2Gw=
-github.com/mattn/go-shellwords v1.0.10/go.mod h1:EZzvwXDESEeg03EKmM+RmDnNOPKG4lLtQsUlTZDWQ8Y=
 github.com/mattn/go-shellwords v1.0.11 h1:vCoR9VPpsk/TZFW2JwK5I9S0xdrtUq2bph6/YjEPnaw=
 github.com/mattn/go-shellwords v1.0.11/go.mod h1:EZzvwXDESEeg03EKmM+RmDnNOPKG4lLtQsUlTZDWQ8Y=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
@@ -45,20 +28,13 @@ github.com/qdm12/reprint v0.0.0-20200326205758-722754a53494 h1:wSmWgpuccqS2IOfmY
 github.com/qdm12/reprint v0.0.0-20200326205758-722754a53494/go.mod h1:yipyliwI08eQ6XwDm1fEwKPdF/xdbkiHtrU+1Hg+vc4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad h1:DN0cp81fZ3njFcrLCytUHRSUkqBjfTo4Tx9RJTWs0EY=
 golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
 golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f h1:+Nyd8tzPX9R7BWHguqsrbFdRx3WQ/1ib8I44HXV5yTA=
-golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4 h1:EZ2mChiOa8udjfp6rRmswTbtZN/QzUQp4ptM4rnjHvc=
-golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210331175145-43e1dd70ce54 h1:rF3Ohx8DRyl8h2zw9qojyLHLhrJpEMgyPOImREEryf0=
 golang.org/x/sys v0.0.0-20210331175145-43e1dd70ce54/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221 h1:/ZHdbVpdR/jk3g30/d4yUL0JU9kksj8+F/bnQUVLGDM=
@@ -68,7 +44,6 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=