tests/sys/opencrypto/cryptotest.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2014 The FreeBSD Foundation
   4 # All rights reserved.
   5 #
   6 # This software was developed by John-Mark Gurney under
   7 # the sponsorship from the FreeBSD Foundation.
   8 # Redistribution and use in source and binary forms, with or without
   9 # modification, are permitted provided that the following conditions
  10 # are met:
  11 # 1.  Redistributions of source code must retain the above copyright
  12 #     notice, this list of conditions and the following disclaimer.
  13 # 2.  Redistributions in binary form must reproduce the above copyright
  14 #     notice, this list of conditions and the following disclaimer in the
  15 #     documentation and/or other materials provided with the distribution.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 # SUCH DAMAGE.
  28 #
  29 # $FreeBSD$
  30 #
  31
  32 from __future__ import print_function
  33 import cryptodev
  34 import itertools
  35 import os
  36 import struct
  37 import unittest
  38 from cryptodev import *
  39 from glob import iglob
  40
  41 katdir = '/usr/local/share/nist-kat'
  42
  43 def katg(base, glob):
  44         assert os.path.exists(os.path.join(katdir, base)), "Please 'pkg install nist-kat'"
  45         return iglob(os.path.join(katdir, base, glob))
  46
  47 aesmodules = [ 'cryptosoft0', 'aesni0', 'ccr0' ]
  48 desmodules = [ 'cryptosoft0', ]
  49 shamodules = [ 'cryptosoft0', 'ccr0' ]
  50
  51 def GenTestCase(cname):
  52         try:
  53                 crid = cryptodev.Crypto.findcrid(cname)
  54         except IOError:
  55                 return None
  56
  57         class GendCryptoTestCase(unittest.TestCase):
  58                 ###############
  59                 ##### AES #####
  60                 ###############
  61                 @unittest.skipIf(cname not in aesmodules, 'skipping AES on %s' % (cname))
  62                 def test_xts(self):
  63                         for i in katg('XTSTestVectors/format tweak value input - data unit seq no', '*.rsp'):
  64                                 self.runXTS(i, cryptodev.CRYPTO_AES_XTS)
  65
  66                 @unittest.skipIf(cname not in aesmodules, 'skipping AES on %s' % (cname))
  67                 def test_cbc(self):
  68                         for i in katg('KAT_AES', 'CBC[GKV]*.rsp'):
  69                                 self.runCBC(i)
  70
  71                 @unittest.skipIf(cname not in aesmodules, 'skipping AES on %s' % (cname))
  72                 def test_gcm(self):
  73                         for i in katg('gcmtestvectors', 'gcmEncrypt*'):
  74                                 self.runGCM(i, 'ENCRYPT')
  75
  76                         for i in katg('gcmtestvectors', 'gcmDecrypt*'):
  77                                 self.runGCM(i, 'DECRYPT')
  78
  79                 _gmacsizes = { 32: cryptodev.CRYPTO_AES_256_NIST_GMAC,
  80                         24: cryptodev.CRYPTO_AES_192_NIST_GMAC,
  81                         16: cryptodev.CRYPTO_AES_128_NIST_GMAC,
  82                 }
  83                 def runGCM(self, fname, mode):
  84                         curfun = None
  85                         if mode == 'ENCRYPT':
  86                                 swapptct = False
  87                                 curfun = Crypto.encrypt
  88                         elif mode == 'DECRYPT':
  89                                 swapptct = True
  90                                 curfun = Crypto.decrypt
  91                         else:
  92                                 raise RuntimeError('unknown mode: %r' % repr(mode))
  93
  94                         for bogusmode, lines in cryptodev.KATParser(fname,
  95                             [ 'Count', 'Key', 'IV', 'CT', 'AAD', 'Tag', 'PT', ]):
  96                                 for data in lines:
  97                                         curcnt = int(data['Count'])
  98                                         cipherkey = data['Key'].decode('hex')
  99                                         iv = data['IV'].decode('hex')
 100                                         aad = data['AAD'].decode('hex')
 101                                         tag = data['Tag'].decode('hex')
 102                                         if 'FAIL' not in data:
 103                                                 pt = data['PT'].decode('hex')
 104                                         ct = data['CT'].decode('hex')
 105
 106                                         if len(iv) != 12:
 107                                                 # XXX - isn't supported
 108                                                 continue
 109
 110                                         c = Crypto(cryptodev.CRYPTO_AES_NIST_GCM_16,
 111                                             cipherkey,
 112                                             mac=self._gmacsizes[len(cipherkey)],
 113                                             mackey=cipherkey, crid=crid)
 114
 115                                         if mode == 'ENCRYPT':
 116                                                 rct, rtag = c.encrypt(pt, iv, aad)
 117                                                 rtag = rtag[:len(tag)]
 118                                                 data['rct'] = rct.encode('hex')
 119                                                 data['rtag'] = rtag.encode('hex')
 120                                                 self.assertEqual(rct, ct, repr(data))
 121                                                 self.assertEqual(rtag, tag, repr(data))
 122                                         else:
 123                                                 if len(tag) != 16:
 124                                                         continue
 125                                                 args = (ct, iv, aad, tag)
 126                                                 if 'FAIL' in data:
 127                                                         self.assertRaises(IOError,
 128                                                                 c.decrypt, *args)
 129                                                 else:
 130                                                         rpt, rtag = c.decrypt(*args)
 131                                                         data['rpt'] = rpt.encode('hex')
 132                                                         data['rtag'] = rtag.encode('hex')
 133                                                         self.assertEqual(rpt, pt,
 134                                                             repr(data))
 135
 136                 def runCBC(self, fname):
 137                         curfun = None
 138                         for mode, lines in cryptodev.KATParser(fname,
 139                             [ 'COUNT', 'KEY', 'IV', 'PLAINTEXT', 'CIPHERTEXT', ]):
 140                                 if mode == 'ENCRYPT':
 141                                         swapptct = False
 142                                         curfun = Crypto.encrypt
 143                                 elif mode == 'DECRYPT':
 144                                         swapptct = True
 145                                         curfun = Crypto.decrypt
 146                                 else:
 147                                         raise RuntimeError('unknown mode: %r' % repr(mode))
 148
 149                                 for data in lines:
 150                                         curcnt = int(data['COUNT'])
 151                                         cipherkey = data['KEY'].decode('hex')
 152                                         iv = data['IV'].decode('hex')
 153                                         pt = data['PLAINTEXT'].decode('hex')
 154                                         ct = data['CIPHERTEXT'].decode('hex')
 155
 156                                         if swapptct:
 157                                                 pt, ct = ct, pt
 158                                         # run the fun
 159                                         c = Crypto(cryptodev.CRYPTO_AES_CBC, cipherkey, crid=crid)
 160                                         r = curfun(c, pt, iv)
 161                                         self.assertEqual(r, ct)
 162
 163                 def runXTS(self, fname, meth):
 164                         curfun = None
 165                         for mode, lines in cryptodev.KATParser(fname,
 166                             [ 'COUNT', 'DataUnitLen', 'Key', 'DataUnitSeqNumber', 'PT',
 167                             'CT' ]):
 168                                 if mode == 'ENCRYPT':
 169                                         swapptct = False
 170                                         curfun = Crypto.encrypt
 171                                 elif mode == 'DECRYPT':
 172                                         swapptct = True
 173                                         curfun = Crypto.decrypt
 174                                 else:
 175                                         raise RuntimeError('unknown mode: %r' % repr(mode))
 176
 177                                 for data in lines:
 178                                         curcnt = int(data['COUNT'])
 179                                         nbits = int(data['DataUnitLen'])
 180                                         cipherkey = data['Key'].decode('hex')
 181                                         iv = struct.pack('QQ', int(data['DataUnitSeqNumber']), 0)
 182                                         pt = data['PT'].decode('hex')
 183                                         ct = data['CT'].decode('hex')
 184
 185                                         if nbits % 128 != 0:
 186                                                 # XXX - mark as skipped
 187                                                 continue
 188                                         if swapptct:
 189                                                 pt, ct = ct, pt
 190                                         # run the fun
 191                                         c = Crypto(meth, cipherkey, crid=crid)
 192                                         r = curfun(c, pt, iv)
 193                                         self.assertEqual(r, ct)
 194
 195                 ###############
 196                 ##### DES #####
 197                 ###############
 198                 @unittest.skipIf(cname not in desmodules, 'skipping DES on %s' % (cname))
 199                 def test_tdes(self):
 200                         for i in katg('KAT_TDES', 'TCBC[a-z]*.rsp'):
 201                                 self.runTDES(i)
 202
 203                 def runTDES(self, fname):
 204                         curfun = None
 205                         for mode, lines in cryptodev.KATParser(fname,
 206                             [ 'COUNT', 'KEYs', 'IV', 'PLAINTEXT', 'CIPHERTEXT', ]):
 207                                 if mode == 'ENCRYPT':
 208                                         swapptct = False
 209                                         curfun = Crypto.encrypt
 210                                 elif mode == 'DECRYPT':
 211                                         swapptct = True
 212                                         curfun = Crypto.decrypt
 213                                 else:
 214                                         raise RuntimeError('unknown mode: %r' % repr(mode))
 215
 216                                 for data in lines:
 217                                         curcnt = int(data['COUNT'])
 218                                         key = data['KEYs'] * 3
 219                                         cipherkey = key.decode('hex')
 220                                         iv = data['IV'].decode('hex')
 221                                         pt = data['PLAINTEXT'].decode('hex')
 222                                         ct = data['CIPHERTEXT'].decode('hex')
 223
 224                                         if swapptct:
 225                                                 pt, ct = ct, pt
 226                                         # run the fun
 227                                         c = Crypto(cryptodev.CRYPTO_3DES_CBC, cipherkey, crid=crid)
 228                                         r = curfun(c, pt, iv)
 229                                         self.assertEqual(r, ct)
 230
 231                 ###############
 232                 ##### SHA #####
 233                 ###############
 234                 @unittest.skipIf(cname not in shamodules, 'skipping SHA on %s' % str(cname))
 235                 def test_sha(self):
 236                         # SHA not available in software
 237                         pass
 238                         #for i in iglob('SHA1*'):
 239                         #       self.runSHA(i)
 240
 241                 @unittest.skipIf(cname not in shamodules, 'skipping SHA on %s' % str(cname))
 242                 def test_sha1hmac(self):
 243                         for i in katg('hmactestvectors', 'HMAC.rsp'):
 244                                 self.runSHA1HMAC(i)
 245
 246                 def runSHA1HMAC(self, fname):
 247                         for hashlength, lines in cryptodev.KATParser(fname,
 248                             [ 'Count', 'Klen', 'Tlen', 'Key', 'Msg', 'Mac' ]):
 249                                 # E.g., hashlength will be "L=20" (bytes)
 250                                 hashlen = int(hashlength.split("=")[1])
 251
 252                                 blocksize = None
 253                                 if hashlen == 20:
 254                                         alg = cryptodev.CRYPTO_SHA1_HMAC
 255                                         blocksize = 64
 256                                 elif hashlen == 28:
 257                                         # Cryptodev doesn't support SHA-224
 258                                         # Slurp remaining input in section
 259                                         for data in lines:
 260                                                 continue
 261                                         continue
 262                                 elif hashlen == 32:
 263                                         alg = cryptodev.CRYPTO_SHA2_256_HMAC
 264                                         blocksize = 64
 265                                 elif hashlen == 48:
 266                                         alg = cryptodev.CRYPTO_SHA2_384_HMAC
 267                                         blocksize = 128
 268                                 elif hashlen == 64:
 269                                         alg = cryptodev.CRYPTO_SHA2_512_HMAC
 270                                         blocksize = 128
 271                                 else:
 272                                         # Skip unsupported hashes
 273                                         # Slurp remaining input in section
 274                                         for data in lines:
 275                                                 continue
 276                                         continue
 277
 278                                 for data in lines:
 279                                         key = data['Key'].decode('hex')
 280                                         msg = data['Msg'].decode('hex')
 281                                         mac = data['Mac'].decode('hex')
 282                                         tlen = int(data['Tlen'])
 283
 284                                         if len(key) > blocksize:
 285                                                 continue
 286
 287                                         c = Crypto(mac=alg, mackey=key,
 288                                             crid=crid)
 289
 290                                         _, r = c.encrypt(msg, iv="")
 291
 292                                         # A limitation in cryptodev.py means we
 293                                         # can only store MACs up to 16 bytes.
 294                                         # That's good enough to validate the
 295                                         # correct behavior, more or less.
 296                                         maclen = min(tlen, 16)
 297                                         self.assertEqual(r[:maclen], mac[:maclen], "Actual: " + \
 298                                             repr(r[:maclen].encode("hex")) + " Expected: " + repr(data))
 299
 300         return GendCryptoTestCase
 301
 302 cryptosoft = GenTestCase('cryptosoft0')
 303 aesni = GenTestCase('aesni0')
 304 ccr = GenTestCase('ccr0')
 305
 306 if __name__ == '__main__':
 307         unittest.main()