Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub agent_email: Option<String>,
    pub observability: Option<ObservabilityConfig>,
    pub is_signed: bool,
    pub raw_json: Option<Value>,
    /* private fields */
}

Fields§

§agent_email: Option<String>

Cached @hai.ai email address for this agent.

§observability: Option<ObservabilityConfig>§is_signed: bool

Whether this config was loaded from a signed JACS document.

§raw_json: Option<Value>

Raw JSON value from disk, retained for signature verification.

Implementations§

Source§

impl Config

Source

pub fn jacs_use_security(&self) -> &Option<String>

Source

pub fn jacs_data_directory(&self) -> &Option<String>

Source

pub fn jacs_key_directory(&self) -> &Option<String>

Source

pub fn jacs_agent_private_key_filename(&self) -> &Option<String>

Source

pub fn jacs_agent_public_key_filename(&self) -> &Option<String>

Source

pub fn jacs_agent_key_algorithm(&self) -> &Option<String>

Source

pub fn jacs_agent_id_and_version(&self) -> &Option<String>

Source

pub fn jacs_default_storage(&self) -> &Option<String>

Source

pub fn jacs_agent_domain(&self) -> &Option<String>

Source

pub fn jacs_dns_validate(&self) -> &Option<bool>

Source

pub fn jacs_dns_strict(&self) -> &Option<bool>

Source

pub fn jacs_dns_required(&self) -> &Option<bool>

Source

pub fn agent_email(&self) -> &Option<String>

Cached @hai.ai email address for this agent.

Source

pub fn jacs_keychain_backend(&self) -> &Option<String>

OS keychain backend: “auto”, “macos-keychain”, “linux-secret-service”, or “disabled”.

Source

pub fn jacs_database_url(&self) -> &Option<String>

Source§

impl Config

Source

pub fn builder() -> ConfigBuilder

Create a ConfigBuilder for fluent configuration.

§Example
let config = Config::builder()
    .key_algorithm("Ed25519")
    .key_directory("/custom/keys")
    .use_security(true)
    .build();
Source

pub fn new( jacs_use_security: Option<String>, jacs_data_directory: Option<String>, jacs_key_directory: Option<String>, jacs_agent_private_key_filename: Option<String>, jacs_agent_public_key_filename: Option<String>, jacs_agent_key_algorithm: Option<String>, jacs_private_key_password: Option<String>, jacs_agent_id_and_version: Option<String>, jacs_default_storage: Option<String>, ) -> Config

Create a new Config.

§Arguments
  • jacs_private_key_password - DEPRECATED: This parameter is ignored. Passwords should be set via the JACS_PRIVATE_KEY_PASSWORD environment variable only.
Source

pub fn get_key_algorithm(&self) -> Result<String, JacsError>

Source

pub fn set_key_algorithm(&mut self, algorithm: String) -> Result<(), JacsError>

Set the key algorithm in the in-memory config.

Used during cross-algorithm key rotation to update the config’s algorithm field after new keys have been generated with the overridden algorithm.

Returns an error if the algorithm is not one of the supported values: RSA-PSS, ring-Ed25519, pq2025.

Source

pub fn config_dir(&self) -> Option<&Path>

Returns the directory containing the config file, if set.

This is set automatically by Config::from_file() to the parent directory of the config file path. It is used by load_by_config to correctly calculate storage_root without requiring the caller to pass the original path or set environment variables as a side-channel.

Source

pub fn set_config_dir(&mut self, dir: Option<PathBuf>)

Sets the config directory explicitly.

Normally set automatically by Config::from_file(). Use this when constructing a Config programmatically and you need load_by_config to resolve storage paths relative to a specific directory.

Source

pub fn merge(&mut self, other: Config)

Merge another config into this one. Values from other will override values in self if they are Some.

Source

pub fn apply_env_overrides(&mut self)

Apply environment variable overrides to this config. Environment variables always take precedence (12-Factor compliance).

This method reads from the following environment variables:

  • JACS_USE_SECURITY
  • JACS_DATA_DIRECTORY
  • JACS_KEY_DIRECTORY
  • JACS_AGENT_PRIVATE_KEY_FILENAME
  • JACS_AGENT_PUBLIC_KEY_FILENAME
  • JACS_AGENT_KEY_ALGORITHM
  • JACS_AGENT_ID_AND_VERSION
  • JACS_DEFAULT_STORAGE
  • JACS_AGENT_DOMAIN
  • JACS_DNS_VALIDATE
  • JACS_DNS_STRICT
  • JACS_DNS_REQUIRED

Note: JACS_PRIVATE_KEY_PASSWORD is intentionally NOT loaded into config. It should be read directly from environment when needed for security.

Source

pub fn with_defaults() -> Self

Create a Config with only hardcoded defaults (no env var lookups). This is useful for testing or when you want explicit control.

Source

pub fn from_file(path: &str) -> Result<Config, JacsError>

Load config from a JSON file without applying environment overrides.

This is the recommended way to load a config file. For 12-Factor compliance, call config.apply_env_overrides() after loading, then Agent::from_config(config, password).

Source

pub fn verify(&self, agent: &mut Agent) -> Result<(), JacsError>

Verify this config’s signature against the given agent. Returns Ok(()) if valid, or Err if tampered or unsigned.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Config

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 Display for Config

Source§

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

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

impl Serialize for Config

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

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
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: 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> ValidateIp for T
where T: ToString,

Source§

fn validate_ipv4(&self) -> bool

Validates whether the given string is an IP V4
Source§

fn validate_ipv6(&self) -> bool

Validates whether the given string is an IP V6
Source§

fn validate_ip(&self) -> bool

Validates whether the given string is an IP
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,