mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-08 10:23:54 +00:00
61 lines
1.8 KiB
C++
61 lines
1.8 KiB
C++
/*
|
|
* Copyright (c) 2014-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <map>
|
|
#include <functional>
|
|
|
|
#include <osquery/config.h>
|
|
#include <osquery/database.h>
|
|
|
|
namespace osquery {
|
|
|
|
/// Enforce specific types of decoration.
|
|
enum DecorationPoint {
|
|
DECORATE_LOAD,
|
|
DECORATE_ALWAYS,
|
|
DECORATE_INTERVAL,
|
|
};
|
|
|
|
/// Define a map of decoration points to their expected configuration key.
|
|
extern const std::map<DecorationPoint, std::string> kDecorationPointKeys;
|
|
|
|
/**
|
|
* @brief Iterate the discovered decorators for a given point type.
|
|
*
|
|
* The configuration maintains various sources, each may contain a set of
|
|
* decorators. The source tracking is abstracted for the decorator iterator.
|
|
*
|
|
* @param point request execution of decorators for this given point.
|
|
* @param time an optional time for points using intervals.
|
|
* @param source restrict run to a specific config source.
|
|
*/
|
|
void runDecorators(DecorationPoint point,
|
|
size_t time = 0,
|
|
const std::string& source = "");
|
|
|
|
/**
|
|
* @brief Access the internal storage of the Decorator parser.
|
|
*
|
|
* The decoration set is a map of column name to value. It contains the opaque
|
|
* set of decoration point results.
|
|
*
|
|
* Decorations are applied to log items before they are sent to the downstream
|
|
* logging APIs: logString, logSnapshot, etc.
|
|
*
|
|
* @param results the output parameter to write decorations.
|
|
*/
|
|
void getDecorations(std::map<std::string, std::string>& results);
|
|
|
|
/// Clear decorations for a source when it updates.
|
|
void clearDecorations(const std::string& source);
|
|
}
|