pkcs11-helper
pkcs11h-core.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005-2018 Alon Bar-Lev <alon.barlev@gmail.com>
3  *
4  * This software is available to you under a choice of one of two
5  * licenses. You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, or the BSD license.
7  *
8  * GNU General Public License (GPL) Version 2
9  * ===========================================
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2
12  * as published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program (see the file COPYING.GPL included with this
21  * distribution); if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  * BSD License
25  * ============
26  * Redistribution and use in source and binary forms, with or without
27  * modification, are permitted provided that the following conditions are met:
28  *
29  * o Redistributions of source code must retain the above copyright notice,
30  * this list of conditions and the following disclaimer.
31  * o Redistributions in binary form must reproduce the above copyright
32  * notice, this list of conditions and the following disclaimer in the
33  * documentation and/or other materials provided with the distribution.
34  * o Neither the name of the Alon Bar-Lev nor the names of its
35  * contributors may be used to endorse or promote products derived from
36  * this software without specific prior written permission.
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
39  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
41  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
42  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
43  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
44  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
45  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
46  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
47  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
48  * POSSIBILITY OF SUCH DAMAGE.
49  */
50 
66 #ifndef __PKCS11H_BASE_H
67 #define __PKCS11H_BASE_H
68 
69 #include <stdarg.h>
70 #include <time.h>
71 
75 
76 #if defined(__cplusplus)
77 extern "C" {
78 #endif
79 
87 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_OPENSSL (1<< 0)
88 
89 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_GNUTLS (1<< 1)
90 
91 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_CRYPTOAPI (1<< 2)
92 
96 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_WIN32 (1<< 2)
97 
98 #define PKCS11H_FEATURE_MASK_DEBUG (1<< 3)
99 
100 #define PKCS11H_FEATURE_MASK_THREADING (1<< 4)
101 
102 #define PKCS11H_FEATURE_MASK_TOKEN (1<< 5)
103 
104 #define PKCS11H_FEATURE_MASK_DATA (1<< 6)
105 
106 #define PKCS11H_FEATURE_MASK_CERTIFICATE (1<< 7)
107 
108 #define PKCS11H_FEATURE_MASK_SLOTEVENT (1<< 8)
109 
110 #define PKCS11H_FEATURE_MASK_OPENSSL (1<< 9)
111 
112 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_POLARSSL (1<< 10)
113 
114 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_MBEDTLS (1<< 10)
115 
125 #define PKCS11H_LOG_DEBUG2 5
126 
127 #define PKCS11H_LOG_DEBUG1 4
128 
129 #define PKCS11H_LOG_INFO 3
130 
131 #define PKCS11H_LOG_WARN 2
132 
133 #define PKCS11H_LOG_ERROR 1
134 
135 #define PKCS11H_LOG_QUIET 0
136 
139 #define PKCS11H_PIN_CACHE_INFINITE -1
140 
147 #define PKCS11H_PRIVATEMODE_MASK_AUTO (0)
148 
149 #define PKCS11H_PRIVATEMODE_MASK_SIGN (1<<0)
150 
151 #define PKCS11H_PRIVATEMODE_MASK_RECOVER (1<<1)
152 
153 #define PKCS11H_PRIVATEMODE_MASK_DECRYPT (1<<2)
154 
155 #define PKCS11H_PRIVATEMODE_MASK_UNWRAP (1<<3)
156 
163 /* Auto select by provider information. */
164 #define PKCS11H_SLOTEVENT_METHOD_AUTO 0
165 
166 #define PKCS11H_SLOTEVENT_METHOD_TRIGGER 1
167 
168 #define PKCS11H_SLOTEVENT_METHOD_POLL 2
169 
170 #define PKCS11H_SLOTEVENT_METHOD_FETCH 3
171 
179 #define PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT (1<<0)
180 
181 #define PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT (1<<1)
182 
183 #define PKCS11H_PROMPT_MASK_ALLOW_ALL ( \
184  PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT | \
185  PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT \
186  )
187 
195 #define PKCS11H_ENUM_METHOD_CACHE 0
196 
197 #define PKCS11H_ENUM_METHOD_CACHE_EXIST 1
198 
199 #define PKCS11H_ENUM_METHOD_RELOAD 2
200 
212 #define PKCS11H_PROVIDER_PROPERTY_LOCATION 0
213 
218 #define PKCS11H_PROVIDER_PROPERTY_ALLOW_PROTECTED_AUTH 1
219 
224 #define PKCS11H_PROVIDER_PROPERTY_MASK_PRIVATE_MODE 2
225 
230 #define PKCS11H_PROVIDER_PROPERTY_SLOT_EVENT_METHOD 3
231 
236 #define PKCS11H_PROVIDER_PROPERTY_SLOT_POLL_INTERVAL 4
237 /*
238  * @brief Provider's certificate access should be done after login.
239  * Value type is @ref PKCS11H_BOOL.
240  * Default value is False.
241 */
242 #define PKCS11H_PROVIDER_PROPERTY_CERT_IS_PRIVATE 5
243 
249 #define PKCS11H_PROVIDER_PROPERTY_INIT_ARGS 6
250 
252 #define _PKCS11H_PROVIDER_PROPERTY_LAST 7
253 
256 struct pkcs11h_token_id_s;
257 
262 
270 typedef void (*pkcs11h_hook_log_t)(
271  IN void * const global_data,
272  IN const unsigned flags,
273  IN const char * const format,
274  IN va_list args
275 );
276 
281 typedef void (*pkcs11h_hook_slotevent_t)(
282  IN void * const global_data
283 );
284 
293 typedef PKCS11H_BOOL (*pkcs11h_hook_token_prompt_t)(
294  IN void * const global_data,
295  IN void * const user_data,
296  IN const pkcs11h_token_id_t token,
297  IN const unsigned retry
298 );
299 
310 typedef PKCS11H_BOOL (*pkcs11h_hook_pin_prompt_t)(
311  IN void * const global_data,
312  IN void * const user_data,
313  IN const pkcs11h_token_id_t token,
314  IN const unsigned retry,
315  OUT char * const pin,
316  IN const size_t pin_max
317 );
318 
324  char display[1024];
326  char manufacturerID[sizeof (((CK_TOKEN_INFO *)NULL)->manufacturerID)+1];
328  char model[sizeof (((CK_TOKEN_INFO *)NULL)->model)+1];
330  char serialNumber[sizeof (((CK_TOKEN_INFO *)NULL)->serialNumber)+1];
332  char label[sizeof (((CK_TOKEN_INFO *)NULL)->label)+1];
333 };
334 
340 const char *
342  IN const CK_RV rv
343 );
344 
349 unsigned int
350 pkcs11h_getVersion (void);
351 
356 unsigned int
357 pkcs11h_getFeatures (void);
358 
365 CK_RV
366 pkcs11h_initialize (void);
367 
373 CK_RV
374 pkcs11h_terminate (void);
375 
380 void
382  IN const unsigned flags
383 );
384 
389 unsigned
390 pkcs11h_getLogLevel (void);
391 
404 CK_RV
406  IN const PKCS11H_BOOL safe
407 );
408 
415 CK_RV
417  IN const pkcs11h_hook_log_t hook,
418  IN void * const global_data
419 );
420 
432 CK_RV
434  IN const pkcs11h_hook_slotevent_t hook,
435  IN void * const global_data
436 );
437 
446 CK_RV
448  IN const pkcs11h_hook_token_prompt_t hook,
449  IN void * const global_data
450 );
451 
460 CK_RV
462  IN const pkcs11h_hook_pin_prompt_t hook,
463  IN void * const global_data
464 );
465 
472 CK_RV
474  IN const PKCS11H_BOOL allow_protected_auth
475 );
476 
483 CK_RV
485  IN const int pin_cache_period
486 );
487 
494 CK_RV
496  IN const unsigned max_retries
497 );
498 
512 CK_RV
514  IN const char * const reference,
515  IN const char * const provider_location,
516  IN const PKCS11H_BOOL allow_protected_auth,
517  IN const unsigned mask_private_mode,
518  IN const unsigned slot_event_method,
519  IN const unsigned slot_poll_interval,
520  IN const PKCS11H_BOOL cert_is_private
521 );
522 
528 CK_RV
530  IN const char * const reference
531 );
532 
539 CK_RV
541  IN const char * const reference,
542  IN const char * const property_str,
543  IN const char * const value_str
544 );
545 
555 CK_RV
557  IN const char * const reference,
558  IN const unsigned property,
559  IN const void * value,
560  IN const size_t value_size
561 );
562 
570 CK_RV
572  IN const char * const reference
573 );
574 
581 CK_RV
583  IN const char * const reference
584 );
585 
601 CK_RV
602 pkcs11h_forkFixup (void);
603 
615 CK_RV
616 pkcs11h_plugAndPlay (void);
617 
622 CK_RV
623 pkcs11h_logout (void);
624 
625 #ifdef __cplusplus
626 }
627 #endif
628 
631 #endif /* __PKCS11H_BASE_H */
CK_RV pkcs11h_registerProvider(IN const char *const reference)
Register a PKCS#11 provider.
CK_RV pkcs11h_logout(void)
Logout from all sessions.
PKCS11H_BOOL(* pkcs11h_hook_pin_prompt_t)(IN void *const global_data, IN void *const user_data, IN const pkcs11h_token_id_t token, IN const unsigned retry, OUT char *const pin, IN const size_t pin_max)
PIN prompt hook.
Definition: pkcs11h-core.h:310
CK_RV pkcs11h_setProviderPropertyByName(IN const char *const reference, IN const char *const property_str, IN const char *const value_str)
Set PKCS#11 provider property by name.
char serialNumber[sizeof(((CK_TOKEN_INFO *) NULL) ->serialNumber)+1]
Definition: pkcs11h-core.h:330
const char * pkcs11h_getMessage(IN const CK_RV rv)
Get message by return value.
unsigned pkcs11h_getLogLevel(void)
Get current log level.
char model[sizeof(((CK_TOKEN_INFO *) NULL) ->model)+1]
Definition: pkcs11h-core.h:328
char manufacturerID[sizeof(((CK_TOKEN_INFO *) NULL) ->manufacturerID)+1]
Definition: pkcs11h-core.h:326
CK_RV pkcs11h_plugAndPlay(void)
Handle slot rescan.
char display[1024]
Definition: pkcs11h-core.h:324
CK_RV pkcs11h_addProvider(IN const char *const reference, IN const char *const provider_location, IN const PKCS11H_BOOL allow_protected_auth, IN const unsigned mask_private_mode, IN const unsigned slot_event_method, IN const unsigned slot_poll_interval, IN const PKCS11H_BOOL cert_is_private)
Register, configure and initialize a PKCS#11 provider.
CK_RV pkcs11h_setMaxLoginRetries(IN const unsigned max_retries)
Set global login retries attempts.
Token identifier.
Definition: pkcs11h-core.h:322
void(* pkcs11h_hook_log_t)(IN void *const global_data, IN const unsigned flags, IN const char *const format, IN va_list args)
Log hook.
Definition: pkcs11h-core.h:270
CK_RV pkcs11h_forkFixup(void)
Handle special case of POSIX fork()
void(* pkcs11h_hook_slotevent_t)(IN void *const global_data)
Slotevent hook.
Definition: pkcs11h-core.h:281
unsigned int pkcs11h_getFeatures(void)
Get features of library.
CK_RV pkcs11h_setTokenPromptHook(IN const pkcs11h_hook_token_prompt_t hook, IN void *const global_data)
Set a token prompt callback.
CK_RV pkcs11h_setPINCachePeriod(IN const int pin_cache_period)
Set global PIN cache timeout.
CK_RV pkcs11h_setPINPromptHook(IN const pkcs11h_hook_pin_prompt_t hook, IN void *const global_data)
Set a pin prompt callback.
pkcs11-helper core.
CK_RV pkcs11h_initialize(void)
Inititalize helper interface.
CK_RV pkcs11h_terminate(void)
Terminate helper interface.
CK_RV pkcs11h_setProtectedAuthentication(IN const PKCS11H_BOOL allow_protected_auth)
Set global protected authentication mode.
CK_RV pkcs11h_setSlotEventHook(IN const pkcs11h_hook_slotevent_t hook, IN void *const global_data)
Set a slot event callback.
CK_RV pkcs11h_removeProvider(IN const char *const reference)
Delete a PKCS#11 provider.
CK_RV pkcs11h_setForkMode(IN const PKCS11H_BOOL safe)
How does the foked process bahaves after POSIX fork()
CK_RV pkcs11h_setLogHook(IN const pkcs11h_hook_log_t hook, IN void *const global_data)
Set a log callback.
unsigned int pkcs11h_getVersion(void)
Get version of library.
PKCS11H_BOOL(* pkcs11h_hook_token_prompt_t)(IN void *const global_data, IN void *const user_data, IN const pkcs11h_token_id_t token, IN const unsigned retry)
Token prompt hook.
Definition: pkcs11h-core.h:293
CK_RV pkcs11h_initializeProvider(IN const char *const reference)
Initialize a PKCS#11 provider.
void pkcs11h_setLogLevel(IN const unsigned flags)
Set current log level of the helper.
pkcs11-helper engines definitions.
struct pkcs11h_token_id_s * pkcs11h_token_id_t
Token identifier.
Definition: pkcs11h-core.h:261
CK_RV pkcs11h_setProviderProperty(IN const char *const reference, IN const unsigned property, IN const void *value, IN const size_t value_size)
Set PKCS#11 provider property.
pkcs11-helper core definitions.
char label[sizeof(((CK_TOKEN_INFO *) NULL) ->label)+1]
Definition: pkcs11h-core.h:332

pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com>OpenSC-Project.org Logo