configuration

package
v0.0.0-...-b501c47 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2021 License: GPL-3.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GlobalConfigFromBytes 

func GlobalConfigFromBytes(data []byte) (conf *globalConfig, err error)

GlobalConfigFromBytes - Unmarshal a Maltego Transform Configuration as bytes If unmarshaling fails, returns a default, empty (but non-nil) configuration, and an error to indicate the user that some action might be required for perfect work.

func GlobalConfigFromFile 

func GlobalConfigFromFile(path string) (conf *globalConfig, err error)

GlobalConfigFromFile - Reads the Maltego Transform Configuration file located at path. If not found, returns a default, empty (but non-nil) configuration, and an error to indicate the user that some action might be required for perfect work.

Types

type BuiltinTransform 

type BuiltinTransform string

BuiltinTransform - A builtin Maltego transform name 

const (
	ConvertToDomain             BuiltinTransform = "Convert to Domain"
	DomainsUsingMXNS            BuiltinTransform = "Domains using MX NS"
	FindOnWebpage               BuiltinTransform = "Find on webpage"
	RelatedEmailAddresses       BuiltinTransform = "Related Email addresses"
	DNSFromDomain               BuiltinTransform = "DNS from Domain"
	EmailAddressesFromDomain    BuiltinTransform = "Email addresses from Domain"
	IPOwnerDetail               BuiltinTransform = "IP owner detail"
	ResolveToIP                 BuiltinTransform = "Resolve to IP"
	DNSFromIP                   BuiltinTransform = "DNS from IP"
	EmailAddressesFromPerson    BuiltinTransform = "Email addresses from Person"
	InfoFromNS                  BuiltinTransform = "Info from NS"
	DomainFromDNS               BuiltinTransform = "Domain From DNS"
	FilesAndDocumentsFromDomain BuiltinTransform = "Files and Documents from Domain"
	LinksInAndOutOfSite         BuiltinTransform = "Links in and out of site"
	DomainOwnerDetail           BuiltinTransform = "Domain owner detail"
	FilesAndDocumentsFromPhrase BuiltinTransform = "Files and Documents from Phrase"
)

type EntityCategory 

type EntityCategory struct {
}

EntityCategory - A type holding information on a category of Entities, and able to write itself as XML for a configuration.

func (EntityCategory) WriteConfig 

func (ec EntityCategory) WriteConfig(path string) (err error)

WriteConfig - The EntityCategory creates a file in path/EntityCategories/EntityCategoryName, and writes itself as an XML message into it.

type IOConstraint 

type IOConstraint struct {
	Min  int    `xml:"min"`
	Max  int    `xml:"max"`
	Type string `xml:"type"`
}

IOConstraint - A set of Input/Output constraint parameters to be applied to a Entity used by a Transform.

type PropertyType 

type PropertyType string

PropertyType - String representation of a Property type 

const (
	PropertyTypeString  PropertyType = "string"
	PropertyTypeBoolean PropertyType = "boolean"
	PropertyTypeInteger PropertyType = "int"
)

type Transform 

type Transform struct {
	TransformInfo
	Abstract          bool
	Template          bool
	Visibility        VisibilityType
	TransformAdapter  TransformAdapter
	Authenticator     string
	LocationRelevance string            `xml:"locationRelevance,attr"`
	Sets              []string          `xml:"defaultSets"`             // Optional name of a transform set to which we belong
	Settings          TransformSettings `xml:"Properties"`              // All transform settings, and their local configuration.
	Input             []IOConstraint    `xml:"InputConstraints>Entity"` // Input Entity, max/min/type
	Output            []IOConstraint    `xml:"OutputEntities>Entity"`   // Output Entity types/max/min
}

Transform - A type holding all the information for a Transform, and able to write itself as XML for inclusion in a configuration file

func (*Transform) WriteConfig 

func (t *Transform) WriteConfig(path string) (err error)

WriteConfig - The transform creates a file in path/TransformRegistries/TransformLocal/TransformName, and writes itself as an XML message into it.

type TransformAdapter 

type TransformAdapter string

TransformAdapter - Defines the transform adapter for the running transform. Currently, there are only two transform adapters available in Maltego. They are listed below. This is just an enumeration class. 

const (
	TransformAdapterLocal   TransformAdapter = "com.paterva.maltego.transform.protocol.v2.LocalTransformAdapterV2"
	TransformAdapterLocalv2 TransformAdapter = "com.paterva.maltego.transform.protocol.v2api.LocalTransformAdapterV2"
	TransformAdapterRemote  TransformAdapter = "com.paterva.maltego.transform.protocol.v2.RemoteTransformAdapterV2"
)

type TransformInfo 

type TransformInfo struct {
	Name         string
	DisplayName  string `xml:"displayName,attr"`
	Description  string // Defaults to the Go-doc comment of the user-provided TransformFunc
	HelpURL      string `xml:"helpURL,attr"`
	Author       string
	Owner        string
	Version      string
	RequireInfo  bool   `xml:"requireDisplayInfo,attr"`
	Help         string `xml:",cdata"`
	Disclaimer   string `xml:",cdata"`
	StealthLevel int
	Debug        string // Whether the transform should open a debugging window in Maltego when executed.
}

TransformInfo - A type holding all user-facing information for a transform, excluding its input/output entities. This type is embedded into the maltego.Transform type and the configuration.Transform, one (used for marshalling Maltego configurations).

type TransformProperty 

type TransformProperty struct {
	Name         string
	DisplayName  string
	DefaultValue string
	SampleValue  string
	Abstract     bool
	Description  string
	Hidden       bool
	Nullable     bool
	ReadOnly     bool
	Popup        bool
	Type         string // Enum
	Visibility   string // Enum
}

TransformProperty - A type very similar to an Entity property, targeting a transform.

type TransformServer 

type TransformServer struct {
}

TransformServer - A type holding all the information of a Transform Server, and able to marshal itself as an XML object for inclusion in a configuration.

func (TransformServer) WriteConfig 

func (ts TransformServer) WriteConfig(path string) (err error)

WriteConfig - The TransformServer creates a file in path/Servers/TransformServerName, and writes itself as an XML message into it.

type TransformSet 

type TransformSet struct {
	Description string
	Transforms  []Transform
}

TransformSet - A set of Maltego transforms

func (TransformSet) WriteConfig 

func (t TransformSet) WriteConfig(path string) (err error)

WriteConfig - The transform set creates a file in path/TransformSets/TransformSetName, and writes itself as an XML message into it.

type TransformSettings 

type TransformSettings struct {
	Enabled    bool
	RunWithAll bool
	Favorite   bool
	Accepted   bool                `xml:"disclaimerAccepted,attr"`
	ShowHelp   bool                `xml:"showHelp,attr"`
	Settings   []TransformProperty // The settings added by the user, before XML marshalling
}

TransformSettings - Holds all settings for a Transform, and their local configurations.

func (*TransformSettings) MarshalXML 

func (ts *TransformSettings) MarshalXML(e *xml.Encoder, start xml.StartElement) (err error)

MarshalXML - The Transform Settings implement the xml.Marshaller interface in order to marshal a few of its elements that are not accessible to Transform writers, like Properties.

type VisibilityType 

type VisibilityType string

VisibilityType - Defines the visibility of a Transform 

const (
	VisibilityTypePublic  VisibilityType = "public"
	VisibilityTypePrivate VisibilityType = "private"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.