Class: Faraday::SSLOptions

Inherits:
Options
  • Object
show all
Defined in:
lib/faraday/options/ssl_options.rb

Overview

SSL-related options.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Options

#[], attribute_options, #clear, #deep_dup, #delete, #each, #each_key, #each_value, #empty?, #fetch, fetch_error_class, from, inherited, #inspect, #key?, #keys, memoized, memoized_attributes, #merge, #merge!, options, options_for, #symbolized_key_set, #to_hash, #update, #value?, #values_at

Instance Attribute Details

#ca_fileString

Returns CA file.

Returns:

  • (String)

    CA file



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#ca_pathString

Returns CA path.

Returns:

  • (String)

    CA path



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#cert_storeOpenSSL::X509::Store

Returns certificate store.

Returns:

  • (OpenSSL::X509::Store)

    certificate store



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#certificateOpenSSL::X509::Certificate

Returns certificate (Excon only).

Returns:

  • (OpenSSL::X509::Certificate)

    certificate (Excon only)



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#client_certString, OpenSSL::X509::Certificate

Returns client certificate.

Returns:

  • (String, OpenSSL::X509::Certificate)

    client certificate



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#client_keyString, ...

Returns client key.

Returns:

  • (String, OpenSSL::PKey::RSA, OpenSSL::PKey::DSA)

    client key



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#max_versionString, Symbol



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#min_versionString, Symbol



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#private_keyOpenSSL::PKey::RSA, OpenSSL::PKey::DSA

Returns private key (Excon only).

Returns:

  • (OpenSSL::PKey::RSA, OpenSSL::PKey::DSA)

    private key (Excon only)



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#verifyBoolean

Returns whether to verify SSL certificates or not.

Returns:

  • (Boolean)

    whether to verify SSL certificates or not



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#verify_depthInteger

Returns maximum depth for the certificate chain verification.

Returns:

  • (Integer)

    maximum depth for the certificate chain verification



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#verify_hostnameBoolean

Returns whether to enable hostname verification on server certificates during the handshake or not (see github.com/ruby/openssl/pull/60).

Returns:



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#verify_modeInteger

Returns Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html).

Returns:



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end

#versionString, Symbol



45
# File 'lib/faraday/options/ssl_options.rb', line 45

class SSLOptions < Options; end