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
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Elasticsearch
module Transport
# Class for wrapping a hash that could have sensitive data.
# When printed, the sensitive values will be redacted.
#
# @since 6.1.1
class Redacted < ::Hash
def initialize(elements = nil)
super()
(elements || {}).each_pair{ |key, value| self[key] = value }
end
# The keys whose values will be redacted.
#
# @since 6.1.1
SENSITIVE_KEYS = [ :password,
:pwd ].freeze
# The replacement string used in place of the value for sensitive keys.
#
# @since 6.1.1
STRING_REPLACEMENT = '<REDACTED>'.freeze
# Get a string representation of the hash.
#
# @return [ String ] The string representation of the hash.
#
# @since 6.1.1
def inspect
redacted_string(:inspect)
end
# Get a string representation of the hash.
#
# @return [ String ] The string representation of the hash.
#
# @since 6.1.1
def to_s
redacted_string(:to_s)
end
private
def redacted_string(method)
'{' + reduce([]) do |list, (k, v)|
list << "#{k.send(method)}=>#{redact(k, v, method)}"
end.join(', ') + '}'
end
def redact(k, v, method)
return STRING_REPLACEMENT if SENSITIVE_KEYS.include?(k.to_sym)
v.send(method)
end
end
end
end
|
