Skip to content

Commit 5119ada

Browse files
p-mongop
andauthored
RUBY-2359 Implement OCSP URI options (#2058)
Co-authored-by: Oleg Pudeyev <[email protected]>
1 parent 03b976c commit 5119ada

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

source/tutorials/ruby-driver-create-client.txt

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -583,10 +583,12 @@ Ruby Options
583583
- none
584584

585585
* - ``:ssl_verify``
586-
- Whether to perform peer certificate validation and hostname verification. Note that
587-
the decision of whether to validate certificates will be overridden if
588-
:ssl_verify_certificate is set, and the decision of whether to validate hostnames will be
589-
overridden if :ssl_verify_hostname is set.
586+
- Whether to perform peer certificate, hostname and OCSP endpoint
587+
validation. Note that the decision of whether to validate certificates
588+
will be overridden if ``:ssl_verify_certificate`` is set, the decision
589+
of whether to validate hostnames will be overridden if
590+
``:ssl_verify_hostname`` is set and the decision of whether to validate
591+
OCSP endpoint will be overridden if ``:ssl_verify_ocsp_endpoint`` is set.
590592
- ``Boolean``
591593
- true
592594

@@ -597,8 +599,16 @@ Ruby Options
597599
- true
598600

599601
* - ``:ssl_verify_hostname``
600-
- Whether to perform peer hostname validation. This setting overrides :ssl_verify with
601-
respect to whether hostname validation is performed.
602+
- Whether to perform peer hostname validation. This setting overrides
603+
:ssl_verify with respect to whether hostname validation is performed.
604+
- ``Boolean``
605+
- true
606+
607+
* - ``:ssl_verify_ocsp_endpoint``
608+
- Whether to validate server-supplied certificate against the OCSP
609+
endpoint specified in the certificate, if the OCSP endpoint is specified
610+
in the certificate. This setting overrides :ssl_verify with respect to
611+
whether OCSP endpoint validation is performed.
602612
- ``Boolean``
603613
- true
604614

@@ -649,6 +659,11 @@ Ruby Options
649659
- ``Integer``
650660
- none
651661

662+
.. note::
663+
664+
The Ruby driver does not implement certificate revocation list (CRL)
665+
checking.
666+
652667

653668
URI Options
654669
```````````
@@ -820,6 +835,14 @@ URI options are explained in detail in the :manual:`Connection URI reference
820835
* - tlsCertificateKeyFilePassword=String
821836
- ``:ssl_key_pass_phrase => String``
822837

838+
* - tlsDisableOCSPEndpointCheck=Boolean
839+
- ``:ssl_verify_ocsp_endpoint => boolean``
840+
841+
Because ``tlsDisableOCSPEndpointCheck`` uses ``true`` to signify that
842+
verification should be disabled and ``ssl_verify_ocsp_endpoint`` uses
843+
``false`` to signify that verification should be disabled, the boolean
844+
is inverted before being used to set ``ssl_verify_ocsp_endpoint``.
845+
823846
* - tlsInsecure=Boolean
824847
- ``:ssl_verify => boolean``
825848

@@ -839,6 +862,15 @@ URI options are explained in detail in the :manual:`Connection URI reference
839862
* - zlibCompressionLevel=Integer
840863
- ``:zlib_compression_level => Integer``
841864

865+
.. note::
866+
867+
The Ruby driver only fails connections when it receives a definitive signed
868+
response indicating that the server's certificate has been revoked.
869+
Because of this, the driver does not recognize the
870+
``tlsDisableCertificateRevocationCheck`` URI option. If this option is
871+
provided in a URI, it will be ignored.
872+
873+
842874
Timeout Options
843875
===============
844876

0 commit comments

Comments
 (0)