1 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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
|
#!python
#cython: language_level=3
"""
High-level Python PKCS#11 Wrapper.
Most class here inherit from pkcs11.types, which provides easier introspection
for Sphinx/Jedi/etc, as this module is not importable without having the
library loaded.
"""
from __future__ import (absolute_import, unicode_literals,
print_function, division)
from cython.view cimport array
from cpython.mem cimport PyMem_Malloc, PyMem_Free
IF UNAME_SYSNAME == "Windows":
from . cimport _mswin as mswin
ELSE:
from posix cimport dlfcn
from ._pkcs11_defn cimport *
include '_errors.pyx'
include '_utils.pyx'
from . import types
from .defaults import *
from .exceptions import *
from .constants import *
from .mechanisms import *
from .types import (
_CK_UTF8CHAR_to_str,
_CK_VERSION_to_tuple,
_CK_MECHANISM_TYPE_to_enum,
PROTECTED_AUTH,
)
# _funclist is used to keep the pointer to the list of functions, when lib() is invoked.
# This is a global, as this object cannot be shared between Python and Cython classes
# Due to this limitation, the current implementation limits the loading of the library
# to one instance only, or to several instances of the same kind.
cdef CK_FUNCTION_LIST *_funclist = NULL
cdef class AttributeList:
"""
A list of CK_ATTRIBUTE objects.
"""
cdef CK_ATTRIBUTE *data
"""CK_ATTRIBUTE * representation of the data."""
cdef CK_ULONG count
"""Length of `data`."""
cdef _values
def __cinit__(self, attrs):
attrs = dict(attrs)
self.count = count = <CK_ULONG> len(attrs)
self.data = <CK_ATTRIBUTE *> PyMem_Malloc(count * sizeof(CK_ATTRIBUTE))
if not self.data:
raise MemoryError()
# Turn the values into bytes and store them so we have pointers
# to them.
self._values = [
(key, _pack_attribute(key, value))
for key, value in attrs.items()
]
for index, (key, value) in enumerate(self._values):
self.data[index].type = key
self.data[index].pValue = <CK_CHAR *> value
self.data[index].ulValueLen = <CK_ULONG>len(value)
def __dealloc__(self):
PyMem_Free(self.data)
cdef class MechanismWithParam:
"""
Python wrapper for a Mechanism with its parameter
"""
cdef CK_MECHANISM *data
"""The mechanism."""
cdef void *param
"""Reference to a pointer we might need to free."""
def __cinit__(self, *args):
self.data = <CK_MECHANISM *> PyMem_Malloc(sizeof(CK_MECHANISM))
self.param = NULL
def __init__(self, key_type, mapping, mechanism=None, param=None):
if mechanism is None:
try:
mechanism = mapping[key_type]
except KeyError:
raise ArgumentsBad("No default mechanism for this key type. "
"Please specify `mechanism`.")
if not isinstance(mechanism, Mechanism):
raise ArgumentsBad("`mechanism` must be a Mechanism.")
# Possible types of parameters we might need to allocate
# These are used to make assigning to the object we malloc() easier
# FIXME: is there a better way to do this?
cdef CK_RSA_PKCS_OAEP_PARAMS *oaep_params
cdef CK_RSA_PKCS_PSS_PARAMS *pss_params
cdef CK_ECDH1_DERIVE_PARAMS *ecdh1_params
# Unpack mechanism parameters
if mechanism is Mechanism.RSA_PKCS_OAEP:
paramlen = sizeof(CK_RSA_PKCS_OAEP_PARAMS)
self.param = oaep_params = \
<CK_RSA_PKCS_OAEP_PARAMS *> PyMem_Malloc(paramlen)
oaep_params.source = CKZ_DATA_SPECIFIED
if param is None:
param = DEFAULT_MECHANISM_PARAMS[mechanism]
(oaep_params.hashAlg, oaep_params.mgf, source_data) = param
if source_data is None:
oaep_params.pSourceData = NULL
oaep_params.ulSourceDataLen = 0
else:
oaep_params.pSourceData = <CK_BYTE *> source_data
oaep_params.ulSourceDataLen = <CK_ULONG> len(source_data)
elif mechanism in (Mechanism.RSA_PKCS_PSS,
Mechanism.SHA1_RSA_PKCS_PSS,
Mechanism.SHA224_RSA_PKCS_PSS,
Mechanism.SHA256_RSA_PKCS_PSS,
Mechanism.SHA384_RSA_PKCS_PSS,
Mechanism.SHA512_RSA_PKCS_PSS):
paramlen = sizeof(CK_RSA_PKCS_PSS_PARAMS)
self.param = pss_params = \
<CK_RSA_PKCS_PSS_PARAMS *> PyMem_Malloc(paramlen)
if param is None:
# All PSS mechanisms have the same defaults
param = DEFAULT_MECHANISM_PARAMS[Mechanism.RSA_PKCS_PSS]
(pss_params.hashAlg, pss_params.mgf, pss_params.sLen) = param
elif mechanism is Mechanism.ECDH1_DERIVE:
paramlen = sizeof(CK_ECDH1_DERIVE_PARAMS)
self.param = ecdh1_params = \
<CK_ECDH1_DERIVE_PARAMS *> PyMem_Malloc(paramlen)
(ecdh1_params.kdf, shared_data, public_data) = param
if shared_data is None:
ecdh1_params.pSharedData = NULL
ecdh1_params.ulSharedDataLen = 0
else:
ecdh1_params.pSharedData = shared_data
ecdh1_params.ulSharedDataLen = <CK_ULONG> len(shared_data)
ecdh1_params.pPublicData = public_data
ecdh1_params.ulPublicDataLen = <CK_ULONG> len(public_data)
elif isinstance(param, bytes):
self.data.pParameter = <CK_BYTE *> param
paramlen = len(param)
elif param is None:
self.data.pParameter = NULL
paramlen = 0
else:
raise ArgumentsBad("Unexpected argument to mechanism_param")
self.data.mechanism = mechanism
self.data.ulParameterLen = <CK_ULONG> paramlen
if self.param != NULL:
self.data.pParameter = self.param
def __dealloc__(self):
PyMem_Free(self.data)
PyMem_Free(self.param)
class Slot(types.Slot):
"""Extend Slot with implementation."""
def get_token(self):
cdef CK_SLOT_ID slot_id = self.slot_id
cdef CK_TOKEN_INFO info
with nogil:
assertRV(_funclist.C_GetTokenInfo(slot_id, &info))
label = info.label[:sizeof(info.label)]
serialNumber = info.serialNumber[:sizeof(info.serialNumber)]
model = info.model[:sizeof(info.model)]
manufacturerID = info.manufacturerID[:sizeof(info.manufacturerID)]
return Token(self, label, serialNumber, model, manufacturerID,
info.hardwareVersion, info.firmwareVersion, info.flags)
def get_mechanisms(self):
cdef CK_SLOT_ID slot_id = self.slot_id
cdef CK_ULONG count
with nogil:
assertRV(_funclist.C_GetMechanismList(slot_id, NULL, &count))
if count == 0:
return set()
cdef CK_MECHANISM_TYPE [:] mechanisms = CK_ULONG_buffer(count)
with nogil:
assertRV(_funclist.C_GetMechanismList(slot_id, &mechanisms[0],
&count))
return set(map(_CK_MECHANISM_TYPE_to_enum, mechanisms))
def get_mechanism_info(self, mechanism):
cdef CK_SLOT_ID slot_id = self.slot_id
cdef CK_MECHANISM_TYPE mech_type = mechanism
cdef CK_MECHANISM_INFO info
with nogil:
assertRV(_funclist.C_GetMechanismInfo(slot_id, mech_type, &info))
return types.MechanismInfo(self, mechanism, **info)
class Token(types.Token):
"""Extend Token with implementation."""
def open(self, rw=False, user_pin=None, so_pin=None):
cdef CK_SLOT_ID slot_id = self.slot.slot_id
cdef CK_SESSION_HANDLE handle
cdef CK_FLAGS flags = CKF_SERIAL_SESSION
cdef CK_USER_TYPE user_type
cdef CK_UTF8CHAR *pin_data
cdef CK_ULONG pin_length
if rw:
flags |= CKF_RW_SESSION
if user_pin is not None and so_pin is not None:
raise ArgumentsBad("Set either `user_pin` or `so_pin`")
elif user_pin is PROTECTED_AUTH:
pin = None
user_type = CKU_USER
elif so_pin is PROTECTED_AUTH:
pin = None
user_type = CKU_SO
elif user_pin is not None:
pin = user_pin.encode('utf-8')
user_type = CKU_USER
elif so_pin is not None:
pin = so_pin.encode('utf-8')
user_type = CKU_SO
else:
pin = None
user_type = UserType.NOBODY
with nogil:
assertRV(_funclist.C_OpenSession(slot_id, flags, NULL,
NULL, &handle))
if so_pin is PROTECTED_AUTH or user_pin is PROTECTED_AUTH:
if self.flags & TokenFlag.PROTECTED_AUTHENTICATION_PATH:
with nogil:
assertRV(_funclist.C_Login(handle, user_type, NULL, 0))
else:
raise ArgumentsBad("Protected authentication is not supported by loaded module")
elif pin is not None:
pin_data = pin
pin_length = len(pin)
with nogil:
assertRV(_funclist.C_Login(handle, user_type,
pin_data, pin_length))
return Session(self, handle, rw=rw, user_type=user_type)
class SearchIter:
"""Iterate a search for objects on a session."""
def __init__(self, session, attrs):
self.session = session
template = AttributeList(attrs)
self.session._operation_lock.acquire()
self._active = True
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_ATTRIBUTE *attr_data = template.data
cdef CK_ULONG attr_count = template.count
with nogil:
assertRV(_funclist.C_FindObjectsInit(handle, attr_data,
attr_count))
def __iter__(self):
return self
def __next__(self):
"""Get the next object."""
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_OBJECT_HANDLE obj
cdef CK_ULONG count
with nogil:
assertRV(_funclist.C_FindObjects(handle, &obj, 1, &count))
if count == 0:
self._finalize()
raise StopIteration()
else:
return Object._make(self.session, obj)
def __del__(self):
"""Close the search."""
self._finalize()
def _finalize(self):
"""Finish the operation."""
cdef CK_SESSION_HANDLE handle = self.session._handle
if self._active:
self._active = False
with nogil:
assertRV(_funclist.C_FindObjectsFinal(handle))
self.session._operation_lock.release()
def merge_templates(default_template, *user_templates):
template = default_template.copy()
for user_template in user_templates:
if user_template is not None:
template.update(user_template)
return {
key: value
for key, value in template.items()
if value is not DEFAULT
}
class Session(types.Session):
"""Extend Session with implementation."""
def close(self):
cdef CK_OBJECT_HANDLE handle = self._handle
if self.user_type != UserType.NOBODY:
with nogil:
assertRV(_funclist.C_Logout(handle))
with nogil:
assertRV(_funclist.C_CloseSession(handle))
def get_objects(self, attrs=None):
return SearchIter(self, attrs or {})
def create_object(self, attrs):
template = AttributeList(attrs)
cdef CK_OBJECT_HANDLE handle = self._handle
cdef CK_ATTRIBUTE *attr_data = template.data
cdef CK_ULONG attr_count = template.count
cdef CK_OBJECT_HANDLE new
with nogil:
assertRV(_funclist.C_CreateObject(handle, attr_data,
attr_count, &new))
return Object._make(self, new)
def create_domain_parameters(self, key_type, attrs,
local=False, store=False):
if local and store:
raise ArgumentsBad("Cannot set both `local` and `store`")
attrs = dict(attrs)
attrs[Attribute.CLASS] = ObjectClass.DOMAIN_PARAMETERS
attrs[Attribute.KEY_TYPE] = key_type
attrs[Attribute.TOKEN] = store
if local:
return DomainParameters(self, None, attrs)
else:
return self.create_object(attrs)
def generate_domain_parameters(self, key_type, param_length, store=False,
mechanism=None, mechanism_param=None,
template=None):
if not isinstance(key_type, KeyType):
raise ArgumentsBad("`key_type` must be KeyType.")
if not isinstance(param_length, int):
raise ArgumentsBad("`param_length` is the length in bits.")
mech = MechanismWithParam(
key_type, DEFAULT_PARAM_GENERATE_MECHANISMS,
mechanism, mechanism_param)
template_ = {
Attribute.CLASS: ObjectClass.DOMAIN_PARAMETERS,
Attribute.TOKEN: store,
Attribute.PRIME_BITS: param_length,
}
attrs = AttributeList(merge_templates(template_, template))
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_ATTRIBUTE *attr_data = attrs.data
cdef CK_ULONG attr_count = attrs.count
cdef CK_OBJECT_HANDLE obj
with nogil:
assertRV(_funclist.C_GenerateKey(handle, mech_data, attr_data,
attr_count, &obj))
return Object._make(self, obj)
def generate_key(self, key_type, key_length=None,
id=None, label=None,
store=False, capabilities=None,
mechanism=None, mechanism_param=None,
template=None):
if not isinstance(key_type, KeyType):
raise ArgumentsBad("`key_type` must be KeyType.")
if key_length is not None and not isinstance(key_length, int):
raise ArgumentsBad("`key_length` is the length in bits.")
if capabilities is None:
try:
capabilities = DEFAULT_KEY_CAPABILITIES[key_type]
except KeyError:
raise ArgumentsBad("No default capabilities for this key "
"type. Please specify `capabilities`.")
mech = MechanismWithParam(
key_type, DEFAULT_GENERATE_MECHANISMS,
mechanism, mechanism_param)
# Build attributes
template_ = {
Attribute.CLASS: ObjectClass.SECRET_KEY,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
# Capabilities
Attribute.ENCRYPT: MechanismFlag.ENCRYPT & capabilities,
Attribute.DECRYPT: MechanismFlag.DECRYPT & capabilities,
Attribute.WRAP: MechanismFlag.WRAP & capabilities,
Attribute.UNWRAP: MechanismFlag.UNWRAP & capabilities,
Attribute.SIGN: MechanismFlag.SIGN & capabilities,
Attribute.VERIFY: MechanismFlag.VERIFY & capabilities,
Attribute.DERIVE: MechanismFlag.DERIVE & capabilities,
}
if key_type is KeyType.AES:
if key_length is None:
raise ArgumentsBad("Must provide `key_length'")
template_[Attribute.VALUE_LEN] = key_length // 8 # In bytes
attrs = AttributeList(merge_templates(template_, template))
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_ATTRIBUTE *attr_data = attrs.data
cdef CK_ULONG attr_count = attrs.count
cdef CK_OBJECT_HANDLE key
with nogil:
assertRV(_funclist.C_GenerateKey(handle, mech_data, attr_data,
attr_count, &key))
return Object._make(self, key)
def _generate_keypair(self, key_type, key_length=None,
id=None, label=None,
store=False, capabilities=None,
mechanism=None, mechanism_param=None,
public_template=None, private_template=None):
if not isinstance(key_type, KeyType):
raise ArgumentsBad("`key_type` must be KeyType.")
if key_length is not None and not isinstance(key_length, int):
raise ArgumentsBad("`key_length` is the length in bits.")
if capabilities is None:
try:
capabilities = DEFAULT_KEY_CAPABILITIES[key_type]
except KeyError:
raise ArgumentsBad("No default capabilities for this key "
"type. Please specify `capabilities`.")
mech = MechanismWithParam(
key_type, DEFAULT_GENERATE_MECHANISMS,
mechanism, mechanism_param)
# Build attributes
public_template_ = {
Attribute.CLASS: ObjectClass.PUBLIC_KEY,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
# Capabilities
Attribute.ENCRYPT: MechanismFlag.ENCRYPT & capabilities,
Attribute.WRAP: MechanismFlag.WRAP & capabilities,
Attribute.VERIFY: MechanismFlag.VERIFY & capabilities,
}
if key_type is KeyType.RSA:
if key_length is None:
raise ArgumentsBad("Must provide `key_length'")
# Some PKCS#11 implementations don't default this, it makes sense
# to do it here
public_template_.update({
Attribute.PUBLIC_EXPONENT: b'\1\0\1',
Attribute.MODULUS_BITS: key_length,
})
public_attrs = AttributeList(merge_templates(public_template_, public_template))
private_template_ = {
Attribute.CLASS: ObjectClass.PRIVATE_KEY,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
# Capabilities
Attribute.DECRYPT: MechanismFlag.DECRYPT & capabilities,
Attribute.UNWRAP: MechanismFlag.UNWRAP & capabilities,
Attribute.SIGN: MechanismFlag.SIGN & capabilities,
Attribute.DERIVE: MechanismFlag.DERIVE & capabilities,
}
private_attrs = AttributeList(merge_templates(private_template_, private_template))
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_ATTRIBUTE *public_attr_data = public_attrs.data
cdef CK_ULONG public_attr_count = public_attrs.count
cdef CK_ATTRIBUTE *private_attr_data = private_attrs.data
cdef CK_ULONG private_attr_count = private_attrs.count
cdef CK_OBJECT_HANDLE public_key
cdef CK_OBJECT_HANDLE private_key
with nogil:
assertRV(_funclist.C_GenerateKeyPair(handle, mech_data,
public_attr_data,
public_attr_count,
private_attr_data,
private_attr_count,
&public_key, &private_key))
return (Object._make(self, public_key),
Object._make(self, private_key))
def seed_random(self, seed):
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_BYTE *seed_data = seed
cdef CK_ULONG seed_len = len(seed)
with nogil:
assertRV(_funclist.C_SeedRandom(handle, seed_data, seed_len))
def generate_random(self, nbits):
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_ULONG length = nbits // 8
cdef CK_CHAR [:] random = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_GenerateRandom(handle, &random[0], length))
return bytes(random)
def _digest(self, data, mechanism=None, mechanism_param=None):
mech = MechanismWithParam(None, {}, mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_BYTE *data_ptr = data
cdef CK_ULONG data_len = len(data)
cdef CK_BYTE [:] digest
cdef CK_ULONG length
with self._operation_lock:
with nogil:
assertRV(_funclist.C_DigestInit(handle, mech_data))
# Run once to get the length
assertRV(_funclist.C_Digest(handle, data_ptr, data_len,
NULL, &length))
digest = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_Digest(handle, data_ptr, data_len,
&digest[0], &length))
return bytes(digest[:length])
def _digest_generator(self, data, mechanism=None, mechanism_param=None):
mech = MechanismWithParam(None, {}, mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key
cdef CK_BYTE *data_ptr
cdef CK_ULONG data_len
cdef CK_BYTE [:] digest
cdef CK_ULONG length
with self._operation_lock:
with nogil:
assertRV(_funclist.C_DigestInit(handle, mech_data))
for block in data:
if isinstance(block, types.Key):
key = block._handle
with nogil:
assertRV(_funclist.C_DigestKey(handle, key))
else:
data_ptr = block
data_len = len(block)
with nogil:
assertRV(_funclist.C_DigestUpdate(handle, data_ptr,
data_len))
# Run once to get the length
with nogil:
assertRV(_funclist.C_DigestFinal(handle, NULL, &length))
digest = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_DigestFinal(handle, &digest[0],
&length))
return bytes(digest[:length])
class Object(types.Object):
"""Expand Object with an implementation."""
@classmethod
def _make(cls, *args, **kwargs):
"""
Make an object with the right bases for its class and capabilities.
"""
# Make a version of ourselves we can introspect
self = cls(*args, **kwargs)
try:
# Determine a list of base classes to manufacture our class with
# FIXME: we should really request all of these attributes in
# one go
object_class = self[Attribute.CLASS]
bases = (_CLASS_MAP[object_class],)
# Build a list of mixins for this new class
for attribute, mixin in (
(Attribute.ENCRYPT, EncryptMixin),
(Attribute.DECRYPT, DecryptMixin),
(Attribute.SIGN, SignMixin),
(Attribute.VERIFY, VerifyMixin),
(Attribute.WRAP, WrapMixin),
(Attribute.UNWRAP, UnwrapMixin),
(Attribute.DERIVE, DeriveMixin),
):
try:
if self[attribute]:
bases += (mixin,)
# nFast returns FunctionFailed when you request an attribute
# it doesn't like.
except (AttributeTypeInvalid, FunctionFailed):
pass
bases += (cls,)
# Manufacture a class with the right capabilities.
klass = type(bases[0].__name__, bases, {})
return klass(*args, **kwargs)
except KeyError:
return self
def __getitem__(self, key):
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_OBJECT_HANDLE obj = self._handle
cdef CK_ATTRIBUTE template
template.type = key
template.pValue = NULL
template.ulValueLen = <CK_ULONG> 0
# Find out the attribute size
with nogil:
assertRV(_funclist.C_GetAttributeValue(handle, obj, &template, 1))
if template.ulValueLen == 0:
return _unpack_attributes(key, b'')
# Put a buffer of the right length in place
cdef CK_CHAR [:] value = CK_BYTE_buffer(template.ulValueLen)
template.pValue = <CK_CHAR *> &value[0]
# Request the value
with nogil:
assertRV(_funclist.C_GetAttributeValue(handle, obj, &template, 1))
return _unpack_attributes(key, value)
def __setitem__(self, key, value):
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_OBJECT_HANDLE obj = self._handle
cdef CK_ATTRIBUTE template
value = _pack_attribute(key, value)
template.type = key
template.pValue = <CK_CHAR *> value
template.ulValueLen = <CK_ULONG>len(value)
with nogil:
assertRV(_funclist.C_SetAttributeValue(handle, obj, &template, 1))
def copy(self, attrs):
template = AttributeList(attrs)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_OBJECT_HANDLE obj = self._handle
cdef CK_ATTRIBUTE *attr_data = template.data
cdef CK_ULONG attr_count = template.count
cdef CK_OBJECT_HANDLE new
with nogil:
assertRV(_funclist.C_CopyObject(handle, obj, attr_data,
attr_count, &new))
return Object._make(self.session, new)
def destroy(self):
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_OBJECT_HANDLE obj = self._handle
with nogil:
assertRV(_funclist.C_DestroyObject(handle, obj))
class SecretKey(types.SecretKey):
pass
class PublicKey(types.PublicKey):
pass
class PrivateKey(types.PrivateKey):
pass
class DomainParameters(types.DomainParameters):
def generate_keypair(self,
id=None, label=None,
store=False, capabilities=None,
mechanism=None, mechanism_param=None,
public_template=None, private_template=None):
if capabilities is None:
try:
capabilities = DEFAULT_KEY_CAPABILITIES[self.key_type]
except KeyError:
raise ArgumentsBad("No default capabilities for this key "
"type. Please specify `capabilities`.")
mech = MechanismWithParam(
self.key_type, DEFAULT_GENERATE_MECHANISMS,
mechanism, mechanism_param)
# Build attributes
public_template_ = {
Attribute.CLASS: ObjectClass.PUBLIC_KEY,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
# Capabilities
Attribute.ENCRYPT: MechanismFlag.ENCRYPT & capabilities,
Attribute.WRAP: MechanismFlag.WRAP & capabilities,
Attribute.VERIFY: MechanismFlag.VERIFY & capabilities,
}
# Copy in our domain parameters.
# Not all parameters are appropriate for all domains.
for attribute in (
Attribute.BASE,
Attribute.PRIME,
Attribute.SUBPRIME,
Attribute.EC_PARAMS,
):
try:
public_template_[attribute] = self[attribute]
# nFast returns FunctionFailed for parameters it doesn't like
except (AttributeTypeInvalid, FunctionFailed):
pass
public_attrs = AttributeList(merge_templates(public_template_, public_template))
private_template_ = {
Attribute.CLASS: ObjectClass.PRIVATE_KEY,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
# Capabilities
Attribute.DECRYPT: MechanismFlag.DECRYPT & capabilities,
Attribute.UNWRAP: MechanismFlag.UNWRAP & capabilities,
Attribute.SIGN: MechanismFlag.SIGN & capabilities,
Attribute.DERIVE: MechanismFlag.DERIVE & capabilities,
}
private_attrs = AttributeList(merge_templates(private_template_, private_template))
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_ATTRIBUTE *public_attr_data = public_attrs.data
cdef CK_ULONG public_attr_count = public_attrs.count
cdef CK_ATTRIBUTE *private_attr_data = private_attrs.data
cdef CK_ULONG private_attr_count = private_attrs.count
cdef CK_OBJECT_HANDLE public_key
cdef CK_OBJECT_HANDLE private_key
with nogil:
assertRV(_funclist.C_GenerateKeyPair(handle, mech_data,
public_attr_data,
public_attr_count,
private_attr_data,
private_attr_count,
&public_key, &private_key))
return (Object._make(self.session, public_key),
Object._make(self.session, private_key))
class Certificate(types.Certificate):
pass
class EncryptMixin(types.EncryptMixin):
"""Expand EncryptMixin with an implementation."""
def _encrypt(self, data,
mechanism=None, mechanism_param=None):
"""
Non chunking encrypt. Needed for some mechanisms.
"""
mech = MechanismWithParam(
self.key_type, DEFAULT_ENCRYPT_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr = data
cdef CK_ULONG data_len = len(data)
cdef CK_BYTE [:] ciphertext
cdef CK_ULONG length
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_EncryptInit(handle, mech_data, key))
# Call to find out the buffer length
with nogil:
assertRV(_funclist.C_Encrypt(handle, data_ptr, data_len,
NULL, &length))
ciphertext = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_Encrypt(handle, data_ptr, data_len,
&ciphertext[0], &length))
return bytes(ciphertext[:length])
def _encrypt_generator(self, data,
mechanism=None, mechanism_param=None,
buffer_size=8192):
"""
Do chunked encryption.
Failing to consume the generator will raise GeneratorExit when it
garbage collects. This will release the lock, but you'll still be
in the middle of an operation, and all future operations will raise
OperationActive, see tests/test_iterators.py:test_close_iterators().
FIXME: cancel the operation when we exit the generator early.
"""
mech = MechanismWithParam(
self.key_type, DEFAULT_ENCRYPT_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr
cdef CK_ULONG data_len
cdef CK_ULONG length
cdef CK_BYTE [:] part_out = CK_BYTE_buffer(buffer_size)
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_EncryptInit(handle, mech_data, key))
for part_in in data:
if not part_in:
continue
data_ptr = part_in
data_len = len(part_in)
length = buffer_size
with nogil:
assertRV(_funclist.C_EncryptUpdate(handle, data_ptr,
data_len, &part_out[0],
&length))
yield bytes(part_out[:length])
# Finalize
# We assume the buffer is much bigger than the block size
length = buffer_size
with nogil:
assertRV(_funclist.C_EncryptFinal(handle, &part_out[0],
&length))
yield bytes(part_out[:length])
class DecryptMixin(types.DecryptMixin):
"""Expand DecryptMixin with an implementation."""
def _decrypt(self, data,
mechanism=None, mechanism_param=None):
"""Non chunking decrypt."""
mech = MechanismWithParam(
self.key_type, DEFAULT_ENCRYPT_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr = data
cdef CK_ULONG data_len = len(data)
cdef CK_BYTE [:] plaintext
cdef CK_ULONG length
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_DecryptInit(handle, mech_data, key))
# Call to find out the buffer length
with nogil:
assertRV(_funclist.C_Decrypt(handle, data_ptr, data_len,
NULL, &length))
plaintext = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_Decrypt(handle, data_ptr, data_len,
&plaintext[0], &length))
return bytes(plaintext[:length])
def _decrypt_generator(self, data,
mechanism=None, mechanism_param=None,
buffer_size=8192):
"""
Chunking decrypt.
Failing to consume the generator will raise GeneratorExit when it
garbage collects. This will release the lock, but you'll still be
in the middle of an operation, and all future operations will raise
OperationActive, see tests/test_iterators.py:test_close_iterators().
FIXME: cancel the operation when we exit the generator early.
"""
mech = MechanismWithParam(
self.key_type, DEFAULT_ENCRYPT_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr
cdef CK_ULONG data_len
cdef CK_ULONG length
cdef CK_BYTE [:] part_out = CK_BYTE_buffer(buffer_size)
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_DecryptInit(handle, mech_data, key))
for part_in in data:
if not part_in:
continue
data_ptr = part_in
data_len = len(part_in)
length = buffer_size
with nogil:
assertRV(_funclist.C_DecryptUpdate(handle, data_ptr,
data_len, &part_out[0],
&length))
yield bytes(part_out[:length])
# Finalize
# We assume the buffer is much bigger than the block size
length = buffer_size
with nogil:
assertRV(_funclist.C_DecryptFinal(handle, &part_out[0],
&length))
yield bytes(part_out[:length])
class SignMixin(types.SignMixin):
"""Expand SignMixin with an implementation."""
def _sign(self, data,
mechanism=None, mechanism_param=None):
mech = MechanismWithParam(
self.key_type, DEFAULT_SIGN_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr = data
cdef CK_ULONG data_len = len(data)
cdef CK_BYTE [:] signature
cdef CK_ULONG length
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_SignInit(handle, mech_data, key))
# Call to find out the buffer length
assertRV(_funclist.C_Sign(handle, data_ptr, data_len,
NULL, &length))
signature = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_Sign(handle, data_ptr, data_len,
&signature[0], &length))
return bytes(signature[:length])
def _sign_generator(self, data,
mechanism=None, mechanism_param=None):
mech = MechanismWithParam(
self.key_type, DEFAULT_SIGN_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr
cdef CK_ULONG data_len
cdef CK_BYTE [:] signature
cdef CK_ULONG length
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_SignInit(handle, mech_data, key))
for part_in in data:
if not part_in:
continue
data_ptr = part_in
data_len = len(part_in)
with nogil:
assertRV(_funclist.C_SignUpdate(handle, data_ptr, data_len))
# Finalize
# Call to find out the buffer length
with nogil:
assertRV(_funclist.C_SignFinal(handle, NULL, &length))
signature = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_SignFinal(handle, &signature[0], &length))
return bytes(signature[:length])
class VerifyMixin(types.VerifyMixin):
"""Expand VerifyMixin with an implementation."""
def _verify(self, data, signature,
mechanism=None, mechanism_param=None):
mech = MechanismWithParam(
self.key_type, DEFAULT_SIGN_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr = data
cdef CK_ULONG data_len = len(data)
cdef CK_BYTE *sig_ptr = signature
cdef CK_ULONG sig_len = len(signature)
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_VerifyInit(handle, mech_data, key))
assertRV(_funclist.C_Verify(handle, data_ptr, data_len,
sig_ptr, sig_len))
def _verify_generator(self, data, signature,
mechanism=None, mechanism_param=None):
mech = MechanismWithParam(
self.key_type, DEFAULT_SIGN_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE key = self._handle
cdef CK_BYTE *data_ptr
cdef CK_ULONG data_len
cdef CK_BYTE *sig_ptr = signature
cdef CK_ULONG sig_len = len(signature)
with self.session._operation_lock:
with nogil:
assertRV(_funclist.C_VerifyInit(handle, mech_data, key))
for part_in in data:
if not part_in:
continue
data_ptr = part_in
data_len = len(part_in)
with nogil:
assertRV(_funclist.C_VerifyUpdate(handle, data_ptr,
data_len))
with nogil:
assertRV(_funclist.C_VerifyFinal(handle, sig_ptr, sig_len))
class WrapMixin(types.WrapMixin):
"""Expand WrapMixin with an implementation."""
def wrap_key(self, key,
mechanism=None, mechanism_param=None):
if not isinstance(key, types.Key):
raise ArgumentsBad("`key` must be a Key.")
mech = MechanismWithParam(
self.key_type, DEFAULT_WRAP_MECHANISMS,
mechanism, mechanism_param)
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE wrapping_key = self._handle
cdef CK_OBJECT_HANDLE key_to_wrap = key._handle
cdef CK_ULONG length
# Find out how many bytes we need to allocate
with nogil:
assertRV(_funclist.C_WrapKey(handle, mech_data, wrapping_key,
key_to_wrap, NULL, &length))
cdef CK_BYTE [:] data = CK_BYTE_buffer(length)
with nogil:
assertRV(_funclist.C_WrapKey(handle, mech_data, wrapping_key,
key_to_wrap, &data[0], &length))
return bytes(data[:length])
class UnwrapMixin(types.UnwrapMixin):
"""Expand UnwrapMixin with an implementation."""
def unwrap_key(self, object_class, key_type, key_data,
id=None, label=None,
mechanism=None, mechanism_param=None,
store=False, capabilities=None,
template=None):
if not isinstance(object_class, ObjectClass):
raise ArgumentsBad("`object_class` must be ObjectClass.")
if not isinstance(key_type, KeyType):
raise ArgumentsBad("`key_type` must be KeyType.")
if capabilities is None:
try:
capabilities = DEFAULT_KEY_CAPABILITIES[key_type]
except KeyError:
raise ArgumentsBad("No default capabilities for this key "
"type. Please specify `capabilities`.")
mech = MechanismWithParam(
self.key_type, DEFAULT_WRAP_MECHANISMS,
mechanism, mechanism_param)
# Build attributes
template_ = {
Attribute.CLASS: object_class,
Attribute.KEY_TYPE: key_type,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
# Capabilities
Attribute.ENCRYPT: MechanismFlag.ENCRYPT & capabilities,
Attribute.DECRYPT: MechanismFlag.DECRYPT & capabilities,
Attribute.WRAP: MechanismFlag.WRAP & capabilities,
Attribute.UNWRAP: MechanismFlag.UNWRAP & capabilities,
Attribute.SIGN: MechanismFlag.SIGN & capabilities,
Attribute.VERIFY: MechanismFlag.VERIFY & capabilities,
Attribute.DERIVE: MechanismFlag.DERIVE & capabilities,
}
attrs = AttributeList(merge_templates(template_, template))
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE unwrapping_key = self._handle
cdef CK_BYTE *wrapped_key_ptr = key_data
cdef CK_ULONG wrapped_key_len = len(key_data)
cdef CK_ATTRIBUTE *attr_data = attrs.data
cdef CK_ULONG attr_count = attrs.count
cdef CK_OBJECT_HANDLE key
with nogil:
assertRV(_funclist.C_UnwrapKey(handle, mech_data, unwrapping_key,
wrapped_key_ptr, wrapped_key_len,
attr_data, attr_count, &key))
return Object._make(self.session, key)
class DeriveMixin(types.DeriveMixin):
"""Expand DeriveMixin with an implementation."""
def derive_key(self, key_type, key_length,
id=None, label=None,
store=False, capabilities=None,
mechanism=None, mechanism_param=None,
template=None):
if not isinstance(key_type, KeyType):
raise ArgumentsBad("`key_type` must be KeyType.")
if not isinstance(key_length, int):
raise ArgumentsBad("`key_length` is the length in bits.")
if capabilities is None:
try:
capabilities = DEFAULT_KEY_CAPABILITIES[key_type]
except KeyError:
raise ArgumentsBad("No default capabilities for this key "
"type. Please specify `capabilities`.")
mech = MechanismWithParam(
self.key_type, DEFAULT_DERIVE_MECHANISMS,
mechanism, mechanism_param)
# Build attributes
template_ = {
Attribute.CLASS: ObjectClass.SECRET_KEY,
Attribute.KEY_TYPE: key_type,
Attribute.ID: id or b'',
Attribute.LABEL: label or '',
Attribute.TOKEN: store,
Attribute.VALUE_LEN: key_length // 8, # In bytes
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
# Capabilities
Attribute.ENCRYPT: MechanismFlag.ENCRYPT & capabilities,
Attribute.DECRYPT: MechanismFlag.DECRYPT & capabilities,
Attribute.WRAP: MechanismFlag.WRAP & capabilities,
Attribute.UNWRAP: MechanismFlag.UNWRAP & capabilities,
Attribute.SIGN: MechanismFlag.SIGN & capabilities,
Attribute.VERIFY: MechanismFlag.VERIFY & capabilities,
Attribute.DERIVE: MechanismFlag.DERIVE & capabilities,
}
attrs = AttributeList(merge_templates(template_, template))
cdef CK_SESSION_HANDLE handle = self.session._handle
cdef CK_MECHANISM *mech_data = mech.data
cdef CK_OBJECT_HANDLE src_key = self._handle
cdef CK_ATTRIBUTE *attr_data = attrs.data
cdef CK_ULONG attr_count = attrs.count
cdef CK_OBJECT_HANDLE key
with nogil:
assertRV(_funclist.C_DeriveKey(handle, mech_data, src_key,
attr_data, attr_count, &key))
return Object._make(self.session, key)
_CLASS_MAP = {
ObjectClass.SECRET_KEY: SecretKey,
ObjectClass.PUBLIC_KEY: PublicKey,
ObjectClass.PRIVATE_KEY: PrivateKey,
ObjectClass.DOMAIN_PARAMETERS: DomainParameters,
ObjectClass.CERTIFICATE: Certificate,
}
cdef class lib:
"""
Main entry point.
This class needs to be defined cdef, so it can't shadow a class in
pkcs11.types.
"""
cdef public str so
cdef public str manufacturer_id
cdef public str library_description
cdef public tuple cryptoki_version
cdef public tuple library_version
IF UNAME_SYSNAME == "Windows":
cdef mswin.HMODULE _handle
ELSE:
cdef void *_handle
cdef _load_pkcs11_lib(self, so) with gil:
"""Load a PKCS#11 library, and extract function calls.
This method will dynamically load a PKCS11 library, and attempt to
resolve the symbol 'C_GetFunctionList()'. Once found, the entry point
is called to populate an internal table of function pointers.
This is a private method, and must never be called directly.
Called when a new lib class is instantiated.
:param so: the path to a valid PKCS#11 library
:type so: str
:raises: RuntimeError or PKCS11Error
:rtype: None
"""
# to keep a pointer to the C_GetFunctionList address returned by dlsym()
cdef C_GetFunctionList_ptr C_GetFunctionList
IF UNAME_SYSNAME == "Windows":
self._handle = mswin.LoadLibraryW(so)
if self._handle == NULL:
raise RuntimeError("Cannot open library at {}: {}".format(so, mswin.winerror(so)))
if self._handle != NULL:
C_GetFunctionList = <C_GetFunctionList_ptr> mswin.GetProcAddress(self._handle, 'C_GetFunctionList')
if C_GetFunctionList == NULL:
raise RuntimeError("{} is not a PKCS#11 library: {}".format(so, mswin.winerror(so)))
ELSE:
self._handle = dlfcn.dlopen(so.encode('utf-8'), dlfcn.RTLD_LAZY | dlfcn.RTLD_LOCAL)
if self._handle == NULL:
raise RuntimeError(dlfcn.dlerror())
C_GetFunctionList = <C_GetFunctionList_ptr> dlfcn.dlsym(self._handle, 'C_GetFunctionList')
if C_GetFunctionList == NULL:
raise RuntimeError("{} is not a PKCS#11 library: {}".format(so, dlfcn.dlerror()))
with nogil:
assertRV(C_GetFunctionList(&_funclist))
cdef _unload_pkcs11_lib(self) with gil:
"""Unload a PKCS#11 library.
This method will dynamically unload a PKCS11 library.
This is a private method, and must never be called directly.
Called when a lib instance is destroyed.
"""
IF UNAME_SYSNAME == "Windows":
if self._handle != NULL:
mswin.FreeLibrary(self._handle)
ELSE:
if self._handle != NULL:
dlfcn.dlclose(self._handle)
def __cinit__(self, so):
self._load_pkcs11_lib(so)
# at this point, _funclist contains all function pointers to the library
with nogil:
assertRV(_funclist.C_Initialize(NULL))
def __init__(self, so):
self.so = so
cdef CK_INFO info
with nogil:
assertRV(_funclist.C_GetInfo(&info))
manufacturerID = info.manufacturerID[:sizeof(info.manufacturerID)]
libraryDescription = info.libraryDescription[:sizeof(info.libraryDescription)]
self.manufacturer_id = _CK_UTF8CHAR_to_str(manufacturerID)
self.library_description = _CK_UTF8CHAR_to_str(libraryDescription)
self.cryptoki_version = _CK_VERSION_to_tuple(info.cryptokiVersion)
self.library_version = _CK_VERSION_to_tuple(info.libraryVersion)
def __str__(self):
return '\n'.join((
"Library: %s" % self.so,
"Manufacturer ID: %s" % self.manufacturer_id,
"Library Description: %s" % self.library_description,
"Cryptoki Version: %s.%s" % self.cryptoki_version,
"Library Version: %s.%s" % self.library_version,
))
def __repr__(self):
return '<pkcs11.lib ({so})>'.format(
so=self.so)
def get_slots(self, token_present=False):
"""Get all slots."""
cdef CK_BBOOL present = token_present
cdef CK_ULONG count
with nogil:
assertRV(_funclist.C_GetSlotList(present, NULL, &count))
if count == 0:
return []
cdef CK_SLOT_ID [:] slot_list = CK_ULONG_buffer(count)
with nogil:
assertRV(_funclist.C_GetSlotList(present, &slot_list[0], &count))
cdef CK_SLOT_ID slot_id
cdef CK_SLOT_INFO info
slots = []
for slot_id in slot_list:
with nogil:
assertRV(_funclist.C_GetSlotInfo(slot_id, &info))
slotDescription = info.slotDescription[:sizeof(info.slotDescription)]
manufacturerID = info.manufacturerID[:sizeof(info.manufacturerID)]
slots.append(
Slot(self, slot_id, slotDescription, manufacturerID,
info.hardwareVersion, info.firmwareVersion, info.flags)
)
return slots
def get_tokens(self,
token_label=None,
token_serial=None,
token_flags=None,
slot_flags=None,
mechanisms=None):
"""Search for a token matching the parameters."""
for slot in self.get_slots():
try:
token = slot.get_token()
token_mechanisms = slot.get_mechanisms()
if token_label is not None and \
token.label != token_label:
continue
if token_serial is not None and \
token.serial != token_serial:
continue
if token_flags is not None and \
not token.flags & token_flags:
continue
if slot_flags is not None and \
not slot.flags & slot_flags:
continue
if mechanisms is not None and \
set(mechanisms) not in token_mechanisms:
continue
yield token
except (TokenNotPresent, TokenNotRecognised):
continue
def get_token(self, **kwargs):
"""Get a single token."""
iterator = self.get_tokens(**kwargs)
try:
token = next(iterator)
except StopIteration:
raise NoSuchToken("No token matching %s" % kwargs)
try:
next(iterator)
raise MultipleTokensReturned(
"More than 1 token matches %s" % kwargs)
except StopIteration:
return token
def reinitialize(self):
if _funclist != NULL:
with nogil:
assertRV(_funclist.C_Finalize(NULL))
assertRV(_funclist.C_Initialize(NULL))
def __dealloc__(self):
if _funclist != NULL:
with nogil:
assertRV(_funclist.C_Finalize(NULL))
self._unload_pkcs11_lib()
|