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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/* Copyright (C) 2020-2021 Open Information Security Foundation
*
* You can copy, redistribute or modify this Program under the terms of
* the GNU General Public License version 2 as published by the Free
* Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
#include "suricata-common.h"
#include "suricata-plugin.h"
#include "suricata.h"
#include "runmodes.h"
#include "output-eve-syslog.h"
#include "util-plugin.h"
#include "util-debug.h"
#ifdef HAVE_PLUGINS
#include <dlfcn.h>
typedef struct PluginListNode_ {
SCPlugin *plugin;
void *lib;
TAILQ_ENTRY(PluginListNode_) entries;
} PluginListNode;
/**
* The list of loaded plugins.
*
* Currently only used as a place to stash the pointer returned from
* dlopen, but could have other uses, such as a plugin unload destructor.
*/
static TAILQ_HEAD(, PluginListNode_) plugins = TAILQ_HEAD_INITIALIZER(plugins);
static TAILQ_HEAD(, SCEveFileType_) output_types = TAILQ_HEAD_INITIALIZER(output_types);
static TAILQ_HEAD(, SCCapturePlugin_) capture_plugins = TAILQ_HEAD_INITIALIZER(capture_plugins);
bool RegisterPlugin(SCPlugin *plugin, void *lib)
{
BUG_ON(plugin->name == NULL);
BUG_ON(plugin->author == NULL);
BUG_ON(plugin->license == NULL);
BUG_ON(plugin->Init == NULL);
PluginListNode *node = SCCalloc(1, sizeof(*node));
if (node == NULL) {
SCLogError("Failed to allocate memory for plugin");
return false;
}
node->plugin = plugin;
node->lib = lib;
TAILQ_INSERT_TAIL(&plugins, node, entries);
SCLogNotice("Initializing plugin %s; author=%s; license=%s", plugin->name, plugin->author,
plugin->license);
(*plugin->Init)();
return true;
}
static void InitPlugin(char *path)
{
void *lib = dlopen(path, RTLD_NOW);
if (lib == NULL) {
SCLogNotice("Failed to open %s as a plugin: %s", path, dlerror());
} else {
SCLogNotice("Loading plugin %s", path);
SCPluginRegisterFunc plugin_register = dlsym(lib, "SCPluginRegister");
if (plugin_register == NULL) {
SCLogError("Plugin does not export SCPluginRegister function: %s", path);
dlclose(lib);
return;
}
if (!RegisterPlugin(plugin_register(), lib)) {
SCLogError("Plugin registration failed: %s", path);
dlclose(lib);
return;
}
}
}
void SCPluginsLoad(const char *capture_plugin_name, const char *capture_plugin_args)
{
ConfNode *conf = ConfGetNode("plugins");
if (conf == NULL) {
return;
}
ConfNode *plugin = NULL;
TAILQ_FOREACH(plugin, &conf->head, next) {
struct stat statbuf;
if (stat(plugin->val, &statbuf) == -1) {
SCLogError("Bad plugin path: %s: %s", plugin->val, strerror(errno));
continue;
}
if (S_ISDIR(statbuf.st_mode)) {
// coverity[toctou : FALSE]
DIR *dir = opendir(plugin->val);
if (dir == NULL) {
SCLogError("Failed to open plugin directory %s: %s", plugin->val, strerror(errno));
continue;
}
struct dirent *entry = NULL;
char path[PATH_MAX];
while ((entry = readdir(dir)) != NULL) {
if (strstr(entry->d_name, ".so") != NULL) {
snprintf(path, sizeof(path), "%s/%s", plugin->val, entry->d_name);
InitPlugin(path);
}
}
closedir(dir);
} else {
InitPlugin(plugin->val);
}
}
if (run_mode == RUNMODE_PLUGIN) {
SCCapturePlugin *capture = SCPluginFindCaptureByName(capture_plugin_name);
if (capture == NULL) {
FatalError("No capture plugin found with name %s", capture_plugin_name);
}
capture->Init(capture_plugin_args, RUNMODE_PLUGIN, TMM_RECEIVEPLUGIN,
TMM_DECODEPLUGIN);
}
}
static bool IsBuiltinTypeName(const char *name)
{
const char *builtin[] = {
"regular",
"unix_dgram",
"unix_stream",
"redis",
NULL,
};
for (int i = 0;; i++) {
if (builtin[i] == NULL) {
break;
}
if (strcmp(builtin[i], name) == 0) {
return true;
}
}
return false;
}
/**
* \brief Register an Eve file type.
*
* \retval true if registered successfully, false if the file type name
* conflicts with a built-in or previously registered
* file type.
*/
bool SCRegisterEveFileType(SCEveFileType *plugin)
{
/* First check that the name doesn't conflict with a built-in filetype. */
if (IsBuiltinTypeName(plugin->name)) {
SCLogError("Eve file type name conflicts with built-in type: %s", plugin->name);
return false;
}
/* Now check against previously registered file types. */
SCEveFileType *existing = NULL;
TAILQ_FOREACH (existing, &output_types, entries) {
if (strcmp(existing->name, plugin->name) == 0) {
SCLogError("Eve file type name conflicts with previously registered type: %s",
plugin->name);
return false;
}
}
SCLogDebug("Registering EVE file type plugin %s", plugin->name);
TAILQ_INSERT_TAIL(&output_types, plugin, entries);
return true;
}
SCEveFileType *SCPluginFindFileType(const char *name)
{
SCEveFileType *plugin = NULL;
TAILQ_FOREACH(plugin, &output_types, entries) {
if (strcmp(name, plugin->name) == 0) {
return plugin;
}
}
return NULL;
}
int SCPluginRegisterCapture(SCCapturePlugin *plugin)
{
TAILQ_INSERT_TAIL(&capture_plugins, plugin, entries);
SCLogNotice("Capture plugin registered: %s", plugin->name);
return 0;
}
SCCapturePlugin *SCPluginFindCaptureByName(const char *name)
{
SCCapturePlugin *plugin = NULL;
TAILQ_FOREACH(plugin, &capture_plugins, entries) {
if (strcmp(name, plugin->name) == 0) {
return plugin;
}
}
return plugin;
}
#endif
|
