faraday-net_http 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68682d9505a93d5cc0421b7122a8d3b6e049197e4e871b563b12be8f7f68ca15
-  data.tar.gz: b0b11d54d7d4fb8023b0763508c38a444038a219cc31ba5705e694e9756d5623
+  metadata.gz: 658606c949eb5a714696b89cf5c75cace8c212e9b2df7688ecc5d1bb5ab6442c
+  data.tar.gz: 7f52a4ae649cfd20426dc480511ed77c8fa0a2ad8d52e76d9c851516d356d1e2
 SHA512:
-  metadata.gz: bb892fe233941b262589c18134f1041d63d01ca19c38f583c19bf9562dde269b7714555c5b5f80703f19210aa407b2d4631def6958f958dfefa60a77cf5622d7
-  data.tar.gz: b9179ac1c840a6e01b1f98625132fc913c15beb106112fee48bf29b1d3b5a0d88d54e64eaf6f40c05e669dd6c109ea963165e92adf15a43cfe604f2bd63f7b86
+  metadata.gz: 3f8aa0043df43b4562a9aa1e2d519e2a3a34e93ca30a293f0a84448c123c518c02bafe21ac79bb0f82d7a41e6e76fd53636f1d5b5db1ef53692001d9bcc658a2
+  data.tar.gz: accb8c3da7c1dcf7ebc22d53495d7f438cd1aea2ca625f2d8d5ec22401ddda66e7a013b2bfeffcb3003374f79c18d1c0276be72f117ebb60b57ab8117bfc7d6c

data/README.md

@@ -31,11 +31,44 @@ conn = Faraday.new(...) do |f|
 end
 ```
 
+### Restricting trusted certificate authorities
+
+By default, `ca_file` and `ca_path` add certificate authorities to the system
+trust store. They do not restrict trust to only the supplied authorities.
+To restrict trust, provide an explicit certificate store. An empty store lets
+you trust only the authorities supplied through `ca_file` or `ca_path`:
+
+```ruby
+require 'openssl'
+
+conn = Faraday.new('https://example.com', ssl: {
+  ca_file: '/path/to/trusted-ca.pem',
+  cert_store: OpenSSL::X509::Store.new
+})
+```
+
+Certificate and hostname verification remain enabled. Alternatively, populate
+the explicit store yourself with `add_file` or `add_cert` and omit `ca_file`.
+
+### SOCKS proxy
+
+A `socks://` proxy is supported when the optional [socksify][socksify] gem (`~> 1.8`) is installed. It is not a dependency of this gem, so add it to your Gemfile:
+
+```ruby
+gem 'socksify', '~> 1.8'
+```
+
+```ruby
+conn = Faraday.new(url, proxy: 'socks://user:password@127.0.0.1:1080')
+```
+
+Using a `socks://` proxy without socksify raises a `RuntimeError`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](rubygems).
+To release a new version, update the version number in `version.rb`, then commit and push that to `main` branch. Then, use GitHub Releases to create a matching Release. A GitHub Action will publish the gem to Rubygems.org.
 
 ## Contributing
 
@@ -51,6 +84,7 @@ Everyone interacting in the Faraday Net::HTTP adapter project's codebases, issue
 
 [faraday]: https://github.com/lostisland/faraday
 [net-http]: https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html
+[socksify]: https://github.com/astro/socksify-ruby
 [rubygems]: https://rubygems.org
 [repo]: https://github.com/lostisland/faraday-net_http
 [license]: https://github.com/lostisland/faraday-net_http/blob/main/LICENSE.md

data/lib/faraday/adapter/net_http.rb

@@ -7,6 +7,13 @@ rescue LoadError
     'Make sure openssl is installed if you want ssl support'
   require 'net/http'
 end
+
+begin
+  require 'socksify/http'
+rescue LoadError
+  # socksify is optional and only required when using a SOCKS proxy
+end
+
 require 'zlib'
 
 module Faraday
@@ -27,16 +34,21 @@ module Faraday
         Net::HTTPHeaderSyntaxError,
         Net::ProtocolError,
         SocketError,
-        Zlib::GzipFile::Error
+        Zlib::GzipFile::Error,
+        Zlib::DataError,
+        Zlib::NeedDict,
+        Zlib::BufError
       ]
 
       exceptions << ::OpenSSL::SSL::SSLError if defined?(::OpenSSL::SSL::SSLError)
       exceptions << ::Net::OpenTimeout if defined?(::Net::OpenTimeout)
+      exceptions << ::SOCKSError if defined?(::SOCKSError)
 
       NET_HTTP_EXCEPTIONS = exceptions.freeze
 
       def initialize(app = nil, opts = {}, &block)
         @ssl_cert_store = nil
+        @ssl_cert_store_mutex = Mutex.new
         super(app, opts, &block)
       end
 
@@ -50,7 +62,9 @@ module Faraday
       def net_http_connection(env)
         proxy = env[:request][:proxy]
         port = env[:url].port || (env[:url].scheme == 'https' ? 443 : 80)
-        if proxy
+        if socks_proxy?(proxy)
+          socks_proxy_class(proxy).new(env[:url].hostname, port, nil)
+        elsif proxy
           Net::HTTP.new(env[:url].hostname, port,
                         proxy[:uri].hostname, proxy[:uri].port,
                         proxy[:user], proxy[:password],
@@ -128,6 +142,20 @@ module Faraday
         end
       end
 
+      def socks_proxy?(proxy)
+        proxy && proxy[:uri].scheme == 'socks'
+      end
+
+      def socks_proxy_class(proxy)
+        raise 'SOCKS proxy support requires the socksify gem ~> 1.8' unless Net::HTTP.respond_to?(:socks_proxy)
+
+        # socksify stores its settings on a class shared by every
+        # Net::HTTP.socks_proxy call, so use a subclass to keep proxies isolated.
+        Class.new(Net::HTTP).socks_proxy(proxy[:uri].hostname, proxy[:uri].port,
+                                         username: proxy[:user],
+                                         password: proxy[:password])
+      end
+
       def configure_ssl(http, ssl)
         http.use_ssl = true if http.respond_to?(:use_ssl=)
 
@@ -173,7 +201,9 @@ module Faraday
         return ssl[:cert_store] if ssl[:cert_store]
 
         # Use the default cert store by default, i.e. system ca certs
-        @ssl_cert_store ||= OpenSSL::X509::Store.new.tap(&:set_default_paths)
+        @ssl_cert_store ||= @ssl_cert_store_mutex.synchronize do
+          @ssl_cert_store ||= OpenSSL::X509::Store.new.tap(&:set_default_paths)
+        end
       end
 
       def ssl_verify_mode(ssl)
@@ -188,8 +218,10 @@ module Faraday
 
       def encoded_body(http_response)
         body = http_response.body || +''
-        /\bcharset=([^;]+)/.match(http_response['Content-Type']) do |match|
-          content_charset = ::Encoding.find(match[1].strip)
+        /(?:\A|;)\s*charset=([^;]+)/i.match(http_response['Content-Type']) do |match|
+          charset = match[1].strip
+          charset = charset[1...-1] if charset.start_with?('"') && charset.end_with?('"')
+          content_charset = ::Encoding.find(charset)
           body = body.dup.force_encoding(content_charset)
         rescue ArgumentError
           nil

data/lib/faraday/net_http/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module NetHttp
-    VERSION = '3.4.4'
+    VERSION = '3.5.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-net_http
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Jan van der Pas
@@ -41,7 +41,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/lostisland/faraday-net_http
   source_code_uri: https://github.com/lostisland/faraday-net_http
-  changelog_uri: https://github.com/lostisland/faraday-net_http/releases/tag/v3.4.4
+  changelog_uri: https://github.com/lostisland/faraday-net_http/releases/tag/v3.5.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Faraday adapter for Net::HTTP
 test_files: []