user_intel

Documentation

Index

• Constants
• type Client
  • func New(cfg *pangea.Config) Client
• type HashType
• type PasswordStatus
  • func IsPasswordBreached(r *pangea.PangeaResponse[UserPasswordBreachedResult], h string) (PasswordStatus, error)
• type UserBreachedData
• type UserBreachedRequest
• type UserBreachedResult
• type UserPasswordBreachedData
• type UserPasswordBreachedRequest
• type UserPasswordBreachedResult

Constants

const (
	PSbreached     PasswordStatus = 0
	PSunbreached                  = 1
	PSinconclusive                = 2
)

Types

type Client

type Client interface {
	UserBreached(ctx context.Context, req *UserBreachedRequest) (*pangea.PangeaResponse[UserBreachedResult], error)
	PasswordBreached(ctx context.Context, req *UserPasswordBreachedRequest) (*pangea.PangeaResponse[UserPasswordBreachedResult], error)

	// Base service methods
	GetPendingRequestID() []string
	PollResultByError(ctx context.Context, e pangea.AcceptedError) (*pangea.PangeaResponse[any], error)
	PollResultByID(ctx context.Context, rid string, v any) (*pangea.PangeaResponse[any], error)
	PollResultRaw(ctx context.Context, requestID string) (*pangea.PangeaResponse[map[string]any], error)
}

func New

func New(cfg *pangea.Config) Client

type HashType

type HashType string

const (
	HTsha265 HashType = "sha256"
	HTsha1   HashType = "sha1"
	HTmd5    HashType = "md5"
)

type PasswordStatus

type PasswordStatus int

func IsPasswordBreached

func IsPasswordBreached(r *pangea.PangeaResponse[UserPasswordBreachedResult], h string) (PasswordStatus, error)

type UserBreachedData

type UserBreachedData struct {
	FoundInBreach bool `json:"found_in_breach"`
	BreachCount   int  `json:"breach_count,omitempty"`
}

type UserBreachedRequest

type UserBreachedRequest struct {
	// Base request has ConfigID for multi-config projects
	pangea.BaseRequest

	Email       string `json:"email,omitempty"`
	Username    string `json:"username,omitempty"`
	PhoneNumber string `json:"phone_number,omitempty"`
	IP          string `json:"ip,omitempty"`
	Start       string `json:"start,omitempty"`
	End         string `json:"end,omitempty"`
	Verbose     *bool  `json:"verbose,omitempty"`
	Raw         *bool  `json:"raw,omitempty"`
	Provider    string `json:"provider,omitempty"`
}

type UserBreachedResult

type UserBreachedResult struct {
	Data       UserBreachedData `json:"data"`
	Parameters interface{}      `json:"parameters,omitempty"`
	RawData    interface{}      `json:"raw_data,omitempty"`
}

type UserPasswordBreachedData

type UserPasswordBreachedData struct {
	FoundInBreach bool `json:"found_in_breach"`
	BreachCount   int  `json:"breach_count,omitempty"`
}

type UserPasswordBreachedRequest

type UserPasswordBreachedRequest struct {
	// Base request has ConfigID for multi-config projects
	pangea.BaseRequest

	HashType   HashType `json:"hash_type,omitempty"`
	HashPrefix string   `json:"hash_prefix,omitempty"`
	Verbose    *bool    `json:"verbose,omitempty"`
	Raw        *bool    `json:"raw,omitempty"`
	Provider   string   `json:"provider,omitempty"`
}

type UserPasswordBreachedResult

type UserPasswordBreachedResult struct {
	Data       UserPasswordBreachedData `json:"data"`
	Parameters map[string]any           `json:"parameters,omitempty"`
	RawData    map[string]any           `json:"raw_data,omitempty"`
}