Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ic-http-certification): add certification builder #260

Merged
merged 1 commit into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .vscode/settings.json

This file was deleted.

34 changes: 17 additions & 17 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

242 changes: 168 additions & 74 deletions packages/ic-http-certification/README.md

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions packages/ic-http-certification/src/cel/cel_builder.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use super::{
CelExpression, DefaultCertification, DefaultRequestCertification, DefaultResponseCertification,
CelExpression, DefaultCelExpression, DefaultFullCelExpression, DefaultRequestCertification,
DefaultResponseCertification, DefaultResponseOnlyCelExpression,
};
use std::borrow::Cow;

Expand All @@ -10,20 +11,20 @@ pub struct DefaultCelBuilder {}
impl DefaultCelBuilder {
/// Create a CEL expression that skips certification entirely.
pub fn skip_certification<'a>() -> CelExpression<'a> {
CelExpression::DefaultCertification(None)
CelExpression::Default(DefaultCelExpression::Skip)
}

/// Creates a builder for a CEL expression that will only certify a response.
/// Request certification will not be included with this builder.
/// See [DefaultResponseCelBuilder] for more details on this builder's interface.
/// See [DefaultResponseOnlyCelBuilder] for more details on this builder's interface.
/// See [full_certification](DefaultCelBuilder::full_certification()) for a builder that will certify both the request and response.
pub fn response_certification<'a>() -> DefaultResponseCelBuilder<'a> {
pub fn response_only_certification<'a>() -> DefaultResponseOnlyCelBuilder<'a> {
Default::default()
}

/// Creates a builder for a CEL expression that will certify both the request and response.
/// See [DefaultFullCelExpressionBuilder] for more details on this builder's interface.
/// See [response_certification](DefaultCelBuilder::response_certification()) for a builder that will only certify the response.
/// See [response_only_certification](DefaultCelBuilder::response_only_certification()) for a builder that will only certify the response.
pub fn full_certification<'a>() -> DefaultFullCelExpressionBuilder<'a> {
Default::default()
}
Expand All @@ -32,11 +33,11 @@ impl DefaultCelBuilder {
/// A CEL expression builder for creating expressions that will only certify a response.
/// To create an expression that certifies both the request and response, see [DefaultFullCelExpressionBuilder].
#[derive(Debug, Clone, Default)]
pub struct DefaultResponseCelBuilder<'a> {
pub struct DefaultResponseOnlyCelBuilder<'a> {
response_certification: DefaultResponseCertification<'a>,
}

impl<'a> DefaultResponseCelBuilder<'a> {
impl<'a> DefaultResponseOnlyCelBuilder<'a> {
/// Configure the response headers that will be included in certification.
///
/// See [DefaultResponseCertification] for details on how to configure this.
Expand All @@ -51,16 +52,15 @@ impl<'a> DefaultResponseCelBuilder<'a> {
}

/// Build the CEL expression, consuming the builder.
pub fn build(self) -> CelExpression<'a> {
CelExpression::DefaultCertification(Some(DefaultCertification {
request_certification: None,
response_certification: self.response_certification,
}))
pub fn build(self) -> DefaultResponseOnlyCelExpression<'a> {
DefaultResponseOnlyCelExpression {
response: self.response_certification,
}
}
}

/// A CEL expression builder for creating expressions that will certify both the request and response.
/// To create an expression that only certifies the response, see [DefaultResponseCelBuilder].
/// To create an expression that only certifies the response, see [DefaultResponseOnlyCelBuilder].
#[derive(Debug, Clone, Default)]
pub struct DefaultFullCelExpressionBuilder<'a> {
request_headers: &'a [&'a str],
Expand Down Expand Up @@ -103,16 +103,16 @@ impl<'a> DefaultFullCelExpressionBuilder<'a> {
}

/// Build the CEL expression, consuming the builder.
pub fn build(self) -> CelExpression<'a> {
let request_certification = Some(DefaultRequestCertification {
pub fn build(self) -> DefaultFullCelExpression<'a> {
let request_certification = DefaultRequestCertification {
headers: Cow::Borrowed(self.request_headers),
query_parameters: Cow::Borrowed(self.request_query_parameters),
});
};

CelExpression::DefaultCertification(Some(DefaultCertification {
request_certification,
response_certification: self.response_certification,
}))
DefaultFullCelExpression {
request: request_certification,
response: self.response_certification,
}
}
}

Expand All @@ -131,7 +131,7 @@ mod tests {

#[rstest]
fn no_request_response_inclusions(no_request_response_inclusions_cel: String) {
let cel_expr = DefaultCelBuilder::response_certification()
let cel_expr = DefaultCelBuilder::response_only_certification()
.with_response_certification(DefaultResponseCertification::certified_response_headers(
&[
"Cache-Control",
Expand All @@ -149,7 +149,7 @@ mod tests {

#[rstest]
fn no_request_response_exclusions(no_request_response_exclusions_cel: String) {
let cel_expr = DefaultCelBuilder::response_certification()
let cel_expr = DefaultCelBuilder::response_only_certification()
.with_response_certification(DefaultResponseCertification::response_header_exclusions(
&["Date", "Cookie", "Set-Cookie"],
))
Expand All @@ -161,16 +161,16 @@ mod tests {

#[rstest]
fn no_request_empty_response_inclusions(no_request_empty_response_inclusions_cel: String) {
let implicit_cel_expr = DefaultCelBuilder::response_certification()
let implicit_cel_expr = DefaultCelBuilder::response_only_certification()
.build()
.to_string();
let explicit_cel_expr = DefaultCelBuilder::response_certification()
let explicit_cel_expr = DefaultCelBuilder::response_only_certification()
.with_response_certification(DefaultResponseCertification::certified_response_headers(
&[],
))
.build()
.to_string();
let default_cel_expr = DefaultCelBuilder::response_certification()
let default_cel_expr = DefaultCelBuilder::response_only_certification()
.with_response_certification(DefaultResponseCertification::default())
.build()
.to_string();
Expand All @@ -182,7 +182,7 @@ mod tests {

#[rstest]
fn no_request_empty_response_exclusions(no_request_empty_response_exclusions_cel: String) {
let cel_expr = DefaultCelBuilder::response_certification()
let cel_expr = DefaultCelBuilder::response_only_certification()
.with_response_certification(DefaultResponseCertification::response_header_exclusions(
&[],
))
Expand Down
Loading