aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/snort/snort.api
blob: 5c65f79e68a1dfee02d845231d9a205806afd1b2 (plain)
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
215
216
217
218
219
220
221
222
223
224
225
226
option version = "1.0.0";

import "vnet/interface_types.api";
import "vnet/ip/ip_types.api";

define snort_instance_create {
        u32 client_index;
        u32 context;
	u32 queue_size;
	u8 drop_on_disconnect;
	string name[];
};

define snort_instance_create_reply {
        u32 context;
        i32 retval;
	u32 instance_index;
};

define snort_instance_delete {
        u32 client_index;
        u32 context;
	u32 instance_index;
};

define snort_instance_delete_reply {
        u32 context;
	i32 retval;
};

define snort_client_disconnect {
        u32 client_index;
        u32 context;
	u32 snort_client_index;
};

define snort_client_disconnect_reply {
        u32 context;
	i32 retval;
};

define snort_instance_disconnect {
        u32 client_index;
        u32 context;
	u32 instance_index;
};

define snort_instance_disconnect_reply {
        u32 context;
	i32 retval;
};

define snort_interface_attach {
        u32 client_index;
        u32 context;
	u32 instance_index;
	u32 sw_if_index;
	u8 snort_dir;
};

define snort_interface_attach_reply {
	u32 context;
	i32 retval;
};

define snort_interface_detach {
        u32 client_index;
        u32 context;
	u32 sw_if_index;
};

define snort_interface_detach_reply {
	u32 context;
	i32 retval;
};

define snort_input_mode_get {
        u32 client_index;
        u32 context;
};

define snort_input_mode_get_reply {
        u32 context;
        i32 retval;
	u32 snort_mode;
};

define snort_input_mode_set {
        u32 client_index;
        u32 context;
	u8 input_mode;
};

define snort_input_mode_set_reply {
        u32 context;
        i32 retval;
};

service {
  rpc snort_instance_get returns snort_instance_get_reply
    stream snort_instance_details;
};

/** \brief Get snort instance(s).
    @param client_index - opaque cookie to identify the sender.
    @param context - sender context
    @param cursor - current iterator value (all requested).
    @param instance_index - instance index (~0 for all).
*/
define snort_instance_get
{
	u32 client_index;
	u32 context;
	u32 cursor;
	u32 instance_index;
};

/** \brief Reply for snort instance(s).
    @param context - sender context
    @param retval - return code for the request.
    @param cursor - iterator value to continue with (if there is more).
*/
define snort_instance_get_reply
{
	u32 context;
	i32 retval;
	u32 cursor;
};

/** \brief Details of a snort instance.
    @param context - sender context
    @param instance - snort instance info.
*/
define snort_instance_details {
	u32 context;
	u32 instance_index;
	u32 shm_size;
	u32 shm_fd;
	u8 drop_on_disconnect;
	u32 snort_client_index;
	string name[];
};

service {
  rpc snort_interface_get returns snort_interface_get_reply
    stream snort_interface_details;
};

/** \brief Get snort interface(s).
    @param client_index - opaque cookie to identify the sender.
    @param context - sender context
    @param cursor - current iterator value (all requested).
    @param sw_if_index - sw if index (~0 for all).
*/
define snort_interface_get
{
	u32 client_index;
	u32 context;
	u32 cursor;
	u32 sw_if_index;
};

/** \brief Reply for snort interface(s).
    @param context - sender context
    @param retval - return code for the request.
    @param cursor - iterator value to continue with (if there is more).
*/
define snort_interface_get_reply
{
	u32 context;
	i32 retval;
	u32 cursor;
};

/** \brief Details of a snort interface.
    @param context - sender context
    @param sw_if_index - interface index
    @param instance_index - snort instance the interface is attached to.
*/
define snort_interface_details {
	u32 context;
	u32 sw_if_index;
	u32 instance_index;
};

service {
  rpc snort_client_get returns snort_client_get_reply
    stream snort_client_details;
};

/** \brief Get snort clients.
    @param client_index - opaque cookie to identify the sender.
    @param context - sender context
    @param cursor - current iterator value (all requested).
    @param client_index (~0 for all).
*/
define snort_client_get
{
	u32 client_index;
	u32 context;
	u32 cursor;
	u32 snort_client_index;
};

/** \brief Reply for snort clients.
    @param context - sender context
    @param retval - return code for the request.
    @param cursor - iterator value to continue with (if there is more).
*/
define snort_client_get_reply
{
	u32 context;
	i32 retval;
	u32 cursor;
};

/** \brief Details of a snort client.
    @param context - sender context
    @param client index
    @param instance_index - snort instance of the client.
*/
define snort_client_details {
	u32 context;
	u32 client_index;
	u32 instance_index;
};