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 */
142 #define is_connected(_ctl) ((_ctl)->fd >= 0)
143 static void logger_reopen(struct logger_ctl
*ctl
);
146 * For tests we want to be able to control datetime outputs
149 static inline int logger_gettimeofday(struct timeval
*tv
, struct timezone
*tz
)
151 char *str
= getenv("LOGGER_TEST_TIMEOFDAY");
154 if (str
&& sscanf(str
, "%ju.%ju", &sec
, &usec
) == 2) {
157 return tv
->tv_sec
>= 0 && tv
->tv_usec
>= 0 ? 0 : -EINVAL
;
160 return gettimeofday(tv
, tz
);
163 static inline char *logger_xgethostname(void)
165 char *str
= getenv("LOGGER_TEST_HOSTNAME");
166 return str
? xstrdup(str
) : xgethostname();
169 static inline pid_t
logger_getpid(void)
171 char *str
= getenv("LOGGER_TEST_GETPID");
174 if (str
&& sscanf(str
, "%u", &pid
) == 1)
180 #undef HAVE_NTP_GETTIME /* force to default non-NTP */
182 #else /* !TEST_LOGGER */
183 # define logger_gettimeofday(x, y) gettimeofday(x, y)
184 # define logger_xgethostname xgethostname
185 # define logger_getpid getpid
189 static int decode(const char *name
, const CODE
*codetab
)
191 register const CODE
*c
;
193 if (name
== NULL
|| *name
== '\0')
195 if (isdigit(*name
)) {
200 num
= strtol(name
, &end
, 10);
201 if (errno
|| name
== end
|| (end
&& *end
))
203 for (c
= codetab
; c
->c_name
; c
++)
208 for (c
= codetab
; c
->c_name
; c
++)
209 if (!strcasecmp(name
, c
->c_name
))
215 static int pencode(char *s
)
220 separator
= strchr(s
, '.');
223 facility
= decode(s
, facilitynames
);
225 errx(EXIT_FAILURE
, _("unknown facility name: %s"), s
);
229 level
= decode(s
, prioritynames
);
231 errx(EXIT_FAILURE
, _("unknown priority name: %s"), s
);
232 if (facility
== LOG_KERN
)
233 facility
= LOG_USER
; /* kern is forbidden */
234 return ((level
& LOG_PRIMASK
) | (facility
& LOG_FACMASK
));
237 static int unix_socket(struct logger_ctl
*ctl
, const char *path
, int *socket_type
)
239 int fd
, i
, type
= -1;
240 static struct sockaddr_un s_addr
; /* AF_UNIX address of local logger */
242 if (strlen(path
) >= sizeof(s_addr
.sun_path
))
243 errx(EXIT_FAILURE
, _("openlog %s: pathname too long"), path
);
245 s_addr
.sun_family
= AF_UNIX
;
246 strcpy(s_addr
.sun_path
, path
);
248 for (i
= 2; i
; i
--) {
251 if (i
== 2 && *socket_type
& TYPE_UDP
) {
255 if (i
== 1 && *socket_type
& TYPE_TCP
) {
259 if (st
== -1 || (fd
= socket(AF_UNIX
, st
, 0)) == -1)
261 if (connect(fd
, (struct sockaddr
*)&s_addr
, sizeof(s_addr
)) == -1) {
269 if (ctl
->unix_socket_errors
)
270 err(EXIT_FAILURE
, _("socket %s"), path
);
272 /* write_output() will try to reconnect */
276 /* replace ALL_TYPES with the real TYPE_* */
277 if (type
> 0 && type
!= *socket_type
)
282 static int inet_socket(const char *servername
, const char *port
, int *socket_type
)
284 int fd
, errcode
, i
, type
= -1;
285 struct addrinfo hints
, *res
;
286 const char *p
= port
;
288 for (i
= 2; i
; i
--) {
289 memset(&hints
, 0, sizeof(hints
));
290 if (i
== 2 && *socket_type
& TYPE_UDP
) {
291 hints
.ai_socktype
= SOCK_DGRAM
;
296 if (i
== 1 && *socket_type
& TYPE_TCP
) {
297 hints
.ai_socktype
= SOCK_STREAM
;
302 if (hints
.ai_socktype
== 0)
304 hints
.ai_family
= AF_UNSPEC
;
305 errcode
= getaddrinfo(servername
, p
, &hints
, &res
);
307 errx(EXIT_FAILURE
, _("failed to resolve name %s port %s: %s"),
308 servername
, p
, gai_strerror(errcode
));
309 if ((fd
= socket(res
->ai_family
, res
->ai_socktype
, res
->ai_protocol
)) == -1) {
313 if (connect(fd
, res
->ai_addr
, res
->ai_addrlen
) == -1) {
324 errx(EXIT_FAILURE
, _("failed to connect to %s port %s"), servername
, p
);
326 /* replace ALL_TYPES with the real TYPE_* */
327 if (type
> 0 && type
!= *socket_type
)
332 #ifdef HAVE_LIBSYSTEMD
333 static int journald_entry(struct logger_ctl
*ctl
, FILE *fp
)
338 int n
, lines
, vectors
= 8, ret
= 0;
341 iovec
= xmalloc(vectors
* sizeof(struct iovec
));
342 for (lines
= 0; /* nothing */ ; lines
++) {
344 sz
= getline(&buf
, &dummy
, fp
);
346 (sz
= rtrim_whitespace((unsigned char *) buf
)) == 0) {
350 if (lines
== vectors
) {
352 if (IOV_MAX
< vectors
)
353 errx(EXIT_FAILURE
, _("maximum input lines (%d) exceeded"), IOV_MAX
);
354 iovec
= xrealloc(iovec
, vectors
* sizeof(struct iovec
));
356 iovec
[lines
].iov_base
= buf
;
357 iovec
[lines
].iov_len
= sz
;
361 ret
= sd_journal_sendv(iovec
, lines
);
362 if (ctl
->stderr_printout
) {
363 for (n
= 0; n
< lines
; n
++)
364 fprintf(stderr
, "%s\n", (char *) iovec
[n
].iov_base
);
366 for (n
= 0; n
< lines
; n
++)
367 free(iovec
[n
].iov_base
);
373 static char const *xgetlogin(void)
378 if (!(cp
= getlogin()) || !*cp
)
379 cp
= (pw
= getpwuid(geteuid()))? pw
->pw_name
: "<someone>";
383 /* this creates a timestamp based on current time according to the
384 * fine rules of RFC3164, most importantly it ensures in a portable
385 * way that the month day is correctly written (with a SP instead
386 * of a leading 0). The function uses a static buffer which is
387 * overwritten on the next call (just like ctime() does).
389 static char const *rfc3164_current_time(void)
391 static char time
[32];
394 static char const * const monthnames
[] = {
395 "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug",
396 "Sep", "Oct", "Nov", "Dec"
399 logger_gettimeofday(&tv
, NULL
);
400 tm
= localtime(&tv
.tv_sec
);
401 snprintf(time
, sizeof(time
),"%s %2d %2.2d:%2.2d:%2.2d",
402 monthnames
[tm
->tm_mon
], tm
->tm_mday
,
403 tm
->tm_hour
, tm
->tm_min
, tm
->tm_sec
);
407 #define next_iovec(ary, idx) __extension__ ({ \
408 assert(ARRAY_SIZE(ary) > (size_t)idx); \
413 #define iovec_add_string(ary, idx, str, len) \
415 struct iovec *v = next_iovec(ary, idx); \
416 v->iov_base = (void *) str; \
417 v->iov_len = len ? len : strlen(str); \
420 #define iovec_memcmp(ary, idx, str, len) \
421 memcmp((ary)[(idx) - 1].iov_base, str, len)
423 /* writes generated buffer to desired destination. For TCP syslog,
424 * we use RFC6587 octet-stuffing (unless octet-counting is selected).
425 * This is not great, but doing full blown RFC5425 (TLS) looks like
426 * it is too much for the logger utility. If octet-counting is
427 * selected, we use that.
429 static void write_output(struct logger_ctl
*ctl
, const char *const msg
)
435 /* initial connect failed? */
436 if (!ctl
->noact
&& !is_connected(ctl
))
440 if (ctl
->octet_count
) {
441 size_t len
= xasprintf(&octet
, "%zu ", strlen(ctl
->hdr
) + strlen(msg
));
442 iovec_add_string(iov
, iovlen
, octet
, len
);
446 iovec_add_string(iov
, iovlen
, ctl
->hdr
, 0);
449 iovec_add_string(iov
, iovlen
, msg
, 0);
451 if (!ctl
->noact
&& is_connected(ctl
)) {
452 struct msghdr message
= { 0 };
453 #ifdef SCM_CREDENTIALS
454 struct cmsghdr
*cmhp
;
458 char control
[CMSG_SPACE(sizeof(struct ucred
))];
462 /* 4) add extra \n to make sure message is terminated */
463 if ((ctl
->socket_type
== TYPE_TCP
) && !ctl
->octet_count
)
464 iovec_add_string(iov
, iovlen
, "\n", 1);
466 message
.msg_iov
= iov
;
467 message
.msg_iovlen
= iovlen
;
469 #ifdef SCM_CREDENTIALS
470 /* syslog/journald may follow local socket credentials rather
471 * than in the message PID. If we use --id as root than we can
472 * force kernel to accept another valid PID than the real logger(1)
475 if (ctl
->pid
&& !ctl
->server
&& ctl
->pid
!= getpid()
476 && geteuid() == 0 && kill(ctl
->pid
, 0) == 0) {
478 message
.msg_control
= cbuf
.control
;
479 message
.msg_controllen
= CMSG_SPACE(sizeof(struct ucred
));
481 cmhp
= CMSG_FIRSTHDR(&message
);
482 cmhp
->cmsg_len
= CMSG_LEN(sizeof(struct ucred
));
483 cmhp
->cmsg_level
= SOL_SOCKET
;
484 cmhp
->cmsg_type
= SCM_CREDENTIALS
;
485 cred
= (struct ucred
*) CMSG_DATA(cmhp
);
487 cred
->pid
= ctl
->pid
;
490 /* Note that logger(1) maybe executed for long time (as pipe
491 * reader) and connection endpoint (syslogd) may be restarted.
493 * The libc syslog() function reconnects on failed send().
494 * Let's do the same to be robust. [kzak -- Oct 2017]
496 * MSG_NOSIGNAL is POSIX.1-2008 compatible, but it for example
497 * no suported by apple-darwin15.6.0.
500 # define MSG_NOSIGNAL 0
502 if (sendmsg(ctl
->fd
, &message
, MSG_NOSIGNAL
) < 0) {
504 if (sendmsg(ctl
->fd
, &message
, MSG_NOSIGNAL
) < 0)
505 warn(_("send message failed"));
509 if (ctl
->stderr_printout
) {
510 /* make sure it's terminated for stderr */
511 if (iovec_memcmp(iov
, iovlen
, "\n", 1) != 0)
512 iovec_add_string(iov
, iovlen
, "\n", 1);
514 ignore_result( writev(STDERR_FILENO
, iov
, iovlen
) );
521 static void syslog_rfc3164_header(struct logger_ctl
*const ctl
)
523 char pid
[30], *hostname
;
529 snprintf(pid
, sizeof(pid
), "[%d]", ctl
->pid
);
531 if ((hostname
= logger_xgethostname())) {
532 char *dot
= strchr(hostname
, '.');
536 hostname
= xstrdup(NILVALUE
);
538 xasprintf(&ctl
->hdr
, "<%d>%.15s %s %.200s%s: ",
539 ctl
->pri
, rfc3164_current_time(), hostname
, ctl
->tag
, pid
);
544 static inline struct list_head
*get_user_structured_data(struct logger_ctl
*ctl
)
546 return &ctl
->user_sds
;
549 static inline struct list_head
*get_reserved_structured_data(struct logger_ctl
*ctl
)
551 return &ctl
->reserved_sds
;
554 static int has_structured_data_id(struct list_head
*ls
, const char *id
)
558 if (!ls
|| list_empty(ls
))
561 list_for_each(p
, ls
) {
562 struct structured_data
*sd
= list_entry(p
, struct structured_data
, sds
);
563 if (sd
->id
&& strcmp(sd
->id
, id
) == 0)
570 static void add_structured_data_id(struct list_head
*ls
, const char *id
)
572 struct structured_data
*sd
;
576 if (has_structured_data_id(ls
, id
))
577 errx(EXIT_FAILURE
, _("structured data ID '%s' is not unique"), id
);
579 sd
= xcalloc(1, sizeof(*sd
));
580 INIT_LIST_HEAD(&sd
->sds
);
581 sd
->id
= xstrdup(id
);
583 list_add_tail(&sd
->sds
, ls
);
586 static void add_structured_data_param(struct list_head
*ls
, const char *param
)
588 struct structured_data
*sd
;
591 errx(EXIT_FAILURE
, _("--sd-id was not specified for --sd-param %s"), param
);
595 sd
= list_last_entry(ls
, struct structured_data
, sds
);
597 if (strv_extend(&sd
->params
, param
))
601 static void add_structured_data_paramf(struct list_head
*ls
, const char *fmt
, ...)
603 struct structured_data
*sd
;
607 assert(!list_empty(ls
));
610 sd
= list_last_entry(ls
, struct structured_data
, sds
);
612 x
= strv_extendv(&sd
->params
, fmt
, ap
);
619 static char *strdup_structured_data(struct structured_data
*sd
)
623 if (strv_isempty(sd
->params
))
626 xasprintf(&res
, "[%s %s]", sd
->id
,
627 (tmp
= strv_join(sd
->params
, " ")));
632 static char *strdup_structured_data_list(struct list_head
*ls
)
637 list_for_each(p
, ls
) {
638 struct structured_data
*sd
= list_entry(p
, struct structured_data
, sds
);
639 char *one
= strdup_structured_data(sd
);
644 res
= strappend(tmp
, one
);
652 static char *get_structured_data_string(struct logger_ctl
*ctl
)
654 char *sys
= NULL
, *usr
= NULL
, *res
;
656 if (!list_empty(&ctl
->reserved_sds
))
657 sys
= strdup_structured_data_list(&ctl
->reserved_sds
);
658 if (!list_empty(&ctl
->user_sds
))
659 usr
= strdup_structured_data_list(&ctl
->user_sds
);
662 res
= strappend(sys
, usr
);
666 res
= sys
? sys
: usr
;
671 static int valid_structured_data_param(const char *str
)
673 char *eq
= strchr(str
, '='),
674 *qm1
= strchr(str
, '"'),
675 *qm2
= qm1
? strchr(qm1
+ 1, '"') : NULL
;
677 if (!eq
|| !qm1
|| !qm2
) /* something is missing */
681 return eq
> str
&& eq
< qm1
&& eq
+ 1 == qm1
&& qm1
< qm2
&& *(qm2
+ 1) == '\0';
685 * name@<private enterprise number>, e.g., "ourSDID@32473"
687 static int valid_structured_data_id(const char *str
)
689 char *at
= strchr(str
, '@');
692 /* standardized IDs without @<digits> */
693 if (!at
&& (strcmp(str
, "timeQuality") == 0 ||
694 strcmp(str
, "origin") == 0 ||
695 strcmp(str
, "meta") == 0))
698 if (!at
|| at
== str
|| !*(at
+ 1))
701 /* <digits> or <digits>.<digits>[...] */
702 for (p
= at
+ 1; p
&& *p
; p
++) {
705 if (isdigit_strend(p
, &end
))
706 break; /* only digits in the string */
708 if (end
== NULL
|| end
== p
||
709 *end
!= '.' || *(end
+ 1) == '\0')
714 /* check for forbidden chars in the <name> */
715 for (p
= str
; p
< at
; p
++) {
716 if (*p
== '[' || *p
== '=' || *p
== '"' || *p
== '@')
718 if (isblank((unsigned char) *p
) || iscntrl((unsigned char) *p
))
725 /* Some field mappings may be controversial, thus I give the reason
726 * why this specific mapping was used:
728 * Some may argue that "logger" is a better fit, but we think
729 * this is better inline of what other implementations do. In
730 * rsyslog, for example, the TAG value is populated from APP-NAME.
732 * This is a relatively straightforward interpretation from
733 * RFC5424, sect. 6.2.6.
734 * MSGID <-- msgid (from --msgid)
735 * One may argue that the string "logger" would be better suited
736 * here so that a receiver can identify the sender process.
737 * However, this does not sound like a good match to RFC5424,
739 * Note that appendix A.1 of RFC5424 does not provide clear guidance
740 * of how these fields should be used. This is the case because the
741 * IETF working group couldn't arrive at a clear agreement when we
742 * specified RFC5424. The rest of the field mappings should be
743 * pretty clear from RFC5424. -- Rainer Gerhards, 2015-03-10
745 static void syslog_rfc5424_header(struct logger_ctl
*const ctl
)
749 char const *app_name
= ctl
->tag
;
751 char *const msgid
= xstrdup(ctl
->msgid
? ctl
->msgid
: NILVALUE
);
752 char *structured
= NULL
;
753 struct list_head
*sd
;
758 if (ctl
->rfc5424_time
) {
762 logger_gettimeofday(&tv
, NULL
);
763 if ((tm
= localtime(&tv
.tv_sec
)) != NULL
) {
765 const size_t i
= strftime(fmt
, sizeof(fmt
),
766 "%Y-%m-%dT%H:%M:%S.%%06u%z ", tm
);
767 /* patch TZ info to comply with RFC3339 (we left SP at end) */
768 fmt
[i
- 1] = fmt
[i
- 2];
769 fmt
[i
- 2] = fmt
[i
- 3];
771 xasprintf(&time
, fmt
, tv
.tv_usec
);
773 err(EXIT_FAILURE
, _("localtime() failed"));
775 time
= xstrdup(NILVALUE
);
777 if (ctl
->rfc5424_host
) {
778 if (!(hostname
= logger_xgethostname()))
779 hostname
= xstrdup(NILVALUE
);
780 /* Arbitrary looking 'if (var < strlen()) checks originate from
781 * RFC 5424 - 6 Syslog Message Format definition. */
782 if (255 < strlen(hostname
))
783 errx(EXIT_FAILURE
, _("hostname '%s' is too long"),
786 hostname
= xstrdup(NILVALUE
);
788 if (48 < strlen(ctl
->tag
))
789 errx(EXIT_FAILURE
, _("tag '%s' is too long"), ctl
->tag
);
792 xasprintf(&procid
, "%d", ctl
->pid
);
794 procid
= xstrdup(NILVALUE
);
796 sd
= get_reserved_structured_data(ctl
);
798 /* time quality structured data (maybe overwritten by --sd-id timeQuality) */
799 if (ctl
->rfc5424_tq
&& !has_structured_data_id(sd
, "timeQuality")) {
801 add_structured_data_id(sd
, "timeQuality");
802 add_structured_data_param(sd
, "tzKnown=\"1\"");
804 #ifdef HAVE_NTP_GETTIME
805 struct ntptimeval ntptv
;
807 if (ntp_gettime(&ntptv
) == TIME_OK
) {
808 add_structured_data_param(sd
, "isSynced=\"1\"");
809 add_structured_data_paramf(sd
, "syncAccuracy=\"%ld\"", ntptv
.maxerror
);
812 add_structured_data_paramf(sd
, "isSynced=\"0\"");
815 /* convert all structured data to string */
816 structured
= get_structured_data_string(ctl
);
818 structured
= xstrdup(NILVALUE
);
820 xasprintf(&ctl
->hdr
, "<%d>1 %s %s %s %s %s %s ",
831 /* app_name points to ctl->tag, do NOT free! */
837 static void parse_rfc5424_flags(struct logger_ctl
*ctl
, char *s
)
842 while ((tok
= strtok(in
, ","))) {
844 if (!strcmp(tok
, "notime")) {
845 ctl
->rfc5424_time
= 0;
847 } else if (!strcmp(tok
, "notq"))
849 else if (!strcmp(tok
, "nohost"))
850 ctl
->rfc5424_host
= 0;
852 warnx(_("ignoring unknown option argument: %s"), tok
);
856 static int parse_unix_socket_errors_flags(char *s
)
858 if (!strcmp(s
, "off"))
859 return AF_UNIX_ERRORS_OFF
;
860 if (!strcmp(s
, "on"))
861 return AF_UNIX_ERRORS_ON
;
862 if (!strcmp(s
, "auto"))
863 return AF_UNIX_ERRORS_AUTO
;
864 warnx(_("invalid argument: %s: using automatic errors"), s
);
865 return AF_UNIX_ERRORS_AUTO
;
868 static void syslog_local_header(struct logger_ctl
*const ctl
)
873 snprintf(pid
, sizeof(pid
), "[%d]", ctl
->pid
);
877 xasprintf(&ctl
->hdr
, "<%d>%s %s%s: ", ctl
->pri
, rfc3164_current_time(),
881 static void generate_syslog_header(struct logger_ctl
*const ctl
)
887 /* just open, nothing else */
888 static void __logger_open(struct logger_ctl
*ctl
)
891 ctl
->fd
= inet_socket(ctl
->server
, ctl
->port
, &ctl
->socket_type
);
893 if (!ctl
->unix_socket
)
894 ctl
->unix_socket
= _PATH_DEVLOG
;
896 ctl
->fd
= unix_socket(ctl
, ctl
->unix_socket
, &ctl
->socket_type
);
900 /* open and initialize relevant @ctl tuff */
901 static void logger_open(struct logger_ctl
*ctl
)
906 ctl
->syslogfp
= ctl
->server
? syslog_rfc5424_header
:
909 ctl
->tag
= xgetlogin();
911 generate_syslog_header(ctl
);
914 /* re-open; usually after failed connection */
915 static void logger_reopen(struct logger_ctl
*ctl
)
924 static void logger_command_line(struct logger_ctl
*ctl
, char **argv
)
926 /* note: we never re-generate the syslog header here, even if we
927 * generate multiple messages. If so, we think it is the right thing
928 * to do to report them with the same timestamp, as the user actually
929 * intended to send a single message.
931 char *const buf
= xmalloc(ctl
->max_message_size
+ 1);
933 const char *endp
= buf
+ ctl
->max_message_size
- 1;
938 if (endp
< p
+ len
&& p
!= buf
) {
939 write_output(ctl
, buf
);
942 if (ctl
->max_message_size
< len
) {
943 (*argv
)[ctl
->max_message_size
] = '\0'; /* truncate */
944 write_output(ctl
, *argv
++);
949 memmove(p
, *argv
++, len
);
953 write_output(ctl
, buf
);
957 static void logger_stdin(struct logger_ctl
*ctl
)
959 /* note: we re-generate the syslog header for each log message to
960 * update header timestamps and to reflect possible priority changes.
961 * The initial header is generated by logger_open().
964 int default_priority
= ctl
->pri
;
965 int last_pri
= default_priority
;
966 size_t max_usrmsg_size
= ctl
->max_message_size
- strlen(ctl
->hdr
);
967 char *const buf
= xmalloc(max_usrmsg_size
+ 2 + 2);
975 if (ctl
->prio_prefix
&& c
== '<') {
978 while (isdigit(c
= getchar()) && pri
<= 191) {
980 pri
= pri
* 10 + c
- '0';
982 if (c
!= EOF
&& c
!= '\n')
984 if (c
== '>' && 0 <= pri
&& pri
<= 191) {
985 /* valid RFC PRI values */
987 if (pri
< 8) /* kern facility is forbidden */
991 ctl
->pri
= default_priority
;
993 if (ctl
->pri
!= last_pri
) {
996 ctl
->max_message_size
- strlen(ctl
->hdr
);
999 if (c
!= EOF
&& c
!= '\n')
1003 while (c
!= EOF
&& c
!= '\n' && i
< max_usrmsg_size
) {
1009 if (i
> 0 || !ctl
->skip_empty_lines
) {
1011 generate_syslog_header(ctl
);
1012 write_output(ctl
, buf
);
1016 if (c
== '\n') /* discard line terminator */
1023 static void logger_close(const struct logger_ctl
*ctl
)
1025 if (ctl
->fd
!= -1 && close(ctl
->fd
) != 0)
1026 err(EXIT_FAILURE
, _("close failed"));
1030 static void __attribute__((__noreturn__
)) usage(void)
1033 fputs(USAGE_HEADER
, out
);
1034 fprintf(out
, _(" %s [options] [<message>]\n"), program_invocation_short_name
);
1036 fputs(USAGE_SEPARATOR
, out
);
1037 fputs(_("Enter messages into the system log.\n"), out
);
1039 fputs(USAGE_OPTIONS
, out
);
1040 fputs(_(" -i log the logger command's PID\n"), out
);
1041 fputs(_(" --id[=<id>] log the given <id>, or otherwise the PID\n"), out
);
1042 fputs(_(" -f, --file <file> log the contents of this file\n"), out
);
1043 fputs(_(" -e, --skip-empty do not log empty lines when processing files\n"), out
);
1044 fputs(_(" --no-act do everything except the write the log\n"), out
);
1045 fputs(_(" -p, --priority <prio> mark given message with this priority\n"), out
);
1046 fputs(_(" --octet-count use rfc6587 octet counting\n"), out
);
1047 fputs(_(" --prio-prefix look for a prefix on every line read from stdin\n"), out
);
1048 fputs(_(" -s, --stderr output message to standard error as well\n"), out
);
1049 fputs(_(" -S, --size <size> maximum size for a single message\n"), out
);
1050 fputs(_(" -t, --tag <tag> mark every line with this tag\n"), out
);
1051 fputs(_(" -n, --server <name> write to this remote syslog server\n"), out
);
1052 fputs(_(" -P, --port <port> use this port for UDP or TCP connection\n"), out
);
1053 fputs(_(" -T, --tcp use TCP only\n"), out
);
1054 fputs(_(" -d, --udp use UDP only\n"), out
);
1055 fputs(_(" --rfc3164 use the obsolete BSD syslog protocol\n"), out
);
1056 fputs(_(" --rfc5424[=<snip>] use the syslog protocol (the default for remote);\n"
1057 " <snip> can be notime, or notq, and/or nohost\n"), out
);
1058 fputs(_(" --sd-id <id> rfc5424 structured data ID\n"), out
);
1059 fputs(_(" --sd-param <data> rfc5424 structured data name=value\n"), out
);
1060 fputs(_(" --msgid <msgid> set rfc5424 message id field\n"), out
);
1061 fputs(_(" -u, --socket <socket> write to this Unix socket\n"), out
);
1062 fputs(_(" --socket-errors[=<on|off|auto>]\n"
1063 " print connection errors when using Unix sockets\n"), out
);
1064 #ifdef HAVE_LIBSYSTEMD
1065 fputs(_(" --journald[=<file>] write journald entry\n"), out
);
1068 fputs(USAGE_SEPARATOR
, out
);
1069 printf(USAGE_HELP_OPTIONS(26));
1070 printf(USAGE_MAN_TAIL("logger(1)"));
1076 * logger -- read and log utility
1078 * Reads from an input and arranges to write the result on the system
1081 int main(int argc
, char **argv
)
1083 struct logger_ctl ctl
= {
1086 .pri
= LOG_USER
| LOG_NOTICE
,
1089 .unix_socket
= NULL
,
1090 .unix_socket_errors
= 0,
1095 .socket_type
= ALL_TYPES
,
1096 .max_message_size
= 1024,
1100 .skip_empty_lines
= 0
1103 int stdout_reopened
= 0;
1104 int unix_socket_errors_mode
= AF_UNIX_ERRORS_AUTO
;
1105 #ifdef HAVE_LIBSYSTEMD
1108 static const struct option longopts
[] = {
1109 { "id", optional_argument
, 0, OPT_ID
},
1110 { "stderr", no_argument
, 0, 's' },
1111 { "file", required_argument
, 0, 'f' },
1112 { "no-act", no_argument
, 0, OPT_NOACT
, },
1113 { "priority", required_argument
, 0, 'p' },
1114 { "tag", required_argument
, 0, 't' },
1115 { "socket", required_argument
, 0, 'u' },
1116 { "socket-errors", required_argument
, 0, OPT_SOCKET_ERRORS
},
1117 { "udp", no_argument
, 0, 'd' },
1118 { "tcp", no_argument
, 0, 'T' },
1119 { "server", required_argument
, 0, 'n' },
1120 { "port", required_argument
, 0, 'P' },
1121 { "version", no_argument
, 0, 'V' },
1122 { "help", no_argument
, 0, 'h' },
1123 { "octet-count", no_argument
, 0, OPT_OCTET_COUNT
},
1124 { "prio-prefix", no_argument
, 0, OPT_PRIO_PREFIX
},
1125 { "rfc3164", no_argument
, 0, OPT_RFC3164
},
1126 { "rfc5424", optional_argument
, 0, OPT_RFC5424
},
1127 { "size", required_argument
, 0, 'S' },
1128 { "msgid", required_argument
, 0, OPT_MSGID
},
1129 { "skip-empty", no_argument
, 0, 'e' },
1130 { "sd-id", required_argument
, 0, OPT_STRUCTURED_DATA_ID
},
1131 { "sd-param", required_argument
, 0, OPT_STRUCTURED_DATA_PARAM
},
1132 #ifdef HAVE_LIBSYSTEMD
1133 { "journald", optional_argument
, 0, OPT_JOURNALD
},
1138 setlocale(LC_ALL
, "");
1139 bindtextdomain(PACKAGE
, LOCALEDIR
);
1140 textdomain(PACKAGE
);
1141 atexit(close_stdout
);
1143 INIT_LIST_HEAD(&ctl
.user_sds
);
1144 INIT_LIST_HEAD(&ctl
.reserved_sds
);
1146 while ((ch
= getopt_long(argc
, argv
, "ef:ip:S:st:u:dTn:P:Vh",
1147 longopts
, NULL
)) != -1) {
1149 case 'f': /* file to log */
1150 if (freopen(optarg
, "r", stdin
) == NULL
)
1151 err(EXIT_FAILURE
, _("file %s"), optarg
);
1152 stdout_reopened
= 1;
1155 ctl
.skip_empty_lines
= 1;
1157 case 'i': /* log process id also */
1158 ctl
.pid
= logger_getpid();
1162 const char *p
= optarg
;
1166 ctl
.pid
= strtoul_or_err(optarg
, _("failed to parse id"));
1168 ctl
.pid
= logger_getpid();
1170 case 'p': /* priority */
1171 ctl
.pri
= pencode(optarg
);
1173 case 's': /* log to standard error */
1174 ctl
.stderr_printout
= 1;
1179 case 'u': /* unix socket */
1180 ctl
.unix_socket
= optarg
;
1182 case 'S': /* max message size */
1183 ctl
.max_message_size
= strtosize_or_err(optarg
,
1184 _("failed to parse message size"));
1187 ctl
.socket_type
= TYPE_UDP
;
1190 ctl
.socket_type
= TYPE_TCP
;
1193 ctl
.server
= optarg
;
1199 printf(UTIL_LINUX_VERSION
);
1203 case OPT_OCTET_COUNT
:
1204 ctl
.octet_count
= 1;
1206 case OPT_PRIO_PREFIX
:
1207 ctl
.prio_prefix
= 1;
1210 ctl
.syslogfp
= syslog_rfc3164_header
;
1213 ctl
.syslogfp
= syslog_rfc5424_header
;
1215 parse_rfc5424_flags(&ctl
, optarg
);
1218 if (strchr(optarg
, ' '))
1219 errx(EXIT_FAILURE
, _("--msgid cannot contain space"));
1222 #ifdef HAVE_LIBSYSTEMD
1225 jfd
= fopen(optarg
, "r");
1227 err(EXIT_FAILURE
, _("cannot open %s"),
1233 case OPT_SOCKET_ERRORS
:
1234 unix_socket_errors_mode
= parse_unix_socket_errors_flags(optarg
);
1239 case OPT_STRUCTURED_DATA_ID
:
1240 if (!valid_structured_data_id(optarg
))
1241 errx(EXIT_FAILURE
, _("invalid structured data ID: '%s'"), optarg
);
1242 add_structured_data_id(get_user_structured_data(&ctl
), optarg
);
1244 case OPT_STRUCTURED_DATA_PARAM
:
1245 if (!valid_structured_data_param(optarg
))
1246 errx(EXIT_FAILURE
, _("invalid structured data parameter: '%s'"), optarg
);
1247 add_structured_data_param(get_user_structured_data(&ctl
), optarg
);
1250 errtryhelp(EXIT_FAILURE
);
1255 if (stdout_reopened
&& argc
)
1256 warnx(_("--file <file> and <message> are mutually exclusive, message is ignored"));
1257 #ifdef HAVE_LIBSYSTEMD
1259 int ret
= journald_entry(&ctl
, jfd
);
1263 errx(EXIT_FAILURE
, _("journald entry could not be written"));
1264 return EXIT_SUCCESS
;
1268 /* user overwrites build-in SD-ELEMENT */
1269 if (has_structured_data_id(get_user_structured_data(&ctl
), "timeQuality"))
1272 switch (unix_socket_errors_mode
) {
1273 case AF_UNIX_ERRORS_OFF
:
1274 ctl
.unix_socket_errors
= 0;
1276 case AF_UNIX_ERRORS_ON
:
1277 ctl
.unix_socket_errors
= 1;
1279 case AF_UNIX_ERRORS_AUTO
:
1280 ctl
.unix_socket_errors
= ctl
.noact
|| ctl
.stderr_printout
;
1281 #ifdef HAVE_LIBSYSTEMD
1282 ctl
.unix_socket_errors
|= !!sd_booted();
1290 logger_command_line(&ctl
, argv
);
1292 /* Note. --file <arg> reopens stdin making the below
1293 * function to be used for file inputs. */
1296 return EXIT_SUCCESS
;