Skip to main content

SqlGuardDenyReason

Enum SqlGuardDenyReason 

Source
pub enum SqlGuardDenyReason {
    OperationNotAllowed {
        operation: String,
    },
    TableNotAllowed {
        table: String,
    },
    ColumnNotAllowed {
        table: String,
        column: String,
    },
    PredicateDenylisted {
        pattern: String,
    },
    MissingWhereClause {
        operation: String,
    },
    ParseError {
        error: String,
    },
    NoConfig,
    SelectStarDenied {
        table: String,
    },
}
Expand description

Structured reason for a SqlQueryGuard denial.

Every denial path in the SQL guard produces one of these variants. The guard logs the reason via tracing::warn! and returns Ok(Verdict::Deny); callers that need the reason programmatically can use SqlQueryGuard::analyze which returns the reason alongside the verdict.

Variants§

§

OperationNotAllowed

The parsed operation class is not present in the guard’s operation_allowlist (fail-closed default).

Fields

§operation: String

The parsed operation class (for example SELECT, DROP).

§

TableNotAllowed

A referenced table is not present in the guard’s table_allowlist.

Fields

§table: String

The offending table name, as parsed (case preserved for logs).

§

ColumnNotAllowed

A projected column is not present in the guard’s column_allowlist for the given table.

Fields

§table: String

The table owning the column.

§column: String

The offending column name.

§

PredicateDenylisted

The canonicalized WHERE/predicate text matched a denylist regex.

Fields

§pattern: String

The regex pattern source that matched.

§

MissingWhereClause

A mutation (UPDATE, DELETE) lacked a WHERE clause.

Fields

§operation: String

The mutation operation kind.

§

ParseError

sqlparser could not parse the query. Fail-closed.

Fields

§error: String

Human readable parser error message.

§

NoConfig

The guard config has no allowlists at all and allow_all is false. Fail-closed default: an unconfigured guard denies every query.

§

SelectStarDenied

SELECT * attempted while a column allowlist is active.

Fields

§table: String

The offending table name.

Implementations§

Source§

impl SqlGuardDenyReason

Source

pub fn code(&self) -> &'static str

Short stable tag suitable for metrics labels.

Trait Implementations§

Source§

impl Clone for SqlGuardDenyReason

Source§

fn clone(&self) -> SqlGuardDenyReason

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SqlGuardDenyReason

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for SqlGuardDenyReason

Source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for SqlGuardDenyReason

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl PartialEq for SqlGuardDenyReason

Source§

fn eq(&self, other: &SqlGuardDenyReason) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SqlGuardDenyReason

Source§

impl StructuralPartialEq for SqlGuardDenyReason

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more