1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
//! Document API
//!
//! See [DocumentOps](trait.DocumentOps.html) for document functions and key terms.
pub use crate::internal::document_api::{
AssociationType, DocAccessEditErr, DocumentAccessResult, DocumentDecryptResult,
DocumentEncryptResult, DocumentId, DocumentListMeta, DocumentListResult,
DocumentMetadataResult, DocumentName, UserOrGroup, VisibleGroup, VisibleUser,
};
use crate::{
common::SdkOperation,
group::GroupId,
internal::{add_optional_timeout, document_api},
policy::PolicyGrant,
user::UserId,
Result,
};
use async_trait::async_trait;
use itertools::{Either, EitherOrBoth, Itertools};
pub mod advanced;
/// List of users and groups that should have access to decrypt a document.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct ExplicitGrant {
grant_to_author: bool,
grants: Vec<UserOrGroup>,
}
impl ExplicitGrant {
/// Constructs a new ExplicitGrant.
///
/// # Arguments
/// - `grant_to_author` - `true` if the calling user should have access to decrypt the document
/// - `grants` - List of users and groups that should have access to decrypt the document
pub fn new(grant_to_author: bool, grants: &[UserOrGroup]) -> ExplicitGrant {
ExplicitGrant {
grant_to_author,
grants: grants.to_vec(),
}
}
}
/// Parameters that can be provided when encrypting a new document.
///
/// Document IDs must be unique to the segment. If no ID is provided, one will be generated for it.
/// If no name is provided, the document's name will be left empty. Neither the document's ID nor name will
/// be encrypted.
///
/// Default values are provided with [DocumentEncryptOpts::default()](struct.DocumentEncryptOpts.html#method.default).
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct DocumentEncryptOpts {
id: Option<DocumentId>,
name: Option<DocumentName>,
// at least one user/group must be included either explicitly or via a policy
grants: EitherOrBoth<ExplicitGrant, PolicyGrant>,
}
impl DocumentEncryptOpts {
/// Constructs a new `DocumentEncryptOpts`.
///
/// Document encryption requires an `ExplicitGrant`, a `PolicyGrant`, or both. If only using one type
/// of grant, consider using [with_explicit_grants](./struct.DocumentEncryptOpts.html#method.with_explicit_grants)
/// or [with_policy_grants](./struct.DocumentEncryptOpts.html#method.with_policy_grants) instead.
///
/// # Arguments
/// - `id` - ID to use for the document.
/// - `name` - Name to use for the document.
/// - `grants` - Grants that control who will have access to read and decrypt this document.
pub fn new(
id: Option<DocumentId>,
name: Option<DocumentName>,
grants: EitherOrBoth<ExplicitGrant, PolicyGrant>,
) -> DocumentEncryptOpts {
DocumentEncryptOpts { grants, name, id }
}
/// Constructs a new `DocumentEncryptOpts` with access explicitly granted to certain users and groups.
///
/// # Arguments
/// - `id` - ID to use for the document.
/// - `name` - Name to use for the document.
/// - `grant_to_author` - `true` if the calling user should have access to decrypt the document
/// - `grants` - List of users and groups that should have access to read and decrypt this document
pub fn with_explicit_grants(
id: Option<DocumentId>,
name: Option<DocumentName>,
grant_to_author: bool,
grants: Vec<UserOrGroup>,
) -> DocumentEncryptOpts {
DocumentEncryptOpts {
id,
name,
grants: EitherOrBoth::Left(ExplicitGrant {
grants,
grant_to_author,
}),
}
}
/// Constructs a new `DocumentEncryptOpts` with access granted by a policy.
///
/// # Arguments
/// - `id` - ID to use for the document.
/// - `name` - Name to use for the document.
/// - `policy` - Policy to determine which users and groups will have access to read and decrypt this document.
/// See the [policy](../policy/index.html) module for more information.
pub fn with_policy_grants(
id: Option<DocumentId>,
name: Option<DocumentName>,
policy: PolicyGrant,
) -> DocumentEncryptOpts {
DocumentEncryptOpts {
id,
name,
grants: EitherOrBoth::Right(policy),
}
}
}
impl Default for DocumentEncryptOpts {
/// Constructs a `DocumentEncryptOpts` with common values.
///
/// The document will have a generated ID and no name. Only the document's author will be able to
/// read and decrypt it.
fn default() -> Self {
DocumentEncryptOpts::with_explicit_grants(None, None, true, vec![])
}
}
/// 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.
#[async_trait]
pub trait DocumentOps {
/// 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](trait.DocumentOps.html#tymethod.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](advanced/trait.DocumentAdvancedOps.html#tymethod.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()](struct.DocumentEncryptOpts.html#method.default).
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # use ironoxide::document::DocumentEncryptOpts;
/// let data = "secret data".to_string().into_bytes();
/// let encrypted = sdk.document_encrypt(data, &DocumentEncryptOpts::default()).await?;
/// # Ok(())
/// # }
/// ```
async fn document_encrypt(
&self,
document_data: Vec<u8>,
encrypt_opts: &DocumentEncryptOpts,
) -> Result<DocumentEncryptResult>;
/// Decrypts an IronCore encrypted document.
///
/// Requires the encrypted data returned from [document_encrypt](trait.DocumentOps.html#tymethod.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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let encrypted_data: Vec<u8> = vec![];
/// let decrypted_document = sdk.document_decrypt(&encrypted_data).await?;
/// let decrypted_data = decrypted_document.decrypted_data();
/// # Ok(())
/// # }
/// ```
async fn document_decrypt(&self, encrypted_document: &[u8]) -> Result<DocumentDecryptResult>;
/// Lists metadata for all of the encrypted documents that the calling user can read or decrypt.
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # use ironoxide::document::DocumentListMeta;
/// # let sdk: IronOxide = unimplemented!();
/// let document_data = sdk.document_list().await?;
/// let documents: Vec<DocumentListMeta> = document_data.result().to_vec();
/// # Ok(())
/// # }
async fn document_list(&self) -> Result<DocumentListResult>;
/// 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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// use std::convert::TryFrom;
/// let document_id = DocumentId::try_from("test_document")?;
/// let document_meta = sdk.document_get_metadata(&document_id).await?;
/// # Ok(())
/// # }
/// ```
async fn document_get_metadata(&self, id: &DocumentId) -> Result<DocumentMetadataResult>;
/// 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
/// ```
/// # fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let bytes: Vec<u8> = vec![];
/// // with `bytes` returned from `document_encrypt`
/// let document_id = sdk.document_get_id_from_bytes(&bytes)?;
/// # Ok(())
/// # }
/// ```
fn document_get_id_from_bytes(&self, encrypted_document: &[u8]) -> Result<DocumentId>;
/// 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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let document_id: DocumentId = unimplemented!();
/// let new_data = "more secret data".to_string().into_bytes();
/// let encrypted = sdk.document_update_bytes(&document_id, new_data).await?;
/// # Ok(())
/// # }
/// ```
async fn document_update_bytes(
&self,
id: &DocumentId,
new_document_data: Vec<u8>,
) -> Result<DocumentEncryptResult>;
/// 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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let document_id: DocumentId = unimplemented!();
/// use std::convert::TryFrom;
/// let new_name = DocumentName::try_from("updated")?;
/// let document_meta = sdk.document_update_name(&document_id, Some(&new_name)).await?;
/// # Ok(())
/// # }
/// ```
async fn document_update_name(
&self,
id: &DocumentId,
name: Option<&DocumentName>,
) -> Result<DocumentMetadataResult>;
/// 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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let document_id: DocumentId = unimplemented!();
/// # let users: Vec<UserId> = vec![];
/// 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?;
/// # Ok(())
/// # }
/// ```
async fn document_grant_access(
&self,
document_id: &DocumentId,
grant_list: &[UserOrGroup],
) -> Result<DocumentAccessResult>;
/// 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
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let document_id: DocumentId = unimplemented!();
/// # let users: Vec<UserId> = vec![];
/// 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?;
/// # Ok(())
/// # }
/// ```
async fn document_revoke_access(
&self,
document_id: &DocumentId,
revoke_list: &[UserOrGroup],
) -> Result<DocumentAccessResult>;
}
#[async_trait]
impl DocumentOps for crate::IronOxide {
async fn document_encrypt(
&self,
document_data: Vec<u8>,
encrypt_opts: &DocumentEncryptOpts,
) -> Result<DocumentEncryptResult> {
let encrypt_opts = encrypt_opts.clone();
let (explicit_users, explicit_groups, grant_to_author, policy_grants) =
match encrypt_opts.grants {
EitherOrBoth::Left(explicit_grants) => {
let (users, groups) = partition_user_or_group(&explicit_grants.grants);
(users, groups, explicit_grants.grant_to_author, None)
}
EitherOrBoth::Right(policy_grant) => (vec![], vec![], false, Some(policy_grant)),
EitherOrBoth::Both(explicit_grants, policy_grant) => {
let (users, groups) = partition_user_or_group(&explicit_grants.grants);
(
users,
groups,
explicit_grants.grant_to_author,
Some(policy_grant),
)
}
};
add_optional_timeout(
document_api::encrypt_document(
self.device.auth(),
&self.config,
&self.recrypt,
&self.user_master_pub_key,
&self.rng,
document_data,
encrypt_opts.id,
encrypt_opts.name,
grant_to_author,
&explicit_users,
&explicit_groups,
policy_grants.as_ref(),
&self.policy_eval_cache,
),
self.config.sdk_operation_timeout,
SdkOperation::DocumentEncrypt,
)
.await?
}
async fn document_decrypt(&self, encrypted_document: &[u8]) -> Result<DocumentDecryptResult> {
add_optional_timeout(
document_api::decrypt_document(
self.device.auth(),
self.recrypt.clone(),
self.device.device_private_key(),
encrypted_document,
),
self.config.sdk_operation_timeout,
SdkOperation::DocumentDecrypt,
)
.await?
}
async fn document_list(&self) -> Result<DocumentListResult> {
add_optional_timeout(
document_api::document_list(self.device.auth()),
self.config.sdk_operation_timeout,
SdkOperation::DocumentList,
)
.await?
}
async fn document_get_metadata(&self, id: &DocumentId) -> Result<DocumentMetadataResult> {
add_optional_timeout(
document_api::document_get_metadata(self.device.auth(), id),
self.config.sdk_operation_timeout,
SdkOperation::DocumentGetMetadata,
)
.await?
}
fn document_get_id_from_bytes(&self, encrypted_document: &[u8]) -> Result<DocumentId> {
document_api::get_id_from_bytes(encrypted_document)
}
async fn document_update_bytes(
&self,
id: &DocumentId,
new_document_data: Vec<u8>,
) -> Result<DocumentEncryptResult> {
add_optional_timeout(
document_api::document_update_bytes(
self.device.auth(),
&self.recrypt,
self.device.device_private_key(),
&self.rng,
id,
new_document_data,
),
self.config.sdk_operation_timeout,
SdkOperation::DocumentUpdateBytes,
)
.await?
}
async fn document_update_name(
&self,
id: &DocumentId,
name: Option<&DocumentName>,
) -> Result<DocumentMetadataResult> {
add_optional_timeout(
document_api::update_document_name(self.device.auth(), id, name),
self.config.sdk_operation_timeout,
SdkOperation::DocumentUpdateName,
)
.await?
}
async fn document_grant_access(
&self,
id: &DocumentId,
grant_list: &[UserOrGroup],
) -> Result<DocumentAccessResult> {
let (users, groups) = partition_user_or_group(grant_list);
add_optional_timeout(
document_api::document_grant_access(
self.device.auth(),
&self.recrypt,
id,
&self.user_master_pub_key,
self.device.device_private_key(),
&users,
&groups,
),
self.config.sdk_operation_timeout,
SdkOperation::DocumentGrantAccess,
)
.await?
}
async fn document_revoke_access(
&self,
id: &DocumentId,
revoke_list: &[UserOrGroup],
) -> Result<DocumentAccessResult> {
add_optional_timeout(
document_api::document_revoke_access(self.device.auth(), id, revoke_list),
self.config.sdk_operation_timeout,
SdkOperation::DocumentRevokeAccess,
)
.await?
}
}
fn partition_user_or_group(uog_slice: &[UserOrGroup]) -> (Vec<UserId>, Vec<GroupId>) {
uog_slice
.iter()
.partition_map(|access_grant| match access_grant {
UserOrGroup::User { id } => Either::Left(id.clone()),
UserOrGroup::Group { id } => Either::Right(id.clone()),
})
}