skill

Documentation

Overview

Package skill provides core skill manipulation and security checking logic.

Package skill provides core skill manipulation, validation, and security checking logic.

Index

• func CalculateEntropy(s string) float64
• func CreateSkillTemplate(name, destDir string) error
• func FindSkillMD(skillPath string) bool
• func GenerateReport(result *CheckResult, format string) (string, error)
• func GenerateSARIFReport(result *CheckResult, version string) (string, error)
• type CheckResult
  • func CheckSafety(skillPath string) (*CheckResult, error)
• type Finding
• type Meta
  • func ParseSkillMD(skillPath string) (*Meta, error)
• type Rule
• type SARIFArtifactLocation
• type SARIFDriver
• type SARIFLocation
• type SARIFMessage
• type SARIFPhysicalLocation
• type SARIFRegion
• type SARIFReport
• type SARIFResult
• type SARIFRule
• type SARIFRuleConfig
• type SARIFRun
• type SARIFTool
• type ScanResult
  • func ScanDirectory(root string, limitDepth int) ([]ScanResult, error)
• type Severity
• type TemplateData
• type ValidationError
  • func ValidateMeta(meta *Meta, dirName string) []ValidationError

Functions

func CalculateEntropy

func CalculateEntropy(s string) float64

CalculateEntropy calculates the Shannon entropy of a string. Higher entropy indicates more randomness, which is common in secrets/keys.

func CreateSkillTemplate

func CreateSkillTemplate(name, destDir string) error

CreateSkillTemplate creates a new skill directory with template files

func FindSkillMD

func FindSkillMD(skillPath string) bool

FindSkillMD checks if a skill has a SKILL.md file

func GenerateReport

func GenerateReport(result *CheckResult, format string) (string, error)

GenerateReport generates a report in the specified format ("md", "html", or "json")

func GenerateSARIFReport

func GenerateSARIFReport(result *CheckResult, version string) (string, error)

GenerateSARIFReport generates a SARIF v2.1.0 formatted security report

Types

type CheckResult

type CheckResult struct {
	SkillName      string
	Findings       []Finding
	ScannedModules []string // List of all modules scanned, including clean ones
}

CheckResult contains all findings for a skill

func CheckSafety

func CheckSafety(skillPath string) (*CheckResult, error)

CheckSafety performs security checks on a skill directory

type Finding

type Finding struct {
	RuleID      string
	Severity    Severity
	Description string
	Module      string // The skill or module name where this finding occurred
	File        string
	Line        int
	Match       string
}

Finding represents a single security issue found in a skill

type Meta

type Meta struct {
	Name          string            `yaml:"name"`
	Description   string            `yaml:"description"`
	Version       string            `yaml:"version"`
	Author        string            `yaml:"author"`
	Dependencies  []string          `yaml:"dependencies"`
	Tags          []string          `yaml:"tags"`
	License       string            `yaml:"license"`
	Compatibility string            `yaml:"compatibility"`
	Metadata      map[string]string `yaml:"metadata"`
	AllowedTools  []string          `yaml:"allowed-tools"`
}

Meta represents metadata parsed from SKILL.md

func ParseSkillMD

func ParseSkillMD(skillPath string) (*Meta, error)

ParseSkillMD parses a SKILL.md file and extracts frontmatter metadata

type Rule

type Rule struct {
	ID          string
	Description string
	Severity    Severity
	Regex       *regexp.Regexp
	Entropy     float64 // Minimum entropy threshold (0 to ignore)
	Tags        []string
}

Rule represents a security check rule

type SARIFArtifactLocation

type SARIFArtifactLocation struct {
	URI string `json:"uri"`
}

type SARIFDriver

type SARIFDriver struct {
	Name    string      `json:"name"`
	Version string      `json:"version"`
	Rules   []SARIFRule `json:"rules,omitempty"`
}

type SARIFLocation

type SARIFLocation struct {
	PhysicalLocation SARIFPhysicalLocation `json:"physicalLocation"`
}

type SARIFMessage

type SARIFMessage struct {
	Text string `json:"text"`
}

type SARIFPhysicalLocation

type SARIFPhysicalLocation struct {
	ArtifactLocation SARIFArtifactLocation `json:"artifactLocation"`
	Region           *SARIFRegion          `json:"region,omitempty"`
}

type SARIFRegion

type SARIFRegion struct {
	StartLine int `json:"startLine"`
}

type SARIFReport

type SARIFReport struct {
	Schema  string     `json:"$schema"`
	Version string     `json:"version"`
	Runs    []SARIFRun `json:"runs"`
}

SARIFReport represents a SARIF v2.1.0 report

type SARIFResult

type SARIFResult struct {
	RuleID    string          `json:"ruleId"`
	Level     string          `json:"level"`
	Message   SARIFMessage    `json:"message"`
	Locations []SARIFLocation `json:"locations,omitempty"`
}

type SARIFRule

type SARIFRule struct {
	ID               string          `json:"id"`
	ShortDescription SARIFMessage    `json:"shortDescription"`
	DefaultConfig    SARIFRuleConfig `json:"defaultConfiguration"`
}

type SARIFRuleConfig

type SARIFRuleConfig struct {
	Level string `json:"level"`
}

type SARIFRun

type SARIFRun struct {
	Tool    SARIFTool     `json:"tool"`
	Results []SARIFResult `json:"results"`
}

type SARIFTool

type SARIFTool struct {
	Driver SARIFDriver `json:"driver"`
}

type ScanResult

type ScanResult struct {
	Path string `json:"path"`
	Meta *Meta  `json:"meta"`
}

ScanResult represents a found skill on disk

func ScanDirectory

func ScanDirectory(root string, limitDepth int) ([]ScanResult, error)

ScanDirectory recursively scans a directory for skills (directories containing SKILL.md) limitDepth prevents infinite recursion. Default recommendation: 3-5

type Severity

type Severity string

Severity represents the severity of a security finding

const (
	// SeverityInfo indicates informational findings
	SeverityInfo Severity = "INFO"
	// SeverityWarning indicates potential issues
	SeverityWarning Severity = "WARNING"
	// SeverityCritical indicates critical vulnerabilities
	SeverityCritical Severity = "CRITICAL"
)

type TemplateData

type TemplateData struct {
	Name        string
	Description string
	Author      string
}

TemplateData holds data for the skill template

type ValidationError

type ValidationError struct {
	Field    string
	Message  string
	Severity Severity
}

ValidationError represents a validation issue with a SKILL.md file

func ValidateMeta

func ValidateMeta(meta *Meta, dirName string) []ValidationError

ValidateMeta validates the Meta struct against the Agent Skills specification https://agentskills.io/specification