entities

type AnalysisCheck string

type AnalysisName string

type ApiFinding struct {
	ApiRule
	Paths []string `json:"paths" validate:"min=1"`
}

type ApiMatcher struct {
	ApiRule
	Match Match `json:"match" validate:"required"`
}

type ApiRule struct {
	Description string `json:"description" validate:"min=1"`
}

type BinType string

type BinaryAnalysis struct {
	BinType   BinType                `json:"bin_type" validate:"valid_bin_types"`
	Libraries []string               `json:"libraries"`
	Macho     MachoInfo              `json:"macho"`
	Results   []BinaryAnalysisResult `json:"results"`
}

type BinaryAnalysisResult struct {
	Issue       string  `json:"issue" validate:"min=1"`
	Description string  `json:"description" validate:"min=1"`
	Status      Status  `json:"status" validate:"valid_status"`
	Cvss        float64 `json:"cvss" validate:"required"`
	CWE         string  `json:"cwe" validate:"startswith=CWE-"`
}

type Bits uint

type BundleUrlType struct {
	Name    string   `json:"name" validate:"required"`
	Schemas []string `json:"schemas" validate:"min=1"`
}

type CodeAnalysis struct {
	Codes      []CodeFinding  `json:"codes" validate:"required,dive"`
	Apis       []ApiFinding   `json:"apis" validate:"required,dive"`
	Urls       []UrlFinding   `json:"urls" validate:"required,dive"`
	Emails     []EmailFinding `json:"emails" validate:"required,dive"`
	BadDomains []string       `json:"bad_domains"`
}

type CodeFinding struct {
	CodeRule
	Paths []string `json:"paths" validate:"min=1"`
}

type CodeMatcher struct {
	CodeRule
	// func (string) bool to call against a string to do the match
	Match Match `json:"match" validate:"required"`
}

type CodeRule struct {
	// Description of the code rule
	Description string `json:"description" validate:"min=1"`
	// level of the issue
	Level Level   `json:"level"       validate:"required,valid_levels"`
	Cvss  float64 `json:"cvss"        validate:"required"`
	Cwe   string  `json:"cwe"         validate:"startswith=CWE-"`
}

type Command struct {
	Path          string                 `json:"path" validate:"required_without=SourcePath"`
	SourcePath    string                 `json:"source_path" validate:"required_without=Path"`
	Source        bool                   `json:"source"`
	Tools         string                 `json:"tools"`
	AppName       string                 `json:"app_name"`
	AppId         string                 `json:"app_id"`
	Country       string                 `json:"country" validate:"valid_country_codes"`
	VirusTotalKey string                 `json:"virus_total_key"`
	Analysis      map[AnalysisCheck]bool `json:"analysis" validate:"valid_analysis"`
	Output        io.Writer              `json:"output"`
	T             *testing.T             `json:"t"`
	Quiet         bool                   `json:"quiet"`
	Summary       bool                   `json:"summary"`
}

type Configuration struct {

	// Path where the source to analyze is present in the filesystem.
	SourcePath string `id:"source" desc:"Path to the source code to analyze"`
	// Path where the binary to analyze is present in the filesystem.
	BinaryPath string `id:"binary" desc:"Path to the binary .ipa file to analyze"`
	// Folder where the external binary tools (jtool, etc.) are in the system. If nothing is passed, the application
	// expects them to be in a sibling folder relative to the app binary.
	ToolsPath string `id:"tools" desc:"Folder where the program external binaries are located"`

	// String slice with the scans to make when calling scan command
	Analysis []string `id:"scans" desc:"Test to do when calling scan command"`
	// Default country to pass to the lookup in the app store command.
	DefaultCountry string `id:"country" desc:"Country to use in the apple store lookup"`

	// Virus scan key. If included, the app will call virus scan api to scan the code
	// TODO: change to a boolean flag when we have the collective key
	VirusScanKey string `id:"virus" desc:"Virus Scan API key to use the service"`
	// Whether or not we output in json. Defaults to false
	JSONFormat bool `id:"json" desc:"Activate the json output"`
	// Whether or not we look for malware domains in malwaredomainlist.com. Defaults to false.
	PerformDomainCheck bool `id:"domains" desc:"Activate domain check from www.malwaredomainlist.com"`
	// Activate quiet mode
	QuietMode bool `id:"quiet" desc:"Deactivate info messages logging"`
	// Activate summary mode
	SummaryMode bool `id:"summary" desc:"Print shorter reports"`
}

type CpuType string

type EmailFinding struct {
	Email string   `json:"email" validate:"min=1"`
	Paths []string `json:"paths" validate:"min=1"`
}

type Endianness string

type Entity interface {
	// ToMap allows the different entities to be transformed to map[string]interface{} objects without using reflection.
	ToMap() map[string]interface{}
	// ToMap and FromMap are complementary functions, in order to test them, we have to be sure that a FromMap().ToMap()
	// roundtrip outputs the same map object as the used input.
	FromMap(m map[string]interface{}) (Entity, error)
	// Validate allows to obtain an array of field errors from the Entity fields. It allows to check if the entity
	// creation has been completelly succesful or not.
	Validate() []validator.FieldError
}

type Error struct {
	Analysis AnalysisName `json:"analysis"`
	E        error        `json:"e" validate:"required"`
}

type FileAnalysis struct {
	Files          []string `json:"files" validate:"min=1"`
	Certifications []string `json:"certifications" validate:"required"`
	Databases      []string `json:"databases" validate:"required"`
	PLists         []string `json:"plists" validate:"required"`
}

type InsecureConnections struct {
	AllowArbitraryLoads bool     `json:"allow_arbitrary_loads"`
	Domains             []string `json:"domains"`
}

type Level string

type LogLevel int

type LogMessage struct {
	Level    LogLevel     `json:"level"`
	Analysis AnalysisName `json:"analysis"`
	Message  string       `json:"message" validate:"min=1"`
}

type MachoInfo struct {
	Err        bool       `json:"err"`
	Bits       Bits       `json:"bits" validate:"required,valid_bits"`
	Endianness Endianness `json:"endianness" validate:"required,valid_endianness"`
	Cpu        CpuType    `json:"cpu" validate:"required,valid_cpu"`
	SubCpu     SubCpuType `json:"sub_cpu" validate:"omitempty,valid_sub_cpu"`
}

type Match func(string) bool

type PListAnalysis struct {
	Xml                      string              `json:"xml" validate:"min=1"`
	BinName                  string              `json:"bin_name" validate:"min=1"`
	Bin                      string              `json:"bin" validate:"min=1"`
	Id                       string              `json:"id" validate:"min=1"`
	Build                    string              `json:"build" validate:"min=1"`
	SDK                      string              `json:"sdk" validate:"min=1"`
	Platform                 string              `json:"platform" validate:"min=1"`
	MinimumVersion           string              `json:"minimum_version" validate:"min=1"`
	BundleName               string              `json:"bundle_name" validate:"min=1"`
	BundleVersionName        string              `json:"bundle_version_name" validate:"min=1"`
	BundleSupportedPlatforms []string            `json:"bundle_supported_platforms" validate:"min=1"`
	BundleLocalizations      []string            `json:"bundle_localizations" validate:"min=1"`
	BundleUrlTypes           []BundleUrlType     `json:"bundle_url_types" validate:"required"`
	Permissions              []Permission        `json:"permissions" validate:"required"`
	InsecureConnections      InsecureConnections `json:"insecure_connections" validate:"required"`
}

type Permission struct {
	Name        string `json:"name" validate:"min=1"`
	Description string `json:"description" validate:"min=1"`
	Reason      string `json:"reason" validate:"min=1"`
}

type StaticAnalysis struct {
	HasBinary bool           `json:"has_binary"`
	HasCode   bool           `json:"has_code"`
	HasFiles  bool           `json:"has_files"`
	HasPlist  bool           `json:"has_plist"`
	HasVirus  bool           `json:"has_virus"`
	HasStore  bool           `json:"has_store"`
	Binary    BinaryAnalysis `json:"binary"`
	Code      CodeAnalysis   `json:"code"`
	Files     FileAnalysis   `json:"files"`
	Plist     PListAnalysis  `json:"plist"`
	Virus     VirusAnalysis  `json:"virus"`
	Store     StoreAnalysis  `json:"lookup"`
}

type Status string

type StoreAnalysis struct {
	Count   int           `json:"resultCount" validate:"len=1"`
	Results []StoreResult `json:"results" validate:"min=1"`
}

type StoreResult struct {
	Features         []string `json:"features" validate:"required"`
	IconUrl512       string   `json:"artworkUrl512" validate:"required"`
	IconUrl100       string   `json:"artworkUrl100" validate:"required"`
	IconUrl60        string   `json:"artworkUrl60" validate:"required"`
	DeveloperId      int      `json:"artistId" validate:"required"`
	DeveloperName    string   `json:"artistName" validate:"required"`
	DeveloperUrl     string   `json:"artistViewUrl" validate:"required"`
	DeveloperWebsite string   `json:"sellerUrl" validate:"required"`
	SupportedDevices []string `json:"supportedDevices" validate:"required"`
	Title            string   `json:"trackName" validate:"required"`
	AppId            string   `json:"bundleId" validate:"required"`
	Categories       []string `json:"genres" validate:"required"`
	Description      string   `json:"description" validate:"required"`
	Price            float64  `json:"price"`
	Url              string   `json:"trackViewUrl" validate:"required"`
	Score            float64  `json:"averageUserRating" validate:"required"`
}

type SubCpuType string

type ToolUrls struct {
	JTool          string `json:"jtool" validate:"url"`
	ClassDumpZ     string `json:"class-dump-z" validate:"url"`
	ClassDumpSwift string `json:"class-dump-swift" validate:"url"`
}

type UrlFinding struct {
	Url   string   `json:"url" validate:"min=1"`
	Paths []string `json:"paths" validate:"min=1"`
}

type VirusAnalysis struct {
	HasReport bool          `json:"has_report"`
	Response  VirusResponse `json:"response" validate:"required"`
	Report    VirusReport   `json:"report" validate:"structonly"`
}

type VirusReport struct {
	VirusResponse
	Md5       string               `json:"md5" validate:"required"`
	Sha1      string               `json:"sha1" validate:"required"`
	ScanDate  string               `json:"scan_date" validate:"required"`
	Positives int                  `json:"positives"`
	Total     int                  `json:"total" validate:"required"`
	Scans     map[string]VirusScan `json:"scans" validate:"required"`
}

type VirusResponse struct {
	ResponseCode int    `json:"response_code"`
	VerboseMsg   string `json:"verbose_msg" validate:"required"`
	Resource     string `json:"resource" validate:"required"`
	ScanId       string `json:"scan_id" validate:"required"`
	Sha256       string `json:"sha256" validate:"required"`
	Permalink    string `json:"permalink" validate:"required"`
}

type VirusScan struct {
	Detected bool   `json:"detected" validate:"required"`
	Version  string `json:"version" validate:"required"`
	Result   string `json:"result" validate:"required"`
	Update   string `json:"update" validate:"required"`
}