Module: Puppet::Util::Checksums
Overview
A stand-alone module for calculating checksums in a generic way.
Defined Under Namespace
Classes: DigestLite, FakeChecksum
Class Method Summary
collapse
-
.checksum?(string) ⇒ Boolean
Is the provided string a checksum?.
-
.checksum_file(digest, filename, lite = false) ⇒ Object
Perform an incremental checksum on a file.
-
.checksum_stream(digest, block, lite = false) ⇒ Object
-
.ctime(content) ⇒ Object
-
.ctime?(string) ⇒ Boolean
-
.ctime_file(filename) ⇒ Object
Return the :ctime of a file.
-
.ctime_stream(&block) ⇒ Object
-
.known_checksum_types ⇒ Object
It’s not a good idea to use some of these in some contexts: for example, I wouldn’t try bucketing a file using the :none checksum type.
-
.md5(content) ⇒ Object
Calculate a checksum using Digest::MD5.
-
.md5?(string) ⇒ Boolean
-
.md5_file(filename, lite = false) ⇒ Object
Calculate a checksum of a file’s content using Digest::MD5.
-
.md5_hex_length ⇒ Object
-
.md5_stream(lite = false, &block) ⇒ Object
-
.md5lite(content) ⇒ Object
Calculate a checksum of the first 500 chars of the content using Digest::MD5.
-
.md5lite?(string) ⇒ Boolean
-
.md5lite_file(filename) ⇒ Object
Calculate a checksum of the first 500 chars of a file’s content using Digest::MD5.
-
.md5lite_hex_length ⇒ Object
-
.md5lite_stream(&block) ⇒ Object
-
.mtime(content) ⇒ Object
-
.mtime?(string) ⇒ Boolean
-
.mtime_file(filename) ⇒ Object
Return the :mtime timestamp of a file.
-
.mtime_stream {|noop_digest| ... } ⇒ Object
by definition this doesn’t exist but we still need to execute the block given.
-
.none(content) ⇒ Object
-
.none?(string) ⇒ Boolean
-
.none_file(filename) ⇒ Object
-
.none_stream {|noop_digest| ... } ⇒ Object
-
.sha1(content) ⇒ Object
Calculate a checksum using Digest::SHA1.
-
.sha1?(string) ⇒ Boolean
-
.sha1_file(filename, lite = false) ⇒ Object
Calculate a checksum of a file’s content using Digest::SHA1.
-
.sha1_hex_length ⇒ Object
-
.sha1_stream(lite = false, &block) ⇒ Object
-
.sha1lite(content) ⇒ Object
Calculate a checksum of the first 500 chars of the content using Digest::SHA1.
-
.sha1lite?(string) ⇒ Boolean
-
.sha1lite_file(filename) ⇒ Object
Calculate a checksum of the first 500 chars of a file’s content using Digest::SHA1.
-
.sha1lite_hex_length ⇒ Object
-
.sha1lite_stream(&block) ⇒ Object
-
.sha224(content) ⇒ Object
Calculate a checksum using Digest::SHA224.
-
.sha224?(string) ⇒ Boolean
-
.sha224_file(filename, lite = false) ⇒ Object
-
.sha224_hex_length ⇒ Object
-
.sha224_stream(lite = false, &block) ⇒ Object
-
.sha256(content) ⇒ Object
Calculate a checksum using Digest::SHA256.
-
.sha256?(string) ⇒ Boolean
-
.sha256_file(filename, lite = false) ⇒ Object
-
.sha256_hex_length ⇒ Object
-
.sha256_stream(lite = false, &block) ⇒ Object
-
.sha256lite(content) ⇒ Object
-
.sha256lite?(string) ⇒ Boolean
-
.sha256lite_file(filename) ⇒ Object
-
.sha256lite_hex_length ⇒ Object
-
.sha256lite_stream(&block) ⇒ Object
-
.sha384(content) ⇒ Object
Calculate a checksum using Digest::SHA384.
-
.sha384?(string) ⇒ Boolean
-
.sha384_file(filename, lite = false) ⇒ Object
-
.sha384_hex_length ⇒ Object
-
.sha384_stream(lite = false, &block) ⇒ Object
-
.sha512(content) ⇒ Object
Calculate a checksum using Digest::SHA512.
-
.sha512?(string) ⇒ Boolean
-
.sha512_file(filename, lite = false) ⇒ Object
-
.sha512_hex_length ⇒ Object
-
.sha512_stream(lite = false, &block) ⇒ Object
-
.sumdata(checksum) ⇒ Object
Strip the checksum type from an existing checksum.
-
.sumtype(checksum) ⇒ Object
Strip the checksum type from an existing checksum.
Class Method Details
.checksum?(string) ⇒ Boolean
Is the provided string a checksum?
24
25
26
27
|
# File 'lib/puppet/util/checksums.rb', line 24
def checksum?(string)
string =~ /^\{(\w{3,10})\}\S+/
end
|
.checksum_file(digest, filename, lite = false) ⇒ Object
Perform an incremental checksum on a file.
344
345
346
347
348
349
350
351
352
353
354
|
# File 'lib/puppet/util/checksums.rb', line 344
def checksum_file(digest, filename, lite = false)
buffer = lite ? 512 : 4096
File.open(filename, 'rb') do |file|
while content = file.read(buffer)
digest << content
break if lite
end
end
digest.hexdigest
end
|
.checksum_stream(digest, block, lite = false) ⇒ Object
356
357
358
359
|
# File 'lib/puppet/util/checksums.rb', line 356
def checksum_stream(digest, block, lite = false)
block.call(DigestLite.new(digest, lite))
digest.hexdigest
end
|
.ctime(content) ⇒ Object
283
284
285
|
# File 'lib/puppet/util/checksums.rb', line 283
def ctime(content)
""
end
|
.ctime?(string) ⇒ Boolean
287
288
289
290
291
292
|
# File 'lib/puppet/util/checksums.rb', line 287
def ctime?(string)
return true if string.is_a? Time
!!DateTime.parse(string)
rescue
false
end
|
.ctime_file(filename) ⇒ Object
Return the :ctime of a file.
295
296
297
|
# File 'lib/puppet/util/checksums.rb', line 295
def ctime_file(filename)
Puppet::FileSystem.stat(filename).send(:ctime)
end
|
.ctime_stream(&block) ⇒ Object
299
300
301
|
# File 'lib/puppet/util/checksums.rb', line 299
def ctime_stream(&block)
mtime_stream(&block)
end
|
.known_checksum_types ⇒ Object
It’s not a good idea to use some of these in some contexts: for example, I wouldn’t try bucketing a file using the :none checksum type.
12
13
14
15
|
# File 'lib/puppet/util/checksums.rb', line 12
def known_checksum_types
[:sha256, :sha256lite, :md5, :md5lite, :sha1, :sha1lite, :sha512, :sha384, :sha224,
:mtime, :ctime, :none]
end
|
.md5(content) ⇒ Object
Calculate a checksum using Digest::MD5.
168
169
170
|
# File 'lib/puppet/util/checksums.rb', line 168
def md5(content)
Digest::MD5.hexdigest(content)
end
|
.md5?(string) ⇒ Boolean
172
173
174
|
# File 'lib/puppet/util/checksums.rb', line 172
def md5?(string)
string =~ /^\h{32}$/
end
|
.md5_file(filename, lite = false) ⇒ Object
Calculate a checksum of a file’s content using Digest::MD5.
177
178
179
180
|
# File 'lib/puppet/util/checksums.rb', line 177
def md5_file(filename, lite = false)
digest = Digest::MD5.new
checksum_file(digest, filename, lite)
end
|
.md5_hex_length ⇒ Object
187
188
189
|
# File 'lib/puppet/util/checksums.rb', line 187
def md5_hex_length
32
end
|
.md5_stream(lite = false, &block) ⇒ Object
182
183
184
185
|
# File 'lib/puppet/util/checksums.rb', line 182
def md5_stream(lite = false, &block)
digest = Digest::MD5.new
checksum_stream(digest, block, lite)
end
|
.md5lite(content) ⇒ Object
Calculate a checksum of the first 500 chars of the content using Digest::MD5.
192
193
194
|
# File 'lib/puppet/util/checksums.rb', line 192
def md5lite(content)
md5(content[0..511])
end
|
.md5lite?(string) ⇒ Boolean
196
197
198
|
# File 'lib/puppet/util/checksums.rb', line 196
def md5lite?(string)
md5?(string)
end
|
.md5lite_file(filename) ⇒ Object
Calculate a checksum of the first 500 chars of a file’s content using Digest::MD5.
201
202
203
|
# File 'lib/puppet/util/checksums.rb', line 201
def md5lite_file(filename)
md5_file(filename, true)
end
|
.md5lite_hex_length ⇒ Object
209
210
211
|
# File 'lib/puppet/util/checksums.rb', line 209
def md5lite_hex_length
md5_hex_length
end
|
.md5lite_stream(&block) ⇒ Object
205
206
207
|
# File 'lib/puppet/util/checksums.rb', line 205
def md5lite_stream(&block)
md5_stream(true, &block)
end
|
.mtime(content) ⇒ Object
213
214
215
|
# File 'lib/puppet/util/checksums.rb', line 213
def mtime(content)
""
end
|
.mtime?(string) ⇒ Boolean
217
218
219
220
221
222
|
# File 'lib/puppet/util/checksums.rb', line 217
def mtime?(string)
return true if string.is_a? Time
!!DateTime.parse(string)
rescue
false
end
|
.mtime_file(filename) ⇒ Object
Return the :mtime timestamp of a file.
225
226
227
|
# File 'lib/puppet/util/checksums.rb', line 225
def mtime_file(filename)
Puppet::FileSystem.stat(filename).send(:mtime)
end
|
.mtime_stream {|noop_digest| ... } ⇒ Object
by definition this doesn’t exist but we still need to execute the block given
231
232
233
234
235
|
# File 'lib/puppet/util/checksums.rb', line 231
def mtime_stream(&block)
noop_digest = FakeChecksum.new
yield noop_digest
nil
end
|
.none(content) ⇒ Object
303
304
305
|
# File 'lib/puppet/util/checksums.rb', line 303
def none(content)
""
end
|
.none?(string) ⇒ Boolean
307
308
309
|
# File 'lib/puppet/util/checksums.rb', line 307
def none?(string)
string.empty?
end
|
.none_file(filename) ⇒ Object
312
313
314
|
# File 'lib/puppet/util/checksums.rb', line 312
def none_file(filename)
""
end
|
.none_stream {|noop_digest| ... } ⇒ Object
316
317
318
319
320
|
# File 'lib/puppet/util/checksums.rb', line 316
def none_stream
noop_digest = FakeChecksum.new
yield noop_digest
""
end
|
.sha1(content) ⇒ Object
Calculate a checksum using Digest::SHA1.
238
239
240
|
# File 'lib/puppet/util/checksums.rb', line 238
def sha1(content)
Digest::SHA1.hexdigest(content)
end
|
.sha1?(string) ⇒ Boolean
242
243
244
|
# File 'lib/puppet/util/checksums.rb', line 242
def sha1?(string)
string =~ /^\h{40}$/
end
|
.sha1_file(filename, lite = false) ⇒ Object
Calculate a checksum of a file’s content using Digest::SHA1.
247
248
249
250
|
# File 'lib/puppet/util/checksums.rb', line 247
def sha1_file(filename, lite = false)
digest = Digest::SHA1.new
checksum_file(digest, filename, lite)
end
|
.sha1_hex_length ⇒ Object
257
258
259
|
# File 'lib/puppet/util/checksums.rb', line 257
def sha1_hex_length
40
end
|
.sha1_stream(lite = false, &block) ⇒ Object
252
253
254
255
|
# File 'lib/puppet/util/checksums.rb', line 252
def sha1_stream(lite = false, &block)
digest = Digest::SHA1.new
checksum_stream(digest, block, lite)
end
|
.sha1lite(content) ⇒ Object
Calculate a checksum of the first 500 chars of the content using Digest::SHA1.
262
263
264
|
# File 'lib/puppet/util/checksums.rb', line 262
def sha1lite(content)
sha1(content[0..511])
end
|
.sha1lite?(string) ⇒ Boolean
266
267
268
|
# File 'lib/puppet/util/checksums.rb', line 266
def sha1lite?(string)
sha1?(string)
end
|
.sha1lite_file(filename) ⇒ Object
Calculate a checksum of the first 500 chars of a file’s content using Digest::SHA1.
271
272
273
|
# File 'lib/puppet/util/checksums.rb', line 271
def sha1lite_file(filename)
sha1_file(filename, true)
end
|
.sha1lite_hex_length ⇒ Object
279
280
281
|
# File 'lib/puppet/util/checksums.rb', line 279
def sha1lite_hex_length
sha1_hex_length
end
|
.sha1lite_stream(&block) ⇒ Object
275
276
277
|
# File 'lib/puppet/util/checksums.rb', line 275
def sha1lite_stream(&block)
sha1_stream(true, &block)
end
|
.sha224(content) ⇒ Object
Calculate a checksum using Digest::SHA224.
141
142
143
144
|
# File 'lib/puppet/util/checksums.rb', line 141
def sha224(content)
require 'openssl'
OpenSSL::Digest::SHA224.new.hexdigest(content)
end
|
.sha224?(string) ⇒ Boolean
146
147
148
|
# File 'lib/puppet/util/checksums.rb', line 146
def sha224?(string)
string =~ /^\h{56}$/
end
|
.sha224_file(filename, lite = false) ⇒ Object
150
151
152
153
154
155
|
# File 'lib/puppet/util/checksums.rb', line 150
def sha224_file(filename, lite = false)
require 'openssl'
digest = OpenSSL::Digest::SHA224.new
checksum_file(digest, filename, lite)
end
|
.sha224_hex_length ⇒ Object
163
164
165
|
# File 'lib/puppet/util/checksums.rb', line 163
def sha224_hex_length
56
end
|
.sha224_stream(lite = false, &block) ⇒ Object
157
158
159
160
161
|
# File 'lib/puppet/util/checksums.rb', line 157
def sha224_stream(lite = false, &block)
require 'openssl'
digest = OpenSSL::Digest::SHA224.new
checksum_stream(digest, block, lite)
end
|
.sha256(content) ⇒ Object
Calculate a checksum using Digest::SHA256.
40
41
42
43
|
# File 'lib/puppet/util/checksums.rb', line 40
def sha256(content)
require 'digest/sha2'
Digest::SHA256.hexdigest(content)
end
|
.sha256?(string) ⇒ Boolean
45
46
47
|
# File 'lib/puppet/util/checksums.rb', line 45
def sha256?(string)
string =~ /^\h{64}$/
end
|
.sha256_file(filename, lite = false) ⇒ Object
49
50
51
52
53
54
|
# File 'lib/puppet/util/checksums.rb', line 49
def sha256_file(filename, lite = false)
require 'digest/sha2'
digest = Digest::SHA256.new
checksum_file(digest, filename, lite)
end
|
.sha256_hex_length ⇒ Object
62
63
64
|
# File 'lib/puppet/util/checksums.rb', line 62
def sha256_hex_length
64
end
|
.sha256_stream(lite = false, &block) ⇒ Object
56
57
58
59
60
|
# File 'lib/puppet/util/checksums.rb', line 56
def sha256_stream(lite = false, &block)
require 'digest/sha2'
digest = Digest::SHA256.new
checksum_stream(digest, block, lite)
end
|
.sha256lite(content) ⇒ Object
66
67
68
|
# File 'lib/puppet/util/checksums.rb', line 66
def sha256lite(content)
sha256(content[0..511])
end
|
.sha256lite?(string) ⇒ Boolean
70
71
72
|
# File 'lib/puppet/util/checksums.rb', line 70
def sha256lite?(string)
sha256?(string)
end
|
.sha256lite_file(filename) ⇒ Object
74
75
76
|
# File 'lib/puppet/util/checksums.rb', line 74
def sha256lite_file(filename)
sha256_file(filename, true)
end
|
.sha256lite_hex_length ⇒ Object
82
83
84
|
# File 'lib/puppet/util/checksums.rb', line 82
def sha256lite_hex_length
sha256_hex_length
end
|
.sha256lite_stream(&block) ⇒ Object
78
79
80
|
# File 'lib/puppet/util/checksums.rb', line 78
def sha256lite_stream(&block)
sha256_stream(true, &block)
end
|
.sha384(content) ⇒ Object
Calculate a checksum using Digest::SHA384.
87
88
89
90
|
# File 'lib/puppet/util/checksums.rb', line 87
def sha384(content)
require 'digest/sha2'
Digest::SHA384.hexdigest(content)
end
|
.sha384?(string) ⇒ Boolean
92
93
94
|
# File 'lib/puppet/util/checksums.rb', line 92
def sha384?(string)
string =~ /^\h{96}$/
end
|
.sha384_file(filename, lite = false) ⇒ Object
96
97
98
99
100
101
|
# File 'lib/puppet/util/checksums.rb', line 96
def sha384_file(filename, lite = false)
require 'digest/sha2'
digest = Digest::SHA384.new
checksum_file(digest, filename, lite)
end
|
.sha384_hex_length ⇒ Object
109
110
111
|
# File 'lib/puppet/util/checksums.rb', line 109
def sha384_hex_length
96
end
|
.sha384_stream(lite = false, &block) ⇒ Object
103
104
105
106
107
|
# File 'lib/puppet/util/checksums.rb', line 103
def sha384_stream(lite = false, &block)
require 'digest/sha2'
digest = Digest::SHA384.new
checksum_stream(digest, block, lite)
end
|
.sha512(content) ⇒ Object
Calculate a checksum using Digest::SHA512.
114
115
116
117
|
# File 'lib/puppet/util/checksums.rb', line 114
def sha512(content)
require 'digest/sha2'
Digest::SHA512.hexdigest(content)
end
|
.sha512?(string) ⇒ Boolean
119
120
121
|
# File 'lib/puppet/util/checksums.rb', line 119
def sha512?(string)
string =~ /^\h{128}$/
end
|
.sha512_file(filename, lite = false) ⇒ Object
123
124
125
126
127
128
|
# File 'lib/puppet/util/checksums.rb', line 123
def sha512_file(filename, lite = false)
require 'digest/sha2'
digest = Digest::SHA512.new
checksum_file(digest, filename, lite)
end
|
.sha512_hex_length ⇒ Object
136
137
138
|
# File 'lib/puppet/util/checksums.rb', line 136
def sha512_hex_length
128
end
|
.sha512_stream(lite = false, &block) ⇒ Object
130
131
132
133
134
|
# File 'lib/puppet/util/checksums.rb', line 130
def sha512_stream(lite = false, &block)
require 'digest/sha2'
digest = Digest::SHA512.new
checksum_stream(digest, block, lite)
end
|
.sumdata(checksum) ⇒ Object
Strip the checksum type from an existing checksum
30
31
32
|
# File 'lib/puppet/util/checksums.rb', line 30
def sumdata(checksum)
checksum =~ /^\{(\w+)\}(.+)/ ? $2 : nil
end
|
.sumtype(checksum) ⇒ Object
Strip the checksum type from an existing checksum
35
36
37
|
# File 'lib/puppet/util/checksums.rb', line 35
def sumtype(checksum)
checksum =~ /^\{(\w+)\}/ ? $1 : nil
end
|