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
//! Blocking variant of IronOxide
//!
//! These synchronous functions will block the current thread to execute instead
//! of returning futures that need to be executed on a runtime. In every other way,
//! they are identical to their asynchronous counterparts.
//!
//! # Optional
//! This requires the optional `blocking` feature to be enabled.
#[doc(no_inline)]
use crate::prelude::*;
use crate::{
InitAndRotationCheck::{NoRotationNeeded, RotationNeeded},
Result,
};
use std::collections::HashMap;
#[cfg(feature = "beta")]
use crate::search::{BlindIndexSearchInitialize, EncryptedBlindIndexSalt};
/// 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. Identical to IronOxide but also contains a Runtime.
#[derive(Debug)]
pub struct BlockingIronOxide {
pub(crate) ironoxide: IronOxide,
pub(crate) runtime: tokio::runtime::Runtime,
}
impl BlockingIronOxide {
/// Get the `DeviceContext` instance that was used to create this SDK instance
pub fn device(&self) -> &DeviceContext {
&self.ironoxide.device
}
/// See [ironoxide::IronOxide::clear_policy_cache](../struct.IronOxide.html#method.clear_policy_cache)
pub fn clear_policy_cache(&self) -> usize {
self.ironoxide.clear_policy_cache()
}
/// See [ironoxide::IronOxide::create_blind_index](../struct.IronOxide.html#method.create_blind_index)
#[cfg(feature = "beta")]
pub fn create_blind_index(&self, group_id: &GroupId) -> Result<EncryptedBlindIndexSalt> {
self.runtime
.block_on(self.ironoxide.create_blind_index(group_id))
}
/// See [ironoxide::IronOxide::rotate_all](../struct.IronOxide.html#method.rotate_all)
pub fn rotate_all(
&self,
rotations: &PrivateKeyRotationCheckResult,
password: &str,
timeout: Option<std::time::Duration>,
) -> Result<(
Option<UserUpdatePrivateKeyResult>,
Option<Vec<GroupUpdatePrivateKeyResult>>,
)> {
self.runtime
.block_on(self.ironoxide.rotate_all(rotations, password, timeout))
}
/// See [ironoxide::document::DocumentOps::document_list](trait.DocumentOps.html#tymethod.document_list)
pub fn document_list(&self) -> Result<DocumentListResult> {
self.runtime.block_on(self.ironoxide.document_list())
}
/// See [ironoxide::document::DocumentOps::document_get_metadata](trait.DocumentOps.html#tymethod.document_get_metadata)
pub fn document_get_metadata(&self, id: &DocumentId) -> Result<DocumentMetadataResult> {
self.runtime
.block_on(self.ironoxide.document_get_metadata(id))
}
/// See [ironoxide::document::DocumentOps::document_get_id_from_bytes](trait.DocumentOps.html#tymethod.document_get_id_from_bytes)
pub fn document_get_id_from_bytes(&self, encrypted_document: &[u8]) -> Result<DocumentId> {
self.ironoxide
.document_get_id_from_bytes(encrypted_document)
}
/// See [ironoxide::document::DocumentOps::document_encrypt](trait.DocumentOps.html#tymethod.document_encrypt)
pub fn document_encrypt(
&self,
document_data: Vec<u8>,
encrypt_opts: &DocumentEncryptOpts,
) -> Result<DocumentEncryptResult> {
self.runtime
.block_on(self.ironoxide.document_encrypt(document_data, encrypt_opts))
}
/// See [ironoxide::document::DocumentOps::document_update_bytes](trait.DocumentOps.html#tymethod.document_update_bytes)
pub fn document_update_bytes(
&self,
id: &DocumentId,
new_document_data: Vec<u8>,
) -> Result<DocumentEncryptResult> {
self.runtime
.block_on(self.ironoxide.document_update_bytes(id, new_document_data))
}
/// See [ironoxide::document::DocumentOps::document_decrypt](trait.DocumentOps.html#tymethod.document_decrypt)
pub fn document_decrypt(&self, encrypted_document: &[u8]) -> Result<DocumentDecryptResult> {
self.runtime
.block_on(self.ironoxide.document_decrypt(encrypted_document))
}
/// See [ironoxide::document::DocumentOps::document_update_name](trait.DocumentOps.html#tymethod.document_update_name)
pub fn document_update_name(
&self,
id: &DocumentId,
name: Option<&DocumentName>,
) -> Result<DocumentMetadataResult> {
self.runtime
.block_on(self.ironoxide.document_update_name(id, name))
}
/// See [ironoxide::document::DocumentOps::document_grant_access](trait.DocumentOps.html#tymethod.document_grant_access)
pub fn document_grant_access(
&self,
id: &DocumentId,
grant_list: &Vec<UserOrGroup>,
) -> Result<DocumentAccessResult> {
self.runtime
.block_on(self.ironoxide.document_grant_access(id, grant_list))
}
/// See [ironoxide::document::DocumentOps::document_revoke_access](trait.DocumentOps.html#tymethod.document_revoke_access)
pub fn document_revoke_access(
&self,
id: &DocumentId,
revoke_list: &Vec<UserOrGroup>,
) -> Result<DocumentAccessResult> {
self.runtime
.block_on(self.ironoxide.document_revoke_access(id, revoke_list))
}
/// See [ironoxide::document::advanced::DocumentAdvancedOps::document_encrypt_unmanaged](trait.DocumentAdvancedOps.html#tymethod.document_encrypt_unmanaged)
pub fn document_encrypt_unmanaged(
&self,
data: Vec<u8>,
encrypt_opts: &DocumentEncryptOpts,
) -> Result<DocumentEncryptUnmanagedResult> {
self.runtime.block_on(
self.ironoxide
.document_encrypt_unmanaged(data, encrypt_opts),
)
}
/// See [ironoxide::document::advanced::DocumentAdvancedOps::document_decrypt_unmanaged](trait.DocumentAdvancedOps.html#tymethod.document_decrypt_unmanaged)
pub fn document_decrypt_unmanaged(
&self,
encrypted_data: &[u8],
encrypted_deks: &[u8],
) -> Result<DocumentDecryptUnmanagedResult> {
self.runtime.block_on(
self.ironoxide
.document_decrypt_unmanaged(encrypted_data, encrypted_deks),
)
}
/// See [ironoxide::group::GroupOps::group_list](trait.GroupOps.html#tymethod.group_list)
pub fn group_list(&self) -> Result<GroupListResult> {
self.runtime.block_on(self.ironoxide.group_list())
}
/// See [ironoxide::group::GroupOps::group_create](trait.GroupOps.html#tymethod.group_create)
pub fn group_create(&self, opts: &GroupCreateOpts) -> Result<GroupCreateResult> {
self.runtime.block_on(self.ironoxide.group_create(opts))
}
/// See [ironoxide::group::GroupOps::group_get_metadata](trait.GroupOps.html#tymethod.group_get_metadata)
pub fn group_get_metadata(&self, id: &GroupId) -> Result<GroupGetResult> {
self.runtime.block_on(self.ironoxide.group_get_metadata(id))
}
/// See [ironoxide::group::GroupOps::group_delete](trait.GroupOps.html#tymethod.group_delete)
pub fn group_delete(&self, id: &GroupId) -> Result<GroupId> {
self.runtime.block_on(self.ironoxide.group_delete(id))
}
/// See [ironoxide::group::GroupOps::group_update_name](trait.GroupOps.html#tymethod.group_update_name)
pub fn group_update_name(
&self,
id: &GroupId,
name: Option<&GroupName>,
) -> Result<GroupMetaResult> {
self.runtime
.block_on(self.ironoxide.group_update_name(id, name))
}
/// See [ironoxide::group::GroupOps::group_add_members](trait.GroupOps.html#tymethod.group_add_members)
pub fn group_add_members(
&self,
id: &GroupId,
grant_list: &[UserId],
) -> Result<GroupAccessEditResult> {
self.runtime
.block_on(self.ironoxide.group_add_members(id, grant_list))
}
/// See [ironoxide::group::GroupOps::group_remove_members](trait.GroupOps.html#tymethod.group_remove_members)
pub fn group_remove_members(
&self,
id: &GroupId,
revoke_list: &[UserId],
) -> Result<GroupAccessEditResult> {
self.runtime
.block_on(self.ironoxide.group_remove_members(id, revoke_list))
}
/// See [ironoxide::group::GroupOps::group_add_admins](trait.GroupOps.html#tymethod.group_add_admins)
pub fn group_add_admins(
&self,
id: &GroupId,
users: &[UserId],
) -> Result<GroupAccessEditResult> {
self.runtime
.block_on(self.ironoxide.group_add_admins(id, users))
}
/// See [ironoxide::group::GroupOps::group_remove_admins](trait.GroupOps.html#tymethod.group_remove_admins)
pub fn group_remove_admins(
&self,
id: &GroupId,
revoke_list: &[UserId],
) -> Result<GroupAccessEditResult> {
self.runtime
.block_on(self.ironoxide.group_remove_admins(id, revoke_list))
}
/// See [ironoxide::group::GroupOps::group_rotate_private_key](trait.GroupOps.html#tymethod.group_rotate_private_key)
pub fn group_rotate_private_key(&self, id: &GroupId) -> Result<GroupUpdatePrivateKeyResult> {
self.runtime
.block_on(self.ironoxide.group_rotate_private_key(id))
}
/// See [ironoxide::user::UserOps::user_create](trait.UserOps.html#tymethod.user_create)
pub fn user_create(
jwt: &Jwt,
password: &str,
user_create_opts: &UserCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<UserCreateResult> {
let rt = create_runtime();
rt.block_on(IronOxide::user_create(
jwt,
password,
user_create_opts,
timeout,
))
}
/// See [ironoxide::user::UserOps::user_list_devices](trait.UserOps.html#tymethod.user_list_devices)
pub fn user_list_devices(&self) -> Result<UserDeviceListResult> {
self.runtime.block_on(self.ironoxide.user_list_devices())
}
/// See [ironoxide::user::UserOps::generate_new_device](trait.UserOps.html#tymethod.generate_new_device)
pub fn generate_new_device(
jwt: &Jwt,
password: &str,
device_create_options: &DeviceCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<DeviceAddResult> {
let rt = create_runtime();
rt.block_on(IronOxide::generate_new_device(
jwt,
password,
device_create_options,
timeout,
))
}
/// See [ironoxide::user::UserOps::user_delete_device](trait.UserOps.html#tymethod.user_delete_device)
pub fn user_delete_device(&self, device_id: Option<&DeviceId>) -> Result<DeviceId> {
self.runtime
.block_on(self.ironoxide.user_delete_device(device_id))
}
/// See [ironoxide::user::UserOps::user_verify](trait.UserOps.html#tymethod.user_verify)
pub fn user_verify(
jwt: &Jwt,
timeout: Option<std::time::Duration>,
) -> Result<Option<UserResult>> {
let rt = create_runtime();
rt.block_on(IronOxide::user_verify(jwt, timeout))
}
/// See [ironoxide::user::UserOps::user_get_public_key](trait.UserOps.html#tymethod.user_get_public_key)
pub fn user_get_public_key(&self, users: &[UserId]) -> Result<HashMap<UserId, PublicKey>> {
self.runtime
.block_on(self.ironoxide.user_get_public_key(users))
}
/// See [ironoxide::user::UserOps::user_rotate_private_key](trait.UserOps.html#tymethod.user_rotate_private_key)
pub fn user_rotate_private_key(&self, password: &str) -> Result<UserUpdatePrivateKeyResult> {
self.runtime
.block_on(self.ironoxide.user_rotate_private_key(password))
}
/// See [ironoxide::user::UserOps::user_change_password](trait.UserOps.html#tymethod.user_change_password)
pub fn user_change_password(
&self,
current_password: &str,
new_password: &str,
) -> Result<UserUpdateResult> {
self.runtime.block_on(
self.ironoxide
.user_change_password(current_password, new_password),
)
}
}
/// Creates a tokio runtime on the current thread
fn create_runtime() -> tokio::runtime::Runtime {
tokio::runtime::Builder::new_current_thread()
.enable_all() // enable both I/O and time drivers
.build()
.expect("tokio runtime failed to initialize")
}
/// Initialize the BlockingIronOxide SDK with a device. Verifies that the provided user/segment exists and the provided device
/// keys are valid and exist for the provided account. If successful, returns instance of the BlockingIronOxide SDK.
pub fn initialize(
device_context: &DeviceContext,
config: &IronOxideConfig,
) -> Result<BlockingIronOxide> {
let rt = create_runtime();
let maybe_io = rt.block_on(crate::initialize(device_context, config));
maybe_io.map(|io| BlockingIronOxide {
ironoxide: io,
runtime: rt,
})
}
/// Initialize the BlockingIronOxide SDK and check to see if the user that owns this `DeviceContext` is
/// marked for private key rotation, or if any of the groups that the user is an admin of are marked
/// for private key rotation.
pub fn initialize_check_rotation(
device_context: &DeviceContext,
config: &IronOxideConfig,
) -> Result<InitAndRotationCheck<BlockingIronOxide>> {
let rt = create_runtime();
let maybe_init = rt.block_on(crate::initialize_check_rotation(device_context, config));
maybe_init.map(|init| match init {
NoRotationNeeded(io) => NoRotationNeeded(BlockingIronOxide {
ironoxide: io,
runtime: rt,
}),
RotationNeeded(io, rot) => RotationNeeded(
BlockingIronOxide {
ironoxide: io,
runtime: rt,
},
rot,
),
})
}