Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-5376

Remove Deprecated SSL Options

    • 2
    • Needed
    • Needed
    • Hide

      1. What would you like to communicate to the user about this feature?

      We've removed support for the listed options in favor of the tls-* variants. See the table here: https://github.com/mongodb/node-mongodb-native/pull/3743

      The non standard tlsCertificateFile has been removed, users should use tlsCertificateKeyFile, note the documentation from the driver specification:

      Path to the client certificate file or the client private key file; in the case that they both are needed, the files should be concatenated

      2. Would you like the user to see examples of the syntax and/or executable code and its output?

      We should remove tlsCertificateFile from:
      https://www.mongodb.com/docs/drivers/node/current/fundamentals/connection/tls/#provide-certificate-filepaths

      I think the advice to use node's secureContext and reading in file contents remains correct and the better approach if you need to specify certificate and key and have the data for each in a separate file.

      3. Which versions of the driver/connector does this apply to?

      v6.0.0, next major version, this is a breaking change.

      Show
      1. What would you like to communicate to the user about this feature? We've removed support for the listed options in favor of the tls-* variants. See the table here: https://github.com/mongodb/node-mongodb-native/pull/3743 The non standard tlsCertificateFile has been removed, users should use tlsCertificateKeyFile, note the documentation from the driver specification: Path to the client certificate file or the client private key file; in the case that they both are needed, the files should be concatenated 2. Would you like the user to see examples of the syntax and/or executable code and its output? We should remove tlsCertificateFile from: https://www.mongodb.com/docs/drivers/node/current/fundamentals/connection/tls/#provide-certificate-filepaths I think the advice to use node's secureContext and reading in file contents remains correct and the better approach if you need to specify certificate and key and have the data for each in a separate file. 3. Which versions of the driver/connector does this apply to? v6.0.0, next major version, this is a breaking change.

      Use Case

      As a... developer
      I want... spec compliant TLS options
      So that... I have expected TLS connection behaviour.

      User Impact

      None

      Dependencies

      None

      Unknowns

      None

      Acceptance Criteria

      Implementation Requirements

      Remove the following deprecated options from the MongoClient and connection string:

      • sslCA
      • sslCRL
      • sslCert
      • sslKey
      • sslPass
      • sslValidate
      • tlsCertificateFile

      Testing Requirements

      Remove any tests specifically testing these options.

      Documentation Requirements

      • Remove any references in documentation
        • API docs on individual options
        • Table that documents all the SSL and TLS options
        • Official documentation (manual)
      • Add section to the migration guide.

      Follow Up Requirements

      None

            Assignee:
            durran.jordan@mongodb.com Durran Jordan
            Reporter:
            durran.jordan@mongodb.com Durran Jordan
            Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: