file_intel

Documentation

Index

• type Client
  • func New(cfg *pangea.Config) Client
• type FileIntel
  • func (e *FileIntel) Lookup(ctx context.Context, input *FileLookupInput) (*pangea.PangeaResponse[FileLookupOutput], error)
  • func (e *FileIntel) Reputation(ctx context.Context, input *FileReputationRequest) (*pangea.PangeaResponse[FileReputationResult], error)
• type FileLookupInput
  • func NewFileLookupInputFromFilepath(fp string) (*FileLookupInput, error)
• type FileLookupOutput
• type FileReputationRequest
  • func NewFileReputationRequestFromFilepath(fp string) (*FileReputationRequest, error)
• type FileReputationResult
• type LookupData
• type ReputationData

Types

type Client

type Client interface {
	Lookup(ctx context.Context, input *FileLookupInput) (*pangea.PangeaResponse[FileLookupOutput], error)
	Reputation(ctx context.Context, input *FileReputationRequest) (*pangea.PangeaResponse[FileReputationResult], error)
}

func New

func New(cfg *pangea.Config) Client

type FileIntel

type FileIntel struct {
	*pangea.Client
}

func (*FileIntel) Lookup

func (e *FileIntel) Lookup(ctx context.Context, input *FileLookupInput) (*pangea.PangeaResponse[FileLookupOutput], error)

@summary Reputation check

@description Lookup a file's hash to retrieve reputation data.

@deprecated Use Reputation instead.

@example

input := &file_intel.FileLookupInput{
	Hash: "322ccbd42b7e4fd3a9d0167ca2fa9f6483d9691364c431625f1df54270647ca8",
	HashType: "sha256",
	Raw: true,
	Verbose: true,
	Provider: "reversinglabs",
}

checkOutput, _, err := fileintel.Lookup(ctx, input)

func (*FileIntel) Reputation

func (e *FileIntel) Reputation(ctx context.Context, input *FileReputationRequest) (*pangea.PangeaResponse[FileReputationResult], error)

@summary Reputation check

@description Lookup a file's hash to retrieve reputation data.

@example

input := &file_intel.FileReputationRequest{
	Hash: "322ccbd42b7e4fd3a9d0167ca2fa9f6483d9691364c431625f1df54270647ca8",
	HashType: "sha256",
	Raw: true,
	Verbose: true,
	Provider: "reversinglabs",
}

checkOutput, _, err := fileintel.Reputation(ctx, input)

type FileLookupInput

type FileLookupInput struct {
	Hash string `json:"hash"`

	// One of "sha256", "sha", "md5".
	HashType string `json:"hash_type"`

	// Echo the API parameters in the response.
	Verbose bool `json:"verbose,omitempty"`

	// Include raw data from this provider.
	Raw bool `json:"raw,omitempty"`

	// Use reputation data from this provider.
	Provider string `json:"provider,omitempty"`
}

@deprecated Use Reputation instead.

func NewFileLookupInputFromFilepath

func NewFileLookupInputFromFilepath(fp string) (*FileLookupInput, error)

Create a FileReputationRequest from path file @deprecated Use NewFileReputationRequestFromFilepath instead.

type FileLookupOutput

type FileLookupOutput struct {
	// High-level normalized results sent
	// by the Pangea service
	Data LookupData `json:"data"`

	// The parameters, which were passed in
	// the request, echoed back
	Parameters interface{} `json:"parameters,omitempty"`

	// The raw data from the provider.
	// Each provider's data will have its own format
	RawData interface{} `json:"raw_data,omitempty"`
}

type FileReputationRequest

type FileReputationRequest struct {
	Hash string `json:"hash"`

	// One of "sha256", "sha", "md5".
	HashType string `json:"hash_type"`

	// Echo the API parameters in the response.
	Verbose bool `json:"verbose,omitempty"`

	// Include raw data from this provider.
	Raw bool `json:"raw,omitempty"`

	// Use reputation data from this provider.
	Provider string `json:"provider,omitempty"`
}

func NewFileReputationRequestFromFilepath

func NewFileReputationRequestFromFilepath(fp string) (*FileReputationRequest, error)

Create a FileReputationRequest from path file

type FileReputationResult

type FileReputationResult struct {
	// High-level normalized results sent
	// by the Pangea service
	Data ReputationData `json:"data"`

	// The parameters, which were passed in
	// the request, echoed back
	Parameters interface{} `json:"parameters,omitempty"`

	// The raw data from the provider.
	// Each provider's data will have its own format
	RawData interface{} `json:"raw_data,omitempty"`
}

type LookupData

type LookupData struct {
	// The categories that apply to this
	// indicator as determined by the provider
	Category []string `json:"category"`

	// The score, given by the Pangea service,
	// for the indicator
	Score int `json:"score"`

	// The verdict, given by the Pangea service,
	// for the indicator
	Verdict string `json:"verdict"`
}

@deprecated Use ReputationData instead.

type ReputationData

type ReputationData struct {
	// The categories that apply to this
	// indicator as determined by the provider
	Category []string `json:"category"`

	// The score, given by the Pangea service,
	// for the indicator
	Score int `json:"score"`

	// The verdict, given by the Pangea service,
	// for the indicator
	Verdict string `json:"verdict"`
}