# README

Recog-Go: Pattern Recognition using Rapid7 Recog

This is a Go implementation of the Recog library and fingerprint database from Rapid7.

This package requires a checkout of the recog repository in order to build.

Recog-Go is open source, please see the LICENSE file for more information.

To build and install:

$ git clone https://github.com/rapid7/recog.git /path/to/recog
$ RECOG_XML=/path/to/recog/xml go generate
$ go install . ./cmd/...

No description provided by the author

No description provided by the author

LoadFingerprintDB parses a Recog XML file from a byte array and returns a FingerprintDB.

LoadFingerprintDBFromFile parses a Recog XML file from disk and returns a FingerprintDB.

LoadFingerprints parses embedded Recog XML databases, returning a FingerprintSet.

LoadFingerprintsDir parses Recog XML files from a local directory, returning a FingerprintSet.

MustLoadFingerprints loads the built-in fingerprints, panicing otherwise.

NewFingerprintSet returns an allocated FingerprintSet structure.

RecogXML statically implements the virtual filesystem provided to vfsgen.

Fingerprint represents a unique Recog fingerprint definition.

FingerprintDB represents a fingerprint database.

FingerprintDescription contains a human-readable description of this fingerprint entry.

FingerprintExample contains an example match string.

FingerprintMatch represents a match of a fingerprint to some data.

FingerprintParam represents a matched parameter.

FingerprintSet is a collection of loaded Recog fingerprint databases.