Path: blob/main/tests/sys/opencrypto/cryptodev.py
102385 views
#!/usr/local/bin/python31#2# Copyright (c) 2014 The FreeBSD Foundation3# Copyright 2014 John-Mark Gurney4# All rights reserved.5# Copyright 2019 Enji Cooper6#7# This software was developed by John-Mark Gurney under8# the sponsorship from the FreeBSD Foundation.9# Redistribution and use in source and binary forms, with or without10# modification, are permitted provided that the following conditions11# are met:12# 1. Redistributions of source code must retain the above copyright13# notice, this list of conditions and the following disclaimer.14# 2. Redistributions in binary form must reproduce the above copyright15# notice, this list of conditions and the following disclaimer in the16# documentation and/or other materials provided with the distribution.17#18# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND19# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE21# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE22# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL23# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS24# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)25# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT26# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY27# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF28# SUCH DAMAGE.29#30#313233import array34import binascii35from fcntl import ioctl36import os37import platform38import random39import re40import signal41from struct import pack as _pack42import sys43import time4445import dpkt4647from cryptodevh import *4849__all__ = [ 'Crypto', 'MismatchError', ]5051class FindOp(dpkt.Packet):52__byte_order__ = '@'53__hdr__ = (54('crid', 'i', 0),55('name', '32s', 0),56)5758class SessionOp(dpkt.Packet):59__byte_order__ = '@'60__hdr__ = (61('cipher', 'I', 0),62('mac', 'I', 0),63('keylen', 'I', 0),64('key', 'P', 0),65('mackeylen', 'i', 0),66('mackey', 'P', 0),67('ses', 'I', 0),68)6970class SessionOp2(dpkt.Packet):71__byte_order__ = '@'72__hdr__ = (73('cipher', 'I', 0),74('mac', 'I', 0),75('keylen', 'I', 0),76('key', 'P', 0),77('mackeylen', 'i', 0),78('mackey', 'P', 0),79('ses', 'I', 0),80('crid', 'i', 0),81('ivlen', 'i', 0),82('maclen', 'i', 0),83('pad0', 'i', 0),84('pad1', 'i', 0),85)8687class CryptOp(dpkt.Packet):88__byte_order__ = '@'89__hdr__ = (90('ses', 'I', 0),91('op', 'H', 0),92('flags', 'H', 0),93('len', 'I', 0),94('src', 'P', 0),95('dst', 'P', 0),96('mac', 'P', 0),97('iv', 'P', 0),98)99100class CryptAEAD(dpkt.Packet):101__byte_order__ = '@'102__hdr__ = (103('ses', 'I', 0),104('op', 'H', 0),105('flags', 'H', 0),106('len', 'I', 0),107('aadlen', 'I', 0),108('ivlen', 'I', 0),109('src', 'P', 0),110('dst', 'P', 0),111('aad', 'P', 0),112('tag', 'P', 0),113('iv', 'P', 0),114)115116# h2py.py can't handle multiarg macros117CIOCGSESSION = 3224396645118CIOCFSESSION = 2147771238119CIOCKEY = 3230688104120CIOCASYMFEAT = 1074029417121CIOCKEY2 = 3230688107122CIOCFINDDEV = 3223610220123if platform.architecture()[0] == '64bit':124CIOCGSESSION2 = 3225445226125CIOCCRYPT = 3224396647126CIOCCRYPTAEAD = 3225445229127else:128CIOCGSESSION2 = 3224396650129CIOCCRYPT = 3223085927130CIOCCRYPTAEAD = 3223872365131132_cryptodev = os.open('/dev/crypto', os.O_RDWR)133134def str_to_ascii(val):135if sys.version_info[0] >= 3:136if isinstance(val, str):137return val.encode("ascii")138return val139140def _findop(crid, name):141fop = FindOp()142fop.crid = crid143fop.name = str_to_ascii(name)144s = array.array('B', fop.pack_hdr())145ioctl(_cryptodev, CIOCFINDDEV, s, 1)146fop.unpack(s)147148try:149idx = fop.name.index(b'\x00')150name = fop.name[:idx]151except ValueError:152name = fop.name153154return fop.crid, name155156def array_tobytes(array_obj):157if sys.version_info[:2] >= (3, 2):158return array_obj.tobytes()159return array_obj.tostring()160161def empty_bytes():162if sys.version_info[0] >= 3:163return b''164return ""165166class Crypto:167@staticmethod168def findcrid(name):169return _findop(-1, name)[0]170171@staticmethod172def getcridname(crid):173return _findop(crid, '')[1]174175def __init__(self, cipher=0, key=None, mac=0, mackey=None,176crid=CRYPTOCAP_F_SOFTWARE | CRYPTOCAP_F_HARDWARE, maclen=None,177ivlen=None):178self._ses = None179self._maclen = maclen180ses = SessionOp2()181ses.cipher = cipher182ses.mac = mac183184if key is not None:185ses.keylen = len(key)186k = array.array('B', key)187ses.key = k.buffer_info()[0]188else:189self.key = None190191if mackey is not None:192ses.mackeylen = len(mackey)193mk = array.array('B', mackey)194ses.mackey = mk.buffer_info()[0]195196if not cipher and not mac:197raise ValueError('one of cipher or mac MUST be specified.')198ses.crid = crid199if ivlen:200ses.ivlen = ivlen201if maclen:202ses.maclen = maclen203#print(ses)204s = array.array('B', ses.pack_hdr())205#print(s)206ioctl(_cryptodev, CIOCGSESSION2, s, 1)207ses.unpack(s)208209self._ses = ses.ses210211def __del__(self):212if self._ses is None:213return214215try:216ioctl(_cryptodev, CIOCFSESSION, _pack('I', self._ses))217except TypeError:218pass219self._ses = None220221def _doop(self, op, src, iv, mac=None):222cop = CryptOp()223cop.ses = self._ses224cop.op = op225cop.flags = 0226if src is not None:227cop.len = len(src)228s = array.array('B', src)229cop.src = cop.dst = s.buffer_info()[0]230if mac is not None:231assert len(mac) == self._maclen, \232'%d != %d' % (len(tag), self._maclen)233if self._maclen is not None:234if mac is None:235m = array.array('B', [0] * self._maclen)236else:237m = array.array('B', mac)238cop.mac = m.buffer_info()[0]239ivbuf = array.array('B', str_to_ascii(iv))240cop.iv = ivbuf.buffer_info()[0]241242#print('cop:', cop)243ioctl(_cryptodev, CIOCCRYPT, bytes(cop))244245if src is not None:246s = array_tobytes(s)247else:248s = empty_bytes()249if self._maclen is not None:250return s, array_tobytes(m)251252return s253254def _doaead(self, op, src, aad, iv, tag=None):255caead = CryptAEAD()256caead.ses = self._ses257caead.op = op258caead.flags = CRD_F_IV_EXPLICIT259caead.flags = 0260if src:261src = str_to_ascii(src)262caead.len = len(src)263s = array.array('B', src)264caead.src = caead.dst = s.buffer_info()[0]265aad = str_to_ascii(aad)266caead.aadlen = len(aad)267saad = array.array('B', aad)268caead.aad = saad.buffer_info()[0]269270if self._maclen is None:271raise ValueError('must have a tag length')272273tag = str_to_ascii(tag)274if tag is None:275tag = array.array('B', [0] * self._maclen)276else:277assert len(tag) == self._maclen, \278'%d != %d' % (len(tag), self._maclen)279tag = array.array('B', tag)280281caead.tag = tag.buffer_info()[0]282283ivbuf = array.array('B', iv)284caead.ivlen = len(iv)285caead.iv = ivbuf.buffer_info()[0]286287ioctl(_cryptodev, CIOCCRYPTAEAD, bytes(caead))288289if src:290s = array_tobytes(s)291else:292s = empty_bytes()293294return s, array_tobytes(tag)295296def perftest(self, op, size, timeo=3):297inp = array.array('B', (random.randint(0, 255) for x in range(size)))298inp = str_to_ascii(inp)299out = array.array('B', inp)300301# prep ioctl302cop = CryptOp()303cop.ses = self._ses304cop.op = op305cop.flags = 0306cop.len = len(inp)307s = array.array('B', inp)308cop.src = s.buffer_info()[0]309cop.dst = out.buffer_info()[0]310if self._maclen is not None:311m = array.array('B', [0] * self._maclen)312cop.mac = m.buffer_info()[0]313ivbuf = array.array('B', (random.randint(0, 255) for x in range(16)))314cop.iv = ivbuf.buffer_info()[0]315316exit = [ False ]317def alarmhandle(a, b, exit=exit):318exit[0] = True319320oldalarm = signal.signal(signal.SIGALRM, alarmhandle)321signal.alarm(timeo)322323start = time.time()324reps = 0325cop = bytes(cop)326while not exit[0]:327ioctl(_cryptodev, CIOCCRYPT, cop)328reps += 1329330end = time.time()331332signal.signal(signal.SIGALRM, oldalarm)333334print('time:', end - start)335print('perf MB/sec:', (reps * size) / (end - start) / 1024 / 1024)336337def encrypt(self, data, iv, aad=None):338if aad is None:339return self._doop(COP_ENCRYPT, data, iv)340else:341return self._doaead(COP_ENCRYPT, data, aad,342iv)343344def decrypt(self, data, iv, aad=None, tag=None):345if aad is None:346return self._doop(COP_DECRYPT, data, iv, mac=tag)347else:348return self._doaead(COP_DECRYPT, data, aad,349iv, tag=tag)350351class MismatchError(Exception):352pass353354class KATParser:355def __init__(self, fname, fields):356self.fields = set(fields)357self._pending = None358self.fname = fname359self.fp = None360self.field_re = re.compile(r"\[(?P<field>[^]]+)\]")361362def __enter__(self):363self.fp = open(self.fname)364return self365366def __exit__(self, exc_type, exc_value, exc_tb):367if self.fp is not None:368self.fp.close()369370def __iter__(self):371return self372373def __next__(self):374while True:375while True:376if self._pending is not None:377i = self._pending378self._pending = None379else:380i = self.fp.readline()381if not i:382return383384if not i.startswith('#') and i.strip():385break386387matches = self.field_re.match(i)388if matches is None:389raise ValueError("Unknown line: %r" % (i))390yield matches.group("field"), self.fielditer()391392def eatblanks(self):393while True:394line = self.fp.readline()395if line == '':396break397398line = line.strip()399if line:400break401402return line403404def fielditer(self):405while True:406values = {}407408line = self.eatblanks()409if not line or line[0] == '[':410self._pending = line411return412413while True:414try:415f, v = line.split(' =')416except:417if line == 'FAIL':418f, v = 'FAIL', ''419else:420print('line:', repr(line))421raise422v = v.strip()423424if f in values:425raise ValueError('already present: %r' % repr(f))426values[f] = v427line = self.fp.readline().strip()428if not line:429break430431# we should have everything432remain = self.fields.copy() - set(values.keys())433# XXX - special case GCM decrypt434if remain and not ('FAIL' in values and 'PT' in remain):435raise ValueError('not all fields found: %r' % repr(remain))436437yield values438439# The CCM files use a bit of a different syntax that doesn't quite fit440# the generic KATParser. In particular, some keys are set globally at441# the start of the file, and some are set globally at the start of a442# section.443class KATCCMParser:444def __init__(self, fname):445self._pending = None446self.fname = fname447self.fp = None448449def __enter__(self):450self.fp = open(self.fname)451self.read_globals()452return self453454def __exit__(self, exc_type, exc_value, exc_tb):455if self.fp is not None:456self.fp.close()457458def read_globals(self):459self.global_values = {}460while True:461line = self.fp.readline()462if not line:463return464if line[0] == '#' or not line.strip():465continue466if line[0] == '[':467self._pending = line468return469470try:471f, v = line.split(' =')472except:473print('line:', repr(line))474raise475476v = v.strip()477478if f in self.global_values:479raise ValueError('already present: %r' % repr(f))480self.global_values[f] = v481482def read_section_values(self, kwpairs):483self.section_values = self.global_values.copy()484for pair in kwpairs.split(', '):485f, v = pair.split(' = ')486if f in self.section_values:487raise ValueError('already present: %r' % repr(f))488self.section_values[f] = v489490while True:491line = self.fp.readline()492if not line:493return494if line[0] == '#' or not line.strip():495continue496if line[0] == '[':497self._pending = line498return499500try:501f, v = line.split(' =')502except:503print('line:', repr(line))504raise505506if f == 'Count':507self._pending = line508return509510v = v.strip()511512if f in self.section_values:513raise ValueError('already present: %r' % repr(f))514self.section_values[f] = v515516def __iter__(self):517return self518519def __next__(self):520while True:521if self._pending:522line = self._pending523self._pending = None524else:525line = self.fp.readline()526if not line:527return528529if (line and line[0] == '#') or not line.strip():530continue531532if line[0] == '[':533section = line[1:].split(']', 1)[0]534self.read_section_values(section)535continue536537values = self.section_values.copy()538539while True:540try:541f, v = line.split(' =')542except:543print('line:', repr(line))544raise545v = v.strip()546547if f in values:548raise ValueError('already present: %r' % repr(f))549values[f] = v550line = self.fp.readline().strip()551if not line:552break553554yield values555556def _spdechex(s):557return binascii.hexlify(''.join(s.split()))558559if sys.version_info[0] < 3:560KATCCMParser.next = KATCCMParser.__next__561KATParser.next = KATParser.__next__562563if __name__ == '__main__':564if True:565try:566crid = Crypto.findcrid('aesni0')567print('aesni:', crid)568except IOError:569print('aesni0 not found')570571for i in range(10):572try:573name = Crypto.getcridname(i)574print('%2d: %r' % (i, repr(name)))575except IOError:576pass577elif False:578columns = [ 'COUNT', 'DataUnitLen', 'Key', 'DataUnitSeqNumber', 'PT', 'CT' ]579fname = '/usr/home/jmg/aesni.testing/format tweak value input - data unit seq no/XTSGenAES128.rsp'580with KATParser(fname, columns) as kp:581for mode, ni in kp:582print(i, ni)583for j in ni:584print(j)585elif False:586key = _spdechex('c939cc13397c1d37de6ae0e1cb7c423c')587iv = _spdechex('00000000000000000000000000000001')588pt = _spdechex('ab3cabed693a32946055524052afe3c9cb49664f09fc8b7da824d924006b7496353b8c1657c5dec564d8f38d7432e1de35aae9d95590e66278d4acce883e51abaf94977fcd3679660109a92bf7b2973ccd547f065ec6cee4cb4a72a5e9f45e615d920d76cb34cba482467b3e21422a7242e7d931330c0fbf465c3a3a46fae943029fd899626dda542750a1eee253df323c6ef1573f1c8c156613e2ea0a6cdbf2ae9701020be2d6a83ecb7f3f9d8e')589#pt = _spdechex('00000000000000000000000000000000')590ct = _spdechex('f42c33853ecc5ce2949865fdb83de3bff1089e9360c94f830baebfaff72836ab5236f77212f1e7396c8c54ac73d81986375a6e9e299cfeca5ba051ed25e8d1affa5beaf6c1d2b45e90802408f2ced21663497e906de5f29341e5e52ddfea5363d628b3eb7806835e17bae051b3a6da3f8e2941fe44384eac17a9d298d2c331ca8320c775b5d53263a5e905059d891b21dede2d8110fd427c7bd5a9a274ddb47b1945ee79522203b6e297d0e399ef')591592c = Crypto(CRYPTO_AES_ICM, key)593enc = c.encrypt(pt, iv)594595print('enc:', binascii.hexlify(enc))596print(' ct:', binascii.hexlify(ct))597598assert ct == enc599600dec = c.decrypt(ct, iv)601602print('dec:', binascii.hexlify(dec))603print(' pt:', binascii.hexlify(pt))604605assert pt == dec606elif False:607key = _spdechex('c939cc13397c1d37de6ae0e1cb7c423c')608iv = _spdechex('00000000000000000000000000000001')609pt = _spdechex('ab3cabed693a32946055524052afe3c9cb49664f09fc8b7da824d924006b7496353b8c1657c5dec564d8f38d7432e1de35aae9d95590e66278d4acce883e51abaf94977fcd3679660109a92bf7b2973ccd547f065ec6cee4cb4a72a5e9f45e615d920d76cb34cba482467b3e21422a7242e7d931330c0fbf465c3a3a46fae943029fd899626dda542750a1eee253df323c6ef1573f1c8c156613e2ea0a6cdbf2ae9701020be2d6a83ecb7f3f9d8e0a3f')610#pt = _spdechex('00000000000000000000000000000000')611ct = _spdechex('f42c33853ecc5ce2949865fdb83de3bff1089e9360c94f830baebfaff72836ab5236f77212f1e7396c8c54ac73d81986375a6e9e299cfeca5ba051ed25e8d1affa5beaf6c1d2b45e90802408f2ced21663497e906de5f29341e5e52ddfea5363d628b3eb7806835e17bae051b3a6da3f8e2941fe44384eac17a9d298d2c331ca8320c775b5d53263a5e905059d891b21dede2d8110fd427c7bd5a9a274ddb47b1945ee79522203b6e297d0e399ef3768')612613c = Crypto(CRYPTO_AES_ICM, key)614enc = c.encrypt(pt, iv)615616print('enc:', binascii.hexlify(enc))617print(' ct:', binascii.hexlify(ct))618619assert ct == enc620621dec = c.decrypt(ct, iv)622623print('dec:', binascii.hexlify(dec))624print(' pt:', binascii.hexlify(pt))625626assert pt == dec627elif False:628key = _spdechex('c939cc13397c1d37de6ae0e1cb7c423c')629iv = _spdechex('6eba2716ec0bd6fa5cdef5e6d3a795bc')630pt = _spdechex('ab3cabed693a32946055524052afe3c9cb49664f09fc8b7da824d924006b7496353b8c1657c5dec564d8f38d7432e1de35aae9d95590e66278d4acce883e51abaf94977fcd3679660109a92bf7b2973ccd547f065ec6cee4cb4a72a5e9f45e615d920d76cb34cba482467b3e21422a7242e7d931330c0fbf465c3a3a46fae943029fd899626dda542750a1eee253df323c6ef1573f1c8c156613e2ea0a6cdbf2ae9701020be2d6a83ecb7f3f9d8e0a3f')631ct = _spdechex('f1f81f12e72e992dbdc304032705dc75dc3e4180eff8ee4819906af6aee876d5b00b7c36d282a445ce3620327be481e8e53a8e5a8e5ca9abfeb2281be88d12ffa8f46d958d8224738c1f7eea48bda03edbf9adeb900985f4fa25648b406d13a886c25e70cfdecdde0ad0f2991420eb48a61c64fd797237cf2798c2675b9bb744360b0a3f329ac53bbceb4e3e7456e6514f1a9d2f06c236c31d0f080b79c15dce1096357416602520daa098b17d1af427')632c = Crypto(CRYPTO_AES_CBC, key)633634enc = c.encrypt(pt, iv)635636print('enc:', binascii.hexlify(enc))637print(' ct:', binascii.hexlify(ct))638639assert ct == enc640641dec = c.decrypt(ct, iv)642643print('dec:', binascii.hexlify(dec))644print(' pt:', binascii.hexlify(pt))645646assert pt == dec647elif False:648key = _spdechex('c939cc13397c1d37de6ae0e1cb7c423c')649iv = _spdechex('b3d8cc017cbb89b39e0f67e2')650pt = _spdechex('c3b3c41f113a31b73d9a5cd4321030')651aad = _spdechex('24825602bd12a984e0092d3e448eda5f')652ct = _spdechex('93fe7d9e9bfd10348a5606e5cafa7354')653ct = _spdechex('93fe7d9e9bfd10348a5606e5cafa73')654tag = _spdechex('0032a1dc85f1c9786925a2e71d8272dd')655tag = _spdechex('8d11a0929cb3fbe1fef01a4a38d5f8ea')656657c = Crypto(CRYPTO_AES_NIST_GCM_16, key)658659enc, enctag = c.encrypt(pt, iv, aad=aad)660661print('enc:', binascii.hexlify(enc))662print(' ct:', binascii.hexlify(ct))663664assert enc == ct665666print('etg:', binascii.hexlify(enctag))667print('tag:', binascii.hexlify(tag))668assert enctag == tag669670# Make sure we get EBADMSG671#enctag = enctag[:-1] + 'a'672dec, dectag = c.decrypt(ct, iv, aad=aad, tag=enctag)673674print('dec:', binascii.hexlify(dec))675print(' pt:', binascii.hexlify(pt))676677assert dec == pt678679print('dtg:', binascii.hexlify(dectag))680print('tag:', binascii.hexlify(tag))681682assert dectag == tag683elif False:684key = _spdechex('c939cc13397c1d37de6ae0e1cb7c423c')685iv = _spdechex('b3d8cc017cbb89b39e0f67e2')686key = key + iv[:4]687iv = iv[4:]688pt = _spdechex('c3b3c41f113a31b73d9a5cd432103069')689aad = _spdechex('24825602bd12a984e0092d3e448eda5f')690ct = _spdechex('93fe7d9e9bfd10348a5606e5cafa7354')691tag = _spdechex('0032a1dc85f1c9786925a2e71d8272dd')692693c = Crypto(CRYPTO_AES_GCM_16, key)694695enc, enctag = c.encrypt(pt, iv, aad=aad)696697print('enc:', binascii.hexlify(enc))698print(' ct:', binascii.hexlify(ct))699700assert enc == ct701702print('etg:', binascii.hexlify(enctag))703print('tag:', binascii.hexlify(tag))704assert enctag == tag705elif False:706for i in range(100000):707c = Crypto(CRYPTO_AES_XTS, binascii.unhexlify('1bbfeadf539daedcae33ced497343f3ca1f2474ad932b903997d44707db41382'))708data = binascii.unhexlify('52a42bca4e9425a25bbc8c8bf6129dec')709ct = binascii.unhexlify('517e602becd066b65fa4f4f56ddfe240')710iv = _pack('QQ', 71, 0)711712enc = c.encrypt(data, iv)713assert enc == ct714elif True:715c = Crypto(CRYPTO_AES_XTS, binascii.unhexlify('1bbfeadf539daedcae33ced497343f3ca1f2474ad932b903997d44707db41382'))716data = binascii.unhexlify('52a42bca4e9425a25bbc8c8bf6129dec')717ct = binascii.unhexlify('517e602becd066b65fa4f4f56ddfe240')718iv = _pack('QQ', 71, 0)719720enc = c.encrypt(data, iv)721assert enc == ct722723dec = c.decrypt(enc, iv)724assert dec == data725726#c.perftest(COP_ENCRYPT, 192*1024, reps=30000)727728else:729key = binascii.unhexlify('1bbfeadf539daedcae33ced497343f3ca1f2474ad932b903997d44707db41382')730print('XTS %d testing:' % (len(key) * 8))731c = Crypto(CRYPTO_AES_XTS, key)732for i in [ 8192, 192*1024]:733print('block size: %d' % i)734c.perftest(COP_ENCRYPT, i)735c.perftest(COP_DECRYPT, i)736737738