Compile regex when parsing config

The regexes are now compiled when the config is parsed and not each
time a new webhook is received.

Adapt tests to using parsed regex.
This commit is contained in:
finga 2021-11-18 17:47:13 +01:00
parent 83785cc77d
commit b8f114900b
4 changed files with 29 additions and 19 deletions

11
Cargo.lock generated
View file

@ -1301,6 +1301,16 @@ dependencies = [
"serde", "serde",
] ]
[[package]]
name = "serde_regex"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a8136f1a4ea815d7eac4101cfd0b16dc0cb5e1fe1b8609dfd728058656b7badf"
dependencies = [
"regex",
"serde",
]
[[package]] [[package]]
name = "serde_yaml" name = "serde_yaml"
version = "0.8.21" version = "0.8.21"
@ -1931,6 +1941,7 @@ dependencies = [
"run_script", "run_script",
"serde", "serde",
"serde_json", "serde_json",
"serde_regex",
"serde_yaml", "serde_yaml",
"sha2", "sha2",
"thiserror", "thiserror",

View file

@ -15,6 +15,7 @@ rocket = "0.5.0-rc.1"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0" serde_json = "1.0"
serde_yaml = "0.8" serde_yaml = "0.8"
serde_regex = "1.1"
regex = "1.5" regex = "1.5"
dirs = "4.0" dirs = "4.0"
anyhow = "1.0" anyhow = "1.0"

View file

@ -488,6 +488,7 @@ async fn main() -> Result<()> {
mod tests { mod tests {
use super::*; use super::*;
use crate::webhooks::{AddrType, HeaderFilter, JsonFilter}; use crate::webhooks::{AddrType, HeaderFilter, JsonFilter};
use regex::Regex;
use rocket::{ use rocket::{
http::{ContentType, Header}, http::{ContentType, Header},
local::asynchronous::Client, local::asynchronous::Client,
@ -507,7 +508,7 @@ mod tests {
secrets: vec!["valid".to_string()], secrets: vec!["valid".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "*".to_string(), pointer: "*".to_string(),
regex: "*".to_string(), regex: Regex::new(".*").unwrap(),
}), }),
}, },
); );
@ -693,7 +694,7 @@ mod tests {
secrets: vec!["valid".to_string()], secrets: vec!["valid".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "/foo".to_string(), pointer: "/foo".to_string(),
regex: "bar".to_string(), regex: Regex::new("bar").unwrap(),
}), }),
}, },
); );
@ -708,7 +709,7 @@ mod tests {
secrets: vec!["valid".to_string()], secrets: vec!["valid".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "/foo".to_string(), pointer: "/foo".to_string(),
regex: "bar".to_string(), regex: Regex::new("bar").unwrap(),
}), }),
}, },
); );
@ -723,7 +724,7 @@ mod tests {
secrets: vec!["valid".to_string()], secrets: vec!["valid".to_string()],
filter: FilterType::Not(Box::new(FilterType::JsonFilter(JsonFilter { filter: FilterType::Not(Box::new(FilterType::JsonFilter(JsonFilter {
pointer: "/foobar".to_string(), pointer: "/foobar".to_string(),
regex: "bar".to_string(), regex: Regex::new("bar").unwrap(),
}))), }))),
}, },
); );
@ -781,7 +782,7 @@ mod tests {
secrets: vec!["valid".to_string()], secrets: vec!["valid".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "/foo".to_string(), pointer: "/foo".to_string(),
regex: "bar".to_string(), regex: Regex::new("bar").unwrap(),
}), }),
}, },
); );
@ -877,7 +878,7 @@ hooks:
secrets: vec!["secret_key_01".to_string(), "secret_key_02".to_string()], secrets: vec!["secret_key_01".to_string(), "secret_key_02".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "/ref".to_string(), pointer: "/ref".to_string(),
regex: "refs/heads/master".to_string(), regex: Regex::new("refs/heads/master").unwrap(),
}), }),
} }
), ),
@ -891,11 +892,12 @@ hooks:
filter: FilterType::And(vec![ filter: FilterType::And(vec![
FilterType::JsonFilter(JsonFilter { FilterType::JsonFilter(JsonFilter {
pointer: "/ref".to_string(), pointer: "/ref".to_string(),
regex: "refs/heads/master".to_string(), regex: Regex::new("refs/heads/master").unwrap(),
}), }),
FilterType::HeaderFilter(HeaderFilter { FilterType::HeaderFilter(HeaderFilter {
field: "X-Gitea-Signature".to_string(), field: "X-Gitea-Signature".to_string(),
regex: "f6e5fe4fe37df76629112d55cc210718b6a55e7e".to_string(), regex: Regex::new("f6e5fe4fe37df76629112d55cc210718b6a55e7e")
.unwrap(),
}), }),
]), ]),
} }
@ -945,7 +947,7 @@ hooks:
secrets: vec!["secret_key_01".to_string(), "secret_key_02".to_string()], secrets: vec!["secret_key_01".to_string(), "secret_key_02".to_string()],
filter: FilterType::JsonFilter(JsonFilter { filter: FilterType::JsonFilter(JsonFilter {
pointer: "/ref".to_string(), pointer: "/ref".to_string(),
regex: "refs/heads/master".to_string(), regex: Regex::new("refs/heads/master").unwrap(),
}), }),
} }
),]) ),])

View file

@ -21,8 +21,6 @@ pub enum WebhookeyError {
Io(std::io::Error), Io(std::io::Error),
#[error("Serde Error")] #[error("Serde Error")]
Serde(serde_json::Error), Serde(serde_json::Error),
#[error("Regex Error")]
Regex(regex::Error),
} }
#[derive(Debug, Deserialize, Serialize)] #[derive(Debug, Deserialize, Serialize)]
@ -60,7 +58,8 @@ impl IpFilter {
#[derive(Debug, Deserialize, Serialize)] #[derive(Debug, Deserialize, Serialize)]
pub struct HeaderFilter { pub struct HeaderFilter {
pub field: String, pub field: String,
pub regex: String, #[serde(with = "serde_regex")]
pub regex: Regex,
} }
impl HeaderFilter { impl HeaderFilter {
@ -71,10 +70,8 @@ impl HeaderFilter {
&self.field, &self.field,
); );
let regex = Regex::new(&self.regex).map_err(WebhookeyError::Regex)?;
if let Some(value) = headers.get_one(&self.field) { if let Some(value) = headers.get_one(&self.field) {
if regex.is_match(value) { if self.regex.is_match(value) {
debug!("Regex `{}` for `{}` matches", &self.regex, &self.field); debug!("Regex `{}` for `{}` matches", &self.regex, &self.field);
return Ok(true); return Ok(true);
@ -94,7 +91,8 @@ impl HeaderFilter {
#[serde(deny_unknown_fields)] #[serde(deny_unknown_fields)]
pub struct JsonFilter { pub struct JsonFilter {
pub pointer: String, pub pointer: String,
pub regex: String, #[serde(with = "serde_regex")]
pub regex: Regex,
} }
impl JsonFilter { impl JsonFilter {
@ -105,10 +103,8 @@ impl JsonFilter {
&self.pointer, &self.pointer,
); );
let regex = Regex::new(&self.regex).map_err(WebhookeyError::Regex)?;
if let Some(value) = data.pointer(&self.pointer) { if let Some(value) = data.pointer(&self.pointer) {
if regex.is_match(&get_string(value)?) { if self.regex.is_match(&get_string(value)?) {
debug!("Regex `{}` for `{}` matches", &self.regex, &self.pointer); debug!("Regex `{}` for `{}` matches", &self.regex, &self.pointer);
return Ok(true); return Ok(true);