Documentation
¶
Overview ¶
Package subjects lists the entities evidence can name as its subject: defined components, SSP system components, parties and users.
Index ¶
Constants ¶
View Source
const MaxLookupIDs = 100
MaxLookupIDs is the most subjects one lookup by ID may name: one page at the largest page size.
Variables ¶
View Source
var AllKinds = []Kind{KindDefinedComponent, KindSystemComponent, KindParty, KindUser}
AllKinds lists every subject kind, in the order they're searched.
Functions ¶
This section is empty.
Types ¶
type IdentityLabel ¶
IdentityLabel is one identity label of a defined component.
type LinkedSSP ¶
type LinkedSSP struct {
SSPID uuid.UUID `json:"ssp-id"`
SSPTitle string `json:"ssp-title"`
ComponentID uuid.UUID `json:"component-id"`
ComponentTitle string `json:"component-title"`
}
LinkedSSP is an SSP system component linked to a defined component.
type ListParams ¶
type ListParams struct {
// Search matches titles case-insensitively.
Search string
// Kinds limits the kinds listed; empty means all.
Kinds []Kind
// SSPID limits system components to one SSP; other kinds are unaffected.
SSPID *uuid.UUID
// IDs limits the list to these subjects.
IDs []uuid.UUID
Limit int
Offset int
}
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
type Summary ¶
type Summary struct {
SubjectUUID uuid.UUID `json:"subject-uuid" gorm:"column:subject_uuid"`
// Type is the OSCAL subject type: component, party or user.
Type string `json:"type" gorm:"column:type"`
Kind Kind `json:"kind" gorm:"column:kind"`
Title string `json:"title" gorm:"column:title"`
// Context is what the subject belongs to: a defined component's component definition, or
// a system component's SSP.
Context *string `json:"context,omitempty" gorm:"column:context"`
// Identity is a defined component's identity labels: the evidence labels that identify it.
Identity []IdentityLabel `json:"identity,omitempty" gorm:"-"`
// LinkedSSPs are the SSP system components a defined component is linked to.
LinkedSSPs []LinkedSSP `json:"linked-ssps,omitempty" gorm:"-"`
}
Summary is an entity evidence can name as its subject.
Click to show internal directories.
Click to hide internal directories.