1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use crate::_osquery as osquery;
use crate::plugin::Registry;

pub trait OsqueryPlugin {
    // Name is the name used to refer to the plugin (eg. the name of the
    // table the plugin implements).
    fn name(&self) -> String;

    // RegistryName is which "registry" the plugin should be added to.
    // Valid names are ["config", "logger", "table"].
    fn registry(&self) -> Registry;

    // Routes returns the detailed information about the interface exposed
    // by the plugin. See the example plugins for samples.
    fn routes(&self) -> osquery::ExtensionPluginResponse;

    // Ping implements a health check for the plugin. If the plugin is in a
    // healthy state, StatusOK should be returned.
    fn ping(&self) -> osquery::ExtensionStatus;

    // Call requests the plugin to perform its defined behavior, returning
    // a response containing the result.
    // Request: {"action": "generate", "context": "{\"constraints\":[{\"name\":\"h1\",\"list\":[],\"affinity\":\"TEXT\"},{\"name\":\"h2\",\"list\":[],\"affinity\":\"INTEGER\"},{\"name\":\"h3\",\"list\":[],\"affinity\":\"TEXT\"}],\"colsUsed\":[\"h3\",\"h2\",\"h1\"],\"colsUsedBitset\":7}"}
    fn call(&self, req: osquery::ExtensionPluginRequest) -> osquery::ExtensionResponse;

    // Shutdown alerts the plugin to stop.
    fn shutdown(&self);
}