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
|
API Reference
=============
.. contents:: Section Contents
:depth: 2
:local:
Classes
-------
.. automodule:: pkcs11
:members:
:exclude-members: lib
.. class:: lib(so)
Initialises the PKCS#11 library.
Only one PKCS#11 library can be initialised.
:param str so: Path to the PKCS#11 library to initialise.
.. method:: get_slots(token_present=False)
Returns a list of PKCS#11 device slots known to this library.
:param token_present: If true, will limit the results to
slots with a token present.
:rtype: list(Slot)
.. method:: get_tokens(token_label=None, token_serial=None, token_flags=None, slot_flags=None, mechanisms=None)
Generator yielding PKCS#11 tokens matching the provided parameters.
See also :meth:`get_token`.
:param str token_label: Optional token label.
:param bytes token_serial: Optional token serial.
:param TokenFlag token_flags: Optional bitwise token flags.
:param SlotFlag slot_flags: Optional bitwise slot flags.
:param iter(Mechanism) mechanisms: Optional required mechanisms.
:rtype: iter(Token)
.. method:: get_token(token_label=None, token_serial=None, token_flags=None, slot_flags=None, mechanisms=None)
Returns a single token or raises either
:class:`pkcs11.exceptions.NoSuchToken` or
:class:`pkcs11.exceptions.MultipleTokensReturned`.
See also :meth:`get_tokens`.
:param str token_label: Optional token label.
:param bytes token_serial: Optional token serial.
:param TokenFlag token_flags: Optional bitwise token flags.
:param SlotFlag slot_flags: Optional bitwise slot flags.
:param iter(Mechanism) mechanisms: Optional required mechanisms.
:rtype: Token
.. method:: reinitialize()
Reinitializes the loaded PKCS#11 library.
:rtype: None
.. attribute:: cryptoki_version
PKCS#11 Cryptoki standard version (:class:`tuple`).
.. attribute:: manufacturer_id
Library vendor's name (:class:`str`).
.. attribute:: library_description
Description of the vendor's library (:class:`str`).
.. attribute:: library_version
Vendor's library version (:class:`tuple`).
.. autoclass:: Slot()
:members:
:inherited-members:
.. autoclass:: Token()
:members:
:inherited-members:
.. autoclass:: Session()
:members:
:inherited-members:
Token Objects
~~~~~~~~~~~~~
The following classes relate to :class:`Object` objects on the
:class:`Token`.
.. autoclass:: Object()
:members:
:inherited-members:
.. autoclass:: Key(Object)
:members:
.. autoclass:: SecretKey(Key)
:members:
.. autoclass:: PublicKey(Key)
:members:
.. autoclass:: PrivateKey(Key)
:members:
.. autoclass:: DomainParameters(Object)
:members:
.. autoclass:: Certificate(Object)
:members:
Object Capabilities
~~~~~~~~~~~~~~~~~~~
Capability mixins for :class:`Object` objects.
.. autoclass:: EncryptMixin()
:members:
.. autoclass:: DecryptMixin()
:members:
.. autoclass:: SignMixin()
:members:
.. autoclass:: VerifyMixin()
:members:
.. autoclass:: WrapMixin()
:members:
.. autoclass:: UnwrapMixin()
:members:
.. autoclass:: DeriveMixin()
:members:
Constants
---------
.. automodule:: pkcs11.constants
:members:
:inherited-members:
:undoc-members:
Key Types & Mechanisms
----------------------
.. automodule:: pkcs11.mechanisms
:members:
:inherited-members:
:undoc-members:
.. autoclass:: pkcs11.MechanismInfo()
:members:
:inherited-members:
Exceptions
----------
.. automodule:: pkcs11.exceptions
:members:
:undoc-members:
Utilities
---------
General Utilities
~~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util
:members:
:undoc-members:
RSA Key Utilities
~~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util.rsa
:members:
:undoc-members:
DSA Key Utilities
~~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util.dsa
:members:
:undoc-members:
DH Key Utilities
~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util.dh
:members:
:undoc-members:
EC Key Utilities
~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util.ec
:members:
:undoc-members:
X.509 Certificate Utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: pkcs11.util.x509
:members:
:undoc-members:
|
