2 * Copyright (c) 1983, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * 1999-02-22 Arkadiusz MiĆkiewicz <misiek@pld.ORG.PL>
34 * - added Native Language Support
35 * Sun Mar 21 1999 - Arnaldo Carvalho de Melo <acme@conectiva.com.br>
36 * - fixed strerr(errno) in gettext calls
47 #include <sys/types.h>
48 #include <sys/socket.h>
50 #include <arpa/inet.h>
59 #include "closestream.h"
61 #include "pathnames.h"
70 #ifdef HAVE_LIBSYSTEMD
71 # include <systemd/sd-daemon.h>
72 # include <systemd/sd-journal.h>
75 #ifdef HAVE_SYS_TIMEX_H
76 # include <sys/timex.h>
82 ALL_TYPES
= TYPE_UDP
| TYPE_TCP
86 AF_UNIX_ERRORS_OFF
= 0,
92 OPT_PRIO_PREFIX
= CHAR_MAX
+ 1,
100 OPT_STRUCTURED_DATA_ID
,
101 OPT_STRUCTURED_DATA_PARAM
,
105 /* rfc5424 structured data */
106 struct structured_data
{
107 char *id
; /* SD-ID */
108 char **params
; /* array with SD-PARAMs */
110 struct list_head sds
;
116 pid_t pid
; /* zero when unwanted */
117 char *hdr
; /* the syslog header (based on protocol) */
120 char *unix_socket
; /* -u <path> or default to _PATH_DEVLOG */
124 size_t max_message_size
;
125 struct list_head user_sds
; /* user defined rfc5424 structured data */
126 struct list_head reserved_sds
; /* standard rfc5424 structured data */
128 void (*syslogfp
)(struct logger_ctl
*ctl
);
131 unix_socket_errors
:1, /* whether to report or not errors */
132 noact
:1, /* do not write to sockets */
133 prio_prefix
:1, /* read priority from input */
134 stderr_printout
:1, /* output message to stderr */
135 rfc5424_time
:1, /* include time stamp */
136 rfc5424_tq
:1, /* include time quality markup */
137 rfc5424_host
:1, /* include hostname */
138 skip_empty_lines
:1, /* do not send empty lines when processing files */
139 octet_count
:1; /* use RFC6587 octet counting */
143 * For tests we want to be able to control datetime outputs
146 static inline int logger_gettimeofday(struct timeval
*tv
, struct timezone
*tz
)
148 char *str
= getenv("LOGGER_TEST_TIMEOFDAY");
151 if (str
&& sscanf(str
, "%ju.%ju", &sec
, &usec
) == 2) {
154 return tv
->tv_sec
>= 0 && tv
->tv_usec
>= 0 ? 0 : -EINVAL
;
157 return gettimeofday(tv
, tz
);
160 static inline char *logger_xgethostname(void)
162 char *str
= getenv("LOGGER_TEST_HOSTNAME");
163 return str
? xstrdup(str
) : xgethostname();
166 static inline pid_t
logger_getpid(void)
168 char *str
= getenv("LOGGER_TEST_GETPID");
171 if (str
&& sscanf(str
, "%u", &pid
) == 1)
177 #undef HAVE_NTP_GETTIME /* force to default non-NTP */
179 #else /* !TEST_LOGGER */
180 # define logger_gettimeofday(x, y) gettimeofday(x, y)
181 # define logger_xgethostname xgethostname
182 # define logger_getpid getpid
186 static int decode(const char *name
, const CODE
*codetab
)
188 register const CODE
*c
;
190 if (name
== NULL
|| *name
== '\0')
192 if (isdigit(*name
)) {
197 num
= strtol(name
, &end
, 10);
198 if (errno
|| name
== end
|| (end
&& *end
))
200 for (c
= codetab
; c
->c_name
; c
++)
205 for (c
= codetab
; c
->c_name
; c
++)
206 if (!strcasecmp(name
, c
->c_name
))
212 static int pencode(char *s
)
217 separator
= strchr(s
, '.');
220 facility
= decode(s
, facilitynames
);
222 errx(EXIT_FAILURE
, _("unknown facility name: %s"), s
);
226 level
= decode(s
, prioritynames
);
228 errx(EXIT_FAILURE
, _("unknown priority name: %s"), s
);
229 if (facility
== LOG_KERN
)
230 facility
= LOG_USER
; /* kern is forbidden */
231 return ((level
& LOG_PRIMASK
) | (facility
& LOG_FACMASK
));
234 static int unix_socket(struct logger_ctl
*ctl
, const char *path
, int *socket_type
)
236 int fd
, i
, type
= -1;
237 static struct sockaddr_un s_addr
; /* AF_UNIX address of local logger */
239 if (strlen(path
) >= sizeof(s_addr
.sun_path
))
240 errx(EXIT_FAILURE
, _("openlog %s: pathname too long"), path
);
242 s_addr
.sun_family
= AF_UNIX
;
243 strcpy(s_addr
.sun_path
, path
);
245 for (i
= 2; i
; i
--) {
248 if (i
== 2 && *socket_type
& TYPE_UDP
) {
252 if (i
== 1 && *socket_type
& TYPE_TCP
) {
256 if (st
== -1 || (fd
= socket(AF_UNIX
, st
, 0)) == -1)
258 if (connect(fd
, (struct sockaddr
*)&s_addr
, sizeof(s_addr
)) == -1) {
266 if (ctl
->unix_socket_errors
)
267 err(EXIT_FAILURE
, _("socket %s"), path
);
269 /* openlog(3) compatibility, socket errors are
270 * not reported, but ignored silently */
275 /* replace ALL_TYPES with the real TYPE_* */
276 if (type
> 0 && type
!= *socket_type
)
281 static int inet_socket(const char *servername
, const char *port
, int *socket_type
)
283 int fd
, errcode
, i
, type
= -1;
284 struct addrinfo hints
, *res
;
285 const char *p
= port
;
287 for (i
= 2; i
; i
--) {
288 memset(&hints
, 0, sizeof(hints
));
289 if (i
== 2 && *socket_type
& TYPE_UDP
) {
290 hints
.ai_socktype
= SOCK_DGRAM
;
295 if (i
== 1 && *socket_type
& TYPE_TCP
) {
296 hints
.ai_socktype
= SOCK_STREAM
;
301 if (hints
.ai_socktype
== 0)
303 hints
.ai_family
= AF_UNSPEC
;
304 errcode
= getaddrinfo(servername
, p
, &hints
, &res
);
306 errx(EXIT_FAILURE
, _("failed to resolve name %s port %s: %s"),
307 servername
, p
, gai_strerror(errcode
));
308 if ((fd
= socket(res
->ai_family
, res
->ai_socktype
, res
->ai_protocol
)) == -1) {
312 if (connect(fd
, res
->ai_addr
, res
->ai_addrlen
) == -1) {
323 errx(EXIT_FAILURE
, _("failed to connect to %s port %s"), servername
, p
);
325 /* replace ALL_TYPES with the real TYPE_* */
326 if (type
> 0 && type
!= *socket_type
)
331 #ifdef HAVE_LIBSYSTEMD
332 static int journald_entry(struct logger_ctl
*ctl
, FILE *fp
)
337 int n
, lines
, vectors
= 8, ret
= 0;
340 iovec
= xmalloc(vectors
* sizeof(struct iovec
));
341 for (lines
= 0; /* nothing */ ; lines
++) {
343 sz
= getline(&buf
, &dummy
, fp
);
345 (sz
= rtrim_whitespace((unsigned char *) buf
)) == 0) {
349 if (lines
== vectors
) {
351 if (IOV_MAX
< vectors
)
352 errx(EXIT_FAILURE
, _("maximum input lines (%d) exceeded"), IOV_MAX
);
353 iovec
= xrealloc(iovec
, vectors
* sizeof(struct iovec
));
355 iovec
[lines
].iov_base
= buf
;
356 iovec
[lines
].iov_len
= sz
;
360 ret
= sd_journal_sendv(iovec
, lines
);
361 if (ctl
->stderr_printout
) {
362 for (n
= 0; n
< lines
; n
++)
363 fprintf(stderr
, "%s\n", (char *) iovec
[n
].iov_base
);
365 for (n
= 0; n
< lines
; n
++)
366 free(iovec
[n
].iov_base
);
372 static char const *xgetlogin(void)
377 if (!(cp
= getlogin()) || !*cp
)
378 cp
= (pw
= getpwuid(geteuid()))? pw
->pw_name
: "<someone>";
382 /* this creates a timestamp based on current time according to the
383 * fine rules of RFC3164, most importantly it ensures in a portable
384 * way that the month day is correctly written (with a SP instead
385 * of a leading 0). The function uses a static buffer which is
386 * overwritten on the next call (just like ctime() does).
388 static char const *rfc3164_current_time(void)
390 static char time
[32];
393 static char const * const monthnames
[] = {
394 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug",
395 "Sep", "Oct", "Nov", "Dec"
398 logger_gettimeofday(&tv
, NULL
);
399 tm
= localtime(&tv
.tv_sec
);
400 snprintf(time
, sizeof(time
),"%s %2d %2.2d:%2.2d:%2.2d",
401 monthnames
[tm
->tm_mon
], tm
->tm_mday
,
402 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
);
406 #define next_iovec(ary, idx) __extension__ ({ \
407 assert(ARRAY_SIZE(ary) > (size_t)idx); \
412 #define iovec_add_string(ary, idx, str, len) \
414 struct iovec *v = next_iovec(ary, idx); \
415 v->iov_base = (void *) str; \
416 v->iov_len = len ? len : strlen(str); \
419 #define iovec_memcmp(ary, idx, str, len) \
420 memcmp((ary)[(idx) - 1].iov_base, str, len)
422 /* writes generated buffer to desired destination. For TCP syslog,
423 * we use RFC6587 octet-stuffing (unless octet-counting is selected).
424 * This is not great, but doing full blown RFC5425 (TLS) looks like
425 * it is too much for the logger utility. If octet-counting is
426 * selected, we use that.
428 static void write_output(const struct logger_ctl
*ctl
, const char *const msg
)
435 if (ctl
->octet_count
) {
436 size_t len
= xasprintf(&octet
, "%zu ", strlen(ctl
->hdr
) + strlen(msg
));
437 iovec_add_string(iov
, iovlen
, octet
, len
);
441 iovec_add_string(iov
, iovlen
, ctl
->hdr
, 0);
444 iovec_add_string(iov
, iovlen
, msg
, 0);
447 struct msghdr message
= { 0 };
448 #ifdef SCM_CREDENTIALS
449 struct cmsghdr
*cmhp
;
453 char control
[CMSG_SPACE(sizeof(struct ucred
))];
457 /* 4) add extra \n to make sure message is terminated */
458 if ((ctl
->socket_type
== TYPE_TCP
) && !ctl
->octet_count
)
459 iovec_add_string(iov
, iovlen
, "\n", 1);
461 message
.msg_iov
= iov
;
462 message
.msg_iovlen
= iovlen
;
464 #ifdef SCM_CREDENTIALS
465 /* syslog/journald may follow local socket credentials rather
466 * than in the message PID. If we use --id as root than we can
467 * force kernel to accept another valid PID than the real logger(1)
470 if (ctl
->pid
&& !ctl
->server
&& ctl
->pid
!= getpid()
471 && geteuid() == 0 && kill(ctl
->pid
, 0) == 0) {
473 message
.msg_control
= cbuf
.control
;
474 message
.msg_controllen
= CMSG_SPACE(sizeof(struct ucred
));
476 cmhp
= CMSG_FIRSTHDR(&message
);
477 cmhp
->cmsg_len
= CMSG_LEN(sizeof(struct ucred
));
478 cmhp
->cmsg_level
= SOL_SOCKET
;
479 cmhp
->cmsg_type
= SCM_CREDENTIALS
;
480 cred
= (struct ucred
*) CMSG_DATA(cmhp
);
482 cred
->pid
= ctl
->pid
;
486 if (sendmsg(ctl
->fd
, &message
, 0) < 0)
487 warn(_("send message failed"));
490 if (ctl
->stderr_printout
) {
491 /* make sure it's terminated for stderr */
492 if (iovec_memcmp(iov
, iovlen
, "\n", 1) != 0)
493 iovec_add_string(iov
, iovlen
, "\n", 1);
495 ignore_result( writev(STDERR_FILENO
, iov
, iovlen
) );
502 static void syslog_rfc3164_header(struct logger_ctl
*const ctl
)
504 char pid
[30], *hostname
;
510 snprintf(pid
, sizeof(pid
), "[%d]", ctl
->pid
);
512 if ((hostname
= logger_xgethostname())) {
513 char *dot
= strchr(hostname
, '.');
517 hostname
= xstrdup(NILVALUE
);
519 xasprintf(&ctl
->hdr
, "<%d>%.15s %s %.200s%s: ",
520 ctl
->pri
, rfc3164_current_time(), hostname
, ctl
->tag
, pid
);
525 static inline struct list_head
*get_user_structured_data(struct logger_ctl
*ctl
)
527 return &ctl
->user_sds
;
530 static inline struct list_head
*get_reserved_structured_data(struct logger_ctl
*ctl
)
532 return &ctl
->reserved_sds
;
535 static int has_structured_data_id(struct list_head
*ls
, const char *id
)
539 if (!ls
|| list_empty(ls
))
542 list_for_each(p
, ls
) {
543 struct structured_data
*sd
= list_entry(p
, struct structured_data
, sds
);
544 if (sd
->id
&& strcmp(sd
->id
, id
) == 0)
551 static void add_structured_data_id(struct list_head
*ls
, const char *id
)
553 struct structured_data
*sd
;
557 if (has_structured_data_id(ls
, id
))
558 errx(EXIT_FAILURE
, _("structured data ID '%s' is not unique"), id
);
560 sd
= xcalloc(1, sizeof(*sd
));
561 INIT_LIST_HEAD(&sd
->sds
);
562 sd
->id
= xstrdup(id
);
564 list_add_tail(&sd
->sds
, ls
);
567 static void add_structured_data_param(struct list_head
*ls
, const char *param
)
569 struct structured_data
*sd
;
572 errx(EXIT_FAILURE
, _("--sd-id was not specified for --sd-param %s"), param
);
576 sd
= list_last_entry(ls
, struct structured_data
, sds
);
578 if (strv_extend(&sd
->params
, param
))
582 static void add_structured_data_paramf(struct list_head
*ls
, const char *fmt
, ...)
584 struct structured_data
*sd
;
588 assert(!list_empty(ls
));
591 sd
= list_last_entry(ls
, struct structured_data
, sds
);
593 x
= strv_extendv(&sd
->params
, fmt
, ap
);
600 static char *strdup_structured_data(struct structured_data
*sd
)
604 if (strv_isempty(sd
->params
))
607 xasprintf(&res
, "[%s %s]", sd
->id
,
608 (tmp
= strv_join(sd
->params
, " ")));
613 static char *strdup_structured_data_list(struct list_head
*ls
)
618 list_for_each(p
, ls
) {
619 struct structured_data
*sd
= list_entry(p
, struct structured_data
, sds
);
620 char *one
= strdup_structured_data(sd
);
625 res
= strappend(tmp
, one
);
633 static char *get_structured_data_string(struct logger_ctl
*ctl
)
635 char *sys
= NULL
, *usr
= NULL
, *res
;
637 if (!list_empty(&ctl
->reserved_sds
))
638 sys
= strdup_structured_data_list(&ctl
->reserved_sds
);
639 if (!list_empty(&ctl
->user_sds
))
640 usr
= strdup_structured_data_list(&ctl
->user_sds
);
643 res
= strappend(sys
, usr
);
647 res
= sys
? sys
: usr
;
652 static int valid_structured_data_param(const char *str
)
654 char *eq
= strchr(str
, '='),
655 *qm1
= strchr(str
, '"'),
656 *qm2
= qm1
? strchr(qm1
+ 1, '"') : NULL
;
658 if (!eq
|| !qm1
|| !qm2
) /* something is missing */
662 return eq
> str
&& eq
< qm1
&& eq
+ 1 == qm1
&& qm1
< qm2
&& *(qm2
+ 1) == '\0';
666 * name@<private enterprise number>, e.g., "ourSDID@32473"
668 static int valid_structured_data_id(const char *str
)
670 char *at
= strchr(str
, '@');
673 /* standardized IDs without @<digits> */
674 if (!at
&& (strcmp(str
, "timeQuality") == 0 ||
675 strcmp(str
, "origin") == 0 ||
676 strcmp(str
, "meta") == 0))
679 if (!at
|| at
== str
|| !*(at
+ 1))
682 /* <digits> or <digits>.<digits>[...] */
683 for (p
= at
+ 1; p
&& *p
; p
++) {
686 if (isdigit_strend(p
, &end
))
687 break; /* only digits in the string */
689 if (end
== NULL
|| end
== p
||
690 *end
!= '.' || *(end
+ 1) == '\0')
695 /* check for forbidden chars in the <name> */
696 for (p
= str
; p
< at
; p
++) {
697 if (*p
== '[' || *p
== '=' || *p
== '"' || *p
== '@')
699 if (isblank((unsigned char) *p
) || iscntrl((unsigned char) *p
))
706 /* Some field mappings may be controversial, thus I give the reason
707 * why this specific mapping was used:
709 * Some may argue that "logger" is a better fit, but we think
710 * this is better inline of what other implementations do. In
711 * rsyslog, for example, the TAG value is populated from APP-NAME.
713 * This is a relatively straightforward interpretation from
714 * RFC5424, sect. 6.2.6.
715 * MSGID <-- msgid (from --msgid)
716 * One may argue that the string "logger" would be better suited
717 * here so that a receiver can identify the sender process.
718 * However, this does not sound like a good match to RFC5424,
720 * Note that appendix A.1 of RFC5424 does not provide clear guidance
721 * of how these fields should be used. This is the case because the
722 * IETF working group couldn't arrive at a clear agreement when we
723 * specified RFC5424. The rest of the field mappings should be
724 * pretty clear from RFC5424. -- Rainer Gerhards, 2015-03-10
726 static void syslog_rfc5424_header(struct logger_ctl
*const ctl
)
730 char const *app_name
= ctl
->tag
;
732 char *const msgid
= xstrdup(ctl
->msgid
? ctl
->msgid
: NILVALUE
);
733 char *structured
= NULL
;
734 struct list_head
*sd
;
739 if (ctl
->rfc5424_time
) {
743 logger_gettimeofday(&tv
, NULL
);
744 if ((tm
= localtime(&tv
.tv_sec
)) != NULL
) {
746 const size_t i
= strftime(fmt
, sizeof(fmt
),
747 "%Y-%m-%dT%H:%M:%S.%%06u%z ", tm
);
748 /* patch TZ info to comply with RFC3339 (we left SP at end) */
749 fmt
[i
- 1] = fmt
[i
- 2];
750 fmt
[i
- 2] = fmt
[i
- 3];
752 xasprintf(&time
, fmt
, tv
.tv_usec
);
754 err(EXIT_FAILURE
, _("localtime() failed"));
756 time
= xstrdup(NILVALUE
);
758 if (ctl
->rfc5424_host
) {
759 if (!(hostname
= logger_xgethostname()))
760 hostname
= xstrdup(NILVALUE
);
761 /* Arbitrary looking 'if (var < strlen()) checks originate from
762 * RFC 5424 - 6 Syslog Message Format definition. */
763 if (255 < strlen(hostname
))
764 errx(EXIT_FAILURE
, _("hostname '%s' is too long"),
767 hostname
= xstrdup(NILVALUE
);
769 if (48 < strlen(ctl
->tag
))
770 errx(EXIT_FAILURE
, _("tag '%s' is too long"), ctl
->tag
);
773 xasprintf(&procid
, "%d", ctl
->pid
);
775 procid
= xstrdup(NILVALUE
);
777 sd
= get_reserved_structured_data(ctl
);
779 /* time quality structured data (maybe overwritten by --sd-id timeQuality) */
780 if (ctl
->rfc5424_tq
&& !has_structured_data_id(sd
, "timeQuality")) {
782 add_structured_data_id(sd
, "timeQuality");
783 add_structured_data_param(sd
, "tzKnown=\"1\"");
785 #ifdef HAVE_NTP_GETTIME
786 struct ntptimeval ntptv
;
788 if (ntp_gettime(&ntptv
) == TIME_OK
) {
789 add_structured_data_param(sd
, "isSynced=\"1\"");
790 add_structured_data_paramf(sd
, "syncAccuracy=\"%ld\"", ntptv
.maxerror
);
793 add_structured_data_paramf(sd
, "isSynced=\"0\"");
796 /* convert all structured data to string */
797 structured
= get_structured_data_string(ctl
);
799 structured
= xstrdup(NILVALUE
);
801 xasprintf(&ctl
->hdr
, "<%d>1 %s %s %s %s %s %s ",
812 /* app_name points to ctl->tag, do NOT free! */
818 static void parse_rfc5424_flags(struct logger_ctl
*ctl
, char *s
)
823 while ((tok
= strtok(in
, ","))) {
825 if (!strcmp(tok
, "notime")) {
826 ctl
->rfc5424_time
= 0;
828 } else if (!strcmp(tok
, "notq"))
830 else if (!strcmp(tok
, "nohost"))
831 ctl
->rfc5424_host
= 0;
833 warnx(_("ignoring unknown option argument: %s"), tok
);
837 static int parse_unix_socket_errors_flags(char *s
)
839 if (!strcmp(s
, "off"))
840 return AF_UNIX_ERRORS_OFF
;
841 if (!strcmp(s
, "on"))
842 return AF_UNIX_ERRORS_ON
;
843 if (!strcmp(s
, "auto"))
844 return AF_UNIX_ERRORS_AUTO
;
845 warnx(_("invalid argument: %s: using automatic errors"), s
);
846 return AF_UNIX_ERRORS_AUTO
;
849 static void syslog_local_header(struct logger_ctl
*const ctl
)
854 snprintf(pid
, sizeof(pid
), "[%d]", ctl
->pid
);
858 xasprintf(&ctl
->hdr
, "<%d>%s %s%s: ", ctl
->pri
, rfc3164_current_time(),
862 static void generate_syslog_header(struct logger_ctl
*const ctl
)
868 static void logger_open(struct logger_ctl
*ctl
)
871 ctl
->fd
= inet_socket(ctl
->server
, ctl
->port
, &ctl
->socket_type
);
873 ctl
->syslogfp
= syslog_rfc5424_header
;
875 if (!ctl
->unix_socket
)
876 ctl
->unix_socket
= _PATH_DEVLOG
;
878 ctl
->fd
= unix_socket(ctl
, ctl
->unix_socket
, &ctl
->socket_type
);
880 ctl
->syslogfp
= syslog_local_header
;
883 ctl
->tag
= xgetlogin();
884 generate_syslog_header(ctl
);
887 static void logger_command_line(const struct logger_ctl
*ctl
, char **argv
)
889 /* note: we never re-generate the syslog header here, even if we
890 * generate multiple messages. If so, we think it is the right thing
891 * to do to report them with the same timestamp, as the user actually
892 * intended to send a single message.
894 char *const buf
= xmalloc(ctl
->max_message_size
+ 1);
896 const char *endp
= buf
+ ctl
->max_message_size
- 1;
901 if (endp
< p
+ len
&& p
!= buf
) {
902 write_output(ctl
, buf
);
905 if (ctl
->max_message_size
< len
) {
906 (*argv
)[ctl
->max_message_size
] = '\0'; /* truncate */
907 write_output(ctl
, *argv
++);
912 memmove(p
, *argv
++, len
);
916 write_output(ctl
, buf
);
920 static void logger_stdin(struct logger_ctl
*ctl
)
922 /* note: we re-generate the syslog header for each log message to
923 * update header timestamps and to reflect possible priority changes.
924 * The initial header is generated by logger_open().
927 int default_priority
= ctl
->pri
;
928 int last_pri
= default_priority
;
929 size_t max_usrmsg_size
= ctl
->max_message_size
- strlen(ctl
->hdr
);
930 char *const buf
= xmalloc(max_usrmsg_size
+ 2 + 2);
938 if (ctl
->prio_prefix
&& c
== '<') {
941 while (isdigit(c
= getchar()) && pri
<= 191) {
943 pri
= pri
* 10 + c
- '0';
945 if (c
!= EOF
&& c
!= '\n')
947 if (c
== '>' && 0 <= pri
&& pri
<= 191) {
948 /* valid RFC PRI values */
950 if (pri
< 8) /* kern facility is forbidden */
954 ctl
->pri
= default_priority
;
956 if (ctl
->pri
!= last_pri
) {
959 ctl
->max_message_size
- strlen(ctl
->hdr
);
962 if (c
!= EOF
&& c
!= '\n')
966 while (c
!= EOF
&& c
!= '\n' && i
< max_usrmsg_size
) {
972 if (i
> 0 || !ctl
->skip_empty_lines
) {
974 generate_syslog_header(ctl
);
975 write_output(ctl
, buf
);
979 if (c
== '\n') /* discard line terminator */
984 static void logger_close(const struct logger_ctl
*ctl
)
986 if (ctl
->fd
!= -1 && close(ctl
->fd
) != 0)
987 err(EXIT_FAILURE
, _("close failed"));
991 static void __attribute__((__noreturn__
)) usage(void)
994 fputs(USAGE_HEADER
, out
);
995 fprintf(out
, _(" %s [options] [<message>]\n"), program_invocation_short_name
);
997 fputs(USAGE_SEPARATOR
, out
);
998 fputs(_("Enter messages into the system log.\n"), out
);
1000 fputs(USAGE_OPTIONS
, out
);
1001 fputs(_(" -i log the logger command's PID\n"), out
);
1002 fputs(_(" --id[=<id>] log the given <id>, or otherwise the PID\n"), out
);
1003 fputs(_(" -f, --file <file> log the contents of this file\n"), out
);
1004 fputs(_(" -e, --skip-empty do not log empty lines when processing files\n"), out
);
1005 fputs(_(" --no-act do everything except the write the log\n"), out
);
1006 fputs(_(" -p, --priority <prio> mark given message with this priority\n"), out
);
1007 fputs(_(" --octet-count use rfc6587 octet counting\n"), out
);
1008 fputs(_(" --prio-prefix look for a prefix on every line read from stdin\n"), out
);
1009 fputs(_(" -s, --stderr output message to standard error as well\n"), out
);
1010 fputs(_(" -S, --size <size> maximum size for a single message\n"), out
);
1011 fputs(_(" -t, --tag <tag> mark every line with this tag\n"), out
);
1012 fputs(_(" -n, --server <name> write to this remote syslog server\n"), out
);
1013 fputs(_(" -P, --port <port> use this port for UDP or TCP connection\n"), out
);
1014 fputs(_(" -T, --tcp use TCP only\n"), out
);
1015 fputs(_(" -d, --udp use UDP only\n"), out
);
1016 fputs(_(" --rfc3164 use the obsolete BSD syslog protocol\n"), out
);
1017 fputs(_(" --rfc5424[=<snip>] use the syslog protocol (the default for remote);\n"
1018 " <snip> can be notime, or notq, and/or nohost\n"), out
);
1019 fputs(_(" --sd-id <id> rfc5424 structured data ID\n"), out
);
1020 fputs(_(" --sd-param <data> rfc5424 structured data name=value\n"), out
);
1021 fputs(_(" --msgid <msgid> set rfc5424 message id field\n"), out
);
1022 fputs(_(" -u, --socket <socket> write to this Unix socket\n"), out
);
1023 fputs(_(" --socket-errors[=<on|off|auto>]\n"
1024 " print connection errors when using Unix sockets\n"), out
);
1025 #ifdef HAVE_LIBSYSTEMD
1026 fputs(_(" --journald[=<file>] write journald entry\n"), out
);
1029 fputs(USAGE_SEPARATOR
, out
);
1030 printf(USAGE_HELP_OPTIONS(26));
1031 printf(USAGE_MAN_TAIL("logger(1)"));
1037 * logger -- read and log utility
1039 * Reads from an input and arranges to write the result on the system
1042 int main(int argc
, char **argv
)
1044 struct logger_ctl ctl
= {
1047 .pri
= LOG_USER
| LOG_NOTICE
,
1050 .unix_socket
= NULL
,
1051 .unix_socket_errors
= 0,
1056 .socket_type
= ALL_TYPES
,
1057 .max_message_size
= 1024,
1061 .skip_empty_lines
= 0
1064 int stdout_reopened
= 0;
1065 int unix_socket_errors_mode
= AF_UNIX_ERRORS_AUTO
;
1066 #ifdef HAVE_LIBSYSTEMD
1069 static const struct option longopts
[] = {
1070 { "id", optional_argument
, 0, OPT_ID
},
1071 { "stderr", no_argument
, 0, 's' },
1072 { "file", required_argument
, 0, 'f' },
1073 { "no-act", no_argument
, 0, OPT_NOACT
, },
1074 { "priority", required_argument
, 0, 'p' },
1075 { "tag", required_argument
, 0, 't' },
1076 { "socket", required_argument
, 0, 'u' },
1077 { "socket-errors", required_argument
, 0, OPT_SOCKET_ERRORS
},
1078 { "udp", no_argument
, 0, 'd' },
1079 { "tcp", no_argument
, 0, 'T' },
1080 { "server", required_argument
, 0, 'n' },
1081 { "port", required_argument
, 0, 'P' },
1082 { "version", no_argument
, 0, 'V' },
1083 { "help", no_argument
, 0, 'h' },
1084 { "octet-count", no_argument
, 0, OPT_OCTET_COUNT
},
1085 { "prio-prefix", no_argument
, 0, OPT_PRIO_PREFIX
},
1086 { "rfc3164", no_argument
, 0, OPT_RFC3164
},
1087 { "rfc5424", optional_argument
, 0, OPT_RFC5424
},
1088 { "size", required_argument
, 0, 'S' },
1089 { "msgid", required_argument
, 0, OPT_MSGID
},
1090 { "skip-empty", no_argument
, 0, 'e' },
1091 { "sd-id", required_argument
, 0, OPT_STRUCTURED_DATA_ID
},
1092 { "sd-param", required_argument
, 0, OPT_STRUCTURED_DATA_PARAM
},
1093 #ifdef HAVE_LIBSYSTEMD
1094 { "journald", optional_argument
, 0, OPT_JOURNALD
},
1099 setlocale(LC_ALL
, "");
1100 bindtextdomain(PACKAGE
, LOCALEDIR
);
1101 textdomain(PACKAGE
);
1102 atexit(close_stdout
);
1104 INIT_LIST_HEAD(&ctl
.user_sds
);
1105 INIT_LIST_HEAD(&ctl
.reserved_sds
);
1107 while ((ch
= getopt_long(argc
, argv
, "ef:ip:S:st:u:dTn:P:Vh",
1108 longopts
, NULL
)) != -1) {
1110 case 'f': /* file to log */
1111 if (freopen(optarg
, "r", stdin
) == NULL
)
1112 err(EXIT_FAILURE
, _("file %s"), optarg
);
1113 stdout_reopened
= 1;
1116 ctl
.skip_empty_lines
= 1;
1118 case 'i': /* log process id also */
1119 ctl
.pid
= logger_getpid();
1123 const char *p
= optarg
;
1127 ctl
.pid
= strtoul_or_err(optarg
, _("failed to parse id"));
1129 ctl
.pid
= logger_getpid();
1131 case 'p': /* priority */
1132 ctl
.pri
= pencode(optarg
);
1134 case 's': /* log to standard error */
1135 ctl
.stderr_printout
= 1;
1140 case 'u': /* unix socket */
1141 ctl
.unix_socket
= optarg
;
1143 case 'S': /* max message size */
1144 ctl
.max_message_size
= strtosize_or_err(optarg
,
1145 _("failed to parse message size"));
1148 ctl
.socket_type
= TYPE_UDP
;
1151 ctl
.socket_type
= TYPE_TCP
;
1154 ctl
.server
= optarg
;
1160 printf(UTIL_LINUX_VERSION
);
1164 case OPT_OCTET_COUNT
:
1165 ctl
.octet_count
= 1;
1167 case OPT_PRIO_PREFIX
:
1168 ctl
.prio_prefix
= 1;
1171 ctl
.syslogfp
= syslog_rfc3164_header
;
1174 ctl
.syslogfp
= syslog_rfc5424_header
;
1176 parse_rfc5424_flags(&ctl
, optarg
);
1179 if (strchr(optarg
, ' '))
1180 errx(EXIT_FAILURE
, _("--msgid cannot contain space"));
1183 #ifdef HAVE_LIBSYSTEMD
1186 jfd
= fopen(optarg
, "r");
1188 err(EXIT_FAILURE
, _("cannot open %s"),
1194 case OPT_SOCKET_ERRORS
:
1195 unix_socket_errors_mode
= parse_unix_socket_errors_flags(optarg
);
1200 case OPT_STRUCTURED_DATA_ID
:
1201 if (!valid_structured_data_id(optarg
))
1202 errx(EXIT_FAILURE
, _("invalid structured data ID: '%s'"), optarg
);
1203 add_structured_data_id(get_user_structured_data(&ctl
), optarg
);
1205 case OPT_STRUCTURED_DATA_PARAM
:
1206 if (!valid_structured_data_param(optarg
))
1207 errx(EXIT_FAILURE
, _("invalid structured data parameter: '%s'"), optarg
);
1208 add_structured_data_param(get_user_structured_data(&ctl
), optarg
);
1211 errtryhelp(EXIT_FAILURE
);
1216 if (stdout_reopened
&& argc
)
1217 warnx(_("--file <file> and <message> are mutually exclusive, message is ignored"));
1218 #ifdef HAVE_LIBSYSTEMD
1220 int ret
= journald_entry(&ctl
, jfd
);
1224 errx(EXIT_FAILURE
, _("journald entry could not be written"));
1225 return EXIT_SUCCESS
;
1229 /* user overwrites build-in SD-ELEMENT */
1230 if (has_structured_data_id(get_user_structured_data(&ctl
), "timeQuality"))
1233 switch (unix_socket_errors_mode
) {
1234 case AF_UNIX_ERRORS_OFF
:
1235 ctl
.unix_socket_errors
= 0;
1237 case AF_UNIX_ERRORS_ON
:
1238 ctl
.unix_socket_errors
= 1;
1240 case AF_UNIX_ERRORS_AUTO
:
1241 ctl
.unix_socket_errors
= ctl
.noact
|| ctl
.stderr_printout
;
1242 #ifdef HAVE_LIBSYSTEMD
1243 ctl
.unix_socket_errors
|= !!sd_booted();
1251 logger_command_line(&ctl
, argv
);
1253 /* Note. --file <arg> reopens stdin making the below
1254 * function to be used for file inputs. */
1257 return EXIT_SUCCESS
;