1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _METAGLOBAL_H 27 #define _METAGLOBAL_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 /* 32 * This file contains all the data structures used for the meta slot 33 */ 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <pthread.h> 40 #include <synch.h> 41 #include <unistd.h> 42 #include <security/cryptoki.h> 43 #include <stdio.h> 44 #include <cryptoutil.h> 45 #include <pkcs11Session.h> 46 #include <pkcs11Slot.h> 47 48 /* 49 * In "generic_attr_t", attributes that are not CK_BBOOL and 50 * CK_ULONG, the data will be stored in generic_data. 51 * Currently, 16 bytes will be pre-allocated for this. 52 * This is just a _WILD_ guess. If actual 53 * experience shows that 16 bytes is too small for most of the 54 * data that will be stored here, and cause this 55 * memory to be reallocated all the time, this should be increased. 56 */ 57 #define INITIAL_ATTR_LEN 16 58 59 /* We provide one slot, with the following arbitrary identifier. */ 60 #define METASLOT_SLOTID 42 61 62 /* Metaslot is always the first slot in the framdwork, with slotID=0 */ 63 #define METASLOT_FRAMEWORK_ID 0 64 65 /* 66 * These are the 2 acceptable string values for ${METASLOT_ENABLE} and 67 * ${METASLOT_AUTO_KEY_MIGRATE} environment variable 68 */ 69 #define TRUE_STRING "true" 70 #define FALSE_STRING "false" 71 72 /* Magic values for different data structures */ 73 #define METASLOT_SESSION_MAGIC 0xECF00004 74 #define METASLOT_SESSION_BADMAGIC 0xBAD00004 75 #define METASLOT_OBJECT_MAGIC 0xECF0B004 76 #define METASLOT_OBJECT_BADMAGIC 0xBAD0B004 77 #define METASLOT_OPSTATE_MAGIC 0xECF09004 78 #define METASLOT_OPSTATE_BADMAGIC 0xBAD09004 79 80 #define IS_READ_ONLY_SESSION(session_flag) \ 81 (!(session_flag & CKF_RW_SESSION)) 82 83 /* 84 * Operation types passed to meta_init_operation() / meta_do_operation() 85 * Operation modes passed to meta_do_operation() 86 * 87 * OP_* and MODE_* must be disjoint (treat as a bitmask), see meta_do_operation 88 * 89 * MODE_UPDATE_WITHKEY is only used for C_DigestKey. 90 */ 91 #define OP_UNUSED 0x0000 92 #define OP_ENCRYPT 0x0001 93 #define OP_DECRYPT 0x0002 94 #define OP_DIGEST 0x0004 95 #define OP_SIGN 0x0008 96 #define OP_VERIFY 0x0010 97 #define OP_SIGNRECOVER 0x0020 98 #define OP_VERIFYRECOVER 0x0040 99 #define MODE_SINGLE 0x0100 100 #define MODE_UPDATE 0x0200 101 #define MODE_UPDATE_WITHKEY 0x0400 102 #define MODE_FINAL 0x1000 103 104 105 /* CK_INFO: Information about cryptoki */ 106 #define METASLOT_CRYPTOKI_VERSION_MAJOR 2 107 #define METASLOT_CRYPTOKI_VERSION_MINOR 11 108 #define METASLOT_MANUFACTURER_ID "Sun Microsystems, Inc. " 109 #define METASLOT_LIBRARY_DESCRIPTION "Sun Metaslot " 110 #define METASLOT_LIBRARY_VERSION_MAJOR 1 111 #define METASLOT_LIBRARY_VERSION_MINOR 1 112 113 /* CK_SLOT_INFO */ 114 #define METASLOT_SLOT_DESCRIPTION "Sun Metaslot " \ 115 " " 116 #define METASLOT_HARDWARE_VERSION_MAJOR 0 117 #define METASLOT_HARDWARE_VERSION_MINOR 0 118 #define METASLOT_FIRMWARE_VERSION_MAJOR 0 119 #define METASLOT_FIRMWARE_VERSION_MINOR 0 120 121 /* CK_TOKEN_INFO: More information about token */ 122 #define METASLOT_TOKEN_LABEL "Sun Metaslot " 123 #define METASLOT_TOKEN_MODEL "1.0 " 124 #define RANDOM_DEVICE "/dev/urandom" 125 126 /* 127 * Maximum number of objects and sessions to queue up before actually 128 * freeing them using the free() system. This is necessary to workaround 129 * a problem in which applications re-uses handles that are no longer valid 130 */ 131 #define MAX_OBJ_TO_BE_FREED 300 132 #define MAX_SESSION_TO_BE_FREED 300 133 134 /* 135 * The following 2 functions deals with inserting and deleting 136 * from double linked lists. It can work with any data structure 137 * that have "prev" and "next" defined. 138 */ 139 140 /* This always inserts into the head of the list */ 141 #define INSERT_INTO_LIST(list, item) \ 142 { \ 143 if ((list) == NULL) { \ 144 (item)->prev = NULL; \ 145 (item)->next = NULL; \ 146 (list) = (item); \ 147 } else { \ 148 (item)->next = (list); \ 149 (item)->prev = NULL; \ 150 (list)->prev = (item); \ 151 (list) = (item); \ 152 } \ 153 } 154 155 156 /* 157 * Remove item from list 158 */ 159 #define REMOVE_FROM_LIST(list, item) \ 160 { \ 161 if ((list) == item) { \ 162 if ((item)->next == NULL) { \ 163 (list) = NULL; \ 164 } else { \ 165 (item)->next->prev = NULL; \ 166 (list) = (item)->next; \ 167 } \ 168 } else { \ 169 if ((item)->next) { \ 170 (item)->next->prev = item->prev; \ 171 (item)->prev->next = (item)->next; \ 172 } else { \ 173 (item)->prev->next = NULL; \ 174 } \ 175 } \ 176 } 177 178 /* 179 * OBJRELEASE 180 * 181 * Signal that a metaobject is no longer in use (but is still valid). 182 */ 183 #define OBJRELEASE(object) \ 184 if (object != NULL) { \ 185 (void) pthread_rwlock_unlock(&object->object_lock); \ 186 } 187 188 /* 189 * REFRELEASE 190 * 191 * Signal that a metasession is no longer in use (but is still valid). 192 * 193 */ 194 #define REFRELEASE(session) \ 195 if (session != NULL) { \ 196 (void) pthread_rwlock_unlock(&session->session_lock); \ 197 } 198 199 /* FreeObject/FreeToken Enumeration */ 200 typedef enum { 201 FREE_UNCHECKED = 0, /* Has not been checked */ 202 FREE_DISABLED = 1, /* No supported provider or key type */ 203 FREE_ALLOWED_KEY = 2, /* Supported key type */ 204 FREE_ENABLED = 3 /* FreeObject/Token enabled */ 205 } freeobject_state_t; 206 207 208 /* Generic attribute type, for storing and managing PKCS#11 attributes. */ 209 typedef struct _attr { 210 CK_ATTRIBUTE attribute; 211 212 boolean_t isMalloced; 213 214 /* attr is necessary for creating a clone of the object */ 215 boolean_t isCloneAttr; 216 217 /* 218 * depends on the PKCS#11 implementation, this attr might or might 219 * not have a value. It's OK for it to not have a value 220 * (ie: the default value is empty) 221 */ 222 boolean_t canBeEmptyValue; 223 224 boolean_t hasValueForClone; 225 226 CK_BBOOL generic_bbool; 227 CK_ULONG generic_ulong; 228 CK_BYTE generic_data[INITIAL_ATTR_LEN]; 229 } generic_attr_t; 230 231 /* 232 * These need to be defined here before the actual structures are defined 233 * because they are used in some of the structure definitions. 234 */ 235 typedef struct slotobject slot_object_t; 236 typedef struct metasession meta_session_t; 237 typedef struct metaobject meta_object_t; 238 typedef struct metaopstate meta_opstate_t; 239 240 /* 241 * slot_session_t 242 * 243 * Wrapper for a session on a provider. This structure is only used internally 244 * in metaslot; it is never revealed to applications. 245 */ 246 typedef struct slotsession { 247 CK_ULONG slotnum; 248 CK_SLOT_ID fw_st_id; /* used for accessing framework's slottable */ 249 CK_SESSION_HANDLE hSession; 250 251 boolean_t is_dualop_capable; 252 CK_FLAGS session_flags; /* what type of session */ 253 254 struct slotsession *next; 255 struct slotsession *prev; 256 257 pthread_rwlock_t object_list_lock; 258 slot_object_t *object_list_head; 259 } slot_session_t; 260 261 262 /* 263 * slot_object_t 264 * 265 * Wrapper for an object on a provider. This structure is only used internally 266 * in metaslot; it is never revealed to applications. 267 */ 268 struct slotobject { 269 CK_OBJECT_HANDLE hObject; 270 271 struct slotobject *next; 272 struct slotobject *prev; 273 274 slot_session_t *creator_session; 275 276 boolean_t isToken; 277 }; 278 279 280 /* 281 * mechinfo_t 282 * 283 * A mechinfo_t is created for each mechanism on a slot. 284 * 285 * This information is used for selecting which slots support the given 286 * mechanism for a crypto operation. 287 * 288 */ 289 typedef struct mechinfo { 290 CK_ULONG slotnum; 291 292 boolean_t initialized; 293 boolean_t supported; 294 CK_MECHANISM_INFO mechanism_info; 295 } mechinfo_t; 296 297 298 /* 299 * operation_info_t 300 * 301 * Part of a meta_session_t, used to track active operations. 302 */ 303 typedef struct opinfo { 304 int type; 305 slot_session_t *session; 306 mechinfo_t *stats; 307 } operation_info_t; 308 309 typedef struct find_objs_info { 310 boolean_t op_active; /* Indicate whether FindObjects is active */ 311 meta_object_t **matched_objs; 312 int num_matched_objs; 313 int next_result_index; /* index of next object to be returned */ 314 } find_objs_info_t; 315 316 typedef struct mech_support_info { 317 CK_MECHANISM_TYPE mech; 318 /* Array of mechinfo_t allocated based on number of slots */ 319 mechinfo_t **supporting_slots; 320 unsigned long num_supporting_slots; 321 } mech_support_info_t; 322 323 /* 324 * meta_session_t 325 * 326 * The internal state for a meta-session is kept here. The session handles 327 * given to applications are always pointers to a structure of this type. 328 * 329 */ 330 struct metasession { 331 ulong_t magic_marker; 332 pthread_rwlock_t session_lock; 333 334 pthread_mutex_t isClosingSession_lock; 335 boolean_t isClosingSession; 336 337 struct metasession *next; 338 struct metasession *prev; 339 340 CK_FLAGS session_flags; 341 342 /* 343 * Could have just declared this as "op", but declaring it as 344 * op1 so that "op2" can be easily added when dual-op support 345 * is implemented in the future 346 */ 347 operation_info_t op1; 348 349 /* 350 * This is for keeping track of which slots support a particular 351 * mechanism. This information doesn't 352 * have to be kept on a per session bases, but having the 353 * memory pre-allocated per session would make things much simpiler, 354 * because memory doesn't need to be allocated/deallocated everytime 355 * we do an operation. 356 */ 357 mech_support_info_t mech_support_info; 358 359 360 /* Session objects created by this session. */ 361 pthread_rwlock_t object_list_lock; 362 meta_object_t *object_list_head; 363 364 /* C_FindObjects support. */ 365 find_objs_info_t find_objs_info; 366 }; 367 368 369 /* 370 * meta_object_t 371 * 372 * The internal state for a meta-object is kept here. The object handles 373 * given to applications are always pointers to a structure of this type. 374 */ 375 struct metaobject { 376 ulong_t magic_marker; 377 pthread_rwlock_t object_lock; 378 379 pthread_mutex_t isClosingObject_lock; 380 boolean_t isClosingObject; 381 382 struct metaobject *next; 383 struct metaobject *prev; 384 385 meta_session_t *creator_session; /* Only set for session objects */ 386 387 boolean_t isToken; /* alias for CKA_TOKEN */ 388 boolean_t isPrivate; /* alias for CKA_PRIVATE */ 389 boolean_t isSensitive; /* alias for CKA_SENSITIVE */ 390 boolean_t isExtractable; /* alias for CKA_EXTRACTABLE */ 391 392 freeobject_state_t isFreeToken; 393 freeobject_state_t isFreeObject; 394 395 CK_ULONG master_clone_slotnum; /* set when object is created */ 396 slot_object_t **clones; 397 /* indicate if tried to create clone object in a slot */ 398 boolean_t *tried_create_clone; 399 400 pthread_rwlock_t attribute_lock; 401 size_t num_attributes; 402 generic_attr_t *attributes; 403 404 pthread_mutex_t clone_create_lock; 405 size_t clone_template_size; /* 0 if not yet known. */ 406 CK_ATTRIBUTE *clone_template; /* NULL if not yet known. */ 407 }; 408 409 410 /* 411 * struct metaopstate 412 * 413 * Used as the format for the operation state returned via 414 * C_GetOperationState. 415 */ 416 typedef struct opstate_data { 417 int op_type; 418 CK_ULONG op_slotnum; 419 CK_ULONG op_state_len; 420 } opstate_data_t; 421 422 struct metaopstate { 423 ulong_t magic_marker; 424 /* 425 * Could have just declared this as "state", but declaring it like this 426 * so that when dual-op support is implemented in the future, the 427 * changes will be simplier. 428 */ 429 struct opstate_data state[1]; 430 }; 431 432 433 /* 434 * session_pool_t 435 * 436 * Used to cache open sessions in a slot. 437 */ 438 typedef struct sessionpool { 439 pthread_mutex_t list_lock; 440 441 /* list of sessions that's currently in use */ 442 slot_session_t *active_list_head; 443 444 /* 445 * list of sessions that are not in use, but can't be deleted because 446 * either session/token objects are created using these sessions 447 * or we need to have one session left with the provider to maintain 448 * the logged in state. Any of these sessions could be re-used if 449 * a session is needed to be established with a provider. 450 */ 451 slot_session_t *persist_list_head; 452 453 /* 454 * List of sessions that are not in use at the moment. We keep 455 * a list of sessions with a particular provider instead of 456 * creating a new session everytime for efficiency 457 */ 458 slot_session_t *idle_list_head; 459 boolean_t keep_one_alive; 460 int num_idle_sessions; /* number of sessions in "idle_list_head" */ 461 } session_pool_t; 462 463 464 /* 465 * slot_data_t 466 * 467 * Each slot has a session pool, a collection of persistant sessions to 468 * allow for more efficient operation. Specifically, to allow reuse of 469 * previously session objects (which need the creating session to stick 470 * around), as well as being frugal with creating/closing sessions. 471 */ 472 typedef struct slotdata { 473 CK_SLOT_ID fw_st_id; /* framework slot table ID */ 474 475 session_pool_t session_pool; 476 477 pthread_rwlock_t tokenobject_list_lock; 478 slot_object_t *tokenobject_list_head; 479 } slot_data_t; 480 481 482 typedef enum { 483 ALL_TOKEN = 0, 484 PUBLIC_TOKEN = 1, 485 PRIVATE_TOKEN = 2 486 } token_obj_type_t; 487 488 /* 489 * metaslot_config_t 490 * 491 * This holds the configuration information for meta slot. 492 * It will first be filled with values that users defined 493 * in environment variables. Any value not defined by the user 494 * will be filled with values from the system wide configuration file. 495 */ 496 typedef struct _metaslot_config { 497 /* token to be used as the keystore for metaslot */ 498 boolean_t keystore_token_specified; 499 CK_UTF8CHAR keystore_token[TOKEN_LABEL_SIZE + 1]; 500 501 /* slot to be used as the keystore for metaslot */ 502 boolean_t keystore_slot_specified; 503 CK_UTF8CHAR keystore_slot[SLOT_DESCRIPTION_SIZE + 1]; 504 505 /* should meta slot be enabled or not */ 506 boolean_t enabled_specified; 507 boolean_t enabled; 508 509 /* should auto migration of sensitive token objects be enabled or not */ 510 boolean_t auto_key_migrate_specified; 511 boolean_t auto_key_migrate; 512 } metaslot_config_t; 513 514 /* 515 * The following 2 structures are used to link the to-be-freed 516 * meta sessions and meta objects into linked lists. 517 * The items on these linked list have not yet been freed via free(); instead 518 * they are added to this list. The actual free will take place when 519 * the number of objects queued reaches MAX_OBJ_TO_BE_FREED or 520 * MAX_SESSION_TO_BE_FREED, at which time the first object in the 521 * list will be freed. 522 */ 523 typedef struct obj_to_be_freed_list { 524 meta_object_t *first; /* points to first obj in the list */ 525 meta_object_t *last; /* points to last obj in the list */ 526 uint32_t count; /* current total objs in the list */ 527 pthread_mutex_t obj_to_be_free_mutex; 528 } object_to_be_freed_list_t; 529 530 typedef struct ses_to_be_freed_list { 531 meta_session_t *first; /* points to first session in the list */ 532 meta_session_t *last; /* points to last session in the list */ 533 uint32_t count; /* current total session in the list */ 534 pthread_mutex_t ses_to_be_free_mutex; 535 } ses_to_be_freed_list_t; 536 537 /* Global variables */ 538 extern metaslot_config_t metaslot_config; 539 extern boolean_t metaslot_enabled; 540 extern CK_SLOT_ID metaslot_keystore_slotid; 541 extern boolean_t metaslot_auto_key_migrate; 542 extern struct CK_FUNCTION_LIST metaslot_functionList; 543 extern int meta_urandom_seed_fd; 544 extern pthread_mutex_t initmutex; 545 546 extern ses_to_be_freed_list_t ses_delay_freed; 547 extern object_to_be_freed_list_t obj_delay_freed; 548 549 extern CK_BBOOL falsevalue; 550 extern CK_BBOOL truevalue; 551 552 /* --- Prototypes --- */ 553 554 CK_RV meta_slotManager_initialize(); 555 void meta_slotManager_finalize(); 556 void meta_slotManager_find_object_token(); 557 CK_RV meta_get_slot_session(CK_ULONG slotnum, slot_session_t **session, 558 CK_FLAGS flags); 559 void meta_release_slot_session(slot_session_t *session); 560 561 CK_RV meta_mechManager_initialize(); 562 void meta_mechManager_finalize(); 563 CK_RV meta_mechManager_get_mechs(CK_MECHANISM_TYPE *list, CK_ULONG *listsize); 564 CK_RV meta_mechManager_get_slots(mech_support_info_t *mech_support_info, 565 boolean_t force_update); 566 CK_RV meta_mechManager_slot_supports_mech(CK_MECHANISM_TYPE mechanism, 567 CK_ULONG slotnum, boolean_t *supports, mechinfo_t **slot_info, 568 boolean_t force_update); 569 570 CK_RV meta_operation_init(int optype, meta_session_t *session, 571 CK_MECHANISM *pMechanism, meta_object_t *key); 572 CK_RV meta_do_operation(int optype, int mode, 573 meta_session_t *session, meta_object_t *object, 574 CK_BYTE *in, CK_ULONG inLen, CK_BYTE *out, CK_ULONG *outLen); 575 576 void meta_operation_cleanup(meta_session_t *session, int optype, 577 boolean_t finished_normally); 578 579 CK_RV meta_generate_keys(meta_session_t *session, CK_MECHANISM *pMechanism, 580 CK_ATTRIBUTE *k1Template, CK_ULONG k1AttrCount, meta_object_t *key1, 581 CK_ATTRIBUTE *k2Template, CK_ULONG k2AttrCount, meta_object_t *key2); 582 583 CK_RV meta_wrap_key(meta_session_t *session, 584 CK_MECHANISM *pMechanism, meta_object_t *wrappingkey, 585 meta_object_t *inputkey, 586 CK_BYTE *wrapped_key, CK_ULONG *wrapped_key_len); 587 588 CK_RV meta_unwrap_key(meta_session_t *session, 589 CK_MECHANISM *pMechanism, meta_object_t *unwrapping_key, 590 CK_BYTE *wrapped_key, CK_ULONG wrapped_key_len, 591 CK_ATTRIBUTE *template, CK_ULONG template_size, 592 meta_object_t *unwrapped_key); 593 594 CK_RV meta_derive_key(meta_session_t *session, CK_MECHANISM *pMech, 595 meta_object_t *basekey1, meta_object_t *basekey2, 596 CK_OBJECT_HANDLE *phBaseKey2, 597 CK_ATTRIBUTE *pTemplate, CK_ULONG ulAttributeCount, 598 meta_object_t *newKey1, meta_object_t *newKey2, 599 meta_object_t *newKey3, meta_object_t *newKey4); 600 601 void get_user_metaslot_config(); 602 603 CK_RV meta_sessionManager_initialize(); 604 void meta_sessionManager_finalize(); 605 CK_RV meta_handle2session(CK_SESSION_HANDLE hSession, 606 meta_session_t **session_p); 607 CK_RV meta_session_alloc(meta_session_t **newSession); 608 CK_RV meta_session_activate(meta_session_t *session); 609 CK_RV meta_session_deactivate(meta_session_t *session, 610 boolean_t have_sessionlist_lock); 611 void meta_session_dealloc(meta_session_t *session); 612 void meta_session_delay_free(meta_session_t *sp); 613 614 CK_RV meta_objectManager_initialize(); 615 void meta_objectManager_finalize(); 616 CK_RV meta_handle2object(CK_OBJECT_HANDLE hObject, meta_object_t **object); 617 CK_RV meta_object_alloc(meta_session_t *session, meta_object_t **object); 618 CK_RV meta_object_get_attr(slot_session_t *slot_session, 619 CK_OBJECT_HANDLE hObject, meta_object_t *object); 620 void meta_object_activate(meta_object_t *object); 621 CK_RV meta_object_deactivate(meta_object_t *object, boolean_t have_list_lock, 622 boolean_t have_object_lock); 623 CK_RV meta_object_dealloc(meta_object_t *object, boolean_t nukeSourceObj); 624 CK_RV meta_slot_object_alloc(slot_object_t **object); 625 void meta_slot_object_activate(slot_object_t *object, slot_session_t *session, 626 boolean_t isToken); 627 void meta_slot_object_deactivate(slot_object_t *object); 628 void meta_slot_object_dealloc(slot_object_t *object); 629 CK_RV meta_object_copyin(meta_object_t *object); 630 CK_RV meta_object_get_clone(meta_object_t *object, 631 CK_ULONG slot_num, slot_session_t *slot_session, 632 slot_object_t **clone); 633 meta_object_t *meta_object_find_by_handle(CK_OBJECT_HANDLE hObject, 634 CK_ULONG slotnum, boolean_t token_only); 635 CK_RV meta_token_object_deactivate(token_obj_type_t token_type); 636 void meta_object_delay_free(meta_object_t *objp); 637 boolean_t meta_freeobject_set(meta_object_t *object, CK_ATTRIBUTE *tmpl, 638 CK_ULONG tmpl_len, boolean_t create); 639 CK_RV meta_freetoken_set(CK_ULONG slot_num, CK_BBOOL *current_value, 640 CK_ATTRIBUTE *tmpl, CK_ULONG tmpl_len); 641 boolean_t meta_freeobject_check(meta_session_t *session, meta_object_t *obj, 642 CK_MECHANISM *pMech, CK_ATTRIBUTE *tmpl, CK_ULONG tmpl_len, 643 CK_KEY_TYPE keytype); 644 boolean_t meta_freeobject_clone(meta_session_t *session, meta_object_t *object); 645 646 CK_RV get_master_attributes_by_object(slot_session_t *session, 647 slot_object_t *slot_object, generic_attr_t **attributes, 648 size_t *num_attributes); 649 CK_RV get_master_attributes_by_template( 650 CK_ATTRIBUTE *template, CK_ULONG template_size, 651 generic_attr_t **attributes, size_t *num_attributes); 652 CK_RV get_master_template_by_type(CK_OBJECT_CLASS class, CK_ULONG subtype, 653 generic_attr_t **attributes, size_t *num_attributes); 654 CK_RV get_master_attributes_by_type(CK_OBJECT_CLASS class, CK_ULONG subtype, 655 generic_attr_t **attributes, size_t *num_attributes); 656 CK_RV get_master_attributes_by_duplication( 657 generic_attr_t *src_attrs, size_t num_src_attrs, 658 generic_attr_t **dst_attrs, size_t *num_dst_attrs); 659 void dealloc_attributes(generic_attr_t *attributes, size_t num_attributes); 660 CK_RV attribute_set_value(CK_ATTRIBUTE *new_attr, 661 generic_attr_t *attributes, size_t num_attributes); 662 boolean_t get_template_ulong(CK_ATTRIBUTE_TYPE type, CK_ATTRIBUTE *attributes, 663 CK_ULONG num_attributes, CK_ULONG *result); 664 boolean_t get_template_boolean(CK_ATTRIBUTE_TYPE type, 665 CK_ATTRIBUTE *attributes, CK_ULONG num_attributes, boolean_t *result); 666 int set_template_boolean(CK_ATTRIBUTE_TYPE type, 667 CK_ATTRIBUTE *attributes, CK_ULONG num_attributes, boolean_t local, 668 CK_BBOOL *value); 669 CK_ULONG get_keystore_slotnum(void); 670 CK_SLOT_ID meta_slotManager_get_framework_table_id(CK_ULONG slotnum); 671 CK_ULONG meta_slotManager_get_slotcount(void); 672 boolean_t meta_slotManager_token_write_protected(void); 673 boolean_t metaslot_logged_in(); 674 void metaslot_set_logged_in_flag(boolean_t value); 675 676 int looping_read(int, void *, int); 677 int looping_write(int, void *, int); 678 679 /* 680 * Prototypes for the various meta_Foo implementations of C_Foo. 681 * 682 */ 683 CK_RV meta_GetFunctionList(CK_FUNCTION_LIST_PTR_PTR ppFunctionList); 684 CK_RV meta_Initialize(CK_VOID_PTR pInitArgs); 685 CK_RV meta_Finalize(CK_VOID_PTR pReserved); 686 CK_RV meta_GetInfo(CK_INFO_PTR pInfo); 687 CK_RV meta_GetSlotList(CK_BBOOL tokenPresent, CK_SLOT_ID_PTR pSlotList, 688 CK_ULONG_PTR pulCount); 689 CK_RV meta_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pInfo); 690 CK_RV meta_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo); 691 CK_RV meta_GetMechanismList(CK_SLOT_ID slotID, 692 CK_MECHANISM_TYPE_PTR pMechanismList, CK_ULONG_PTR pulCount); 693 CK_RV meta_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type, 694 CK_MECHANISM_INFO_PTR pInfo); 695 CK_RV meta_InitToken(CK_SLOT_ID slotID, CK_UTF8CHAR_PTR pPin, 696 CK_ULONG ulPinLen, CK_UTF8CHAR_PTR pLabel); 697 CK_RV meta_InitPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pPin, 698 CK_ULONG ulPinLen); 699 CK_RV meta_SetPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pOldPin, 700 CK_ULONG ulOldPinLen, CK_UTF8CHAR_PTR pNewPin, CK_ULONG ulNewPinLen); 701 CK_RV meta_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags, 702 CK_VOID_PTR pApplication, CK_NOTIFY Notify, 703 CK_SESSION_HANDLE_PTR phSession); 704 CK_RV meta_CloseSession(CK_SESSION_HANDLE hSession); 705 CK_RV meta_CloseAllSessions(CK_SLOT_ID slotID); 706 CK_RV meta_GetSessionInfo(CK_SESSION_HANDLE hSession, 707 CK_SESSION_INFO_PTR pInfo); 708 CK_RV meta_GetOperationState(CK_SESSION_HANDLE hSession, 709 CK_BYTE_PTR pOperationState, CK_ULONG_PTR pulOperationStateLen); 710 CK_RV meta_SetOperationState(CK_SESSION_HANDLE hSession, 711 CK_BYTE_PTR pOperationState, CK_ULONG ulOperationStateLen, 712 CK_OBJECT_HANDLE hEncryptionKey, CK_OBJECT_HANDLE hAuthenticationKey); 713 CK_RV meta_Login(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType, 714 CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen); 715 CK_RV meta_Logout(CK_SESSION_HANDLE hSession); 716 CK_RV meta_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate, 717 CK_ULONG ulCount, CK_OBJECT_HANDLE_PTR phObject); 718 CK_RV meta_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, 719 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, 720 CK_OBJECT_HANDLE_PTR phNewObject); 721 CK_RV meta_DestroyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject); 722 CK_RV meta_GetObjectSize(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, 723 CK_ULONG_PTR pulSize); 724 CK_RV meta_GetAttributeValue(CK_SESSION_HANDLE hSession, 725 CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount); 726 CK_RV meta_SetAttributeValue(CK_SESSION_HANDLE hSession, 727 CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount); 728 CK_RV meta_FindObjectsInit(CK_SESSION_HANDLE hSession, 729 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount); 730 CK_RV meta_FindObjects(CK_SESSION_HANDLE hSession, 731 CK_OBJECT_HANDLE_PTR phObject, CK_ULONG ulMaxObjectCount, 732 CK_ULONG_PTR pulObjectCount); 733 CK_RV meta_FindObjectsFinal(CK_SESSION_HANDLE hSession); 734 CK_RV meta_EncryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 735 CK_OBJECT_HANDLE hKey); 736 CK_RV meta_Encrypt(CK_SESSION_HANDLE hSession, 737 CK_BYTE_PTR pData, CK_ULONG ulDataLen, 738 CK_BYTE_PTR pEncryptedData, CK_ULONG_PTR pulEncryptedDataLen); 739 CK_RV meta_EncryptUpdate(CK_SESSION_HANDLE hSession, 740 CK_BYTE_PTR pPart, CK_ULONG ulPartLen, 741 CK_BYTE_PTR pEncryptedPart, CK_ULONG_PTR pulEncryptedPartLen); 742 CK_RV meta_EncryptFinal(CK_SESSION_HANDLE hSession, 743 CK_BYTE_PTR pLastEncryptedPart, CK_ULONG_PTR pulLastEncryptedPartLen); 744 CK_RV meta_DecryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 745 CK_OBJECT_HANDLE hKey); 746 CK_RV meta_Decrypt(CK_SESSION_HANDLE hSession, 747 CK_BYTE_PTR pEncryptedData, CK_ULONG ulEncryptedDataLen, 748 CK_BYTE_PTR pData, CK_ULONG_PTR pulDataLen); 749 CK_RV meta_DecryptUpdate(CK_SESSION_HANDLE hSession, 750 CK_BYTE_PTR pEncryptedPart, CK_ULONG ulEncryptedPartLen, 751 CK_BYTE_PTR pPart, CK_ULONG_PTR pulPartLen); 752 CK_RV meta_DecryptFinal(CK_SESSION_HANDLE hSession, 753 CK_BYTE_PTR pLastPart, CK_ULONG_PTR pulLastPartLen); 754 CK_RV meta_DigestInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism); 755 CK_RV meta_Digest(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, 756 CK_ULONG ulDataLen, CK_BYTE_PTR pDigest, CK_ULONG_PTR pulDigestLen); 757 CK_RV meta_DigestUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, 758 CK_ULONG ulPartLen); 759 CK_RV meta_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey); 760 CK_RV meta_DigestFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pDigest, 761 CK_ULONG_PTR pulDigestLen); 762 CK_RV meta_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 763 CK_OBJECT_HANDLE hKey); 764 CK_RV meta_Sign(CK_SESSION_HANDLE hSession, 765 CK_BYTE_PTR pData, CK_ULONG ulDataLen, 766 CK_BYTE_PTR pSignature, CK_ULONG_PTR pulSignatureLen); 767 CK_RV meta_SignUpdate(CK_SESSION_HANDLE hSession, 768 CK_BYTE_PTR pPart, CK_ULONG ulPartLen); 769 CK_RV meta_SignFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, 770 CK_ULONG_PTR pulSignatureLen); 771 CK_RV meta_SignRecoverInit(CK_SESSION_HANDLE hSession, 772 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey); 773 CK_RV meta_SignRecover(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, 774 CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, CK_ULONG_PTR pulSignatureLen); 775 CK_RV meta_VerifyInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 776 CK_OBJECT_HANDLE hKey); 777 CK_RV meta_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, 778 CK_ULONG ulDataLen, CK_BYTE_PTR pSignature, CK_ULONG ulSignatureLen); 779 CK_RV meta_VerifyUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, 780 CK_ULONG ulPartLen); 781 CK_RV meta_VerifyFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, 782 CK_ULONG ulSignatureLen); 783 CK_RV meta_VerifyRecoverInit(CK_SESSION_HANDLE hSession, 784 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey); 785 CK_RV meta_VerifyRecover(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSignature, 786 CK_ULONG ulSignatureLen, CK_BYTE_PTR pData, CK_ULONG_PTR pulDataLen); 787 CK_RV meta_DigestEncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, 788 CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart, 789 CK_ULONG_PTR pulEncryptedPartLen); 790 CK_RV meta_DecryptDigestUpdate(CK_SESSION_HANDLE hSession, 791 CK_BYTE_PTR pEncryptedPart, CK_ULONG ulEncryptedPartLen, 792 CK_BYTE_PTR pPart, CK_ULONG_PTR pulPartLen); 793 CK_RV meta_SignEncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, 794 CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart, 795 CK_ULONG_PTR pulEncryptedPartLen); 796 CK_RV meta_DecryptVerifyUpdate(CK_SESSION_HANDLE hSession, 797 CK_BYTE_PTR pEncryptedPart, CK_ULONG ulEncryptedPartLen, 798 CK_BYTE_PTR pPart, CK_ULONG_PTR pulPartLen); 799 CK_RV meta_GenerateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 800 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, CK_OBJECT_HANDLE_PTR phKey); 801 CK_RV meta_GenerateKeyPair(CK_SESSION_HANDLE hSession, 802 CK_MECHANISM_PTR pMechanism, CK_ATTRIBUTE_PTR pPublicKeyTemplate, 803 CK_ULONG ulPublicKeyAttributeCount, CK_ATTRIBUTE_PTR pPrivateKeyTemplate, 804 CK_ULONG ulPrivateKeyAttributeCount, CK_OBJECT_HANDLE_PTR phPublicKey, 805 CK_OBJECT_HANDLE_PTR phPrivateKey); 806 CK_RV meta_WrapKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 807 CK_OBJECT_HANDLE hWrappingKey, CK_OBJECT_HANDLE hKey, 808 CK_BYTE_PTR pWrappedKey, CK_ULONG_PTR pulWrappedKeyLen); 809 CK_RV meta_UnwrapKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 810 CK_OBJECT_HANDLE hUnwrappingKey, CK_BYTE_PTR pWrappedKey, 811 CK_ULONG ulWrappedKeyLen, CK_ATTRIBUTE_PTR pTemplate, 812 CK_ULONG ulAttributeCount, CK_OBJECT_HANDLE_PTR phKey); 813 CK_RV meta_DeriveKey(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 814 CK_OBJECT_HANDLE hBaseKey, CK_ATTRIBUTE_PTR pTemplate, 815 CK_ULONG ulAttributeCount, CK_OBJECT_HANDLE_PTR phKey); 816 CK_RV meta_SeedRandom(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSeed, 817 CK_ULONG ulSeedLen); 818 CK_RV meta_GenerateRandom(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pRandomData, 819 CK_ULONG ulRandomLen); 820 CK_RV meta_GetFunctionStatus(CK_SESSION_HANDLE hSession); 821 CK_RV meta_CancelFunction(CK_SESSION_HANDLE hSession); 822 CK_RV meta_WaitForSlotEvent(CK_FLAGS flags, CK_SLOT_ID_PTR pSlot, 823 CK_VOID_PTR pReserved); 824 825 #ifdef __cplusplus 826 } 827 #endif 828 829 #endif /* _METAGLOBAL_H */ 830