Class: Faraday::SSLOptions

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

Overview

SSL-related options.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#ca_file ⇒ String

Returns CA file.

Returns:

  • (String) —

    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.

Returns:

  • (String) —

    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.

Returns:

  • (OpenSSL::X509::Store) —

    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).

Returns:

  • (OpenSSL::X509::Certificate) —

    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.

Returns:

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

    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.

Returns:

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

    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).

Returns:



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).

Returns:



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).

Returns:

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

    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.

Returns:

  • (Boolean) —

    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.

Returns:

  • (Integer) —

    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).

Returns:



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).

Returns:



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.

Returns:

  • (Boolean) —

    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.

Returns:

  • (Boolean) —

    true if should verify



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

def verify?
  verify != false
end