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
|
from datetime import datetime
from struct import Struct
from pkcs11.constants import (
Attribute,
CertificateType,
MechanismFlag,
ObjectClass,
)
from pkcs11.mechanisms import KeyType, Mechanism
# (Pack Function, Unpack Function) functions
handle_bool = (Struct("?").pack, lambda v: False if len(v) == 0 else Struct("?").unpack(v)[0])
handle_ulong = (Struct("L").pack, lambda v: Struct("L").unpack(v)[0])
handle_str = (lambda s: s.encode("utf-8"), lambda b: b.decode("utf-8"))
handle_date = (
lambda s: s.strftime("%Y%m%d").encode("ascii"),
lambda s: datetime.strptime(s.decode("ascii"), "%Y%m%d").date(),
)
handle_bytes = (bytes, bytes)
# The PKCS#11 biginteger type is an array of bytes in network byte order.
# If you have an int type, wrap it in biginteger()
handle_biginteger = handle_bytes
def _enum(type_):
"""Factory to pack/unpack ints into IntEnums."""
pack, unpack = handle_ulong
return (lambda v: pack(int(v)), lambda v: type_(unpack(v)))
ATTRIBUTE_TYPES = {
Attribute.ALWAYS_AUTHENTICATE: handle_bool,
Attribute.ALWAYS_SENSITIVE: handle_bool,
Attribute.APPLICATION: handle_str,
Attribute.BASE: handle_biginteger,
Attribute.CERTIFICATE_TYPE: _enum(CertificateType),
Attribute.CHECK_VALUE: handle_bytes,
Attribute.CLASS: _enum(ObjectClass),
Attribute.COEFFICIENT: handle_biginteger,
Attribute.DECRYPT: handle_bool,
Attribute.DERIVE: handle_bool,
Attribute.EC_PARAMS: handle_bytes,
Attribute.EC_POINT: handle_bytes,
Attribute.ENCRYPT: handle_bool,
Attribute.END_DATE: handle_date,
Attribute.EXPONENT_1: handle_biginteger,
Attribute.EXPONENT_2: handle_biginteger,
Attribute.EXTRACTABLE: handle_bool,
Attribute.HASH_OF_ISSUER_PUBLIC_KEY: handle_bytes,
Attribute.HASH_OF_SUBJECT_PUBLIC_KEY: handle_bytes,
Attribute.ID: handle_bytes,
Attribute.ISSUER: handle_bytes,
Attribute.KEY_GEN_MECHANISM: _enum(Mechanism),
Attribute.KEY_TYPE: _enum(KeyType),
Attribute.LABEL: handle_str,
Attribute.LOCAL: handle_bool,
Attribute.MODIFIABLE: handle_bool,
Attribute.COPYABLE: handle_bool,
Attribute.MODULUS: handle_biginteger,
Attribute.MODULUS_BITS: handle_ulong,
Attribute.NEVER_EXTRACTABLE: handle_bool,
Attribute.OBJECT_ID: handle_bytes,
Attribute.PRIME: handle_biginteger,
Attribute.PRIME_BITS: handle_ulong,
Attribute.PRIME_1: handle_biginteger,
Attribute.PRIME_2: handle_biginteger,
Attribute.PRIVATE: handle_bool,
Attribute.PRIVATE_EXPONENT: handle_biginteger,
Attribute.PUBLIC_EXPONENT: handle_biginteger,
Attribute.SENSITIVE: handle_bool,
Attribute.SERIAL_NUMBER: handle_bytes,
Attribute.SIGN: handle_bool,
Attribute.SIGN_RECOVER: handle_bool,
Attribute.START_DATE: handle_date,
Attribute.SUBJECT: handle_bytes,
Attribute.SUBPRIME: handle_biginteger,
Attribute.SUBPRIME_BITS: handle_ulong,
Attribute.TOKEN: handle_bool,
Attribute.TRUSTED: handle_bool,
Attribute.UNIQUE_ID: handle_str,
Attribute.UNWRAP: handle_bool,
Attribute.URL: handle_str,
Attribute.VALUE: handle_biginteger,
Attribute.VALUE_BITS: handle_ulong,
Attribute.VALUE_LEN: handle_ulong,
Attribute.VERIFY: handle_bool,
Attribute.VERIFY_RECOVER: handle_bool,
Attribute.WRAP: handle_bool,
Attribute.WRAP_WITH_TRUSTED: handle_bool,
Attribute.GOSTR3410_PARAMS: handle_bytes,
Attribute.GOSTR3411_PARAMS: handle_bytes,
}
"""
Map of attributes to (serialize, deserialize) functions.
"""
ALL_CAPABILITIES = (
Attribute.ENCRYPT,
Attribute.DECRYPT,
Attribute.WRAP,
Attribute.UNWRAP,
Attribute.SIGN,
Attribute.VERIFY,
Attribute.DERIVE,
)
def _apply_common(template, id_, label, store):
if id_:
template[Attribute.ID] = id_
if label:
template[Attribute.LABEL] = label
template[Attribute.TOKEN] = bool(store)
def _apply_capabilities(template, possible_capas, capabilities):
for attr in possible_capas:
template[attr] = _capa_attr_to_mechanism_flag[attr] & capabilities
_capa_attr_to_mechanism_flag = {
Attribute.ENCRYPT: MechanismFlag.ENCRYPT,
Attribute.DECRYPT: MechanismFlag.DECRYPT,
Attribute.WRAP: MechanismFlag.WRAP,
Attribute.UNWRAP: MechanismFlag.UNWRAP,
Attribute.SIGN: MechanismFlag.SIGN,
Attribute.VERIFY: MechanismFlag.VERIFY,
Attribute.DERIVE: MechanismFlag.DERIVE,
}
class AttributeMapper:
"""
Class mapping PKCS#11 attributes to and from Python values.
"""
def __init__(self):
self.attribute_types = dict(ATTRIBUTE_TYPES)
self.default_secret_key_template = {
Attribute.CLASS: ObjectClass.SECRET_KEY,
Attribute.ID: b"",
Attribute.LABEL: "",
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
}
self.default_public_key_template = {
Attribute.CLASS: ObjectClass.PUBLIC_KEY,
Attribute.ID: b"",
Attribute.LABEL: "",
}
self.default_private_key_template = {
Attribute.CLASS: ObjectClass.PRIVATE_KEY,
Attribute.ID: b"",
Attribute.LABEL: "",
Attribute.PRIVATE: True,
Attribute.SENSITIVE: True,
}
def register_handler(self, key, pack, unpack):
self.attribute_types[key] = (pack, unpack)
def _handler(self, key):
try:
return self.attribute_types[key]
except KeyError as e:
raise NotImplementedError(f"Can't handle attribute type {hex(key)}.") from e
def pack_attribute(self, key, value):
"""Pack a Attribute value into a bytes array."""
pack, _ = self._handler(key)
return pack(value)
def unpack_attributes(self, key, value):
"""Unpack a Attribute bytes array into a Python value."""
_, unpack = self._handler(key)
return unpack(value)
def public_key_template(
self,
*,
capabilities,
id_,
label,
store,
):
template = self.default_public_key_template
_apply_capabilities(
template, (Attribute.ENCRYPT, Attribute.WRAP, Attribute.VERIFY), capabilities
)
_apply_common(template, id_, label, store)
return template
def private_key_template(
self,
*,
capabilities,
id_,
label,
store,
):
template = self.default_private_key_template
_apply_capabilities(
template,
(Attribute.DECRYPT, Attribute.UNWRAP, Attribute.SIGN, Attribute.DERIVE),
capabilities,
)
_apply_common(template, id_, label, store)
return template
def secret_key_template(
self,
*,
capabilities,
id_,
label,
store,
):
return self.generic_key_template(
self.default_secret_key_template,
capabilities=capabilities,
id_=id_,
label=label,
store=store,
)
def generic_key_template(
self,
base_template,
*,
capabilities,
id_,
label,
store,
):
template = dict(base_template)
_apply_capabilities(template, ALL_CAPABILITIES, capabilities)
_apply_common(template, id_, label, store)
return template
|
