Struct AuthSettings 

pub struct AuthSettings { /* private fields */ }

Authentication settings view/interface over Doc data

Keys are stored by pubkey in the “keys” sub-object. Delegations are stored by root tree ID in the “delegations” sub-object. Global permission is stored in the “global” sub-object.

Implementations

impl AuthSettings

pub fn new() -> Self

Create a new empty auth settings view

pub fn as_doc(&self) -> &Doc

Get the underlying Doc for direct access

pub fn as_doc_mut(&mut self) -> &mut Doc

Get mutable access to the underlying Doc

pub fn add_key(&mut self, pubkey: &PublicKey, key: AuthKey) -> Result<()>

Add a new authentication key by pubkey (fails if key already exists)

Arguments

• pubkey - The public key
• key - The AuthKey containing permissions, status, and optional name

pub fn overwrite_key(&mut self, pubkey: &PublicKey, key: AuthKey) -> Result<()>

Explicitly overwrite an existing authentication key

pub fn get_key_by_pubkey(&self, pubkey: &PublicKey) -> Result<AuthKey>

Get a key by its public key

pub fn find_keys_by_name(&self, name: &str) -> Vec<(String, AuthKey)>

Find keys by name (may return multiple if names collide)

Returns Vec of (pubkey, AuthKey) tuples sorted by pubkey for deterministic ordering.

pub fn get_all_keys(&self) -> Result<HashMap<String, AuthKey>>

Get all authentication keys

pub fn rename_key( &mut self, pubkey: &PublicKey, name: Option<&str>, ) -> Result<()>

Rename a key by pubkey

Updates only the display name of an existing key, preserving its permissions and status.

pub fn revoke_key(&mut self, pubkey: &PublicKey) -> Result<()>

Revoke a key by pubkey

pub fn add_delegated_tree(&mut self, tree_ref: DelegatedTreeRef) -> Result<()>

Add or update a delegated tree reference

The delegation is stored by root tree ID, extracted from tree_ref.tree.root. This ensures collision-resistant storage similar to key storage by pubkey.

pub fn get_delegated_tree(&self, root_id: &ID) -> Result<DelegatedTreeRef>

Get a delegated tree reference by root tree ID

pub fn get_delegated_tree_by_str( &self, root_id: &str, ) -> Result<DelegatedTreeRef>

Get a delegated tree reference by root tree ID string

This variant accepts a string directly, useful when the ID comes from a DelegationStep.tree field which stores the root ID as a string.

pub fn get_all_delegated_trees(&self) -> Result<HashMap<ID, DelegatedTreeRef>>

Get all delegated tree references

Returns a map from root tree ID to the delegation reference.

pub fn set_global_permission(&mut self, key: AuthKey)

Set the global permission

Stores the global permission at the global path, separate from individual key entries in the keys namespace.

pub fn get_global_key(&self) -> Result<AuthKey>

Get the global permission AuthKey

Reads from the global path.

pub fn resolve_hint(&self, hint: &KeyHint) -> Result<Vec<ResolvedAuth>>

Resolve a key hint to matching authentication info

Returns Vec of ResolvedAuth. For pubkey hints, returns at most one. For name hints, may return multiple if names collide. Caller should try each until signature verifies.

Name Collision Handling

When multiple keys share the same name, all matching keys are returned. The caller (typically validate_entry) should iterate through the matches and attempt signature verification with each until one succeeds.

pub fn has_global_permission(&self) -> bool

Check if global permission exists and is active

pub fn get_global_permission(&self) -> Option<Permission>

Get global permission level if it exists and is active

pub fn global_permission_grants_access( &self, requested_permission: &Permission, ) -> bool

Check if global permission grants sufficient access

pub fn can_access( &self, pubkey: &PublicKey, requested_permission: &Permission, ) -> bool

Check if a public key can access the database with the requested permission

pub fn find_all_sigkeys_for_pubkey( &self, pubkey: &PublicKey, ) -> Vec<(SigKey, Permission)>

Find all SigKeys that a public key can use to access this database

Returns (SigKey, Permission) tuples sorted by permission (highest first)

pub fn resolve_sig_key_for_operation( &self, pubkey: &PublicKey, ) -> Result<(SigKey, Permission)>

Resolve which SigKey should be used for an operation

Returns the SigKey with highest permission for the given pubkey.

pub fn can_modify_key( &self, signing_key: &ResolvedAuth, target_pubkey: &PublicKey, ) -> Result<bool>

Check if a signing key can modify an existing target key

pub fn can_create_key( &self, signing_key: &ResolvedAuth, new_key_permissions: &Permission, ) -> Result<bool>

Check if a signing key can create a new key with the specified permissions

Trait Implementations

impl Clone for AuthSettings

fn clone(&self) -> AuthSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthSettings

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

Formats the value using the given formatter.

impl Default for AuthSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AuthSettings> for Doc

fn from(settings: AuthSettings) -> Doc

Converts to this type from the input type.

impl From<Doc> for AuthSettings

fn from(doc: Doc) -> Self

Converts to this type from the input type.

impl Serialize for AuthSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.