pcmt/run.go

247 lines
6.8 KiB
Go
Raw Normal View History

2023-05-20 20:15:57 +02:00
// Copyright 2023 wanderer <a_mirre at utb dot cz>
// SPDX-License-Identifier: AGPL-3.0-only
package main
import (
2023-03-22 22:56:25 +01:00
"context"
"flag"
"fmt"
"net/http"
2023-03-22 22:56:25 +01:00
"os"
"os/signal"
"strconv"
"syscall"
2023-03-22 22:56:25 +01:00
"time"
"golang.org/x/exp/slog"
// pure go postgres driver.
_ "github.com/lib/pq"
// ent pure go sqlite3 driver instead of "github.com/mattn/go-sqlite3".
_ "github.com/xiaoqidun/entps"
"git.dotya.ml/mirre-mt/pcmt/app"
"git.dotya.ml/mirre-mt/pcmt/app/settings"
"git.dotya.ml/mirre-mt/pcmt/config"
"git.dotya.ml/mirre-mt/pcmt/ent"
2023-05-05 22:52:59 +02:00
moddb "git.dotya.ml/mirre-mt/pcmt/modules/db"
2023-04-19 05:30:52 +02:00
"git.dotya.ml/mirre-mt/pcmt/slogging"
)
const (
2023-04-19 21:22:00 +02:00
banner = `
`
slug = `Password Compromise Monitoring Tool
https://git.dotya.ml/mirre-mt/pcmt
2023-04-19 23:36:12 +02:00
____________________________________`
licenseHeader = `pcmt - Password Compromise Monitoring Tool
Copyright (C) git.dotya.ml/wanderer
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.`
)
var (
host = flag.String("host", "unset", "host address to listen on")
2023-05-23 16:37:33 +02:00
port = flag.Int("port", 0, "TCP port to listen on")
configFlag = flag.String("config", "config.dhall", "Default path of the config file")
configIsPathFlag = flag.Bool("configIsPath", true, "Whether the provided config is path or raw config")
devel = flag.Bool("devel", false, "Run the application in dev mode, connect to a local browser-sync instance for hot-reloading")
license = flag.Bool("license", false, "Print licensing information and exit")
version = "dev"
// the global logger.
2023-05-11 17:06:20 +02:00
slogger *slogging.Slogger
// local logger instance.
2023-05-11 17:06:20 +02:00
log slogging.Slogger
)
func run() error {
flag.Parse()
2023-04-19 23:36:12 +02:00
if *license {
fmt.Fprintln(os.Stderr, licenseHeader)
return nil
2023-04-19 23:36:12 +02:00
}
printHeader()
2023-05-17 13:21:14 +02:00
// TODO: allow different configuration formats (toml, ini)
// TODO: rename main.go to pcmt.go
// TODO: add flake.nix
// TODO: SBOM: https://actuated.dev/blog/sbom-in-github-actions
// TODO: SBOM: https://www.docker.com/blog/generate-sboms-with-buildkit/
2023-05-17 13:21:14 +02:00
// TODO: integrate with Graylog (https://github.com/samber/slog-graylog).
2023-05-17 20:55:09 +02:00
// TODO: add mailer (https://github.com/wneessen/go-mail).
// TODO: deploy containers with podman using Ansible (https://www.redhat.com/sysadmin/automate-podman-ansible)
// TODO: add health checks for pod's containers (db, app)
2023-05-13 19:44:32 +02:00
conf, err := config.Load(*configFlag, *configIsPathFlag)
if err != nil {
2023-05-21 18:59:12 +02:00
return fmt.Errorf("couldn't load the configuration (isPath: '%t') '%s', full err: %w",
*configIsPathFlag, *configFlag, err,
)
}
setting := settings.New()
setting.Consolidate(
conf, host, port, devel, version,
)
2023-05-11 17:06:20 +02:00
slogger = slogging.Logger() // init is performed in the config package.
log = *slogger // local copy.
log.Logger = log.Logger.With(
// local attrs.
slog.Group("pcmt extra", slog.String("module", "run")),
)
// expected connstring form for "github.com/xiaoqidun/entps":
// "file:ent?mode=memory&cache=shared&_fk=1"
// and for the postgres driver "github.com/lib/pq":
// "host=127.0.0.1 sslmode=disable port=5432 user=postgres dbname=postgres password=postgres".
connstr := os.Getenv("PCMT_CONNSTRING")
dbtype := os.Getenv("PCMT_DBTYPE")
// check and bail early.
switch {
case connstr == "" || dbtype == "":
log.Errorf("PCMT_CONNSTRING or PCMT_DBTYPE or *both* were UNSET, bailing...")
return errDBNotConfigured
case dbtype != "postgres" && dbtype != "sqlite3":
log.Errorf("unsupported DB type specified, bailing...")
return errUnsupportedDBType
2023-05-17 20:40:24 +02:00
default:
setting.SetDbConnstring(connstr)
// type can be one of "postgres" or "sqlite3".
setting.SetDbType(dbtype)
}
2023-04-19 21:41:51 +02:00
2023-04-19 05:30:52 +02:00
log.Infof("connecting to db at '%s'", connstr)
2023-04-19 21:41:51 +02:00
db, err := ent.Open(setting.DbType(), setting.DbConnstring())
if err != nil {
return fmt.Errorf("failed to open a connection to database: %v", err)
}
defer db.Close()
ctx := context.WithValue(context.Background(), moddb.CtxKey{}, slogger)
2023-05-05 22:52:59 +02:00
log.Info("ensuring the db is set up and attempting to automatically migrate db schema")
2023-05-05 22:52:59 +02:00
// make sure the database is set up and optionally creates an administrator
// user (only when setting up the db).
if err = moddb.SetUp(ctx, db, setting.InitCreateAdmin(), setting.InitAdminPassword()); err != nil {
2023-05-05 22:52:59 +02:00
return err
}
setting.SetDbIsSetUp(true)
a := &app.App{}
2023-05-17 20:40:24 +02:00
if err = a.Init(setting, slogger, db); err != nil {
return err
}
a.PrintConfiguration()
a.SetEmbeds(templates, assets)
2023-05-31 22:42:50 +02:00
if err = a.SetupRoutes(); err != nil {
return err
}
a.SetEchoSettings()
2023-05-21 16:00:22 +02:00
if err = setting.EraseENVs(); err != nil {
log.Error("failed to erase PCMT ENVs")
return err
}
log.Debug("erased PCMT ENVs")
e := a.E()
// channel used to check whether the app had troubles starting up.
started := make(chan error, 1)
2023-05-03 05:58:09 +02:00
defer close(started)
go func(ok chan error) {
p := setting.Port()
h := setting.Host()
address := h + ":" + strconv.Itoa(p)
2023-05-03 05:58:09 +02:00
if err := e.Start(address); err != nil && err != http.ErrServerClosed {
log.Error("troubles running the server, bailing...", "error", err)
2023-05-03 05:58:09 +02:00
started <- err
2023-05-03 05:58:09 +02:00
return
2023-03-22 22:56:25 +01:00
}
2023-05-03 05:58:09 +02:00
started <- nil
}(started)
2023-05-03 05:58:09 +02:00
quit := make(chan os.Signal, 1)
signal.Notify(quit, os.Interrupt)
signal.Notify(quit, syscall.SIGTERM)
signal.Notify(quit, syscall.SIGHUP)
// non-blocking channel receive.
select {
case err := <-started:
if err != nil {
return err
}
2023-05-03 05:58:09 +02:00
case <-quit:
shutdownTimeout := 10 * time.Second
2023-03-22 22:56:25 +01:00
2023-05-03 05:58:09 +02:00
ctx, cancel := context.WithTimeout(context.Background(), shutdownTimeout)
defer func() {
log.Infof("Interrupt received, gracefully shutting down the server (timeout %s)", shutdownTimeout)
cancel()
2023-03-22 22:56:25 +01:00
2023-05-03 05:58:09 +02:00
signal.Stop(quit)
2023-04-19 21:41:51 +02:00
2023-05-03 05:58:09 +02:00
close(quit)
2023-05-03 05:58:09 +02:00
log.Info("Bye!")
}()
2023-05-03 05:58:09 +02:00
if err = e.Shutdown(ctx); err != nil {
log.Error("There was an error shutting the server down")
return err
}
}
return nil
}
func printHeader() {
2023-04-19 21:22:00 +02:00
fmt.Fprintf(os.Stderr,
2023-04-19 23:36:12 +02:00
"\033[34m%s%s\033[0m\n\n\n",
2023-04-19 21:22:00 +02:00
banner,
slug,
)
}