Merge pull request #25 from Seagate/FMW-71949_slog

slog and minimize configuration

.gitignore

@@ -4,4 +4,4 @@ build
 vendor
 /pykmip-server/server.log
 /pykmip-server/server.db
-cmd/kms/kms
+kms

Makefile

@@ -1,7 +1,26 @@
+.PHONY : all build builddir install ppkmip kmipgen lint vet clean fmt generate test cover up down docker bash fish tidy update tools pykmip-server gen-certs
+
 SHELL = bash
 BUILD_FLAGS =
 TEST_FLAGS =
 COMPOSE ?= docker-compose
+APP_NAME := kms
+
+help:
+	@echo ""
+	@echo "-----------------------------------------------------------------------------------"
+	@echo "make all          - remove all"
+	@echo "make build        - build a local executable"
+	@echo "make install      - install the executable"
+	@echo "make clean        - remove build files"
+	@echo "make tidy         - go mod tidy"
+	@echo "make update       - go get -u ./..."
+	@echo "make lint         - golangci-lint run"
+	@echo "make vet          - go vet ./..."
+	@echo "make fmt          - gofumpt -w -l ."
+	@echo "make kms          - build $(APP_NAME)"
+	@echo "make installkms   - install $(APP_NAME)"
+	@echo ""
 
 all: fmt build up test lint
 
@@ -26,8 +45,12 @@ kmipgen:
 lint:
 	golangci-lint run
 
+vet:
+	go vet ./...
+
 clean:
 	rm -rf build/*
+	rm -rf $(APP_NAME)
 
 fmt:
 	gofumpt -w -l .
@@ -100,5 +123,10 @@ pykmip-server: up
 gen-certs:
 	openssl req -x509 -newkey rsa:4096 -keyout pykmip-server/server.key -out pykmip-server/server.cert -days 3650 -nodes -subj '/CN=localhost'
 
-.PHONY: all build builddir run artifacts vet lint clean fmt test testall testreport up down pull builder runc ci bash fish image prep vendor.update vendor.ensure tools buildtools migratetool db.migrate
+kms: cmd/$(APP_NAME)/main.go
+	@echo "Build local $(APP_NAME)..."
+	go build -o $(APP_NAME) -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`" ./cmd/$(APP_NAME)/main.go
+	ls -lh $(APP_NAME)
 
+installkms:
+	install ./$(APP_NAME) /usr/local/bin

cmd/kmipgen/main.go

@@ -307,7 +307,6 @@ func genCode(s *Specifications) (string, error) {
 	template.Must(tmpl.New("mask").Parse(maskTmpl))
 
 	err = tmpl.Execute(buf, in)
-
 	if err != nil {
 		return "", merry.Prepend(err, "executing template")
 	}

cmd/kms/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.3.0] (2024-10-15)
+
+### Features
+- Switch to using the standard package `slog`
+- Reduce `kmipapi.ConfigurationSettings` to minimal required settings, remove tls.Conn pointer
+- Modify all interfaces to pass `connection *tls.Conn`
+
 # [1.2.0] (2022-10-10)
 
 ### Features

cmd/kms/main.go

@@ -3,16 +3,26 @@ package main
 import (
 	"bufio"
 	"context"
+	"crypto/tls"
 	"flag"
 	"fmt"
+	"log/slog"
 	"os"
 
+	"github.com/Seagate/kmip-go/pkg/common"
 	"github.com/Seagate/kmip-go/src/handlers"
 	"github.com/Seagate/kmip-go/src/kmipapi"
-	"k8s.io/klog/v2"
 )
 
-const version string = "1.2.0"
+const version string = "1.3.0"
+
+// This variable is filled in during the linker step - -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`"
+var buildTime = ""
+
+var programLevel = new(slog.LevelVar) // Info by default
+
+// This variable is used to store the TLS connection for an open session with a KMS server
+var tlsConnection *tls.Conn = nil
 
 // init: called once during program execution
 func init() {
@@ -21,9 +31,6 @@ func init() {
 
 // main: the main application
 func main() {
-	klog.InitFlags(nil)
-	klog.EnableContextualLogging(true)
-
 	flag.Usage = func() {
 		_, _ = fmt.Fprintf(flag.CommandLine.Output(), "[] kms (version=%s) usage:\n", version)
 		_, _ = fmt.Fprintln(flag.CommandLine.Output(), "")
@@ -35,29 +42,38 @@ func main() {
 	}
 
 	var usage bool
+	var debug bool
 
 	flag.BoolVar(&usage, "h", false, "Show usage message.")
+	flag.BoolVar(&debug, "d", false, "Enable debug log level.")
 	flag.Parse()
 
 	if usage {
 		flag.Usage()
 		os.Exit(0)
 	}
 
-	fmt.Printf("[] kms (version=%s)\n\n", version)
+	// Initialize the slog logger
+	logger := slog.Default()
+	if debug {
+		slog.SetLogLoggerLevel(slog.LevelDebug)
+	}
+
+	fmt.Printf("\n[] kms (version=%s %s)\n\n", version, buildTime)
 
 	settings := kmipapi.ConfigurationSettings{
 		ProtocolVersionMajor: 1,
 		ProtocolVersionMinor: 4,
 		ServiceType:          kmipapi.KMIP14Service,
 	}
 
-	ctx := context.Background()
+	ctx := context.WithValue(context.Background(), common.LoggerKey, logger)
 
 	// Restore any previously stored configuration settings
-	filename := "kms.json"
-	if _, err := os.Stat(filename); err == nil {
-		kmipapi.Restore(ctx, &settings, filename)
+	err := kmipapi.Restore(ctx, &settings, "")
+	if err != nil {
+		fmt.Printf("ERROR: restoring kms configuration data, error: %v", err)
+		os.Exit(1)
 	}
 
 	scanner := bufio.NewScanner(os.Stdin)
@@ -70,7 +86,7 @@ func main() {
 				os.Exit(0)
 			}
 			if line != "" {
-				handlers.Execute(ctx, &settings, line)
+				handlers.Execute(ctx, &tlsConnection, &settings, line)
 				fmt.Println("")
 			}
 		}

cmd/ppkmip/main.go

@@ -13,8 +13,6 @@ import (
 	"os"
 	"strings"
 
-	_ "github.com/Seagate/kmip-go/kmip14"
-	_ "github.com/Seagate/kmip-go/kmip20"
 	"github.com/Seagate/kmip-go/ttlv"
 )
 
@@ -187,6 +185,7 @@ xml format:
 			}
 
 			printTTLV(outFormat, raw, count)
+
 			count++
 		}
 	case FormatHex:

go.mod

@@ -1,29 +1,25 @@
 module github.com/Seagate/kmip-go
 
-go 1.21
+go 1.22
 
 require (
 	github.com/ansel1/merry v1.8.0
 	github.com/fatih/color v1.17.0
 	github.com/gemalto/flume v0.13.1
 	github.com/google/uuid v1.6.0
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/text v0.17.0
-	k8s.io/klog/v2 v2.130.1
+	golang.org/x/text v0.19.0
 )
 
 require (
 	github.com/ansel1/merry/v2 v2.2.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/stretchr/objx v0.5.2 // indirect
-	go.uber.org/atomic v1.11.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.27.0 // indirect
-	golang.org/x/sys v0.24.0 // indirect
+	golang.org/x/sys v0.26.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )