-
Notifications
You must be signed in to change notification settings - Fork 1.3k
CSHARP-4255: Fix bug and some tests. #993
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.
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
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ca108c1
CSHARP-4255: Fix bug and some tests.
DmitryLukyanov 28cf23d
Code review.
DmitryLukyanov 4029fd3
Add test.
DmitryLukyanov 308349b
Code review.
DmitryLukyanov e7b9fc1
Code review.
DmitryLukyanov 1e78cdb
Fixing tests.
DmitryLukyanov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
src/MongoDB.Driver/Encryption/CreateEncryptedCollectionResult.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* Copyright 2010-present MongoDB Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
using MongoDB.Bson; | ||
|
||
namespace MongoDB.Driver.Encryption | ||
{ | ||
/// <summary> | ||
/// Represents the result of a create encrypted collection. | ||
/// </summary> | ||
BorisDog marked this conversation as resolved.
Show resolved
Hide resolved
|
||
public sealed class CreateEncryptedCollectionResult | ||
{ | ||
private readonly BsonDocument _encryptedFields; | ||
|
||
/// <summary> | ||
/// Initializes a new instance of the <see cref="CreateEncryptedCollectionResult"/> class. | ||
/// </summary> | ||
/// <param name="encryptedFields">The encrypted fields document.</param> | ||
public CreateEncryptedCollectionResult(BsonDocument encryptedFields) => _encryptedFields = encryptedFields; | ||
|
||
/// <summary> | ||
/// The encrypted fields document. | ||
/// </summary> | ||
public BsonDocument EncryptedFields => _encryptedFields; | ||
} | ||
} |
69 changes: 69 additions & 0 deletions
69
src/MongoDB.Driver/Encryption/MongoEncryptionCreateCollectionException.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* Copyright 2010-present MongoDB Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
using System; | ||
using System.Runtime.Serialization; | ||
using MongoDB.Bson; | ||
|
||
namespace MongoDB.Driver.Encryption | ||
{ | ||
/// <summary> | ||
/// Represents an encryption exception. | ||
/// </summary> | ||
[Serializable] | ||
public class MongoEncryptionCreateCollectionException : MongoEncryptionException | ||
BorisDog marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
private readonly BsonDocument _encryptedFields; | ||
|
||
/// <summary> | ||
/// Initializes a new instance of the <see cref="MongoEncryptionException"/> class. | ||
/// </summary> | ||
/// <param name="innerException">The inner exception.</param> | ||
/// <param name="encryptedFields">The encrypted fields.</param> | ||
public MongoEncryptionCreateCollectionException(Exception innerException, BsonDocument encryptedFields) | ||
: base(innerException) | ||
{ | ||
_encryptedFields = encryptedFields; | ||
} | ||
|
||
/// <summary> | ||
/// Initializes a new instance of the <see cref="MongoEncryptionCreateCollectionException"/> class (this overload used by deserialization). | ||
/// </summary> | ||
/// <param name="info">The SerializationInfo.</param> | ||
/// <param name="context">The StreamingContext.</param> | ||
protected MongoEncryptionCreateCollectionException(SerializationInfo info, StreamingContext context) | ||
: base(info, context) | ||
{ | ||
_encryptedFields = (BsonDocument)info.GetValue(nameof(_encryptedFields), typeof(BsonDocument)); | ||
} | ||
|
||
/// <summary> | ||
/// The encrypted fields. | ||
/// </summary> | ||
public BsonDocument EncryptedFields => _encryptedFields; | ||
|
||
// public methods | ||
/// <summary> | ||
/// Gets the object data. | ||
/// </summary> | ||
/// <param name="info">The information.</param> | ||
/// <param name="context">The context.</param> | ||
public override void GetObjectData(SerializationInfo info, StreamingContext context) | ||
{ | ||
base.GetObjectData(info, context); | ||
info.AddValue(nameof(_encryptedFields), _encryptedFields); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning operation data, which is unrelated to exception, within exception is a bit unusual, but I am fine with this here.
@JamesKovacs this is follow up for our slack discussion, please double check that you are ok with this as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed with Dima via Slack. While from an API perspective it feels odd to return successfully-created keys in the exception, I don't see another reasonable way to avoid phantom encryption keys. While we could modify
CreateCollectionOptions
as we generate dataKeys, it violates the principle of least surprise to modify one's input parameters unexpectedly. I think this is the best option given the available trade-offs.