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
//! Support for explicit encryption.
mod create_data_key;
mod encrypt;
use mongocrypt::{ctx::KmsProvider, Crypt};
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;
use crate::{
bson::{doc, spec::BinarySubtype, Binary, RawBinaryRef, RawDocumentBuf},
client::options::TlsOptions,
coll::options::CollectionOptions,
error::{Error, Result},
options::{ReadConcern, WriteConcern},
results::DeleteResult,
Client,
Collection,
Cursor,
Namespace,
};
use super::{options::KmsProviders, state_machine::CryptExecutor};
pub use crate::action::csfle::encrypt::{EncryptKey, RangeOptions};
/// A handle to the key vault. Used to create data encryption keys, and to explicitly encrypt and
/// decrypt values when auto-encryption is not an option.
pub struct ClientEncryption {
crypt: Crypt,
exec: CryptExecutor,
key_vault: Collection<RawDocumentBuf>,
}
impl ClientEncryption {
/// Initialize a new `ClientEncryption`.
///
/// ```no_run
/// # use bson::doc;
/// # use mongocrypt::ctx::KmsProvider;
/// # use mongodb::client_encryption::ClientEncryption;
/// # use mongodb::error::Result;
/// # fn func() -> Result<()> {
/// # let kv_client = todo!();
/// # let kv_namespace = todo!();
/// # let local_key = doc! { };
/// let enc = ClientEncryption::new(
/// kv_client,
/// kv_namespace,
/// [
/// (KmsProvider::Local, doc! { "key": local_key }, None),
/// (KmsProvider::Kmip, doc! { "endpoint": "localhost:5698" }, None),
/// ]
/// )?;
/// # Ok(())
/// # }
/// ```
pub fn new(
key_vault_client: Client,
key_vault_namespace: Namespace,
kms_providers: impl IntoIterator<Item = (KmsProvider, bson::Document, Option<TlsOptions>)>,
) -> Result<Self> {
let kms_providers = KmsProviders::new(kms_providers)?;
let crypt = Crypt::builder()
.kms_providers(&kms_providers.credentials_doc()?)?
.use_need_kms_credentials_state()
.use_range_v2()?
.build()?;
let exec = CryptExecutor::new_explicit(
key_vault_client.weak(),
key_vault_namespace.clone(),
kms_providers,
)?;
let key_vault = key_vault_client
.database(&key_vault_namespace.db)
.collection_with_options(
&key_vault_namespace.coll,
CollectionOptions::builder()
.write_concern(WriteConcern::majority())
.read_concern(ReadConcern::majority())
.build(),
);
Ok(ClientEncryption {
crypt,
exec,
key_vault,
})
}
// pub async fn rewrap_many_data_key(&self, _filter: Document, _opts: impl
// Into<Option<RewrapManyDataKeyOptions>>) -> Result<RewrapManyDataKeyResult> {
// todo!("RUST-1441") }
/// Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault
/// collection. Returns the result of the internal deleteOne() operation on the key vault
/// collection.
pub async fn delete_key(&self, id: &Binary) -> Result<DeleteResult> {
self.key_vault.delete_one(doc! { "_id": id }).await
}
/// Finds a single key document with the given UUID (BSON binary subtype 0x04).
/// Returns the result of the internal find() operation on the key vault collection.
pub async fn get_key(&self, id: &Binary) -> Result<Option<RawDocumentBuf>> {
self.key_vault.find_one(doc! { "_id": id }).await
}
/// Finds all documents in the key vault collection.
/// Returns the result of the internal find() operation on the key vault collection.
pub async fn get_keys(&self) -> Result<Cursor<RawDocumentBuf>> {
self.key_vault.find(doc! {}).await
}
/// Adds a keyAltName to the keyAltNames array of the key document in the key vault collection
/// with the given UUID (BSON binary subtype 0x04). Returns the previous version of the key
/// document.
pub async fn add_key_alt_name(
&self,
id: &Binary,
key_alt_name: &str,
) -> Result<Option<RawDocumentBuf>> {
self.key_vault
.find_one_and_update(
doc! { "_id": id },
doc! { "$addToSet": { "keyAltNames": key_alt_name } },
)
.await
}
/// Removes a keyAltName from the keyAltNames array of the key document in the key vault
/// collection with the given UUID (BSON binary subtype 0x04). Returns the previous version
/// of the key document.
pub async fn remove_key_alt_name(
&self,
id: &Binary,
key_alt_name: &str,
) -> Result<Option<RawDocumentBuf>> {
let update = doc! {
"$set": {
"keyAltNames": {
"$cond": [
{ "$eq": ["$keyAltNames", [key_alt_name]] },
"$$REMOVE",
{
"$filter": {
"input": "$keyAltNames",
"cond": { "$ne": ["$$this", key_alt_name] },
}
}
]
}
}
};
self.key_vault
.find_one_and_update(doc! { "_id": id }, vec![update])
.await
}
/// Returns a key document in the key vault collection with the given keyAltName.
pub async fn get_key_by_alt_name(
&self,
key_alt_name: impl AsRef<str>,
) -> Result<Option<RawDocumentBuf>> {
self.key_vault
.find_one(doc! { "keyAltNames": key_alt_name.as_ref() })
.await
}
/// Decrypts an encrypted value (BSON binary of subtype 6).
/// Returns the original BSON value.
pub async fn decrypt<'a>(&self, value: RawBinaryRef<'a>) -> Result<bson::RawBson> {
if value.subtype != BinarySubtype::Encrypted {
return Err(Error::invalid_argument(format!(
"Invalid binary subtype for decrypt: expected {:?}, got {:?}",
BinarySubtype::Encrypted,
value.subtype
)));
}
let ctx = self
.crypt
.ctx_builder()
.build_explicit_decrypt(value.bytes)?;
let result = self.exec.run_ctx(ctx, None).await?;
Ok(result
.get("v")?
.ok_or_else(|| Error::internal("invalid decryption result"))?
.to_raw_bson())
}
}
/// A KMS-specific key used to encrypt data keys.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum MasterKey {
Aws(AwsMasterKey),
Azure(AzureMasterKey),
Gcp(GcpMasterKey),
Kmip(KmipMasterKey),
Local(LocalMasterKey),
}
/// An AWS master key.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
#[builder(field_defaults(default, setter(into)))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AwsMasterKey {
/// The name for the key. The value for this field must be the same as the corresponding
/// [`KmsProvider`](mongocrypt::ctx::KmsProvider)'s name.
#[serde(skip)]
pub name: Option<String>,
/// The region.
pub region: String,
/// The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
pub key: String,
/// An alternate host identifier to send KMS requests to. May include port number. Defaults to
/// "kms.\<region\>.amazonaws.com".
pub endpoint: Option<String>,
}
impl From<AwsMasterKey> for MasterKey {
fn from(aws_master_key: AwsMasterKey) -> Self {
Self::Aws(aws_master_key)
}
}
/// An Azure master key.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
#[builder(field_defaults(default, setter(into)))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AzureMasterKey {
/// The name for the key. The value for this field must be the same as the corresponding
/// [`KmsProvider`](mongocrypt::ctx::KmsProvider)'s name.
#[serde(skip)]
pub name: Option<String>,
/// Host with optional port. Example: "example.vault.azure.net".
pub key_vault_endpoint: String,
/// The key name.
pub key_name: String,
/// A specific version of the named key, defaults to using the key's primary version.
pub key_version: Option<String>,
}
impl From<AzureMasterKey> for MasterKey {
fn from(azure_master_key: AzureMasterKey) -> Self {
Self::Azure(azure_master_key)
}
}
/// A GCP master key.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
#[builder(field_defaults(default, setter(into)))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct GcpMasterKey {
/// The name for the key. The value for this field must be the same as the corresponding
/// [`KmsProvider`](mongocrypt::ctx::KmsProvider)'s name.
#[serde(skip)]
pub name: Option<String>,
/// The project ID.
pub project_id: String,
/// The location.
pub location: String,
/// The key ring.
pub key_ring: String,
/// The key name.
pub key_name: String,
/// A specific version of the named key. Defaults to using the key's primary version.
pub key_version: Option<String>,
/// Host with optional port. Defaults to "cloudkms.googleapis.com".
pub endpoint: Option<String>,
}
impl From<GcpMasterKey> for MasterKey {
fn from(gcp_master_key: GcpMasterKey) -> Self {
Self::Gcp(gcp_master_key)
}
}
/// A local master key.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
#[builder(field_defaults(default, setter(into)))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct LocalMasterKey {
/// The name for the key. The value for this field must be the same as the corresponding
/// [`KmsProvider`](mongocrypt::ctx::KmsProvider)'s name.
#[serde(skip)]
pub name: Option<String>,
}
impl From<LocalMasterKey> for MasterKey {
fn from(local_master_key: LocalMasterKey) -> Self {
Self::Local(local_master_key)
}
}
/// A KMIP master key.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
#[builder(field_defaults(default, setter(into)))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct KmipMasterKey {
/// The name for the key. The value for this field must be the same as the corresponding
/// [`KmsProvider`](mongocrypt::ctx::KmsProvider)'s name.
#[serde(skip)]
pub name: Option<String>,
/// The KMIP Unique Identifier to a 96 byte KMIP Secret Data managed object. If this field is
/// not specified, the driver creates a random 96 byte KMIP Secret Data managed object.
pub key_id: Option<String>,
/// If true (recommended), the KMIP server must decrypt this key. Defaults to false.
pub delegated: Option<bool>,
/// Host with optional port.
pub endpoint: Option<String>,
}
impl From<KmipMasterKey> for MasterKey {
fn from(kmip_master_key: KmipMasterKey) -> Self {
Self::Kmip(kmip_master_key)
}
}
impl MasterKey {
/// Returns the `KmsProvider` associated with this key.
pub fn provider(&self) -> KmsProvider {
let (provider, name) = match self {
MasterKey::Aws(AwsMasterKey { name, .. }) => (KmsProvider::aws(), name.clone()),
MasterKey::Azure(AzureMasterKey { name, .. }) => (KmsProvider::azure(), name.clone()),
MasterKey::Gcp(GcpMasterKey { name, .. }) => (KmsProvider::gcp(), name.clone()),
MasterKey::Kmip(KmipMasterKey { name, .. }) => (KmsProvider::kmip(), name.clone()),
MasterKey::Local(LocalMasterKey { name, .. }) => (KmsProvider::local(), name.clone()),
};
if let Some(name) = name {
provider.with_name(name)
} else {
provider
}
}
}
// #[non_exhaustive]
// pub struct RewrapManyDataKeyOptions {
// pub provider: KmsProvider,
// pub master_key: Option<Document>,
// }
//
//
// #[non_exhaustive]
// pub struct RewrapManyDataKeyResult {
// pub bulk_write_result: Option<BulkWriteResult>,
// }