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
|
# frozen_string_literal: true
# rubocop:todo all
require 'mongo'
require 'base64'
require 'spec_helper'
describe Mongo::Crypt::Handle do
require_libmongocrypt
include_context 'define shared FLE helpers'
describe '#initialize' do
let(:credentials) { Mongo::Crypt::KMS::Credentials.new(kms_providers) }
let(:kms_tls_options) { {} }
let(:handle) do
described_class.new(
credentials,
kms_tls_options,
schema_map: schema_map,
schema_map_path: schema_map_path,
bypass_query_analysis: bypass_query_analysis,
crypt_shared_lib_path: crypt_shared_lib_path,
crypt_shared_lib_required: crypt_shared_lib_required,
explicit_encryption_only: explicit_encryption_only,
)
end
let(:schema_map) do
nil
end
let(:schema_map_path) do
nil
end
let(:bypass_query_analysis) do
nil
end
let(:crypt_shared_lib_path) do
nil
end
let(:crypt_shared_lib_required) do
nil
end
let(:explicit_encryption_only) do
nil
end
shared_examples 'a functioning Mongo::Crypt::Handle' do
context 'with valid schema map' do
it 'does not raise an exception' do
expect { handle }.not_to raise_error
end
end
context 'with valid schema map in a file' do
let(:schema_map_path) do
schema_map_file_path
end
context 'without schema_map set' do
let(:schema_map) do
nil
end
it 'does not raise an exception' do
expect { handle }.not_to raise_error
end
end
context 'with schema_map set' do
it 'raises an exception' do
expect { handle }.to raise_error(ArgumentError, /Cannot set both schema_map and schema_map_path options/)
end
end
end
context 'with invalid schema map' do
let(:schema_map) { '' }
it 'raises an exception' do
expect { handle }.to raise_error(ArgumentError, /invalid schema_map; schema_map must be a Hash or nil/)
end
end
context 'with nil schema map' do
let(:schema_map) { nil }
it 'does not raise an exception' do
expect { handle }.not_to raise_error
end
end
context 'with crypt_shared_lib_path' do
min_server_version '6.0.0'
context 'with correct path' do
let(:crypt_shared_lib_path) do
SpecConfig.instance.crypt_shared_lib_path
end
it 'loads the crypt shared lib' do
expect(handle.crypt_shared_lib_version).not_to eq(0)
end
end
context 'with incorrect path' do
let(:crypt_shared_lib_path) do
'/some/bad/path/mongo_crypt_v1.so'
end
it 'raises an exception' do
expect { handle }.to raise_error(Mongo::Error::CryptError)
end
end
end
context 'with crypt_shared_lib_required' do
min_server_version '6.0.0'
context 'set to true' do
let(:crypt_shared_lib_required) do
true
end
context 'when shared lib is available' do
let(:crypt_shared_lib_path) do
SpecConfig.instance.crypt_shared_lib_path
end
it 'does not raise an exception' do
expect { handle }.not_to raise_error
end
end
context 'when shared lib is not available' do
let(:crypt_shared_lib_path) do
'/some/bad/path/mongo_crypt_v1.so'
end
it 'raises an exception' do
expect { handle }.to raise_error(Mongo::Error::CryptError)
end
end
end
end
context 'if bypass_query_analysis is true' do
min_server_version '6.0.0'
let(:bypass_query_analysis) do
true
end
it 'does not load the crypt shared lib' do
expect(Mongo::Crypt::Binding).not_to receive(:setopt_append_crypt_shared_lib_search_path)
expect(handle.crypt_shared_lib_version).to eq(0)
end
end
context 'if explicit_encryption_only is true' do
min_server_version '6.0.0'
let(:explicit_encryption_only) do
true
end
it 'does not load the crypt shared lib' do
expect(Mongo::Crypt::Binding).not_to receive(:setopt_append_crypt_shared_lib_search_path)
expect(handle.crypt_shared_lib_version).to eq(0)
end
end
end
context 'local' do
context 'with invalid local kms master key' do
let(:kms_providers) do
{
local: {
key: 'ruby' * 23 # NOT 96 bytes
}
}
end
it 'raises an exception' do
expect { handle }.to raise_error(Mongo::Error::CryptError, /local key must be 96 bytes \(libmongocrypt error code 1\)/)
end
end
context 'with valid local kms_providers' do
include_context 'with local kms_providers'
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
end
context 'AWS' do
context 'with valid AWS kms_providers' do
include_context 'with AWS kms_providers'
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
context 'with empty AWS kms_providers' do
let(:kms_providers) do
{
aws: {}
}
end
it 'instructs libmongocrypt to handle empty AWS credentials' do
expect(Mongo::Crypt::Binding).to receive(
:setopt_use_need_kms_credentials_state
).once.and_call_original
handle
end
end
end
context 'Azure' do
context 'with valid azure kms_providers' do
include_context 'with Azure kms_providers'
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
end
context 'GCP' do
context 'with valid gcp kms_providers' do
include_context 'with GCP kms_providers'
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
end
context 'GCP with PEM private key' do
require_mri
context 'with valid gcp kms_providers' do
include_context 'with GCP kms_providers'
let(:kms_providers) do
{
gcp: {
email: SpecConfig.instance.fle_gcp_email,
private_key: OpenSSL::PKey.read(
Base64.decode64(SpecConfig.instance.fle_gcp_private_key)
).export,
}
}
end
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
end
context 'KMIP' do
context 'with valid kmip kms_providers' do
include_context 'with KMIP kms_providers'
it_behaves_like 'a functioning Mongo::Crypt::Handle'
end
end
end
end
|