Class: Faraday::SSLOptions

Inherits:

Options

• Object
• Struct
• Options
• Faraday::SSLOptions

Defined in:

lib/faraday/options/ssl_options.rb

Overview

SSL-related options.

Instance Attribute Summary

• #ca_file ⇒ String

  CA file.

• #ca_path ⇒ String

  CA path.

• #cert_store ⇒ OpenSSL::X509::Store

  Certificate store.

• #certificate ⇒ OpenSSL::X509::Certificate

  Certificate (Excon only).

• #ciphers ⇒ String

  Cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D).

• #client_cert ⇒ String, OpenSSL::X509::Certificate

  Client certificate.

• #client_key ⇒ String, ...

  Client key.

• #hostname ⇒ String

  Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D).

• #max_version ⇒ String, Symbol

  Maximum SSL version (see https://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 https://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_hostname ⇒ Boolean

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

• #verify_mode ⇒ Integer

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

• #version ⇒ String, Symbol

  SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D).

Method Summary

Methods inherited from Options

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

Instance Attribute Details

#ca_file ⇒ String

Returns CA file.

Returns:

• (String) —

  CA file

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

class SSLOptions < Options; end

#ca_path ⇒ String

Returns CA path.

Returns:

• (String) —

  CA path

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

class SSLOptions < Options; end

#cert_store ⇒ OpenSSL::X509::Store

Returns certificate store.

Returns:

• (OpenSSL::X509::Store) —

  certificate store

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

class SSLOptions < Options; end

#certificate ⇒ OpenSSL::X509::Certificate

Returns certificate (Excon only).

Returns:

• (OpenSSL::X509::Certificate) —

  certificate (Excon only)

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

class SSLOptions < Options; end

#ciphers ⇒ String

Returns cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D).

Returns:

• (String) —

  cipher list in OpenSSL format (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D)

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

class SSLOptions < Options; end

#client_cert ⇒ String, OpenSSL::X509::Certificate

Returns client certificate.

Returns:

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

  client certificate

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

class SSLOptions < Options; end

#client_key ⇒ String, ...

Returns client key.

Returns:

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

  client key

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

class SSLOptions < Options; end

#hostname ⇒ String

Returns Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D).

Returns:

• (String) —

  Server hostname used for SNI (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D)

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

class SSLOptions < Options; end

#max_version ⇒ String, Symbol

Returns maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D).

Returns:

• (String, Symbol) —

  maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)

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

class SSLOptions < Options; end

#min_version ⇒ String, Symbol

Returns minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D).

Returns:

• (String, Symbol) —

  minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D)

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

class SSLOptions < Options; end

#private_key ⇒ OpenSSL::PKey::RSA, OpenSSL::PKey::DSA

Returns private key (Excon only).

Returns:

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

  private key (Excon only)

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

class SSLOptions < Options; end

#verify ⇒ Boolean

Returns whether to verify SSL certificates or not.

Returns:

• (Boolean) —

  whether to verify SSL certificates or not

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

class SSLOptions < Options; end

#verify_depth ⇒ Integer

Returns maximum depth for the certificate chain verification.

Returns:

• (Integer) —

  maximum depth for the certificate chain verification

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

class SSLOptions < Options; end

#verify_hostname ⇒ Boolean

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

Returns:

• (Boolean) —

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

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

class SSLOptions < Options; end

#verify_mode ⇒ Integer

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

Returns:

• (Integer) —

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

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

class SSLOptions < Options; end

#version ⇒ String, Symbol

Returns SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D).

Returns:

• (String, Symbol) —

  SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D)

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

class SSLOptions < Options; end