Class: Ccrypto::Java::DigestEngine

Inherits:
Object
  • Object
show all
Includes:
DataConversion, TR::CondUtils
Defined in:
lib/ccrypto/java/engines/digest_engine.rb

Defined Under Namespace

Classes: SupportedDigestEngine

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DataConversion

#from_b64, #from_b64_mime, #from_hex, included, #to_b64, #to_b64_mime, #to_bin, #to_hex, #to_java_bytes, #to_str

Constructor Details

#initialize(algo, prov = nil, &block) ⇒ DigestEngine

Returns a new instance of DigestEngine.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 243

def initialize(algo, prov = nil, &block)
  
  logger.debug "Algo : #{algo}"

  @algo = algo 
  begin
    if not_empty?(prov)
      @native_instance = java.security.MessageDigest.getInstance(@algo, prov)
    else
      @native_instance = java.security.MessageDigest.getInstance(@algo)
    end
  rescue Exception => ex
    raise DigestEngineException, ex
  end
end

Instance Attribute Details

#native_instance ⇒ Object (readonly)

Instance method



242
243
244
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 242

def native_instance
  @native_instance
end

Class Method Details

.find_digest_config(key) ⇒ Object 



103
104
105
106
107
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 103

def self.find_digest_config(key)
  res = supported.find(algo: key)
  res.concat(supported.find(jceAlgo: key))
  res.uniq
end

.instance(conf, &block) ⇒ Object

Raises:

  • (DigestEngineException) 


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 80

def self.instance(conf, &block)

  case conf
  when String, Symbol
    digEng = find_digest_config(conf)
  when Ccrypto::DigestConfig
    digEng = conf
  else
    raise DigestEngineException, "Unsupported instance type '#{conf}'"
  end

  raise DigestEngineException, "Unsupported digest type '#{conf}'" if digEng.nil?

  prov = digEng.provider_config[:jceProvider]
  if not_empty?(prov)
    JCEProvider.instance.add_provider(prov) if not JCEProvider.instance.is_provider_registered?(prov)
    DigestEngine.new(digEng.provider_config[:algo_name], prov, &block)
  else
    DigestEngine.new(digEng.provider_config[:algo_name], &block)
  end

end

.is_digest_supported?(key) ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 76

def self.is_digest_supported?(key)
  (find_digest_config(key).length > 0)
end

.supported ⇒ Object Also known as: supported_digests 



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
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 18

def self.supported
  if @supported.nil?
    if ENV[Java::ENV_PROBE_DIGEST_KEY] == "true"
      @supported = SupportedDigestEngine.new
    else
      @supported = SupportedDigestEngine.load_from_storage("supported_digest")
    end

    if @supported.empty?
      @supported = SupportedDigestEngine.new
      probe = java.security.Security.getAlgorithms("MessageDigest").to_a.delete_if { |e| e.include?(".") }

      logger = Ccrypto::Java.logger(:digest_eng)

      blacklistedDigest = ["MD2","MD4","MD5"]
      probe.sort.each do |found|
        next if blacklistedDigest.include?(found)
        logger.debug "Found digest algo : #{found}"
        begin
          md = java.security.MessageDigest.getInstance(found, JCEProvider::BCProv)
          case found
          when "HARAKA-256"
            conf = { provider_config: { algo_name: found, jceProvider: JCEProvider::BCProv.name }, fixed_input_len_byte: 32 }
          when "HARAKA-512"
            conf = { provider_config: { algo_name: found, jceProvider: JCEProvider::BCProv.name }, fixed_input_len_byte: 64 }
          else
            conf = { provider_config: { algo_name: found, jceProvider: JCEProvider::BCProv.name } }
          end

          digConf = Ccrypto::DigestConfig.new(found, md.getDigestLength()*8, conf) 

          testDig = Ccrypto::DigestMatcher.generate_digest(digConf)
          digKey = Ccrypto::DigestMatcher.find_digest_key(testDig)
          if not_empty?(digKey)
            # map the algo name to common name
            digConf = Ccrypto::DigestConfig.new(digKey, md.getDigestLength()*8, conf) 
            @supported.register(digConf, { tag_under: :jceAlgo, tag_value: found }) 

          else
            logger.warn "Digest algo from Java named '#{found}' not listed in the Ccrypto::DigestMatcher. Skip or add the value into the table. [#{testDig}]" 

          end

        rescue Exception => ex
          logger.error ex.message
        end
      end
    end

    @supported.save_to_storage("supported_digest")

  end
  @supported
end

.to_bc_digest_inst(conf) ⇒ Object 



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
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 109

def self.to_bc_digest_inst(conf)
  case conf
  when Ccrypto::DigestConfig
    algo = conf.provider_config[:algo_name]
  when String
    algo = conf.upcase
  when Symbol
    algo = conf.to_s.upcase
  else
    raise DigestEngineException, "Unsupported query type '#{conf.class}'"
  end

  logger.debug "BC digest matching : #{conf.inspect} ==> #{algo}"

  case algo
  when "BLAKE2B-160","BLAKE2B_160"
    "org.bouncycastle.crypto.digests.Blake2bDigest.new(160)"
  when "BLAKE2B-256"
    "org.bouncycastle.crypto.digests.Blake2bDigest.new(256)"
  when "BLAKE2B-384"
    "org.bouncycastle.crypto.digests.Blake2bDigest.new(384)"
  when "BLAKE2B-512"
    "org.bouncycastle.crypto.digests.Blake2bDigest.new(512)"
  when "BLAKE2S-128"
    "org.bouncycastle.crypto.digests.Blake2sDigest.new(128)"
  when "BLAKE2S-160"
    "org.bouncycastle.crypto.digests.Blake2sDigest.new(160)"
  when "BLAKE2S-224"
    "org.bouncycastle.crypto.digests.Blake2sDigest.new(224)"
  when "BLAKE2S-256"
    "org.bouncycastle.crypto.digests.Blake2sDigest.new(256)"
  when "BLAKE3-256"
    "org.bouncycastle.crypto.digests.Blake3Digest.new #(256)"
  when "DSTU7564-256"
    "org.bouncycastle.crypto.digests.DSTU7564Digest.new(256)"
  when "DSTU7564-384"
    "org.bouncycastle.crypto.digests.DSTU7564Digest.new(384)"
  when "DSTU7564-512"
    "org.bouncycastle.crypto.digests.DSTU7564Digest.new(512)"
  when "GOST3411"
    "org.bouncycastle.crypto.digests.GOST3411Digest.new"
  when "GOST3411-2012-256"
    "org.bouncycastle.crypto.digests.GOST3411_2012_256Digest.new"
  when "GOST3411-2012-512"
    "org.bouncycastle.crypto.digests.GOST3411_2012_512Digest.new"
  #when "HARAKA-256"
  #  org.bouncycastle.crypto.digests.Haraka256Digest.new
  #when "HARAKA-512"
  #  org.bouncycastle.crypto.digests.Haraka512Digest.new
  when "KECCAK-224"
    "org.bouncycastle.crypto.digests.KeccakDigest.new(224)"
  when "KECCAK-256"
    "org.bouncycastle.crypto.digests.KeccakDigest.new(256)"
  when "KECCAK-288"
    "org.bouncycastle.crypto.digests.KeccakDigest.new(288)"
  when "KECCAK-384"
    "org.bouncycastle.crypto.digests.KeccakDigest.new(384)"
  when "KECCAK-512"
    "org.bouncycastle.crypto.digests.KeccakDigest.new(512)"
  when "RIPEMD128"
    "org.bouncycastle.crypto.digests.RIPEMD128Digest.new"
  when "RIPEMD160"
    "org.bouncycastle.crypto.digests.RIPEMD160Digest.new"
  when "RIPEMD256"
    "org.bouncycastle.crypto.digests.RIPEMD256Digest.new"
  when "SHA-1", "SHA1"
    "org.bouncycastle.crypto.digests.SHA1Digest.new"
  when "SHA-224", "SHA224"
    "org.bouncycastle.crypto.digests.SHA224Digest.new"
  when "SHA-256", "SHA256"
    "org.bouncycastle.crypto.digests.SHA256Digest.new"
  when "SHA-384", "SHA384"
    "org.bouncycastle.crypto.digests.SHA384Digest.new"
  when "SHA-512", "SHA512"
    "org.bouncycastle.crypto.digests.SHA512Digest.new"
  when "SHA3-224","SHA3_224"
    "org.bouncycastle.crypto.digests.SHA3Digest.new(224)"
  when "SHA3-256","SHA3_256"
    "org.bouncycastle.crypto.digests.SHA3Digest.new(256)"
  when "SHA3-384","SHA3_384"
    "org.bouncycastle.crypto.digests.SHA3Digest.new(384)"
  when "SHA3-512","SHA3_512"
    "org.bouncycastle.crypto.digests.SHA3Digest.new(512)"
  when "SHAKE128-256","SHAKE128_256"
    "org.bouncycastle.crypto.digests.SHAKEDigest.new(128)"
  when "SHAKE256-512","SHAKE256_512"
    "org.bouncycastle.crypto.digests.SHAKEDigest.new(256)"
  when "SKEIN-1024-1024","SKEIN_1024_1024"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(1024,1024)"
  when "SKEIN-1024-384","SKEIN_1024_384"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(1024,384)"
  when "SKEIN-1024-512","SKEIN_1024_512"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(1024,512)"
  when "SKEIN-256-128","SKEIN_256_128"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(256,128)"
  when "SKEIN-256-160","SKEIN_256_160"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(256,160)"
  when "SKEIN-256-224","SKEIN_256_224"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(256,224)"
  when "SKEIN-256-256","SKEIN_256_256"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(256,256)"
  when "SKEIN-512-128","SKEIN_512_128"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,128)"
  when "SKEIN-512-160","SKEIN_512_160"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,160)"
  when "SKEIN-512-224","SKEIN_512_224"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,224)"
  when "SKEIN-512-256","SKEIN_512_256"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,256)"
  when "SKEIN-512-384","SKEIN_512_384"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,384)"
  when "SKEIN-512-512","SKEIN_512_512"
    "org.bouncycastle.crypto.digests.SkeinDigest.new(512,512)"
  when "SM3"
    "org.bouncycastle.crypto.digests.SM3Digest.new"
  when "TIGER"
    "org.bouncycastle.crypto.digests.TigerDigest.new"
  when "WHIRLPOOL"
    "org.bouncycastle.crypto.digests.WhirlpoolDigest.new"
  end
 
end

Instance Method Details

#digest(val, output = :binary) ⇒ Object 



259
260
261
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 259

def digest(val, output = :binary)
  digest_final(val, output)
end

#digest_final(val = nil, output = :binary) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 267

def digest_final(val = nil, output = :binary)
  if not_empty?(val)
    @native_instance.update(to_java_bytes(val))
  end
  res = @native_instance.digest
  @native_instance.reset
  case output
  when :hex
    to_hex(res)
  when :b64
    to_b64(res)
  else
    res
  end
end

#digest_update(val) ⇒ Object 



263
264
265
 
# File 'lib/ccrypto/java/engines/digest_engine.rb', line 263

def digest_update(val)
  @native_instance.update(to_java_bytes(val))
end