Class: Faraday::SSLOptions
- Inherits:
-
Object
- Object
- Faraday::SSLOptions
- Defined in:
- lib/faraday/options/ssl_options.rb
Overview
SSL-related options.
Instance Attribute Summary collapse
-
#ca_file ⇒ String
CA file.
-
#ca_path ⇒ String
CA path.
-
#cert_store ⇒ OpenSSL::X509::Store
Certificate store.
-
#certificate ⇒ OpenSSL::X509::Certificate
Certificate (Excon only).
-
#client_cert ⇒ String, OpenSSL::X509::Certificate
Client certificate.
-
#client_key ⇒ String, ...
Client key.
-
#max_version ⇒ String, Symbol
Maximum SSL version (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D).
-
#min_version ⇒ String, Symbol
Minimum SSL version (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D).
-
#private_key ⇒ OpenSSL::PKey::RSA, OpenSSL::PKey::DSA
Private key (Excon only).
-
#verify ⇒ Boolean
Whether to verify SSL certificates or not.
-
#verify_depth ⇒ Integer
Maximum depth for the certificate chain verification.
-
#verify_mode ⇒ Integer
Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html).
- #version ⇒ String, Symbol
Instance Method Summary collapse
-
#disable? ⇒ Boolean
True if should not verify.
-
#verify? ⇒ Boolean
True if should verify.
Instance Attribute Details
#ca_file ⇒ String
Returns CA file.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#ca_path ⇒ String
Returns CA path.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#cert_store ⇒ OpenSSL::X509::Store
Returns certificate store.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#certificate ⇒ OpenSSL::X509::Certificate
Returns certificate (Excon only).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#client_cert ⇒ String, OpenSSL::X509::Certificate
Returns client certificate.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#client_key ⇒ String, ...
Returns client key.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#max_version ⇒ String, Symbol
Returns maximum SSL version (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#min_version ⇒ String, Symbol
Returns minimum SSL version (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#private_key ⇒ OpenSSL::PKey::RSA, OpenSSL::PKey::DSA
Returns private key (Excon only).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#verify ⇒ Boolean
Returns whether to verify SSL certificates or not.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#verify_depth ⇒ Integer
Returns maximum depth for the certificate chain verification.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#verify_mode ⇒ Integer
Returns Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
#version ⇒ String, Symbol
Returns SSL version (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/faraday/options/ssl_options.rb', line 44 class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode, :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth, :version, :min_version, :max_version) # @return [Boolean] true if should verify def verify? verify != false end # @return [Boolean] true if should not verify def disable? !verify? end end |
Instance Method Details
#disable? ⇒ Boolean
Returns true if should not verify.
55 56 57 |
# File 'lib/faraday/options/ssl_options.rb', line 55 def disable? !verify? end |
#verify? ⇒ Boolean
Returns true if should verify.
50 51 52 |
# File 'lib/faraday/options/ssl_options.rb', line 50 def verify? verify != false end |