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_file ⇒ String

Returns CA file.

Returns:

  • (String) —

    CA file



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#ca_path ⇒ String

Returns CA path.

Returns:

  • (String) —

    CA path



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#cert_store ⇒ OpenSSL::X509::Store

Returns certificate store.

Returns:

  • (OpenSSL::X509::Store) —

    certificate store



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#certificate ⇒ OpenSSL::X509::Certificate

Returns certificate (Excon only).

Returns:

  • (OpenSSL::X509::Certificate) —

    certificate (Excon only)



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

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

Returns client certificate.

Returns:

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

    client certificate



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#client_key ⇒ String, ...

Returns client key.

Returns:

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

    client key



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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)



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#verify ⇒ Boolean

Returns whether to verify SSL certificates or not.

Returns:

  • (Boolean) —

    whether to verify SSL certificates or not



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end

#verify_depth ⇒ Integer

Returns maximum depth for the certificate chain verification.

Returns:

  • (Integer) —

    maximum depth for the certificate chain verification



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
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:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/faraday/options/ssl_options.rb', line 56

SSLOptions = Options.new(:verify, :verify_hostname, :hostname,
                         :ca_file, :ca_path, :verify_mode,
                         :cert_store, :client_cert, :client_key,
                         :certificate, :private_key, :verify_depth,
                         :version, :min_version, :max_version, :ciphers) do
  # @return [Boolean] true if should verify
  def verify?
    verify != false
  end

  # @return [Boolean] true if should not verify
  def disable?
    !verify?
  end

  # @return [Boolean] true if should verify_hostname
  def verify_hostname?
    verify_hostname != false
  end
end