Class: Net::SSH::Transport::HMAC::Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/net/ssh/transport/hmac/abstract.rb

Overview

The base class of all OpenSSL-based HMAC algorithm wrappers.

Direct Known Subclasses

MD5, None, RIPEMD160, SHA1, SHA2_256, SHA2_512

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key = nil) ⇒ Abstract

Returns a new instance of Abstract.


62
63
64
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 62

def initialize(key=nil)
  self.key = key
end

Instance Attribute Details

#keyObject

The key in use for this instance.


60
61
62
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 60

def key
  @key
end

Class Method Details

.digest_class(*v) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 34

def digest_class(*v)
  @digest_class = nil if !defined?(@digest_class)
  if v.empty?
    @digest_class = superclass.digest_class if @digest_class.nil? && superclass.respond_to?(:digest_class)
    return @digest_class
  elsif v.length == 1
    @digest_class = v.first
  else
    raise ArgumentError, "wrong number of arguments (#{v.length} for 1)"
  end
end

.key_length(*v) ⇒ Object


10
11
12
13
14
15
16
17
18
19
20
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 10

def key_length(*v)
  @key_length = nil if !defined?(@key_length)
  if v.empty?
    @key_length = superclass.key_length if @key_length.nil? && superclass.respond_to?(:key_length)
    return @key_length
  elsif v.length == 1
    @key_length = v.first
  else
    raise ArgumentError, "wrong number of arguments (#{v.length} for 1)"
  end
end

.mac_length(*v) ⇒ Object


22
23
24
25
26
27
28
29
30
31
32
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 22

def mac_length(*v)
  @mac_length = nil if !defined?(@mac_length)
  if v.empty?
    @mac_length = superclass.mac_length if @mac_length.nil? && superclass.respond_to?(:mac_length)
    return @mac_length
  elsif v.length == 1
    @mac_length = v.first
  else
    raise ArgumentError, "wrong number of arguments (#{v.length} for 1)"
  end
end

Instance Method Details

#digest(data) ⇒ Object

Compute the HMAC digest for the given data string.


73
74
75
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 73

def digest(data)
  OpenSSL::HMAC.digest(digest_class.new, key, data)[0,mac_length]
end

#digest_classObject


55
56
57
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 55

def digest_class
  self.class.digest_class
end

#key_lengthObject


47
48
49
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 47

def key_length
  self.class.key_length
end

#mac_lengthObject


51
52
53
# File 'lib/net/ssh/transport/hmac/abstract.rb', line 51

def mac_length
  self.class.mac_length
end