components

package
v0.8.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 2, 2024 License: MPL-2.0 Imports: 4 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvancedAgentConfiguration

type AdvancedAgentConfiguration struct {
	// The interval in seconds to check for agent updates
	AgentUpdateInterval *int64 `json:"agent_update_interval"`
	// Use the hashcat binary already installed on the client system
	UseNativeHashcat *bool `json:"use_native_hashcat"`
	// The device to use for hashcat, separated by commas
	BackendDevice *string `json:"backend_device"`
	// The OpenCL device types to use for hashcat, separated by commas
	OpenclDevices *string `json:"opencl_devices,omitempty"`
	// Causes hashcat to perform benchmark-all, rather than just benchmark
	EnableAdditionalHashTypes bool `json:"enable_additional_hash_types"`
}

func (*AdvancedAgentConfiguration) GetAgentUpdateInterval

func (o *AdvancedAgentConfiguration) GetAgentUpdateInterval() *int64

func (*AdvancedAgentConfiguration) GetBackendDevice

func (o *AdvancedAgentConfiguration) GetBackendDevice() *string

func (*AdvancedAgentConfiguration) GetEnableAdditionalHashTypes added in v0.4.0

func (o *AdvancedAgentConfiguration) GetEnableAdditionalHashTypes() bool

func (*AdvancedAgentConfiguration) GetOpenclDevices added in v0.4.3

func (o *AdvancedAgentConfiguration) GetOpenclDevices() *string

func (*AdvancedAgentConfiguration) GetUseNativeHashcat

func (o *AdvancedAgentConfiguration) GetUseNativeHashcat() *bool

type Agent

type Agent struct {
	// The id of the agent
	ID int64 `json:"id"`
	// The hostname of the agent
	HostName string `json:"host_name"`
	// The signature of the client
	ClientSignature string `json:"client_signature"`
	// The state of the agent
	State State `json:"state"`
	// The operating system of the agent
	OperatingSystem       string                     `json:"operating_system"`
	Devices               []string                   `json:"devices"`
	AdvancedConfiguration AdvancedAgentConfiguration `json:"advanced_configuration"`
}

func (*Agent) GetAdvancedConfiguration

func (o *Agent) GetAdvancedConfiguration() AdvancedAgentConfiguration

func (*Agent) GetClientSignature

func (o *Agent) GetClientSignature() string

func (*Agent) GetDevices

func (o *Agent) GetDevices() []string

func (*Agent) GetHostName added in v0.8.5

func (o *Agent) GetHostName() string

func (*Agent) GetID

func (o *Agent) GetID() int64

func (*Agent) GetOperatingSystem

func (o *Agent) GetOperatingSystem() string

func (*Agent) GetState added in v0.4.0

func (o *Agent) GetState() State

type Attack

type Attack struct {
	// The id of the attack
	ID int64 `json:"id"`
	// Attack mode name
	AttackMode *AttackMode `default:"dictionary" json:"attack_mode"`
	// hashcat attack mode
	AttackModeHashcat *int64 `default:"0" json:"attack_mode_hashcat"`
	// A hashcat mask string
	Mask *string `default:"" json:"mask"`
	// Enable hashcat increment mode
	IncrementMode *bool `default:"false" json:"increment_mode"`
	// The start of the increment range
	IncrementMinimum int64 `json:"increment_minimum"`
	// The end of the increment range
	IncrementMaximum int64 `json:"increment_maximum"`
	// Enable hashcat optimized mode
	Optimized *bool `default:"false" json:"optimized"`
	// Enable hashcat slow candidate generators
	SlowCandidateGenerators *bool `default:"false" json:"slow_candidate_generators"`
	// The hashcat workload profile
	WorkloadProfile *int64 `default:"3" json:"workload_profile"`
	// Disable hashcat markov mode
	DisableMarkov *bool `default:"false" json:"disable_markov"`
	// Enable hashcat classic markov mode
	ClassicMarkov *bool `default:"false" json:"classic_markov"`
	// The hashcat markov threshold
	MarkovThreshold *int64 `default:"0" json:"markov_threshold"`
	// The left-hand rule for combinator attacks
	LeftRule *string `default:"" json:"left_rule"`
	// The right-hand rule for combinator attacks
	RightRule *string `default:"" json:"right_rule"`
	// Custom charset 1 for hashcat mask attacks
	CustomCharset1 *string `default:"" json:"custom_charset_1"`
	// Custom charset 2 for hashcat mask attacks
	CustomCharset2 *string `default:"" json:"custom_charset_2"`
	// Custom charset 3 for hashcat mask attacks
	CustomCharset3 *string `default:"" json:"custom_charset_3"`
	// Custom charset 4 for hashcat mask attacks
	CustomCharset4 *string `default:"" json:"custom_charset_4"`
	// The id of the hash list
	HashListID int64               `json:"hash_list_id"`
	WordList   *AttackResourceFile `json:"word_list,omitempty"`
	RuleList   *AttackResourceFile `json:"rule_list,omitempty"`
	MaskList   *AttackResourceFile `json:"mask_list,omitempty"`
	// The hashcat hash mode
	HashMode *int64 `default:"0" json:"hash_mode"`
	// The download URL for the hash list
	HashListURL *string `json:"hash_list_url"`
	// The MD5 checksum of the hash list
	HashListChecksum *string `json:"hash_list_checksum"`
	// The URL to the attack
	URL *string `json:"url"`
}

func (*Attack) GetAttackMode

func (o *Attack) GetAttackMode() *AttackMode

func (*Attack) GetAttackModeHashcat

func (o *Attack) GetAttackModeHashcat() *int64

func (*Attack) GetClassicMarkov

func (o *Attack) GetClassicMarkov() *bool

func (*Attack) GetCustomCharset1

func (o *Attack) GetCustomCharset1() *string

func (*Attack) GetCustomCharset2

func (o *Attack) GetCustomCharset2() *string

func (*Attack) GetCustomCharset3

func (o *Attack) GetCustomCharset3() *string

func (*Attack) GetCustomCharset4

func (o *Attack) GetCustomCharset4() *string

func (*Attack) GetDisableMarkov

func (o *Attack) GetDisableMarkov() *bool

func (*Attack) GetHashListChecksum

func (o *Attack) GetHashListChecksum() *string

func (*Attack) GetHashListID

func (o *Attack) GetHashListID() int64

func (*Attack) GetHashListURL

func (o *Attack) GetHashListURL() *string

func (*Attack) GetHashMode

func (o *Attack) GetHashMode() *int64

func (*Attack) GetID

func (o *Attack) GetID() int64

func (*Attack) GetIncrementMaximum

func (o *Attack) GetIncrementMaximum() int64

func (*Attack) GetIncrementMinimum

func (o *Attack) GetIncrementMinimum() int64

func (*Attack) GetIncrementMode

func (o *Attack) GetIncrementMode() *bool

func (*Attack) GetLeftRule

func (o *Attack) GetLeftRule() *string

func (*Attack) GetMarkovThreshold

func (o *Attack) GetMarkovThreshold() *int64

func (*Attack) GetMask

func (o *Attack) GetMask() *string

func (*Attack) GetMaskList added in v0.8.1

func (o *Attack) GetMaskList() *AttackResourceFile

func (*Attack) GetOptimized

func (o *Attack) GetOptimized() *bool

func (*Attack) GetRightRule

func (o *Attack) GetRightRule() *string

func (*Attack) GetRuleList added in v0.8.1

func (o *Attack) GetRuleList() *AttackResourceFile

func (*Attack) GetSlowCandidateGenerators

func (o *Attack) GetSlowCandidateGenerators() *bool

func (*Attack) GetURL

func (o *Attack) GetURL() *string

func (*Attack) GetWordList added in v0.8.1

func (o *Attack) GetWordList() *AttackResourceFile

func (*Attack) GetWorkloadProfile

func (o *Attack) GetWorkloadProfile() *int64

func (Attack) MarshalJSON

func (a Attack) MarshalJSON() ([]byte, error)

func (*Attack) UnmarshalJSON

func (a *Attack) UnmarshalJSON(data []byte) error

type AttackMode added in v0.2.0

type AttackMode string

AttackMode - Attack mode name

const (
	AttackModeDictionary       AttackMode = "dictionary"
	AttackModeMask             AttackMode = "mask"
	AttackModeHybridDictionary AttackMode = "hybrid_dictionary"
	AttackModeHybridMask       AttackMode = "hybrid_mask"
)

func (AttackMode) ToPointer added in v0.2.0

func (e AttackMode) ToPointer() *AttackMode

func (*AttackMode) UnmarshalJSON added in v0.2.0

func (e *AttackMode) UnmarshalJSON(data []byte) error

type AttackResourceFile

type AttackResourceFile struct {
	// The id of the resource file
	ID int64 `json:"id"`
	// The download URL of the resource file
	DownloadURL string `json:"download_url"`
	// The MD5 checksum of the resource file
	Checksum string `json:"checksum"`
	// The name of the resource file
	FileName string `json:"file_name"`
}

func (*AttackResourceFile) GetChecksum

func (o *AttackResourceFile) GetChecksum() string

func (*AttackResourceFile) GetDownloadURL

func (o *AttackResourceFile) GetDownloadURL() string

func (*AttackResourceFile) GetFileName

func (o *AttackResourceFile) GetFileName() string

func (*AttackResourceFile) GetID

func (o *AttackResourceFile) GetID() int64

type CrackerUpdate

type CrackerUpdate struct {
	// A new version of the cracker binary is available
	Available bool `json:"available"`
	// The latest version of the cracker binary
	LatestVersion *string `json:"latest_version,omitempty"`
	// The download URL of the new version
	DownloadURL *string `json:"download_url,omitempty"`
	// The name of the executable
	ExecName *string `json:"exec_name,omitempty"`
	// A message about the update
	Message *string `json:"message,omitempty"`
}

func (*CrackerUpdate) GetAvailable

func (o *CrackerUpdate) GetAvailable() bool

func (*CrackerUpdate) GetDownloadURL

func (o *CrackerUpdate) GetDownloadURL() *string

func (*CrackerUpdate) GetExecName

func (o *CrackerUpdate) GetExecName() *string

func (*CrackerUpdate) GetLatestVersion

func (o *CrackerUpdate) GetLatestVersion() *string

func (*CrackerUpdate) GetMessage

func (o *CrackerUpdate) GetMessage() *string

type DeviceStatus

type DeviceStatus struct {
	// The id of the device
	DeviceID int64 `json:"device_id"`
	// The name of the device
	DeviceName string `json:"device_name"`
	// The type of the device
	DeviceType DeviceType `json:"device_type"`
	// The speed of the device
	Speed int64 `json:"speed"`
	// The utilization of the device
	Utilization int64 `json:"utilization"`
	// The temperature of the device, or -1 if unmonitored.
	Temperature int64 `json:"temperature"`
}

func (*DeviceStatus) GetDeviceID

func (o *DeviceStatus) GetDeviceID() int64

func (*DeviceStatus) GetDeviceName

func (o *DeviceStatus) GetDeviceName() string

func (*DeviceStatus) GetDeviceType

func (o *DeviceStatus) GetDeviceType() DeviceType

func (*DeviceStatus) GetSpeed

func (o *DeviceStatus) GetSpeed() int64

func (*DeviceStatus) GetTemperature

func (o *DeviceStatus) GetTemperature() int64

func (*DeviceStatus) GetUtilization

func (o *DeviceStatus) GetUtilization() int64

type DeviceType added in v0.2.0

type DeviceType string

DeviceType - The type of the device

const (
	DeviceTypeCPU DeviceType = "CPU"
	DeviceTypeGpu DeviceType = "GPU"
)

func (DeviceType) ToPointer added in v0.2.0

func (e DeviceType) ToPointer() *DeviceType

func (*DeviceType) UnmarshalJSON added in v0.2.0

func (e *DeviceType) UnmarshalJSON(data []byte) error

type HashcatBenchmark

type HashcatBenchmark struct {
	// The hashcat hash type
	HashType int64 `json:"hash_type"`
	// The runtime of the benchmark in milliseconds.
	Runtime int64 `json:"runtime"`
	// The speed of the benchmark in hashes per second.
	HashSpeed float64 `json:"hash_speed"`
	// The device used for the benchmark
	Device int64 `json:"device"`
}

func (*HashcatBenchmark) GetDevice

func (o *HashcatBenchmark) GetDevice() int64

func (*HashcatBenchmark) GetHashSpeed

func (o *HashcatBenchmark) GetHashSpeed() float64

func (*HashcatBenchmark) GetHashType

func (o *HashcatBenchmark) GetHashType() int64

func (*HashcatBenchmark) GetRuntime

func (o *HashcatBenchmark) GetRuntime() int64

type HashcatGuess

type HashcatGuess struct {
	// The base value used for the guess (for example, the mask)
	GuessBase string `json:"guess_base"`
	// The number of times the base value was used
	GuessBaseCount int64 `json:"guess_base_count"`
	// The offset of the base value
	GuessBaseOffset int64 `json:"guess_base_offset"`
	// The percentage completion of the base value
	GuessBasePercentage float64 `json:"guess_base_percentage"`
	// The modifier used for the guess (for example, the wordlist)
	GuessMod string `json:"guess_mod"`
	// The number of times the modifier was used
	GuessModCount int64 `json:"guess_mod_count"`
	// The offset of the modifier
	GuessModOffset int64 `json:"guess_mod_offset"`
	// The percentage completion of the modifier
	GuessModPercentage float64 `json:"guess_mod_percentage"`
	// The mode used for the guess
	GuessMode int64 `json:"guess_mode"`
}

func (*HashcatGuess) GetGuessBase

func (o *HashcatGuess) GetGuessBase() string

func (*HashcatGuess) GetGuessBaseCount

func (o *HashcatGuess) GetGuessBaseCount() int64

func (*HashcatGuess) GetGuessBaseOffset

func (o *HashcatGuess) GetGuessBaseOffset() int64

func (*HashcatGuess) GetGuessBasePercentage

func (o *HashcatGuess) GetGuessBasePercentage() float64

func (*HashcatGuess) GetGuessMod

func (o *HashcatGuess) GetGuessMod() string

func (*HashcatGuess) GetGuessModCount

func (o *HashcatGuess) GetGuessModCount() int64

func (*HashcatGuess) GetGuessModOffset

func (o *HashcatGuess) GetGuessModOffset() int64

func (*HashcatGuess) GetGuessModPercentage

func (o *HashcatGuess) GetGuessModPercentage() float64

func (*HashcatGuess) GetGuessMode

func (o *HashcatGuess) GetGuessMode() int64

type HashcatResult

type HashcatResult struct {
	// The time the hash was cracked
	Timestamp time.Time `json:"timestamp"`
	// The hash value
	Hash string `json:"hash"`
	// The plain text value
	PlainText string `json:"plain_text"`
}

func (*HashcatResult) GetHash

func (o *HashcatResult) GetHash() string

func (*HashcatResult) GetPlainText

func (o *HashcatResult) GetPlainText() string

func (*HashcatResult) GetTimestamp

func (o *HashcatResult) GetTimestamp() time.Time

func (HashcatResult) MarshalJSON

func (h HashcatResult) MarshalJSON() ([]byte, error)

func (*HashcatResult) UnmarshalJSON

func (h *HashcatResult) UnmarshalJSON(data []byte) error

type Security

type Security struct {
	BearerAuth string `security:"scheme,type=http,subtype=bearer,name=Authorization"`
}

func (*Security) GetBearerAuth

func (o *Security) GetBearerAuth() string

type State added in v0.4.0

type State string

State - The state of the agent

const (
	StatePending State = "pending"
	StateActive  State = "active"
	StateStopped State = "stopped"
	StateError   State = "error"
)

func (State) ToPointer added in v0.4.0

func (e State) ToPointer() *State

func (*State) UnmarshalJSON added in v0.4.0

func (e *State) UnmarshalJSON(data []byte) error

type Task

type Task struct {
	// The id of the task
	ID int64 `json:"id"`
	// The id of the attack
	AttackID int64 `json:"attack_id"`
	// The time the task was started
	StartDate time.Time `json:"start_date"`
	// The status of the task
	Status string `json:"status"`
	// The offset of the keyspace
	Skip *int64 `json:"skip,omitempty"`
	// The limit of the keyspace
	Limit *int64 `json:"limit,omitempty"`
}

func (*Task) GetAttackID

func (o *Task) GetAttackID() int64

func (*Task) GetID

func (o *Task) GetID() int64

func (*Task) GetLimit

func (o *Task) GetLimit() *int64

func (*Task) GetSkip

func (o *Task) GetSkip() *int64

func (*Task) GetStartDate

func (o *Task) GetStartDate() time.Time

func (*Task) GetStatus

func (o *Task) GetStatus() string

func (Task) MarshalJSON

func (t Task) MarshalJSON() ([]byte, error)

func (*Task) UnmarshalJSON

func (t *Task) UnmarshalJSON(data []byte) error

type TaskStatus

type TaskStatus struct {
	// The original line from hashcat
	OriginalLine string `json:"original_line"`
	// The time the status was received
	Time time.Time `json:"time"`
	// The session name
	Session      string       `json:"session"`
	HashcatGuess HashcatGuess `json:"hashcat_guess"`
	// The status of the task
	Status int64 `json:"status"`
	// The target of the task
	Target string `json:"target"`
	// The progress of the task
	Progress []int64 `json:"progress"`
	// The restore point of the task
	RestorePoint int64 `json:"restore_point"`
	// The number of recovered hashes
	RecoveredHashes []int64 `json:"recovered_hashes"`
	// The number of recovered salts
	RecoveredSalts []int64 `json:"recovered_salts"`
	// The number of rejected guesses
	Rejected int64 `json:"rejected"`
	// The status of the devices used for the task
	DeviceStatuses []DeviceStatus `json:"device_statuses"`
	// The time the task started.
	TimeStart time.Time `json:"time_start"`
	// The estimated time of completion.
	EstimatedStop time.Time `json:"estimated_stop"`
}

func (*TaskStatus) GetDeviceStatuses

func (o *TaskStatus) GetDeviceStatuses() []DeviceStatus

func (*TaskStatus) GetEstimatedStop

func (o *TaskStatus) GetEstimatedStop() time.Time

func (*TaskStatus) GetHashcatGuess

func (o *TaskStatus) GetHashcatGuess() HashcatGuess

func (*TaskStatus) GetOriginalLine

func (o *TaskStatus) GetOriginalLine() string

func (*TaskStatus) GetProgress

func (o *TaskStatus) GetProgress() []int64

func (*TaskStatus) GetRecoveredHashes

func (o *TaskStatus) GetRecoveredHashes() []int64

func (*TaskStatus) GetRecoveredSalts

func (o *TaskStatus) GetRecoveredSalts() []int64

func (*TaskStatus) GetRejected

func (o *TaskStatus) GetRejected() int64

func (*TaskStatus) GetRestorePoint

func (o *TaskStatus) GetRestorePoint() int64

func (*TaskStatus) GetSession

func (o *TaskStatus) GetSession() string

func (*TaskStatus) GetStatus

func (o *TaskStatus) GetStatus() int64

func (*TaskStatus) GetTarget

func (o *TaskStatus) GetTarget() string

func (*TaskStatus) GetTime

func (o *TaskStatus) GetTime() time.Time

func (*TaskStatus) GetTimeStart

func (o *TaskStatus) GetTimeStart() time.Time

func (TaskStatus) MarshalJSON

func (t TaskStatus) MarshalJSON() ([]byte, error)

func (*TaskStatus) UnmarshalJSON

func (t *TaskStatus) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL