Keyring

https://docs.rs/keyring/latest/keyring/
Admin
Keyring is a cross-platform Rust library for secure storage and retrieval of passwords and secrets...
Tokens:3,567
Snippets:47
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### pub fn use_sample_store(config: &HashMap<&str, &str>) -> Result<()>

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_sample_store.html

Sets the default store to the keyring-core::Sample store.

```APIDOC
## use_sample_store

### Description
Sets the default store to the `keyring-core::Sample` store. This function is available on all platforms.

### Signature
`pub fn use_sample_store(config: &HashMap<&str, &str>) -> Result<()>`

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A configuration map used to initialize the sample store.
```

--------------------------------

### pub fn use_native_store(prefer_secret_service: bool) -> Result<()>

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_native_store.html

Sets the default store to the platform’s OS-provided credential store. If the platform has no OS-provided credential store, the sample store is used. On Linux, the kernel keyutils store is used unless prefer_secret_service is true, in which case the Secret Service store is used.

```APIDOC
## Function: use_native_store

### Description
Sets the default store to the platform’s OS-provided credential store. If the platform has no OS-provided credential store, the sample store is used. On Linux (only), the kernel keyutils store is used unless `prefer_secret_service` is true, in which case the Secret Service store is used.

### Signature
`pub fn use_native_store(prefer_secret_service: bool) -> Result<()>`

### Parameters
- **prefer_secret_service** (bool) - Required - If true, forces the use of the Secret Service store on Linux instead of the kernel keyutils store.
```

--------------------------------

### pub fn store_info() -> String

Source: https://docs.rs/keyring/latest/keyring/cli/fn.store_info.html

Returns a debug description of the current default store.

```APIDOC
## store_info

### Description
Returns a debug description of the current default store.

### Signature
`pub fn store_info() -> String`
```

--------------------------------

### pub fn use_zbus_secret_service_store(config: &HashMap<&str, &str>) -> Result<()>

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_zbus_secret_service_store.html

Configures the keyring to use the dbus-based Secret Service store. This function is intended for use on Linux and *nix platforms and will return a NotSupportedByStore error on unsupported platforms.

```APIDOC
## Function: use_zbus_secret_service_store

### Description
Use the dbus-based Secret Service store via `zbus`. This function configures the credential store for the CLI.

### Signature
`pub fn use_zbus_secret_service_store(config: &HashMap<&str, &str>) -> Result<()>`

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A map containing configuration settings for the store.

### Returns
- **Result<()>** - Returns Ok(()) on success, or a `NotSupportedByStore` error if the platform is not supported.
```

--------------------------------

### Function signature for use_sample_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_sample_store.html

The function signature for setting the default store to the sample store.

```rust
pub fn use_sample_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### pub fn release_store()

Source: https://docs.rs/keyring/latest/keyring/cli/fn.release_store.html

Releases the current default store.

```APIDOC
## Function: release_store

### Description
Releases the current default store.

### Signature
`pub fn release_store()`
```

--------------------------------

### use_android_native_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_android_native_store.html

Configures the keyring to use the Android native store.

```APIDOC
## pub fn use_android_native_store(config: &HashMap<&str, &str>) -> Result<()>

### Description
Use the Android Shared Preferences store. Shared Preference data is encrypted using the Android keystore. Fails with a `NotSupportedByStore` error on other platforms.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - Configuration map for the store.
```

--------------------------------

### use_windows_native_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_windows_native_store.html

Configures the keyring to utilize the native Windows Credential store. This function is intended for use on Windows platforms and will return a NotSupportedByStore error if invoked on other operating systems.

```APIDOC
## Function: use_windows_native_store

### Signature
`pub fn use_windows_native_store(config: &HashMap<&str, &str>) -> Result<()>`

### Description
Configures the application to use the Windows Credential store for managing keys. This operation is platform-specific.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A reference to a hash map containing configuration settings.

### Returns
- **Result<()>** - Returns Ok(()) on success, or a Result containing a `NotSupportedByStore` error if the platform is not Windows.
```

--------------------------------

### use_linux_keyutils_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_linux_keyutils_store.html

Configures the keyring to use the Linux Keyutils store. This function will return an error if called on non-Linux platforms.

```APIDOC
## pub fn use_linux_keyutils_store(config: &HashMap<&str, &str>) -> Result<()>

### Description
Use the Linux Keyutils store for secret management. This function is platform-specific and will fail with a `NotSupportedByStore` error on operating systems other than Linux.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A reference to a HashMap containing configuration key-value pairs.
```

--------------------------------

### use_sqlite_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_sqlite_store.html

Configures the keyring to use a cross-platform encrypted SQLite (Turso) database.

```APIDOC
## pub fn use_sqlite_store(config: &HashMap<&str, &str>) -> Result<()> 

### Description
Use a cross-platform encrypted sqlite (Turso) database.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A configuration map containing the necessary settings for the SQLite store.
```

--------------------------------

### pub fn use_named_store(name: &str) -> Result<()>

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_named_store.html

Sets the default store to one of the known stores in its default configuration. Returns an error if the store name is unknown or if store creation fails.

```APIDOC
## use_named_store

### Description
Sets the default store to one of the known stores in its default configuration.

### Signature
`pub fn use_named_store(name: &str) -> Result<()>`

### Parameters
- **name** (&str) - Required - The name of the store to set as default.

### Errors
- Returns an `Invalid` error if the store name is not known.
- Returns any error encountered during store creation.
```

--------------------------------

### use_windows_native_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_windows_native_store.html

The function signature for configuring the Windows native store.

```rust
pub fn use_windows_native_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_linux_keyutils_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_linux_keyutils_store.html

The function signature for configuring the Linux Keyutils store. It requires a configuration map and returns a Result.

```rust
pub fn use_linux_keyutils_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_dbus_secret_service_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_dbus_secret_service_store.html

Configures the application to use the dbus-based Secret Service store. This function is intended for use on Linux and *nix platforms and will return a NotSupportedByStore error on unsupported platforms.

```APIDOC
## Function: use_dbus_secret_service_store

### Signature
`pub fn use_dbus_secret_service_store(config: &HashMap<&str, &str>) -> Result<()>`

### Description
Configures the keyring to utilize the dbus-based Secret Service store via `libdbus`. This function is specifically designed for Linux and *nix environments.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A configuration map containing settings for the Secret Service store.

### Returns
- **Result<()>** - Returns `Ok(())` on success, or a `NotSupportedByStore` error if the platform is not supported.
```

--------------------------------

### Function Signature for use_zbus_secret_service_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_zbus_secret_service_store.html

The function signature for initializing the zbus-based Secret Service store.

```rust
pub fn use_zbus_secret_service_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_apple_protected_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_apple_protected_store.html

The function signature for initializing the Apple protected store. It requires a configuration map and returns a Result.

```rust
pub fn use_apple_protected_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_apple_keychain_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_apple_keychain_store.html

Configures the keyring to use the macOS Keychain Services store.

```APIDOC
## pub fn use_apple_keychain_store(config: &HashMap<&str, &str>) -> Result<()>

### Description
Use the macOS Keychain Services store. Fails with a `NotSupportedByStore` error on other platforms.

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A configuration map containing store settings.

### Returns
- **Result<()>** - Returns Ok(()) on success, or a Result containing an error if the operation fails or is not supported on the current platform.
```

--------------------------------

### use_android_native_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_android_native_store.html

The function signature for configuring the Android native store.

```rust
pub fn use_android_native_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### Function Signature for use_dbus_secret_service_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_dbus_secret_service_store.html

The function signature for configuring the Secret Service store using a HashMap of configuration options.

```rust
pub fn use_dbus_secret_service_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_apple_keychain_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_apple_keychain_store.html

The function signature for configuring the Apple Keychain store. It requires a HashMap configuration and returns a Result.

```rust
pub fn use_apple_keychain_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### use_sqlite_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_sqlite_store.html

The function signature for configuring the sqlite store using a HashMap of configuration options.

```rust
pub fn use_sqlite_store(config: &HashMap<&str, &str>) -> Result<()>
```

--------------------------------

### store_info function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.store_info.html

The function signature for retrieving the debug description of the default store.

```rust
pub fn store_info() -> String
```

--------------------------------

### use_named_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_named_store.html

The function signature for setting the default store by name.

```rust
pub fn use_named_store(name: &str) -> Result<()>
```

--------------------------------

### release_store function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.release_store.html

The function signature for releasing the default store.

```rust
pub fn release_store()
```

--------------------------------

### use_apple_protected_store

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_apple_protected_store.html

Configures the application to use the iOS/macOS Protected Data store. Note that this function requires the application to be sandboxed and have a valid provisioning profile on macOS.

```APIDOC
## Function: use_apple_protected_store

### Description
Use the iOS/macOS Protected Data store. Note that macOS apps without a provisioning profile cannot use the protected store. The function uses the presence of the `APP_SANDBOX_CONTAINER_ID` environment variable as a proxy for checking if the app is sandboxed.

### Signature
`pub fn use_apple_protected_store(config: &HashMap<&str, &str>) -> Result<()>`

### Parameters
- **config** (&HashMap<&str, &str>) - Required - A configuration map used to initialize the store.

### Errors
- Returns `NotSupportedByStore` if called on platforms other than iOS or macOS.
- May fail if the application is sandboxed but lacks a valid provisioning profile, causing subsequent credential operations to fail.
```

--------------------------------

### Function signature for use_named_store_with_modifiers

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_named_store_with_modifiers.html

The function signature defines the required parameters for setting the default store.

```rust
pub fn use_named_store_with_modifiers(
    name: &str,
    modifiers: &HashMap<&str, &str>,
) -> Result<()>
```

--------------------------------

### use_named_store_with_modifiers

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_named_store_with_modifiers.html

Sets the default store to one of the known stores in the specified configuration. The modifiers are passed to the store builder.

```APIDOC
## pub fn use_named_store_with_modifiers(name: &str, modifiers: &HashMap<&str, &str>) -> Result<()>

### Description
Set the default store to one of the known stores in the specified configuration. The modifiers are passed to the store builder.

### Parameters
- **name** (&str) - The name of the store to use.
- **modifiers** (&HashMap<&str, &str>) - A map of modifiers passed to the store builder.

### Returns
- **Result<()>** - Returns Ok(()) on success, or an error if the store name is unknown or if store creation fails.
```

--------------------------------

### use_native_store Function Signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.use_native_store.html

The function signature for setting the default credential store to the platform's native implementation.

```rust
pub fn use_native_store(prefer_secret_service: bool) -> Result<()>
```

--------------------------------

### NAMED_STORES Constant Definition

Source: https://docs.rs/keyring/latest/keyring/cli/constant.NAMED_STORES.html

The constant is defined as an array of string slices containing 9 known credential stores.

```rust
pub const NAMED_STORES: [&str; 9];
```

--------------------------------

### internalize function signature

Source: https://docs.rs/keyring/latest/keyring/cli/fn.internalize.html

The function signature for internalizing a HashMap of strings into a HashMap of references.

```rust
pub fn internalize(
    config: Option<&HashMap<String, String>>,
) -> HashMap<&str, &str>
```
Tokens:
Raw