xref: /illumos-gate/usr/src/lib/pkcs11/libpkcs11/common/pkcs11Session.h (revision 1da57d551424de5a9d469760be7c4b4d4f10a755)
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 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_PKCS11_SESSION_H
27 #define	_PKCS11_SESSION_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #define	PKCS11_SESSION_MAGIC	0xECF00001
34 
35 typedef struct pkcs11_session {
36 
37 	ulong_t			se_magic; /* ensure this is a valid session */
38 	CK_SESSION_HANDLE	se_handle; /* from slot's C_OpenSession() */
39 	CK_SLOT_ID		se_slotid; /* slotID in framework */
40 	struct pkcs11_session	*se_prev;	/* Chain of sessions  */
41 	struct pkcs11_session	*se_next; 	/* in this slot */
42 
43 } pkcs11_session_t;
44 
45 
46 /*
47  * This macro is used to typecast a session handle to a pointer
48  * to a session structure.  It also checks to see if the session
49  * is tagged with a session magic number.  This is to detect when an
50  * application passes a bogus session pointer.
51  */
52 #define	HANDLE2SESSION(hSession, sessionp, rv)\
53 		sessionp = (pkcs11_session_t *)(hSession);	\
54 		rv = CKR_OK;					\
55 		if ((sessionp == NULL) || 			\
56 		    (sessionp->se_magic != PKCS11_SESSION_MAGIC)) \
57 			rv = CKR_SESSION_HANDLE_INVALID;
58 
59 
60 struct pkcs11_slot;
61 
62 extern CK_RV pkcs11_session_add(struct pkcs11_slot *pslot, CK_SLOT_ID slot_id,
63 	CK_SESSION_HANDLE_PTR pfwhandle, CK_SESSION_HANDLE prov_sess);
64 
65 extern void pkcs11_session_delete(struct pkcs11_slot *pslot,
66 	pkcs11_session_t *psess);
67 
68 extern void pkcs11_sessionlist_delete(struct pkcs11_slot *pslot);
69 
70 #ifdef	__cplusplus
71 }
72 #endif
73 
74 #endif /* _PKCS11_SESSION_H */
75