Skip to content

Commit 64359b4

Browse files
Add documentation for the ssl.* config options. (#5182)
[SC-50966](https://app.shortcut.com/tiledb-inc/story/50966/document-ssl-config-options) This adds documentation for the ssl certificate options that was previously undocumented. --- TYPE: NO_HISTORY
1 parent 271b045 commit 64359b4

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

tiledb/api/c_api/config/config_api_external.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,24 @@ TILEDB_EXPORT void tiledb_config_free(tiledb_config_t** config) TILEDB_NOEXCEPT;
324324
* If `true` tile offsets can be partially loaded and unloaded by the
325325
* readers. <br>
326326
* **Default**: false
327+
* - `ssl.ca_file` <br>
328+
* The path to CA certificate to use when validating server certificates.
329+
* Applies to all SSL/TLS connections. <br>
330+
* This option might be ignored on platforms that have native certificate
331+
* stores like Windows. <br>
332+
* **Default**: ""
333+
* - `ssl.ca_path` <br>
334+
* The path to a directory with CA certificates to use when validating
335+
* server certificates. Applies to all SSL/TLS connections. <br>
336+
* This option might be ignored on platforms that have native certificate
337+
* stores like Windows. <br>
338+
* **Default**: ""
339+
* - `ssl.verify` <br>
340+
* Whether to verify the server's certificate. Applies to all SSL/TLS
341+
* connections. <br>
342+
* Disabling verification is insecure and should only used for testing
343+
* purposes. <br>
344+
* **Default**: true
327345
* - `vfs.read_ahead_cache_size` <br>
328346
* The the total maximum size of the read-ahead cache, which is an LRU. <br>
329347
* **Default**: 10485760

tiledb/sm/cpp_api/config.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,24 @@ class Config {
498498
* If `true` tile offsets can be partially loaded and unloaded by the
499499
* readers. <br>
500500
* **Default**: false
501+
* - `ssl.ca_file` <br>
502+
* The path to CA certificate to use when validating server certificates.
503+
* Applies to all SSL/TLS connections. <br>
504+
* This option might be ignored on platforms that have native certificate
505+
* stores like Windows. <br>
506+
* **Default**: ""
507+
* - `ssl.ca_path` <br>
508+
* The path to a directory with CA certificates to use when validating
509+
* server certificates. Applies to all SSL/TLS connections. <br>
510+
* This option might be ignored on platforms that have native certificate
511+
* stores like Windows. <br>
512+
* **Default**: ""
513+
* - `ssl.verify` <br>
514+
* Whether to verify the server's certificate. Applies to all SSL/TLS
515+
* connections. <br>
516+
* Disabling verification is insecure and should only used for testing
517+
* purposes. <br>
518+
* **Default**: true
501519
* - `vfs.read_ahead_cache_size` <br>
502520
* The the total maximum size of the read-ahead cache, which is an LRU.
503521
* <br>

0 commit comments

Comments
 (0)