summaryrefslogtreecommitdiff
path: root/debug_syslog.c
blob: 2644246062f138b116c8e32f6c5634199ca3b0c5 (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
227
228
229
230
231
232
233
234
235
236
237
238
239
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set et sw=2 ts=2: */
/***************************************************************************
 *            debug_syslog.c
 *
 *  Fri Dec  7 14:24:54 CET 2012
 *  Copyright 2012 Jonas Suhr Christensen
 *  jsc@umbraculum.org
 ****************************************************************************/

/*
 *  This file is part of Debug Module.
 *
 *  Debug Module is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  Debug Module 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
 *  along with Debug Module; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */
#include "debug_syslog.h"

#include <stdio.h>
#include <string.h>
#include <time.h>

#include <sys/socket.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <netinet/in.h>
#include <errno.h>

#include "debug_util.h"

#ifndef WITH_DBG_SYSLOG
#warning debug_syslog.c compiled but WITH_DBG_SYSLOG not defined
#endif

#define SYSLOG_MSGLEN 1024
#define SYSLOG_PRILEN 5
#define SYSLOG_TIMELEN 32 
#define SYSLOG_TAGLEN 32
#define SYSLOG_CONTENTLEN SYSLOG_MSGLEN - SYSLOG_PRILEN - SYSLOG_TIMELEN - SYSLOG_TAGLEN
//#define SYSLOG_CONTENTLEN SYSLOG_MSGLEN - SYSLOG_PRILEN - SYSLOG_TAGLEN - SYSLOG_HEADERLEN -1

#define SYSLOG_LENOFEXECNAME 256

static int dbg_syslog_sock;
static struct sockaddr_in dbg_syslog_sockaddr;
static pid_t pid;
static char execname[SYSLOG_LENOFEXECNAME];

void dbg_syslog_init(const char* host, int port) 
{
  printf("Initializing syslog module remote %s:%d\n", host, port);
  if ( (dbg_syslog_sock = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0) {
    fprintf(stderr, "Failed to create socket\n");
    return;  
  }
  memset(&dbg_syslog_sockaddr, 0, sizeof(dbg_syslog_sockaddr));
  dbg_syslog_sockaddr.sin_family = AF_INET;
  dbg_syslog_sockaddr.sin_addr.s_addr = inet_addr(host);
  dbg_syslog_sockaddr.sin_port = htons(port);

  // This implementation has all kind of possible errors:
  //   * It is Linux only
  //   * Max length of execname (including path, avoid this by cmdline file in reverse order) 
  //     is set to SYSLOG_LENOFEXECNAME
  //   * If not found execname is ""
  pid = getpid();
  char buf[SYSLOG_LENOFEXECNAME];
  FILE* f = fopen("/proc/self/cmdline", "r");
  if(f) {
    char* s = NULL;
    s = fgets(buf, SYSLOG_LENOFEXECNAME, f);
    fclose(f);
  }
  
  char* bufptr = strrchr(buf, '/');
  if(bufptr) {
    strncpy(execname, bufptr+1, SYSLOG_LENOFEXECNAME-1);
  }
  else {
    strcpy(execname, "\0");
  }

  printf("\tRunning as %s with pid %d\n", execname, pid);
}

/*
void dbg_syslog_createheader() {
  const time_t rawtime = time(NULL);
  struct tm time;
  localtime_r(&rawtime, &time);
  char timebuf[256];
  strftime(timebuf, 256, "%b %e %H:%M:%S ", &time);

  char bufpri[SYSLOG_PRILEN] = "<20>";
  char buftag[SYSLOG_TAGLEN] = "PROGRAM[PID]: ";

}
*/

/*
 * Syslog message specification (based on rfc3164). 
 * Modified after reading syslog v2. documentation
 *
 * MSG: "<%d%d>%s %s %s%c%s", FACILITY, SEVERITY, TIME, CLIENT, TAG, DELIM, CONTENT
 * 
 * Example:
 *   <34>Oct 11 22:14:15 mymachine su: 'su root' failed for lonvick on /dev/pts/8
 *
 *
 * NOTE! Length of MSG must not exceed 1024 characters!
 *
 * FACILITY:
 *      0             kernel messages
 *      1             user-level messages
 *      2             mail system
 *      3             system daemons
 *      4             security/authorization messages (note 1)
 *      5             messages generated internally by syslogd
 *      6             line printer subsystem
 *      7             network news subsystem
 *      8             UUCP subsystem
 *      9             clock daemon (note 2)
 *      10            security/authorization messages (note 1)
 *      11            FTP daemon
 *      12            NTP subsystem
 *      13            log audit (note 1)
 *      14            log alert (note 1)
 *      15            clock daemon (note 2)
 *      16            local use 0  (local0)
 *      17            local use 1  (local1)
 *      18            local use 2  (local2)
 *      19            local use 3  (local3)
 *      20            local use 4  (local4)
 *      21            local use 5  (local5)
 *      22            local use 6  (local6)
 *      23            local use 7  (local7)
 *
 * SEVERITY:
 *      0       Emergency: system is unusable
 *      1       Alert: action must be taken immediately
 *      2       Critical: critical conditions
 *      3       Error: error conditions
 *      4       Warning: warning conditions
 *      5       Notice: normal but significant condition
 *      6       Informational: informational messages
 *      7       Debug: debug-level messages
 *
 * TIME:
 *     Time of message formatted like: Mmm dd hh:mm:ss
 *
 * CLIENT:
 *     Hostname or
 *     IPv4 address or
 *     IPv6 address
 *
 * TAG: format: PROGRAM[PID]
 *     Program or process information
 *     PROGRAM is Alphanumeric 
 *     PID is numeric 
 *     Must not exceed 32 characters
 * 
 * DELIM:
 *     A nonn-alphanumeric character (eg. ':', '[' ...)
 *     In implementation DELIM is the first character of CONTENT
 *
 * CONTENT:
 *     The message to log.
 *     String of printable characters
 *
 * */

void dbg_syslog_output(char* msg) 
{
  if(dbg_syslog_sock < 0) return;

  const time_t rawtime = time(NULL);
  struct tm time;
  dbg_localtime(&rawtime, &time);
  char buftime[SYSLOG_TIMELEN];
  strftime(buftime, SYSLOG_TIMELEN, "%b %e %H:%M:%S ", &time);

  // Currently everything is mapped to local facility 4 as debug
  char bufpri[SYSLOG_PRILEN];
  strncpy(bufpri, "<167>", SYSLOG_PRILEN);

  char buftag[SYSLOG_TAGLEN];
  snprintf(buftag, SYSLOG_TAGLEN, "%s[%d]: ", execname, pid);

  char buf[SYSLOG_MSGLEN];
  memset(buf, 0, sizeof(buf));
  strncat(buf, bufpri, SYSLOG_PRILEN);
  strncat(buf, buftime, SYSLOG_TIMELEN);
  strncat(buf, buftag, SYSLOG_TAGLEN);
  strncat(buf, msg, SYSLOG_CONTENTLEN);
  strcat(buf, "\n");


//  printf("Sending to syslog: %s\n", buf);
  int buf_len = strlen(buf);
  if((sendto(dbg_syslog_sock, buf, buf_len, 0, (struct sockaddr *) &dbg_syslog_sockaddr, 
             sizeof(dbg_syslog_sockaddr))) != buf_len) {
    fprintf(stderr, "Failed to send message successfully: %s\n", strerror(errno));
  }
}

void dbg_syslog_close() {
  printf("Closing syslog module\n");
  if(dbg_syslog_sock < 0) return;
  close(dbg_syslog_sock);
}

#ifdef TEST_DEBUG_SYSLOG
//Additional dependency files
//deps:
//Required cflags (autoconf vars may be used)
//cflags:
//Required link options (autoconf vars may be used)
//libs:
#include "test.h"

TEST_BEGIN;

// TODO: Put some testcode here (see test.h for usable macros).
TEST_TRUE(false, "No tests yet!");

TEST_END;

#endif/*TEST_DEBUG_SYSLOG*/