Skip to content

CSHARP-6206: KMS master key exposure via unredacted credential serialization in driver settings string (port to main branch) #2113

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

Open
papafe wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −2
Open

CSHARP-6206: KMS master key exposure via unredacted credential serialization in driver settings string (port to main branch) #2113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/MongoDB.Driver/AutoEncryptionOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,8 @@ public override string ToString()
{
sb.AppendFormat("KeyExpiration : {0}, ", _keyExpiration.Value);
}
sb.AppendFormat("KmsProviders : {0}, ", _kmsProviders.ToJson(jsonWriterSettings));
// redact every option value, so providers added later cannot leak credentials by default
sb.AppendFormat("KmsProviders : {0}, ", new BsonDocument(_kmsProviders.Select(p => new BsonElement(p.Key, "<hidden>"))).ToJson(jsonWriterSettings));
if (_keyVaultNamespace != null)
{
sb.AppendFormat("KeyVaultNamespace : \"{0}\", ", _keyVaultNamespace.FullName);
Expand Down
29 changes: 28 additions & 1 deletion tests/MongoDB.Driver.Tests/Encryption/AutoEncryptionOptionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,34 @@ public void ToString_should_return_expected_result()
encryptedFieldsMap: encryptedFieldsMap);

var result = subject.ToString();
result.Should().Be("{ BypassAutoEncryption : True, BypassQueryAnalysis : False, KmsProviders : { \"provider1\" : { \"string\" : \"test\" }, \"provider2\" : { \"binary\" : { \"_t\" : \"System.Byte[]\", \"_v\" : { \"$binary\" : { \"base64\" : \"ABEiM0RVZneImaq7zN3u/w==\", \"subType\" : \"00\" } } } } }, KeyVaultNamespace : \"db.coll\", ExtraOptions : { \"mongocryptdURI\" : \"testURI\" }, SchemaMap : { \"coll1\" : { \"string\" : \"test\" }, \"coll2\" : { \"binary\" : { \"$binary\" : { \"base64\" : \"ABEiM0RVZneImaq7zN3u/w==\", \"subType\" : \"04\" } } } }, TlsOptions : [{ \"local\" : \"<hidden>\" }], EncryptedFieldsMap : { \"db.test\" : { \"dummy\" : \"doc\" } } }");
result.Should().Be("{ BypassAutoEncryption : True, BypassQueryAnalysis : False, KmsProviders : { \"provider1\" : \"<hidden>\", \"provider2\" : \"<hidden>\" }, KeyVaultNamespace : \"db.coll\", ExtraOptions : { \"mongocryptdURI\" : \"testURI\" }, SchemaMap : { \"coll1\" : { \"string\" : \"test\" }, \"coll2\" : { \"binary\" : { \"$binary\" : { \"base64\" : \"ABEiM0RVZneImaq7zN3u/w==\", \"subType\" : \"04\" } } } }, TlsOptions : [{ \"local\" : \"<hidden>\" }], EncryptedFieldsMap : { \"db.test\" : { \"dummy\" : \"doc\" } } }");
}

[Fact]
public void ToString_should_not_expose_kms_provider_credentials()
{
var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>
{
{ "local", new Dictionary<string, object> { { "key", new byte[96] } } },
{ "aws", new Dictionary<string, object> { { "accessKeyId", "id" }, { "secretAccessKey", "secret" } } },
{ "aws:named", new Dictionary<string, object> { { "accessKeyId", "id" }, { "secretAccessKey", "secret" } } }
};

var subject = new AutoEncryptionOptions(__keyVaultNamespace, kmsProviders);

var result = subject.ToString();

result.Should().Be("{ BypassAutoEncryption : False, KmsProviders : { \"local\" : \"<hidden>\", \"aws\" : \"<hidden>\", \"aws:named\" : \"<hidden>\" }, KeyVaultNamespace : \"db.coll\", TlsOptions : [] }");
}

[Fact]
public void ToString_should_return_expected_result_when_kmsProviders_is_empty()
{
var subject = new AutoEncryptionOptions(__keyVaultNamespace, new Dictionary<string, IReadOnlyDictionary<string, object>>());

var result = subject.ToString();

result.Should().Be("{ BypassAutoEncryption : False, KmsProviders : { }, KeyVaultNamespace : \"db.coll\", TlsOptions : [] }");
}

// private methods
Expand Down
Loading