kits

Sep 25, 2023

Changes in this version

+ const Alert

type PackedScheduledSearch

+ GUID uuid.UUID

Jan 5, 2023

Changes in this version

type PackedResource

+ Labels []string

May 19, 2022

Changes in this version

type PackedScheduledSearch

+ Flow string

+ ScheduledType string

Aug 13, 2021

Changes in this version

type BuilderConfig

+ Readme string

type Manifest

+ Readme string

Apr 14, 2021

Changes in this version

+ const Dashboard

+ const External

+ const Extractor

+ const File

+ const License

+ const Macro

+ const ManifestName

+ const ManifestSigName

+ const Pivot

+ const Playbook

+ const Resource

+ const ScheduledSearch

+ const SearchLibrary

+ const Template

+ const Version

+ var ErrEmptyContent = errors.New("Empty data")

+ var ErrEmptyFileName = errors.New("Empty file name")

+ var ErrEmptyID = errors.New("Empty bundle ID")

+ var ErrEmptyName = errors.New("Empty name")

+ var ErrFailedSeek = errors.New("failed to seek on reader")

+ var ErrInvalidHash = errors.New("Invalid file hash")

+ var ErrInvalidImageID = errors.New("Invalid image ID, must be an existing file GUID")

+ var ErrInvalidSignature = errors.New("Invalid manifest signature")

+ var ErrInvalidType = errors.New("Invalid ItemType")

+ var ErrInvalidVersion = errors.New("Invalid kit Version")

+ var ErrManifestMismatch = errors.New("Manifest does not match kit")

+ var ErrMissingManifest = errors.New("Kit is missing a manifest")

+ var ErrMissingSignature = errors.New("Kit is missing a manifest signature")

+ var ErrNotActive = errors.New("Not active")

+ var ErrNotOpen = errors.New("Kit Reader is not open")

+ var ErrNotVerified = errors.New("Kit Reader has not verified the kit")

+ func GetHash(v []byte) [sha256.Size]byte

+ func GetKitItem(name string, tp ItemType, rdr io.Reader) (itm types.KitItem, err error)

+ type Builder struct

+ func NewBuilder(cfg BuilderConfig, fout io.WriteCloser) (pb *Builder, err error)

+ func NewBuilderFile(cfg BuilderConfig, output string) (pb *Builder, err error)

+ func (pb *Builder) Abort() error

+ func (pb *Builder) Add(name string, tp ItemType, v []byte) error

+ func (pb *Builder) AddFile(name string, tp ItemType, f *os.File) error

+ func (pb *Builder) AddReader(name string, tp ItemType, r io.Reader) error

+ func (pb *Builder) Close() (err error)

+ func (pb *Builder) Description() string

+ func (pb *Builder) ID() string

+ func (pb *Builder) Manifest() Manifest

+ func (pb *Builder) Name() string

+ func (pb *Builder) SetBanner(id string) error

+ func (pb *Builder) SetCover(id string) error

+ func (pb *Builder) SetIcon(id string) error

+ func (pb *Builder) WriteManifest(sig []byte) (err error)

+ type BuilderConfig struct

+ ConfigMacros []types.KitConfigMacro

+ Dependencies []types.KitDependency

+ Description string

+ ID string

+ MaxVersion types.CanonicalVersion

+ MinVersion types.CanonicalVersion

+ Name string

+ Version uint

+ func (c *BuilderConfig) Validate() error

+ type CallbackFunc func(name string, tp ItemType, hash [sha256.Size]byte, rdr io.Reader) error

+ type Item struct

+ Hash [sha256.Size]byte

+ Name string

+ Type ItemType

+ func (i *Item) UnmarshalJSON(v []byte) (err error)

+ func (i Item) Equal(ni Item) bool

+ func (i Item) Filename() string

+ func (i Item) MarshalJSON() ([]byte, error)

+ func (i Item) String() string

+ type ItemType int

+ func TranslateExt(ext string) (it ItemType, err error)

+ func TranslateType(tp string) (it ItemType, err error)

+ func (it ItemType) Ext() string

+ func (it ItemType) String() string

+ func (it ItemType) Valid() bool

+ type Manifest struct

+ Banner string

+ ConfigMacros []types.KitConfigMacro

+ Cover string

+ Dependencies []types.KitDependency

+ Desc string

+ ID string

+ Icon string

+ Items []Item

+ MaxVersion types.CanonicalVersion

+ MinVersion types.CanonicalVersion

+ Name string

+ Version uint

+ func Verify(rdr io.Reader, sigVerify SigVerificationFunc) (signed bool, manifest Manifest, err error)

+ func (m *Manifest) Add(item Item) error

+ func (m *Manifest) CompatibleVersion(v types.CanonicalVersion) (err error)

+ func (m *Manifest) Load(rdr io.Reader) error

+ func (m *Manifest) Marshal() ([]byte, error)

+ func (m *Manifest) SetBanner(id string) error

+ func (m *Manifest) SetCover(id string) error

+ func (m *Manifest) SetIcon(id string) error

+ func (m *Manifest) Unmarshal(v []byte) error

+ type PackedDashboard struct

+ Data types.RawObject

+ Description string

+ Labels []string

+ Name string

+ UUID string

+ func PackDashboard(d types.Dashboard) (pd PackedDashboard)

+ func (pd *PackedDashboard) JSONMetadata() (json.RawMessage, error)

+ func (pd *PackedDashboard) Validate() error

+ type PackedMacro struct

+ Description string

+ Expansion string

+ Labels []string

+ Name string

+ func PackSearchMacro(m *types.SearchMacro) (p PackedMacro)

+ func (pm *PackedMacro) JSONMetadata() (json.RawMessage, error)

+ func (pm *PackedMacro) Validate() error

+ type PackedResource struct

+ Data []byte

+ Description string

+ Hash []byte

+ ResourceName string

+ Size uint64

+ VersionNumber int

+ func PackResourceUpdate(ru types.ResourceUpdate) (p PackedResource)

+ func (p *PackedResource) JSONMetadata() (json.RawMessage, error)

+ func (p *PackedResource) Validate() error

+ type PackedScheduledSearch struct

+ DefaultDeploymentRules types.ScriptDeployConfig

+ Description string

+ Duration int64

+ Labels []string

+ Name string

+ Schedule string

+ Script string

+ SearchString string

+ func PackScheduledSearch(ss *types.ScheduledSearch) (p PackedScheduledSearch)

+ func (pss *PackedScheduledSearch) JSONMetadata() (json.RawMessage, error)

+ func (pss *PackedScheduledSearch) TypeName() string

+ func (pss *PackedScheduledSearch) Unpackage(uid, gid int32) (ss types.ScheduledSearch)

+ func (pss *PackedScheduledSearch) Validate() error

+ type Reader struct

+ func NewReader(rdr utils.ReadResetCloser, verify SigVerificationFunc) (rp *Reader, err error)

+ func (rp *Reader) Manifest() (m Manifest, err error)

+ func (rp *Reader) Process(cb CallbackFunc) (err error)

+ func (rp *Reader) Signed() (signed bool, err error)

+ func (rp *Reader) Verify() (err error)

+ type SigVerificationFunc func(manifest []byte, sig []byte) error