summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurdette Lamar <[email protected]>2023-02-26 07:37:09 -0600
committergit <[email protected]>2023-02-26 13:37:15 +0000
commit6e6992e5db49a238baf290d9b9b521f6b6be5a19 ()
treeb2533a9459f15d76cdea9b90c8e54e214fa92053
parentc8bafc3b01c67cee1b0fd6ef8a2842c172f79ab0 (diff)
[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
(https://.com/ruby/net-http/pull/127) https://.com/ruby/net-http/commit/07b2b88ef5
-rw-r--r--lib/net/http.rb65
1 files changed, 35 insertions, 30 deletions
@@ -1211,62 +1211,64 @@ module Net #:nodoc:
:verify_hostname,
] # :nodoc:
- # Sets path of a CA certification file in PEM format.
- #
- # The file can contain several CA certificates.
attr_accessor :ca_file
- # Sets path of a CA certification directory containing certifications in
- # PEM format.
attr_accessor :ca_path
- # Sets an OpenSSL::X509::Certificate object as client certificate.
- # (This method is appeared in Michal Rokos's OpenSSL extension).
attr_accessor :cert
- # Sets the X509::Store to verify peer certificate.
attr_accessor :cert_store
- # Sets the available ciphers. See OpenSSL::SSL::SSLContext#ciphers=
attr_accessor :ciphers
- # Sets the extra X509 certificates to be added to the certificate chain.
- # See OpenSSL::SSL::SSLContext#extra_chain_cert=
attr_accessor :extra_chain_cert
- # Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
- # (This method is appeared in Michal Rokos's OpenSSL extension.)
attr_accessor :key
- # Sets the SSL timeout seconds.
attr_accessor :ssl_timeout
- # Sets the SSL version. See OpenSSL::SSL::SSLContext#ssl_version=
attr_accessor :ssl_version
- # Sets the minimum SSL version. See OpenSSL::SSL::SSLContext#min_version=
attr_accessor :min_version
- # Sets the maximum SSL version. See OpenSSL::SSL::SSLContext#max_version=
attr_accessor :max_version
- # Sets the verify callback for the server certification verification.
attr_accessor :verify_callback
- # Sets the maximum depth for the certificate chain verification.
attr_accessor :verify_depth
- # Sets the flags for server the certification verification at beginning of
- # SSL/TLS session.
- #
# OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.
attr_accessor :verify_mode
- # Sets to check the server certificate is valid for the hostname.
- # See OpenSSL::SSL::SSLContext#verify_hostname=
attr_accessor :verify_hostname
- # The X509 certificate chain (an array of strings) for the session's socket peer,
# or +nil+ if none.
def peer_cert
if not use_ssl? or not @socket
@@ -1497,17 +1499,20 @@ module Net #:nodoc:
defined?(@is_proxy_class) ? @is_proxy_class : false
end
- # Address of proxy host. If \Net::HTTP does not use a proxy, nil.
attr_reader :proxy_address
- # Port number of proxy host. If \Net::HTTP does not use a proxy, nil.
attr_reader :proxy_port
- # User name for accessing proxy. If \Net::HTTP does not use a proxy, nil.
attr_reader :proxy_user
- # User password for accessing proxy. \If Net::HTTP does not use a proxy,
- # nil.
attr_reader :proxy_pass
end