-
Type: Task
-
Resolution: Fixed
-
Priority: Major - P3
-
Affects Version/s: None
-
Component/s: manual
-
Labels:None
Documentation Request Summary:
This implements the user-facing piece of PM-305's certificate selector specification. Apple and Windows implementations still need to handle the values which will come in later commits.
Engineering Ticket Description:
The new option will be called a “Certificate Selector” for each option used to read a PEM file today. No new options will be used to read CA certs or CRL lists as these will be retrieved from the system certificate store by the native SSL library automatically. Both platforms will check OCSP for CRLs.
Existing Option | New Option | Config Name |
---|---|---|
sslPEMKeyFile | sslCertificateSelector | net.ssl.CertificateSelector |
sslClusterFile | sslClusterCertificateSelector | net.ssl.ClusterCertificateSelector |
kmipClientCertificateFile | kmipClientCertificateSelector | security.kmip.ClientCertificateSelector |
It is a startup error to specify a certificate selector and file for the same parameter.
The format of the certificate selector is:
<certificate property>=<value>
The following certificate properties are supported:
Property | Value | Description |
---|---|---|
subject | An ASCII string | Matches Subject Name |
thumbprint | Hex string | Matches Thumbprint |
serial | Hex string | Matches Serial Number |
The property names are case-sensitive. For subject name, the match is exact, case-sensitive string match. Only one property may be specified in a search. In the case of two or more certificates matching the same search criteria, the certificate returned is undefined, and depends on the OS behavior.
Scope of changes:
The approach will be to add a reference to the Apple/Windows options everytime we reference configuring a .pem file. Possible implicated files are:
https://docs.mongodb.com/manual/tutorial/configure-ssl/
https://docs.mongodb.com/manual/tutorial/configure-ssl-clients/index.html
https://docs.mongodb.com/manual/tutorial/upgrade-cluster-to-ssl/index.html
Impact to other docs outside of this product:
MVP:
Resources:
- documents
-
SERVER-32980 Add certificate selector command-line/config options.
- Closed
- is duplicated by
-
DOCS-11522 Docs for SERVER-34139: Add certificate selector support for Apple Secure Transport
- Closed
- related to
-
DOCS-11526 Docs for SERVER-33832: Change Windows SSL and Enterprise builds to SChannel
- Closed