Skip to content

Commit cf300a3

Browse files
baileympearsonbaileympearson
committed
rename KMIP tls files to align with the shared tooling in drivers evergreen tools.
1 parent f94cda4 commit cf300a3

File tree

9 files changed

+69
-70
lines changed

9 files changed

+69
-70
lines changed

‎.evergreen/config.in.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,8 @@ functions:
148148
export AWS_REGION='${AWS_REGION}'
149149
export AWS_CMK_ID='${AWS_CMK_ID}'
150150
export AWS_DEFAULT_REGION='us-east-1'
151-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
152-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
151+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
152+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
153153
EOT
154154
fi
155155
- command: subprocess.exec
@@ -184,8 +184,8 @@ functions:
184184
export AWS_REGION='${AWS_REGION}'
185185
export AWS_CMK_ID='${AWS_CMK_ID}'
186186
export AWS_DEFAULT_REGION='us-east-1'
187-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
188-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
187+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
188+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
189189
EOT
190190
- command: subprocess.exec
191191
type: test

‎.evergreen/config.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ functions:
120120
export AWS_REGION='${AWS_REGION}'
121121
export AWS_CMK_ID='${AWS_CMK_ID}'
122122
export AWS_DEFAULT_REGION='us-east-1'
123-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
124-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
123+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
124+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
125125
EOT
126126
fi
127127
- command: subprocess.exec
@@ -155,8 +155,8 @@ functions:
155155
export AWS_REGION='${AWS_REGION}'
156156
export AWS_CMK_ID='${AWS_CMK_ID}'
157157
export AWS_DEFAULT_REGION='us-east-1'
158-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
159-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
158+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
159+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
160160
EOT
161161
- command: subprocess.exec
162162
type: test

‎.evergreen/run-custom-csfle-tests.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ set -o errexit # Exit the script with error if any of the commands fail
1616

1717

1818
export MONGODB_URI=${MONGODB_URI}
19-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
20-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
19+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
20+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
2121
export TEST_CSFLE=true
2222

2323
npm run check:csfle

‎.evergreen/run-socks5-tests.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ function setup_fle() {
1212
export CLIENT_ENCRYPTION=true
1313
source .evergreen/setup-fle.sh
1414

15-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
16-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
15+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
16+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
1717
export TEST_CSFLE=true
1818
}
1919

‎test/integration/client-side-encryption/client_side_encryption.prose.06.corpus.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,8 @@ describe('Client Side Encryption Prose Corpus Test', function () {
201201
// Configure both objects with ``keyVaultNamespace`` set to ``keyvault.datakeys``.
202202
const tlsOptions = {
203203
kmip: {
204-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
205-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
204+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
205+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
206206
}
207207
};
208208
const extraOptions = getEncryptExtraOptions();

‎test/integration/client-side-encryption/client_side_encryption.prose.test.js‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -863,8 +863,8 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
863863
kmsProviders: customKmsProviders,
864864
tlsOptions: {
865865
kmip: {
866-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
867-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
866+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
867+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
868868
}
869869
},
870870
extraOptions: getEncryptExtraOptions()
@@ -875,8 +875,8 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
875875
kmsProviders: invalidKmsProviders,
876876
tlsOptions: {
877877
kmip: {
878-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
879-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
878+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
879+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
880880
}
881881
},
882882
extraOptions: getEncryptExtraOptions()
@@ -1371,16 +1371,16 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
13711371
beforeEach(async function () {
13721372
const tlsCaOptions = {
13731373
aws: {
1374-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1374+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
13751375
},
13761376
azure: {
1377-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1377+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
13781378
},
13791379
gcp: {
1380-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1380+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
13811381
},
13821382
kmip: {
1383-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1383+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
13841384
}
13851385
};
13861386
const clientNoTlsOptions = {
@@ -1394,20 +1394,20 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
13941394
kmsProviders: getKmsProviders(null, null, '127.0.0.1:8002', '127.0.0.1:8002'),
13951395
tlsOptions: {
13961396
aws: {
1397-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1398-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1397+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1398+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
13991399
},
14001400
azure: {
1401-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1402-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1401+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1402+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
14031403
},
14041404
gcp: {
1405-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1406-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1405+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1406+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
14071407
},
14081408
kmip: {
1409-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1410-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1409+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1410+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
14111411
}
14121412
},
14131413
extraOptions: getEncryptExtraOptions()
@@ -1752,32 +1752,32 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
17521752
},
17531753
tlsOptions: {
17541754
'aws:no_client_cert': {
1755-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1755+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
17561756
},
17571757
'azure:no_client_cert': {
1758-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1758+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
17591759
},
17601760
'gcp:no_client_cert': {
1761-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1761+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
17621762
},
17631763
'kmip:no_client_cert': {
1764-
tlsCAFile: process.env.KMIP_TLS_CA_FILE
1764+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE
17651765
},
17661766
'aws:with_tls': {
1767-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1768-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1767+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1768+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
17691769
},
17701770
'azure:with_tls': {
1771-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1772-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1771+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1772+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
17731773
},
17741774
'gcp:with_tls': {
1775-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1776-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1775+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1776+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
17771777
},
17781778
'kmip:with_tls': {
1779-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
1780-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
1779+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
1780+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
17811781
}
17821782
},
17831783
keyVaultNamespace: 'db.keys'
@@ -2354,8 +2354,8 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
23542354
kmsProviders: getKmsProviders(),
23552355
tlsOptions: {
23562356
kmip: {
2357-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
2358-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
2357+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
2358+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
23592359
}
23602360
},
23612361
extraOptions: getEncryptExtraOptions(),
@@ -2379,8 +2379,8 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
23792379
kmsProviders: getKmsProviders(),
23802380
tlsOptions: {
23812381
kmip: {
2382-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
2383-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
2382+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
2383+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
23842384
}
23852385
},
23862386
extraOptions: getEncryptExtraOptions(),

‎test/readme.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -508,15 +508,15 @@ The following steps will walk you through how to run the tests for CSFLE.
508508
```
509509
> **Note:** MongoDB employees can pull these values from the Evergreen project's configuration.
510510

511-
| Variable Name | Description |
512-
| ----------------------- | ------------------------------------------------------------------------------------------- |
513-
| `AWS_ACCESS_KEY_ID` | The AWS access key ID used to generate KMS messages |
514-
| `AWS_SECRET_ACCESS_KEY` | The AWS secret access key used to generate KMS messages |
515-
| `AWS_REGION` | The AWS region where the KMS resides (e.g., `us-east-1`) |
516-
| `AWS_CMK_ID` | The Customer Master Key for the KMS |
517-
| `CSFLE_KMS_PROVIDERS` | The raw EJSON description of the KMS providers. An example of the format is provided below. |
518-
| `KMIP_TLS_CA_FILE` | /path/to/mongodb-labs/drivers-evergreen-tools/.evergreen/x509gen/ca.pem |
519-
| `KMIP_TLS_CERT_FILE` | /path/to/mongodb-labs/drivers-evergreen-tools/.evergreen/x509gen/client.pem |
511+
| Variable Name | Description |
512+
| ---------------------------- | ------------------------------------------------------------------------------------------- |
513+
| `AWS_ACCESS_KEY_ID` | The AWS access key ID used to generate KMS messages |
514+
| `AWS_SECRET_ACCESS_KEY` | The AWS secret access key used to generate KMS messages |
515+
| `AWS_REGION` | The AWS region where the KMS resides (e.g., `us-east-1`) |
516+
| `AWS_CMK_ID` | The Customer Master Key for the KMS |
517+
| `CSFLE_KMS_PROVIDERS` | The raw EJSON description of the KMS providers. An example of the format is provided below. |
518+
| `CSFLE_TLS_CA_FILE` | /path/to/mongodb-labs/drivers-evergreen-tools/.evergreen/x509gen/ca.pem |
519+
| `CSFLE_TLS_CLIENT_CERT_FILE` | /path/to/mongodb-labs/drivers-evergreen-tools/.evergreen/x509gen/client.pem |
520520

521521
The value of the `CSFLE_KMS_PROVIDERS` variable will have the following format:
522522

@@ -655,8 +655,8 @@ lerna run test --scope @mongosh/service-provider-server
655655
```
656656
4. Set the following environment variables:
657657
```sh
658-
export KMIP_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
659-
export KMIP_TLS_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
658+
export CSFLE_TLS_CA_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/ca.pem"
659+
export CSFLE_TLS_CLIENT_CERT_FILE="${DRIVERS_TOOLS}/.evergreen/x509gen/client.pem"
660660
```
661661
5. Install the FLE lib:
662662
```sh

‎test/tools/spec-runner/index.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ function translateClientOptions(options) {
8383
};
8484
options.autoEncryption.tlsOptions = {
8585
kmip: {
86-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
87-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
86+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
87+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
8888
}
8989
};
9090
}
@@ -93,8 +93,8 @@ function translateClientOptions(options) {
9393
kmsProviders['local:name2'] = options.autoEncryptOpts.kmsProviders['local:name2'];
9494
options.autoEncryption.tlsOptions = {
9595
'local:name2': {
96-
tlsCAFile: process.env.KMIP_TLS_CA_FILE,
97-
tlsCertificateKeyFile: process.env.KMIP_TLS_CERT_FILE
96+
tlsCAFile: process.env.CSFLE_TLS_CA_FILE,
97+
tlsCertificateKeyFile: process.env.CSFLE_TLS_CLIENT_CERT_FILE
9898
}
9999
};
100100
}

‎test/tools/unified-spec-runner/unified-utils.ts‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -247,9 +247,8 @@ export function getMatchingEventCount(event, client, entities): number {
247247
/**
248248
* parses the process.env for three required environment variables
249249
*
250-
* - CSFLE_KMS_PROVIDERS
251-
* - KMIP_TLS_CA_FILE
252-
* - KMIP_TLS_CERT_FILE
250+
* - CSFLE_TLS_CA_FILE
251+
* - CSFLE_TLS_CLIENT_CERT_FILE
253252
*
254253
* @throws if any required environment variable is undefined, or if we are unable to
255254
* parse the CLSFE_KMS_PROVIDERS from the environment
@@ -272,24 +271,24 @@ export function getCSFLETestDataFromEnvironment(environment: Record<string, stri
272271
throw new AssertionError('Malformed CSFLE_KMS_PROVIDERS provided to unified tests.');
273272
}
274273

275-
if (environment.KMIP_TLS_CA_FILE == null) {
274+
if (environment.CSFLE_TLS_CA_FILE == null) {
276275
throw new AssertionError(
277-
'KMIP_TLS_CA_FILE is required to run the csfle tests. Please make sure it is set in the environment.'
276+
'CSFLE_TLS_CA_FILE is required to run the csfle tests. Please make sure it is set in the environment.'
278277
);
279278
}
280279

281-
if (environment.KMIP_TLS_CERT_FILE == null) {
280+
if (environment.CSFLE_TLS_CLIENT_CERT_FILE == null) {
282281
throw new AssertionError(
283-
'KMIP_TLS_CERT_FILE is required to run the csfle tests. Please make sure it is set in the environment.'
282+
'CSFLE_TLS_CLIENT_CERT_FILE is required to run the csfle tests. Please make sure it is set in the environment.'
284283
);
285284
}
286285

287286
return {
288287
kmsProviders: parsedKMSProviders,
289288
tlsOptions: {
290289
kmip: {
291-
tlsCAFile: environment.KMIP_TLS_CA_FILE,
292-
tlsCertificateKeyFile: environment.KMIP_TLS_CERT_FILE
290+
tlsCAFile: environment.CSFLE_TLS_CA_FILE,
291+
tlsCertificateKeyFile: environment.CSFLE_TLS_CLIENT_CERT_FILE
293292
}
294293
}
295294
};

0 commit comments

Comments
 (0)