types/src/audit.rs

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use std::net::Ipv6Addr;
use std::time::{SystemTime, UNIX_EPOCH};

use chrono::NaiveDateTime;

/// The entry for one line audit log
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Entry {
    /// Timestamp
    datetime: NaiveDateTime,
    /// Where the request is from.
    ip: Ipv6Addr,
    /// Who conducts the request.
    user: String,
    /// What the user wants.
    message: String,
    /// The result for the message.
    /// true for success and false for failure
    result: bool,
}

impl Default for Entry {
    fn default() -> Self {
        let datetime = NaiveDateTime::from_timestamp_micros(0).unwrap();
        let ip = Ipv6Addr::UNSPECIFIED;
        let user = String::new();
        let message = String::new();
        let result = false;

        Self {
            datetime,
            ip,
            user,
            message,
            result,
        }
    }
}

impl Entry {
    pub fn datetime(&self) -> NaiveDateTime {
        self.datetime
    }

    pub fn ip(&self) -> Ipv6Addr {
        self.ip
    }

    pub fn user(&self) -> String {
        self.user.clone()
    }

    pub fn message(&self) -> String {
        self.message.clone()
    }

    pub fn result(&self) -> bool {
        self.result
    }
}

#[derive(Default, Clone)]
pub struct EntryBuilder {
    /// The microsecond since the UNIX epoch
    microsecond: Option<i64>,
    ip: Option<Ipv6Addr>,
    user: Option<String>,
    message: Option<String>,
    result: Option<bool>,
}

impl EntryBuilder {
    pub fn new() -> Self {
        Default::default()
    }

    pub fn microsecond(mut self, microsecond: i64) -> Self {
        self.microsecond = Some(microsecond);
        self
    }

    pub fn ip(mut self, ip: Ipv6Addr) -> Self {
        self.ip = Some(ip);
        self
    }

    pub fn user(mut self, user: String) -> Self {
        self.user = Some(user);
        self
    }

    pub fn message(mut self, message: String) -> Self {
        self.message = Some(message);
        self
    }

    pub fn result(mut self, result: bool) -> Self {
        self.result = Some(result);
        self
    }

    pub fn build(self) -> Entry {
        let datetime = self
            .microsecond
            .and_then(NaiveDateTime::from_timestamp_micros)
            .unwrap_or_else(|| {
                // The time when the build happens
                let now = SystemTime::now().duration_since(UNIX_EPOCH).unwrap();
                let microsecond = now.as_micros() as i64;
                NaiveDateTime::from_timestamp_micros(microsecond).unwrap()
            });

        Entry {
            datetime,
            ip: self.ip.unwrap_or(Ipv6Addr::UNSPECIFIED),
            user: self.user.unwrap_or_default(),
            message: self.message.unwrap_or_default(),
            result: self.result.unwrap_or(false),
        }
    }
}