Botan 3.11.0
Crypto and TLS for C&
p11_error.cpp
Go to the documentation of this file.
1/*
2* PKCS #11 Error Information
3* (C) 2025 Jack Lloyd
4* (C) 2025 Fabian Albert - Rohde & Schwarz Cybersecurity GmbH
5*
6* Botan is released under the Simplified BSD License (see license.txt)
7*/
8
9#include <botan/p11.h>
10#include <botan/internal/fmt.h>
11
12namespace Botan::PKCS11 {
13
14namespace {
15std::string to_string(ReturnValue return_val) {
16 switch(return_val) {
17 case ReturnValue::OK:
18 return "function executed successfully";
19 case ReturnValue::Cancel:
20 return "function aborted by application";
21 case ReturnValue::HostMemory:
22 return "insufficient memory to perform function";
23 case ReturnValue::SlotIdInvalid:
24 return "invalid slot id";
25 case ReturnValue::GeneralError:
26 return "unrecoverable error occurred";
27 case ReturnValue::FunctionFailed:
28 return "function failed without detailed information";
29 case ReturnValue::ArgumentsBad:
30 return "invalid arguments supplied";
31 case ReturnValue::NoEvent:
32 return "no new slot events";
33 case ReturnValue::NeedToCreateThreads:
34 return "library needs to create threads";
35 case ReturnValue::CantLock:
36 return "requested locking not available";
37 case ReturnValue::AttributeReadOnly:
38 return "attribute cannot be modified";
39 case ReturnValue::AttributeSensitive:
40 return "attribute is sensitive and cannot be revealed";
41 case ReturnValue::AttributeTypeInvalid:
42 return "invalid attribute type";
43 case ReturnValue::AttributeValueInvalid:
44 return "invalid attribute value";
45 case ReturnValue::ActionProhibited:
46 return "action not allowed by policy";
47 case ReturnValue::DataInvalid:
48 return "invalid plaintext input data";
49 case ReturnValue::DataLenRange:
50 return "plaintext data length out of range";
51 case ReturnValue::DeviceError:
52 return "problem with token or slot";
53 case ReturnValue::DeviceMemory:
54 return "insufficient token memory";
55 case ReturnValue::DeviceRemoved:
56 return "token removed during function execution";
57 case ReturnValue::EncryptedDataInvalid:
58 return "invalid ciphertext input";
59 case ReturnValue::EncryptedDataLenRange:
60 return "ciphertext length out of range";
61 case ReturnValue::AeadDecryptFailed:
62 return "AEAD decrypt failed";
63 case ReturnValue::FunctionCanceled:
64 return "function canceled mid-execution";
65 case ReturnValue::FunctionNotParallel:
66 return "no function executing in parallel";
67 case ReturnValue::FunctionNotSupported:
68 return "function not supported";
69 case ReturnValue::KeyHandleInvalid:
70 return "invalid key handle";
71 case ReturnValue::KeySizeRange:
72 return "key size out of range";
73 case ReturnValue::KeyTypeInconsistent:
74 return "key type inconsistent with mechanism";
75 case ReturnValue::KeyNotNeeded:
76 return "extraneous key supplied";
77 case ReturnValue::KeyChanged:
78 return "key changed";
79 case ReturnValue::KeyNeeded:
80 return "key needed to restore session state";
81 case ReturnValue::KeyIndigestible:
82 return "key cannot be digested";
83 case ReturnValue::KeyFunctionNotPermitted:
84 return "key use not permitted";
85 case ReturnValue::KeyNotWrappable:
86 return "key cannot be wrapped";
87 case ReturnValue::KeyUnextractable:
88 return "key cannot be extracted";
89 case ReturnValue::MechanismInvalid:
90 return "invalid mechanism specified";
91 case ReturnValue::MechanismParamInvalid:
92 return "invalid mechanism parameters";
93 case ReturnValue::ObjectHandleInvalid:
94 return "invalid object handle";
95 case ReturnValue::OperationActive:
96 return "conflicting active operation";
97 case ReturnValue::OperationNotInitialized:
98 return "operation not initialized";
99 case ReturnValue::PinIncorrect:
100 return "incorrect PIN";
101 case ReturnValue::PinInvalid:
102 return "invalid PIN characters";
103 case ReturnValue::PinLenRange:
104 return "PIN length out of range";
105 case ReturnValue::PinExpired:
106 return "PIN expired";
107 case ReturnValue::PinLocked:
108 return "PIN locked due to failed attempts";
109 case ReturnValue::SessionClosed:
110 return "session closed during function execution";
111 case ReturnValue::SessionCount:
112 return "too many sessions open";
113 case ReturnValue::SessionHandleInvalid:
114 return "invalid session handle";
115 case ReturnValue::SessionParallelNotSupported:
116 return "parallel sessions not supported";
117 case ReturnValue::SessionReadOnly:
118 return "read-only session";
119 case ReturnValue::SessionExists:
120 return "session already open";
121 case ReturnValue::SessionReadOnlyExists:
122 return "read-only session already exists";
123 case ReturnValue::SessionReadWriteSoExists:
124 return "read/write SO session exists";
125 case ReturnValue::SignatureInvalid:
126 return "invalid signature";
127 case ReturnValue::SignatureLenRange:
128 return "invalid signature length";
129 case ReturnValue::TemplateIncomplete:
130 return "incomplete template";
131 case ReturnValue::TemplateInconsistent:
132 return "conflicting template attributes";
133 case ReturnValue::TokenNotPresent:
134 return "token not present in slot";
135 case ReturnValue::TokenNotRecognized:
136 return "token not recognized";
137 case ReturnValue::TokenWriteProtected:
138 return "token is write-protected";
139 case ReturnValue::UnwrappingKeyHandleInvalid:
140 return "invalid unwrapping key handle";
141 case ReturnValue::UnwrappingKeySizeRange:
142 return "unwrapping key size out of range";
143 case ReturnValue::UnwrappingKeyTypeInconsistent:
144 return "unwrapping key type inconsistent";
145 case ReturnValue::UserAlreadyLoggedIn:
146 return "user already logged in";
147 case ReturnValue::UserNotLoggedIn:
148 return "user not logged in";
149 case ReturnValue::UserPinNotInitialized:
150 return "user PIN not initialized";
151 case ReturnValue::UserTypeInvalid:
152 return "invalid user type";
153 case ReturnValue::UserAnotherAlreadyLoggedIn:
154 return "another user already logged in";
155 case ReturnValue::UserTooManyTypes:
156 return "too many distinct users logged in";
157 case ReturnValue::WrappedKeyInvalid:
158 return "invalid wrapped key";
159 case ReturnValue::WrappedKeyLenRange:
160 return "wrapped key length out of range";
161 case ReturnValue::WrappingKeyHandleInvalid:
162 return "invalid wrapping key handle";
163 case ReturnValue::WrappingKeySizeRange:
164 return "wrapping key size out of range";
165 case ReturnValue::WrappingKeyTypeInconsistent:
166 return "wrapping key type inconsistent";
167 case ReturnValue::RandomSeedNotSupported:
168 return "RNG does not accept seeding";
169 case ReturnValue::RandomNoRng:
170 return "no random number generator";
171 case ReturnValue::DomainParamsInvalid:
172 return "invalid domain parameters";
173 case ReturnValue::CurveNotSupported:
174 return "curve not supported by token";
175 case ReturnValue::BufferTooSmall:
176 return "output buffer too small";
177 case ReturnValue::SavedStateInvalid:
178 return "invalid saved state";
179 case ReturnValue::InformationSensitive:
180 return "information is sensitive";
181 case ReturnValue::StateUnsaveable:
182 return "state cannot be saved";
183 case ReturnValue::CryptokiNotInitialized:
184 return "library not initialized";
185 case ReturnValue::CryptokiAlreadyInitialized:
186 return "library already initialized";
187 case ReturnValue::MutexBad:
188 return "bad mutex object";
189 case ReturnValue::MutexNotLocked:
190 return "mutex not locked";
191 case ReturnValue::NewPinMode:
192 return "new PIN mode";
193 case ReturnValue::NextOtp:
194 return "next OTP";
195 case ReturnValue::ExceededMaxIterations:
196 return "exceeded max iterations";
197 case ReturnValue::FipsSelfTestFailed:
198 return "FIPS self-test failed";
199 case ReturnValue::LibraryLoadFailed:
200 return "failed to load dependent library";
201 case ReturnValue::PinTooWeak:
202 return "PIN too weak";
203 case ReturnValue::PublicKeyInvalid:
204 return "invalid public key";
205 case ReturnValue::FunctionRejected:
206 return "signature request rejected by user";
207 case ReturnValue::TokenResourceExceeded:
208 return "token resource exceeded";
209 case ReturnValue::OperationCancelFailed:
210 return "operation cancel failed";
211 case ReturnValue::KeyExhausted:
212 return "key exhausted";
213 case ReturnValue::Pending:
214 return "operation running asynchronously";
215 case ReturnValue::SessionAsyncNotSupported:
216 return "async operations not supported";
217 case ReturnValue::SeedRandomRequired:
218 return "RNG needs seeding";
219 case ReturnValue::OperationNotValidated:
220 return "operation violates token validation policies";
221 case ReturnValue::TokenNotInitialized:
222 return "token needs initialization";
223 case ReturnValue::ParameterSetNotSupported:
224 return "parameter set not supported";
225 case ReturnValue::VendorDefined:
226 return "vendor defined error";
227 }
228 return "unknown error";
229}
230} // namespace
231
232PKCS11_ReturnError::PKCS11_ReturnError(ReturnValue return_val) :
233 PKCS11_Error(Botan::fmt("{} ({})", static_cast<uint32_t>(return_val), to_string(return_val))),
234 m_return_val(return_val) {}
235
236} // namespace Botan::PKCS11
Botan::PKCS11::PKCS11_Error::PKCS11_Error
PKCS11_Error(std::string_view what)
Definition p11.h:4015
Botan::PKCS11::PKCS11_ReturnError::PKCS11_ReturnError
PKCS11_ReturnError(ReturnValue return_val)
Definition p11_error.cpp:232
Botan::fmt
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
Botan::to_string
std::string to_string(ErrorType type)
Convert an ErrorType to string.
Definition exceptn.cpp:13
Generated by doxygen 1.15.0