Welcome to Canari Framework’s documentation!

Contents:

• Canari Quick Start
  • Installation
    • Installing Dependencies
    • Installing Canari
  • Hello World!
  • Your First Transform
    • Working With Input Entities
    • Using Configuration Files
    • Making Transforms Remote
• canari.framework - Canari Framework Annotations & Extras
  • Annotations
    • @RequireSuperUser Behavior
    • @EnableDebugWindow Behavior
    • Request Filtering with @RequestFilter
  • Foreign Language Support
• canari.maltego.message - Maltego Messaging Objects
  • Maltego Request and Response Objects
  • Communicating Exceptions
  • Communicating Diagnostic Information
  • Using and Defining Maltego Entities
    • Defining Entity Fields
    • Customizing ValidationError Error Messages
    • Creating Custom Entity Field Types
    • Adding Additional Information to Entities
    • Matching Rules and Maltego
    • Automatically Generating Canari Entity Definitions
• canari.config - Canari Configuration Files
  • Automatic Type Marshalling
  • Option String Interpolation
• canari.mode - Canari Execution Modes
• canari.maltego.entities Maltego Entities
  • maltego.TrackingCode (alias: maltego.UniqueIdentifier)
  • maltego.NSRecord
  • maltego.affiliation.Bebo (alias: AffiliationBebo)
  • maltego.NominatimLocation
  • maltego.EmailAddress
  • maltego.affiliation.Spock (alias: AffiliationSpock)
  • maltego.Unknown
  • maltego.DNSName
  • maltego.Webdir
  • maltego.Document
  • maltego.affiliation.Zoominfo
  • maltego.BuiltWithRelationship
  • maltego.Service
  • maltego.Organization
  • maltego.URL
  • maltego.affiliation.Orkut (alias: AffiliationOrkut)
  • maltego.Device
  • maltego.Location
  • maltego.Banner
  • maltego.Hashtag
  • maltego.AS (alias: ASNumber)
  • maltego.affiliation.Linkedin (alias: AffiliationLinkedin)
  • maltego.File
  • maltego.CircularArea
  • maltego.IPv4Address (alias: IPAddress)
  • maltego.affiliation.Facebook (alias: AffiliationFacebook)
  • maltego.PhoneNumber
  • maltego.Tweet
  • maltego.affiliation.Flickr (alias: AffiliationFlickr)
  • maltego.FacebookObject
  • maltego.WebTitle
  • maltego.GPS
  • maltego.MXRecord
  • maltego.affiliation.Affiliation
  • maltego.Person
  • maltego.affiliation.WikiEdit
  • maltego.Domain
  • maltego.Vulnerability (alias: Vuln)
  • maltego.Alias
  • maltego.Sentiment
  • maltego.Phrase
  • maltego.affiliation.Twitter (alias: AffiliationTwitter)
  • maltego.BuiltWithTechnology
  • maltego.Port
  • maltego.TwitterUserList
  • maltego.Company
  • maltego.Website
  • maltego.Twit
  • maltego.affiliation.MySpace (alias: AffiliationMySpace)
  • maltego.Image
  • maltego.Hash
  • maltego.Netblock

Indices and tables

• Index
• Module Index
• Search Page