<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:25:25 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[DRIVERS-2372] Add createKey to ClientEncryption as an optional feature</title>
                <link>https://jira.mongodb.org/browse/DRIVERS-2372</link>
                <project id="10980" key="DRIVERS">Drivers</project>
                    <description>&lt;div class=&quot;panel&quot; style=&quot;background-color: #fafbfc;border-width: 1px;&quot;&gt;&lt;div class=&quot;panelContent&quot; style=&quot;background-color: #fafbfc;&quot;&gt;
&lt;h3&gt;&lt;a name=&quot;Summary&quot;&gt;&lt;/a&gt;&lt;b&gt;Summary&lt;/b&gt;&lt;/h3&gt;

&lt;p&gt;The initial Key Management API spec in &lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-1951&quot; title=&quot;Key Management API&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-1951&quot;&gt;&lt;del&gt;DRIVERS-1951&lt;/del&gt;&lt;/a&gt; included a new &lt;tt&gt;createKey()&lt;/tt&gt; function for parity with mongosh. This function was removed by &lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-2370&quot; title=&quot;Remove ClientEncryption.createKey() in favor of createDataKey()&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-2370&quot;&gt;&lt;del&gt;DRIVERS-2370&lt;/del&gt;&lt;/a&gt; for forward-compatibility reasons. However, the Node driver has already shipped the Key Management API and is already depended on by the latest release of mongosh.&lt;/p&gt;

&lt;p&gt;In order to minimize friction with the Node driver, it is proposed that &lt;tt&gt;createKey()&lt;/tt&gt; be added back to the spec as an &lt;em&gt;optional&lt;/em&gt; feature, with the suggestion that Drivers which have not yet implemented &lt;tt&gt;createKey()&lt;/tt&gt; or released the Key Management API continue to make an effort to exclude &lt;tt&gt;createKey()&lt;/tt&gt; for reasons stated in &lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-2370&quot; title=&quot;Remove ClientEncryption.createKey() in favor of createDataKey()&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-2370&quot;&gt;&lt;del&gt;DRIVERS-2370&lt;/del&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;h3&gt;&lt;a name=&quot;Motivation&quot;&gt;&lt;/a&gt;&lt;b&gt;Motivation&lt;/b&gt;&lt;/h3&gt;
&lt;h4&gt;&lt;a name=&quot;Whoistheaffectedenduser%3F&quot;&gt;&lt;/a&gt;Who is the affected end user?&lt;/h4&gt;

&lt;p&gt;Primarily the Node driver and its downstream users. Other drivers currently implementing the Key Management API are also involved.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Howdoesthisaffecttheenduser%3F&quot;&gt;&lt;/a&gt;How does this affect the end user?&lt;/h4&gt;

&lt;p&gt;Leaving &lt;tt&gt;createKey()&lt;/tt&gt; removed from the spec would means Node is non-conforming.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Howlikelyisitthatthisproblemorusecasewilloccur%3F&quot;&gt;&lt;/a&gt;How likely is it that this problem or use case will occur?&lt;/h4&gt;

&lt;p&gt;The issue primarily affects the Node driver and its downstream users.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Iftheproblemdoesoccur%2Cwhataretheconsequencesandhowseverearethey%3F&quot;&gt;&lt;/a&gt;If the problem does occur, what are the consequences and how severe are they?&lt;/h4&gt;

&lt;p&gt;Requiring Node to remove &lt;tt&gt;createKey()&lt;/tt&gt; for spec conformance may have undesirable and far-reaching consequences for downstream users of both Node and mongosh.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Isthisissueurgent%3F&quot;&gt;&lt;/a&gt;Is this issue urgent?&lt;/h4&gt;

&lt;p&gt;Somewhat. No actual effort is required by this ticket w.r.t. &lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-1951&quot; title=&quot;Key Management API&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-1951&quot;&gt;&lt;del&gt;DRIVERS-1951&lt;/del&gt;&lt;/a&gt; and &lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-2370&quot; title=&quot;Remove ClientEncryption.createKey() in favor of createDataKey()&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-2370&quot;&gt;&lt;del&gt;DRIVERS-2370&lt;/del&gt;&lt;/a&gt;, but clarity on requirements for the Key Management API by Drivers are important for teams currently implementing it.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Isthisticketrequiredbyadownstreamteam%3F&quot;&gt;&lt;/a&gt;Is this ticket required by a downstream team?&lt;/h4&gt;

&lt;p&gt;Needed by the Node Driver.&lt;/p&gt;
&lt;h4&gt;&lt;a name=&quot;Isthisticketonlyfortests%3F&quot;&gt;&lt;/a&gt;Is this ticket only for tests?&lt;/h4&gt;

&lt;p&gt;No. This impacts the permitted interface for &lt;tt&gt;ClientEncryption&lt;/tt&gt;&#160;as part of the Key Management API.&lt;/p&gt;
&lt;/div&gt;&lt;/div&gt;</description>
                <environment></environment>
        <key id="2077945">DRIVERS-2372</key>
            <summary>Add createKey to ClientEncryption as an optional feature</summary>
                <type id="14901" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14700&amp;avatarType=issuetype">Spec Change</type>
                                            <priority id="10300" iconUrl="https://jira.mongodb.org/images/icons/priorities/medium.svg">Unknown</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="12300">Won&apos;t Do</resolution>
                                        <assignee username="ezra.chung@mongodb.com">Ezra Chung</assignee>
                                    <reporter username="ezra.chung@mongodb.com">Ezra Chung</reporter>
                        <labels>
                    </labels>
                <created>Mon, 27 Jun 2022 22:06:36 +0000</created>
                <updated>Tue, 28 Jun 2022 15:56:14 +0000</updated>
                            <resolved>Tue, 28 Jun 2022 15:55:24 +0000</resolved>
                                                        <component>Client Side Encryption</component>
                                        <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                    <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="1897788">DRIVERS-1951</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="2076603">DRIVERS-2370</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                            <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                    <customfield id="customfield_10951" key="com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons">
                        <customfieldname>Driver Changes</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10940"><![CDATA[Not Needed]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|i0j1o0:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        </customfields>
    </item>
</channel>
</rss>