analyzers

Documentation

Overview

Copyright 2023 Meta Platforms, Inc. and affiliates.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• func Add[inputType any](r *Registry, id analysis.AnalyzerID, ...) error
• func Get[inputType any](r *Registry, id analysis.AnalyzerID) analysis.Analyzer[inputType]
• type AnalyzerFactory
• type Registry
  • func NewRegistry() *Registry
  • func NewRegistryWithKnownAnalyzers() (*Registry, error)
  • func (r *Registry) IDs() []analysis.AnalyzerID

Functions

func Add

func Add[inputType any](r *Registry, id analysis.AnalyzerID, analyzerFactory AnalyzerFactory[inputType]) error

Add registers provided analyzer

func Get

func Get[inputType any](r *Registry, id analysis.AnalyzerID) analysis.Analyzer[inputType]

Get returns a new instance of required analyzer by id

TODO: remove `id analysis.AnalyzerID`, use the `inputType` to find a proper registry.

Types

type AnalyzerFactory

type AnalyzerFactory[inputType any] func() analysis.Analyzer[inputType]

AnalyzerFactory represents a factory method for new analyzers

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry provides access to all standalone firmware analyzers

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new Registry instance

func NewRegistryWithKnownAnalyzers

func NewRegistryWithKnownAnalyzers() (*Registry, error)

NewRegistryWithKnownAnalyzers creates a new Registry instance and registers all analyzers from the analyzers subpackages

func (*Registry) IDs

func (r *Registry) IDs() []analysis.AnalyzerID

IDs returns a list of IDs of all registered analyzers