Skip to content

Fix check for whether crypt shared lib is available #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2022
Merged

Fix check for whether crypt shared lib is available #1004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d878810
Extract method for duplicated logic checking for whether mongocryptd …
jyemin Sep 28, 2022
1e48303
Fix check for whether crypt shared lib is available
jyemin Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions driver-core/src/main/com/mongodb/internal/capi/MongoCryptHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ private static BsonDocument toBsonDocument(final Map<String, Object> optionsMap)
return new BsonDocumentWrapper<>(new Document(optionsMap), new DocumentCodec());
}

public static boolean isMongocryptdSpawningDisabled(@Nullable final String cryptSharedLibVersion,
final AutoEncryptionSettings settings) {
boolean cryptSharedLibIsAvailable = cryptSharedLibVersion != null && !cryptSharedLibVersion.isEmpty();
boolean cryptSharedLibRequired = (boolean) settings.getExtraOptions().getOrDefault("cryptSharedLibRequired", false);
return settings.isBypassAutoEncryption() || settings.isBypassQueryAnalysis() || cryptSharedLibRequired || cryptSharedLibIsAvailable;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that this is all in one place but wow what a return statement!!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I wish it were simpler...

}

@SuppressWarnings("unchecked")
public static List<String> createMongocryptdSpawnArgs(final Map<String, Object> options) {
List<String> spawnArgs = new ArrayList<>();
Expand Down
27 changes: 27 additions & 0 deletions driver-core/src/test/functional/com/mongodb/internal/capi/MongoCryptHelperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,17 @@
import java.util.HashMap;
import java.util.Map;

import static com.mongodb.internal.capi.MongoCryptHelper.isMongocryptdSpawningDisabled;
import static com.mongodb.internal.capi.MongoCryptHelper.validateRewrapManyDataKeyOptions;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonList;
import static java.util.Collections.singletonMap;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class MongoCryptHelperTest {

Expand Down Expand Up @@ -104,6 +108,29 @@ public void validateRewrapManyDataKeyOptionsTest() {
assertThrows(MongoClientException.class, () -> validateRewrapManyDataKeyOptions(new RewrapManyDataKeyOptions().masterKey(new BsonDocument())));
}

@Test
public void isMongocryptdSpawningDisabledTest() {
assertTrue(isMongocryptdSpawningDisabled(null,
initializeAutoEncryptionSettingsBuilder().bypassAutoEncryption(true).build()));
assertTrue(isMongocryptdSpawningDisabled(null,
initializeAutoEncryptionSettingsBuilder().bypassQueryAnalysis(true).build()));
assertTrue(isMongocryptdSpawningDisabled(null,
initializeAutoEncryptionSettingsBuilder().extraOptions(singletonMap("cryptSharedLibRequired", true)).build()));
assertTrue(isMongocryptdSpawningDisabled("/path/to/shared/lib.so",
initializeAutoEncryptionSettingsBuilder().build()));
assertFalse(isMongocryptdSpawningDisabled(null,
initializeAutoEncryptionSettingsBuilder().build()));
assertFalse(isMongocryptdSpawningDisabled("",
initializeAutoEncryptionSettingsBuilder().build()));
}

private static AutoEncryptionSettings.Builder initializeAutoEncryptionSettingsBuilder() {
AutoEncryptionSettings.Builder builder = AutoEncryptionSettings.builder()
.keyVaultNamespace("test.vault")
.kmsProviders(singletonMap("local", singletonMap("key", new byte[96])));
return builder;
}

void assertMongoCryptOptions(final MongoCryptOptions expected, final MongoCryptOptions actual) {
assertEquals(expected.getAwsKmsProviderOptions(), actual.getAwsKmsProviderOptions(), "AwsKmsProviderOptions not equal");
assertEquals(expected.getEncryptedFieldsMap(), actual.getEncryptedFieldsMap(), "EncryptedFieldsMap not equal");
Expand Down
11 changes: 3 additions & 8 deletions ...ive-streams/src/main/com/mongodb/reactivestreams/client/internal/crypt/CommandMarker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import static com.mongodb.assertions.Assertions.assertNotNull;
import static com.mongodb.internal.capi.MongoCryptHelper.createMongocryptdClientSettings;
import static com.mongodb.internal.capi.MongoCryptHelper.createProcessBuilder;
import static com.mongodb.internal.capi.MongoCryptHelper.isMongocryptdSpawningDisabled;
import static com.mongodb.internal.capi.MongoCryptHelper.startProcess;

@SuppressWarnings("UseOfProcessBuilder")
Expand Down Expand Up @@ -62,18 +63,12 @@ class CommandMarker implements Closeable {
CommandMarker(
final MongoCrypt mongoCrypt,
final AutoEncryptionSettings settings) {
Map<String, Object> extraOptions = settings.getExtraOptions();
String cryptSharedLibVersionString = mongoCrypt.getCryptSharedLibVersionString();

boolean bypassAutoEncryption = settings.isBypassAutoEncryption();
boolean isBypassQueryAnalysis = settings.isBypassQueryAnalysis();
boolean cryptSharedIsAvailable = cryptSharedLibVersionString != null && cryptSharedLibVersionString.isEmpty();
boolean cryptSharedLibRequired = (boolean) extraOptions.getOrDefault("cryptSharedLibRequired", false);

if (bypassAutoEncryption || isBypassQueryAnalysis || cryptSharedLibRequired || cryptSharedIsAvailable) {
if (isMongocryptdSpawningDisabled(mongoCrypt.getCryptSharedLibVersionString(), settings)) {
processBuilder = null;
client = null;
} else {
Map<String, Object> extraOptions = settings.getExtraOptions();
boolean mongocryptdBypassSpawn = (boolean) extraOptions.getOrDefault("mongocryptdBypassSpawn", false);
if (!mongocryptdBypassSpawn) {
processBuilder = createProcessBuilder(extraOptions);
Expand Down
11 changes: 3 additions & 8 deletions driver-sync/src/main/com/mongodb/client/internal/CommandMarker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import static com.mongodb.assertions.Assertions.assertNotNull;
import static com.mongodb.internal.capi.MongoCryptHelper.createMongocryptdClientSettings;
import static com.mongodb.internal.capi.MongoCryptHelper.createProcessBuilder;
import static com.mongodb.internal.capi.MongoCryptHelper.isMongocryptdSpawningDisabled;
import static com.mongodb.internal.capi.MongoCryptHelper.startProcess;

@SuppressWarnings("UseOfProcessBuilder")
Expand Down Expand Up @@ -62,18 +63,12 @@ class CommandMarker implements Closeable {
CommandMarker(
final MongoCrypt mongoCrypt,
final AutoEncryptionSettings settings) {
Map<String, Object> extraOptions = settings.getExtraOptions();
String cryptSharedLibVersionString = mongoCrypt.getCryptSharedLibVersionString();

boolean bypassAutoEncryption = settings.isBypassAutoEncryption();
boolean isBypassQueryAnalysis = settings.isBypassQueryAnalysis();
boolean cryptSharedIsAvailable = cryptSharedLibVersionString != null && cryptSharedLibVersionString.isEmpty();
boolean cryptSharedLibRequired = (boolean) extraOptions.getOrDefault("cryptSharedLibRequired", false);

if (bypassAutoEncryption || isBypassQueryAnalysis || cryptSharedLibRequired || cryptSharedIsAvailable) {
if (isMongocryptdSpawningDisabled(mongoCrypt.getCryptSharedLibVersionString(), settings)) {
processBuilder = null;
client = null;
} else {
Map<String, Object> extraOptions = settings.getExtraOptions();
boolean mongocryptdBypassSpawn = (boolean) extraOptions.getOrDefault("mongocryptdBypassSpawn", false);
if (!mongocryptdBypassSpawn) {
processBuilder = createProcessBuilder(extraOptions);
Expand Down