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
//! User API
//!
//! See [UserOps](trait.UserOps.html) for user functions and key terms.
pub use crate::internal::user_api::{
DeviceAddResult, DeviceId, DeviceName, EncryptedPrivateKey, Jwt, JwtClaims, KeyPair,
UserCreateResult, UserDevice, UserDeviceListResult, UserId, UserResult,
UserUpdatePrivateKeyResult, UserUpdateResult,
};
use crate::{
common::{PublicKey, SdkOperation},
internal::{add_optional_timeout, user_api, OUR_REQUEST},
IronOxide, Result,
};
use async_trait::async_trait;
use recrypt::api::Recrypt;
use std::{collections::HashMap, convert::TryInto};
/// Options for device creation.
///
/// Default values are provided with [DeviceCreateOpts::default()](#method.default)
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct DeviceCreateOpts {
device_name: Option<DeviceName>,
}
impl DeviceCreateOpts {
/// # Arguments
/// - device_name
/// - `None` (default) - The device will be created with no name.
/// - `Some` - The provided name will be used as the device's name.
pub fn new(device_name: Option<DeviceName>) -> DeviceCreateOpts {
DeviceCreateOpts { device_name }
}
}
impl Default for DeviceCreateOpts {
/// Default `DeviceCreateOpts` for common use cases.
///
/// The device will be created with no name.
fn default() -> Self {
DeviceCreateOpts::new(None)
}
}
/// Options for user creation.
///
/// Default values are provided with [UserCreateOpts::default()](#method.default)
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct UserCreateOpts {
needs_rotation: bool,
}
impl UserCreateOpts {
/// # Arguments
/// - `needs_rotation` - `true` if the private key for this user marked for rotation
pub fn new(needs_rotation: bool) -> UserCreateOpts {
UserCreateOpts { needs_rotation }
}
}
impl Default for UserCreateOpts {
/// Default `UserCreateOpts` for common use cases.
///
/// The user will be created with their private key not marked for rotation.
fn default() -> Self {
UserCreateOpts::new(false)
}
}
/// IronOxide User Operations
///
/// # Key Terms
/// - Device - The only entity in the Data Control Platform that can decrypt data. A device is authorized using a user’s private key,
/// therefore a device is tightly bound to a user.
/// - ID - The ID representing a user or device. It must be unique within its segment and will **not** be encrypted.
/// - Password - The string used to encrypt and escrow a user's private key.
/// - Rotation - Changing a user's private key while leaving their public key unchanged. This can be accomplished by calling
/// [user_rotate_private_key](trait.UserOps.html#tymethod.user_rotate_private_key).
#[async_trait]
pub trait UserOps {
/// Creates a user.
///
/// # Arguments
/// - `jwt` - Valid IronCore or Auth0 JWT
/// - `password` - Password to use for encrypting and escrowing the user's private key
/// - `user_create_opts` - User creation parameters. Default values are provided with
/// [UserCreateOpts::default()](struct.UserCreateOpts.html#method.default)
/// - `timeout` - Timeout for this operation or `None` for no timeout
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let jwt_str = "";
/// let jwt = Jwt::new(jwt_str)?;
/// let password = "foobar";
/// let opts = UserCreateOpts::new(false);
/// let user_result = IronOxide::user_create(&jwt, password, &opts, None).await?;
/// # Ok(())
/// # }
/// ```
async fn user_create(
jwt: &Jwt,
password: &str,
user_create_opts: &UserCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<UserCreateResult>;
/// Generates a new device for the user specified in the JWT.
///
/// This will result in a new transform key (from the user's master private key to the new device's public key)
/// being generated and stored with the IronCore Service.
///
/// # Arguments
/// - `jwt` - Valid IronCore or Auth0 JWT
/// - `password` - Password for the user specified in the JWT
/// - `device_create_options` - Device creation parameters. Default values are provided with
/// [DeviceCreateOpts::default()](struct.DeviceCreateOpts.html#method.default)
/// - `timeout` - Timeout for this operation or `None` for no timeout
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # use std::convert::TryFrom;
/// # let jwt_str = "";
/// let jwt = Jwt::new(jwt_str)?;
/// let password = "foobar";
/// let device_name = DeviceName::try_from("primary_device")?;
/// let opts = DeviceCreateOpts::new(Some(device_name));
/// let device_result = IronOxide::generate_new_device(&jwt, password, &opts, None).await?;
/// let device_id: &DeviceId = device_result.device_id();
/// # Ok(())
/// # }
/// ```
async fn generate_new_device(
jwt: &Jwt,
password: &str,
device_create_options: &DeviceCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<DeviceAddResult>;
/// Verifies the existence of a user using a JWT to identify their user record.
///
/// Returns a `None` if the user could not be found.
///
/// # Arguments
/// - `jwt` - Valid IronCore or Auth0 JWT
/// - `timeout` - Timeout for this operation or `None` for no timeout
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let jwt_str = "";
/// let jwt = Jwt::new(jwt_str)?;
/// let verify_result = IronOxide::user_verify(&jwt, None).await?;
/// let user_id = verify_result.expect("User not found!").account_id();
/// # Ok(())
/// # }
/// ```
async fn user_verify(
jwt: &Jwt,
timeout: Option<std::time::Duration>,
) -> Result<Option<UserResult>>;
/// Lists all of the devices for the current user.
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// let devices_result = sdk.user_list_devices().await?;
/// let devices: Vec<UserDevice> = devices_result.result().to_vec();
/// # Ok(())
/// # }
/// ```
async fn user_list_devices(&self) -> Result<UserDeviceListResult>;
/// Gets users' public keys given their IDs.
///
/// Allows discovery of which user IDs have keys in the IronCore system to help determine if they can be added to groups
/// or have documents shared with them.
///
/// Only returns users whose keys were found in the IronCore system.
///
/// # Arguments
/// - `users` - List of user IDs to check
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # use std::convert::TryFrom;
/// # let sdk: IronOxide = unimplemented!();
/// let user1 = UserId::try_from("colt")?;
/// let user2 = UserId::try_from("fake_user")?;
/// let users = [user1, user2];
/// // This will only return one entry, for user "colt"
/// let get_result = sdk.user_get_public_key(&users).await?;
/// let (valid_users, invalid_users): (Vec<&UserId>, Vec<&UserId>) =
/// users.iter().partition(|u| get_result.contains_key(u));
/// # Ok(())
/// # }
/// ```
async fn user_get_public_key(&self, users: &[UserId]) -> Result<HashMap<UserId, PublicKey>>;
/// Rotates the current user's private key while leaving their public key the same.
///
/// There's no black magic here! This is accomplished via multi-party computation with the IronCore webservice.
///
/// The main use case for this is a workflow that requires that users be generated prior to the user logging in for the first time.
/// In this situation, a user's cryptographic identity can be generated by a third party, like a server process, and then
/// the user can take control of their keys by rotating their private key.
///
/// # Arguments
/// `password` - Password to unlock the current user's private key
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// let password = "foobar";
/// let rotate_result = sdk.user_rotate_private_key(password).await?;
/// # Ok(())
/// # }
/// ```
async fn user_rotate_private_key(&self, password: &str) -> Result<UserUpdatePrivateKeyResult>;
/// Deletes a device.
///
/// If deleting the currently signed-in device, the SDK will need to be
/// re-initialized with [IronOxide::initialize](../fn.initialize.html) before further use.
///
/// Returns the ID of the deleted device.
///
/// # Arguments
/// - `device_id` - ID of the device to delete. If `None`, deletes the current device
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// # let device_id: DeviceId = unimplemented!();
/// // If successful, returns the same `DeviceId` it is passed.
/// let deleted_device: DeviceId = sdk.user_delete_device(Some(&device_id)).await?;
/// # Ok(())
/// # }
/// ```
async fn user_delete_device(&self, device_id: Option<&DeviceId>) -> Result<DeviceId>;
/// Change the password for the user
///
/// This will result in the password that is being used to encrypt the user private key to be changed.
///
/// # Arguments
/// `current_password` - Password to unlock the current user's private key
/// `new_password` - New password to lock the current user's private key
///
/// # Examples
/// ```
/// # async fn run() -> Result<(), ironoxide::IronOxideErr> {
/// # use ironoxide::prelude::*;
/// # let sdk: IronOxide = unimplemented!();
/// let password = "foobar";
/// let new_password = "barbaz";
/// let change_password_result = sdk.user_change_password(password, new_password).await?;
/// # Ok(())
/// # }
/// ```
async fn user_change_password(
&self,
current_password: &str,
new_password: &str,
) -> Result<UserUpdateResult>;
}
#[async_trait]
impl UserOps for IronOxide {
async fn user_create(
jwt: &Jwt,
password: &str,
user_create_opts: &UserCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<UserCreateResult> {
let recrypt = Recrypt::new();
add_optional_timeout(
user_api::user_create(
&recrypt,
jwt,
password.try_into()?,
user_create_opts.needs_rotation,
*OUR_REQUEST,
),
timeout,
SdkOperation::UserCreate,
)
.await?
}
async fn generate_new_device(
jwt: &Jwt,
password: &str,
device_create_options: &DeviceCreateOpts,
timeout: Option<std::time::Duration>,
) -> Result<DeviceAddResult> {
let recrypt = Recrypt::new();
let device_create_options = device_create_options.clone();
add_optional_timeout(
user_api::generate_device_key(
&recrypt,
jwt,
password.try_into()?,
device_create_options.device_name,
&std::time::SystemTime::now().into(),
&OUR_REQUEST,
),
timeout,
SdkOperation::GenerateNewDevice,
)
.await?
}
async fn user_verify(
jwt: &Jwt,
timeout: Option<std::time::Duration>,
) -> Result<Option<UserResult>> {
add_optional_timeout(
user_api::user_verify(jwt, *OUR_REQUEST),
timeout,
SdkOperation::UserVerify,
)
.await?
}
async fn user_list_devices(&self) -> Result<UserDeviceListResult> {
add_optional_timeout(
user_api::device_list(self.device.auth()),
self.config.sdk_operation_timeout,
SdkOperation::UserListDevices,
)
.await?
}
async fn user_get_public_key(&self, users: &[UserId]) -> Result<HashMap<UserId, PublicKey>> {
add_optional_timeout(
user_api::user_key_list(self.device.auth(), users),
self.config.sdk_operation_timeout,
SdkOperation::UserGetPublicKey,
)
.await?
}
async fn user_rotate_private_key(&self, password: &str) -> Result<UserUpdatePrivateKeyResult> {
add_optional_timeout(
user_api::user_rotate_private_key(
&self.recrypt,
password.try_into()?,
self.device().auth(),
),
self.config.sdk_operation_timeout,
SdkOperation::UserRotatePrivateKey,
)
.await?
}
async fn user_delete_device(&self, device_id: Option<&DeviceId>) -> Result<DeviceId> {
add_optional_timeout(
user_api::device_delete(self.device.auth(), device_id),
self.config.sdk_operation_timeout,
SdkOperation::UserDeleteDevice,
)
.await?
}
async fn user_change_password(
&self,
current_password: &str,
new_password: &str,
) -> Result<UserUpdateResult> {
add_optional_timeout(
user_api::user_change_password(
current_password.try_into()?,
new_password.try_into()?,
self.device.auth(),
),
self.config.sdk_operation_timeout,
SdkOperation::UserChangePassword,
)
.await?
}
}
#[cfg(test)]
mod tests {
use super::*;
use galvanic_assert::{matchers::*, *};
#[test]
fn user_create_opts_defaults() {
let opts = UserCreateOpts::default();
assert_that!(
&opts,
has_structure!(UserCreateOpts {
needs_rotation: eq(false)
})
)
}
#[test]
fn user_create_opts_new() {
let opts = UserCreateOpts::new(true);
assert_that!(
&opts,
has_structure!(UserCreateOpts {
needs_rotation: eq(true)
})
)
}
}