Module: Excon::Utils

Extended by:
Utils
Included in:
Connection, Socket, Utils
Defined in:
lib/excon/utils.rb

Constant Summary collapse

CONTROL = 
(0x0..0x1f).map {|c| c.chr }.join + "\x7f"
DELIMS = 
'<>#%"'
UNWISE = 
'{}|\\^[]`'
NONASCII = 
(0x80..0xff).map {|c| c.chr }.join
UNESCAPED = 
/([#{ Regexp.escape(CONTROL + ' ' + DELIMS + UNWISE + NONASCII) }])/
ESCAPED = 
/%([0-9a-fA-F]{2})/

Instance Method Summary collapse

Instance Method Details

#binary_encode(string) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/excon/utils.rb', line 13

def binary_encode(string)
  if FORCE_ENC && string.encoding != Encoding::ASCII_8BIT
    if string.frozen?
      string.dup.force_encoding('BINARY')
    else
      string.force_encoding('BINARY')
    end
  else
    string
  end
end

#connection_uri(datum = @data) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/excon/utils.rb', line 25

def connection_uri(datum = @data)
  unless datum
    raise ArgumentError, '`datum` must be given unless called on a Connection'
  end
  if datum[:scheme] == UNIX
    "#{datum[:scheme]}://#{datum[:socket]}"
  else
    "#{datum[:scheme]}://#{datum[:host]}#{port_string(datum)}"
  end
end

#default_port?(datum) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
76
 
# File 'lib/excon/utils.rb', line 72

def default_port?(datum)
  (!datum[:scheme]&.casecmp?('unix') && datum[:port].nil?) ||
    (datum[:scheme]&.casecmp?('http') && datum[:port] == 80) ||
    (datum[:scheme]&.casecmp?('https') && datum[:port] == 443)
end

#escape_uri(str) ⇒ Object

Escapes HTTP reserved and unwise characters in str



110
111
112
113
114
 
# File 'lib/excon/utils.rb', line 110

def escape_uri(str)
  str = str.dup
  str = binary_encode(str)
  str.gsub(UNESCAPED) { "%%%02X" % $1[0].ord }
end

#headers_hash_to_s(headers) ⇒ Object

Performs validation on the passed header hash and returns a string representation of the headers



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/excon/utils.rb', line 132

def headers_hash_to_s(headers)
  headers_str = String.new
  headers.each do |key, values|
    if key.to_s.match(/[\r\n]/)
      raise Excon::Errors::InvalidHeaderKey.new(key.to_s.inspect + ' contains forbidden "\r" or "\n"')
    end
    [values].flatten.each do |value|
      if value.to_s.match(/[\r\n]/)
        # Don't include the potentially sensitive header value (i.e. authorization token) in the message
        raise Excon::Errors::InvalidHeaderValue.new(key.to_s + ' header value contains forbidden "\r" or "\n"')
      end
      headers_str << key.to_s << ': ' << value.to_s << CR_NL
    end
  end
  headers_str
end

#port_string(datum) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/excon/utils.rb', line 64

def port_string(datum)
  if !default_port?(datum) || datum[:include_default_port] || !datum[:omit_default_port]
    ":#{datum[:port]}"
  else
    ''
  end
end

#query_string(datum) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/excon/utils.rb', line 78

def query_string(datum)
  str = String.new
  case datum[:query]
  when String
    str << '?' << datum[:query]
  when Hash
    str << '?'
    datum[:query].sort_by {|k,_| k.to_s }.each do |key, values|
      key = CGI.escape(key.to_s)
      if values.nil?
        str << key << '&'
      else
        [values].flatten.each do |value|
          str << key << '=' << CGI.escape(value.to_s) << '&'
        end
      end
    end
    str.chop! # remove trailing '&'
  end
  str
end

#redact(datum) ⇒ Object

Redact sensitive info from provided data



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/excon/utils.rb', line 37

def redact(datum)
  datum = datum.dup
  if datum.has_key?(:headers)
    if datum[:headers].has_key?('Authorization') || datum[:headers].has_key?('Proxy-Authorization')
      datum[:headers] = datum[:headers].dup
    end
    if datum[:headers].has_key?('Authorization')
      datum[:headers]['Authorization'] = REDACTED
    end
    if datum[:headers].has_key?('Proxy-Authorization')
      datum[:headers]['Proxy-Authorization'] = REDACTED
    end
  end
  if datum.has_key?(:password)
    datum[:password] = REDACTED
  end
  if datum.has_key?(:proxy) && datum[:proxy] && datum[:proxy].has_key?(:password)
    datum[:proxy] = datum[:proxy].dup
    datum[:proxy][:password] = REDACTED
  end
  datum
end

#request_uri(datum) ⇒ Object 



60
61
62
 
# File 'lib/excon/utils.rb', line 60

def request_uri(datum)
  connection_uri(datum) + datum[:path] + query_string(datum)
end

#split_header_value(str) ⇒ Object

Splits a header value str according to HTTP specification.



101
102
103
104
105
106
107
 
# File 'lib/excon/utils.rb', line 101

def split_header_value(str)
  return [] if str.nil?
  str = str.dup.strip
  str = binary_encode(str)
  str.scan(%r'\G((?:"(?:\\.|[^"])+?"|[^",])+)
                (?:,\s*|\Z)'xn).flatten
end

#unescape_form(str) ⇒ Object

Unescape form encoded values in str



124
125
126
127
128
129
 
# File 'lib/excon/utils.rb', line 124

def unescape_form(str)
  str = str.dup
  str = binary_encode(str)
  str.gsub!(/\+/, ' ')
  str.gsub(ESCAPED) { $1.hex.chr }
end

#unescape_uri(str) ⇒ Object

Unescapes HTTP reserved and unwise characters in str



117
118
119
120
121
 
# File 'lib/excon/utils.rb', line 117

def unescape_uri(str)
  str = str.dup
  str = binary_encode(str)
  str.gsub(ESCAPED) { $1.hex.chr }
end