Module: Lockbox::Padding

Included in:
Lockbox
Defined in:
lib/lockbox/padding.rb

Constant Summary collapse

PAD_FIRST_BYTE = 
"\x80".b
PAD_ZERO_BYTE = 
"\x00".b

Instance Method Summary collapse

Instance Method Details

#pad(str, **options) ⇒ Object 



6
7
8
 
# File 'lib/lockbox/padding.rb', line 6

def pad(str, **options)
  pad!(str.dup, **options)
end

#pad!(str, size: 16) ⇒ Object

ISO/IEC 7816-4 same as Libsodium libsodium.gitbook.io/doc/padding apply prior to encryption note: current implementation does not try to minimize side channels

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/lockbox/padding.rb', line 20

def pad!(str, size: 16)
  raise ArgumentError, "Invalid size" if size < 1

  str.force_encoding(Encoding::BINARY)

  pad_length = size - 1
  pad_length -= str.bytesize % size

  str << PAD_FIRST_BYTE
  pad_length.times do
    str << PAD_ZERO_BYTE
  end

  str
end

#unpad(str, **options) ⇒ Object 



10
11
12
 
# File 'lib/lockbox/padding.rb', line 10

def unpad(str, **options)
  unpad!(str.dup, **options)
end

#unpad!(str, size: 16) ⇒ Object

note: current implementation does not try to minimize side channels

Raises:

  • (ArgumentError) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/lockbox/padding.rb', line 38

def unpad!(str, size: 16)
  raise ArgumentError, "Invalid size" if size < 1

  str.force_encoding(Encoding::BINARY)

  i = 1
  while i <= size
    case str[-i]
    when PAD_ZERO_BYTE
      i += 1
    when PAD_FIRST_BYTE
      str.slice!(-i..-1)
      return str
    else
      break
    end
  end

  raise Lockbox::PaddingError, "Invalid padding"
end