chore!: quality: restructure project to better align with the best pr…

…actices

* make most of the packages internal. The packages are currently not
  imported by anyone and as we are <1.0, this is a fair game.
* move main packages to `cmd/{binaryName}`
* rename `client` package to `ui` which better describes the functionality.
  Currently, the project provides no actual API client to consume.

.goreleaser.yaml

@@ -2,12 +2,12 @@ builds:
   - id: &build_id_ssh_inscribe ssh-inscribe
     env:
       - CGO_ENABLED=0
-    main: .
+    main: ./cmd/ssh-inscribe
     binary: ssh-inscribe
     ldflags:
-      - -X github.com/aakso/ssh-inscribe/pkg/globals.version={{ .Version }}
-      - -X github.com/aakso/ssh-inscribe/pkg/globals.confDir=/etc/ssh-inscribe
-      - -X github.com/aakso/ssh-inscribe/pkg/globals.varDir=/var/lib/ssh-inscribe
+      - -X github.com/aakso/ssh-inscribe/internal/globals.version={{ .Version }}
+      - -X github.com/aakso/ssh-inscribe/internal/globals.confDir=/etc/ssh-inscribe
+      - -X github.com/aakso/ssh-inscribe/internal/globals.varDir=/var/lib/ssh-inscribe
     goos: [darwin, linux]
     goarch: [amd64, arm64]
     ignore:
@@ -17,10 +17,10 @@ builds:
   - id: &build_id_sshi sshi
     env:
       - CGO_ENABLED=0
-    main: ./cliclient/sshi
+    main: ./cmd/sshi
     binary: sshi
     ldflags:
-      - -X github.com/aakso/ssh-inscribe/pkg/globals.version={{ .Version }}
+      - -X github.com/aakso/ssh-inscribe/internal/globals.version={{ .Version }}
     goos: [darwin, linux, windows]
     goarch: [amd64, arm64]
     ignore:

Makefile

@@ -20,5 +20,5 @@ dist:
 
 .PHONY: test
 test:
-	go test $(shell git grep  -l '!race' ./pkg | xargs -n 1 dirname | uniq | sed 's/^/\.\//')
-	go test -race ./pkg/...
+	go test $(shell git grep  -l '!race' ./internal | xargs -n 1 dirname | uniq | sed 's/^/\.\//')
+	go test -race ./internal/...

cmd/crypt.go → cmd/ssh-inscribe/crypt.go

@@ -1,4 +1,4 @@
-package cmd
+package main
 
 import (
 	"fmt"

cmd/defaults.go → cmd/ssh-inscribe/defaults.go

@@ -1,13 +1,14 @@
-package cmd
+package main
 
 import (
 	"fmt"
 
-	_ "github.com/aakso/ssh-inscribe/pkg/auth/backend/all"
-	"github.com/aakso/ssh-inscribe/pkg/config"
-	_ "github.com/aakso/ssh-inscribe/pkg/server"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v2"
+
+	_ "github.com/aakso/ssh-inscribe/internal/auth/backend/all"
+	"github.com/aakso/ssh-inscribe/internal/config"
+	_ "github.com/aakso/ssh-inscribe/internal/server"
 )
 
 // serverCmd represents the server command

main.go → cmd/ssh-inscribe/main.go

@@ -14,8 +14,14 @@
 
 package main
 
-import "github.com/aakso/ssh-inscribe/cmd"
+import (
+	"fmt"
+	"os"
+)
 
 func main() {
-	cmd.Execute()
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+		os.Exit(-1)
+	}
 }

cmd/root.go → cmd/ssh-inscribe/root.go

@@ -1,14 +1,15 @@
-package cmd
+package main
 
 import (
 	"fmt"
 	"os"
 	"path"
 
-	"github.com/aakso/ssh-inscribe/pkg/config"
-	"github.com/aakso/ssh-inscribe/pkg/logging"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
+
+	"github.com/aakso/ssh-inscribe/internal/config"
+	"github.com/aakso/ssh-inscribe/internal/logging"
 )
 
 var cfgFile string
@@ -20,13 +21,6 @@ var RootCmd = &cobra.Command{
 	Long:  "",
 }
 
-func Execute() {
-	if err := RootCmd.Execute(); err != nil {
-		fmt.Println(err)
-		os.Exit(-1)
-	}
-}
-
 func init() {
 	cobra.OnInitialize(rootInit)
 	RootCmd.PersistentFlags().StringVar(

cmd/server.go → cmd/ssh-inscribe/server.go

@@ -1,8 +1,9 @@
-package cmd
+package main
 
 import (
-	"github.com/aakso/ssh-inscribe/pkg/server"
 	"github.com/spf13/cobra"
+
+	"github.com/aakso/ssh-inscribe/internal/server"
 )
 
 // serverCmd represents the server command

cmd/version.go → cmd/ssh-inscribe/version.go

@@ -1,10 +1,11 @@
-package cmd
+package main
 
 import (
 	"fmt"
 
-	"github.com/aakso/ssh-inscribe/pkg/globals"
 	"github.com/spf13/cobra"
+
+	"github.com/aakso/ssh-inscribe/internal/globals"
 )
 
 // serverCmd represents the server command

cliclient/cmd/ca.go → cmd/sshi/ca.go

@@ -1,4 +1,4 @@
-package cmd
+package main
 
 import (
 	"fmt"
@@ -7,7 +7,7 @@ import (
 	"github.com/spf13/cobra"
 	"golang.org/x/crypto/ssh"
 
-	"github.com/aakso/ssh-inscribe/pkg/client"
+	"github.com/aakso/ssh-inscribe/internal/ui"
 )
 
 var principals []string
@@ -23,7 +23,7 @@ var ShowCaCmd = &cobra.Command{
 	Args:              cobra.NoArgs,
 	ValidArgsFunction: cobra.NoFileCompletions,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		c := &client.Client{
+		c := &ui.Client{
 			Config: ClientConfig,
 		}
 		defer c.Close()
@@ -51,7 +51,7 @@ var AddCaCmd = &cobra.Command{
 		if len(args) > 0 {
 			ClientConfig.CAKeyFile = args[0]
 		}
-		c := &client.Client{
+		c := &ui.Client{
 			Config: ClientConfig,
 		}
 		defer c.Close()
@@ -65,7 +65,7 @@ var ResponseCmd = &cobra.Command{
 	Args:              cobra.NoArgs,
 	ValidArgsFunction: cobra.NoFileCompletions,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		c := &client.Client{
+		c := &ui.Client{
 			Config: ClientConfig,
 		}
 		defer c.Close()

cliclient/cmd/exec.go → cmd/sshi/exec.go

@@ -1,4 +1,4 @@
-package cmd
+package main
 
 import (
 	"fmt"
@@ -14,10 +14,10 @@ import (
 	"github.com/spf13/cobra"
 	"golang.org/x/crypto/ssh/agent"
 
-	"github.com/aakso/ssh-inscribe/pkg/client"
-	"github.com/aakso/ssh-inscribe/pkg/filteringagent"
-	"github.com/aakso/ssh-inscribe/pkg/logging"
-	"github.com/aakso/ssh-inscribe/pkg/util"
+	"github.com/aakso/ssh-inscribe/internal/filteringagent"
+	"github.com/aakso/ssh-inscribe/internal/logging"
+	"github.com/aakso/ssh-inscribe/internal/ui"
+	"github.com/aakso/ssh-inscribe/internal/util"
 )
 
 const (
@@ -80,7 +80,7 @@ func runExecCommand(args []string) error {
 		}
 	}
 	ClientConfig.GenerateKeypair = true
-	c := &client.Client{Config: ClientConfig}
+	c := &ui.Client{Config: ClientConfig}
 	defer c.Close()
 	if err := c.Login(); err != nil {
 		return err

cmd/sshi/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"fmt"
+	"os"
+)
+
+func main() {
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+		os.Exit(-1)
+	}
+}

cliclient/cmd/request.go → cmd/sshi/request.go

@@ -1,12 +1,13 @@
-package cmd
+package main
 
 import (
 	"fmt"
 	"os"
 	"strconv"
 
-	"github.com/aakso/ssh-inscribe/pkg/client"
 	"github.com/spf13/cobra"
+
+	"github.com/aakso/ssh-inscribe/internal/ui"
 )
 
 var ReqCmd = &cobra.Command{
@@ -15,7 +16,7 @@ var ReqCmd = &cobra.Command{
 	Args:              cobra.NoArgs,
 	ValidArgsFunction: cobra.NoFileCompletions,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		c := &client.Client{
+		c := &ui.Client{
 			Config: ClientConfig,
 		}
 		defer c.Close()

cliclient/cmd/root.go → cmd/sshi/root.go

@@ -1,4 +1,4 @@
-package cmd
+package main
 
 import (
 	"fmt"
@@ -9,8 +9,8 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/aakso/ssh-inscribe/pkg/client"
-	"github.com/aakso/ssh-inscribe/pkg/logging"
+	"github.com/aakso/ssh-inscribe/internal/logging"
+	"github.com/aakso/ssh-inscribe/internal/ui"
 )
 
 var RootCmd = &cobra.Command{
@@ -19,7 +19,7 @@ var RootCmd = &cobra.Command{
 	SilenceErrors: true,
 	SilenceUsage:  true,
 }
-var ClientConfig = &client.Config{
+var ClientConfig = &ui.Config{
 	UseAgent:            true,
 	Timeout:             2 * time.Second,
 	Retries:             3,
@@ -173,7 +173,7 @@ func init() {
 		"Login to specific auth endpoints ($SSH_INSCRIBE_LOGIN_AUTH_ENDPOINTS)",
 	)
 	_ = RootCmd.RegisterFlagCompletionFunc("login", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		c := &client.Client{
+		c := &ui.Client{
 			Config: ClientConfig,
 		}
 		defer c.Close()

cliclient/cmd/ssh.go → cmd/sshi/ssh.go

@@ -1,4 +1,4 @@
-package cmd
+package main
 
 import (
 	"bufio"

cliclient/cmd/version.go → cmd/sshi/version.go

@@ -1,13 +1,14 @@
-package cmd
+package main
 
 import (
 	"fmt"
 	"os"
 
-	"github.com/aakso/ssh-inscribe/pkg/client"
+	"github.com/aakso/ssh-inscribe/internal/ui"
 
-	"github.com/aakso/ssh-inscribe/pkg/globals"
 	"github.com/spf13/cobra"
+
+	"github.com/aakso/ssh-inscribe/internal/globals"
 )
 
 // versionCmd represents the version command
@@ -18,7 +19,7 @@ var versionCmd = &cobra.Command{
 	Args:              cobra.NoArgs,
 	ValidArgsFunction: cobra.NoFileCompletions,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		c := &client.Client{Config: ClientConfig}
+		c := &ui.Client{Config: ClientConfig}
 		fmt.Printf("local: %s\n", globals.Version())
 
 		if ClientConfig.URL == "" {

pkg/auth/authz/authzfilter/init.go → internal/auth/authz/authzfilter/init.go

@@ -2,7 +2,8 @@ package authzfilter
 
 import (
 	"github.com/sirupsen/logrus"
-	"github.com/aakso/ssh-inscribe/pkg/logging"
+
+	"github.com/aakso/ssh-inscribe/internal/logging"
 )
 
 var Log *logrus.Entry = logging.GetLogger("authzfilter").WithField("pkg", "auth/authz/authzfilter")

pkg/auth/authz/authzfilter/principal_filter.go → internal/auth/authz/authzfilter/principal_filter.go

@@ -1,10 +1,11 @@
 package authzfilter
 
 import (
-	"github.com/sirupsen/logrus"
-	"github.com/aakso/ssh-inscribe/pkg/auth"
 	"github.com/gobwas/glob"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+
+	"github.com/aakso/ssh-inscribe/internal/auth"
 )
 
 type PrincipalFilterConfig struct {

pkg/auth/authz/authzfilter/principal_filter_test.go → internal/auth/authz/authzfilter/principal_filter_test.go

@@ -7,8 +7,8 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/aakso/ssh-inscribe/pkg/auth"
-	"github.com/aakso/ssh-inscribe/pkg/logging"
+	"github.com/aakso/ssh-inscribe/internal/auth"
+	"github.com/aakso/ssh-inscribe/internal/logging"
 )
 
 func authContext() *auth.AuthContext {

internal/auth/backend/all/init.go

@@ -0,0 +1,7 @@
+package all
+
+import (
+	_ "github.com/aakso/ssh-inscribe/internal/auth/backend/authfile"
+	_ "github.com/aakso/ssh-inscribe/internal/auth/backend/authldap"
+	_ "github.com/aakso/ssh-inscribe/internal/auth/backend/authoidc"
+)

pkg/auth/backend/authfile/auth.go → internal/auth/backend/authfile/auth.go

@@ -8,9 +8,10 @@ import (
 
 	"golang.org/x/crypto/bcrypt"
 
-	"github.com/sirupsen/logrus"
-	"github.com/aakso/ssh-inscribe/pkg/auth"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+
+	"github.com/aakso/ssh-inscribe/internal/auth"
 )
 
 type AuthFile struct {