use std::sync::Arc;
use gatekeep::{
AuditEntry, AuditSink, Context, Decision, DecisionAuditId, DecisionAuditOccurrence,
DecisionSummary, DecisiveClause, DenyShape, Effect, EffectKind, FactResolver,
IdentityReasonCatalog, Lattice, NoopAuditSink, NoopPolicyObserver, Policy, PolicyAnchor,
PolicyId, PolicyObserver, ReasonCatalog, evaluate, required_facts,
};
use serde::Serialize;
use time::OffsetDateTime;
use crate::{DenialResponseConfig, GatekeepAxumError, GatekeepRejection};
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Authorized<O> {
pub outcome: O,
pub decision: Decision<O>,
pub audit_occurrence: DecisionAuditOccurrence,
}
pub struct Gatekeeper<R, A = NoopAuditSink, C = IdentityReasonCatalog, W = NoopPolicyObserver> {
resolver: Arc<R>,
audit_sink: Arc<A>,
reason_catalog: Arc<C>,
observer: Arc<W>,
denial_response: DenialResponseConfig,
clock: Arc<dyn Fn() -> OffsetDateTime + Send + Sync>,
}
impl<R, A, C, W> Clone for Gatekeeper<R, A, C, W> {
fn clone(&self) -> Self {
Self {
resolver: Arc::clone(&self.resolver),
audit_sink: Arc::clone(&self.audit_sink),
reason_catalog: Arc::clone(&self.reason_catalog),
observer: Arc::clone(&self.observer),
denial_response: self.denial_response.clone(),
clock: Arc::clone(&self.clock),
}
}
}
impl<R> Gatekeeper<R> {
#[must_use]
pub fn new(resolver: R) -> Self {
Self {
resolver: Arc::new(resolver),
audit_sink: Arc::new(NoopAuditSink),
reason_catalog: Arc::new(IdentityReasonCatalog),
observer: Arc::new(NoopPolicyObserver),
denial_response: DenialResponseConfig::default(),
clock: Arc::new(OffsetDateTime::now_utc),
}
}
}
impl<R, A, C, W> Gatekeeper<R, A, C, W> {
#[must_use]
pub fn with_audit_sink<NextAudit>(
self,
audit_sink: NextAudit,
) -> Gatekeeper<R, NextAudit, C, W> {
Gatekeeper {
resolver: self.resolver,
audit_sink: Arc::new(audit_sink),
reason_catalog: self.reason_catalog,
observer: self.observer,
denial_response: self.denial_response,
clock: self.clock,
}
}
#[must_use]
pub fn with_reason_catalog<NextCatalog>(
self,
reason_catalog: NextCatalog,
) -> Gatekeeper<R, A, NextCatalog, W> {
Gatekeeper {
resolver: self.resolver,
audit_sink: self.audit_sink,
reason_catalog: Arc::new(reason_catalog),
observer: self.observer,
denial_response: self.denial_response,
clock: self.clock,
}
}
#[must_use]
pub fn with_observer<NextObserver>(
self,
observer: NextObserver,
) -> Gatekeeper<R, A, C, NextObserver> {
Gatekeeper {
resolver: self.resolver,
audit_sink: self.audit_sink,
reason_catalog: self.reason_catalog,
observer: Arc::new(observer),
denial_response: self.denial_response,
clock: self.clock,
}
}
#[must_use]
pub fn with_denial_response(mut self, denial_response: DenialResponseConfig) -> Self {
self.denial_response = denial_response;
self
}
}
impl<R, A, C, W> Gatekeeper<R, A, C, W>
where
R: FactResolver,
A: AuditSink,
C: ReasonCatalog + Send + Sync,
W: PolicyObserver,
{
pub async fn authorize<O>(
&self,
policy_id: PolicyId,
policy: &Policy<O>,
context: Context,
) -> Result<Authorized<O>, GatekeepRejection<R::Error, A::Error>>
where
O: Lattice + Serialize + Send + Sync,
{
let anchor = PolicyAnchor {
policy_id,
policy_hash: policy
.hash()
.map_err(GatekeepAxumError::PolicyHash)
.map_err(GatekeepRejection::from_error)?,
};
let required = required_facts(policy).into_iter().collect::<Vec<_>>();
let facts = self
.resolver
.resolve_for_decision(&required, &context)
.await
.map_err(GatekeepAxumError::Resolve)
.map_err(GatekeepRejection::from_error)?;
let decision = evaluate(policy, &facts);
let audit_occurrence = self
.observe_and_audit(&anchor, &decision, &context)
.await
.map_err(GatekeepRejection::from_error)?;
match decision.effect.clone() {
Effect::Permit(outcome) => Ok(Authorized {
outcome,
decision,
audit_occurrence,
}),
Effect::Deny => {
let reason = decision
.denial_reason()
.map_err(GatekeepAxumError::Trace)
.map_err(GatekeepRejection::from_error)?;
let response = self.denial_response.denied(
denial_shape(&decision),
reason.as_ref(),
&context.locale,
self.reason_catalog.as_ref(),
);
Err(response.into())
}
}
}
async fn observe_and_audit<O>(
&self,
anchor: &PolicyAnchor,
decision: &Decision<O>,
context: &Context,
) -> Result<DecisionAuditOccurrence, GatekeepAxumError<R::Error, A::Error>>
where
O: Serialize + Clone + Sync,
{
let supplied_occurrence = context.decision_audit_occurrence.clone();
let occurrence = supplied_occurrence
.map_or_else(
|| DecisionAuditOccurrence::new(DecisionAuditId::generate(), (self.clock)()),
|value| DecisionAuditOccurrence::new(value.decision_audit_id, value.occurred_at),
)
.map_err(GatekeepAxumError::Occurrence)?;
let trace = decision.to_trace().map_err(GatekeepAxumError::Trace)?;
let entry = AuditEntry {
decision_audit_id: occurrence.decision_audit_id.clone(),
occurred_at: occurrence.occurred_at,
request_id: context.request_id.clone(),
anchor: anchor.clone(),
effect: EffectKind::from(decision),
obligations: decision.obligations.clone(),
consulted: trace.consulted.clone(),
decisive: trace.decisive.clone(),
denial_reason: decision.denial_reason().map_err(GatekeepAxumError::Trace)?,
trace,
tenant: context.tenant.clone(),
principal: context.principal.clone(),
subjects: context.subjects.clone(),
locale: context.locale.clone(),
};
let summary = DecisionSummary {
anchor: anchor.clone(),
effect: EffectKind::from(decision),
obligations: decision.obligations.clone(),
consulted: decision.trace.consulted.clone(),
};
self.audit_sink
.record(&entry)
.await
.map_err(|source| GatekeepAxumError::Audit {
occurrence: occurrence.clone(),
source,
})?;
self.observer.observe(&summary);
Ok(occurrence)
}
}
const fn denial_shape<O>(decision: &Decision<O>) -> DenyShape {
match &decision.trace.decisive {
DecisiveClause::Deny { shape, .. } => *shape,
DecisiveClause::Permit { .. } => DenyShape::Forbidden,
}
}