diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 17:39:49 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 17:39:49 +0000 |
commit | a0aa2307322cd47bbf416810ac0292925e03be87 (patch) | |
tree | 37076262a026c4b48c8a0e84f44ff9187556ca35 /rust/src/x509 | |
parent | Initial commit. (diff) | |
download | suricata-a0aa2307322cd47bbf416810ac0292925e03be87.tar.xz suricata-a0aa2307322cd47bbf416810ac0292925e03be87.zip |
Adding upstream version 1:7.0.3.upstream/1%7.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | rust/src/x509/log.rs | 40 | ||||
-rw-r--r-- | rust/src/x509/mod.rs | 153 | ||||
-rw-r--r-- | rust/src/x509/time.rs | 59 |
3 files changed, 252 insertions, 0 deletions
diff --git a/rust/src/x509/log.rs b/rust/src/x509/log.rs new file mode 100644 index 0000000..adb6464 --- /dev/null +++ b/rust/src/x509/log.rs @@ -0,0 +1,40 @@ +/* Copyright (C) 2023 Open Information Security Foundation + * + * You can copy, redistribute or modify this Program under the terms of + * the GNU General Public License version 2 as published by the Free + * Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * version 2 along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + * 02110-1301, USA. + */ + +use crate::jsonbuilder::JsonBuilder; +use crate::x509::time::format_timestamp; +use std::ffi::CStr; +use std::os::raw::c_char; + +/// Helper function to log a TLS timestamp from C to JSON with the +/// provided key. The format of the timestamp is ISO 8601 timestamp +/// with no sub-second or offset information as UTC is assumed. +/// +/// # Safety +/// +/// FFI function that dereferences pointers from C. +#[no_mangle] +pub unsafe extern "C" fn sc_x509_log_timestamp( + jb: &mut JsonBuilder, key: *const c_char, timestamp: i64, +) -> bool { + if let Ok(key) = CStr::from_ptr(key).to_str() { + if let Ok(timestamp) = format_timestamp(timestamp) { + return jb.set_string(key, ×tamp).is_ok(); + } + } + false +} diff --git a/rust/src/x509/mod.rs b/rust/src/x509/mod.rs new file mode 100644 index 0000000..c87928c --- /dev/null +++ b/rust/src/x509/mod.rs @@ -0,0 +1,153 @@ +/* Copyright (C) 2019-2020 Open Information Security Foundation + * + * You can copy, redistribute or modify this Program under the terms of + * the GNU General Public License version 2 as published by the Free + * Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * version 2 along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + * 02110-1301, USA. + */ + +//! Module for SSL/TLS X.509 certificates parser and decoder. + +// written by Pierre Chifflier <chifflier@wzdftpd.net> + +use crate::common::rust_string_to_c; +use nom7::Err; +use std; +use std::os::raw::c_char; +use x509_parser::prelude::*; +mod time; +mod log; + +#[repr(u32)] +pub enum X509DecodeError { + _Success = 0, + /// Generic decoding error + InvalidCert, + /// Some length does not match, or certificate is incomplete + InvalidLength, + InvalidVersion, + InvalidSerial, + InvalidAlgorithmIdentifier, + InvalidX509Name, + InvalidDate, + InvalidExtensions, + /// DER structure is invalid + InvalidDER, +} + +pub struct X509(X509Certificate<'static>); + +/// Attempt to parse a X.509 from input, and return a pointer to the parsed object if successful. +/// +/// # Safety +/// +/// input must be a valid buffer of at least input_len bytes +#[no_mangle] +pub unsafe extern "C" fn rs_x509_decode( + input: *const u8, + input_len: u32, + err_code: *mut u32, +) -> *mut X509 { + let slice = std::slice::from_raw_parts(input, input_len as usize); + let res = X509Certificate::from_der(slice); + match res { + Ok((_rem, cert)) => Box::into_raw(Box::new(X509(cert))), + Err(e) => { + let error = x509_parse_error_to_errcode(&e); + *err_code = error as u32; + std::ptr::null_mut() + } + } +} + +#[no_mangle] +pub unsafe extern "C" fn rs_x509_get_subject(ptr: *const X509) -> *mut c_char { + if ptr.is_null() { + return std::ptr::null_mut(); + } + let x509 = cast_pointer! {ptr, X509}; + let subject = x509.0.tbs_certificate.subject.to_string(); + rust_string_to_c(subject) +} + +#[no_mangle] +pub unsafe extern "C" fn rs_x509_get_issuer(ptr: *const X509) -> *mut c_char { + if ptr.is_null() { + return std::ptr::null_mut(); + } + let x509 = cast_pointer! {ptr, X509}; + let issuer = x509.0.tbs_certificate.issuer.to_string(); + rust_string_to_c(issuer) +} + +#[no_mangle] +pub unsafe extern "C" fn rs_x509_get_serial(ptr: *const X509) -> *mut c_char { + if ptr.is_null() { + return std::ptr::null_mut(); + } + let x509 = cast_pointer! {ptr, X509}; + let raw_serial = x509.0.tbs_certificate.raw_serial(); + let v: Vec<_> = raw_serial.iter().map(|x| format!("{:02X}", x)).collect(); + let serial = v.join(":"); + rust_string_to_c(serial) +} + +/// Extract validity from input X.509 object +/// +/// # Safety +/// +/// ptr must be a valid object obtained using `rs_x509_decode` +#[no_mangle] +pub unsafe extern "C" fn rs_x509_get_validity( + ptr: *const X509, + not_before: *mut i64, + not_after: *mut i64, +) -> i32 { + if ptr.is_null() { + return -1; + } + let x509 = &*ptr; + let n_b = x509.0.validity().not_before.timestamp(); + let n_a = x509.0.validity().not_after.timestamp(); + *not_before = n_b; + *not_after = n_a; + 0 +} + +/// Free a X.509 object allocated by Rust +/// +/// # Safety +/// +/// ptr must be a valid object obtained using `rs_x509_decode` +#[no_mangle] +pub unsafe extern "C" fn rs_x509_free(ptr: *mut X509) { + if ptr.is_null() { + return; + } + drop(Box::from_raw(ptr)); +} + +fn x509_parse_error_to_errcode(e: &Err<X509Error>) -> X509DecodeError { + match e { + Err::Incomplete(_) => X509DecodeError::InvalidLength, + Err::Error(e) | Err::Failure(e) => match e { + X509Error::InvalidVersion => X509DecodeError::InvalidVersion, + X509Error::InvalidSerial => X509DecodeError::InvalidSerial, + X509Error::InvalidAlgorithmIdentifier => X509DecodeError::InvalidAlgorithmIdentifier, + X509Error::InvalidX509Name => X509DecodeError::InvalidX509Name, + X509Error::InvalidDate => X509DecodeError::InvalidDate, + X509Error::InvalidExtensions => X509DecodeError::InvalidExtensions, + X509Error::Der(_) => X509DecodeError::InvalidDER, + _ => X509DecodeError::InvalidCert, + }, + } +} diff --git a/rust/src/x509/time.rs b/rust/src/x509/time.rs new file mode 100644 index 0000000..507b39c --- /dev/null +++ b/rust/src/x509/time.rs @@ -0,0 +1,59 @@ +/* Copyright (C) 2023 Open Information Security Foundation + * + * You can copy, redistribute or modify this Program under the terms of + * the GNU General Public License version 2 as published by the Free + * Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * version 2 along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + * 02110-1301, USA. + */ + +use std::os::raw::c_char; +use time::macros::format_description; + +/// Format a timestamp in an ISO format suitable for TLS logging. +/// +/// Negative timestamp values are used for dates prior to 1970. +pub fn format_timestamp(timestamp: i64) -> Result<String, time::error::Error> { + let format = format_description!("[year]-[month]-[day]T[hour]:[minute]:[second]"); + let ts = time::OffsetDateTime::from_unix_timestamp(timestamp)?; + let formatted = ts.format(&format)?; + Ok(formatted) +} + +/// Format a x509 ISO timestamp into the provided C buffer. +/// +/// Returns false if an error occurs, otherwise true is returned if +/// the timestamp is properly formatted into the provided buffer. +/// +/// # Safety +/// +/// Access buffers from C that are expected to be valid. +#[no_mangle] +pub unsafe extern "C" fn sc_x509_format_timestamp( + timestamp: i64, buf: *mut c_char, size: usize, +) -> bool { + let timestamp = match format_timestamp(timestamp) { + Ok(ts) => ts, + Err(_) => return false, + }; + crate::ffi::strings::copy_to_c_char(timestamp, buf, size) +} + +#[cfg(test)] +mod test { + use super::*; + + #[test] + fn test_format_timestamp() { + assert_eq!("1969-12-31T00:00:00", format_timestamp(-86400).unwrap()); + assert_eq!("2038-12-31T00:10:03", format_timestamp(2177367003).unwrap()); + } +} |