Merge pull request #102 from C2FO/accept-multi-kex

Allow commandline to specify multiple kex algos

CHANGELOG.md

@@ -5,6 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [Unreleased]
 
+## [6.0.0] - 2021-09-29
+### Changed
+- Modified sftp Key Exchange option to accept an array instead of a string, allowing multiple kex algorithms
+
+### Upgrade steps
+
+With v6.0.0, sftp.Options struct changed to accept an array of Key Exchange algorithms rather than a string. To update, change the syntax of the auth commands. 
+```
+"keyExchanges":"diffie-hellman-group-a256"
+```
+becomes 
+```
+"keyExchanges":["diffie-hellman-group-a256"]
+```
+
 ## [5.10.0] - 2021-09-16
 ### Changed
 - Modified S3 file.go so that on the initial read when the remote file is downloaded, a temporary file is locally created

README.md

@@ -4,7 +4,7 @@
 
 [![GitHub tag](https://img.shields.io/github/tag/c2fo/vfs.svg?style=flat)](https://github.com/c2fo/vfs/releases)
 [![Build Status](https://travis-ci.org/C2FO/vfs.svg?branch=master)](https://travis-ci.org/C2FO/vfs)
-[![GoDoc](https://pkg.go.dev/badge/github.com/c2fo/vfs/v5?utm_source=godoc)](https://pkg.go.dev/github.com/c2fo/vfs/v5)
+[![GoDoc](https://pkg.go.dev/badge/github.com/c2fo/vfs/v6?utm_source=godoc)](https://pkg.go.dev/github.com/c2fo/vfs/v6)
 [![codecov](https://codecov.io/gh/c2fo/vfs/branch/master/graph/badge.svg)](https://codecov.io/gh/c2fo/vfs)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](License.md)
 [![Go Report Card](https://goreportcard.com/badge/github.com/c2fo/vfs)](https://goreportcard.com/report/github.com/c2fo/vfs)
@@ -60,10 +60,27 @@ file system backends.
 
 ### Install
 
-Go install:
+Pre 1.17:
+```
+go get -u github.com/c2fo/vfs/v6
+```
+
+Post 1.17:
+```
+go install -u github.com/c2fo/vfs/v6
+```
 
-    go get -u github.com/c2fo/vfs/v5
+### Upgrading
 
+#### Upgrading from v5 to v6
+With v6.0.0, sftp.Options struct changed to to accept an array of Key Exchange algorithms rather than a string. To update, change the syntax of the auth commands.
+```
+  "keyExchanges":"diffie-hellman-group-a256"
+```
+becomes
+```
+  "keyExchanges":["diffie-hellman-group-a256"]
+```
 
 ### Usage
 

backend/all/all.go

@@ -2,10 +2,10 @@
 package all
 
 import (
-	_ "github.com/c2fo/vfs/v5/backend/azure" // register azure backend
-	_ "github.com/c2fo/vfs/v5/backend/gs"    // register gs backend
-	_ "github.com/c2fo/vfs/v5/backend/mem"   // register mem backend
-	_ "github.com/c2fo/vfs/v5/backend/os"    // register os backend
-	_ "github.com/c2fo/vfs/v5/backend/s3"    // register s3 backend
-	_ "github.com/c2fo/vfs/v5/backend/sftp"  // register sftp backend
+	_ "github.com/c2fo/vfs/v6/backend/azure" // register azure backend
+	_ "github.com/c2fo/vfs/v6/backend/gs"    // register gs backend
+	_ "github.com/c2fo/vfs/v6/backend/mem"   // register mem backend
+	_ "github.com/c2fo/vfs/v6/backend/os"    // register os backend
+	_ "github.com/c2fo/vfs/v6/backend/s3"    // register s3 backend
+	_ "github.com/c2fo/vfs/v6/backend/sftp"  // register sftp backend
 )

backend/azure/client.go

@@ -11,8 +11,8 @@ import (
 	"github.com/Azure/azure-pipeline-go/pipeline"
 	"github.com/Azure/azure-storage-blob-go/azblob"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 // The Client interface contains methods that perform specific operations to Azure Blob Storage.  This interface is

backend/azure/doc.go

@@ -6,8 +6,8 @@ Usage
 Rely on github.com/c2fo/vfs/backend
 
   import(
-      "github.com/c2fo/vfs/v5/backend"
-      "github.com/c2fo/vfs/v5/backend/azure"
+      "github.com/c2fo/vfs/v6/backend"
+      "github.com/c2fo/vfs/v6/backend/azure"
   )
 
   func UseFs() error {
@@ -17,7 +17,7 @@ Rely on github.com/c2fo/vfs/backend
 
 Or call directly:
 
-  import "github.com/c2fo/vfs/v5/backend/azure"
+  import "github.com/c2fo/vfs/v6/backend/azure"
 
   func DoSomething() {
       fs := azure.NewFilesystem()

backend/azure/file.go

@@ -11,9 +11,9 @@ import (
 
 	"github.com/Azure/azure-storage-blob-go/azblob"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/backend"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/backend"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 // File implements the vfs.File interface for Azure Blob Storage

backend/azure/fileSystem.go

@@ -9,9 +9,9 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/backend"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/backend"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 // Scheme defines the scheme for the azure implementation

backend/azure/fileSystem_test.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 type FileSystemTestSuite struct {

backend/azure/file_test.go

@@ -10,8 +10,8 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 type FileTestSuite struct {

backend/azure/location.go

@@ -7,8 +7,8 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 const errNilLocationReceiver = "azure.Location receiver pointer must be non-nil"

backend/azure/location_test.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 type LocationTestSuite struct {

backend/azure/mock_client.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/Azure/azure-storage-blob-go/azblob"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 // MockAzureClient is a mock implementation of azure.Client.

backend/azure/options.go

@@ -3,7 +3,7 @@ package azure
 import (
 	"os"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 
 	"github.com/Azure/azure-storage-blob-go/azblob"
 )

backend/backend.go

@@ -4,7 +4,7 @@ import (
 	"sort"
 	"sync"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 var mmu sync.RWMutex

backend/backend_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5/mocks"
+	"github.com/c2fo/vfs/v6/mocks"
 )
 
 /**********************************

backend/doc.go

@@ -8,9 +8,9 @@ In this way, a caller of vfs backends can simply load the backend file system (a
 
   // import backend and each backend you intend to use
   import(
-      "github.com/c2fo/vfs/v5/backend"
-      "github.com/c2fo/vfs/v5/backend/os"
-      "github.com/c2fo/vfs/v5/backend/s3"
+      "github.com/c2fo/vfs/v6/backend"
+      "github.com/c2fo/vfs/v6/backend/os"
+      "github.com/c2fo/vfs/v6/backend/s3"
   )
 
   func main() {
@@ -43,8 +43,8 @@ Then ensure it registers itself on load:
 
   import(
       ...
-      "github.com/c2fo/vfs/v5"
-      "github.com/c2fo/vfs/v5/backend"
+      "github.com/c2fo/vfs/v6"
+      "github.com/c2fo/vfs/v6/backend"
   )
 
   // IMPLEMENT vfs interfaces
@@ -59,7 +59,7 @@ Then do use it in some other package do
   package MyExoticFileSystem
 
   import(
-      "github.com/c2fo/vfs/v5/backend"
+      "github.com/c2fo/vfs/v6/backend"
       "github.com/acme/myexoticfilesystem"
   )
 

backend/gs/bucketHandleWrapper.go

@@ -5,7 +5,7 @@ import (
 
 	"cloud.google.com/go/storage"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 // BucketHandle is an interface which contains a subset of the functions provided

backend/gs/doc.go

@@ -6,8 +6,8 @@ Usage
 Rely on github.com/c2fo/vfs/backend
 
   import(
-      "github.com/c2fo/vfs/v5/backend"
-      "github.com/c2fo/vfs/v5/backend/gs"
+      "github.com/c2fo/vfs/v6/backend"
+      "github.com/c2fo/vfs/v6/backend/gs"
   )
 
   func UseFs() error {
@@ -17,7 +17,7 @@ Rely on github.com/c2fo/vfs/backend
 
 Or call directly:
 
-  import "github.com/c2fo/vfs/v5/backend/gs"
+  import "github.com/c2fo/vfs/v6/backend/gs"
 
   func DoSomething() {
       fs := gs.NewFilesystem()

backend/gs/file.go

@@ -12,9 +12,9 @@ import (
 
 	"cloud.google.com/go/storage"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/backend"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/backend"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 const (

backend/gs/fileSystem.go

@@ -7,9 +7,9 @@ import (
 	"cloud.google.com/go/storage"
 	"golang.org/x/net/context"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/backend"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/backend"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 // Scheme defines the file system type.

backend/gs/file_test.go

@@ -13,7 +13,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 type fileTestSuite struct {

backend/gs/location.go

@@ -9,8 +9,8 @@ import (
 	"cloud.google.com/go/storage"
 	"google.golang.org/api/iterator"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 // Location implements vfs.Location for gs fs.

backend/gs/location_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
 
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6/utils"
 
 	"github.com/fsouza/fake-gcs-server/fakestorage"
 )

backend/gs/objectHandleWrapper.go

@@ -6,7 +6,7 @@ import (
 	"cloud.google.com/go/storage"
 	"google.golang.org/api/iterator"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 // ObjectHandleWrapper is an interface which contains a subset of the functions provided

backend/gs/options.go

@@ -3,7 +3,7 @@ package gs
 import (
 	"google.golang.org/api/option"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 // Options holds Google Cloud Storage -specific options.  Currently only client options are used.

backend/helpers.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"io"
 
-	"github.com/c2fo/vfs/v5"
+	"github.com/c2fo/vfs/v6"
 )
 
 func ValidateCopySeekPosition(f vfs.File) error {

backend/mem/doc.go

@@ -1,17 +1,17 @@
 /*
 Package mem built-in mem lib VFS implementation.
 Usage
-Rely on github.com/c2fo/vfs/v5/backend
+Rely on github.com/c2fo/vfs/v6/backend
   import(
-      "github.com/c2fo/vfs/v5/backend"
-      "github.com/c2fo/vfs/v5/backend/mem"
+      "github.com/c2fo/vfs/v6/backend"
+      "github.com/c2fo/vfs/v6/backend/mem"
   )
   func UseFs() error {
       fs := backend.Backend(mem.Scheme)
       ...
   }
 Or call directly:
-  import _mem "github.com/c2fo/vfs/v5/backend/mem"
+  import _mem "github.com/c2fo/vfs/v6/backend/mem"
   func DoSomething() {
 	fs := _mem.NewFileSystem()
       ...

backend/mem/file.go

@@ -8,9 +8,9 @@ import (
 	"sync"
 	"time"
 
-	"github.com/c2fo/vfs/v5"
-	"github.com/c2fo/vfs/v5/backend"
-	"github.com/c2fo/vfs/v5/utils"
+	"github.com/c2fo/vfs/v6"
+	"github.com/c2fo/vfs/v6/backend"
+	"github.com/c2fo/vfs/v6/utils"
 )
 
 //