<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:02:42 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>[DOCS-11384] Docs for SERVER-32974: Enhance createUser and updateUser to support SCRAM-SHA-256</title>
                <link>https://jira.mongodb.org/browse/DOCS-11384</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;h1&gt;&lt;a name=&quot;DocumentationRequestSummary%3A&quot;&gt;&lt;/a&gt;Documentation Request Summary:&lt;/h1&gt;

&lt;p&gt;createUser/updateUser support a &quot;passwordDigestor&quot; parameter. The default value for this in 3.6 and earlier was &quot;client&quot;. This has now been changed to &quot;server&quot;.&lt;/p&gt;

&lt;p&gt;Users requiring client-side digest should pass `&lt;/p&gt;

{ passwordDigestor: &apos;client&apos; }

&lt;p&gt;` to retain the old behavior, however this usage is not compatible with SCRAM-SHA-256.&lt;/p&gt;
&lt;h1&gt;&lt;a name=&quot;Scope&quot;&gt;&lt;/a&gt;Scope&lt;/h1&gt;
&lt;ul&gt;
	&lt;li&gt;Add &lt;tt&gt;passwordDigestor&lt;/tt&gt; &lt;img class=&quot;emoticon&quot; src=&quot;https://jira.mongodb.org/images/icons/emoticons/check.png&quot; height=&quot;16&quot; width=&quot;16&quot; align=&quot;absmiddle&quot; alt=&quot;&quot; border=&quot;0&quot;/&gt; and &lt;tt&gt;mechanisms&lt;/tt&gt; &lt;img class=&quot;emoticon&quot; src=&quot;https://jira.mongodb.org/images/icons/emoticons/check.png&quot; height=&quot;16&quot; width=&quot;16&quot; align=&quot;absmiddle&quot; alt=&quot;&quot; border=&quot;0&quot;/&gt; in shell helpers
	&lt;ul&gt;
		&lt;li&gt;source/reference/method/db.createUser.txt&lt;/li&gt;
		&lt;li&gt;source/reference/method/db.updateUser.txt&lt;/li&gt;
		&lt;li&gt;source/reference/command/createUser.txt&lt;/li&gt;
		&lt;li&gt;source/reference/command/updateUser.txt&lt;/li&gt;
		&lt;li&gt;source/includes/apiargs-dbcommand-createUser-field.yaml&lt;/li&gt;
		&lt;li&gt;source/includes/apiargs-dbcommand-updateUser-field.yaml&lt;/li&gt;
		&lt;li&gt;source/reference/system-users-collection.txt&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
	&lt;li&gt;Add examples to db.createUser and db.updateUser &lt;img class=&quot;emoticon&quot; src=&quot;https://jira.mongodb.org/images/icons/emoticons/check.png&quot; height=&quot;16&quot; width=&quot;16&quot; align=&quot;absmiddle&quot; alt=&quot;&quot; border=&quot;0&quot;/&gt;&lt;/li&gt;
&lt;/ul&gt;


&lt;h1&gt;&lt;a name=&quot;EngineeringTicketDescription%3A&quot;&gt;&lt;/a&gt;Engineering Ticket Description:&lt;/h1&gt;

&lt;p&gt;Add the string &quot;SCRAM-SHA-256&quot; to the authenticationMechanisms setParameter.&lt;/p&gt;

&lt;p&gt;Both createUser and updateUser will be given a new optional argument, named mechanisms which will accept an Array of Strings. &#8220;SCRAM-SHA-1&#8221; and &#8220;SCRAM-SHA-256&#8221; are permissible values in this Array. This flag allows administrators to control which mechanisms may be used to authenticate as a specified user. Administrators testing their applications or attempting to meet compliance goals may configure users to support different subsets of mechanisms, or remove support for particular mechanisms.&lt;/p&gt;

&lt;p&gt;The mechanisms flag may only be used when FCV is 3.7. createUser and updateUser will only produce SCRAM-SHA-1 credentials when the FCV is not 3.7.&lt;/p&gt;

&lt;p&gt;When either createUser or updateUser would generate a user document containing SCRAM-SHA-256 credentials, they shall ensure that the user&apos;s username has been prepared as a stored string with SASLPrep. If the username has not been properly prepared, the command shall return an error. If the server is not in FCV 3.7, but the server would generate SCRAM-SHA-256 credentials otherwise, these commands will still return an error if the provided user name has not been properly prepared.&lt;/p&gt;

&lt;p&gt;Invocations with password and mechanism&lt;br/&gt;
 When mechanisms is provided to a createUser invocation with a password, the command will use the provided password to generate user documents containing credentials for the specified mechanism(s). The mechanisms in the mechanisms field must be a subset of the mechanisms enumerated in the authenticationMechanisms setParameter.&lt;/p&gt;

&lt;p&gt;When mechanisms is provided to an updateUser invocation containing a password, the command will use the password to generate credentials for the specified mechanism(s) and replace the user document&#8217;s existing credentials with them. If a specified mechanism is unrecognized, the command will fail with an error without modifying the user&#8217;s document. The mechanisms in the mechanisms field must be a subset of the mechanisms enumerated in the authenticationMechanisms setParameter.&lt;/p&gt;

&lt;p&gt;Invocations with password only&lt;br/&gt;
 When createUser or updateUser are invoked with a password and without the mechanisms field, the commands will use the provided password to generate user documents containing credentials for all mechanisms enumerated in the authenticationMechanisms setParameter, if the server&apos;s current FCV is 3.7. Otherwise, the generated user documents will only contain credentials for SCRAM-SHA-1.&lt;/p&gt;

&lt;p&gt;Invocations with mechanism only&lt;br/&gt;
 When mechanisms is provided to updateUser without a password, if the listed mechanisms are a subset of the mechanisms supported by the target user&#8217;s credentials, all mechanisms not listed will be removed from the user&apos;s credentials. If the mechanisms field is empty or not a subset, an error will be emitted and the user shall be left unmodified. If the mechanisms field contains unrecognized mechanisms, the command shall fail with an error if the unrecognized mechanisms are not supported by the target user&#8217;s credentials. If the mechanisms field only contains unrecognized fields, the command shall fail with an error.&lt;/p&gt;</description>
                <environment></environment>
        <key id="504812">DOCS-11384</key>
            <summary>Docs for SERVER-32974: Enhance createUser and updateUser to support SCRAM-SHA-256</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</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="13201">Fixed</resolution>
                                        <assignee username="kay.kim@mongodb.com">Kay Kim</assignee>
                                    <reporter username="kay.kim@mongodb.com">Kay Kim</reporter>
                        <labels>
                    </labels>
                <created>Fri, 2 Mar 2018 17:56:41 +0000</created>
                <updated>Sun, 29 Oct 2023 13:58:17 +0000</updated>
                            <resolved>Thu, 10 May 2018 16:21:29 +0000</resolved>
                                                    <fixVersion>3.7.3</fixVersion>
                                        <due></due>
                            <votes>0</votes>
                                    <watches>1</watches>
                                                                                                                <comments>
                            <comment id="1888216" author="xgen-internal-githook" created="Thu, 10 May 2018 16:06:41 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;kay&apos;, &apos;email&apos;: &apos;kay.kim@10gen.com&apos;, &apos;username&apos;: &apos;kay-kim&apos;}
&lt;p&gt;Message: DOCS-11535,&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-11384&quot; title=&quot;Docs for SERVER-32974: Enhance createUser and updateUser to support SCRAM-SHA-256&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-11384&quot;&gt;&lt;del&gt;DOCS-11384&lt;/del&gt;&lt;/a&gt;,&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-11280&quot; title=&quot;Create scramSHA256IterationCount setParameter (SERVER-33012)&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-11280&quot;&gt;&lt;del&gt;DOCS-11280&lt;/del&gt;&lt;/a&gt;: SCRAM-SHA-256, iteration count param, create/update Users mechanisms and digestor&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/f94a84f6fe1a3317d3c39b5ccab40d4c3d95359c&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/f94a84f6fe1a3317d3c39b5ccab40d4c3d95359c&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10320">
                    <name>Documented</name>
                                            <outwardlinks description="documents">
                                        <issuelink>
            <issuekey id="488891">SERVER-32974</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="520991">DOCS-11530</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                                        </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Thu, 10 May 2018 16:06:41 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        5 years, 39 weeks, 6 days ago
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18254" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Dependencies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[]]></customfieldvalue>


                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10857" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>DOCS-11003</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10057" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comment by Customer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10056" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last commenter</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>luke.bonanomi@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            5 years, 39 weeks, 6 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>kay.kim@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|htrjzz:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|htiy3j:</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>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10053" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time In Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_14350" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>serverRank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|htr66f:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                </customfields>
    </item>
</channel>
</rss>