pkcs11-helper
pkcs11h-core.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005-2011 Alon Bar-Lev <alon.barlev@gmail.com>
3  * All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses. You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, or the BSD license.
8  *
9  * GNU General Public License (GPL) Version 2
10  * ===========================================
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2
13  * as published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program (see the file COPYING.GPL included with this
22  * distribution); if not, write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24  *
25  * BSD License
26  * ============
27  * Redistribution and use in source and binary forms, with or without
28  * modification, are permitted provided that the following conditions are met:
29  *
30  * o Redistributions of source code must retain the above copyright notice,
31  * this list of conditions and the following disclaimer.
32  * o Redistributions in binary form must reproduce the above copyright
33  * notice, this list of conditions and the following disclaimer in the
34  * documentation and/or other materials provided with the distribution.
35  * o Neither the name of the Alon Bar-Lev nor the names of its
36  * contributors may be used to endorse or promote products derived from
37  * this software without specific prior written permission.
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
40  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
42  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
43  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
44  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
45  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
46  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49  * POSSIBILITY OF SUCH DAMAGE.
50  */
51 
67 #ifndef __PKCS11H_BASE_H
68 #define __PKCS11H_BASE_H
69 
70 #include <stdarg.h>
71 #include <time.h>
72 
76 
77 #if defined(__cplusplus)
78 extern "C" {
79 #endif
80 
88 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_OPENSSL (1<< 0)
89 
90 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_GNUTLS (1<< 1)
91 
92 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_WIN32 (1<< 2)
93 
94 #define PKCS11H_FEATURE_MASK_DEBUG (1<< 3)
95 
96 #define PKCS11H_FEATURE_MASK_THREADING (1<< 4)
97 
98 #define PKCS11H_FEATURE_MASK_TOKEN (1<< 5)
99 
100 #define PKCS11H_FEATURE_MASK_DATA (1<< 6)
101 
102 #define PKCS11H_FEATURE_MASK_CERTIFICATE (1<< 7)
103 
104 #define PKCS11H_FEATURE_MASK_SLOTEVENT (1<< 8)
105 
106 #define PKCS11H_FEATURE_MASK_OPENSSL (1<< 9)
107 
117 #define PKCS11H_LOG_DEBUG2 5
118 
119 #define PKCS11H_LOG_DEBUG1 4
120 
121 #define PKCS11H_LOG_INFO 3
122 
123 #define PKCS11H_LOG_WARN 2
124 
125 #define PKCS11H_LOG_ERROR 1
126 
127 #define PKCS11H_LOG_QUIET 0
128 
131 #define PKCS11H_PIN_CACHE_INFINITE -1
132 
139 #define PKCS11H_PRIVATEMODE_MASK_AUTO (0)
140 
141 #define PKCS11H_PRIVATEMODE_MASK_SIGN (1<<0)
142 
143 #define PKCS11H_PRIVATEMODE_MASK_RECOVER (1<<1)
144 
145 #define PKCS11H_PRIVATEMODE_MASK_DECRYPT (1<<2)
146 
147 #define PKCS11H_PRIVATEMODE_MASK_UNWRAP (1<<3)
148 
155 /* Auto select by provider information. */
156 #define PKCS11H_SLOTEVENT_METHOD_AUTO 0
157 
158 #define PKCS11H_SLOTEVENT_METHOD_TRIGGER 1
159 
160 #define PKCS11H_SLOTEVENT_METHOD_POLL 2
161 
162 #define PKCS11H_SLOTEVENT_METHOD_FETCH 3
163 
171 #define PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT (1<<0)
172 
173 #define PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT (1<<1)
174 
175 #define PKCS11H_PROMPT_MASK_ALLOW_ALL ( \
176  PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT | \
177  PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT \
178  )
179 
187 #define PKCS11H_ENUM_METHOD_CACHE 0
188 
189 #define PKCS11H_ENUM_METHOD_CACHE_EXIST 1
190 
191 #define PKCS11H_ENUM_METHOD_RELOAD 2
192 
194 struct pkcs11h_token_id_s;
195 
200 
208 typedef void (*pkcs11h_hook_log_t)(
209  IN void * const global_data,
210  IN const unsigned flags,
211  IN const char * const format,
212  IN va_list args
213 );
214 
219 typedef void (*pkcs11h_hook_slotevent_t)(
220  IN void * const global_data
221 );
222 
231 typedef PKCS11H_BOOL (*pkcs11h_hook_token_prompt_t)(
232  IN void * const global_data,
233  IN void * const user_data,
234  IN const pkcs11h_token_id_t token,
235  IN const unsigned retry
236 );
237 
248 typedef PKCS11H_BOOL (*pkcs11h_hook_pin_prompt_t)(
249  IN void * const global_data,
250  IN void * const user_data,
251  IN const pkcs11h_token_id_t token,
252  IN const unsigned retry,
253  OUT char * const pin,
254  IN const size_t pin_max
255 );
256 
262  char display[1024];
264  char manufacturerID[sizeof (((CK_TOKEN_INFO *)NULL)->manufacturerID)+1];
266  char model[sizeof (((CK_TOKEN_INFO *)NULL)->model)+1];
268  char serialNumber[sizeof (((CK_TOKEN_INFO *)NULL)->serialNumber)+1];
270  char label[sizeof (((CK_TOKEN_INFO *)NULL)->label)+1];
271 };
272 
278 const char *
280  IN const CK_RV rv
281 );
282 
287 unsigned int
288 pkcs11h_getVersion (void);
289 
294 unsigned int
295 pkcs11h_getFeatures (void);
296 
303 CK_RV
304 pkcs11h_initialize (void);
305 
311 CK_RV
312 pkcs11h_terminate (void);
313 
318 void
320  IN const unsigned flags
321 );
322 
327 unsigned
328 pkcs11h_getLogLevel (void);
329 
342 CK_RV
344  IN const PKCS11H_BOOL safe
345 );
346 
353 CK_RV
355  IN const pkcs11h_hook_log_t hook,
356  IN void * const global_data
357 );
358 
370 CK_RV
372  IN const pkcs11h_hook_slotevent_t hook,
373  IN void * const global_data
374 );
375 
384 CK_RV
386  IN const pkcs11h_hook_token_prompt_t hook,
387  IN void * const global_data
388 );
389 
398 CK_RV
400  IN const pkcs11h_hook_pin_prompt_t hook,
401  IN void * const global_data
402 );
403 
410 CK_RV
412  IN const PKCS11H_BOOL allow_protected_auth
413 );
414 
421 CK_RV
423  IN const int pin_cache_period
424 );
425 
432 CK_RV
434  IN const unsigned max_retries
435 );
436 
450 CK_RV
452  IN const char * const reference,
453  IN const char * const provider_location,
454  IN const PKCS11H_BOOL allow_protected_auth,
455  IN const unsigned mask_private_mode,
456  IN const unsigned slot_event_method,
457  IN const unsigned slot_poll_interval,
458  IN const PKCS11H_BOOL cert_is_private
459 );
460 
467 CK_RV
469  IN const char * const reference
470 );
471 
483 CK_RV
484 pkcs11h_forkFixup (void);
485 
497 CK_RV
498 pkcs11h_plugAndPlay (void);
499 
504 CK_RV
505 pkcs11h_logout (void);
506 
507 #ifdef __cplusplus
508 }
509 #endif
510 
513 #endif /* __PKCS11H_BASE_H */
CK_RV pkcs11h_logout(void)
Logout from all sessions.
char serialNumber[sizeof(((CK_TOKEN_INFO *) NULL) ->serialNumber)+1]
Definition: pkcs11h-core.h:268
const char * pkcs11h_getMessage(IN const CK_RV rv)
Get message by return value.
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:231
unsigned pkcs11h_getLogLevel(void)
Get current log level.
char model[sizeof(((CK_TOKEN_INFO *) NULL) ->model)+1]
Definition: pkcs11h-core.h:266
char manufacturerID[sizeof(((CK_TOKEN_INFO *) NULL) ->manufacturerID)+1]
Definition: pkcs11h-core.h:264
CK_RV pkcs11h_plugAndPlay(void)
Handle slot rescan.
char display[1024]
Definition: pkcs11h-core.h:262
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)
Add a PKCS#11 provider.
CK_RV pkcs11h_setMaxLoginRetries(IN const unsigned max_retries)
Set global login retries attempts.
Token identifier.
Definition: pkcs11h-core.h:260
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:248
CK_RV pkcs11h_forkFixup(void)
Handle special case of POSIX fork()
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.
void(* pkcs11h_hook_slotevent_t)(IN void *const global_data)
Slotevent hook.
Definition: pkcs11h-core.h:219
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()
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:208
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.
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:199
pkcs11-helper core definitions.
char label[sizeof(((CK_TOKEN_INFO *) NULL) ->label)+1]
Definition: pkcs11h-core.h:270

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