Chore: remove generated cobra comments and improve help messages

.envrc

@@ -1,18 +1,18 @@
 # Can be debug,info,warning,error
-export LOG_LEVEL=debug
+export POLYCULECONNECT_LOG_LEVEL=debug
 
 # Can be net,unix
-export SERVER_MODE=net
+export POLYCULECONNECT_SERVER_MODE=net
-export SERVER_HOST="0.0.0.0"
+export POLYCULECONNECT_SERVER_HOST="0.0.0.0"
-export SERVER_PORT="5000"
+export POLYCULECONNECT_SERVER_PORT="5000"
-# SERVER_SOCK_PATH = ""
+# POLYCULECONNECT_SERVER_SOCK_PATH = ""
 
-export STORAGE_TYPE="sqlite"
+export POLYCULECONNECT_STORAGE_TYPE="sqlite"
-export STORAGE_FILEPATH="./build/polyculeconnect.db"
+export POLYCULECONNECT_STORAGE_FILEPATH="./build/polyculeconnect.db"
-# STORAGE_HOST = "127.0.0.1"
+# POLYCULECONNECT_STORAGE_HOST = "127.0.0.1"
-# STORAGE_PORT = "5432"
+# POLYCULECONNECT_STORAGE_PORT = "5432"
-# STORAGE_DB = "polyculeconnect"
+# POLYCULECONNECT_STORAGE_DB = "polyculeconnect"
-# STORAGE_USER = "polyculeconnect"
+# POLYCULECONNECT_STORAGE_USER = "polyculeconnect"
-# STORAGE_PASSWORD = "polyculeconnect"
+# POLYCULECONNECT_STORAGE_PASSWORD = "polyculeconnect"
-# STORAGE_SSL_MODE = "disable"
+# POLYCULECONNECT_STORAGE_SSL_MODE = "disable"
-# STORAGE_SSL_CA_FILE = ""
+# POLYCULECONNECT_STORAGE_SSL_CA_FILE = ""

.forgejo/workflows/docker-build-push-master.yml

@@ -0,0 +1,21 @@
+on:
+  push:
+    branches:
+      - "main"
+jobs:
+  docker-build-push:
+    runs-on: cth-ubuntu-latest
+    steps:
+      - name: set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: login to repository
+        uses: docker/login-action@v3
+        with:
+          registry: git.faercol.me
+          username: ${{ secrets.DOCKER_LOGIN }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: build and push image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: git.faercol.me/polyculeconnect/polyculeconnect:latest

.forgejo/workflows/docker-build-push-tag.yml

@@ -0,0 +1,21 @@
+on:
+  push:
+    tags:
+      - "**"
+jobs:
+  docker-build-push:
+    runs-on: cth-ubuntu-latest
+    steps:
+      - name: set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: login to repository
+        uses: docker/login-action@v3
+        with:
+          registry: git.faercol.me
+          username: ${{ secrets.DOCKER_LOGIN }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: build and push image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: git.faercol.me/polyculeconnect/polyculeconnect:${{ gitea.ref_name }}

.forgejo/workflows/docker-build.yml

@@ -0,0 +1,16 @@
+on:
+  push:
+    branches:
+      - "**"
+      - "!main"
+jobs:
+  docker-build-only:
+    runs-on: cth-ubuntu-latest
+    steps:
+      - name: set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: build image (build only)
+        uses: docker/build-push-action@v6
+        with:
+          push: false
+          tags: git.faercol.me/polyculeconnect/polyculeconnect

.forgejo/workflows/go-test.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+    branches:
+      - "**"
+jobs:
+  go-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.22
+      - name: Run unit tests
+        run: make -C polyculeconnect test
+      - name: Build go package
+        run: make -C polyculeconnect build

.woodpecker/deploy.yml

@@ -1,57 +0,0 @@
-steps:
-  docker-build-only:
-    image: woodpeckerci/plugin-docker-buildx
-    privileged: true
-    settings:
-      repo: git.faercol.me/polyculeconnect/polyculeconnect
-      tags: latest
-      dry_run: true
-      platforms:
-        - linux/amd64
-        # - linux/arm64
-    when:
-      - event: pull_request
-      - event: push
-        branch:
-          exclude: [main]
-
-  docker-build-push:
-    image: woodpeckerci/plugin-docker-buildx
-    privileged: true
-    settings:
-      repo: git.faercol.me/polyculeconnect/polyculeconnect
-      registry: git.faercol.me
-      tags: latest
-      username:
-        from_secret: git_username
-      password:
-        from_secret: git_password
-      platforms:
-        - linux/amd64
-        # - linux/arm64
-    when:
-      - event: push
-        branch: main
-
-  docker-push-tag:
-    image: woodpeckerci/plugin-docker-buildx
-    privileged: true
-    settings:
-      registry: git.faercol.me
-      repo: git.faercol.me/polyculeconnect/polyculeconnect
-      auto_tag: true
-      platforms:
-        - linux/amd64
-        # - linux/arm64
-      username:
-        from_secret: git_username
-      password:
-        from_secret: git_password
-    when:
-      - event: tag
-
-depends_on:
-  - test
-
-when:
-  event: [push, tag]

.woodpecker/test.yml

@@ -1,13 +0,0 @@
-steps:
-  go-test:
-    image: golang
-    commands:
-      - make -C polyculeconnect test
-
-  go-build:
-    image: golang
-    commands:
-      - make -C polyculeconnect build
-
-when:
-  event: [push, tag]

README.md

@@ -1,6 +1,6 @@
 # PolyculeConnect
 
-[![status-badge](https://ci-polycule-connect.chapoline.me/api/badges/1/status.svg)](https://ci-polycule-connect.chapoline.me/repos/1)
+[![status-badge](https://git.faercol.me/PolyculeConnect/polycule-connect/badges/workflows/go-test.yml/badge.svg?branch=main)](https://ci-polycule-connect.chapoline.me/repos/1)
 
 ![Project logo](./polyculeconnect/static/img/logo-text.png)
 

polyculeconnect/cmd/app/add.go

@@ -90,8 +90,9 @@ func init() {
 	appCmd.AddCommand(appAddCmd)
 
 	appAddCmd.Flags().StringVarP(&appName, "name", "n", "", "Name to represent the app")
-	appAddCmd.Flags().StringVarP(&appClientID, "id", "i", "", "ID to identify the app in the storage")
+	appAddCmd.Flags().StringVarP(&appID, "id", "i", "", "ID to identify the app in the storage")
-	appAddCmd.Flags().StringVarP(&appClientSecret, "secret", "s", "", "OpenIDConnect client secret")
+	appAddCmd.Flags().StringVarP(&appClientID, "client-id", "", "", "OpenIDConnect client secret")
+	appAddCmd.Flags().StringVarP(&appClientSecret, "client-secret", "", "", "OpenIDConnect client secret")
 	appAddCmd.Flags().StringSliceVarP(&appRedirectURIs, "redirect-uri", "r", []string{}, "Allowed redirect URI")
 
 	appAddCmd.Flags().BoolVar(&appInteractive, "interactive", false, "Set the client ID and secret in an interactive way")

polyculeconnect/cmd/app/remove.go

@@ -13,10 +13,8 @@ import (
 var appRemoveCmd = &cobra.Command{
 	Use:   "remove <app_client_id>",
 	Short: "Remove an app",
-	Long: `Remove the app with the given ID from the database.
+	Long:  `Remove the app with the given ID from the database.`,
-
+	Args:  cobra.ExactArgs(1),
-If the app is not found in the database, no error is returned`,
-	Args: cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		removeApp(args[0])
 	},

polyculeconnect/cmd/app/show.go

@@ -15,8 +15,8 @@ var appShowCmd = &cobra.Command{
 	Short: "Display installed apps",
 	Long: `Display the configuration for the apps.
 
-Pass the commands without arguments to display the list of currently installed apps
+Optional parameters:
-Pass the optional 'id' argument to display the configuration for this specific app`,
+- app-id: id of the application to display. If empty, display the list of available apps instead`,
 	Args: cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		s := utils.InitStorage(utils.InitConfig(""))

polyculeconnect/cmd/backend/backend.go

@@ -9,13 +9,8 @@ import (
 
 var backendCmd = &cobra.Command{
 	Use:   "backend",
-	Short: "A brief description of your command",
+	Short: "Handle authentication backends",
-	Long: `A longer description that spans multiple lines and likely contains examples
+	Long:  `Add, Remove or Show currently installed authentication backends`,
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		fmt.Println("backend called")
 	},

polyculeconnect/cmd/backend/remove.go

@@ -13,10 +13,8 @@ import (
 var backendRemoveCmd = &cobra.Command{
 	Use:   "remove <backend_id>",
 	Short: "Remove a backend",
-	Long: `Remove the backend with the given ID from the database.
+	Long:  `Remove the backend with the given ID from the database.`,
-
+	Args:  cobra.ExactArgs(1),
-If the backend is not found in the database, no error is returned`,
-	Args: cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		removeBackend(args[0])
 	},

polyculeconnect/cmd/backend/show.go

@@ -15,8 +15,8 @@ var backendShowCmd = &cobra.Command{
 	Short: "Display installed backends",
 	Long: `Display the configuration for the backends.
 
-Pass the commands without arguments to display the list of currently installed backends
+Optional parameters:
-Pass the optional 'id' argument to display the configuration for this specific backend`,
+- app-id: id of the backend to display. If empty, display the list of available backends instead`,
 	Args: cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		s := utils.InitStorage(utils.InitConfig(""))

polyculeconnect/cmd/db/connect.go

@@ -0,0 +1,55 @@
+package db
+
+import (
+	"errors"
+	"fmt"
+	"os/exec"
+	"syscall"
+
+	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/utils"
+	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/config"
+	"github.com/spf13/cobra"
+)
+
+// connectCmd represents the db connect command
+var connectCmd = &cobra.Command{
+	Use:   "connect",
+	Short: "Connect to the database",
+	Long:  `Connect to the database.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		conf := utils.InitConfig("")
+		if err := connectToDB(conf); err != nil {
+			utils.Failf("Failed to connect to DB: %s", err.Error())
+		}
+	},
+}
+
+func connectSQLite(conf *config.StorageConfig) error {
+	path, err := exec.LookPath("sqlite3")
+	if err != nil {
+		if errors.Is(err, exec.ErrNotFound) {
+			return errors.New("sqlite3 not installed")
+		}
+		return fmt.Errorf("failed to find sqlite3 executable: %w", err)
+	}
+
+	if err := syscall.Exec(path, []string{path, conf.File}, nil); err != nil {
+		return fmt.Errorf("failed to run sqlite3 command: %w", err)
+	}
+	return nil
+}
+
+func connectToDB(conf *config.AppConfig) error {
+	switch conf.StorageType {
+	case string(config.Memory):
+		return errors.New("no DB associated with memory storage")
+	case string(config.SQLite):
+		return connectSQLite(conf.StorageConfig)
+	default:
+		return fmt.Errorf("unsupported storage type %q", conf.StorageType)
+	}
+}
+
+func init() {
+	dbCmd.AddCommand(connectCmd)
+}

polyculeconnect/cmd/db/db.go

@@ -0,0 +1,17 @@
+package db
+
+import (
+	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd"
+	"github.com/spf13/cobra"
+)
+
+// dbCmd represents the db command
+var dbCmd = &cobra.Command{
+	Use:   "db",
+	Short: "Manage the database",
+	Long:  `Manage the database.`,
+}
+
+func init() {
+	cmd.RootCmd.AddCommand(dbCmd)
+}

polyculeconnect/cmd/db/destroy.go

@@ -0,0 +1,50 @@
+package db
+
+import (
+	"errors"
+	"fmt"
+	"os"
+
+	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/utils"
+	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/config"
+	"github.com/spf13/cobra"
+)
+
+// destroyCmd represents the db destroy command
+var destroyCmd = &cobra.Command{
+	Use:   "destroy",
+	Short: "Completely delete the current database",
+	Long:  `Delete the current database.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		conf := utils.InitConfig("")
+		if err := deleteDB(conf); err != nil {
+			utils.Failf("Failed to connect to DB: %s", err.Error())
+		}
+		fmt.Println("DB deleted")
+	},
+}
+
+func deleteSqliteDB(path string) error {
+	if err := os.Remove(path); err != nil {
+		if errors.Is(err, os.ErrNotExist) { // if the file has already been deleted we don't want to fail here
+			return nil
+		}
+		return fmt.Errorf("failed to delete SQLite file: %w", err)
+	}
+	return nil
+}
+
+func deleteDB(conf *config.AppConfig) error {
+	switch conf.StorageType {
+	case string(config.Memory):
+		return errors.New("no DB to delete in memory mode")
+	case string(config.SQLite):
+		return deleteSqliteDB(conf.StorageConfig.File)
+	default:
+		return fmt.Errorf("unsupported storage type %q", conf.StorageType)
+	}
+}
+
+func init() {
+	dbCmd.AddCommand(destroyCmd)
+}

polyculeconnect/cmd/root.go

@@ -12,9 +12,6 @@ var RootCmd = &cobra.Command{
 	Short: "You're in their DMs, I'm in their SSO",
 	Long: `PolyculeConnect is a SSO OpenIDConnect provider which allows multiple authentication backends,
 and enables authentication federation among several infrastructures.`,
-	// Uncomment the following line if your bare application
-	// has an action associated with it:
-	// Run: func(cmd *cobra.Command, args []string) { },
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -27,16 +24,5 @@ func Execute() {
 }
 
 func init() {
-	// Here you will define your flags and configuration settings.
-	// Cobra supports persistent flags, which, if defined here,
-	// will be global for your application.
-
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.polyculeconnect.yaml)")
-
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	// rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
-
-	// Disable the default `completion` command to generate the autocompletion files
 	RootCmd.Root().CompletionOptions.DisableDefaultCmd = true
 }

polyculeconnect/cmd/serve/serve.go

@@ -43,11 +43,11 @@ func serve() {
 	logger.L.Infof("Initialized storage backend %q", conf.StorageType)
 	dexConf := dex_server.Config{
 		Web: dex_server.WebConfig{
-			Dir:   "./",
+			Dir:   conf.StaticDir,
 			Theme: "default",
 		},
 		Storage:                storageType,
-		Issuer:                 conf.OpenConnectConfig.Issuer,
+		Issuer:                 conf.Issuer,
 		SupportedResponseTypes: []string{"code"},
 		SkipApprovalScreen:     false,
 		AllowedOrigins:         []string{"*"},
@@ -71,20 +71,6 @@ func serve() {
 		logger.L.Errorf("Failed to add connector for backend RefuseAll to stage: %s", err.Error())
 	}
 
-	for _, backend := range conf.OpenConnectConfig.BackendConfigs {
-		if err := services.CreateConnector(backend, &dexConf, connectorIDs); err != nil {
-			logger.L.Errorf("Failed to add connector for backend %q to stage: %s", backend.Name, err.Error())
-			continue
-		}
-	}
-
-	logger.L.Info("Initializing clients")
-	for _, client := range conf.OpenConnectConfig.ClientConfigs {
-		if err := dexConf.Storage.CreateClient(*client); err != nil {
-			logger.L.Errorf("Failed to add client to storage: %s", err.Error())
-		}
-	}
-
 	dexSrv, err := dex_server.NewServer(mainCtx, dexConf)
 	if err != nil {
 		logger.L.Fatalf("Failed to init dex server: %s", err.Error())
@@ -127,15 +113,5 @@ func serve() {
 
 func init() {
 	cmd.RootCmd.AddCommand(serveCmd)
-
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// serveCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// serveCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 	serveCmd.Flags().StringVarP(&configPath, "config", "c", "config.json", "Path to the JSON configuration file")
 }

polyculeconnect/config/config.go

@@ -8,31 +8,13 @@ import (
 	"os"
 
 	"github.com/dexidp/dex/connector/oidc"
-	"github.com/dexidp/dex/storage"
+	"github.com/kelseyhightower/envconfig"
 	"github.com/sirupsen/logrus"
 )
 
-type envVar string
-
 const (
-	varLogLevel envVar = "LOG_LEVEL"
+	envConfigPrefix   = "POLYCULECONNECT"
-
+	DefaultConfigPath = "/etc/polyculeconnect.json"
-	varServerMode   envVar = "SERVER_MODE"
-	varServerHost   envVar = "SERVER_HOST"
-	varServerPort   envVar = "SERVER_PORT"
-	varServerSocket envVar = "SERVER_SOCK_PATH"
-
-	varIssuer envVar = "ISSUER"
-
-	varStorageType      envVar = "STORAGE_TYPE"
-	varStorageFile      envVar = "STORAGE_FILEPATH"
-	varStorageHost      envVar = "STORAGE_HOST"
-	varStoragePort      envVar = "STORAGE_PORT"
-	varStorageDB        envVar = "STORAGE_DB"
-	varStorageUser      envVar = "STORAGE_USER"
-	varStoragePassword  envVar = "STORAGE_PASSWORD"
-	varStorageSSLMode   envVar = "STORAGE_SSL_MODE"
-	varStorageSSLCaFile envVar = "STORAGE_SSL_CA_FILE"
 )
 
 type ListeningMode string
@@ -52,12 +34,13 @@ const (
 const (
 	defaultLogLevel = logrus.InfoLevel
 
-	defaultServerMode   = ModeNet
+	defaultServerMode      = ModeNet
-	defaultServerHost   = "0.0.0.0"
+	defaultServerHost      = "0.0.0.0"
-	defaultServerPort   = 5000
+	defaultServerPort      = 5000
-	defaultServerSocket = ""
+	defaultServerSocket    = ""
+	defaultServerStaticDir = "./"
 
-	defaultIssuer = "locahost"
+	defaultIssuer = "http://localhost:5000"
 
 	defaultStorageType      = Memory
 	defaultStorageFile      = "./polyculeconnect.db"
@@ -79,39 +62,104 @@ type BackendConfig struct {
 	Local  bool              `json:"local"`
 }
 
-// Deprecated: remove when we finally drop the JSON config
+type SSLStorageConfig struct {
-type OpenConnectConfig struct {
+	Mode   string `json:"mode" envconfig:"STORAGE_SSL_MODE"`
-	ClientConfigs  []*storage.Client `json:"clients"`
+	CaFile string `json:"ca_file" envconfig:"STORAGE_SSL_CA_FILE"`
-	BackendConfigs []*BackendConfig  `json:"backends"`
-	Issuer         string            `json:"issuer"`
 }
 
 type StorageConfig struct {
-	File     string
+	File     string `envconfig:"STORAGE_PATH"`
-	Host     string
+	Host     string `envconfig:"STORAGE_HOST"`
-	Port     int
+	Port     int    `envconfig:"STORAGE_PORT"`
-	Database string
+	Database string `envconfig:"STORAGE_DATABASE"`
-	User     string
+	User     string `envconfig:"STORAGE_USER"`
-	Password string
+	Password string `envconfig:"STORAGE_PASSWORD"`
-	Ssl      struct {
+	SSL      SSLStorageConfig
-		Mode   string
+}
-		CaFile string
+
-	}
+type logConfig struct {
+	Level string `json:"level"`
+}
+
+type serverConfig struct {
+	Mode string `json:"mode"`
+	Host string `json:"host"`
+	Port int    `json:"port"`
+	Sock string `json:"sock"`
+}
+
+type jsonStorageConfig struct {
+	Type     string           `json:"type"`
+	File     string           `json:"path"`
+	Host     string           `json:"host" `
+	Port     int              `json:"port"`
+	Database string           `json:"database" `
+	User     string           `json:"user" `
+	Password string           `json:"password" `
+	SSL      SSLStorageConfig `json:"ssl"`
 }
 
 type jsonConf struct {
-	OpenConnectConfig *OpenConnectConfig `json:"openconnect"`
+	LogConfig     logConfig         `json:"log"`
+	ServerConfig  serverConfig      `json:"server"`
+	StorageConfig jsonStorageConfig `json:"storage"`
+}
+
+func (c *jsonConf) initValues(ac *AppConfig) {
+	c.LogConfig = logConfig{Level: ac.LogLevel.String()}
+	c.ServerConfig = serverConfig{
+		Mode: string(ac.ServerMode),
+		Host: ac.Host,
+		Port: ac.Port,
+		Sock: ac.SockPath,
+	}
+	c.StorageConfig = jsonStorageConfig{
+		Type:     ac.StorageType,
+		File:     ac.StorageConfig.File,
+		Host:     ac.StorageConfig.Host,
+		Port:     ac.StorageConfig.Port,
+		Database: ac.StorageConfig.Database,
+		User:     ac.StorageConfig.User,
+		Password: ac.StorageConfig.Password,
+		SSL:      ac.StorageConfig.SSL,
+	}
 }
 
 type AppConfig struct {
-	LogLevel          logrus.Level
+	LogLevel      logrus.Level  `envconfig:"LOG_LEVEL"`
-	ServerMode        ListeningMode
+	ServerMode    ListeningMode `envconfig:"SERVER_MODE"`
-	Host              string
+	Host          string        `envconfig:"SERVER_HOST"`
-	Port              int
+	Port          int           `envconfig:"SERVER_PORT"`
-	SockPath          string
+	SockPath      string        `envconfig:"SERVER_SOCK"`
-	StorageType       string
+	StorageType   string        `envconfig:"STORAGE_TYPE"`
-	StorageConfig     *StorageConfig
+	StorageConfig *StorageConfig
-	OpenConnectConfig *OpenConnectConfig
+	Issuer        string
+	StaticDir     string
+}
+
+func defaultConfig() AppConfig {
+	return AppConfig{
+		LogLevel:    defaultLogLevel,
+		ServerMode:  defaultServerMode,
+		Host:        defaultServerHost,
+		Port:        defaultServerPort,
+		SockPath:    defaultServerSocket,
+		StorageType: string(defaultStorageType),
+		StorageConfig: &StorageConfig{
+			File:     defaultStorageFile,
+			Host:     defaultStorageHost,
+			Port:     defaultServerPort,
+			Database: defaultStorageDB,
+			User:     defaultStorageUser,
+			Password: defaultStoragePassword,
+			SSL: SSLStorageConfig{
+				Mode:   defaultStorageSSLMode,
+				CaFile: defaultStorageSSLCaFile,
+			},
+		},
+		Issuer:    defaultIssuer,
+		StaticDir: defaultServerStaticDir,
+	}
 }
 
 func parseLevel(lvlStr string) logrus.Level {
@@ -125,45 +173,36 @@ func parseLevel(lvlStr string) logrus.Level {
 
 func (ac *AppConfig) UnmarshalJSON(data []byte) error {
 	var jsonConf jsonConf
+	jsonConf.initValues(ac)
+
 	if err := json.Unmarshal(data, &jsonConf); err != nil {
 		return fmt.Errorf("failed to read JSON: %w", err)
 	}
-	ac.OpenConnectConfig = jsonConf.OpenConnectConfig
+
-	if ac.OpenConnectConfig == nil {
+	ac.LogLevel = parseLevel(jsonConf.LogConfig.Level)
-		ac.OpenConnectConfig = &OpenConnectConfig{}
+
-	}
+	ac.ServerMode = ListeningMode(jsonConf.ServerConfig.Mode)
+	ac.Host = jsonConf.ServerConfig.Host
+	ac.Port = jsonConf.ServerConfig.Port
+	ac.SockPath = jsonConf.ServerConfig.Sock
+
+	ac.StorageType = jsonConf.StorageConfig.Type
+	ac.StorageConfig.File = jsonConf.StorageConfig.File
+	ac.StorageConfig.Host = jsonConf.StorageConfig.Host
+	ac.StorageConfig.Port = jsonConf.StorageConfig.Port
+	ac.StorageConfig.Database = jsonConf.StorageConfig.Database
+	ac.StorageConfig.User = jsonConf.StorageConfig.User
+	ac.StorageConfig.Password = jsonConf.StorageConfig.Password
+	ac.StorageConfig.SSL = jsonConf.StorageConfig.SSL
 	return nil
 }
 
-func (ac *AppConfig) getConfFromEnv() {
-	ac.LogLevel = parseLevel(getStringFromEnv(varLogLevel, defaultLogLevel.String()))
-
-	ac.ServerMode = ListeningMode(getStringFromEnv(varServerMode, string(defaultServerMode)))
-	ac.Host = getStringFromEnv(varServerHost, defaultServerHost)
-	ac.Port = getIntFromEnv(varServerPort, defaultServerPort)
-	ac.SockPath = getStringFromEnv(varServerSocket, defaultServerSocket)
-
-	ac.StorageType = getStringFromEnv(varStorageType, string(defaultStorageType))
-	ac.StorageConfig.Database = getStringFromEnv(varStorageDB, defaultStorageDB)
-	ac.StorageConfig.File = getStringFromEnv(varStorageFile, defaultStorageFile)
-	ac.StorageConfig.Host = getStringFromEnv(varStorageHost, defaultStorageHost)
-	ac.StorageConfig.Port = getIntFromEnv(varStoragePort, defaultStoragePort)
-	ac.StorageConfig.User = getStringFromEnv(varStorageUser, defaultStorageUser)
-	ac.StorageConfig.Password = getStringFromEnv(varStoragePassword, defaultStoragePassword)
-	ac.StorageConfig.Ssl.CaFile = getStringFromEnv(varStorageSSLCaFile, defaultStorageSSLCaFile)
-	ac.StorageConfig.Ssl.Mode = getStringFromEnv(varStorageSSLMode, defaultStorageSSLMode)
-
-	ac.OpenConnectConfig.Issuer = getStringFromEnv(varIssuer, defaultIssuer)
-}
-
 func (ac *AppConfig) RedirectURI() string {
-	return ac.OpenConnectConfig.Issuer + "/callback"
+	return ac.Issuer + "/callback"
 }
 
 func New(filepath string) (*AppConfig, error) {
-	var conf AppConfig
+	conf := defaultConfig()
-	conf.StorageConfig = &StorageConfig{}
-	conf.OpenConnectConfig = &OpenConnectConfig{}
 	content, err := os.ReadFile(filepath)
 	if err != nil {
 		if !errors.Is(err, fs.ErrNotExist) {
@@ -174,6 +213,14 @@ func New(filepath string) (*AppConfig, error) {
 			return nil, fmt.Errorf("failed to parse config file: %w", err)
 		}
 	}
-	conf.getConfFromEnv()
+	if err := envconfig.Process(envConfigPrefix, &conf); err != nil {
+		return nil, err
+	}
+	if err := envconfig.Process(envConfigPrefix, conf.StorageConfig); err != nil {
+		return nil, err
+	}
+	if err := envconfig.Process(envConfigPrefix, &conf.StorageConfig.SSL); err != nil {
+		return nil, err
+	}
 	return &conf, nil
 }

polyculeconnect/config/config_test.go

@@ -10,30 +10,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var defaultConfig = AppConfig{
-	LogLevel:    defaultLogLevel,
-	ServerMode:  defaultServerMode,
-	Host:        defaultServerHost,
-	Port:        defaultServerPort,
-	SockPath:    defaultServerSocket,
-	StorageType: string(defaultStorageType),
-	StorageConfig: &StorageConfig{
-		File:     defaultStorageFile,
-		Host:     defaultStorageHost,
-		Port:     defaultStoragePort,
-		Database: defaultStorageDB,
-		User:     defaultStorageUser,
-		Password: defaultStoragePassword,
-		Ssl: struct {
-			Mode   string
-			CaFile string
-		}{Mode: defaultStorageSSLMode, CaFile: defaultStorageSSLCaFile},
-	},
-	OpenConnectConfig: &OpenConnectConfig{
-		Issuer: defaultIssuer,
-	},
-}
-
 func initJson(t *testing.T, content string) string {
 	tmpPath := t.TempDir()
 	confPath := path.Join(tmpPath, "config.json")
@@ -52,14 +28,14 @@ func TestDefault(t *testing.T) {
 	t.Run("no file", func(t *testing.T) {
 		conf, err := New("/this/path/does/not/exist")
 		require.NoError(t, err)
-		assert.Equal(t, defaultConfig, *conf)
+		assert.Equal(t, defaultConfig(), *conf)
 	})
 
 	t.Run("empty config", func(t *testing.T) {
 		confPath := initJson(t, `{}`)
 		conf, err := New(confPath)
 		require.NoError(t, err)
-		assert.Equal(t, defaultConfig, *conf)
+		assert.Equal(t, defaultConfig(), *conf)
 	})
 }
 
@@ -72,11 +48,54 @@ func TestInvalidJSON(t *testing.T) {
 	assert.ErrorContains(t, err, errMsg)
 }
 
+func TestJSONConfig(t *testing.T) {
+	confPath := initJson(t, `{
+	"log": {"level":"info"},
+	"server": {
+		"mode": "net",
+		"host": "0.0.0.0",
+		"port": 1337
+	}
+}`)
+
+	conf, err := New(confPath)
+	require.NoError(t, err)
+
+	assert.Equal(t, ModeNet, conf.ServerMode)
+	assert.Equal(t, "0.0.0.0", conf.Host)
+	assert.Equal(t, 1337, conf.Port)
+}
+
+func TestJSONConfigOverriden(t *testing.T) {
+	confPath := initJson(t, `{
+	"log": {"level":"info"},
+	"server": {
+		"mode": "net",
+		"host": "0.0.0.0",
+		"port": 1337
+	}
+}`)
+
+	envVars := map[string]string{
+		string("POLYCULECONNECT_SERVER_MODE"): string(ModeUnix),
+		string("POLYCULECONNECT_SERVER_SOCK"): "/run/polyculeconnect.sock",
+	}
+	setEnv(t, envVars)
+
+	conf, err := New(confPath)
+	require.NoError(t, err)
+
+	assert.Equal(t, ModeUnix, conf.ServerMode)
+	assert.Equal(t, "0.0.0.0", conf.Host)
+	assert.Equal(t, 1337, conf.Port)
+	assert.Equal(t, "/run/polyculeconnect.sock", conf.SockPath)
+}
+
 func TestHostNetMode(t *testing.T) {
 	envVars := map[string]string{
-		string(varServerMode): string(ModeNet),
+		string("POLYCULECONNECT_SERVER_MODE"): string(ModeNet),
-		string(varServerHost): "127.0.0.1",
+		string("POLYCULECONNECT_SERVER_HOST"): "127.0.0.1",
-		string(varServerPort): "8888",
+		string("POLYCULECONNECT_SERVER_PORT"): "8888",
 	}
 	setEnv(t, envVars)
 
@@ -90,8 +109,8 @@ func TestHostNetMode(t *testing.T) {
 
 func TestHostSocketMode(t *testing.T) {
 	envVars := map[string]string{
-		string(varServerMode):   string(ModeUnix),
+		string("POLYCULECONNECT_SERVER_MODE"): string(ModeUnix),
-		string(varServerSocket): "/run/polyculeconnect.sock",
+		string("POLYCULECONNECT_SERVER_SOCK"): "/run/polyculeconnect.sock",
 	}
 	setEnv(t, envVars)
 
@@ -104,7 +123,7 @@ func TestHostSocketMode(t *testing.T) {
 
 func TestLogLevel(t *testing.T) {
 	envVars := map[string]string{
-		string(varLogLevel): "error",
+		string("POLYCULECONNECT_LOG_LEVEL"): "error",
 	}
 	setEnv(t, envVars)
 
@@ -114,22 +133,10 @@ func TestLogLevel(t *testing.T) {
 	assert.Equal(t, logrus.ErrorLevel, conf.LogLevel)
 }
 
-func TestLogLevelInvalidValue(t *testing.T) {
-	envVars := map[string]string{
-		string(varLogLevel): "toto",
-	}
-	setEnv(t, envVars)
-
-	conf, err := New("")
-	require.NoError(t, err)
-
-	assert.Equal(t, logrus.InfoLevel, conf.LogLevel) // if invalid, no error should occur, but info level should be used
-}
-
 func TestSqliteConfig(t *testing.T) {
 	envVars := map[string]string{
-		string(varStorageType): "sqlite",
+		string("POLYCULECONNECT_STORAGE_TYPE"): "sqlite",
-		string(varStorageFile): "/data/polyculeconnect.db",
+		string("POLYCULECONNECT_STORAGE_PATH"): "/data/polyculeconnect.db",
 	}
 	setEnv(t, envVars)
 
@@ -139,3 +146,40 @@ func TestSqliteConfig(t *testing.T) {
 	assert.Equal(t, string(SQLite), conf.StorageType)
 	assert.Equal(t, "/data/polyculeconnect.db", conf.StorageConfig.File)
 }
+
+func TestSqliteConfigJSON(t *testing.T) {
+	confPath := initJson(t, `{
+		"log": {"level":"info"},
+		"storage": {
+			"type": "sqlite",
+			"path": "/data/polyculeconnect.db"
+		}
+	}`)
+
+	conf, err := New(confPath)
+	require.NoError(t, err)
+
+	assert.Equal(t, string(SQLite), conf.StorageType)
+	assert.Equal(t, "/data/polyculeconnect.db", conf.StorageConfig.File)
+}
+
+func TestSqliteConfigJSONOverriden(t *testing.T) {
+	confPath := initJson(t, `{
+		"log": {"level":"info"},
+		"storage": {
+			"type": "sqlite",
+			"path": "/data/polyculeconnect.db"
+		}
+	}`)
+
+	envVars := map[string]string{
+		string("POLYCULECONNECT_STORAGE_PATH"): "/tmp/polyculeconnect.db",
+	}
+	setEnv(t, envVars)
+
+	conf, err := New(confPath)
+	require.NoError(t, err)
+
+	assert.Equal(t, string(SQLite), conf.StorageType)
+	assert.Equal(t, "/tmp/polyculeconnect.db", conf.StorageConfig.File)
+}

polyculeconnect/config/envvar.go

@@ -1,26 +0,0 @@
-package config
-
-import (
-	"os"
-	"strconv"
-)
-
-func getStringFromEnv(key envVar, defaultValue string) string {
-	val, ok := os.LookupEnv(string(key))
-	if !ok {
-		return defaultValue
-	}
-	return val
-}
-
-func getIntFromEnv(key envVar, defaultValue int) int {
-	rawVal, ok := os.LookupEnv(string(key))
-	if !ok {
-		return defaultValue
-	}
-	val, err := strconv.Atoi(rawVal)
-	if err != nil {
-		return defaultValue
-	}
-	return val
-}

polyculeconnect/controller/ui/static.go

@@ -15,22 +15,31 @@ import (
 const StaticRoute = "/static/"
 
 type StaticController struct {
+	baseDir string
+}
+
+func NewStaticController(baseDir string) *StaticController {
+	return &StaticController{
+		baseDir: baseDir,
+	}
 }
 
 func (sc *StaticController) ServeHTTP(w http.ResponseWriter, r *http.Request) {
-	fs := http.FileServer(http.Dir("./static"))
+	fs := http.FileServer(http.Dir(sc.baseDir + "/static"))
 	http.StripPrefix(StaticRoute, fs).ServeHTTP(w, r)
 }
 
 type IndexController struct {
 	l                     *logrus.Logger
 	downstreamConstroller http.Handler
+	baseDir               string
 }
 
-func NewIndexController(l *logrus.Logger, downstream http.Handler) *IndexController {
+func NewIndexController(l *logrus.Logger, downstream http.Handler, baseDir string) *IndexController {
 	return &IndexController{
 		l:                     l,
 		downstreamConstroller: downstream,
+		baseDir:               baseDir,
 	}
 }
 
@@ -39,9 +48,9 @@ func (ic IndexController) serveUI(w http.ResponseWriter, r *http.Request) (int,
 		"issuer": func() string { return "toto" },
 	}
 
-	lp := filepath.Join("templates", "index.html")
+	lp := filepath.Join(ic.baseDir, "templates", "index.html")
-	hdrTpl := filepath.Join("templates", "header.html")
+	hdrTpl := filepath.Join(ic.baseDir, "templates", "header.html")
-	footTpl := filepath.Join("templates", "footer.html")
+	footTpl := filepath.Join(ic.baseDir, "templates", "footer.html")
 	tmpl, err := template.New("index.html").Funcs(funcs).ParseFiles(hdrTpl, footTpl, lp)
 	if err != nil {
 		return http.StatusInternalServerError, -1, fmt.Errorf("failed to init template: %w", err)

polyculeconnect/go.mod

@@ -4,6 +4,7 @@ go 1.20
 
 require (
 	github.com/dexidp/dex v0.0.0-20231014000322-089f374d4f3e
+	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/prometheus/client_golang v1.17.0
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.7.0

polyculeconnect/go.sum

@@ -102,6 +102,8 @@ github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/jonboulle/clockwork v0.2.2 h1:UOGuzwb1PwsrDAObMuhUnj0p5ULPj8V/xJ7Kx9qUBdQ=
 github.com/jonboulle/clockwork v0.2.2/go.mod h1:Pkfl5aHPm1nk2H9h0bjmnJD/BcgbGXUBGnn1kMkgxc8=
+github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
+github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=

polyculeconnect/main.go

@@ -4,6 +4,7 @@ import (
 	"git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd"
 	_ "git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/app"
 	_ "git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/backend"
+	_ "git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/db"
 	_ "git.faercol.me/faercol/polyculeconnect/polyculeconnect/cmd/serve"
 )
 

polyculeconnect/server/server.go

@@ -64,8 +64,8 @@ func New(appConf *config.AppConfig, dexSrv *dex_server.Server, logger *logrus.Lo
 	}
 
 	controllers := map[string]http.Handler{
-		ui.StaticRoute: middlewares.WithLogger(&ui.StaticController{}, logger),
+		ui.StaticRoute: middlewares.WithLogger(ui.NewStaticController(appConf.StaticDir), logger),
-		"/":            middlewares.WithLogger(ui.NewIndexController(logger, dexSrv), logger),
+		"/":            middlewares.WithLogger(ui.NewIndexController(logger, dexSrv, appConf.StaticDir), logger),
 	}
 
 	m := http.NewServeMux()

polyculeconnect/static/scripts/approval.js

@@ -0,0 +1,5 @@
+let approvalForm = document.getElementById("approvalform");
+
+approvalForm.addEventListener("submit", (e) => {
+  handleSuccess();
+});

polyculeconnect/static/scripts/appstate.js

@@ -0,0 +1,17 @@
+const STATE_SUCCESS = "SUCCESS";
+const STATE_IN_PROGRESS = "IN PROGRESS"
+const STATE_EMPTY = "NO STATE"
+
+const stateKey = "appState"
+
+function getState() {
+  state = localStorage.getItem(stateKey);
+  if (state === null) {
+    return STATE_EMPTY;
+  }
+  return state;
+}
+
+function setState(value) {
+  localStorage.setItem(stateKey, value);
+}

polyculeconnect/static/scripts/error.js

@@ -0,0 +1,6 @@
+let backButton = document.getElementById("error-back");
+
+backButton.addEventListener("click", (e) => {
+  e.preventDefault();
+  goBackToLogin();
+});

polyculeconnect/static/scripts/form.js

@@ -0,0 +1,11 @@
+let connectorForm = document.getElementById("connectorform");
+
+connectorForm.addEventListener("submit", (e) => {
+  e.preventDefault();
+  let connectorName = document.getElementById("cname").value;
+  let rememberMe = document.getElementById("remember-me").checked;
+  if (rememberMe === true) {
+    localStorage.setItem(connectorNameKey, connectorName);
+  }
+  chooseConnector(connectorName);
+});

polyculeconnect/static/scripts/index.js

@@ -1,11 +1,47 @@
-let connectorForm = document.getElementById("connectorform");
+const connectorNameKey = "connectorName";
+const connectorIDParam = "connector_id";
 
-connectorForm.addEventListener("submit", (e) => {
+const urlParams = new URLSearchParams(window.location.search);
-  e.preventDefault();
 
+function chooseConnector(connectorName) {
   let nextURL = new URL(window.location.href);
-  let connectorName = document.getElementById("cname").value;
+  nextURL.searchParams.append(connectorIDParam, connectorName);
-  nextURL.searchParams.append("connector_id", connectorName)
+  setState(STATE_IN_PROGRESS);
-
   window.location.href = nextURL;
-});
+}
+
+// Clean the cache in case previous authentication didn't succeed
+// in order not to get stuck in a login loop
+function handleFailedState() {
+  if (getState() !== STATE_SUCCESS) {
+    localStorage.removeItem(connectorNameKey);
+  }
+}
+
+// Add the connector name to local storage in case the auth succeeded
+// and the remember-me box was checked
+function handleSuccess(connectorName) {
+  setState(STATE_SUCCESS);
+  if (localStorage.getItem(rememberMeKey)) {
+    localStorage.removeItem(rememberMeKey);
+    localStorage.setItem(connectorNameKey, connectorName);
+  }
+}
+
+function handleLoginPage() {
+  handleFailedState();
+  let connectorName = localStorage.getItem(connectorNameKey);
+  if (getState() === STATE_SUCCESS && connectorName != null) {
+    chooseConnector(connectorName);
+  }
+}
+
+function goBackToLogin() {
+  let nextURL = new URL(window.location.href);
+  nextURL.searchParams.delete(connectorIDParam);
+  window.location.href = nextURL;
+}
+
+if (window.location.pathname === "/auth" && !urlParams.has(connectorIDParam)) {
+  handleLoginPage();
+}

polyculeconnect/static/style/index.css

@@ -76,6 +76,15 @@ body {
     color: var(--subtext-1);
 }
 
+.form-checkbox {
+    cursor: pointer;
+}
+
+.form-checkbox-label {
+    color: var(--subtext-0);
+    font-size: small;
+}
+
 .button {
     border: none;
     color: var(--mantle);

polyculeconnect/templates/approval.html

@@ -1,5 +1,7 @@
 {{ template "header.html" . }}
 
+<script src="/static/scripts/approval.js" defer></script>
+
 <div class="container">
     <div class="container-content">
         {{ if .Scopes }}
@@ -14,7 +16,7 @@
         {{ end }}
     </div>
 
-    <div class="form-buttons">
+    <div class="form-buttons" id="approvalform">
         <form method="post" class="container-form">
             <input type="hidden" name="req" value="{{ .AuthReqID }}" />
             <input type="hidden" name="approval" value="approve">

polyculeconnect/templates/error.html

@@ -1,7 +1,10 @@
 {{ template "header.html" . }}
 
+<script src="/static/scripts/error.js" defer></script>
+
 <div class="container">
     <div class="container-content">
+        <button id="error-back" class="button button-cancel">Back</button>
         <h2>{{ .ErrType }}</h2>
         <p>{{ .ErrMsg }}</p>
     </div>

polyculeconnect/templates/header.html

@@ -16,6 +16,9 @@
     <link rel="mask-icon" href="/static/icons/safari-pinned-tab.svg" color="#5bbad5">
     <meta name="msapplication-TileColor" content="#9f00a7">
     <meta name="theme-color" content="#ffffff">
+    <script src="/static/scripts/appstate.js"></script>
+    <script src="/static/scripts/index.js"></script>
+
 </head>
 
 <body>

polyculeconnect/templates/login.html

@@ -1,6 +1,6 @@
 {{ template "header.html" . }}
 
-<script src="/static/scripts/index.js" defer></script>
+<script src="/static/scripts/form.js" defer></script>
 
 <div class="container">
     <div class="container-content">
@@ -12,6 +12,10 @@
             <div class="form-elements">
                 <input type="text" id="cname" name="connector_id" placeholder="Service name" required
                     class="form-input">
+                <div>
+                    <input type="checkbox" id="remember-me" name="remember_me" class="form-checkbox">
+                    <label for="remember-me" class="form-checkbox-label">Remember my choice</label>
+                </div>
             </div>
             <div class="form-buttons">
                 <input type="submit" class="button button-accept" value="Continue">