Merge pull request #6 from oidc-mytoken/dev

0.2.0

Author: zachmann

.github/workflows/go.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Set up Go 1.14
+    - name: Set up Go 1.16
       uses: actions/setup-go@v2
       with:
-        go-version: ^1.14
+        go-version: 1.16
       id: go
 
     - name: Check out code into the Go module directory

.github/workflows/release.yaml

@@ -0,0 +1,28 @@
+name: goreleaser
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      -
+        name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16
+      -
+        name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          version: latest
+          args: release --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -8,3 +8,4 @@ config/config.yaml
 IP2LOCATION-LITE-DB1.IPV6.BIN
 /cmd/test
 generateDDL.sh
+dist/

.goreleaser.yml

@@ -0,0 +1,97 @@
+project_name: mytoken-server
+before:
+  hooks:
+    - go mod tidy
+builds:
+  - id: server
+    main: ./cmd/mytoken-server/main.go
+    binary: mytoken-server
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+  #      - windows
+  #      - darwin
+  - id: setup
+    main: ./cmd/mytoken-server/mytoken-setup/setup.go
+    binary: mytoken-setup
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+  - id: garbage
+    main: ./cmd/mytoken-server/mytoken-dbGarbageCollector/main.go
+    binary: mytoken-dbgc
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+archives:
+  - replacements:
+      darwin: Darwin
+      linux: Linux
+      windows: Windows
+      386: i386
+      amd64: x86_64
+nfpms:
+  - id: server-pkg
+    package_name: mytoken-server
+    builds:
+      - server
+    homepage: https://mytoken-doc.data.kit.edu/server/intro
+    maintainer: Gabriel Zachmann <[email protected]>
+    description: Mytoken is a central web service with the goal to easily obtain OpenID Connect access tokens across devices.
+    license: MIT
+    formats:
+#      - apk
+      - deb
+      - rpm
+    release: 1
+    section: misc
+    empty_folders:
+      - /var/log/mytoken
+    contents:
+      - src: config/example-config.yaml
+        dst: /etc/mytoken/example-config.yaml
+        type: config
+      - src: config/mytoken.service
+        dst: /etc/systemd/system/mytoken.service
+  - id: setup-pkg
+    package_name: mytoken-server-setup
+    builds:
+      - setup
+    homepage: https://mytoken-doc.data.kit.edu/server/intro
+    maintainer: Gabriel Zachmann <[email protected]>
+    description: A setup utility for the mytoken-server
+    license: MIT
+    formats:
+      - deb
+      - rpm
+    release: 1
+    section: misc
+  - id: garbage-pkg
+    package_name: mytoken-server-dbgc
+    builds:
+      - garbage
+    homepage: https://mytoken-doc.data.kit.edu/server/intro
+    maintainer: Gabriel Zachmann <[email protected]>
+    description: A garbage collector for the mytoken database. It deletes expired entries.
+    license: MIT
+    formats:
+      - deb
+      - rpm
+    release: 1
+    section: misc
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+release:
+  draft: true
+  name_template: "{{.ProjectName}} {{.Version}}"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

README.md

@@ -1,7 +1,10 @@
 ![mytoken logo](https://git.scc.kit.edu/oidc/mytoken/-/raw/master/docs/img/mytoken.png)
 
 [![License](https://img.shields.io/github/license/oidc-mytoken/server.svg)](https://github.com/oidc-mytoken/server/blob/master/LICENSE)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/oidc-mytoken/server)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/oidc-mytoken/server/Go)
 [![Go Report](https://goreportcard.com/badge/github.com/oidc-mytoken/server)](https://goreportcard.com/report/github.com/oidc-mytoken/server)
+[![DeepSource](https://deepsource.io/gh/oidc-mytoken/server.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/oidc-mytoken/server/?ref=repository-badge)
 [![Release date](https://img.shields.io/github/release-date/oidc-mytoken/server.svg)](https://github.com/oidc-mytoken/server/releases/latest)
 [![Release version](https://img.shields.io/github/release/oidc-mytoken/server.svg)](https://github.com/oidc-mytoken/server/releases/latest)
 
@@ -16,6 +19,8 @@ The power of a super token can be restricted by the user, so he can create exact
 
 The mytoken command line client can be found at [https://github.com/oidc-mytoken/client](https://github.com/oidc-mytoken/client).
 
-Documentation is available at [https://docs-sdm.scc.kit.edu/mytoken](https://docs-sdm.scc.kit.edu/mytoken) (currently no public access).
+A go library for interacting with the mytoken server can be found at [https://github.com/oidc-mytoken/lib](https://github.com/oidc-mytoken/lib).
+
+Documentation is available at [https://mytoken-docs.data.kit.edu/](https://mytoken-docs.data.kit.edu/).
 
 A demo instance of mytoken is running at [https://mytoken.data.kit.edu/](https://mytoken.data.kit.edu/).

cmd/mytoken-server/main.go

@@ -25,9 +25,7 @@ func main() {
 	server.Init()
 	configurationEndpoint.Init()
 	authcode.Init()
-	if err := db.Connect(); err != nil {
-		log.WithError(err).Fatal()
-	}
+	db.Connect()
 	jws.LoadKey()
 	httpClient.Init(config.Get().IssuerURL)
 	geoip.Init()
@@ -56,9 +54,7 @@ func reload() {
 	config.Load()
 	loggerUtils.SetOutput()
 	loggerUtils.MustUpdateAccessLogger()
-	if err := db.Connect(); err != nil {
-		log.WithError(err).Fatal()
-	}
+	db.Connect()
 	jws.LoadKey()
 	geoip.Init()
 }

cmd/mytoken-server/mytoken-dbGarbageCollector/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"github.com/jmoiron/sqlx"
 	log "github.com/sirupsen/logrus"
 
 	"github.com/oidc-mytoken/server/internal/config"
@@ -11,21 +12,24 @@ import (
 func main() {
 	config.Load()
 	loggerUtils.Init()
-	if err := db.Connect(); err != nil {
-		log.WithError(err).Fatal()
-	}
+	db.Connect()
 	deleteExpiredTransferCodes()
 	deleteExpiredAuthInfo()
 }
 
-func deleteExpiredTransferCodes() {
-	if _, err := db.DB().Exec(`DELETE FROM ProxyTokens WHERE id = ANY(SELECT id FROM TransferCodesAttributes WHERE expires_at < CURRENT_TIMESTAMP())`); err != nil {
+func execSimpleQuery(sql string) {
+	if err := db.RunWithinTransaction(nil, func(tx *sqlx.Tx) error {
+		_, err := tx.Exec(sql)
+		return err
+	}); err != nil {
 		log.WithError(err).Error()
 	}
 }
 
+func deleteExpiredTransferCodes() {
+	execSimpleQuery(`DELETE FROM ProxyTokens WHERE id = ANY(SELECT id FROM TransferCodesAttributes WHERE expires_at < CURRENT_TIMESTAMP())`)
+}
+
 func deleteExpiredAuthInfo() {
-	if _, err := db.DB().Exec(`DELETE FROM AuthInfo WHERE expires_at < CURRENT_TIMESTAMP()`); err != nil {
-		log.WithError(err).Error()
-	}
+	execSimpleQuery(`DELETE FROM AuthInfo WHERE expires_at < CURRENT_TIMESTAMP()`)
 }

cmd/mytoken-server/mytoken-setup/setup.go

@@ -1,26 +1,27 @@
 package main
 
 import (
+	"database/sql"
 	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
 	"strings"
 
 	"github.com/Songmu/prompter"
-	"github.com/jessevdk/go-flags"
+	flags "github.com/jessevdk/go-flags"
 	"github.com/jmoiron/sqlx"
 	log "github.com/sirupsen/logrus"
 
 	"github.com/oidc-mytoken/server/internal/config"
-	"github.com/oidc-mytoken/server/internal/db"
+	"github.com/oidc-mytoken/server/internal/db/cluster"
 	"github.com/oidc-mytoken/server/internal/db/dbdefinition"
 	"github.com/oidc-mytoken/server/internal/jws"
 	"github.com/oidc-mytoken/server/internal/model"
 	loggerUtils "github.com/oidc-mytoken/server/internal/utils/logger"
 	"github.com/oidc-mytoken/server/internal/utils/zipdownload"
-	model2 "github.com/oidc-mytoken/server/pkg/model"
-	event "github.com/oidc-mytoken/server/shared/supertoken/event/pkg"
+	model2 "github.com/oidc-mytoken/server/shared/model"
+	event "github.com/oidc-mytoken/server/shared/mytoken/event/pkg"
 	"github.com/oidc-mytoken/server/shared/utils/fileutil"
 )
 
@@ -35,11 +36,19 @@ func main() {
 	loggerUtils.Init()
 
 	parser := flags.NewNamedParser("mytoken", flags.HelpFlag|flags.PassDoubleDash)
-	parser.AddCommand("signing-key", "Generates a new signing key", "Generates a new signing key according to the properties specified in the config file and stores it.", &genSigningKeyComm)
-	parser.AddCommand("db", "Setups the database", "Setups the database as needed and specified in the config file.", &createDBComm)
-	parser.AddCommand("install", "Installs needed dependencies", "", &installComm)
-	_, err := parser.Parse()
-	if err != nil {
+	if _, err := parser.AddCommand("signing-key", "Generates a new signing key", "Generates a new signing key according to the properties specified in the config file and stores it.", &genSigningKeyComm); err != nil {
+		log.WithError(err).Fatal()
+		os.Exit(1)
+	}
+	if _, err := parser.AddCommand("db", "Setups the database", "Setups the database as needed and specified in the config file.", &createDBComm); err != nil {
+		log.WithError(err).Fatal()
+		os.Exit(1)
+	}
+	if _, err := parser.AddCommand("install", "Installs needed dependencies", "", &installComm); err != nil {
+		log.WithError(err).Fatal()
+		os.Exit(1)
+	}
+	if _, err := parser.Parse(); err != nil {
 		var flagError *flags.Error
 		if errors.As(err, &flagError) {
 			if flagError.Type == flags.ErrHelp {
@@ -100,15 +109,15 @@ func (c *commandGenSigningKey) Execute(args []string) error {
 // Execute implements the flags.Commander interface
 func (c *commandCreateDB) Execute(args []string) error {
 	password := ""
-	if c.Password != nil && len(*c.Password) == 0 { // -p specified without argument
+	if c.Password != nil && *c.Password == "" { // -p specified without argument
 		password = prompter.Password("Database Password")
 	}
-	dsn := fmt.Sprintf("%s:%s@%s(%s)/", c.Username, password, "tcp", config.Get().DB.Host)
-	if err := db.ConnectDSN(dsn); err != nil {
-		return err
-	}
-	log.WithField("user", c.Username).Debug("Connected to database")
-	if err := checkDB(); err != nil {
+	db := cluster.NewFromConfig(config.DBConf{
+		Hosts:    config.Get().DB.Hosts,
+		User:     c.Username,
+		Password: password,
+	})
+	if err := checkDB(db); err != nil {
 		return err
 	}
 	err := db.Transact(func(tx *sqlx.Tx) error {
@@ -121,7 +130,7 @@ func (c *commandCreateDB) Execute(args []string) error {
 		if err := createTables(tx); err != nil {
 			return err
 		}
-		if err := addPredefinedValues(tx); err != nil {
+		if err := addPredefinedValues(tx); err != nil { // skipcq RVV-B0005
 			return err
 		}
 		return nil
@@ -160,7 +169,7 @@ func createTables(tx *sqlx.Tx) error {
 	}
 	for _, cmd := range dbdefinition.DDL {
 		cmd = strings.TrimSpace(cmd)
-		if len(cmd) > 0 && !strings.HasPrefix(cmd, "--") {
+		if cmd != "" && !strings.HasPrefix(cmd, "--") {
 			log.Trace(cmd)
 			if _, err := tx.Exec(cmd); err != nil {
 				return err
@@ -199,16 +208,21 @@ func createUser(tx *sqlx.Tx) error {
 	return nil
 }
 
-func checkDB() error {
+func checkDB(db *cluster.Cluster) error {
 	log.WithField("database", config.Get().DB.DB).Debug("Check if database already exists")
-	rows, err := db.DB().Query(`SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME=?`, config.Get().DB.DB)
-	if err != nil {
+	var rows *sql.Rows
+	if err := db.Transact(func(tx *sqlx.Tx) error {
+		var err error
+		rows, err = tx.Query(`SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME=?`, config.Get().DB.DB)
+		return err
+	}); err != nil {
 		return err
 	}
 	defer rows.Close()
 	if rows.Next() {
 		if !prompter.YesNo("The database already exists. If we continue all data will be deleted. Do you want to continue?", false) {
-			os.Exit(1)
+			_ = rows.Close()
+			os.Exit(1) // skipcq CRT-D0011
 		}
 	}
 	return nil