Documentation
¶
Index ¶
- Constants
- type Filter
- type FilterFunc
- type Index
- func (i *Index) All() []string
- func (i *Index) Clear()
- func (i *Index) Count(filter *Filter) int
- func (i *Index) Delete(path string)
- func (i *Index) Filter(filter *Filter) []string
- func (i *Index) FilterFunc(fn FilterFunc) []string
- func (i *Index) Get(path string) (*Metadata, bool)
- func (i *Index) GetAll() map[string]*Metadata
- func (i *Index) Has(path string) bool
- func (i *Index) Load() error
- func (i *Index) Save() error
- func (i *Index) Set(path string, metadata *Metadata) (*Metadata, bool)
- func (i *Index) SetFromTemplate(path string, tpl *templates.Template) (*Metadata, bool)
- func (i *Index) Size() int
- type Metadata
Constants ¶
const ( // IndexFileName is the name of the persistent cache file. IndexFileName = "index.gob" // IndexVersion is the schema version for cache invalidation on breaking // changes. IndexVersion = 1 // DefaultMaxSize is the default maximum number of templates to cache. DefaultMaxSize = 50000 // DefaultMaxWeight is the default maximum weight of the cache. DefaultMaxWeight = DefaultMaxSize * 800 // ~40MB assuming ~800B/entry )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Filter ¶
type Filter struct {
// Authors to include.
Authors []string
// Tags to include.
Tags []string
// ExcludeTags to exclude (takes precedence over Tags).
ExcludeTags []string
// IncludeTags to force include even if excluded.
IncludeTags []string
// IDs to include (supports wildcards, OR logic).
IDs []string
// ExcludeIDs to exclude (supports wildcards).
ExcludeIDs []string
// IncludeTemplates paths to force include even if excluded.
IncludeTemplates []string
// ExcludeTemplates paths to exclude.
ExcludeTemplates []string
// Severities to include.
Severities []severity.Severity
// ExcludeSeverities to exclude.
ExcludeSeverities []severity.Severity
// ProtocolTypes to include.
ProtocolTypes []types.ProtocolType
// ExcludeProtocolTypes to exclude.
ExcludeProtocolTypes []types.ProtocolType
}
Filter represents filtering criteria for template metadata.
Inclusion fields (e.g., Authors, Tags, IDs, Severities, ProtocolTypes) use AND logic across different filter types and OR logic within each type. Exclusion fields (e.g., ExcludeTags, ExcludeIDs, ExcludeSeverities, ExcludeProtocolTypes) take precedence over inclusion fields. Additionally, IncludeTemplates and IncludeTags can force inclusion of templates even if they match exclusion criteria.
func UnmarshalFilter ¶
func UnmarshalFilter( authors, tags, excludeTags, includeTags []string, ids, excludeIDs []string, includeTemplates, excludeTemplates []string, severities, excludeSeverities []string, protocolTypes, excludeProtocolTypes []string, ) (*Filter, error)
UnmarshalFilter creates a Filter from nuclei options.
type FilterFunc ¶
FilterFunc is a function that filters metadata.
func UnmarshalFilterFunc ¶
func UnmarshalFilterFunc(filter *Filter) FilterFunc
UnmarshalFilterFunc creates a FilterFunc from filter criteria.
type Index ¶
type Index struct {
// contains filtered or unexported fields
}
Index represents a cache for template metadata.
func NewDefaultIndex ¶
NewDefaultIndex creates a index with default settings in the default cache directory.
func (*Index) FilterFunc ¶
func (i *Index) FilterFunc(fn FilterFunc) []string
FilterFunc returns all template paths that match the given filter function.
func (*Index) Set ¶
Set stores metadata for a template path.
The caller is responsible for ensuring the metadata is valid and contains the correct checksum before calling this method. Use [SetFromTemplate] for automatic extraction and checksum computation.
Returns the metadata and whether it was successfully cached (false if evicted).
func (*Index) SetFromTemplate ¶
SetFromTemplate extracts metadata from a parsed template and stores it.
Returns the metadata and whether it was successfully cached. The metadata is always returned (even on checksum failure) for immediate filtering use. Returns false if the metadata was not cached (e.g., set, evicted).
type Metadata ¶
type Metadata struct {
// ID is the unique identifier of the template.
ID string `gob:"id"`
// FilePath is the path to the template file.
FilePath string `gob:"file_path"`
// ModTime is the modification time of the template file.
ModTime time.Time `gob:"mod_time"`
// Name is the name of the template.
Name string `gob:"name"`
// Authors are the authors of the template.
Authors []string `gob:"authors"`
// Tags are the tags associated with the template.
Tags []string `gob:"tags"`
// Severity is the severity level of the template.
Severity string `gob:"severity"`
// ProtocolType is the primary protocol type of the template.
ProtocolType string `gob:"protocol_type"`
// Verified indicates whether the template is verified.
Verified bool `gob:"verified"`
// TemplateVerifier is the verifier used for the template.
TemplateVerifier string `gob:"verifier,omitempty"`
}
Metadata contains lightweight metadata extracted from a template.
func NewMetadataFromTemplate ¶
NewMetadataFromTemplate creates a new metadata object from a template.
func (*Metadata) IsValid ¶
IsValid checks if the cached metadata is still valid by comparing the file modification time.
func (*Metadata) MatchesProtocol ¶
func (m *Metadata) MatchesProtocol(protocolType types.ProtocolType) bool
MatchesProtocol checks if the metadata matches the given protocol type.
Source Files