use std::{path::PathBuf, str::FromStr};
#[derive(Debug, Clone, Default)]
pub struct TlsConfig {
pub mode: TlsMode,
pub ca: Option<PathBuf>,
pub cert: Option<PathBuf>,
pub key: Option<PathBuf>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum TlsMode {
#[default]
Disable,
Require,
VerifyCA,
VerifyFull,
}
impl FromStr for TlsMode {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.trim().to_lowercase().replace('_', "-").as_str() {
"disable" | "disabled" => Ok(Self::Disable),
"require" | "required" => Ok(Self::Require),
"verify-ca" => Ok(Self::VerifyCA),
"verify-full" | "verify-identity" => Ok(Self::VerifyFull),
other @ ("prefer" | "preferred" | "allow") => Err(format!(
"unsupported TLS mode `{other}`: dbpulse does not negotiate opportunistic TLS, \
use `disable` or `require`"
)),
_ => Err(format!(
"invalid TLS mode `{s}`, expected one of: disable, require, verify-ca, verify-full \
(MySQL spellings DISABLED, REQUIRED, VERIFY_CA, VERIFY_IDENTITY are also accepted)"
)),
}
}
}
impl TlsMode {
#[must_use]
pub const fn is_enabled(&self) -> bool {
!matches!(self, Self::Disable)
}
}
#[cfg(test)]
mod tests {
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
use super::*;
#[test]
fn test_tls_mode_from_str() {
assert_eq!("disable".parse::<TlsMode>().unwrap(), TlsMode::Disable);
assert_eq!("require".parse::<TlsMode>().unwrap(), TlsMode::Require);
assert_eq!("verify-ca".parse::<TlsMode>().unwrap(), TlsMode::VerifyCA);
assert_eq!(
"verify-full".parse::<TlsMode>().unwrap(),
TlsMode::VerifyFull
);
}
#[test]
fn test_tls_mode_case_insensitive() {
assert_eq!("DISABLE".parse::<TlsMode>().unwrap(), TlsMode::Disable);
assert_eq!("Require".parse::<TlsMode>().unwrap(), TlsMode::Require);
}
#[test]
fn unknown_tls_mode_is_rejected_rather_than_downgraded() {
for input in ["verify_full_typo", "verify-al", "on", "true", "yes", ""] {
let parsed = input.parse::<TlsMode>();
assert!(
parsed.is_err(),
"`{input}` must be rejected, not silently treated as {:?}",
TlsMode::default()
);
}
}
#[test]
fn mysql_spellings_are_accepted() {
assert_eq!("DISABLED".parse::<TlsMode>().unwrap(), TlsMode::Disable);
assert_eq!("REQUIRED".parse::<TlsMode>().unwrap(), TlsMode::Require);
assert_eq!("VERIFY_CA".parse::<TlsMode>().unwrap(), TlsMode::VerifyCA);
assert_eq!(
"VERIFY_IDENTITY".parse::<TlsMode>().unwrap(),
TlsMode::VerifyFull
);
}
#[test]
fn opportunistic_modes_are_rejected_with_guidance() {
for input in ["prefer", "preferred", "allow"] {
let err = input
.parse::<TlsMode>()
.expect_err("opportunistic modes have no equivalent");
assert!(
err.contains("disable") && err.contains("require"),
"error should point at the supported modes, got: {err}"
);
}
}
#[test]
fn test_tls_mode_is_enabled() {
assert!(!TlsMode::Disable.is_enabled());
assert!(TlsMode::Require.is_enabled());
assert!(TlsMode::VerifyCA.is_enabled());
assert!(TlsMode::VerifyFull.is_enabled());
}
}