1
0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00
juanfont.headscale/db.go

305 lines
6.9 KiB
Go
Raw Normal View History

2020-06-21 12:32:08 +02:00
package headscale
import (
2022-07-06 13:39:10 +02:00
"context"
"database/sql/driver"
"encoding/json"
2020-06-21 12:32:08 +02:00
"errors"
"fmt"
2022-09-02 09:13:50 +02:00
"net/netip"
"time"
2020-06-21 12:32:08 +02:00
"github.com/glebarez/sqlite"
"github.com/rs/zerolog/log"
2021-06-24 15:44:19 +02:00
"gorm.io/driver/postgres"
"gorm.io/gorm"
"gorm.io/gorm/logger"
"tailscale.com/tailcfg"
2020-06-21 12:32:08 +02:00
)
2021-11-15 20:18:14 +01:00
const (
dbVersion = "1"
errValueNotFound = Error("not found")
)
2020-06-21 12:32:08 +02:00
2021-02-23 20:11:30 +01:00
// KV is a key-value store in a psql table. For future use...
2020-06-21 12:32:08 +02:00
type KV struct {
Key string
Value string
}
func (h *Headscale) initDB() error {
2021-07-04 21:40:46 +02:00
db, err := h.openDB()
2020-06-21 12:32:08 +02:00
if err != nil {
return err
}
2021-07-04 21:40:46 +02:00
h.db = db
if h.dbType == Postgres {
2022-01-30 15:53:40 +01:00
db.Exec(`create extension if not exists "uuid-ossp";`)
}
_ = db.Migrator().RenameColumn(&Machine{}, "ip_address", "ip_addresses")
2022-04-24 21:56:42 +02:00
_ = db.Migrator().RenameColumn(&Machine{}, "name", "hostname")
// GivenName is used as the primary source of DNS names, make sure
// the field is populated and normalized if it was not when the
// machine was registered.
_ = db.Migrator().RenameColumn(&Machine{}, "nickname", "given_name")
// If the Machine table has a column for registered,
// find all occourences of "false" and drop them. Then
// remove the column.
if db.Migrator().HasColumn(&Machine{}, "registered") {
log.Info().
Msg(`Database has legacy "registered" column in machine, removing...`)
machines := Machines{}
if err := h.db.Not("registered").Find(&machines).Error; err != nil {
log.Error().Err(err).Msg("Error accessing db")
}
for _, machine := range machines {
log.Info().
2022-04-24 21:56:42 +02:00
Str("machine", machine.Hostname).
Str("machine_key", machine.MachineKey).
Msg("Deleting unregistered machine")
if err := h.db.Delete(&Machine{}, machine.ID).Error; err != nil {
log.Error().
Err(err).
2022-04-24 21:56:42 +02:00
Str("machine", machine.Hostname).
Str("machine_key", machine.MachineKey).
Msg("Error deleting unregistered machine")
}
}
err := db.Migrator().DropColumn(&Machine{}, "registered")
if err != nil {
log.Error().Err(err).Msg("Error dropping registered column")
}
}
2021-06-24 15:44:19 +02:00
err = db.AutoMigrate(&Machine{})
if err != nil {
return err
}
if db.Migrator().HasColumn(&Machine{}, "given_name") {
machines := Machines{}
if err := h.db.Find(&machines).Error; err != nil {
log.Error().Err(err).Msg("Error accessing db")
}
for item, machine := range machines {
if machine.GivenName == "" {
normalizedHostname, err := NormalizeToFQDNRules(
machine.Hostname,
h.cfg.OIDC.StripEmaildomain,
)
if err != nil {
log.Error().
Caller().
Str("hostname", machine.Hostname).
Err(err).
Msg("Failed to normalize machine hostname in DB migration")
}
err = h.RenameMachine(&machines[item], normalizedHostname)
if err != nil {
log.Error().
Caller().
Str("hostname", machine.Hostname).
Err(err).
Msg("Failed to save normalized machine name in DB migration")
}
}
}
}
2021-06-24 15:44:19 +02:00
err = db.AutoMigrate(&KV{})
if err != nil {
return err
}
2021-06-24 15:44:19 +02:00
err = db.AutoMigrate(&Namespace{})
if err != nil {
return err
}
2021-06-24 15:44:19 +02:00
err = db.AutoMigrate(&PreAuthKey{})
if err != nil {
return err
}
2020-06-21 12:32:08 +02:00
2022-02-21 23:52:55 +01:00
_ = db.Migrator().DropTable("shared_machines")
2022-01-25 23:11:05 +01:00
err = db.AutoMigrate(&APIKey{})
if err != nil {
return err
}
err = h.setValue("db_version", dbVersion)
2021-11-14 16:46:09 +01:00
return err
2020-06-21 12:32:08 +02:00
}
2021-07-04 21:40:46 +02:00
func (h *Headscale) openDB() (*gorm.DB, error) {
2021-06-24 15:44:19 +02:00
var db *gorm.DB
var err error
var log logger.Interface
if h.dbDebug {
log = logger.Default
} else {
log = logger.Default.LogMode(logger.Silent)
}
2021-06-24 15:44:19 +02:00
switch h.dbType {
case Sqlite:
db, err = gorm.Open(
sqlite.Open(h.dbString+"?_synchronous=1&_journal_mode=WAL"),
&gorm.Config{
DisableForeignKeyConstraintWhenMigrating: true,
Logger: log,
},
)
db.Exec("PRAGMA foreign_keys=ON")
// The pure Go SQLite library does not handle locking in
// the same way as the C based one and we cant use the gorm
// connection pool as of 2022/02/23.
2022-02-22 20:04:52 +01:00
sqlDB, _ := db.DB()
sqlDB.SetMaxIdleConns(1)
2022-02-22 20:04:52 +01:00
sqlDB.SetMaxOpenConns(1)
sqlDB.SetConnMaxIdleTime(time.Hour)
case Postgres:
db, err = gorm.Open(postgres.Open(h.dbString), &gorm.Config{
DisableForeignKeyConstraintWhenMigrating: true,
Logger: log,
})
2021-06-24 15:44:19 +02:00
}
2020-06-21 12:32:08 +02:00
if err != nil {
return nil, err
}
2020-06-21 12:32:08 +02:00
return db, nil
}
2021-11-13 09:39:04 +01:00
// getValue returns the value for the given key in KV.
2020-06-21 12:32:08 +02:00
func (h *Headscale) getValue(key string) (string, error) {
var row KV
2021-11-13 09:36:45 +01:00
if result := h.db.First(&row, "key = ?", key); errors.Is(
result.Error,
gorm.ErrRecordNotFound,
) {
2021-11-15 20:18:14 +01:00
return "", errValueNotFound
2020-06-21 12:32:08 +02:00
}
2021-11-14 16:46:09 +01:00
2020-06-21 12:32:08 +02:00
return row.Value, nil
}
2021-11-13 09:39:04 +01:00
// setValue sets value for the given key in KV.
2020-06-21 12:32:08 +02:00
func (h *Headscale) setValue(key string, value string) error {
2021-11-15 17:15:50 +01:00
keyValue := KV{
2020-06-21 12:32:08 +02:00
Key: key,
Value: value,
}
2021-07-04 21:40:46 +02:00
2021-11-14 18:09:22 +01:00
if _, err := h.getValue(key); err == nil {
2021-11-15 17:15:50 +01:00
h.db.Model(&keyValue).Where("key = ?", key).Update("value", value)
2021-11-14 16:46:09 +01:00
2020-06-21 12:32:08 +02:00
return nil
}
2022-05-30 15:39:24 +02:00
if err := h.db.Create(keyValue).Error; err != nil {
return fmt.Errorf("failed to create key value pair in the database: %w", err)
}
2021-11-14 16:46:09 +01:00
2020-06-21 12:32:08 +02:00
return nil
}
func (h *Headscale) pingDB(ctx context.Context) error {
ctx, cancel := context.WithTimeout(ctx, time.Second)
2022-07-06 13:39:10 +02:00
defer cancel()
db, err := h.db.DB()
if err != nil {
return err
}
return db.PingContext(ctx)
}
// This is a "wrapper" type around tailscales
// Hostinfo to allow us to add database "serialization"
// methods. This allows us to use a typed values throughout
// the code and not have to marshal/unmarshal and error
// check all over the code.
type HostInfo tailcfg.Hostinfo
func (hi *HostInfo) Scan(destination interface{}) error {
switch value := destination.(type) {
case []byte:
return json.Unmarshal(value, hi)
case string:
return json.Unmarshal([]byte(value), hi)
default:
2022-07-29 17:35:21 +02:00
return fmt.Errorf("%w: unexpected data type %T", ErrMachineAddressesInvalid, destination)
}
}
// Value return json value, implement driver.Valuer interface.
func (hi HostInfo) Value() (driver.Value, error) {
bytes, err := json.Marshal(hi)
return string(bytes), err
}
2022-09-02 09:13:50 +02:00
type IPPrefixes []netip.Prefix
func (i *IPPrefixes) Scan(destination interface{}) error {
switch value := destination.(type) {
case []byte:
return json.Unmarshal(value, i)
case string:
return json.Unmarshal([]byte(value), i)
default:
2022-07-29 17:35:21 +02:00
return fmt.Errorf("%w: unexpected data type %T", ErrMachineAddressesInvalid, destination)
}
}
// Value return json value, implement driver.Valuer interface.
func (i IPPrefixes) Value() (driver.Value, error) {
bytes, err := json.Marshal(i)
return string(bytes), err
}
type StringList []string
func (i *StringList) Scan(destination interface{}) error {
switch value := destination.(type) {
case []byte:
return json.Unmarshal(value, i)
case string:
return json.Unmarshal([]byte(value), i)
default:
2022-07-29 17:35:21 +02:00
return fmt.Errorf("%w: unexpected data type %T", ErrMachineAddressesInvalid, destination)
}
}
// Value return json value, implement driver.Valuer interface.
func (i StringList) Value() (driver.Value, error) {
bytes, err := json.Marshal(i)
return string(bytes), err
}