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
use log::Record;
use log4rs::append::Append;
use std::error::Error;
use std::io;
use std::io::Write;
use std::net::{SocketAddr, TcpStream, ToSocketAddrs, UdpSocket};
use std::sync::Mutex;

pub mod consts;
pub mod plain;
pub mod rfc5424;
pub mod rfc5425;

const DEFAULT_PROTOCOL: SyslogAppenderProtocol = SyslogAppenderProtocol::UDP;
const DEFAULT_PORT: u16 = 514;
const DEFAULT_ADDRESS: &'static str = "localhost:514";
const DEFAULT_MAX_LENGTH: usize = 2048;

/// Writers to send syslog to UDP or TCP
#[derive(Debug)]
enum SyslogWriter {
    Udp(UdpSocket, SocketAddr),
    Tcp(Mutex<TcpStream>),
}

/// Trait that allows to format a given message.
trait Formattable {
    fn format(
        &self,
        rec: &Record,
        protocol: &SyslogAppenderProtocol,
        encoder: &Box<dyn log4rs::encode::Encode>,
    ) -> Result<String, Box<dyn Error + Sync + Send>>;
}

/// Syslog message format.
#[derive(Debug)]
pub enum MessageFormat {
    /// No formatting is applied.
    Plain(plain::Format),
    /// Formatting according to RFC5424 is applied.
    Rfc5424(rfc5424::Format),
    /// Formatting according to RFC5425 is applied (use with telegraf).
    Rfc5425(rfc5425::Format),
}

impl Formattable for MessageFormat {
    fn format<'a>(
        &self,
        rec: &Record<'a>,
        protocol: &SyslogAppenderProtocol,
        encoder: &Box<dyn log4rs::encode::Encode>,
    ) -> Result<String, Box<dyn Error + Sync + Send>> {
        match self {
            MessageFormat::Plain(ref fmt) => fmt.format(&rec, protocol, encoder),
            MessageFormat::Rfc5424(ref fmt) => fmt.format(&rec, protocol, encoder),
            MessageFormat::Rfc5425(ref fmt) => fmt.format(&rec, protocol, encoder),
        }
    }
}

#[derive(Debug)]
pub enum SyslogAppenderProtocol {
    UDP,
    TCP,
}

/// Appender that sends log messages to syslog.
#[derive(Debug)]
pub struct SyslogAppender {
    writer: SyslogWriter,
    msg_format: MessageFormat,
    max_len: usize,
    protocol: SyslogAppenderProtocol,
    encoder: Box<dyn log4rs::encode::Encode>,
}

impl Append for SyslogAppender {
    fn append<'a>(&self, record: &Record<'a>) -> Result<(), Box<dyn Error + Sync + Send>> {
        // Format the message, which will be different based on the chosen MsgFormat
        let msg = self
            .msg_format
            .format(&record, &self.protocol, &self.encoder)?;

        let mut bytes = msg.as_bytes();

        // Check for message length. If it exceeds DEFAULT_MAX_LENGTH, truncate.
        // Per syslog specification, a receiver may discard messages exceeding that limit.
        if bytes.len() > DEFAULT_MAX_LENGTH {
            bytes = &bytes[0..DEFAULT_MAX_LENGTH];
        }

        // Write to UDP or TCP depending on the configuration
        match self.writer {
            SyslogWriter::Udp(ref socket, ref addrs) => {
                socket.send_to(&bytes, addrs)?;
            }
            SyslogWriter::Tcp(ref stream_w) => {
                let mut stream = stream_w.lock().unwrap();
                stream.write(bytes)?;
            }
        };
        Ok(())
    }

    fn flush(&self) {}
}

/// Builder for `SyslogAppender`.
pub struct SyslogAppenderBuilder {
    protocol: SyslogAppenderProtocol,
    addrs: String,
    max_len: usize,
    msg_format: MessageFormat,
    encoder: Box<dyn log4rs::encode::Encode>,
}

impl SyslogAppenderBuilder {
    /// Creates a `SyslogAppenderBuilder` for constructing new `SyslogAppender`.
    pub fn new() -> SyslogAppenderBuilder {
        SyslogAppenderBuilder {
            protocol: DEFAULT_PROTOCOL,
            addrs: DEFAULT_ADDRESS.to_string(),
            max_len: DEFAULT_MAX_LENGTH,
            msg_format: MessageFormat::Plain(plain::Format {}),
            encoder: Box::new(log4rs::encode::pattern::PatternEncoder::default()),
        }
    }

    /// Sets network protocol for accessing syslog.
    ///
    /// Defaults to "udp".
    pub fn protocol(mut self, p: SyslogAppenderProtocol) -> Self {
        self.protocol = p;
        self
    }

    /// Sets network address of syslog server.
    ///
    /// Defaults to "localhost:514".
    pub fn address(mut self, addrs: String) -> Self {
        self.addrs = addrs;
        self
    }

    /// Sets type of log message formatter.
    ///
    /// Defaults to `Plain`.
    pub fn format(mut self, mf: MessageFormat) -> Self {
        self.msg_format = mf;
        self
    }

    /// Sets the maximum length of a message in bytes. If a log message exceedes
    /// this size, it's truncated with not respect to UTF char boundaries.
    ///
    /// Defaults to 2048.
    pub fn max_len(mut self, ml: usize) -> Self {
        self.max_len = ml;
        self
    }

    /// Sets the encoder used to encode the message
    ///
    pub fn encoder(mut self, encoder: Box<dyn log4rs::encode::Encode>) -> Self {
        self.encoder = encoder;
        self
    }
    /// Produces a `SyslogAppender` with parameters, supplied to the builder.
    pub fn build(mut self) -> io::Result<SyslogAppender> {
        norm_addrs(&mut self.addrs);
        let writer;

        match self.protocol {
            SyslogAppenderProtocol::UDP => {
                writer = udp_writer(self.addrs.as_str());
            }
            SyslogAppenderProtocol::TCP => {
                writer = tcp_writer(self.addrs.as_str());
            }
        }

        let appender = SyslogAppender {
            writer,
            msg_format: self.msg_format,
            max_len: self.max_len,
            protocol: self.protocol,
            encoder: self.encoder,
        };

        Ok(appender)
    }
}

/// Normalizes network address -- adds port if necessary
fn norm_addrs(addrs: &mut String) {
    if !addrs.find(':').is_some() {
        addrs.push(':');
        addrs.push_str(&DEFAULT_PORT.to_string())
    }
}

/// Creates writer for UDP protocol based on external host and port
fn udp_writer<T: ToSocketAddrs>(rem: T) -> SyslogWriter {
    let socket = UdpSocket::bind("0.0.0.0:0").unwrap();
    let rem_addrs = rem.to_socket_addrs().unwrap().next().unwrap();
    SyslogWriter::Udp(socket, rem_addrs)
}

/// Creates writer for TCP protocol based on external host and port
fn tcp_writer<T: ToSocketAddrs>(rem: T) -> SyslogWriter {
    let stream = TcpStream::connect(rem).unwrap();
    SyslogWriter::Tcp(Mutex::new(stream))
}