Skip to content

Commit f9e14b0

Browse files
p-mongop
authored andcommitted
RUBY-2175 Change all instances of "FLE/Field-Level Encryption" to say "Client-Side Encryption" (#1785)
Co-authored-by: Oleg Pudeyev <[email protected]>
1 parent d939a23 commit f9e14b0

File tree

5 files changed

+23
-16
lines changed

5 files changed

+23
-16
lines changed

docs/tutorials/client-side-encryption.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ to encrypt specific fields in MongoDB documents before inserting them into the
1717
database.
1818

1919
With client-side encryption, developers can encrypt fields client-side without
20-
any server-side configuration or directives. Client-side field-level encryption
21-
supports workloads where applications must guarantee that unauthorized parties,
20+
any server-side configuration or directives. Client-side encryption supports
21+
workloads where applications must guarantee that unauthorized parties,
2222
including server administrators, cannot read the encrypted data.
2323

2424
.. warning::

lib/mongo/error/crypt_error.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Copyright (C) 2020 MongoDB Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
15
# You may obtain a copy of the License at
26
#
37
# http://www.apache.org/licenses/LICENSE-2.0
@@ -11,7 +15,7 @@
1115
module Mongo
1216
class Error
1317

14-
# An error related to field-level encryption
18+
# An error related to client-side encryption.
1519
class CryptError < Mongo::Error
1620
# Create a new CryptError
1721
#

lib/mongo/error/kms_error.rb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Copyright (C) 2020 MongoDB Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
15
# You may obtain a copy of the License at
26
#
37
# http://www.apache.org/licenses/LICENSE-2.0
@@ -11,7 +15,8 @@
1115
module Mongo
1216
class Error
1317

14-
# A KMS-related error during field-level encryption
15-
class KmsError < CryptError; end
18+
# A KMS-related error during client-side encryption.
19+
class KmsError < CryptError
20+
end
1621
end
1722
end
Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Copyright (C) 2020 MongoDB Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
15
# You may obtain a copy of the License at
26
#
37
# http://www.apache.org/licenses/LICENSE-2.0
@@ -11,14 +15,8 @@
1115
module Mongo
1216
class Error
1317

14-
# An error related to spawning mongocryptd for field-level encrpytion
18+
# An error related to spawning mongocryptd for client-side encryption.
1519
class MongocryptdSpawnError < CryptError
16-
# Create a new MongocryptdSpawnError
17-
#
18-
# @param [ String ] message The error message
19-
def initialize(message)
20-
super(message)
21-
end
2220
end
2321
end
2422
end

spec/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ possible to run just the Kerberos-related unit tests without provisioning a
286286
MongoDB deployment; consult .evergreen/run-tests-kerberos-unit.sh for the
287287
full list of relevant test files.
288288

289-
## Field-Level Encryption
289+
## Client-Side Encryption
290290

291291
Install libmongocrypt on your machine:
292292

@@ -305,7 +305,7 @@ Option 2: Build from source
305305
- To build libmongocrypt from source, follow the instructions in the README on the libmongocrypt GitHub repo: https://github.com/mongodb/libmongocrypt
306306

307307
Create AWS KMS keys
308-
Many of the Field-Level Encryption tests require that you have an encryption
308+
Many of the Client-Side Encryption tests require that you have an encryption
309309
master key hosted on AWS's Key Management Service. Set up a master key by following
310310
these steps:
311311

@@ -320,7 +320,7 @@ in environment variables on your local machine. Create an access key by followin
320320
"Managing Access Keys (Console)" instructions in this guide:
321321
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey
322322
Once an access key has been created, store the access key id and the access key
323-
secret in environment variables. If you plan to frequently run Field-Level
323+
secret in environment variables. If you plan to frequently run Client-Side
324324
Encryption tests, it may be a good idea to put these lines in your .bash_profile
325325
or .bashrc file. Otherwise, you can run them in the terminal window where you
326326
plan to run your tests.
@@ -342,7 +342,7 @@ section of this guide: https://docs.aws.amazon.com/kms/latest/developerguide/cre
342342
and how to view your key's ARN: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys-console.html
343343

344344
Store these two pieces of information in environment variables. If you plan
345-
to frequently run Field-Level Encryption tests, it may be a good idea to put
345+
to frequently run Client-Side Encryption tests, it may be a good idea to put
346346
these lines in your .bash_profile or .bashrc file. Otherwise, you can run
347347
them in the terminal window where you plan to run your tests.
348348

0 commit comments

Comments
 (0)