无法使用 VCR 过滤敏感数据
Can't filter sensitive data with VCR
我的 spec_helper
中有以下内容
c.filter_sensitive_data("<FILTERED>") { keys['s3_key'] }
c.filter_sensitive_data("<REDACTED>") { keys['s3_secret'] }
然而,当我 运行 我的规范时,我发现它在盒式磁带中创建了以下条目:
Authorization:
- AWS <FILTERED>:this_part_has_not_been_filtered=
如您所见,有一部分未被过滤。我不确定它是否包含有用的信息,但我不想粘贴它以防万一。但是我可以说它不包含我的密钥或我的秘密。它只是绒毛吗?我应该关心吗?这是在使用 aws-sdk gem 时过滤 S3 请求时通常会发生的情况吗?如果没有,那么我怎样才能让它过滤所有授权数据?
是否有一组特殊的指令来过滤 S3 密钥?我真的不想把事情搞砸。
好吧,看起来它是安全的,如果你的钥匙不在的话。可以肯定的是,您可以使用正则表达式匹配器来替换整个字符串,例如 %r<#{keys['s3_key']:.*?=>
。坏消息:没有正则表达式 filter_sensitive_data
。好消息:您可以使用更多低级方法自行实现。
这是 filter_sensitive_data
的当前实现
# @param placeholder [String] The placeholder string.
# @param tag [Symbol] Set this to apply this only to cassettes
# with a matching tag; otherwise it will apply to every cassette.
# @yield block that determines what string to replace
# @yieldparam interaction [(optional) VCR::HTTPInteraction::HookAware] the HTTP interaction
# @yieldreturn the string to replace
def define_cassette_placeholder(placeholder, tag = nil, &block)
before_record(tag) do |interaction|
orig_text = call_block(block, interaction)
log "before_record: replacing #{orig_text.inspect} with #{placeholder.inspect}"
interaction.filter!(orig_text, placeholder)
end
before_playback(tag) do |interaction|
orig_text = call_block(block, interaction)
log "before_playback: replacing #{placeholder.inspect} with #{orig_text.inspect}"
interaction.filter!(placeholder, orig_text)
end
end
alias filter_sensitive_data define_cassette_placeholder
这导致我们使用这些方法
# Replaces a string in any part of the HTTP interaction (headers, request body,
# response body, etc) with the given replacement text.
#
# @param [#to_s] text the text to replace
# @param [#to_s] replacement_text the text to put in its place
def filter!(text, replacement_text)
text, replacement_text = text.to_s, replacement_text.to_s
return self if [text, replacement_text].any? { |t| t.empty? }
filter_object!(self, text, replacement_text)
end
private
def filter_object!(object, text, replacement_text)
if object.respond_to?(:gsub)
object.gsub!(text, replacement_text) if object.include?(text)
elsif Hash === object
filter_hash!(object, text, replacement_text)
elsif object.respond_to?(:each)
# This handles nested arrays and structs
object.each { |o| filter_object!(o, text, replacement_text) }
end
object
end
哦,好吧,我们可以试试猴子修补这个方法:
在你的某处spec_helper:
class VCR::HTTPInteraction::HookAware
def filter!(text, replacement_text)
replacement_text = replacement_text.to_s unless replacement_text.is_a?(Regexp)
text = text.to_s
return self if [text, replacement_text].any? { |t| t.empty? }
filter_object!(self, text, replacement_text)
end
end
当然,你可以选择不去搞乱外星人图书馆的深层内部结构,并且不要太偏执地知道一些随机的字母数字数据被写入了你令牌附近的盒式磁带(但不包括后者) ).
我的 spec_helper
中有以下内容c.filter_sensitive_data("<FILTERED>") { keys['s3_key'] }
c.filter_sensitive_data("<REDACTED>") { keys['s3_secret'] }
然而,当我 运行 我的规范时,我发现它在盒式磁带中创建了以下条目:
Authorization:
- AWS <FILTERED>:this_part_has_not_been_filtered=
如您所见,有一部分未被过滤。我不确定它是否包含有用的信息,但我不想粘贴它以防万一。但是我可以说它不包含我的密钥或我的秘密。它只是绒毛吗?我应该关心吗?这是在使用 aws-sdk gem 时过滤 S3 请求时通常会发生的情况吗?如果没有,那么我怎样才能让它过滤所有授权数据?
是否有一组特殊的指令来过滤 S3 密钥?我真的不想把事情搞砸。
好吧,看起来它是安全的,如果你的钥匙不在的话。可以肯定的是,您可以使用正则表达式匹配器来替换整个字符串,例如 %r<#{keys['s3_key']:.*?=>
。坏消息:没有正则表达式 filter_sensitive_data
。好消息:您可以使用更多低级方法自行实现。
这是 filter_sensitive_data
# @param placeholder [String] The placeholder string.
# @param tag [Symbol] Set this to apply this only to cassettes
# with a matching tag; otherwise it will apply to every cassette.
# @yield block that determines what string to replace
# @yieldparam interaction [(optional) VCR::HTTPInteraction::HookAware] the HTTP interaction
# @yieldreturn the string to replace
def define_cassette_placeholder(placeholder, tag = nil, &block)
before_record(tag) do |interaction|
orig_text = call_block(block, interaction)
log "before_record: replacing #{orig_text.inspect} with #{placeholder.inspect}"
interaction.filter!(orig_text, placeholder)
end
before_playback(tag) do |interaction|
orig_text = call_block(block, interaction)
log "before_playback: replacing #{placeholder.inspect} with #{orig_text.inspect}"
interaction.filter!(placeholder, orig_text)
end
end
alias filter_sensitive_data define_cassette_placeholder
这导致我们使用这些方法
# Replaces a string in any part of the HTTP interaction (headers, request body,
# response body, etc) with the given replacement text.
#
# @param [#to_s] text the text to replace
# @param [#to_s] replacement_text the text to put in its place
def filter!(text, replacement_text)
text, replacement_text = text.to_s, replacement_text.to_s
return self if [text, replacement_text].any? { |t| t.empty? }
filter_object!(self, text, replacement_text)
end
private
def filter_object!(object, text, replacement_text)
if object.respond_to?(:gsub)
object.gsub!(text, replacement_text) if object.include?(text)
elsif Hash === object
filter_hash!(object, text, replacement_text)
elsif object.respond_to?(:each)
# This handles nested arrays and structs
object.each { |o| filter_object!(o, text, replacement_text) }
end
object
end
哦,好吧,我们可以试试猴子修补这个方法:
在你的某处spec_helper:
class VCR::HTTPInteraction::HookAware
def filter!(text, replacement_text)
replacement_text = replacement_text.to_s unless replacement_text.is_a?(Regexp)
text = text.to_s
return self if [text, replacement_text].any? { |t| t.empty? }
filter_object!(self, text, replacement_text)
end
end
当然,你可以选择不去搞乱外星人图书馆的深层内部结构,并且不要太偏执地知道一些随机的字母数字数据被写入了你令牌附近的盒式磁带(但不包括后者) ).