1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
|
require 'uri'
require 'fileutils'
# Simple thread-safe cookie jar for WhatWeb
# Provides automatic cookie persistence across redirects with minimal complexity
#
# DESIGN PURPOSE:
# This cookie jar is designed primarily for handling redirects and session persistence,
# NOT for mass cookie collection. It maintains cookies during redirects and across
# requests to the same domain to ensure proper web application scanning.
#
# LIMITATIONS:
# - Max 10,000 domains by default (see max_domains parameter)
# - Automatic cleanup removes oldest domains when limit is reached
# - Memory usage grows with number of unique domains scanned
# - For large-scale scans across many domains, use --no-cookies for better performance
class SimpleCookieJar
def initialize(max_domains: 10_000, cookie_jar_file: nil)
@cookies = {} # domain -> cookie_string
@mutex = Mutex.new # Thread safety
@max_domains = max_domains
@cleanup_threshold = max_domains / 2
@request_count = 0
@cookie_jar_file = cookie_jar_file
# Load cookies from file if it exists
load_from_file if @cookie_jar_file
end
def add_cookies(set_cookie_header, url)
return unless set_cookie_header && url
domain = extract_domain(url)
return unless domain
@mutex.synchronize do
@request_count += 1
# Parse Set-Cookie header (simple approach)
cookie_values = parse_set_cookie_header(set_cookie_header)
unless cookie_values.empty?
if @cookies[domain]
# Merge cookies, with new cookies overriding existing ones with same name
existing_cookies = {}
@cookies[domain].split('; ').each do |cookie|
name, value = cookie.split('=', 2)
existing_cookies[name] = value if name && value
end
# Add new cookies, overriding existing ones
cookie_values.split('; ').each do |cookie|
name, value = cookie.split('=', 2)
# Only store cookies with valid names (non-empty) and values
existing_cookies[name] = value if name && !name.empty? && value && !value.empty?
end
# Rebuild cookie string
@cookies[domain] = existing_cookies.map { |name, value| "#{name}=#{value}" }.join('; ')
else
@cookies[domain] = cookie_values
end
end
# Cleanup after adding if we reach or exceed limit
cleanup_old_domains if @cookies.size >= @max_domains
end
end
def cookies_for_request(url)
domain = extract_domain(url)
return nil unless domain
@mutex.synchronize { @cookies[domain] }
end
def stats
@mutex.synchronize do
{
domains: @cookies.size,
max_domains: @max_domains,
requests_processed: @request_count,
memory_estimate_kb: @cookies.size * 1024 # ~1KB per domain
}
end
end
# Display current cookie jar contents (for debugging)
def display_cookies
@mutex.synchronize do
if @cookies.empty?
debug("Cookie jar is empty") if defined?(debug)
else
debug("Cookie jar contents (#{@cookies.size} domains):") if defined?(debug)
@cookies.each do |domain, cookies|
debug(" #{domain}: #{cookies}") if defined?(debug)
end
end
end
end
# Load cookies from the cookie jar file
def load_from_file
return unless @cookie_jar_file && File.readable?(@cookie_jar_file)
begin
lines = File.readlines(@cookie_jar_file).map(&:strip)
return if lines.empty?
# Check if this is the new domain-aware format
if lines.any? { |line| line.start_with?('# Domain:') }
# Parse domain-aware format
current_domain = nil
lines.each do |line|
if line.start_with?('# Domain:')
current_domain = line.sub(/^# Domain:\s*/, '')
elsif !line.empty? && !line.start_with?('#') && current_domain
# Store cookie for this domain
@cookies[current_domain] = line
end
end
else
# Legacy format - treat as single domain cookies
# These will be available via $CUSTOM_HEADERS['Cookie'] mechanism
# Don't load into @cookies since we don't know the domain
end
debug("Loaded cookies for #{@cookies.size} domains from #{@cookie_jar_file}") if defined?(debug)
rescue => e
# Don't crash if loading fails, just warn
warning("Failed to load cookies from #{@cookie_jar_file}: #{e.message}") if defined?(warning)
end
end
# Save cookies to the cookie jar file
def save_to_file
return unless @cookie_jar_file
@mutex.synchronize do
begin
# Create directory if it doesn't exist
dir = File.dirname(@cookie_jar_file)
FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
# Write cookies in domain-aware format
if @cookies.empty?
# Create empty file or clear existing file
File.write(@cookie_jar_file, "")
else
content = []
@cookies.each do |domain, cookie_string|
next if cookie_string.nil? || cookie_string.empty?
content << "# Domain: #{domain}"
content << cookie_string
content << "" # Empty line for readability
end
# Remove trailing empty line and ensure final newline
content.pop if content.last == ""
cookie_content = content.join("\n") + "\n"
File.write(@cookie_jar_file, cookie_content)
end
debug("Saved #{@cookies.size} domains with cookies to #{@cookie_jar_file}") if defined?(debug)
rescue => e
# Don't crash the program if cookie saving fails, just warn
warning("Failed to save cookies to #{@cookie_jar_file}: #{e.message}") if defined?(warning)
end
end
end
private
def extract_domain(url)
URI.parse(url.to_s).host&.downcase
rescue URI::InvalidURIError, ArgumentError
nil
end
def parse_set_cookie_header(header)
begin
cookie_values = []
# Handle different cookie header formats
if header.include?("\n")
# Multiple Set-Cookie headers joined with newlines
header.split("\n").each do |line|
line = line.strip
next if line.empty?
# Extract the first cookie (before first semicolon for attributes)
cookie_part = line.split(';').first
cookie_part = cookie_part.strip if cookie_part
if cookie_part && cookie_part.include?('=') && !cookie_part.empty?
name, value = cookie_part.split('=', 2)
if name && !name.empty? && value && !value.empty?
cookie_values << cookie_part
end
end
end
elsif header.include?(';')
# Check if this is a single cookie with attributes or multiple cookies
parts = header.split(';').map(&:strip)
# Known cookie attributes that should be ignored
cookie_attributes = %w[path domain expires max-age secure httponly samesite]
# If the first part looks like a cookie and subsequent parts are attributes,
# treat as single cookie with attributes
first_part = parts.first
if first_part && first_part.include?('=')
# Check if remaining parts are cookie attributes
remaining_parts = parts[1..-1]
looks_like_attributes = remaining_parts.all? do |part|
if part.include?('=')
attr_name = part.split('=', 2).first.downcase
cookie_attributes.include?(attr_name)
else
# Attributes like 'Secure', 'HttpOnly' don't have values
cookie_attributes.include?(part.downcase)
end
end
if looks_like_attributes
# Single cookie with attributes - only take the first part
name, value = first_part.split('=', 2)
if name && !name.empty? && value && !value.empty?
cookie_values << first_part
end
else
# Multiple cookies - process all parts
parts.each do |part|
if part.include?('=') && !part.empty?
name, value = part.split('=', 2)
if name && !name.empty? && value && !value.empty?
cookie_values << part
end
end
end
end
end
else
# Single cookie without attributes
if header.include?('=') && !header.strip.empty?
name, value = header.strip.split('=', 2)
if name && !name.empty? && value && !value.empty?
cookie_values << header.strip
end
end
end
cookie_values.join('; ')
rescue => e
# Log error but don't crash - only show in debug mode
debug("Failed to parse cookie header: #{e.message}") if defined?(debug)
""
end
end
def cleanup_old_domains
# Emergency cleanup if way over limit
if @cookies.size > @max_domains * 1.5
@cookies.clear
debug("Emergency cookie jar reset due to memory pressure") if defined?(debug)
elsif @cookies.size >= @max_domains
# Normal cleanup - Ruby hashes maintain insertion order, remove oldest domains
domains_to_remove = @cookies.keys.first(@cleanup_threshold)
domains_to_remove.each { |domain| @cookies.delete(domain) }
debug("Cookie jar cleanup: removed #{domains_to_remove.size} oldest domains") if defined?(debug)
end
end
end
|