Struct ironoxide::IronOxide

pub struct IronOxide { /* fields omitted */ }

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.

Methods

impl IronOxide

pub fn device(&self) -> &DeviceContext

Get the DeviceContext instance that was used to create this SDK instance

Trait Implementations

impl DocumentAdvancedOps for IronOxide

fn document_encrypt_unmanaged(
    &self,
    data: &[u8],
    encrypt_opts: &DocumentEncryptOpts
) -> Result<DocumentEncryptUnmanagedResult>

(Advanced) Encrypt the provided document bytes. Return the encrypted document encryption keys (EDEKs) instead of creating a document entry in the IronCore webservice.

fn document_decrypt_unmanaged(
    &self,
    encrypted_data: &[u8],
    encrypted_deks: &[u8]
) -> Result<DocumentDecryptUnmanagedResult>

(Advanced) Decrypt a document not managed by the ironcore service. Both the encrypted data and the encrypted deks need to be provided.

impl DocumentOps for IronOxide

fn document_list(&self) -> Result<DocumentListResult>

List all of the documents that the current user is able to decrypt.

fn document_get_metadata(
    &self,
    id: &DocumentId
) -> Result<DocumentMetadataResult>

Get the metadata for a specific document given its ID.

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

Attempt to parse the document ID out of an encrypted document.

fn document_encrypt(
    &self,
    document_data: &[u8],
    encrypt_opts: &DocumentEncryptOpts
) -> Result<DocumentEncryptResult>

Encrypt the provided document bytes.

fn document_update_bytes(
    &self,
    id: &DocumentId,
    new_document_data: &[u8]
) -> Result<DocumentEncryptResult>

Update the encrypted content of an existing document. Persists any existing access to other users and groups.

fn document_decrypt(
    &self,
    encrypted_document: &[u8]
) -> Result<DocumentDecryptResult>

Decrypts the provided encrypted document and returns details about the document as well as its decrypted bytes.

fn document_update_name(
    &self,
    id: &DocumentId,
    name: Option<&DocumentName>
) -> Result<DocumentMetadataResult>

Update a document name to a new value or clear its value.

fn document_grant_access(
    &self,
    id: &DocumentId,
    grant_list: &Vec<UserOrGroup>
) -> Result<DocumentAccessResult>

Grant access to a document. Recipients of document access can be either users or groups.

fn document_revoke_access(
    &self,
    id: &DocumentId,
    revoke_list: &Vec<UserOrGroup>
) -> Result<DocumentAccessResult>

Revoke access from a document. Revocation of document access can be either users or groups.

impl GroupOps for IronOxide

fn group_list(&self) -> Result<GroupListResult>

List all of the groups that the current user is either an admin or member of.

fn group_create(&self, opts: &GroupCreateOpts) -> Result<GroupCreateResult>

Create a group. The creating user will become a group admin and by default a group member.

fn group_get_metadata(&self, id: &GroupId) -> Result<GroupGetResult>

Get the full metadata for a specific group given its ID.

fn group_delete(&self, id: &GroupId) -> Result<GroupId>

Delete the identified group. Group does not have to be empty of admins/members in order to delete the group. Warning: Deletion of a group will cause all documents encrypted to that group to no longer be decryptable. Caution should be used when deleting groups.

fn group_update_name(
    &self,
    id: &GroupId,
    name: Option<&GroupName>
) -> Result<GroupMetaResult>

Update a group name to a new value or clear its value.

fn group_add_members(
    &self,
    id: &GroupId,
    grant_list: &[UserId]
) -> Result<GroupAccessEditResult>

Add the users as members of a group.

fn group_remove_members(
    &self,
    id: &GroupId,
    revoke_list: &[UserId]
) -> Result<GroupAccessEditResult>

Remove a list of users as members from the group.

fn group_add_admins(
    &self,
    id: &GroupId,
    users: &[UserId]
) -> Result<GroupAccessEditResult>

Add the users as admins of a group.

fn group_remove_admins(
    &self,
    id: &GroupId,
    revoke_list: &[UserId]
) -> Result<GroupAccessEditResult>

Remove a list of users as admins from the group.

fn group_rotate_private_key(
    &self,
    id: &GroupId
) -> Result<GroupUpdatePrivateKeyResult>

Rotate the provided group's private key, but leave the public key the same. There's no black magic here! This is accomplished via multi-party computation with the IronCore webservice. Note: You must be an admin of the group in order to rotate its private key.

impl UserOps for IronOxide

fn user_create(
    jwt: &str,
    password: &str,
    user_create_opts: &UserCreateOpts
) -> Result<UserCreateResult>

Sync a new user within the IronCore system.

fn user_list_devices(&self) -> Result<UserDeviceListResult>

Get all the devices for the current user

fn generate_new_device(
    jwt: &str,
    password: &str,
    device_create_options: &DeviceCreateOpts
) -> Result<DeviceContext>

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

fn user_delete_device(&self, device_id: Option<&DeviceId>) -> Result<DeviceId>

Delete a user device.

fn user_verify(jwt: &str) -> Result<Option<UserResult>>

Verify a user given a JWT for their user record.

fn user_get_public_key(
    &self,
    users: &[UserId]
) -> Result<HashMap<UserId, PublicKey>>

Get a list of user public keys given their IDs. Allows discovery of which user IDs have keys in the IronCore system to determine of they can be added to groups or have documents shared with them.

fn user_rotate_private_key(
    &self,
    password: &str
) -> Result<UserUpdatePrivateKeyResult>

Rotate the current user's private key, but leave the public key the same. There's no black magic here! This is accomplished via multi-party computation with the IronCore webservice.