Struct PermissionProfileConfig
pub struct PermissionProfileConfig {
pub admin: bool,
pub allowed_agents: Vec<String>,
pub config_write_paths: Vec<String>,
pub allowed_tools: Vec<String>,
pub grants: HashMap<Resource, Vec<Verb>>,
}Expand description
One named grant set ([permission_profiles.<alias>]).
Profiles are the single authorization vocabulary: OIDC profile_map
values and [users.<name>].permission_profiles both resolve here. A
profile grants exactly what it lists; everything else is denied.
Fields§
§admin: boolGrant everything. When true all other fields are irrelevant.
allowed_agents: Vec<String>Agent aliases holders of this profile may bind or address. Empty
grants NO agents; grant every agent with the explicit "*" entry.
config_write_paths: Vec<String>Dotted config path prefixes holders may write. A trailing .*
grants the subtree (e.g. channels.*); a bare path grants that
exact prop; "*" grants every path. Empty grants NO paths.
allowed_tools: Vec<String>Tool names holders may cause an agent to run. Empty grants NO
tools; broad access requires the explicit "*" entry. This selector
composes with the coarse tools = ["execute"] grant, never replaces
it: without that grant the holder’s sessions run tool-less whatever
is named here. (Note this differs from risk-profile allowed_tools,
where empty means unconstrained: permission profiles are
deny-by-default. The agent’s own risk-profile policy still applies
on top.)
grants: HashMap<Resource, Vec<Verb>>Resource-class grants: for each resource kind, the verbs
permitted. Resources: system, sessions, memory, cron,
config, agents, cost, skills, personality, logs,
tui, files, locales, quickstart, channels, providers,
models, peer_groups, plugins, tools, sops. Verbs:
create, read, update, delete, execute. An unlisted
resource is denied.
Implementations§
Source§impl PermissionProfileConfig
impl PermissionProfileConfig
Sourcepub fn configurable_prefix() -> &'static str
pub fn configurable_prefix() -> &'static str
Returns the #[prefix] value for this Configurable struct.
Sourcepub fn init_requires_explicit_config() -> bool
pub fn init_requires_explicit_config() -> bool
True when this struct has a required leaf field that a
bare/ancestor-prefix init_defaults scaffold must not
materialize (it would fill the field with its Rust
Default, which prune_empty_leaves then strips on save,
leaving a partial sub-table that fails strict reload).
Explicitly targeting this section (or a descendant of it)
still scaffolds regardless of this flag, so the section can
be materialized for the operator to fill in.
Sourcepub fn secret_fields(&self) -> Vec<SecretFieldInfo>
pub fn secret_fields(&self) -> Vec<SecretFieldInfo>
Returns metadata about all #[secret] fields on this struct and nested children.
pub fn secret_field_terminals() -> Vec<&'static str>
Sourcepub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>
pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>
Encrypt all secret fields in place using the provided store.
Sourcepub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>
pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>
Decrypt all secret fields in place using the provided store.
Sourcepub fn set_secret(&mut self, name: &str, value: String) -> Result<(), Error>
pub fn set_secret(&mut self, name: &str, value: String) -> Result<(), Error>
Set a secret field by its full dotted name, dispatching to nested children.
Sourcepub fn prop_fields(&self) -> Vec<PropFieldInfo>
pub fn prop_fields(&self) -> Vec<PropFieldInfo>
Returns metadata about all property fields on this struct and nested children.
Sourcepub fn get_prop(&self, name: &str) -> Result<String, Error>
pub fn get_prop(&self, name: &str) -> Result<String, Error>
Get a property value by its full dotted name, returning it as a display string.
Sourcepub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<(), Error>
pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<(), Error>
Set a property value by its full dotted name, parsing from string.
Sourcepub fn prop_is_secret(name: &str) -> bool
pub fn prop_is_secret(name: &str) -> bool
Check if a property name refers to a secret field (static, no instance needed).
Sourcepub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>
pub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>
Instantiate None nested sections whose prefix matches.
Returns the prefixes that were initialized.
Sourcepub fn map_key_sections() -> Vec<MapKeySection>
pub fn map_key_sections() -> Vec<MapKeySection>
Enumerate every map-keyed (HashMap<String, T>) and list-shaped
(Vec<T>) section discoverable from this Configurable’s tree.
The dashboard / CLI consume this to surface “+ Add” affordances
without hardcoding the section list.
Sourcepub fn nested_section_help(name: &str) -> Option<&'static str>
pub fn nested_section_help(name: &str) -> Option<&'static str>
Help blurb for a #[nested] field on this struct, sourced from
the field-level /// docstring. Returns None for unknown
names so callers can fall through to a different lookup.
pub fn nested_section_group(name: &str) -> Option<&'static str>
Sourcepub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>
pub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>
Return the current alias keys at section_path, or None if
the path doesn’t resolve to a map-keyed section in this tree.
pub fn nested_option_entries(&self) -> Vec<NestedOptionEntry>
pub fn create_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>
pub fn delete_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>
pub fn rename_map_key( &mut self, section_path: &str, map_key: &str, new_key: &str, ) -> Result<bool, String>
Source§impl PermissionProfileConfig
impl PermissionProfileConfig
Sourcepub fn resolve(&self) -> ResolvedGrants
pub fn resolve(&self) -> ResolvedGrants
Compile this profile into the runtime grant shape.
Trait Implementations§
Source§impl Clone for PermissionProfileConfig
impl Clone for PermissionProfileConfig
Source§fn clone(&self) -> PermissionProfileConfig
fn clone(&self) -> PermissionProfileConfig
1.0.0 (const: unstable) · §fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for PermissionProfileConfig
impl Debug for PermissionProfileConfig
Source§impl Default for PermissionProfileConfig
impl Default for PermissionProfileConfig
Source§fn default() -> PermissionProfileConfig
fn default() -> PermissionProfileConfig
Source§impl<'de> Deserialize<'de> for PermissionProfileConfigwhere
PermissionProfileConfig: Default,
impl<'de> Deserialize<'de> for PermissionProfileConfigwhere
PermissionProfileConfig: Default,
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<PermissionProfileConfig, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<PermissionProfileConfig, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl JsonSchema for PermissionProfileConfig
impl JsonSchema for PermissionProfileConfig
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl MaskSecrets for PermissionProfileConfig
impl MaskSecrets for PermissionProfileConfig
fn mask_secrets(&mut self)
fn restore_secrets_from(&mut self, current: &PermissionProfileConfig)
Source§impl Serialize for PermissionProfileConfig
impl Serialize for PermissionProfileConfig
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl Freeze for PermissionProfileConfig
impl RefUnwindSafe for PermissionProfileConfig
impl Send for PermissionProfileConfig
impl Sync for PermissionProfileConfig
impl Unpin for PermissionProfileConfig
impl UnsafeUnpin for PermissionProfileConfig
impl UnwindSafe for PermissionProfileConfig
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more