models

Documentation

Index

• type APIKey
• type AuthSchemeData
• type DefaultTag
• type Evidence
• type EvidenceFindingMap
• type EvidenceMetadata
• type Finding
• type FindingCategory
• type GlobalVar
• type LimitedAuthSchemeData
• type Operation
• type OperationVar
• type Query
• type QueuedEmail
• type ServiceWorker
• type Session
• type Tag
• type TagEvidenceMap
• type User
• type UserGroup
• type UserGroupMap
• type UserGroupOperationPermission
• type UserOperationPermission
• type UserOperationPreferences
• type UserWithAuthData
• type VarOperationMap

Types

type APIKey

type APIKey struct {
	ID        int64      `db:"id"`
	UserID    int64      `db:"user_id"`
	AccessKey string     `db:"access_key"`
	SecretKey []byte     `db:"secret_key"`
	LastAuth  *time.Time `db:"last_auth"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
}

APIKey reflects the structure of the database table 'api_keys'

type AuthSchemeData

type AuthSchemeData struct {
	ID int64 `db:"id"`
	// AuthScheme defines the name of the authentication method. e.g. Okta
	AuthScheme string `db:"auth_scheme"`
	// AuthType defines how the scheme should work. e.g. "oidc" or "local"
	AuthType          string         `db:"auth_type"`
	Username          string         `db:"username"`
	AuthnID           sql.NullString `db:"authn_id"`
	UserID            int64          `db:"user_id"`
	EncryptedPassword []byte         `db:"encrypted_password"`
	MustResetPassword bool           `db:"must_reset_password"`
	TOTPSecret        *string        `db:"totp_secret"`
	JSONData          *string        `db:"json_data"`
	LastLogin         *time.Time     `db:"last_login"`
	CreatedAt         time.Time      `db:"created_at"`
	UpdatedAt         *time.Time     `db:"updated_at"`
}

AuthSchemeData reflects the structure of the database table 'auth_scheme_data'

type DefaultTag

type DefaultTag struct {
	ID          int64      `db:"id"`
	Name        string     `db:"name"`
	ColorName   string     `db:"color_name"`
	Description *string    `db:"description"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

type Evidence

type Evidence struct {
	ID            int64      `db:"id"`
	UUID          string     `db:"uuid"`
	OperationID   int64      `db:"operation_id"`
	OperatorID    int64      `db:"operator_id"`
	Description   string     `db:"description"`
	ContentType   string     `db:"content_type"`
	FullImageKey  string     `db:"full_image_key"`
	ThumbImageKey string     `db:"thumb_image_key"`
	OccurredAt    time.Time  `db:"occurred_at"`
	CreatedAt     time.Time  `db:"created_at"`
	AdjustedAt    *time.Time `db:"adjusted_at"`
	UpdatedAt     *time.Time `db:"updated_at"`
}

Evidence reflects the structure of the database table 'evidence'

type EvidenceFindingMap

type EvidenceFindingMap struct {
	EvidenceID int64      `db:"evidence_id"`
	FindingID  int64      `db:"finding_id"`
	CreatedAt  time.Time  `db:"created_at"`
	UpdatedAt  *time.Time `db:"updated_at"`
}

EvidenceFindingMap reflects the structure of the database table 'evidence_finding_map'

type EvidenceMetadata

type EvidenceMetadata struct {
	ID             int64                    `db:"id"`
	EvidenceID     int64                    `db:"evidence_id"`
	Source         string                   `db:"source"`
	Body           string                   `db:"body"`
	Status         *evidencemetadata.Status `db:"status"`
	LastRunMessage *string                  `db:"last_run_message"`
	CanProcess     *bool                    `db:"can_process"`
	CreatedAt      time.Time                `db:"created_at"`
	WorkStartedAt  *time.Time               `db:"work_started_at"`
	UpdatedAt      *time.Time               `db:"updated_at"`
}

EvidenceMetadata reflects the structure of the database table 'evidence_metadata'

type Finding

type Finding struct {
	ID            int64      `db:"id"`
	UUID          string     `db:"uuid"`
	OperationID   int64      `db:"operation_id"`
	ReadyToReport bool       `db:"ready_to_report"`
	TicketLink    *string    `db:"ticket_link"`
	CategoryID    *int64     `db:"category_id"`
	Title         string     `db:"title"`
	Description   string     `db:"description"`
	CreatedAt     time.Time  `db:"created_at"`
	UpdatedAt     *time.Time `db:"updated_at"`
}

Finding reflects the structure of the database table 'findings'

type FindingCategory

type FindingCategory struct {
	ID        int64      `db:"id"`
	Category  string     `db:"category"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
	DeletedAt *time.Time `db:"deleted_at"`
}

type GlobalVar

type GlobalVar struct {
	ID        int64      `db:"id"`
	Name      string     `db:"name"`
	Value     string     `db:"value"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
}

GlobalVar reflects the structure of the database table 'global_vars'

type LimitedAuthSchemeData

type LimitedAuthSchemeData struct {
	AuthScheme string
	LastLogin  *time.Time
}

LimitedAuthSchemeData represents a partial AuthSchemeData model, exposing only the name of the scheme

type Operation

type Operation struct {
	ID        int64      `db:"id"`
	Slug      string     `db:"slug"`
	Name      string     `db:"name"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
}

Operation reflects the structure of the database table 'operations'

type OperationVar

type OperationVar struct {
	ID        int64      `db:"id"`
	Slug      string     `db:"slug"`
	Name      string     `db:"name"`
	Value     string     `db:"value"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
}

OperationVar reflects the structure of the database table 'operation_vars'

type Query

type Query struct {
	ID          int64      `db:"id"`
	OperationID int64      `db:"operation_id"`
	Name        string     `db:"name"`
	Query       string     `db:"query"`
	Type        string     `db:"type"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

Query reflects the structure of the database table 'queries'

type QueuedEmail

type QueuedEmail struct {
	ID          int64      `db:"id"`
	ToEmail     string     `db:"to_email"`
	UserID      int64      `db:"user_id"`
	Template    string     `db:"template"`
	EmailStatus string     `db:"email_status"`
	ErrorCount  int64      `db:"error_count"`
	ErrorText   *string    `db:"error_text"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

QueuedEmail reflects the structure of the database table 'email_queue'

type ServiceWorker

type ServiceWorker struct {
	ID        int64      `db:"id"`
	Name      string     `db:"name"`
	Config    string     `db:"config"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
	DeletedAt *time.Time `db:"deleted_at"`
}

ServiceWorker reflects the structure of the database table 'service_workers'

type Session

type Session struct {
	ID          int64      `db:"id"`
	UserID      int64      `db:"user_id"`
	SessionData []byte     `db:"session_data"`
	CreatedAt   time.Time  `db:"created_at"`
	ModifiedAt  *time.Time `db:"modified_at"`
	ExpiresAt   time.Time  `db:"expires_at"`
}

Session reflects the structure of the database table 'sessions'

type Tag

type Tag struct {
	ID          int64      `db:"id"`
	OperationID int64      `db:"operation_id"`
	Name        string     `db:"name"`
	ColorName   string     `db:"color_name"`
	Description *string    `db:"description"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

Tag reflects the structure of the database table 'tags'

type TagEvidenceMap

type TagEvidenceMap struct {
	TagID      int64      `db:"tag_id"`
	EvidenceID int64      `db:"evidence_id"`
	CreatedAt  time.Time  `db:"created_at"`
	UpdatedAt  *time.Time `db:"updated_at"`
}

TagEvidenceMap reflects the structure of the database table 'tag_evidence_map'

type User

type User struct {
	ID        int64      `db:"id"`
	Slug      string     `db:"slug"`
	FirstName string     `db:"first_name"`
	LastName  string     `db:"last_name"`
	Email     string     `db:"email"`
	Admin     bool       `db:"admin"`
	Disabled  bool       `db:"disabled"`
	Headless  bool       `db:"headless"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
	DeletedAt *time.Time `db:"deleted_at"`
}

User reflects the structure of the database table 'user'

type UserGroup

type UserGroup struct {
	ID        int64      `db:"id"`
	Slug      string     `db:"slug"`
	Name      string     `db:"name"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
	DeletedAt *time.Time `db:"deleted_at"`
}

Group reflects the structure of the database table 'user_groups'

type UserGroupMap

type UserGroupMap struct {
	GroupID   int64      `db:"group_id"`
	UserID    int64      `db:"user_id"`
	CreatedAt time.Time  `db:"created_at"`
	UpdatedAt *time.Time `db:"updated_at"`
}

TagEvidenceMap reflects the structure of the database table 'user_group_map'

type UserGroupOperationPermission

type UserGroupOperationPermission struct {
	UserGroupID int64                `db:"group_id"`
	OperationID int64                `db:"operation_id"`
	Role        policy.OperationRole `db:"role"`
	CreatedAt   time.Time            `db:"created_at"`
	UpdatedAt   *time.Time           `db:"updated_at"`
}

UserOperationPermission reflects the structure of the database table 'user_group_operation_permissions'

type UserOperationPermission

type UserOperationPermission struct {
	UserID      int64                `db:"user_id"`
	OperationID int64                `db:"operation_id"`
	Role        policy.OperationRole `db:"role"`
	CreatedAt   time.Time            `db:"created_at"`
	UpdatedAt   *time.Time           `db:"updated_at"`
}

UserOperationPermission reflects the structure of the database table 'user_operation_permissions'

type UserOperationPreferences

type UserOperationPreferences struct {
	UserID      int64      `db:"user_id"`
	OperationID int64      `db:"operation_id"`
	IsFavorite  bool       `db:"is_favorite"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

type UserWithAuthData

type UserWithAuthData struct {
	User
	AuthSchemeData []LimitedAuthSchemeData
}

UserWithAuthData represents a limited joining of users table with auth_scheme_data table

type VarOperationMap

type VarOperationMap struct {
	VarID       int64      `db:"var_id"`
	OperationID int64      `db:"operation_id"`
	CreatedAt   time.Time  `db:"created_at"`
	UpdatedAt   *time.Time `db:"updated_at"`
}

VarOperationMap reflects the structure of the database table 'var_operation_map'