1 /* $NetBSD: syslogd.h,v 1.4 2013/05/27 23:15:51 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Martin Sch�tte. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 #ifndef SYSLOGD_H_ 39 #define SYSLOGD_H_ 40 /* 41 * hold common data structures and prototypes 42 * for syslogd.c and tls.c 43 * 44 */ 45 46 #include <sys/cdefs.h> 47 #define MAXLINE 1024 /* maximum line length */ 48 #define MAXSVLINE 120 /* maximum saved line length */ 49 #define DEFUPRI (LOG_USER|LOG_NOTICE) 50 #define DEFSPRI (LOG_KERN|LOG_NOTICE) 51 #define TIMERINTVL 30 /* interval for checking flush, mark */ 52 #define TTYMSGTIME 1 /* timeout passed to ttymsg */ 53 54 #include <sys/param.h> 55 #include <sys/socket.h> 56 #include <sys/sysctl.h> 57 #include <sys/types.h> 58 #include <sys/un.h> 59 #include <sys/wait.h> 60 #include <sys/queue.h> 61 #include <netinet/in.h> 62 #include <sys/event.h> 63 #include <event.h> 64 65 #include <assert.h> 66 #include <ctype.h> 67 #include <errno.h> 68 #include <fcntl.h> 69 #include <grp.h> 70 #include <locale.h> 71 #include <netdb.h> 72 #include <pwd.h> 73 #include <signal.h> 74 #include <stdarg.h> 75 #include <stdio.h> 76 #include <stdlib.h> 77 #include <string.h> 78 #include <unistd.h> 79 #include <stdbool.h> 80 #include <utmp.h> 81 #ifdef __NetBSD_Version__ 82 #include <util.h> 83 #include "utmpentry.h" 84 #endif /* __NetBSD_Version__ */ 85 #ifdef __FreeBSD_version 86 #include <libutil.h> 87 #include <sys/stat.h> 88 #include <sys/uio.h> 89 #include <limits.h> 90 #endif /* __FreeBSD_version */ 91 92 #ifndef DISABLE_TLS 93 #include <netinet/tcp.h> 94 #include <openssl/ssl.h> 95 #endif /* !DISABLE_TLS */ 96 97 #include <sys/stdint.h> 98 #include <sys/resource.h> 99 100 #include "pathnames.h" 101 #include <sys/syslog.h> 102 103 /* some differences between the BSDs */ 104 #ifdef __FreeBSD_version 105 #undef _PATH_UNIX 106 #define _PATH_UNIX "kernel" 107 #define HAVE_STRNDUP 0 108 #endif /* __FreeBSD_version */ 109 110 #ifdef __NetBSD_Version__ 111 #define HAVE_STRNDUP 1 112 #define HAVE_DEHUMANIZE_NUMBER 1 113 #endif /* __NetBSD_Version__ */ 114 115 #ifdef __minix 116 #undef _PATH_UNIX 117 #define _PATH_UNIX "kernel" 118 #endif /* __minix */ 119 120 #ifndef HAVE_DEHUMANIZE_NUMBER /* not in my 4.0-STABLE yet */ 121 extern int dehumanize_number(const char *str, int64_t *size); 122 #endif /* !HAVE_DEHUMANIZE_NUMBER */ 123 124 #if !HAVE_STRNDUP 125 char *strndup(const char *str, size_t n); 126 #endif /* !HAVE_STRNDUP */ 127 128 #ifndef __minix 129 #ifdef LIBWRAP 130 #include <tcpd.h> 131 #endif 132 #endif /* !__minix */ 133 134 #define FDMASK(fd) (1 << (fd)) 135 136 #define A_CNT(x) (sizeof((x)) / sizeof((x)[0])) 137 138 /* debug messages with categories */ 139 #define D_NONE 0 140 #define D_CALL 1 /* function calls */ 141 #define D_DATA 2 /* syslog message reading/formatting */ 142 #define D_NET 4 /* sockets/network */ 143 #define D_FILE 8 /* local files */ 144 #define D_TLS 16 /* TLS */ 145 #define D_PARSE 32 /* configuration/parsing */ 146 #define D_EVENT 64 /* libevent */ 147 #define D_BUFFER 128 /* message queues */ 148 #define D_MEM 256 /* malloc/free */ 149 #define D_MEM2 1024 /* every single malloc/free */ 150 #define D_SIGN 2048 /* -sign */ 151 #define D_MISC 4096 /* everything else */ 152 #define D_ALL (D_CALL | D_DATA | D_NET | D_FILE | D_TLS | D_PARSE | \ 153 D_EVENT | D_BUFFER | D_MEM | D_MEM2 | D_SIGN | D_MISC) 154 #define D_DEFAULT (D_CALL | D_NET | D_FILE | D_TLS | D_MISC) 155 156 157 /* build with -DNDEBUG to remove all assert()s and DPRINTF()s */ 158 #ifdef NDEBUG 159 #define DPRINTF(x, ...) (void)0 160 #else 161 #define DPRINTF(x, ...) /*LINTED null effect */(void)(Debug & (x) \ 162 ? (printf("%s:%s:%s:%.4d\t", make_timestamp(NULL, true), \ 163 __FILE__, __func__, __LINE__), printf(__VA_ARGS__)) : 0) 164 #endif 165 166 /* shortcuts for libevent */ 167 #define EVENT_ADD(x) do { \ 168 DPRINTF(D_EVENT, "event_add(%s@%p)\n", #x, x); \ 169 if (event_add(x, NULL) == -1) { \ 170 DPRINTF(D_EVENT, "Failure in event_add()\n"); \ 171 } \ 172 } while (/*CONSTCOND*/0) 173 #define RETRYEVENT_ADD(x) do { \ 174 struct timeval _tv; \ 175 _tv.tv_sec = 0; \ 176 _tv.tv_usec = TLS_RETRY_EVENT_USEC; \ 177 DPRINTF(D_EVENT, "retryevent_add(%s@%p)\n", #x, x); \ 178 if (event_add(x, &_tv) == -1) { \ 179 DPRINTF(D_EVENT, "Failure in event_add()\n"); \ 180 } \ 181 } while (/*CONSTCOND*/0) 182 #define DEL_EVENT(x) do { \ 183 DPRINTF(D_MEM2, "DEL_EVENT(%s@%p)\n", #x, x); \ 184 if ((x) && (event_del(x) == -1)) { \ 185 DPRINTF(D_EVENT, "Failure in event_del()\n"); \ 186 } \ 187 } while (/*CONSTCOND*/0) 188 189 /* safe calls to free() */ 190 #define FREEPTR(x) if (x) { \ 191 DPRINTF(D_MEM2, "free(%s@%p)\n", #x, x); \ 192 free(x); x = NULL; } 193 #define FREE_SSL(x) if (x) { \ 194 DPRINTF(D_MEM2, "SSL_free(%s@%p)\n", #x, x); \ 195 SSL_free(x); x = NULL; } 196 #define FREE_SSL_CTX(x) if (x) { \ 197 DPRINTF(D_MEM2, "SSL_CTX_free(%s@%p)\n", #x, x); \ 198 SSL_CTX_free(x); x = NULL; } 199 200 /* reference counting macros for buffers */ 201 #define NEWREF(x) ((x) ? (DPRINTF(D_BUFFER, "inc refcount of " #x \ 202 " @ %p: %zu --> %zu\n", (x), (x)->refcount, \ 203 (x)->refcount + 1), (x)->refcount++, (x))\ 204 : (DPRINTF(D_BUFFER, "inc refcount of NULL!\n"), NULL)) 205 #define DELREF(x) /*LINTED null effect*/(void)((x) ? (DPRINTF(D_BUFFER, "dec refcount of " #x \ 206 " @ %p: %zu --> %zu\n", (x), (x)->refcount, \ 207 (x)->refcount - 1), buf_msg_free(x), NULL) \ 208 : (DPRINTF(D_BUFFER, "dec refcount of NULL!\n"), NULL)) 209 210 /* assumption: 211 * - malloc()/calloc() only fails if not enough memory available 212 * - once init() has set up all global variables etc. 213 * the bulk of available memory is used for buffers 214 * and can be freed if necessary 215 */ 216 #define MALLOC(ptr, size) do { \ 217 while(!(ptr = malloc(size))) { \ 218 DPRINTF(D_MEM, "Unable to allocate memory"); \ 219 message_allqueues_purge(); \ 220 } \ 221 DPRINTF(D_MEM2, "MALLOC(%s@%p, %zu)\n", #ptr, ptr, size); \ 222 } while (/*CONSTCOND*/0) 223 224 #define CALLOC(ptr, size) do { \ 225 while(!(ptr = calloc(1, size))) { \ 226 DPRINTF(D_MEM, "Unable to allocate memory"); \ 227 message_allqueues_purge(); \ 228 } \ 229 DPRINTF(D_MEM2, "CALLOC(%s@%p, %zu)\n", #ptr, ptr, size); \ 230 } while (/*CONSTCOND*/0) 231 232 /* define strlen(NULL) to be 0 */ 233 #define SAFEstrlen(x) ((x) ? strlen(x) : 0) 234 235 /* shorthand to block/restore signals for the duration of one function */ 236 #define BLOCK_SIGNALS(omask, newmask) do { \ 237 sigemptyset(&newmask); \ 238 sigaddset(&newmask, SIGHUP); \ 239 sigaddset(&newmask, SIGALRM); \ 240 sigprocmask(SIG_BLOCK, &newmask, &omask); \ 241 } while (/*CONSTCOND*/0) 242 243 #define RESTORE_SIGNALS(omask) sigprocmask(SIG_SETMASK, &omask, NULL) 244 245 /* small optimization to call send_queue() only if queue has elements */ 246 #define SEND_QUEUE(f) do { \ 247 if ((f)->f_qelements) \ 248 send_queue(0, 0, f); \ 249 } while (/*CONSTCOND*/0) 250 251 #define MAXUNAMES 20 /* maximum number of user names */ 252 #define BSD_TIMESTAMPLEN 14+1 253 #define MAX_TIMESTAMPLEN 31+1 254 255 /* maximum field lengths in syslog-protocol */ 256 #define PRI_MAX 5 257 #define HOST_MAX 255 258 #define APPNAME_MAX 48 259 #define PROCID_MAX 128 260 #define MSGID_MAX 32 261 /* longest possible header length */ 262 #define HEADER_LEN_MAX (PRI_MAX + 1 + 1 + MAX_TIMESTAMPLEN + 1 + HOST_MAX \ 263 + 1 + APPNAME_MAX + 1 + PROCID_MAX + 1 + MSGID_MAX) 264 265 /* allowed number of priorities by IETF standards */ 266 #define IETF_NUM_PRIVALUES 192 267 268 /* check if message with fac/sev belogs to a destination f */ 269 #define MATCH_PRI(f, fac, sev) \ 270 ( (((f)->f_pcmp[fac] & PRI_EQ) && ((f)->f_pmask[fac] == (sev))) \ 271 ||(((f)->f_pcmp[fac] & PRI_LT) && ((f)->f_pmask[fac] < (sev))) \ 272 ||(((f)->f_pcmp[fac] & PRI_GT) && ((f)->f_pmask[fac] > (sev))) \ 273 ) 274 275 /* shorthand to test Byte Order Mark which indicates UTF-8 content */ 276 #define IS_BOM(p) ( \ 277 (p)[0] != '\0' && (unsigned char)(p)[0] == (unsigned char)0xEF && \ 278 (p)[1] != '\0' && (unsigned char)(p)[1] == (unsigned char)0xBB && \ 279 (p)[2] != '\0' && (unsigned char)(p)[2] == (unsigned char)0xBF) 280 281 /* message buffer container used for processing, formatting, and queueing */ 282 struct buf_msg { 283 size_t refcount; 284 int pri; 285 int flags; 286 char *timestamp; 287 char *recvhost; 288 char *host; 289 char *prog; 290 char *pid; 291 char *msgid; 292 char *sd; /* structured data */ 293 char *msg; /* message content */ 294 char *msgorig; /* in case we advance *msg beyond header fields 295 we still want to free() the original ptr */ 296 size_t msglen; /* strlen(msg) */ 297 size_t msgsize; /* allocated memory size */ 298 size_t tlsprefixlen; /* bytes for the TLS length prefix */ 299 size_t prilen; /* bytes for priority and version */ 300 }; 301 302 /* queue of messages */ 303 struct buf_queue { 304 struct buf_msg* msg; 305 STAILQ_ENTRY(buf_queue) entries; 306 }; 307 STAILQ_HEAD(buf_queue_head, buf_queue); 308 309 /* a pair of a socket and an associated event object */ 310 struct socketEvent { 311 int fd; 312 int af; 313 struct event *ev; 314 }; 315 316 /* 317 * Flags to logmsg(). 318 */ 319 #define IGN_CONS 0x001 /* don't print on console */ 320 #define SYNC_FILE 0x002 /* do fsync on file after printing */ 321 #define ADDDATE 0x004 /* add a date to the message */ 322 #define MARK 0x008 /* this message is a mark */ 323 #define ISKERNEL 0x010 /* kernel generated message */ 324 #define BSDSYSLOG 0x020 /* line in traditional BSD Syslog format */ 325 #define SIGN_MSG 0x040 /* syslog-sign data, not signed again */ 326 327 /* strategies for message_queue_purge() */ 328 #define PURGE_OLDEST 1 329 #define PURGE_BY_PRIORITY 2 330 331 /* 332 * This structure represents the files that will have log 333 * copies printed. 334 * We require f_file to be valid if f_type is F_FILE, F_CONSOLE, F_TTY, 335 * or if f_type is F_PIPE and f_pid > 0. 336 */ 337 338 struct filed { 339 struct filed *f_next; /* next in linked list */ 340 short f_type; /* entry type, see below */ 341 short f_file; /* file descriptor */ 342 time_t f_time; /* time this was last written */ 343 char *f_host; /* host from which to record */ 344 u_char f_pmask[LOG_NFACILITIES+1]; /* priority mask */ 345 u_char f_pcmp[LOG_NFACILITIES+1]; /* compare priority */ 346 #define PRI_LT 0x1 347 #define PRI_EQ 0x2 348 #define PRI_GT 0x4 349 char *f_program; /* program this applies to */ 350 union { 351 char f_uname[MAXUNAMES][UT_NAMESIZE+1]; 352 struct { 353 char f_hname[MAXHOSTNAMELEN]; 354 struct addrinfo *f_addr; 355 } f_forw; /* UDP forwarding address */ 356 #ifndef DISABLE_TLS 357 struct { 358 SSL *ssl; /* SSL object */ 359 struct tls_conn_settings *tls_conn; /* certificate info */ 360 } f_tls; /* TLS forwarding address */ 361 #endif /* !DISABLE_TLS */ 362 char f_fname[MAXPATHLEN]; 363 struct { 364 char f_pname[MAXPATHLEN]; 365 pid_t f_pid; 366 } f_pipe; 367 } f_un; 368 #ifndef DISABLE_SIGN 369 struct signature_group_t *f_sg; /* one signature group */ 370 #endif /* !DISABLE_SIGN */ 371 struct buf_queue_head f_qhead; /* undelivered msgs queue */ 372 size_t f_qelements; /* elements in queue */ 373 size_t f_qsize; /* size of queue in bytes */ 374 struct buf_msg *f_prevmsg; /* last message logged */ 375 struct event *f_sq_event; /* timer for send_queue() */ 376 int f_prevcount; /* repetition cnt of prevmsg */ 377 int f_repeatcount; /* number of "repeated" msgs */ 378 int f_lasterror; /* last error on writev() */ 379 int f_flags; /* file-specific flags */ 380 #define FFLAG_SYNC 0x01 /* for F_FILE: fsync after every msg */ 381 #define FFLAG_FULL 0x02 /* for F_FILE | F_PIPE: write PRI header */ 382 #define FFLAG_SIGN 0x04 /* for syslog-sign with SG="3": 383 * sign the messages to this destination */ 384 }; 385 386 #ifndef DISABLE_TLS 387 388 /* linked list for allowed TLS peer credentials 389 * (one for fingerprint, one for cert-files) 390 */ 391 SLIST_HEAD(peer_cred_head, peer_cred); 392 struct peer_cred { 393 SLIST_ENTRY(peer_cred) entries; 394 char *data; 395 }; 396 397 /* config options for TLS server-side */ 398 struct tls_global_options_t { 399 SSL_CTX *global_TLS_CTX; 400 struct peer_cred_head fprint_head; /* trusted client fingerprints */ 401 struct peer_cred_head cert_head; /* trusted client cert files */ 402 char *keyfile; /* file with private key */ 403 char *certfile; /* file with own certificate */ 404 char *CAfile; /* file with CA certificate */ 405 char *CAdir; /* alternative: path to directory with CA certs */ 406 char *x509verify; /* level of peer verification */ 407 char *bindhost; /* hostname/IP to bind to */ 408 char *bindport; /* port/service to bind to */ 409 char *server; /* if !NULL: do not listen to incoming TLS */ 410 char *gen_cert; /* if !NULL: generate self-signed certificate */ 411 }; 412 413 /* TLS needs three sets of sockets: 414 * - listening sockets: a fixed size array TLS_Listen_Set, just like finet for UDP. 415 * - outgoing connections: managed as part of struct filed. 416 * - incoming connections: variable sized, thus a linked list TLS_Incoming. 417 */ 418 /* every connection has its own input buffer with status 419 * variables for message reading */ 420 SLIST_HEAD(TLS_Incoming, TLS_Incoming_Conn); 421 422 struct TLS_Incoming_Conn { 423 SLIST_ENTRY(TLS_Incoming_Conn) entries; 424 struct tls_conn_settings *tls_conn; 425 int socket; 426 char *inbuf; /* input buffer */ 427 size_t inbuflen; 428 size_t cur_msg_len; /* length of current msg */ 429 size_t cur_msg_start; /* beginning of current msg */ 430 size_t read_pos; /* ring buffer position to write to */ 431 size_t errorcount; /* to close faulty connections */ 432 bool closenow; /* close connection as soon as buffer processed */ 433 bool dontsave; /* for receiving oversized messages w/o saving them */ 434 }; 435 436 #endif /* !DISABLE_TLS */ 437 438 #endif /*SYSLOGD_H_*/ 439