Skip to main content

SecurityConfig

Struct SecurityConfig 

Source
pub struct SecurityConfig {
Show 20 fields pub role_definitions: Vec<RoleDefinition>, pub default_role: Option<String>, pub multi_tenant: bool, pub rls: RlsConfig, pub tenancy: TenancyConfig, pub cost_budget: Option<CostBudgetConfig>, pub default_policy: Option<String>, pub rules: Vec<AuthorizationRule>, pub policies: Vec<AuthorizationPolicy>, pub field_auth: Vec<FieldAuthRule>, pub enterprise: Option<EnterpriseSecurityConfig>, pub error_sanitization: Option<ErrorSanitizationConfig>, pub rate_limiting: Option<RateLimitingSecurityConfig>, pub state_encryption: Option<StateEncryptionConfig>, pub pkce: Option<PkceSecurityConfig>, pub api_keys: Option<ApiKeySecurityConfig>, pub token_revocation: Option<TokenRevocationSecurityConfig>, pub trusted_documents: Option<TrustedDocumentsConfig>, pub persisted_queries_only: bool, pub service_accounts: Option<HashMap<String, ServiceAccountConfig>>,
}
Expand description

Security configuration from fraiseql.toml.

Contains role definitions and other security-related settings that are compiled into schema.compiled.json.

deny_unknown_fields: this object is the seam seven security subsystems are configured through, and it used to carry a #[serde(flatten)] catch-all that seven string lookups read — so rate_limitting or token_revokation in a compiled schema landed in the catch-all, the lookup missed, and the subsystem came up silently unconfigured (#977). A typo’d key must fail the load, not disable the subsystem it names (the compiled-schema seam rule).

Fields§

§role_definitions: Vec<RoleDefinition>

Role definitions mapping role names to their granted scopes.

§default_role: Option<String>

Default role when none is specified.

§multi_tenant: bool

Whether this schema serves multiple tenants with data isolation via RLS.

Declared as [security] multi_tenant = true. A non-none tenancy.mode implies it, so this flag is only needed by deployments that separate tenants without FraiseQL’s own tenancy machinery — read CompiledSchema::is_multi_tenant, never this field, when asking whether a deployment is multi-tenant.

§rls: RlsConfig

Declaration that database Row-Level Security isolates this schema’s data.

Compiled from [security.rls]. Consumed by the boot gate: a multi-tenant schema with caching enabled and no RLS declaration refuses to start, and one that does declare RLS has the declaration verified against the live database catalog.

§tenancy: TenancyConfig

Tenancy isolation configuration for multi-tenant deployments.

When present and mode != "none", the runtime enforces tenant isolation at the database level (row-based or schema-based).

§cost_budget: Option<CostBudgetConfig>

Operation cost budgets (#379), compiled from [security.cost_budget].

per_request_max is enforced by the executor (every transport that executes a GraphQL document), not only by the HTTP handler; the per-tenant default seeds the tenant registry’s rolling windows.

§default_policy: Option<String>

Default authorization policy applied when an operation names none.

§rules: Vec<AuthorizationRule>

Custom authorization rules, compiled from [[security.rules]].

§policies: Vec<AuthorizationPolicy>

Authorization policies (RBAC/ABAC), compiled from [[security.policies]].

§field_auth: Vec<FieldAuthRule>

Field-level authorization rules, compiled from [[security.field_auth]].

§enterprise: Option<EnterpriseSecurityConfig>

Enterprise security flags, compiled from [security.enterprise].

§error_sanitization: Option<ErrorSanitizationConfig>

Error sanitization, compiled from [security.error_sanitization].

§rate_limiting: Option<RateLimitingSecurityConfig>

Rate limiting, compiled from [security.rate_limiting].

§state_encryption: Option<StateEncryptionConfig>

OAuth state / PKCE blob encryption, compiled from [security.state_encryption].

§pkce: Option<PkceSecurityConfig>

PKCE for OAuth Authorization Code flows, compiled from [security.pkce].

§api_keys: Option<ApiKeySecurityConfig>

API key authentication, compiled from [security.api_keys].

§token_revocation: Option<TokenRevocationSecurityConfig>

Token revocation, compiled from [security.token_revocation].

§trusted_documents: Option<TrustedDocumentsConfig>

Trusted documents / persisted-query allowlist, compiled from [security.trusted_documents].

§persisted_queries_only: bool

Force persisted-operations-only enforcement (#379).

When true, the runtime forces the trusted-document store into strict mode regardless of trusted_documents.mode. Requires a configured trusted-documents manifest to have any effect.

§service_accounts: Option<HashMap<String, ServiceAccountConfig>>

Machine service accounts, keyed by account name (security.service_accounts).

Implementations§

Source§

impl SecurityConfig

Source

pub fn new() -> Self

Create a new empty security configuration.

Source

pub fn add_role(&mut self, role: RoleDefinition)

Add a role definition.

Source

pub fn find_role(&self, name: &str) -> Option<&RoleDefinition>

Find a role definition by name.

Source

pub fn get_role_scopes(&self, role_name: &str) -> Vec<String>

Get all scopes granted to a role.

Source

pub fn role_has_scope(&self, role_name: &str, scope: &str) -> bool

Check if a role has a specific scope.

Trait Implementations§

Source§

impl Clone for SecurityConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecurityConfig

Source§

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

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

impl Default for SecurityConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SecurityConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for SecurityConfig

Source§

impl PartialEq for SecurityConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for SecurityConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SecurityConfig

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Checks if this value is equivalent to the given key. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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