Skip to content

Commit da0f73a

Browse files
jmikolajmikola
authored
PHPC-1912: CSFLE 1.0 KMIP Support (#1280)
* PHPC-2009: Support tlsOptions encryption option This also adds some missing option validation tests for the autoEncryption driver option and Manager::createClientEncryption(). * PHPC-2010: Type validation for autoEncryption.extraOptions
1 parent 21fd5a6 commit da0f73a

File tree

3 files changed

+77
-14
lines changed

3 files changed

+77
-14
lines changed

‎php_phongo.c‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2803,6 +2803,25 @@ static bool phongo_manager_set_auto_encryption_opts(php_phongo_manager_t* manage
28032803
bson_destroy(&bson_map);
28042804
}
28052805

2806+
if (php_array_existsc(zAutoEncryptionOpts, "tlsOptions")) {
2807+
zval* tls_options = php_array_fetch(zAutoEncryptionOpts, "tlsOptions");
2808+
bson_t bson_options = BSON_INITIALIZER;
2809+
2810+
if (Z_TYPE_P(tls_options) != IS_OBJECT && Z_TYPE_P(tls_options) != IS_ARRAY) {
2811+
phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected \"tlsOptions\" encryption option to be an array or object");
2812+
goto cleanup;
2813+
}
2814+
2815+
php_phongo_zval_to_bson(tls_options, PHONGO_BSON_NONE, &bson_options, NULL);
2816+
if (EG(exception)) {
2817+
goto cleanup;
2818+
}
2819+
2820+
mongoc_auto_encryption_opts_set_tls_opts(auto_encryption_opts, &bson_options);
2821+
2822+
bson_destroy(&bson_options);
2823+
}
2824+
28062825
if (php_array_existsc(zAutoEncryptionOpts, "bypassAutoEncryption")) {
28072826
zend_bool bypass_auto_encryption = php_array_fetch_bool(zAutoEncryptionOpts, "bypassAutoEncryption");
28082827

@@ -2813,6 +2832,11 @@ static bool phongo_manager_set_auto_encryption_opts(php_phongo_manager_t* manage
28132832
zval* extra_options = php_array_fetch(zAutoEncryptionOpts, "extraOptions");
28142833
bson_t bson_options = BSON_INITIALIZER;
28152834

2835+
if (Z_TYPE_P(extra_options) != IS_OBJECT && Z_TYPE_P(extra_options) != IS_ARRAY) {
2836+
phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected \"extraOptions\" encryption option to be an array or object");
2837+
goto cleanup;
2838+
}
2839+
28162840
php_phongo_zval_to_bson(extra_options, PHONGO_BSON_NONE, &bson_options, NULL);
28172841
if (EG(exception)) {
28182842
goto cleanup;
@@ -2912,6 +2936,24 @@ static mongoc_client_encryption_opts_t* phongo_clientencryption_opts_from_zval(z
29122936
bson_destroy(&bson_providers);
29132937
}
29142938

2939+
if (php_array_existsc(options, "tlsOptions")) {
2940+
zval* tls_options = php_array_fetchc(options, "tlsOptions");
2941+
bson_t bson_options = BSON_INITIALIZER;
2942+
2943+
if (Z_TYPE_P(tls_options) != IS_ARRAY && Z_TYPE_P(tls_options) != IS_OBJECT) {
2944+
phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected \"tlsOptions\" encryption option to be an array or object");
2945+
goto cleanup;
2946+
}
2947+
2948+
php_phongo_zval_to_bson(tls_options, PHONGO_BSON_NONE, &bson_options, NULL);
2949+
if (EG(exception)) {
2950+
goto cleanup;
2951+
}
2952+
2953+
mongoc_client_encryption_opts_set_tls_opts(opts, &bson_options);
2954+
bson_destroy(&bson_options);
2955+
}
2956+
29152957
return opts;
29162958

29172959
cleanup:

‎tests/manager/manager-createClientEncryption-error-002.phpt‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,37 @@ MongoDB\Driver\Manager::createClientEncryption() with invalid option types
99
require_once __DIR__ . '/../utils/basic.inc';
1010

1111
$tests = [
12-
['kmsProviders' => 'string'],
12+
['keyVaultClient' => 'not_an_array_or_object'],
1313
[
14+
'keyVaultNamespace' => 'not_a_namespace',
15+
// keyVaultNamespace requires a valid kmsProviders option
1416
'kmsProviders' => ['local' => ['key' => new MongoDB\BSON\Binary('', 0)]],
15-
'keyVaultClient' => 'string',
1617
],
18+
['kmsProviders' => 'not_an_array_or_object'],
19+
['tlsOptions' => 'not_an_array_or_object'],
1720
];
1821

1922
foreach ($tests as $test) {
2023
echo throws(function () use ($test) {
2124
$manager = create_test_manager();
22-
$clientEncryption = $manager->createClientEncryption(['keyVaultNamespace' => 'default.keys'] + $test);
25+
$clientEncryption = $manager->createClientEncryption($test);
2326
}, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n\n";
2427
}
2528

2629
?>
2730
===DONE===
2831
<?php exit(0); ?>
2932
--EXPECT--
33+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
34+
Expected "keyVaultClient" encryption option to be MongoDB\Driver\Manager, string given
35+
36+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
37+
Expected "keyVaultNamespace" encryption option to contain a full collection name
38+
3039
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
3140
Expected "kmsProviders" encryption option to be an array or object
3241

3342
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
34-
Expected "keyVaultClient" encryption option to be MongoDB\Driver\Manager, string given
43+
Expected "tlsOptions" encryption option to be an array or object
3544

3645
===DONE===

‎tests/manager/manager-ctor-auto_encryption-error-003.phpt‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,48 @@ MongoDB\Driver\Manager::__construct(): invalid option types
99
require_once __DIR__ . '/../utils/basic.inc';
1010

1111
$tests = [
12-
['kmsProviders' => 'string'],
12+
'not_an_array',
13+
['keyVaultClient' => 'not_an_array_or_object'],
1314
[
15+
'keyVaultNamespace' => 'not_a_namespace',
16+
// keyVaultNamespace requires a valid kmsProviders option
1417
'kmsProviders' => ['local' => ['key' => new MongoDB\BSON\Binary('', 0)]],
15-
'schemaMap' => 'string',
16-
],
17-
[
18-
'kmsProviders' => ['local' => ['key' => new MongoDB\BSON\Binary('', 0)]],
19-
'keyVaultClient' => 'string',
2018
],
19+
['kmsProviders' => 'not_an_array_or_object'],
20+
['schemaMap' => 'not_an_array_or_object'],
21+
['tlsOptions' => 'not_an_array_or_object'],
22+
['extraOptions' => 'not_an_array_or_object'],
2123
];
2224

2325
foreach ($tests as $test) {
2426
echo throws(function() use ($test) {
25-
$autoEncryptionOptions = ['keyVaultNamespace' => 'admin.dataKeys'];
26-
27-
$manager = create_test_manager(null, [], ['autoEncryption' => $autoEncryptionOptions + $test]);
27+
$manager = create_test_manager(null, [], ['autoEncryption' => $test]);
2828
}, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n\n";
2929
}
3030

3131
?>
3232
===DONE===
3333
<?php exit(0); ?>
3434
--EXPECT--
35+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
36+
Expected "autoEncryption" driver option to be array, string given
37+
38+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
39+
Expected "keyVaultClient" encryption option to be MongoDB\Driver\Manager, string given
40+
41+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
42+
Expected "keyVaultNamespace" encryption option to contain a full collection name
43+
3544
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
3645
Expected "kmsProviders" encryption option to be an array or object
3746

3847
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
3948
Expected "schemaMap" encryption option to be an array or object
4049

4150
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
42-
Expected "keyVaultClient" encryption option to be MongoDB\Driver\Manager, string given
51+
Expected "tlsOptions" encryption option to be an array or object
52+
53+
OK: Got MongoDB\Driver\Exception\InvalidArgumentException
54+
Expected "extraOptions" encryption option to be an array or object
4355

4456
===DONE===

0 commit comments

Comments
 (0)