pack

type CleanupFunc func(ctx context.Context, input CleanupInput) error

type CleanupInput struct {
	Simulation       string         `json:"simulation"`
	ExecutionID      string         `json:"execution_id"`
	Params           map[string]any `json:"params"`
	DetonationResult *Result        `json:"detonation_result,omitempty"`
}

type DetonateFunc func(ctx context.Context, input DetonateInput) (*Result, error)

type DetonateInput struct {
	Simulation       string            `json:"simulation"`
	ExecutionID      string            `json:"execution_id"`
	Params           map[string]any    `json:"params"`
	TerraformOutputs map[string]string `json:"terraform_outputs"`
}

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type LogLine struct {
	Level       string         `json:"level"`
	Msg         string         `json:"msg"`
	Simulation  string         `json:"simulation,omitempty"`
	ExecutionID string         `json:"execution_id,omitempty"`
	Pack        string         `json:"pack,omitempty"`
	PackVersion string         `json:"pack_version,omitempty"`
	Timestamp   string         `json:"ts"`
	Extra       map[string]any `json:"-"` // Additional fields not in the struct
}

type MITREMapping struct {
	Tactics    []string `json:"tactics"`    // MITRE tactic IDs (e.g., ["TA0040"])
	Techniques []string `json:"techniques"` // MITRE technique IDs (e.g., ["T1496"])
}

type ManifestInput struct {
	Parameters map[string]any `json:"parameters,omitempty"`
}

type ManifestResponse struct {
	Pack         PackInfo             `json:"pack"`
	Simulations  []SimulationManifest `json:"simulations"`
	Templates    []TemplateManifest   `json:"templates,omitempty"`
	ParamsSchema json.RawMessage      `json:"params_schema,omitempty"`
}

type PackInfo struct {
	Name             string `json:"name"`
	Version          string `json:"version"`
	MinSimrunVersion string `json:"min_simrun_version"`
}

type PackParam struct {
	// Name is the parameter key. Must be unique across custom params and must
	// not collide with a reserved built-in name.
	Name string
	// Type is one of "string", "boolean", "object_string_map".
	Type string
	// Description is human-readable help text shown in the UI.
	Description string
	// Default is the default value used when the operator does not set the
	// param. Must match Type: string for "string", bool for "boolean",
	// map[string]string for "object_string_map".
	Default any
	// Required marks the param as mandatory. Backend validation rejects a
	// PUT /api/packs/{name}/parameters that omits a required param.
	Required bool
	// Enum, when non-empty, restricts a "string"-typed param's allowed values.
	// Invalid on any non-string type.
	Enum []string
}

type Result struct {
	Status     string         `json:"status"`
	Indicators map[string]any `json:"indicators,omitempty"`
	Error      *Error         `json:"error,omitempty"`
}

type SSHClient struct {
	// contains filtered or unexported fields
}

type SSHConfig struct {
	Host           string        // Required: IP or hostname
	Username       string        // Required: SSH username
	PrivateKeyPath string        // Path to private key file
	ConnectTimeout time.Duration // Default: 30s
}

type Simulation struct {
	// ID is the simulation slug (e.g., "ec2-bitcoin-mining").
	// The SDK generates the full qualified ID (scope.slug) at manifest time.
	ID                        string       `json:"id"`
	Name                      string       `json:"name"`
	Description               string       `json:"description"`
	MITRE                     MITREMapping `json:"mitre"`
	Scope                     string       `json:"scope"` // Required: aws, gcp, azure, generic
	IsSlow                    bool         `json:"is_slow,omitempty"`
	RequiresExternalResources bool         `json:"requires_external_resources,omitempty"`
	ParamsSchema              any          `json:"params_schema,omitempty"`
	Terraform                 string       `json:"-"` // raw HCL content, typically from //go:embed
	// RequiredOutputs lists the Terraform output names that Detonate reads
	// from DetonateInput.TerraformOutputs. The SDK validates these against
	// the embedded Terraform body at Register time and panics if any are
	// missing, so authors find sim/TF contract drift at boot rather than
	// after a real `terraform apply`. Leave nil to skip validation.
	RequiredOutputs []string     `json:"-"`
	Detonate        DetonateFunc `json:"-"`
	Cleanup         CleanupFunc  `json:"-"`
}

type SimulationManifest struct {
	ID                        string          `json:"id"` // Simulation ID: scope.slug (e.g., "aws.ec2-bitcoin-mining")
	Name                      string          `json:"name"`
	Description               string          `json:"description"`
	MITRE                     MITREMapping    `json:"mitre"`
	Scope                     string          `json:"scope"`
	IsSlow                    bool            `json:"is_slow,omitempty"`
	RequiresExternalResources bool            `json:"requires_external_resources,omitempty"`
	ParamsSchema              json.RawMessage `json:"params_schema,omitempty"`
	Terraform                 string          `json:"terraform,omitempty"` // base64-encoded
	HasCustomCleanup          bool            `json:"has_custom_cleanup"`
}

type Template struct {
	// ID is the template slug (e.g., "add-group-member").
	// The SDK generates the full qualified ID (scope.slug) at manifest time.
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Scope       string `json:"scope"` // Required: okta, aws, gcp, azure, generic
	Content     string `json:"-"`     // Raw template content, typically from //go:embed
}

type TemplateManifest struct {
	ID          string            `json:"id"` // Template ID: scope.slug (e.g., "okta.add-group-member")
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Scope       string            `json:"scope"`
	Content     string            `json:"content"`        // Base64-encoded template content
	Vars        map[string]string `json:"vars,omitempty"` // Variable names to default values, extracted from template
}