Module: Datadog::Tracing::Contrib::Utils::Quantization::HTTP

Defined in:
lib/datadog/tracing/contrib/utils/quantization/http.rb

Overview

Quantization for HTTP resources

Constant Summary collapse

PLACEHOLDER = 
'?'.freeze
RFC3986_URL_BASE =

taken from Ruby github.com/ruby/uri/blob/eaf89cc31619d49e67c64d0b58ea9dc38892d175/lib/uri/rfc3986_parser.rb but adjusted to parse only <scheme>://<host>:<port>/ components and stop there, since we don’t care about the path, query string, and fragment components

/\A(?<URI>(?<scheme>[A-Za-z][+\-.0-9A-Za-z]*+):(?<hier-part>\/\/(?<authority>(?:(?<userinfo>(?:%\h\h|[!$&-.0-;=A-Z_a-z~])*+)@)?(?<host>(?<IP-literal>\[(?:(?<IPv6address>(?:\h{1,4}:){6}(?<ls32>\h{1,4}:\h{1,4}|(?<IPv4address>(?<dec-octet>[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]|\d)\.\g<dec-octet>\.\g<dec-octet>\.\g<dec-octet>))|::(?:\h{1,4}:){5}\g<ls32>|\h{1,4}?::(?:\h{1,4}:){4}\g<ls32>|(?:(?:\h{1,4}:)?\h{1,4})?::(?:\h{1,4}:){3}\g<ls32>|(?:(?:\h{1,4}:){,2}\h{1,4})?::(?:\h{1,4}:){2}\g<ls32>|(?:(?:\h{1,4}:){,3}\h{1,4})?::\h{1,4}:\g<ls32>|(?:(?:\h{1,4}:){,4}\h{1,4})?::\g<ls32>|(?:(?:\h{1,4}:){,5}\h{1,4})?::\h{1,4}|(?:(?:\h{1,4}:){,6}\h{1,4})?::)|(?<IPvFuture>v\h++\.[!$&-.0-;=A-Z_a-z~]++))\])|\g<IPv4address>|(?<reg-name>(?:%\h\h|[!$&-.0-9;=A-Z_a-z~])*+))(?::(?<port>\d*+))?)))(?:\/|\z)/.freeze
OBFUSCATOR_WITH = 
'<redacted>'.freeze
OBFUSCATOR_REGEX =

rubocop:disable Layout/LineLength

%r{
  (?: # JSON-ish leading quote
     (?:"|%22)?
  )
  (?: # common keys
     (?:old[-_]?|new_?)?p(?:ass)?w(?:or)?d(?:1|2)? # pw, password variants
    |pass(?:[-_]?phrase)?  # pass, passphrase variants
    |secret
    |(?: # key, key_id variants
         api[-_]?
        |private[-_]?
        |public[-_]?
        |access[-_]?
        |secret[-_]?
     )key(?:[-_]?id)?
    |token
    |consumer[-_]?(?:id|key|secret)
    |sign(?:ed|ature)?
    |auth(?:entication|orization)?
  )
  (?:
     # '=' query string separator, plus value til next '&' separator
     (?:\s|%20)*(?:=|%3D)[^&]+
     # JSON-ish '": "somevalue"', key being handled with case above, without the opening '"'
    |(?:"|%22)                                     # closing '"' at end of key
     (?:\s|%20)*(?::|%3A)(?:\s|%20)*               # ':' key-value spearator, with surrounding spaces
     (?:"|%22)                                     # opening '"' at start of value
     (?:%2[^2]|%[^2]|[^"%])+                       # value
     (?:"|%22)                                     # closing '"' at end of value
  )
 |(?: # other common secret values
     bearer(?:\s|%20)+[a-z0-9._-]+
    |token(?::|%3A)[a-z0-9]{13}
    |gh[opsu]_[0-9a-zA-Z]{36}
    |ey[I-L](?:[\w=-]|%3D)+\.ey[I-L](?:[\w=-]|%3D)+(?:\.(?:[\w.+/=-]|%3D|%2F|%2B)+)?
    |-{5}BEGIN(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY-{5}[^-]+-{5}END(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY(?:-{5})?(?:\n|%0A)?
    |(?:ssh-(?:rsa|dss)|ecdsa-[a-z0-9]+-[a-z0-9]+)(?:\s|%20)*(?:[a-z0-9/.+]|%2F|%5C|%2B){100,}(?:=|%3D)*(?:(?:\s+)[a-z0-9._-]+)?
  )
}ix.freeze

Class Method Summary collapse

Class Method Details

.base_url(url, options = {}) ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/datadog/tracing/contrib/utils/quantization/http.rb', line 29

def base_url(url, options = {})
  if (m = RFC3986_URL_BASE.match(url))
    m[1]
  else
    ''
  end
end

.query(query, options = {}) ⇒ Object 



58
59
60
61
62
 
# File 'lib/datadog/tracing/contrib/utils/quantization/http.rb', line 58

def query(query, options = {})
  query!(query, options)
rescue StandardError
  options[:placeholder] || PLACEHOLDER
end

.query!(query, options = {}) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/datadog/tracing/contrib/utils/quantization/http.rb', line 64

def query!(query, options = {})
  options ||= {}
  options[:obfuscate] = {} if options[:obfuscate] == :internal
  options[:show] = options[:show] || (options[:obfuscate] ? :all : [])
  options[:exclude] = options[:exclude] || []

  # Short circuit if query string is meant to exclude everything
  # or if the query string is meant to include everything
  return '' if options[:exclude] == :all

  unless options[:show] == :all && !(options[:obfuscate] && options[:exclude])
    query = collect_query(query, uniq: true) do |key, value|
      if options[:exclude].include?(key)
        [nil, nil]
      else
        value = options[:show] == :all || options[:show].include?(key) ? value : nil
        [key, value]
      end
    end
  end

  options[:obfuscate] ? obfuscate_query(query, options[:obfuscate]) : query
end

.url(url, options = {}) ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/datadog/tracing/contrib/utils/quantization/http.rb', line 21

def url(url, options = {})
  url!(url, options)
rescue StandardError
  placeholder = options[:placeholder] || PLACEHOLDER

  options[:base] == :exclude ? placeholder : "#{base_url(url)}/#{placeholder}"
end

.url!(url, options = {}) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/datadog/tracing/contrib/utils/quantization/http.rb', line 37

def url!(url, options = {})
  options ||= {}

  URI.parse(url).tap do |uri|
    # Format the query string
    if uri.query
      query = query(uri.query, options[:query])
      uri.query = (!query.nil? && query.empty? ? nil : query)
    end

    # Remove any URI fragments
    uri.fragment = nil unless options[:fragment] == :show

    if options[:base] == :exclude
      uri.host = nil
      uri.port = nil
      uri.scheme = nil
    end
  end.to_s
end