Module: Puppet::Util::Checksums

Included in:
DataSync, FileBucket::Dipper, FileBucketFile::File, FileServing::Metadata, Resource::Catalog::Compiler
Defined in:
lib/puppet/util/checksums.rb

Overview

A stand-alone module for calculating checksums in a generic way.

Defined Under Namespace

Classes: DigestLite, FakeChecksum

Class Method Summary collapse

Class Method Details

.checksum?(string) ⇒ Boolean

Is the provided string a checksum?

Returns:

  • (Boolean) 


24
25
26
27
 
# File 'lib/puppet/util/checksums.rb', line 24

def checksum?(string)
  # 'sha256lite'.length == 10
  string =~ /^\{(\w{3,10})\}\S+/
end

.checksum_file(digest, filename, lite = false) ⇒ Object

Perform an incremental checksum on a file.



265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/puppet/util/checksums.rb', line 265

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 



277
278
279
280
 
# File 'lib/puppet/util/checksums.rb', line 277

def checksum_stream(digest, block, lite = false)
  block.call(DigestLite.new(digest, lite))
  digest.hexdigest
end

.ctime(content) ⇒ Object 



202
203
204
 
# File 'lib/puppet/util/checksums.rb', line 202

def ctime(content)
  ""
end

.ctime?(string) ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
209
210
211
 
# File 'lib/puppet/util/checksums.rb', line 206

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.



214
215
216
 
# File 'lib/puppet/util/checksums.rb', line 214

def ctime_file(filename)
  Puppet::FileSystem.stat(filename).send(:ctime)
end

.ctime_stream(&block) ⇒ Object 



218
219
220
 
# File 'lib/puppet/util/checksums.rb', line 218

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,
    :mtime, :ctime, :none]
end

.md5(content) ⇒ Object

Calculate a checksum using Digest::MD5.



87
88
89
 
# File 'lib/puppet/util/checksums.rb', line 87

def md5(content)
  Digest::MD5.hexdigest(content)
end

.md5?(string) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/puppet/util/checksums.rb', line 91

def md5?(string)
  string =~ /^\h{32}$/
end

.md5_file(filename, lite = false) ⇒ Object

Calculate a checksum of a file’s content using Digest::MD5.



96
97
98
99
 
# File 'lib/puppet/util/checksums.rb', line 96

def md5_file(filename, lite = false)
  digest = Digest::MD5.new
  checksum_file(digest, filename,  lite)
end

.md5_hex_length ⇒ Object 



106
107
108
 
# File 'lib/puppet/util/checksums.rb', line 106

def md5_hex_length
  32
end

.md5_stream(lite = false, &block) ⇒ Object 



101
102
103
104
 
# File 'lib/puppet/util/checksums.rb', line 101

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.



111
112
113
 
# File 'lib/puppet/util/checksums.rb', line 111

def md5lite(content)
  md5(content[0..511])
end

.md5lite?(string) ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/puppet/util/checksums.rb', line 115

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.



120
121
122
 
# File 'lib/puppet/util/checksums.rb', line 120

def md5lite_file(filename)
  md5_file(filename, true)
end

.md5lite_hex_length ⇒ Object 



128
129
130
 
# File 'lib/puppet/util/checksums.rb', line 128

def md5lite_hex_length
  md5_hex_length
end

.md5lite_stream(&block) ⇒ Object 



124
125
126
 
# File 'lib/puppet/util/checksums.rb', line 124

def md5lite_stream(&block)
  md5_stream(true, &block)
end

.mtime(content) ⇒ Object 



132
133
134
 
# File 'lib/puppet/util/checksums.rb', line 132

def mtime(content)
  ""
end

.mtime?(string) ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
139
140
141
 
# File 'lib/puppet/util/checksums.rb', line 136

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.



144
145
146
 
# File 'lib/puppet/util/checksums.rb', line 144

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

Yields:

  • (noop_digest) 


150
151
152
153
154
 
# File 'lib/puppet/util/checksums.rb', line 150

def mtime_stream(&block)
  noop_digest = FakeChecksum.new
  yield noop_digest
  nil
end

.none(content) ⇒ Object 



222
223
224
 
# File 'lib/puppet/util/checksums.rb', line 222

def none(content)
  ""
end

.none?(string) ⇒ Boolean

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/puppet/util/checksums.rb', line 226

def none?(string)
  string.empty?
end

.none_file(filename) ⇒ Object

Return a “no checksum”



231
232
233
 
# File 'lib/puppet/util/checksums.rb', line 231

def none_file(filename)
  ""
end

.none_stream {|noop_digest| ... } ⇒ Object

Yields:

  • (noop_digest) 


235
236
237
238
239
 
# File 'lib/puppet/util/checksums.rb', line 235

def none_stream
  noop_digest = FakeChecksum.new
  yield noop_digest
  ""
end

.sha1(content) ⇒ Object

Calculate a checksum using Digest::SHA1.



157
158
159
 
# File 'lib/puppet/util/checksums.rb', line 157

def sha1(content)
  Digest::SHA1.hexdigest(content)
end

.sha1?(string) ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/puppet/util/checksums.rb', line 161

def sha1?(string)
  string =~ /^\h{40}$/
end

.sha1_file(filename, lite = false) ⇒ Object

Calculate a checksum of a file’s content using Digest::SHA1.



166
167
168
169
 
# File 'lib/puppet/util/checksums.rb', line 166

def sha1_file(filename, lite = false)
  digest = Digest::SHA1.new
  checksum_file(digest, filename, lite)
end

.sha1_hex_length ⇒ Object 



176
177
178
 
# File 'lib/puppet/util/checksums.rb', line 176

def sha1_hex_length
  40
end

.sha1_stream(lite = false, &block) ⇒ Object 



171
172
173
174
 
# File 'lib/puppet/util/checksums.rb', line 171

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.



181
182
183
 
# File 'lib/puppet/util/checksums.rb', line 181

def sha1lite(content)
  sha1(content[0..511])
end

.sha1lite?(string) ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/puppet/util/checksums.rb', line 185

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.



190
191
192
 
# File 'lib/puppet/util/checksums.rb', line 190

def sha1lite_file(filename)
  sha1_file(filename, true)
end

.sha1lite_hex_length ⇒ Object 



198
199
200
 
# File 'lib/puppet/util/checksums.rb', line 198

def sha1lite_hex_length
  sha1_hex_length
end

.sha1lite_stream(&block) ⇒ Object 



194
195
196
 
# File 'lib/puppet/util/checksums.rb', line 194

def sha1lite_stream(&block)
  sha1_stream(true, &block)
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

Returns:

  • (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

Returns:

  • (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

.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