Module: SIRP

Included in:
Client, Verifier
Defined in:
lib/sirp/sirp.rb,
lib/sirp/client.rb,
lib/sirp/version.rb,
lib/sirp/verifier.rb,
lib/sirp/parameters.rb

Defined Under Namespace

Classes: Client, Verifier

Constant Summary collapse

VERSION =
'2.0.1'.freeze

Instance Method Summary collapse

Instance Method Details

#calc_A(a, n, g) ⇒ Object

A = g^a (mod N)


128
129
130
# File 'lib/sirp/sirp.rb', line 128

def calc_A(a, n, g)
  mod_exp(g, a, n)
end

#calc_B(b, k, v, n, g) ⇒ Object

B = g^b + k v (mod N)


133
134
135
# File 'lib/sirp/sirp.rb', line 133

def calc_B(b, k, v, n, g)
  (mod_exp(g, b, n) + k * v) % n
end

#calc_client_S(bb, a, k, x, u, n, g) ⇒ Object

Client secret S = (B - (k * g^x)) ^ (a + (u * x)) % N


139
140
141
# File 'lib/sirp/sirp.rb', line 139

def calc_client_S(bb, a, k, x, u, n, g)
  mod_exp((bb - k * mod_exp(g, x, n)) % n, (a + x * u), n)
end

#calc_H_AMK(xaa, xmm, xkk, hash_klass) ⇒ Object

H(A, M, K)


159
160
161
162
# File 'lib/sirp/sirp.rb', line 159

def calc_H_AMK(xaa, xmm, xkk, hash_klass)
  byte_string = hex_to_bytes([xaa, xmm, xkk].join('')).pack('C*')
  sha_str(byte_string, hash_klass).hex
end

#calc_k(n, g, hash_klass) ⇒ Object

Multiplier parameter k = H(N, g) (in SRP-6a)


104
105
106
# File 'lib/sirp/sirp.rb', line 104

def calc_k(n, g, hash_klass)
  H(hash_klass, n, n, g)
end

#calc_M(xaa, xbb, xkk, hash_klass) ⇒ Object

M = H(A, B, K)


150
151
152
153
154
155
156
# File 'lib/sirp/sirp.rb', line 150

def calc_M(xaa, xbb, xkk, hash_klass)
  digester = hash_klass.new
  digester << hex_to_bytes(xaa).pack('C*')
  digester << hex_to_bytes(xbb).pack('C*')
  digester << hex_to_bytes(xkk).pack('C*')
  digester.hexdigest
end

#calc_server_S(aa, b, v, u, n) ⇒ Object

Server secret S = (A * v^u) ^ b % N


145
146
147
# File 'lib/sirp/sirp.rb', line 145

def calc_server_S(aa, b, v, u, n)
  mod_exp((mod_exp(v, u, n) * aa), b, n)
end

#calc_u(xaa, xbb, n, hash_klass) ⇒ Object

Random scrambling parameter u = H(A, B)


117
118
119
# File 'lib/sirp/sirp.rb', line 117

def calc_u(xaa, xbb, n, hash_klass)
  H(hash_klass, n, xaa, xbb)
end

#calc_v(x, n, g) ⇒ Object

Password verifier v = g^x (mod N)


123
124
125
# File 'lib/sirp/sirp.rb', line 123

def calc_v(x, n, g)
  mod_exp(g, x, n)
end

#calc_x(username, password, salt, hash_klass) ⇒ Object

Private key (derived from username, raw password and salt) x = H(salt || H(username || ':' || password))


110
111
112
113
# File 'lib/sirp/sirp.rb', line 110

def calc_x(username, password, salt, hash_klass)
  spad = salt.length.odd? ? '0' : ''
  sha_hex(spad + salt + sha_str([username, password].join(':'), hash_klass), hash_klass).hex
end

#H(hash_klass, n, *a) ⇒ Object

Hashing function with padding. Input is prefixed with 0 to meet N hex width.


87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/sirp/sirp.rb', line 87

def H(hash_klass, n, *a)
  nlen = 2 * ((('%x' % [n]).length * 4 + 7) >> 3)

  hashin = a.map do |s|
    next unless s
    shex = s.is_a?(String) ? s : num_to_hex(s)
    if shex.length > nlen
      raise 'Bit width does not match - client uses different prime'
    end
    '0' * (nlen - shex.length) + shex
  end.join('')

  sha_hex(hashin, hash_klass).hex % n
end

#hex_to_bytes(str) ⇒ Array<Integer>

Convert a hex string to an a array of Integer bytes by first converting the String to hex, and then converting that hex to an Array of Integer bytes.

Parameters:

  • str (String)

    a string to convert

Returns:

  • (Array<Integer>)

    an Array of Integer bytes


8
9
10
# File 'lib/sirp/sirp.rb', line 8

def hex_to_bytes(str)
  [str].pack('H*').unpack('C*')
end

#mod_exp(a, b, m) ⇒ Object


80
81
82
83
# File 'lib/sirp/sirp.rb', line 80

def mod_exp(a, b, m)
  # Use OpenSSL::BN#mod_exp
  a.to_bn.mod_exp(b, m)
end

#Ng(group) ⇒ Object


2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
# File 'lib/sirp/parameters.rb', line 2

def Ng(group)
  case group
  when 1024
    @N = %w(
      EEAF0AB9 ADB38DD6 9C33F80A FA8FC5E8 60726187 75FF3C0B 9EA2314C
      9C256576 D674DF74 96EA81D3 383B4813 D692C6E0 E0D5D8E2 50B98BE4
      8E495C1D 6089DAD1 5DC7D7B4 6154D6B6 CE8EF4AD 69B15D49 82559B29
      7BCF1885 C529F566 660E57EC 68EDBC3C 05726CC0 2FD4CBF4 976EAA9A
      FD5138FE 8376435B 9FC61D2F C0EB06E3
    ).join.hex
    @g = 2
    @hash = Digest::SHA1

  when 1536
    @N = %w(
      9DEF3CAF B939277A B1F12A86 17A47BBB DBA51DF4 99AC4C80 BEEEA961
      4B19CC4D 5F4F5F55 6E27CBDE 51C6A94B E4607A29 1558903B A0D0F843
      80B655BB 9A22E8DC DF028A7C EC67F0D0 8134B1C8 B9798914 9B609E0B
      E3BAB63D 47548381 DBC5B1FC 764E3F4B 53DD9DA1 158BFD3E 2B9C8CF5
      6EDF0195 39349627 DB2FD53D 24B7C486 65772E43 7D6C7F8C E442734A
      F7CCB7AE 837C264A E3A9BEB8 7F8A2FE9 B8B5292E 5A021FFF 5E91479E
      8CE7A28C 2442C6F3 15180F93 499A234D CF76E3FE D135F9BB
    ).join.hex
    @g = 2
    @hash = Digest::SHA1

  when 2048
    @N = %w(
      AC6BDB41 324A9A9B F166DE5E 1389582F AF72B665 1987EE07 FC319294
      3DB56050 A37329CB B4A099ED 8193E075 7767A13D D52312AB 4B03310D
      CD7F48A9 DA04FD50 E8083969 EDB767B0 CF609517 9A163AB3 661A05FB
      D5FAAAE8 2918A996 2F0B93B8 55F97993 EC975EEA A80D740A DBF4FF74
      7359D041 D5C33EA7 1D281E44 6B14773B CA97B43A 23FB8016 76BD207A
      436C6481 F1D2B907 8717461A 5B9D32E6 88F87748 544523B5 24B0D57D
      5EA77A27 75D2ECFA 032CFBDB F52FB378 61602790 04E57AE6 AF874E73
      03CE5329 9CCC041C 7BC308D8 2A5698F3 A8D0C382 71AE35F8 E9DBFBB6
      94B5C803 D89F7AE4 35DE236D 525F5475 9B65E372 FCD68EF2 0FA7111F
      9E4AFF73
    ).join.hex
    @g = 2
    @hash = Digest::SHA256

  when 3072
    @N = %w(
      FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08
      8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B
      302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9
      A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6
      49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8
      FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D
      670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C
      180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718
      3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D
      04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D
      B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226
      1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C
      BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC
      E0FD108E 4B82D120 A93AD2CA FFFFFFFF FFFFFFFF
    ).join.hex
    @g = 5
    @hash = Digest::SHA256

  when 4096
    @N = %w(
      FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08
      8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B
      302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9
      A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6
      49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8
      FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D
      670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C
      180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718
      3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D
      04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D
      B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226
      1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C
      BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC
      E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7 88719A10 BDBA5B26
      99C32718 6AF4E23C 1A946834 B6150BDA 2583E9CA 2AD44CE8 DBBBC2DB
      04DE8EF9 2E8EFC14 1FBECAA6 287C5947 4E6BC05D 99B2964F A090C3A2
      233BA186 515BE7ED 1F612970 CEE2D7AF B81BDD76 2170481C D0069127
      D5B05AA9 93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34063199
      FFFFFFFF FFFFFFFF
    ).join.hex
    @g = 5
    @hash = Digest::SHA256

  when 6144
    @N = %w(
      FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08
      8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B
      302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9
      A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6
      49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8
      FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D
      670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C
      180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718
      3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D
      04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D
      B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226
      1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C
      BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC
      E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7 88719A10 BDBA5B26
      99C32718 6AF4E23C 1A946834 B6150BDA 2583E9CA 2AD44CE8 DBBBC2DB
      04DE8EF9 2E8EFC14 1FBECAA6 287C5947 4E6BC05D 99B2964F A090C3A2
      233BA186 515BE7ED 1F612970 CEE2D7AF B81BDD76 2170481C D0069127
      D5B05AA9 93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34028492
      36C3FAB4 D27C7026 C1D4DCB2 602646DE C9751E76 3DBA37BD F8FF9406
      AD9E530E E5DB382F 413001AE B06A53ED 9027D831 179727B0 865A8918
      DA3EDBEB CF9B14ED 44CE6CBA CED4BB1B DB7F1447 E6CC254B 33205151
      2BD7AF42 6FB8F401 378CD2BF 5983CA01 C64B92EC F032EA15 D1721D03
      F482D7CE 6E74FEF6 D55E702F 46980C82 B5A84031 900B1C9E 59E7C97F
      BEC7E8F3 23A97A7E 36CC88BE 0F1D45B7 FF585AC5 4BD407B2 2B4154AA
      CC8F6D7E BF48E1D8 14CC5ED2 0F8037E0 A79715EE F29BE328 06A1D58B
      B7C5DA76 F550AA3D 8A1FBFF0 EB19CCB1 A313D55C DA56C9EC 2EF29632
      387FE8D7 6E3C0468 043E8F66 3F4860EE 12BF2D5B 0B7474D6 E694F91E
      6DCC4024 FFFFFFFF FFFFFFFF
    ).join.hex
    @g = 5
    @hash = Digest::SHA256

  when 8192
    @N = %w(
      FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08
      8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B
      302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9
      A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6
      49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8
      FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D
      670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C
      180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718
      3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D
      04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D
      B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226
      1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C
      BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC
      E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7 88719A10 BDBA5B26
      99C32718 6AF4E23C 1A946834 B6150BDA 2583E9CA 2AD44CE8 DBBBC2DB
      04DE8EF9 2E8EFC14 1FBECAA6 287C5947 4E6BC05D 99B2964F A090C3A2
      233BA186 515BE7ED 1F612970 CEE2D7AF B81BDD76 2170481C D0069127
      D5B05AA9 93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34028492
      36C3FAB4 D27C7026 C1D4DCB2 602646DE C9751E76 3DBA37BD F8FF9406
      AD9E530E E5DB382F 413001AE B06A53ED 9027D831 179727B0 865A8918
      DA3EDBEB CF9B14ED 44CE6CBA CED4BB1B DB7F1447 E6CC254B 33205151
      2BD7AF42 6FB8F401 378CD2BF 5983CA01 C64B92EC F032EA15 D1721D03
      F482D7CE 6E74FEF6 D55E702F 46980C82 B5A84031 900B1C9E 59E7C97F
      BEC7E8F3 23A97A7E 36CC88BE 0F1D45B7 FF585AC5 4BD407B2 2B4154AA
      CC8F6D7E BF48E1D8 14CC5ED2 0F8037E0 A79715EE F29BE328 06A1D58B
      B7C5DA76 F550AA3D 8A1FBFF0 EB19CCB1 A313D55C DA56C9EC 2EF29632
      387FE8D7 6E3C0468 043E8F66 3F4860EE 12BF2D5B 0B7474D6 E694F91E
      6DBE1159 74A3926F 12FEE5E4 38777CB6 A932DF8C D8BEC4D0 73B931BA
      3BC832B6 8D9DD300 741FA7BF 8AFC47ED 2576F693 6BA42466 3AAB639C
      5AE4F568 3423B474 2BF1C978 238F16CB E39D652D E3FDB8BE FC848AD9
      22222E04 A4037C07 13EB57A8 1A23F0C7 3473FC64 6CEA306B 4BCBC886
      2F8385DD FA9D4B7F A2C087E8 79683303 ED5BDD3A 062B3CF5 B3A278A6
      6D2A13F8 3F44F82D DF310EE0 74AB6A36 4597E899 A0255DC1 64F31CC5
      0846851D F9AB4819 5DED7EA1 B1D510BD 7EE74D73 FAF36BC3 1ECFA268
      359046F4 EB879F92 4009438B 481C6CD7 889A002E D5EE382B C9190DA6
      FC026E47 9558E447 5677E9AA 9E3050E2 765694DF C81F56E8 80B96E71
      60C980DD 98EDD3DF FFFFFFFF FFFFFFFF
    ).join.hex
    @g = 19
    @hash = Digest::SHA256
  else
    raise ArgumentError, 'must be a known group size'
  end

  [@N, @g, @hash]
end

#num_to_hex(num) ⇒ String

Convert a number to a downcased hex string, prepending '0' to the hex string if the hex conversion resulted in an odd length string.

Parameters:

  • num (Integer)

    a number to convert to a hex string

Returns:

  • (String)

    a hex string


17
18
19
20
21
# File 'lib/sirp/sirp.rb', line 17

def num_to_hex(num)
  hex_str = num.to_s(16)
  even_hex_str = hex_str.length.odd? ? '0' + hex_str : hex_str
  even_hex_str.downcase
end

#secure_compare(a, b) ⇒ true, false

Constant time string comparison. Extracted from Rack::Utils github.com/rack/rack/blob/master/lib/rack/utils.rb

NOTE: the values compared should be of fixed length, such as strings that have already been processed by HMAC. This should not be used on variable length plaintext strings because it could leak length info via timing attacks. The user provided value should always be passed in as the second parameter so as not to leak info about the secret.

Parameters:

  • a (String)

    the private value

  • b (String)

    the user provided value

Returns:

  • (true, false)

    whether the strings match or not


65
66
67
68
69
70
71
72
73
# File 'lib/sirp/sirp.rb', line 65

def secure_compare(a, b)
  return false unless a.bytesize == b.bytesize

  l = a.unpack('C*')

  r, i = 0, -1
  b.each_byte { |v| r |= v ^ l[i+=1] }
  r == 0
end

#sha_hex(h, hash_klass) ⇒ String

Applies a one-way hash function, either SHA1 or SHA256, on an unpacked hex string. It will generate the same one-way hash value for a string that has been unpacked as if the hash function had been applied to the string directly.

'foo'.unpack('H*')
=> ["666f6f"]

> sha_hex('foo'.unpack('H*')[0], Digest::SHA256)
=> "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"
> Digest::SHA256.hexdigest 'foo'
=> "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"

Parameters:

  • h (String)

    a hex string to hash

  • hash_klass (Digest::SHA1, Digest::SHA256)

    The hash class that responds to hexdigest

Returns:

  • (String)

    a hex string representing the result of the one way hash function


39
40
41
# File 'lib/sirp/sirp.rb', line 39

def sha_hex(h, hash_klass)
  hash_klass.hexdigest([h].pack('H*'))
end

#sha_str(s, hash_klass) ⇒ String

Applies a one-way hash function, either SHA1 or SHA256, on the string provided.

Parameters:

  • s (String)

    a string to hash

  • hash_klass (Digest::SHA1, Digest::SHA256)

    The hash class that responds to hexdigest

Returns:

  • (String)

    a hex string representing the result of the one way hash function


48
49
50
# File 'lib/sirp/sirp.rb', line 48

def sha_str(s, hash_klass)
  hash_klass.hexdigest(s)
end