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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/* pmrciscoios.c
* This is a parser module for CISCO IOS "syslog" format.
*
* File begun on 2014-07-07 by RGerhards
*
* Copyright 2014 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* -or-
* see COPYING.ASL20 in the source distribution
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include "rsyslog.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <ctype.h>
#include "syslogd.h"
#include "conf.h"
#include "syslogd-types.h"
#include "template.h"
#include "msg.h"
#include "module-template.h"
#include "glbl.h"
#include "errmsg.h"
#include "parser.h"
#include "datetime.h"
#include "unicode-helper.h"
MODULE_TYPE_PARSER
MODULE_TYPE_NOKEEP
PARSER_NAME("rsyslog.ciscoios")
MODULE_CNFNAME("pmciscoios")
/* internal structures */
DEF_PMOD_STATIC_DATA
DEFobjCurrIf(errmsg)
DEFobjCurrIf(glbl)
DEFobjCurrIf(parser)
DEFobjCurrIf(datetime)
/* parser instance parameters */
static struct cnfparamdescr parserpdescr[] = {
{ "present.origin", eCmdHdlrBinary, 0 }
};
static struct cnfparamblk parserpblk =
{ CNFPARAMBLK_VERSION,
sizeof(parserpdescr)/sizeof(struct cnfparamdescr),
parserpdescr
};
struct instanceConf_s {
int bOriginPresent; /* is ORIGIN field present? */
};
BEGINisCompatibleWithFeature
CODESTARTisCompatibleWithFeature
if(eFeat == sFEATUREAutomaticSanitazion)
iRet = RS_RET_OK;
if(eFeat == sFEATUREAutomaticPRIParsing)
iRet = RS_RET_OK;
ENDisCompatibleWithFeature
/* create input instance, set default paramters, and
* add it to the list of instances.
*/
static rsRetVal
createInstance(instanceConf_t **pinst)
{
instanceConf_t *inst;
DEFiRet;
CHKmalloc(inst = MALLOC(sizeof(instanceConf_t)));
inst->bOriginPresent = 0;
*pinst = inst;
finalize_it:
RETiRet;
}
BEGINnewParserInst
struct cnfparamvals *pvals;
int i;
CODESTARTnewParserInst
DBGPRINTF("newParserInst (pmciscoios)\n");
CHKiRet(createInstance(&inst));
if(lst == NULL)
FINALIZE; /* just set defaults, no param block! */
if((pvals = nvlstGetParams(lst, &parserpblk, NULL)) == NULL) {
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
}
if(Debug) {
dbgprintf("parser param blk in pmciscoios:\n");
cnfparamsPrint(&parserpblk, pvals);
}
for(i = 0 ; i < parserpblk.nParams ; ++i) {
if(!pvals[i].bUsed)
continue;
if(!strcmp(parserpblk.descr[i].name, "present.origin")) {
inst->bOriginPresent = (int) pvals[i].val.d.n;
} else {
dbgprintf("pmciscoios: program error, non-handled "
"param '%s'\n", parserpblk.descr[i].name);
}
}
finalize_it:
CODE_STD_FINALIZERnewParserInst
if(lst != NULL)
cnfparamvalsDestruct(pvals, &parserpblk);
ENDnewParserInst
BEGINfreeParserInst
CODESTARTfreeParserInst
dbgprintf("pmciscoios: free parser instance %p\n", pInst);
ENDfreeParserInst
BEGINparse2
uchar *p2parse;
long long msgcounter;
int lenMsg;
int i;
int iHostname;
uchar bufParseTAG[512];
uchar bufParseHOSTNAME[CONF_HOSTNAME_MAXSIZE]; /* used by origin */
CODESTARTparse2
DBGPRINTF("Message will now be parsed by pmciscoios\n");
assert(pMsg != NULL);
assert(pMsg->pszRawMsg != NULL);
lenMsg = pMsg->iLenRawMsg - pMsg->offAfterPRI; /* note: offAfterPRI is already the number of PRI chars (do not add one!) */
p2parse = pMsg->pszRawMsg + pMsg->offAfterPRI; /* point to start of text, after PRI */
/* first obtain the MESSAGE COUNTER. It must be numeric up until
* the ": " terminator sequence
*/
msgcounter = 0;
while(lenMsg > 0 && (*p2parse >= '0' && *p2parse <= '9') ) {
msgcounter = msgcounter * 10 + *p2parse - '0';
++p2parse, --lenMsg;
}
DBGPRINTF("pmciscoios: msgcntr %lld\n", msgcounter);
/* delimiter check */
if(lenMsg < 2 || *p2parse != ':' || *(p2parse+1) != ' ') {
DBGPRINTF("pmciscoios: fail after seqno: '%s'\n", p2parse);
ABORT_FINALIZE(RS_RET_COULD_NOT_PARSE);
}
p2parse += 2;
/* ORIGIN (optional) */
if(pInst->bOriginPresent) {
iHostname = 0;
while( lenMsg > 1
&& !(*p2parse == ':' && *(p2parse+1) == ' ') /* IPv6 is e.g. "::1" (loopback) */
&& iHostname < (int) sizeof(bufParseHOSTNAME) - 1 ) {
bufParseHOSTNAME[iHostname++] = *p2parse++;
--lenMsg;
}
bufParseHOSTNAME[iHostname] = '\0';
/* delimiter check */
if(lenMsg < 2 || *(p2parse+1) != ' ') {
DBGPRINTF("pmciscoios: fail after origin: '%s'\n", p2parse);
ABORT_FINALIZE(RS_RET_COULD_NOT_PARSE);
}
p2parse += 2;
}
/* TIMESTAMP */
if(datetime.ParseTIMESTAMP3164(&(pMsg->tTIMESTAMP), &p2parse, &lenMsg, PARSE3164_TZSTRING) == RS_RET_OK) {
if(pMsg->dfltTZ[0] != '\0')
applyDfltTZ(&pMsg->tTIMESTAMP, pMsg->dfltTZ);
} else {
DBGPRINTF("pmciscoios: fail at timestamp: '%s'\n", p2parse);
ABORT_FINALIZE(RS_RET_COULD_NOT_PARSE);
}
/* Note: date parser strips ": ", so we cannot do the delimiter check here */
/* parse SYSLOG TAG. must always start with '%', else we have a field mismatch */
if(lenMsg < 1 || *p2parse != '%') {
DBGPRINTF("pmciscoios: fail at tag begin (no '%%'): '%s'\n", p2parse);
ABORT_FINALIZE(RS_RET_COULD_NOT_PARSE);
}
i = 0;
while(lenMsg > 0 && *p2parse != ':' && *p2parse != ' ' && i < (int) sizeof(bufParseTAG) - 2) {
bufParseTAG[i++] = *p2parse++;
--lenMsg;
}
/* delimiter check */
if(lenMsg < 2 || *p2parse != ':' || *(p2parse+1) != ' ') {
DBGPRINTF("pmciscoios: fail after tag: '%s'\n", p2parse);
ABORT_FINALIZE(RS_RET_COULD_NOT_PARSE);
}
++p2parse;
bufParseTAG[i++] = ':';
bufParseTAG[i] = '\0'; /* terminate string */
/* if we reach this point, we have a wellformed message and can persist the values */
MsgSetTAG(pMsg, bufParseTAG, i);
if(pInst->bOriginPresent)
MsgSetHOSTNAME(pMsg, bufParseHOSTNAME, iHostname);
MsgSetMSGoffs(pMsg, p2parse - pMsg->pszRawMsg);
setProtocolVersion(pMsg, MSG_LEGACY_PROTOCOL);
finalize_it:
ENDparse2
BEGINmodExit
CODESTARTmodExit
/* release what we no longer need */
objRelease(errmsg, CORE_COMPONENT);
objRelease(glbl, CORE_COMPONENT);
objRelease(parser, CORE_COMPONENT);
objRelease(datetime, CORE_COMPONENT);
ENDmodExit
BEGINqueryEtryPt
CODESTARTqueryEtryPt
CODEqueryEtryPt_STD_PMOD2_QUERIES
CODEqueryEtryPt_IsCompatibleWithFeature_IF_OMOD_QUERIES
ENDqueryEtryPt
BEGINmodInit()
CODESTARTmodInit
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
CODEmodInit_QueryRegCFSLineHdlr
CHKiRet(objUse(glbl, CORE_COMPONENT));
CHKiRet(objUse(errmsg, CORE_COMPONENT));
CHKiRet(objUse(parser, CORE_COMPONENT));
CHKiRet(objUse(datetime, CORE_COMPONENT));
DBGPRINTF("pmciscoios parser init called\n");
ENDmodInit
|
