Skip to content

Commit 0423dbc

Browse files
authored
DOCSP-24872 adds FLE options (#234)
* DOCSP-24872 adds FLE options * internal review feedback * links instances of "AWS" where appropriate
1 parent 0737296 commit 0423dbc

File tree

1 file changed

+91
-9
lines changed

1 file changed

+91
-9
lines changed

source/reference/options.txt

Lines changed: 91 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ General Options
2727

2828
Evaluates a JavaScript expression. You can use a single ``--eval``
2929
argument or multiple ``--eval`` arguments together.
30-
30+
3131
After ``mongosh`` evaluates the ``--eval`` argument, it prints the
3232
results to your command line. If you use multiple ``--eval``
3333
statements, ``mongosh`` only prints the results of the last
@@ -149,7 +149,7 @@ Connection Options
149149
.. example::
150150

151151
.. code-block:: none
152-
152+
153153
mongodb+srv://server.example.com/?connectionTimeout=3000ms
154154

155155
.. option:: --port <port>
@@ -212,7 +212,7 @@ TLS Options
212212
.. include:: /includes/fact-ssl-see-more.rst
213213

214214
.. option:: --tlsCAFile <filename>
215-
215+
216216
Specifies the :file:`.pem` file that contains the root certificate
217217
chain from the Certificate Authority. This file is used to validate
218218
the certificate presented by the
@@ -394,7 +394,7 @@ Authentication Options
394394
.. note::
395395

396396
Starting in version 4.0:
397-
397+
398398
- MongoDB removes support for the deprecated MongoDB
399399
Challenge-Response (``MONGODB-CR``) authentication mechanism.
400400

@@ -464,9 +464,9 @@ Authentication Options
464464
- ``forwardAndReverse``, performs a forward DNS lookup and then a
465465
reverse lookup. New in ``mongosh`` 1.3.0.
466466
- ``forward``, the effect is the same as setting
467-
``authMechanismProperties=CANONICALIZE_HOST_NAME:true``.
467+
``authMechanismProperties=CANONICALIZE_HOST_NAME:true``.
468468
- ``none``, the effect is the same as setting
469-
``authMechanismProperties=CANONICALIZE_HOST_NAME:false``.
469+
``authMechanismProperties=CANONICALIZE_HOST_NAME:false``.
470470

471471
.. option:: --password <password>, -p <password>
472472

@@ -507,6 +507,88 @@ Session Options
507507
Client-Side Field Level Encryption Options
508508
------------------------------------------
509509

510-
For information on Client-Side Field Level Encryption Options,
511-
refer to the :manual:`MongoDB Manual
512-
</reference/program/mongo/#client-side-field-level-encryption-options>`.
510+
.. option:: --awsAccessKeyId <string>
511+
512+
An `AWS Access Key
513+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html>`__
514+
associated with an IAM user who has ``List`` and ``Read`` permissions
515+
for the AWS Key Management Service (KMS). :program:`mongosh` uses the
516+
specified :option:`--awsAccessKeyId` to access the KMS.
517+
518+
:option:`--awsAccessKeyId` is required to enable
519+
:ref:`manual-csfle-feature` for the :program:`mongosh` shell session.
520+
:option:`--awsAccessKeyId` requires *both* of the following command
521+
line options:
522+
523+
- :option:`--awsSecretAccessKey`
524+
- :option:`--keyVaultNamespace`
525+
526+
If :option:`--awsAccessKeyId` is omitted, use the :method:`Mongo()`
527+
constructor within the shell session to enable client-side field
528+
level encryption.
529+
530+
To mitigate the risk of leaking access keys into logs, consider
531+
specifying an environmental variable to :option:`--awsAccessKeyId`.
532+
533+
.. option:: --awsSecretAccessKey <string>
534+
535+
An `AWS Secret Key
536+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html>`__
537+
associated to the specified :option:`--awsAccessKeyId`.
538+
539+
:option:`--awsSecretAccessKey` is required to enable
540+
:ref:`manual-csfle-feature` for the :program:`mongosh` session.
541+
:option:`--awsSecretAccessKey` requires *both* of the following
542+
command line options:
543+
544+
- :option:`--awsAccessKeyId`
545+
- :option:`--keyVaultNamespace`
546+
547+
If :option:`--awsSecretAccessKey` and its supporting options are
548+
omitted, use :method:`Mongo()` within the shell session to enable
549+
client-side field level encryption.
550+
551+
To mitigate the risk of leaking access keys into logs, consider
552+
specifying an environmental variable to
553+
:option:`--awsSecretAccessKey`.
554+
555+
.. option:: --awsSessionToken <string>
556+
557+
An `AWS Session Token
558+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html>`__
559+
associated to the specified :option:`--awsAccessKeyId`.
560+
561+
:option:`--awsSessionToken` is required to enable
562+
:ref:`manual-csfle-feature` for the :program:`mongosh` shell session.
563+
:option:`--awsSessionToken` requires *all* of the following command
564+
line options:
565+
566+
- :option:`--awsAccessKeyId`
567+
- :option:`--awsSecretAccessKey`
568+
- :option:`--keyVaultNamespace`
569+
570+
If :option:`--awsSessionToken` and its supporting options are
571+
omitted, use :method:`Mongo()` within the shell session to enable
572+
client-side field level encryption.
573+
574+
To mitigate the risk of leaking access keys into logs, consider
575+
specifying an environmental variable to :option:`--awsSessionToken`.
576+
577+
.. option:: --keyVaultNamespace <string>
578+
579+
The full namespace (``<database>.<collection>``) of the collection
580+
used as a key vault for :ref:`manual-csfle-feature`.
581+
:option:`--keyVaultNamespace` is required for enabling client-side
582+
field level encryption. for the :program:`mongosh` shell session.
583+
:program:`mongosh` creates the specified namespace if it does not
584+
exist.
585+
586+
:option:`--keyVaultNamespace` requires *both* of the following
587+
command line options:
588+
589+
- :option:`--awsAccessKeyId`
590+
- :option:`--awsSecretAccessKey`
591+
592+
If :option:`--keyVaultNamespace` and its supporting options are
593+
omitted, use the :method:`Mongo()` constructor within the shell
594+
session to enable client-side field level encryption.

0 commit comments

Comments
 (0)