[−][src]Trait ironoxide::document::DocumentOps

pub trait DocumentOps {
#[must_use]    fn document_encrypt<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        document_data: &'life1 [u8], 
        encrypt_opts: &'life2 DocumentEncryptOpts
    ) -> Pin<Box<dyn Future<Output = Result<DocumentEncryptResult>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

#[must_use]    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;

#[must_use]    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;

#[must_use]    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;

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

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

#[must_use]    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;

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

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

IronOxide Document Operations

Key Terms

  • ID - The ID representing a document. It must be unique within the document's segment and will not be encrypted.
  • Name - The human-readable name of a document. It does not need to be unique and will not be encrypted.

Required methods

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

Encrypts the provided document bytes.

Returns a DocumentEncryptResult which contains document metadata as well as the encrypted_data, which is the only thing that must be passed to document_decrypt in order to decrypt the document.

Metadata about the document will be stored by IronCore, but the encrypted bytes of the document will not. To encrypt without any document information being stored by IronCore, consider using document_encrypt_unmanaged instead.

Arguments

  • document_data - Bytes of the document to encrypt
  • encrypt_opts - Document encryption parameters. Default values are provided with DocumentEncryptOpts::default().

Examples

let data = "secret data".as_bytes();
let encrypted = sdk.document_encrypt(data, &DocumentEncryptOpts::default()).await?;

#[must_use]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.

Requires the encrypted data returned from document_encrypt.

Returns details about the document as well as its decrypted bytes.

Arguments

  • encrypted_document - Bytes of the encrypted document

Errors

Fails if passed malformed data or if the calling user does not have sufficient access to the document.

Examples

let decrypted_document = sdk.document_decrypt(&encrypted_data).await?;
let decrypted_data = decrypted_document.decrypted_data();

#[must_use]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.

Examples

let document_data = sdk.document_list().await?;
let documents: Vec<DocumentListMeta> = document_data.result().to_vec();

#[must_use]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.

This will not return the encrypted document bytes, as they are not stored by IronCore.

Arguments

  • id - ID of the document to retrieve

Examples

use std::convert::TryFrom;
let document_id = DocumentId::try_from("test_document")?;
let document_meta = sdk.document_get_metadata(&document_id).await?;

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

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

This is the same ID returned by DocumentEncryptResult.id().

Arguments

  • encrypted_document - Bytes of the encrypted document

Errors

Fails if the provided bytes are not an encrypted document or have no header.

Examples

// with `bytes` returned from `document_encrypt`
let document_id = sdk.document_get_id_from_bytes(&bytes)?;

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

Updates the contents of an existing IronCore encrypted document.

The new contents will be encrypted, and which users and groups are granted access will remain unchanged.

Arguments

  • id - ID of the document to update
  • new_document_data - New document bytes to encrypt

Examples

let new_data = "more secret data".as_bytes();
let encrypted = sdk.document_update_bytes(&document_id, new_data).await?;

#[must_use]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.

Returns the updated metadata of the document.

Arguments

  • id - ID of the document to update
  • name - New name for the document. Provide a Some to update to a new name or a None to clear the name field.

Examples

use std::convert::TryFrom;
let new_name = DocumentName::try_from("updated")?;
let document_meta = sdk.document_update_name(&document_id, Some(&new_name)).await?;

#[must_use]fn document_grant_access<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    document_id: &'life1 DocumentId,
    grant_list: &'life2 Vec<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.

Returns lists of successful and failed grants.

Arguments

  • document_id - ID of the document whose access is being modified.
  • grant_list - List of users and groups to grant access to.

Errors

This operation supports partial success. If the request succeeds, then the resulting DocumentAccessResult will indicate which grants succeeded and which failed, and it will provide an explanation for each failure.

Examples

use ironoxide::document::UserOrGroup;
// from a list of UserIds, `users`
let users_or_groups: Vec<UserOrGroup> = users.iter().map(|user| user.into()).collect();
let access_result = sdk.document_grant_access(&document_id, &users_or_groups).await?;

#[must_use]fn document_revoke_access<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    document_id: &'life1 DocumentId,
    revoke_list: &'life2 Vec<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.

Returns lists of successful and failed revocations.

Arguments

  • document_id - ID of the document whose access is being modified.
  • revoke_list - List of users and groups to revoke access from.

Errors

This operation supports partial success. If the request succeeds, then the resulting DocumentAccessResult will indicate which revocations succeeded and which failed, and it will provide an explanation for each failure.

Examples

use ironoxide::document::UserOrGroup;
// from a list of UserIds, `users`
let users_or_groups: Vec<UserOrGroup> = users.iter().map(|user| user.into()).collect();
let access_result = sdk.document_revoke_access(&document_id, &users_or_groups).await?;
Loading content...

Implementors

impl DocumentOps for IronOxide[src]

Loading content...