Encrypted syslog protocol. More...

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <byteswap.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/tcpip.h>
#include <ipxe/dhcp.h>
#include <ipxe/settings.h>
#include <ipxe/console.h>
#include <ipxe/lineconsole.h>
#include <ipxe/tls.h>
#include <ipxe/syslog.h>
#include <config/console.h>

Macros
#define	CONSOLE_SYSLOGS ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_TUI )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

static void	syslogs_close (struct interface *intf, int rc)
	Handle encrypted syslog TLS interface close. More...

static void	syslogs_window_changed (struct interface *intf)
	Handle encrypted syslog TLS interface window change. More...

static void	syslogs_handle_priority (struct ansiesc_context *ctx __unused, unsigned int count __unused, int params[])
	Handle ANSI set encrypted syslog priority (private sequence) More...

static void	syslogs_putchar (int character)
	Print a character to encrypted syslog console. More...

const struct setting syslogs_setting	__setting (SETTING_MISC, syslogs)
	Encrypted syslog server setting. More...

static int	apply_syslogs_settings (void)
	Apply encrypted syslog settings. More...

Variables
struct console_driver syslogs_console	__console_driver
	Encrypted syslog console driver. More...

static struct sockaddr_tcpip	logserver
	The encrypted syslog server. More...

static struct interface_operation	syslogs_operations []
	Encrypted syslog TLS interface operations. More...

static struct interface_descriptor	syslogs_desc
	Encrypted syslog TLS interface descriptor. More...

static struct interface	syslogs = INTF_INIT ( syslogs_desc )
	The encrypted syslog TLS interface. More...

static char	syslogs_buffer [SYSLOG_BUFSIZE]
	Encrypted syslog line buffer. More...

static unsigned int	syslogs_severity = SYSLOG_DEFAULT_SEVERITY
	Encrypted syslog severity. More...

static struct ansiesc_handler	syslogs_handlers []
	Encrypted syslog ANSI escape sequence handlers. More...

static struct line_console	syslogs_line
	Encrypted syslog line console. More...

static int	syslogs_entered
	Encrypted syslog recursion marker. More...

struct settings_applicator syslogs_applicator	__settings_applicator
	Encrypted syslog settings applicator. More...

Detailed Description

Encrypted syslog protocol.

Definition in file syslogs.c.

Macro Definition Documentation

◆ CONSOLE_SYSLOGS

#define CONSOLE_SYSLOGS ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_TUI )

Definition at line 50 of file syslogs.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ syslogs_close()

static void syslogs_close	(	struct interface *	intf,
		int	rc
	)

static

Handle encrypted syslog TLS interface close.

Parameters

intf	Interface
rc	Reason for close

Definition at line 66 of file syslogs.c.

                                                              {
 
         DBG ( "SYSLOGS console disconnected: %s\n", strerror ( rc ) );
         intf_restart ( intf, rc );
 }

References DBG, intf_restart(), rc, and strerror().

Referenced by apply_syslogs_settings().

◆ syslogs_window_changed()

static void syslogs_window_changed ( struct interface * intf )

static

Handle encrypted syslog TLS interface window change.

Parameters

intf Interface

Definition at line 77 of file syslogs.c.

                                                               {
 
         /* Mark console as enabled when window first opens, indicating
          * that TLS negotiation is complete.  (Do not disable console
          * when window closes again, since TCP will close the window
          * whenever there is unACKed data.)
          */
         if ( xfer_window ( intf ) ) {
                 if ( syslogs_console.disabled )
                         DBG ( "SYSLOGS console connected\n" );
                 syslogs_console.disabled = 0;
         }
 }

References DBG, and xfer_window().

◆ syslogs_handle_priority()

static void syslogs_handle_priority	(	struct ansiesc_context *ctx	__unused,
		unsigned int count	__unused,
		int	params[]
	)

static

Handle ANSI set encrypted syslog priority (private sequence)

Parameters

ctx	ANSI escape sequence context
count	Parameter count
params	List of graphic rendition aspects

Definition at line 125 of file syslogs.c.

                                                      {
         if ( params[0] >= 0 ) {
                 syslogs_severity = params[0];
         } else {
                 syslogs_severity = SYSLOG_DEFAULT_SEVERITY;
         }
 }

References SYSLOG_DEFAULT_SEVERITY, and syslogs_severity.

◆ syslogs_putchar()

static void syslogs_putchar ( int character )

static

Print a character to encrypted syslog console.

Parameters

character Character to be printed

Definition at line 158 of file syslogs.c.

                                               {
         int rc;
 
         /* Ignore if we are already mid-logging */
         if ( syslogs_entered )
                 return;
 
         /* Fill line buffer */
         if ( line_putchar ( &syslogs_line, character ) == 0 )
                 return;
 
         /* Guard against re-entry */
         syslogs_entered = 1;
 
         /* Send log message */
         if ( ( rc = syslog_send ( &syslogs, syslogs_severity,
                                   syslogs_buffer, "\n" ) ) != 0 ) {
                 DBG ( "SYSLOGS could not send log message: %s\n",
                       strerror ( rc ) );
         }
 
         /* Clear re-entry flag */
         syslogs_entered = 0;
 }

References DBG, line_putchar(), rc, strerror(), syslog_send(), syslogs, syslogs_buffer, syslogs_entered, syslogs_line, and syslogs_severity.

◆ __setting()

const struct setting syslogs_setting __setting	(	SETTING_MISC	,
		syslogs
	)

Encrypted syslog server setting.

◆ apply_syslogs_settings()

static int apply_syslogs_settings ( void )

static

Apply encrypted syslog settings.

Return values

rc	Return status code

Definition at line 210 of file syslogs.c.

                                            {
         static char *old_server;
         char *server;
         int rc;
 
         /* Fetch log server */
         fetch_string_setting_copy ( NULL, &syslogs_setting, &server );
 
         /* Do nothing unless log server has changed */
         if ( ( ( server == NULL ) && ( old_server == NULL ) ) ||
              ( ( server != NULL ) && ( old_server != NULL ) &&
                ( strcmp ( server, old_server ) == 0 ) ) ) {
                 rc = 0;
                 goto out_no_change;
         }
         free ( old_server );
         old_server = NULL;
 
         /* Reset encrypted syslog connection */
         syslogs_console.disabled = CONSOLE_DISABLED;
         intf_restart ( &syslogs, 0 );
 
         /* Do nothing unless we have a log server */
         if ( ! server ) {
                 DBG ( "SYSLOGS has no log server\n" );
                 rc = 0;
                 goto out_no_server;
         }
         DBG ( "SYSLOGS using log server %s\n", server );
 
         /* Connect to log server */
         if ( ( rc = xfer_open_named_socket ( &syslogs, SOCK_STREAM,
                                              (( struct sockaddr *) &logserver ),
                                              server, NULL ) ) != 0 ) {
                 DBG ( "SYSLOGS cannot connect to log server: %s\n",
                       strerror ( rc ) );
                 goto err_open_named_socket;
         }
 
         /* Add TLS filter */
         if ( ( rc = add_tls ( &syslogs, server, NULL, NULL ) ) != 0 ) {
                 DBG ( "SYSLOGS cannot create TLS filter: %s\n",
                       strerror ( rc ) );
                 goto err_add_tls;
         }
 
         /* Record log server */
         old_server = server;
 
         return 0;
 
  err_add_tls:
  err_open_named_socket:
         syslogs_close ( &syslogs, rc );
  out_no_server:
  out_no_change:
         free ( server );
         return rc;
 }

References add_tls(), CONSOLE_DISABLED, DBG, fetch_string_setting_copy(), free, intf_restart(), logserver, NULL, rc, SOCK_STREAM, strcmp(), strerror(), syslogs, syslogs_close(), and xfer_open_named_socket().

Variable Documentation

◆ __console_driver

struct console_driver syslogs_console __console_driver

Initial value:

= {
        .putchar = syslogs_putchar,
        .disabled = CONSOLE_DISABLED,
        .usage = CONSOLE_SYSLOGS,
}

Encrypted syslog console driver.

Definition at line 53 of file syslogs.c.

◆ logserver

struct sockaddr_tcpip logserver

static

Initial value:

= {
        .st_port = htons ( SYSLOG_PORT ),
}

The encrypted syslog server.

Definition at line 56 of file syslogs.c.

Referenced by apply_syslogs_settings().

◆ syslogs_operations

struct interface_operation syslogs_operations[]

static

Initial value:

= {
        INTF_OP ( xfer_window_changed, struct interface *,
                  syslogs_window_changed ),
        INTF_OP ( intf_close, struct interface *, syslogs_close ),
}

Encrypted syslog TLS interface operations.

Definition at line 92 of file syslogs.c.

◆ syslogs_desc

struct interface_descriptor syslogs_desc

static

Initial value:

=

INTF_DESC_PURE ( syslogs_operations )

syslogs_operations

static struct interface_operation syslogs_operations[]

Encrypted syslog TLS interface operations.

Definition: syslogs.c:92

INTF_DESC_PURE

#define INTF_DESC_PURE(operations)

Define an object interface descriptor for a pure-interface object.

Definition: interface.h:115

Encrypted syslog TLS interface descriptor.

Definition at line 99 of file syslogs.c.

◆ syslogs

struct interface syslogs = INTF_INIT ( syslogs_desc )

static

The encrypted syslog TLS interface.

Definition at line 103 of file syslogs.c.

Referenced by apply_syslogs_settings(), and syslogs_putchar().

◆ syslogs_buffer

char syslogs_buffer[SYSLOG_BUFSIZE]

static

Encrypted syslog line buffer.

Definition at line 113 of file syslogs.c.

Referenced by syslogs_putchar().

◆ syslogs_severity

unsigned int syslogs_severity = SYSLOG_DEFAULT_SEVERITY

static

Encrypted syslog severity.

Definition at line 116 of file syslogs.c.

Referenced by syslogs_handle_priority(), and syslogs_putchar().

◆ syslogs_handlers

struct ansiesc_handler syslogs_handlers[]

static

Initial value:

= {
        { ANSIESC_LOG_PRIORITY, syslogs_handle_priority },
        { 0, NULL }
}

Encrypted syslog ANSI escape sequence handlers.

Definition at line 136 of file syslogs.c.

◆ syslogs_line

struct line_console syslogs_line

static

Initial value:

= {
        .buffer = syslogs_buffer,
        .len = sizeof ( syslogs_buffer ),
        .ctx = {
                .handlers = syslogs_handlers,
        },
}

Encrypted syslog line console.

Definition at line 142 of file syslogs.c.

Referenced by syslogs_putchar().

◆ syslogs_entered

int syslogs_entered

static

Encrypted syslog recursion marker.

Definition at line 151 of file syslogs.c.

Referenced by syslogs_putchar().

◆ __settings_applicator

struct settings_applicator syslogs_applicator __settings_applicator

Initial value:

= {
        .apply = apply_syslogs_settings,
}

Encrypted syslog settings applicator.

Definition at line 271 of file syslogs.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CONSOLE_SYSLOGS

Function Documentation

◆ FILE_LICENCE()

◆ syslogs_close()

◆ syslogs_window_changed()

◆ syslogs_handle_priority()

◆ syslogs_putchar()

◆ __setting()

◆ apply_syslogs_settings()

Variable Documentation

◆ __console_driver

◆ logserver

◆ syslogs_operations

◆ syslogs_desc

◆ syslogs

◆ syslogs_buffer

◆ syslogs_severity

◆ syslogs_handlers

◆ syslogs_line

◆ syslogs_entered

◆ __settings_applicator