Mercurial > illumos > illumos-gate
view usr/src/lib/pkcs11/pkcs11_kms/common/kmsSession.h @ 12720:3db6e0082404
PSARC 2010/195 PKCS11 KMS Provider
6944296 Solaris needs a PKCS#11 provider to allow access to KMS keystore functionality
author | Wyllys Ingersoll <Wyllys.Ingersoll@Sun.COM> |
---|---|
date | Mon, 28 Jun 2010 16:04:11 -0700 |
parents | |
children |
line wrap: on
line source
/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. */ #ifndef _KMSSESSION_H #define _KMSSESSION_H #ifdef __cplusplus extern "C" { #endif #include <stdio.h> #include <pthread.h> #include <sys/avl.h> #include <security/pkcs11t.h> #define K_SOLARIS_PLATFORM #include "KMSAgent.h" #define KMSTOKEN_SESSION_MAGIC 0xECF00004 #define CRYPTO_OPERATION_ACTIVE 0x01 #define CRYPTO_OPERATION_UPDATE 0x02 typedef struct { CK_MECHANISM mech; void *context; uint32_t flags; } kms_active_op_t; typedef struct { char *label; avl_node_t nodep; } objlabel_t; #define KMSOFFSETOF(s, m) ((size_t)(&(((s *)0)->m))) /* * Data stored in the KMS profile config file. */ typedef struct { char name[BUFSIZ]; char agentId[BUFSIZ]; char agentAddr[BUFSIZ]; int transTimeout; int failoverLimit; int discoveryFreq; int securityMode; } kms_cfg_info_t; typedef struct session { CK_ULONG magic_marker; /* magic # be validated for integrity */ pthread_mutex_t session_mutex; /* session's mutex lock */ pthread_mutex_t ses_free_mutex; /* mutex used during closing session */ pthread_cond_t ses_free_cond; /* cond variable for signal and wait */ uint32_t ses_refcnt; /* session reference count */ uint32_t ses_close_sync; /* session closing flags */ boolean_t ses_RO; /* RO or RW session flag */ CK_SLOT_ID ses_slotid; /* slotID saved from C_OpenSession() */ /* Place holder for parameters passed in the C_OpenSession */ CK_FLAGS flags; CK_NOTIFY Notify; CK_VOID_PTR pApplication; /* Pointers to form the global session list */ struct session *next; /* points to next session on the list */ struct session *prev; /* points to prev session on the list */ struct object *object_list; /* points to list of objects */ kms_active_op_t find_objects; kms_active_op_t encrypt; kms_active_op_t decrypt; kms_cfg_info_t configInfo; avl_tree_t objlabel_tree; KMSClientProfile kmsProfile; } kms_session_t; /* * The following structure is used to link the to-be-freed sessions * into a linked list. The sessions on this linked list have * not yet been freed via free() after C_CloseSession() call; instead * they are added to this list. The actual free will take place when * the number of sessions queued reaches MAX_SES_TO_BE_FREED, at which * time the first session in the list will be freed. */ #define MAX_SES_TO_BE_FREED 300 typedef struct ses_to_be_freed_list { kms_session_t *first; /* points to the first session in the list */ kms_session_t *last; /* points to the last session in the list */ uint32_t count; /* current total sessions in the list */ pthread_mutex_t ses_to_be_free_mutex; } ses_to_be_freed_list_t; extern ses_to_be_freed_list_t ses_delay_freed; extern CK_ULONG kms_session_cnt; extern CK_ULONG kms_session_rw_cnt; /* * Flag definitions for ses_close_sync */ #define SESSION_IS_CLOSING 1 /* Session is in a closing state */ #define SESSION_REFCNT_WAITING 2 /* Waiting for session reference */ /* count to become zero */ /* * This macro is used to decrement the session reference count by one. * * The caller of this macro uses the argument lock_held to indicate that * whether the caller holds the lock on the session or not. * * REFRELE macro does the following: * 1) Get the session lock if the caller does not hold it. * 2) Decrement the session reference count by one. * 3) If the session reference count becomes zero after being decremented, * and there is a closing session thread in the wait state, then * call pthread_cond_signal() to wake up that thread who is blocked * in the session deletion routine due to non-zero reference ount. * 4) Always release the session lock. */ #define REFRELE(s, ses_lock_held) { \ if (!ses_lock_held) \ (void) pthread_mutex_lock(&s->session_mutex); \ if ((--((s)->ses_refcnt) == 0) && \ (s->ses_close_sync & SESSION_REFCNT_WAITING)) { \ (void) pthread_mutex_unlock(&s->session_mutex); \ (void) pthread_cond_signal(&s->ses_free_cond); \ } else { \ (void) pthread_mutex_unlock(&s->session_mutex); \ } \ } /* * Function Prototypes. */ CK_RV handle2session(CK_SESSION_HANDLE hSession, kms_session_t **session_p); void kms_delete_all_sessions(boolean_t wrapper_only); void kms_delete_all_objects_in_session(kms_session_t *sp, boolean_t wrapper_only); CK_RV kms_add_session(CK_SLOT_ID slotID, CK_FLAGS flags, CK_VOID_PTR pApplication, CK_NOTIFY notify, CK_ULONG *phSession); void kms_delete_session(kms_session_t *sp, boolean_t lock_held, boolean_t wrapper_only); void kms_session_delay_free(kms_session_t *sp); void kms_acquire_all_slots_mutexes(); void kms_release_all_slots_mutexes(); #ifdef __cplusplus } #endif #endif /* _KMSSESSION_H */