cargo

Documentation

Index

• Variables
• func Name() string
• func NewPackageFromBinaryDependency(dependPackageList []rustaudit.Package, path string) []model.Package
• func NewPkgFromCargoMetadata(c CargoPackageMetadata, m map[string]CargoPackageMetadata, filePath string) model.Package
• func PkgType() model.PkgType
• type CargoPackageMetadata
• type Collector
  • func NewCollector() *Collector
  • func (c *Collector) Collect() (pkgs []model.Package, err error)
• type RustBinaryParser
  • func NewRustBinaryParser() RustBinaryParser
  • func (RustBinaryParser) Matcher() collector.FileMatcher
  • func (RustBinaryParser) Parse(path string) (pkgs []model.Package, err error)
• type RustCargoFileParser
  • func NewCargoFileParser() *RustCargoFileParser
  • func (m *RustCargoFileParser) Matcher() collector.FileMatcher
  • func (m *RustCargoFileParser) Parse(filePath string) ([]model.Package, error)
• type RustCargoTomlFileParser
  • func NewCargoTomlFileParser() *RustCargoTomlFileParser
  • func (m *RustCargoTomlFileParser) Matcher() collector.FileMatcher
  • func (m *RustCargoTomlFileParser) Parse(filePath string) ([]model.Package, error)

Variables

var (
	ErrUnrecognizedExe = errors.New("unrecognized executable format")
	ErrNonRustBinary   = errors.New("non Rust auditable binary")
)

Functions

func Name

func Name() string

func NewPackageFromBinaryDependency

func NewPackageFromBinaryDependency(dependPackageList []rustaudit.Package, path string) []model.Package

func NewPkgFromCargoMetadata

func NewPkgFromCargoMetadata(c CargoPackageMetadata, m map[string]CargoPackageMetadata, filePath string) model.Package

func PkgType

func PkgType() model.PkgType

Types

type CargoPackageMetadata

type CargoPackageMetadata struct {
	Name         string   `toml:"name" json:"name"`
	Version      string   `toml:"version" json:"version"`
	Source       string   `toml:"source" json:"source"`
	Checksum     string   `toml:"checksum" json:"checksum"`
	Dependencies []string `toml:"dependencies" json:"dependencies"`
}

* * [[package]] * name = "ansi_term" * version = "0.12.1" * source = "registry+https://github.com/rust-lang/crates.io-index" * checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2" * dependencies = [ * "winapi", * ]

type Collector

type Collector struct {
	collector.BaseCollector
}

func NewCollector

func NewCollector() *Collector

func (*Collector) Collect

func (c *Collector) Collect() (pkgs []model.Package, err error)

type RustBinaryParser

type RustBinaryParser struct{}

RustBinaryParser is a parser for rust binary file see: https://github.com/rust-secure-code/cargo-auditable

func NewRustBinaryParser

func NewRustBinaryParser() RustBinaryParser

func (RustBinaryParser) Matcher

func (RustBinaryParser) Matcher() collector.FileMatcher

func (RustBinaryParser) Parse

func (RustBinaryParser) Parse(path string) (pkgs []model.Package, err error)

type RustCargoFileParser

type RustCargoFileParser struct {
}

RustCargoFileParser is a parser for Cargo.lock file see: https://doc.rust-lang.org/cargo/reference/manifest.html

https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

func NewCargoFileParser

func NewCargoFileParser() *RustCargoFileParser

NewCargoFileParser returns a new RustCargoFileParser

func (*RustCargoFileParser) Matcher

func (m *RustCargoFileParser) Matcher() collector.FileMatcher

func (*RustCargoFileParser) Parse

func (m *RustCargoFileParser) Parse(filePath string) ([]model.Package, error)

type RustCargoTomlFileParser

type RustCargoTomlFileParser struct {
}

RustCargoTomlFileParser is a parser for Cargo.toml file see: https://doc.rust-lang.org/cargo/reference/manifest.html

https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

func NewCargoTomlFileParser

func NewCargoTomlFileParser() *RustCargoTomlFileParser

NewCargoTomlFileParser returns a new RustCargoTomlFileParser

func (*RustCargoTomlFileParser) Matcher

func (m *RustCargoTomlFileParser) Matcher() collector.FileMatcher

func (*RustCargoTomlFileParser) Parse

func (m *RustCargoTomlFileParser) Parse(filePath string) ([]model.Package, error)