hashcat

type ErrorCategory int

type ErrorInfo struct {
	Category  ErrorCategory
	Severity  api.Severity
	Retryable bool
	Message   string
	Context   map[string]any
}

type ExitCodeInfo struct {
	Category  ErrorCategory
	Severity  api.Severity
	Retryable bool
	Status    string
	ExitCode  int
	Context   map[string]any
}

type Params struct {
	AttackMode                int64    `json:"attack_mode"`                  // Attack mode (0=dictionary, 3=mask, 6/7=hybrid, 9=benchmark)
	HashType                  int64    `json:"hash_type"`                    // Hashcat hash type code
	HashFile                  string   `json:"hash_file"`                    // Path to file containing target hashes
	Mask                      string   `json:"mask,omitempty"`               // Mask pattern for mask/hybrid attacks
	MaskIncrement             bool     `json:"mask_increment,omitempty"`     // Enable mask increment mode
	MaskIncrementMin          int64    `json:"mask_increment_min"`           // Minimum mask length for increment mode
	MaskIncrementMax          int64    `json:"mask_increment_max"`           // Maximum mask length for increment mode
	MaskCustomCharsets        []string `json:"mask_custom_charsets"`         // Custom character sets for mask attacks
	WordListFilename          string   `json:"wordlist_filename"`            // Path to wordlist file
	RuleListFilename          string   `json:"rules_filename"`               // Path to rules file for dictionary attacks
	MaskListFilename          string   `json:"mask_list_filename"`           // Path to mask list file
	AdditionalArgs            []string `json:"additional_args"`              // Extra command-line arguments
	OptimizedKernels          bool     `json:"optimized_kernels"`            // Use optimized kernels (-O flag)
	SlowCandidates            bool     `json:"slow_candidates"`              // Enable slow candidate generators (-S flag)
	Skip                      int64    `json:"skip,omitempty"`               // Skip N candidates from start
	Limit                     int64    `json:"limit,omitempty"`              // Stop after processing N candidates
	BackendDevices            string   `json:"backend_devices,omitempty"`    // Backend devices to use (pre-resolved by DeviceConfig)
	OpenCLDevices             string   `json:"opencl_devices,omitempty"`     // OpenCL device types (pre-resolved by DeviceConfig)
	EnableAdditionalHashTypes bool     `json:"enable_additional_hash_types"` // Enable all hash types in benchmark mode
	RestoreFilePath           string   `json:"restore_file_path,omitempty"`  // Path to restore file for session resumption

	// Runtime configuration injected by the agent at session construction. These are
	// NOT part of the server API contract (json:"-"); they replace direct agentstate
	// reads in lib/hashcat so sessions are constructable and testable in isolation.
	OutPath                string `json:"-"` // Directory for the output file and charset temp files
	ZapsPath               string `json:"-"` // Directory for zaps (--outfile-check-dir); also cleaned up
	FilePath               string `json:"-"` // Base directory for wordlist/rule/mask files
	StatusTimer            int    `json:"-"` // Status/outfile-check timer in seconds
	RetainZapsOnCompletion bool   `json:"-"` // Whether Cleanup keeps the zaps directory
}

type Result struct {
	Timestamp time.Time `json:"timestamp"` // When the hash was cracked
	Hash      string    `json:"hash"`      // Original hash value
	Plaintext string    `json:"plaintext"` // Recovered plaintext password
}

type Session struct {
	CrackedHashes     chan Result    // Channel for successfully cracked hashes
	StatusUpdates     chan Status    // Channel for periodic status updates
	StderrMessages    chan ErrorInfo // Channel for classified error messages from hashcat
	StdoutLines       chan string    // StdoutLines receives non-JSON stdout lines. Never closed; consumers must select on ctx.Done().
	DoneChan          chan error     // Channel signaling process completion
	SkipStatusUpdates bool           // Flag to disable status update parsing
	RestoreFilePath   string         // Path to session restore file
	// contains filtered or unexported fields
}

type Status struct {
	OriginalLine    string         `json:"original_line"`    // Raw status line from hashcat
	Time            time.Time      `json:"time"`             // Timestamp when status was captured
	Session         string         `json:"session"`          // Unique session identifier
	Guess           statusGuess    `json:"guess"`            // Current guess/wordlist state
	Status          int64          `json:"status"`           // Hashcat status code
	Target          string         `json:"target"`           // Target hash or hash list
	Progress        []int64        `json:"progress"`         // Current and total progress values
	RestorePoint    int64          `json:"restore_point"`    // Position for session restoration
	RecoveredHashes []int64        `json:"recovered_hashes"` // Count of cracked hashes
	RecoveredSalts  []int64        `json:"recovered_salts"`  // Count of recovered salts
	Rejected        int64          `json:"rejected"`         // Number of rejected candidates
	Devices         []StatusDevice `json:"devices"`          // Active compute devices
	TimeStart       int64          `json:"time_start"`       // Attack start timestamp (Unix)
	EstimatedStop   int64          `json:"estimated_stop"`   // Estimated completion timestamp (Unix)
}

type StatusDevice struct {
	DeviceID   int64  `json:"device_id"`   // Unique device identifier
	DeviceName string `json:"device_name"` // Human-readable device name
	DeviceType string `json:"device_type"` // Device type (e.g., "GPU", "CPU")
	Speed      int64  `json:"speed"`       // Current processing speed (hashes/second)
	Util       int64  `json:"util"`        // Device utilization percentage (0-100)
	Temp       int64  `json:"temp"`        // Device temperature in Celsius
}