castle-rb 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d6aa4996eb091692c0a7dfcf9658b2b26fb011cfa94103604a79e60d401ac0
-  data.tar.gz: 8e7eb4c21cf3edd7a3845fc946857dd25ad1031d75dfa8cf8cb8b911b928eebe
+  metadata.gz: 9e257285772f0ea234bc5ffce99cfccabdd31205c9bd09c6b210f633ea691728
+  data.tar.gz: dbe175f86dc14f5e246e502452ff7e65de27dc82966428262f440e8acbfcf295
 SHA512:
-  metadata.gz: 9bdf75588225fd282a36d1e37c1ee3eb69ecfab3f3e50a2c27d695f8c7c7ad1a2bccdb8b097dbe9ff361c17481c9449808d9c26adf56924eb249a18ffb2e9a71
-  data.tar.gz: '089b2507cd099a863b9592c8a194f5971f2126a7ff2892d0f211ace1a9b06261872a9a13d98a72b617f59815d70d87a4c49ca9e348c06031554a3a8cbe905140'
+  metadata.gz: a25b09f89b7d0b589b215e58bfd2b3436954da93a99d141e1dc7282b8350480a289e1b852b1cd5afdcf8f0a924b0b6062771da73ba6ad6c10fd179b214de2c59
+  data.tar.gz: faa3a957367aaad5e16bb9330b7a63e7ca607468f8e46ba75f99fce05b328bccfa59d2908051b3488605cb9517c7f6f3cf4f6d1a98d7fa68df9a569a9f60d3a5

data/README.md

@@ -87,12 +87,12 @@ Castle.configure do |config|
   config.blacklisted = ['HTTP-X-header']
 
   # Castle needs the original IP of the client, not the IP of your proxy or load balancer.
-  # we try to fetch proper ip based on X-Forwarded-For, X-Client-Id or Remote-Addr headers in that order
+  # we try to fetch proper ip based on X-Forwarded-For or Remote-Addr headers in that order
   # but sometimes proper ip may be stored in different header or order could be different.
   # SDK can extract ip automatically for you, but you must configure which ip_headers you would like to use
   configuration.ip_headers = []
 
-  # Additionally to make X-Forwarded-For or X-Client-Id work better discovering client ip address,
+  # Additionally to make X-Forwarded-For and other headers work better discovering client ip address,
   # and not the address of a reverse proxy server, you can define trusted proxies
   # which will help to fetch proper ip from those headers
   configuration.trusted_proxies = []

data/lib/castle/extractors/ip.rb

@@ -5,43 +5,39 @@ module Castle
     # used for extraction of ip from the request
     class IP
       # ordered list of ip headers for ip extraction
-      DEFAULT = %w[X-Forwarded-For Client-Ip Remote-Addr].freeze
-      # default header fallback when ip is not found
-      FALLBACK = 'Remote-Addr'
+      DEFAULT = %w[X-Forwarded-For Remote-Addr].freeze
 
-      private_constant :FALLBACK, :DEFAULT
+      private_constant :DEFAULT
 
       # @param headers [Hash]
       def initialize(headers)
         @headers = headers
-        @ip_headers = Castle.config.ip_headers + DEFAULT
+        @ip_headers = Castle.config.ip_headers.empty? ? DEFAULT : Castle.config.ip_headers
         @proxies = Castle.config.trusted_proxies + Castle::Configuration::TRUSTED_PROXIES
       end
 
       # Order of headers:
       #   .... list of headers defined by ip_headers
       #   X-Forwarded-For
-      #   Client-Ip is
       #   Remote-Addr
       # @return [String]
       def call
+        all_ips = []
+
         @ip_headers.each do |ip_header|
-          ip_value = calculate_ip(ip_header)
+          ips = ips_from(ip_header)
+          ip_value = remove_proxies(ips).last
           return ip_value if ip_value
+
+          all_ips.push(*ips)
         end
 
-        @headers[FALLBACK]
+        # fallback to first whatever ip
+        all_ips.first
       end
 
       private
 
-      # @param header [String]
-      # @return [String]
-      def calculate_ip(header)
-        ips = ips_from(header)
-        remove_proxies(ips).first
-      end
-
       # @param ips [Array<String>]
       # @return [Array<String>]
       def remove_proxies(ips)
@@ -61,7 +57,7 @@ module Castle
 
         return [] unless value
 
-        value.strip.split(/[,\s]+/).reverse
+        value.strip.split(/[,\s]+/)
       end
     end
   end

data/lib/castle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Castle
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

data/spec/lib/castle/extractors/ip_spec.rb

@@ -21,20 +21,20 @@ describe Castle::Extractors::IP do
       end
 
       context 'with uppercase format' do
-        before { Castle.config.ip_headers = %w[CF_CONNECTING_IP] }
+        before { Castle.config.ip_headers = %w[CF_CONNECTING_IP X-Forwarded-For] }
 
         it { expect(extractor.call).to eql('1.2.3.4') }
       end
 
       context 'with regular format' do
-        before { Castle.config.ip_headers = %w[Cf-Connecting-Ip] }
+        before { Castle.config.ip_headers = %w[Cf-Connecting-Ip X-Forwarded-For] }
 
         it { expect(extractor.call).to eql('1.2.3.4') }
       end
 
-      context 'with value from trusted proxies' do
+      context 'with value from trusted proxies it get seconds header' do
         before do
-          Castle.config.ip_headers = %w[Cf-Connecting-Ip]
+          Castle.config.ip_headers = %w[Cf-Connecting-Ip X-Forwarded-For]
           Castle.config.trusted_proxies = %w[1.2.3.4]
         end
 
@@ -49,7 +49,7 @@ describe Castle::Extractors::IP do
 
       let(:headers) { { 'Remote-Addr' => '127.0.0.1', 'X-Forwarded-For' => http_x_header } }
 
-      it 'fallbacks to remote_addr even if trusted proxy' do
+      it 'fallbacks to first available header when all headers are marked trusted proxy' do
         expect(extractor.call).to eql('127.0.0.1')
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Johan Brissmyr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal