Struct ironoxide::IronOxide

pub struct IronOxide { /* private fields */ }

Primary SDK Object

Struct that is used to make authenticated requests to the IronCore API. Instantiated with the details of an account’s various ids, device, and signing keys. Once instantiated all operations will be performed in the context of the account provided.

Implementations

impl IronOxide

pub fn device(&self) -> &DeviceContext

DeviceContext that was used to create this SDK instance

pub fn clear_policy_cache(&self) -> usize

Clears all entries from the policy cache.

Returns the number of entries cleared from the cache.

pub async fn rotate_all(
    &self,
    rotations: &PrivateKeyRotationCheckResult,
    password: &str,
    timeout: Option<Duration>
) -> Result<(Option<UserUpdatePrivateKeyResult>, Option<Vec<GroupUpdatePrivateKeyResult>>)>

Rotate the private key of the calling user and all groups they are an administrator of where needs_rotation is true. Note that this function has the potential to take much longer than other functions, as rotation will be done individually on each user/group. If rotation is only needed for a specific group, it is strongly recommended to call user_rotate_private_key or group_rotate_private_key instead.

Arguments

• rotations - PrivateKeyRotationCheckResult that holds all users and groups to be rotated
• password - Password to unlock the current user’s user master key
• timeout - timeout for rotate_all. This is a separate timeout from the SDK-wide timeout as it is expected that this operation might take significantly longer than other operations.

Trait Implementations

impl BlindIndexSearchInitialize for IronOxide

fn create_blind_index<'life0, 'life1, 'async_trait>(
    &'life0 self,
    group_id: &'life1 GroupId
) -> Pin<Box<dyn Future<Output = Result<EncryptedBlindIndexSalt>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Create an index and encrypt it to the provided group_id.

impl Debug for IronOxide

Manual implementation of Debug without the recrypt or rng fields

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

Formats the value using the given formatter.

impl DocumentAdvancedOps for IronOxide

fn document_encrypt_unmanaged<'life0, 'life1, 'async_trait>(
    &'life0 self,
    data: Vec<u8>,
    encrypt_opts: &'life1 DocumentEncryptOpts
) -> Pin<Box<dyn Future<Output = Result<DocumentEncryptUnmanagedResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Encrypts the provided document bytes without being managed by the IronCore service.

fn document_decrypt_unmanaged<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    encrypted_data: &'life1 [u8],
    encrypted_deks: &'life2 [u8]
) -> Pin<Box<dyn Future<Output = Result<DocumentDecryptUnmanagedResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Decrypts a document not managed by the IronCore service.

impl DocumentOps for IronOxide

fn document_encrypt<'life0, 'life1, 'async_trait>(
    &'life0 self,
    document_data: Vec<u8>,
    encrypt_opts: &'life1 DocumentEncryptOpts
) -> Pin<Box<dyn Future<Output = Result<DocumentEncryptResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Encrypts the provided document bytes.

fn document_decrypt<'life0, 'life1, 'async_trait>(
    &'life0 self,
    encrypted_document: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<DocumentDecryptResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Decrypts an IronCore encrypted document.

fn document_list<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<DocumentListResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Lists metadata for all of the encrypted documents that the calling user can read or decrypt.

fn document_get_metadata<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 DocumentId
) -> Pin<Box<dyn Future<Output = Result<DocumentMetadataResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Returns the metadata for an encrypted document.

fn document_get_id_from_bytes(
    &self,
    encrypted_document: &[u8]
) -> Result<DocumentId>

Returns the document ID from the bytes of an encrypted document.

fn document_update_bytes<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 DocumentId,
    new_document_data: Vec<u8>
) -> Pin<Box<dyn Future<Output = Result<DocumentEncryptResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Updates the contents of an existing IronCore encrypted document.

fn document_update_name<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 DocumentId,
    name: Option<&'life2 DocumentName>
) -> Pin<Box<dyn Future<Output = Result<DocumentMetadataResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Modifies or removes a document’s name.

fn document_grant_access<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 DocumentId,
    grant_list: &'life2 [UserOrGroup]
) -> Pin<Box<dyn Future<Output = Result<DocumentAccessResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Grants decryption access to a document for the provided users and/or groups.

fn document_revoke_access<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 DocumentId,
    revoke_list: &'life2 [UserOrGroup]
) -> Pin<Box<dyn Future<Output = Result<DocumentAccessResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Revokes decryption access to a document for the provided users and/or groups.

impl GroupOps for IronOxide

fn group_create<'life0, 'life1, 'async_trait>(
    &'life0 self,
    opts: &'life1 GroupCreateOpts
) -> Pin<Box<dyn Future<Output = Result<GroupCreateResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Creates a group.

fn group_get_metadata<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId
) -> Pin<Box<dyn Future<Output = Result<GroupGetResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Gets the full metadata for a group.

fn group_list<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<GroupListResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Lists all of the groups that the current user is an admin or a member of.

fn group_update_name<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId,
    name: Option<&'life2 GroupName>
) -> Pin<Box<dyn Future<Output = Result<GroupMetaResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Modifies or removes a group’s name.

fn group_rotate_private_key<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId
) -> Pin<Box<dyn Future<Output = Result<GroupUpdatePrivateKeyResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Rotates a group’s private key while leaving its public key unchanged.

fn group_add_members<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId,
    grant_list: &'life2 [UserId]
) -> Pin<Box<dyn Future<Output = Result<GroupAccessEditResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Adds members to a group.

fn group_remove_members<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId,
    revoke_list: &'life2 [UserId]
) -> Pin<Box<dyn Future<Output = Result<GroupAccessEditResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Removes members from a group.

fn group_add_admins<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId,
    users: &'life2 [UserId]
) -> Pin<Box<dyn Future<Output = Result<GroupAccessEditResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Adds administrators to a group.

fn group_remove_admins<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId,
    revoke_list: &'life2 [UserId]
) -> Pin<Box<dyn Future<Output = Result<GroupAccessEditResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Removes administrators from a group.

fn group_delete<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 GroupId
) -> Pin<Box<dyn Future<Output = Result<GroupId>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Deletes a group.

impl UserOps for IronOxide

fn user_create<'life0, 'life1, 'life2, 'async_trait>(
    jwt: &'life0 Jwt,
    password: &'life1 str,
    user_create_opts: &'life2 UserCreateOpts,
    timeout: Option<Duration>
) -> Pin<Box<dyn Future<Output = Result<UserCreateResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,

Creates a user.

fn generate_new_device<'life0, 'life1, 'life2, 'async_trait>(
    jwt: &'life0 Jwt,
    password: &'life1 str,
    device_create_options: &'life2 DeviceCreateOpts,
    timeout: Option<Duration>
) -> Pin<Box<dyn Future<Output = Result<DeviceAddResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,

Generates a new device for the user specified in the JWT.

fn user_verify<'life0, 'async_trait>(
    jwt: &'life0 Jwt,
    timeout: Option<Duration>
) -> Pin<Box<dyn Future<Output = Result<Option<UserResult>>> + Send + 'async_trait>>where
    'life0: 'async_trait,

Verifies the existence of a user using a JWT to identify their user record.

fn user_list_devices<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<UserDeviceListResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Lists all of the devices for the current user.

fn user_get_public_key<'life0, 'life1, 'async_trait>(
    &'life0 self,
    users: &'life1 [UserId]
) -> Pin<Box<dyn Future<Output = Result<HashMap<UserId, PublicKey>>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Gets users’ public keys given their IDs.

fn user_rotate_private_key<'life0, 'life1, 'async_trait>(
    &'life0 self,
    password: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<UserUpdatePrivateKeyResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Rotates the current user’s private key while leaving their public key the same.

fn user_delete_device<'life0, 'life1, 'async_trait>(
    &'life0 self,
    device_id: Option<&'life1 DeviceId>
) -> Pin<Box<dyn Future<Output = Result<DeviceId>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Deletes a device.

fn user_change_password<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    current_password: &'life1 str,
    new_password: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<UserUpdateResult>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Change the password for the user