bootstrap

package

v0.0.0-...-ec844c3 Latest Latest Go to latest Published: Feb 25, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SpecterOps/bloodhound

Links

Documentation ¶

Index ¶

Constants
func ConnectGraph(ctx context.Context, cfg config.Configuration) (*graph.DatabaseSwitch, error)
func CreateDefaultAdmin(ctx context.Context, cfg config.Configuration, db database.Database, ...) error
func DefaultConfigFilePath() string
func EnsureServerDirectories(cfg config.Configuration) error
func FillAndPopulateDefaultAdminInfo(cfg config.DefaultAdminConfiguration, ...) (config.DefaultAdminConfiguration, bool, error)
func MigrateDB(ctx context.Context, cfg config.Configuration, db database.Database, ...) error
func NewDaemonContext(parentCtx context.Context) context.Context
func PopulateExtensionData(ctx context.Context, db database.Database) error
type DatabaseConnections
type DatabaseConstructor
type Initializer
- func (s Initializer[DBType, GraphType]) Launch(parentCtx context.Context, handleSignals bool) error
type InitializerLogic

Constants ¶

View Source

const (
	DefaultServerShutdownTimeout = time.Minute
	ContentSecurityPolicy        = "" /* 195-byte string literal not displayed */
)

Variables ¶

This section is empty.

Functions ¶

func ConnectGraph ¶

func ConnectGraph(ctx context.Context, cfg config.Configuration) (*graph.DatabaseSwitch, error)

func CreateDefaultAdmin ¶

func CreateDefaultAdmin(ctx context.Context, cfg config.Configuration, db database.Database, defaultAdminFunction func() (config.DefaultAdminConfiguration, error)) error

func DefaultConfigFilePath ¶

func DefaultConfigFilePath() string

DefaultConfigFilePath returns the location of the config file

func EnsureServerDirectories ¶

func EnsureServerDirectories(cfg config.Configuration) error

EnsureServerDirectories checks that all required server directories have been set up. If they haven't, it attempts to create them. If creation fails, it returns the error.

func FillAndPopulateDefaultAdminInfo ¶

func FillAndPopulateDefaultAdminInfo(cfg config.DefaultAdminConfiguration, defaultAdminFunction func() (config.DefaultAdminConfiguration, error)) (config.DefaultAdminConfiguration, bool, error)

FillAndPopulateDefaultAdminInfo will ensure that the default admin config has all of the necessary values for population in the DB

func MigrateDB ¶

func MigrateDB(ctx context.Context, cfg config.Configuration, db database.Database, defaultAdminFunc func() (config.DefaultAdminConfiguration, error)) error

MigrateDB runs database migrations on PG

func NewDaemonContext ¶

func NewDaemonContext(parentCtx context.Context) context.Context

func PopulateExtensionData ¶

func PopulateExtensionData(ctx context.Context, db database.Database) error

Types ¶

type DatabaseConnections ¶

type DatabaseConnections[DBType database.Database, GraphType graph.Database] struct {
	RDMS  DBType
	Graph GraphType
}

type DatabaseConstructor ¶

type DatabaseConstructor[DBType database.Database, GraphType graph.Database] func(ctx context.Context, cfg config.Configuration) (DatabaseConnections[DBType, GraphType], error)

type Initializer ¶

type Initializer[DBType database.Database, GraphType graph.Database] struct {
	Configuration       config.Configuration
	PreMigrationDaemons InitializerLogic[DBType, GraphType]
	Entrypoint          InitializerLogic[DBType, GraphType]
	DBConnector         DatabaseConstructor[DBType, GraphType]
}

func (Initializer[DBType, GraphType]) Launch ¶

func (s Initializer[DBType, GraphType]) Launch(parentCtx context.Context, handleSignals bool) error

type InitializerLogic ¶

type InitializerLogic[DBType database.Database, GraphType graph.Database] func(ctx context.Context, cfg config.Configuration, databaseConnections DatabaseConnections[DBType, GraphType]) ([]daemons.Daemon, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL