Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-13121

Investigate changes in SERVER-44044: Remove unused second parameter from KeyVault.createDataKey()

XMLWordPrintableJSON

      Description

      Downstream Change Summary

      Update documentation for KeyVault.createKey() to note that CMK is not required/rejected for local KMS.

      Check the server-side commit to validate workflow before documenting.

      Description of Linked Ticket

      In the 4.2 mongo shell, KeyVault.createKey() takes three parameters. The second parameter customerMasterKey indicates that the user should set a CMK for the local KMS.

      From discussions, this appears to be a vestigial parameter in the context of the local KMS that is ultimately not used. The generateDataKey method eventually boils down to an kms_local.encrypt where the specified CMK is unused.

      The documentation will be modified to have users input an empty string ("") for the parameter. To clean this up, the second parameter should be optional (or rejected?) when kms = "local" .

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

            Assignee:
            ravind.kumar Ravind Kumar (Inactive)
            Reporter:
            backlog-server-pm Backlog - Core Eng Program Management Team
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:
              4 years, 12 weeks, 2 days ago