Final fixes before release (#16)

* Fixes to DB

* Add WithTeamDirectory() option to client/servers

* Fix version printing and add method to team.Client interface.

* Move transports to example directory

* Print daemon listening status

* Fix log level not printed in status

* Add some stuff to README

* Add more to README

* README

* Add code examples to readme

* README

* README Examples

* README

* Differences with Hashicorp plugins

* Add README to example

* README

* README

* Update ncruces/sqlite dependencies

* Use go1.21 in actions

* Fix cgo build

* Try to fix actions CodeQL

* Tidy comments

* Tidy comments

* Cleanup and comments tidying

* Fix actions

* Remove logging of cleartext credentials

* Fix imports

* Fix client imports

* Fix and restructure imports

* Fix windows action

* Finish server examples code

* Fix imports and update survey version

* Fix imports AGAIN

* Fix wrong server configs directory usage

* Fixes to security alerts

Author: maxlandon

example/README.md

@@ -58,7 +58,7 @@ number of transport/RPC listener/server backends to your core application teamse
    RPC backend. This file is good in that it shows you clearly how to use the teamserver as a core
    driver for any application-specific teamserving process. For example it shows how to query the
    teamserver users, request their connection/token credentials, authenticate them, and log all steps
-   with the teamserver loggers.   
+   with the teamserver loggers.  
 4) `transports/grpc/server/middleware.go` shows a quite complex but secure use of gRPC middleware using
    the teamserver authentication and logging toolset. Note that gRPC is a quite beefy stack, and not
    very idiomatic for Go. Don't be too scared at this code if you don't understand it at first, since

internal/certs/certs.go

@@ -36,11 +36,10 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/sirupsen/logrus"
-	"gorm.io/gorm"
-
 	"github.com/reeflective/team/internal/assets"
 	"github.com/reeflective/team/internal/db"
+	"github.com/sirupsen/logrus"
+	"gorm.io/gorm"
 )
 
 const (
@@ -90,8 +89,8 @@ func NewManager(filesystem *assets.FS, db *gorm.DB, logger *logrus.Entry, appNam
 	return certs
 }
 
-func (m *Manager) db() *gorm.DB {
-	return m.database.Session(&gorm.Session{
+func (c *Manager) db() *gorm.DB {
+	return c.database.Session(&gorm.Session{
 		FullSaveAssociations: true,
 	})
 }

internal/log/cli.go

@@ -41,11 +41,13 @@ const (
 	fieldPackage   = "logger"
 	fieldMessage   = "message"
 
-	PackageFieldKey = "teamserver_pkg"
-
 	minimumPackagePad = 11
 )
 
+// PackageFieldKey is used to identify the name of the package
+// specified by teamclients and teamservers named loggers.
+const PackageFieldKey = "teamserver_pkg"
+
 // stdioHook combines a stdout hook (info/debug/trace),
 // and a stderr hook (warn/error/fatal/panic).
 type stdioHook struct {

internal/log/log.go

@@ -23,9 +23,8 @@ import (
 	"io"
 	"path/filepath"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/reeflective/team/internal/assets"
+	"github.com/sirupsen/logrus"
 )
 
 const (

server/config.go

@@ -27,10 +27,9 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/reeflective/team/internal/assets"
 	"github.com/reeflective/team/internal/command"
+	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -78,15 +77,14 @@ type Config struct {
 
 // ConfigPath returns the path to the server config.json file, on disk or in-memory.
 func (ts *Server) ConfigPath() string {
-	appDir := ts.TeamDir()
-	configDir := filepath.Join(appDir, "configs")
+	appDir := ts.ConfigsDir()
 
-	err := ts.fs.MkdirAll(configDir, assets.DirPerm)
+	err := ts.fs.MkdirAll(appDir, assets.DirPerm)
 	if err != nil {
-		ts.log().Errorf("cannot write to %s config dir: %s", configDir, err)
+		ts.log().Errorf("cannot write to %s config dir: %s", appDir, err)
 	}
 
-	serverConfigPath := filepath.Join(configDir, fmt.Sprintf("%s.%s", ts.Name(), command.ServerConfigExt))
+	serverConfigPath := filepath.Join(appDir, fmt.Sprintf("%s.%s", ts.Name(), command.ServerConfigExt))
 
 	return serverConfigPath
 }

server/core.go

@@ -24,15 +24,14 @@ import (
 	"runtime"
 	"sync"
 
-	"github.com/sirupsen/logrus"
-	"gorm.io/gorm"
-
 	"github.com/reeflective/team"
 	"github.com/reeflective/team/client"
 	"github.com/reeflective/team/internal/assets"
 	"github.com/reeflective/team/internal/certs"
 	"github.com/reeflective/team/internal/db"
 	"github.com/reeflective/team/internal/version"
+	"github.com/sirupsen/logrus"
+	"gorm.io/gorm"
 )
 
 // Server is the core driver of an application teamserver.
@@ -160,14 +159,14 @@ func (ts *Server) Self(opts ...client.Options) *client.Client {
 	return teamclient
 }
 
-// Version implements team.Client.VersionClient() interface
+// VersionClient implements team.Client.VersionClient() interface
 // method, so that the teamserver can be a teamclient of itself.
 // This simply returns the server.VersionServer() output.
 func (ts *Server) VersionClient() (team.Version, error) {
 	return ts.VersionServer()
 }
 
-// Version returns the teamserver binary version information.
+// VersionServe returns the teamserver binary version information.
 func (ts *Server) VersionServer() (team.Version, error) {
 	semVer := version.Semantic()
 	compiled, _ := version.Compiled()

server/db.go

@@ -25,11 +25,10 @@ import (
 	"path"
 	"path/filepath"
 
-	"gorm.io/gorm"
-
 	"github.com/reeflective/team/internal/assets"
 	"github.com/reeflective/team/internal/command"
 	"github.com/reeflective/team/internal/db"
+	"gorm.io/gorm"
 )
 
 const (
@@ -62,7 +61,7 @@ func (ts *Server) DatabaseConfig() *db.Config {
 
 // GetDatabaseConfigPath - File path to config.json.
 func (ts *Server) dbConfigPath() string {
-	appDir := ts.ConfigPath()
+	appDir := ts.ConfigsDir()
 	log := ts.NamedLogger("config", "database")
 	dbFileName := fmt.Sprintf("%s.%s", ts.Name()+"_database", command.ServerConfigExt)
 	databaseConfigPath := filepath.Join(appDir, dbFileName)

server/directories.go

@@ -67,7 +67,7 @@ func (ts *Server) TeamDir() string {
 	return dir
 }
 
-// LogsDir returns the directory of the client (~/.app-server/logs), creating
+// LogsDir returns the log directory of the server (~/.app-server/logs), creating
 // the directory if needed, or logging a fatal event if failing to create it.
 func (ts *Server) LogsDir() string {
 	logDir := path.Join(ts.TeamDir(), assets.DirLogs)
@@ -80,6 +80,19 @@ func (ts *Server) LogsDir() string {
 	return logDir
 }
 
+// Configs returns the configs directory of the server (~/.app-server/logs), creating
+// the directory if needed, or logging a fatal event if failing to create it.
+func (ts *Server) ConfigsDir() string {
+	logDir := path.Join(ts.TeamDir(), assets.DirConfigs)
+
+	err := ts.fs.MkdirAll(logDir, assets.DirPerm)
+	if err != nil {
+		ts.log().Errorf("cannot write to %s root dir: %s", logDir, err)
+	}
+
+	return logDir
+}
+
 // CertificatesDir returns the directory storing users CA PEM files as backup,
 // (~/.app/teamserver/certs), either on-disk or in-memory if the teamserver is.
 func (ts *Server) CertificatesDir() string {

server/log.go

@@ -22,9 +22,8 @@ import (
 	"fmt"
 	"path/filepath"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/reeflective/team/internal/log"
+	"github.com/sirupsen/logrus"
 )
 
 // NamedLogger returns a new logging "thread" with two fields (optional)

server/options.go

@@ -23,11 +23,10 @@ import (
 	"os"
 	"strings"
 
-	"github.com/sirupsen/logrus"
-	"gorm.io/gorm"
-
 	"github.com/reeflective/team/internal/assets"
 	"github.com/reeflective/team/internal/db"
+	"github.com/sirupsen/logrus"
+	"gorm.io/gorm"
 )
 
 const noTeamdir = "no team subdirectory"