2001-09-14 02:06:10 +04:00
|
|
|
/*
|
|
|
|
* The contents of this file are subject to the Mozilla Public
|
|
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of
|
|
|
|
* the License at http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS
|
|
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
|
|
* implied. See the License for the specific language governing
|
|
|
|
* rights and limitations under the License.
|
|
|
|
*
|
|
|
|
* The Original Code is the Netscape security libraries.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is Netscape
|
|
|
|
* Communications Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1994-2000 Netscape Communications Corporation. All
|
|
|
|
* Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the
|
|
|
|
* terms of the GNU General Public License Version 2 or later (the
|
|
|
|
* "GPL"), in which case the provisions of the GPL are applicable
|
|
|
|
* instead of those above. If you wish to allow use of your
|
|
|
|
* version of this file only under the terms of the GPL and not to
|
|
|
|
* allow others to use your version of this file under the MPL,
|
|
|
|
* indicate your decision by deleting the provisions above and
|
|
|
|
* replace them with the notice and other provisions required by
|
|
|
|
* the GPL. If you do not delete the provisions above, a recipient
|
|
|
|
* may use your version of this file under either the MPL or the
|
|
|
|
* GPL.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ckhelper.h
|
|
|
|
*
|
|
|
|
* This file contains some helper utilities for interaction with cryptoki.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CKHELPER_H
|
|
|
|
#define CKHELPER_H
|
|
|
|
|
|
|
|
#ifdef DEBUG
|
2001-11-08 03:15:51 +03:00
|
|
|
static const char CKHELPER_CVS_ID[] = "@(#) $RCSfile: ckhelper.h,v $ $Revision: 1.10 $ $Date: 2001/11/08 00:14:52 $ $Name: $";
|
2001-09-14 02:06:10 +04:00
|
|
|
#endif /* DEBUG */
|
|
|
|
|
|
|
|
#ifndef NSSCKT_H
|
|
|
|
#include "nssckt.h"
|
|
|
|
#endif /* NSSCKT_H */
|
|
|
|
|
|
|
|
PR_BEGIN_EXTERN_C
|
|
|
|
|
|
|
|
/* Shortcut to cryptoki API functions. */
|
|
|
|
#define CKAPI(x) \
|
|
|
|
((CK_FUNCTION_LIST_PTR)((x)->epv))
|
|
|
|
|
|
|
|
/* Some globals to keep from constantly redeclaring common cryptoki
|
|
|
|
* attribute types on the stack.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Boolean values */
|
2001-10-11 22:40:34 +04:00
|
|
|
NSS_EXTERN_DATA const NSSItem g_ck_true;
|
|
|
|
NSS_EXTERN_DATA const NSSItem g_ck_false;
|
2001-09-14 02:06:10 +04:00
|
|
|
|
|
|
|
/* Object classes */
|
2001-10-11 22:40:34 +04:00
|
|
|
NSS_EXTERN_DATA const NSSItem g_ck_class_cert;
|
|
|
|
NSS_EXTERN_DATA const NSSItem g_ck_class_pubkey;
|
|
|
|
NSS_EXTERN_DATA const NSSItem g_ck_class_privkey;
|
|
|
|
|
|
|
|
#define NSS_CK_SET_ATTRIBUTE_VAR(cktemplate, index, var) \
|
|
|
|
(cktemplate)[index].pValue = (CK_VOID_PTR)&var; \
|
|
|
|
(cktemplate)[index].ulValueLen = (CK_ULONG)sizeof(var)
|
|
|
|
|
2001-10-19 22:10:58 +04:00
|
|
|
/* so, nssUTF8_Size or nssUTF8_Length? \0 or no? */
|
|
|
|
#define NSS_CK_SET_ATTRIBUTE_UTF8(cktemplate, index, utf8) \
|
|
|
|
(cktemplate)[index].pValue = (CK_VOID_PTR)utf8; \
|
|
|
|
(cktemplate)[index].ulValueLen = (CK_ULONG)nssUTF8_Size(utf8, NULL);
|
|
|
|
|
2001-10-11 22:40:34 +04:00
|
|
|
#define NSS_CK_SET_ATTRIBUTE_ITEM(cktemplate, index, item) \
|
|
|
|
(cktemplate)[index].pValue = (CK_VOID_PTR)(item)->data; \
|
|
|
|
(cktemplate)[index].ulValueLen = (CK_ULONG)(item)->size;
|
2001-09-14 02:06:10 +04:00
|
|
|
|
|
|
|
/* NSS_CK_ATTRIBUTE_TO_ITEM(attrib, item)
|
|
|
|
*
|
|
|
|
* Convert a CK_ATTRIBUTE to an NSSItem.
|
|
|
|
*/
|
2001-11-05 20:18:48 +03:00
|
|
|
#define NSS_CK_ATTRIBUTE_TO_ITEM(attrib, item) \
|
|
|
|
if ((CK_LONG)(attrib)->ulValueLen > 0) { \
|
|
|
|
(item)->data = (void *)(attrib)->pValue; \
|
|
|
|
(item)->size = (PRUint32)(attrib)->ulValueLen; \
|
|
|
|
}
|
2001-09-14 02:06:10 +04:00
|
|
|
|
2001-10-09 00:19:30 +04:00
|
|
|
/* NSS_CK_ATTRIBUTE_TO_UTF8(attrib, str)
|
|
|
|
*
|
|
|
|
* Convert a CK_ATTRIBUTE to a string.
|
|
|
|
*/
|
|
|
|
#define NSS_CK_ATTRIBUTE_TO_UTF8(attrib, str) \
|
|
|
|
str = (NSSUTF8 *)((attrib)->pValue);
|
|
|
|
|
|
|
|
/* NSS_CK_ITEM_TO_ATTRIBUTE(item, attrib)
|
|
|
|
*
|
|
|
|
* Convert an NSSItem to a CK_ATTRIBUTE.
|
|
|
|
*/
|
|
|
|
#define NSS_CK_ITEM_TO_ATTRIBUTE(item, attrib) \
|
|
|
|
(attrib)->pValue = (CK_VOID_PTR)(item)->data; \
|
|
|
|
(attrib)->ulValueLen = (CK_ULONG)(item)->size; \
|
|
|
|
|
2001-09-14 02:06:10 +04:00
|
|
|
/* Get an array of attributes from an object. */
|
|
|
|
NSS_EXTERN PRStatus
|
2001-09-20 01:47:23 +04:00
|
|
|
nssCKObject_GetAttributes
|
2001-09-14 02:06:10 +04:00
|
|
|
(
|
|
|
|
CK_OBJECT_HANDLE object,
|
|
|
|
CK_ATTRIBUTE_PTR obj_template,
|
|
|
|
CK_ULONG count,
|
|
|
|
NSSArena *arenaOpt,
|
2001-09-19 00:54:28 +04:00
|
|
|
nssSession *session,
|
2001-09-14 02:06:10 +04:00
|
|
|
NSSSlot *slot
|
|
|
|
);
|
|
|
|
|
2001-10-11 20:33:38 +04:00
|
|
|
/* Get a single attribute as an item. */
|
|
|
|
NSS_EXTERN PRStatus
|
|
|
|
nssCKObject_GetAttributeItem
|
|
|
|
(
|
|
|
|
CK_OBJECT_HANDLE object,
|
|
|
|
CK_ATTRIBUTE_TYPE attribute,
|
|
|
|
NSSArena *arenaOpt,
|
|
|
|
nssSession *session,
|
|
|
|
NSSSlot *slot,
|
|
|
|
NSSItem *rvItem
|
|
|
|
);
|
|
|
|
|
|
|
|
NSS_EXTERN PRBool
|
|
|
|
nssCKObject_IsAttributeTrue
|
|
|
|
(
|
|
|
|
CK_OBJECT_HANDLE object,
|
|
|
|
CK_ATTRIBUTE_TYPE attribute,
|
|
|
|
nssSession *session,
|
|
|
|
NSSSlot *slot,
|
|
|
|
PRStatus *rvStatus
|
|
|
|
);
|
|
|
|
|
2001-10-19 22:10:58 +04:00
|
|
|
NSS_EXTERN PRStatus
|
|
|
|
nssCKObject_SetAttributes
|
|
|
|
(
|
|
|
|
CK_OBJECT_HANDLE object,
|
|
|
|
CK_ATTRIBUTE_PTR obj_template,
|
|
|
|
CK_ULONG count,
|
|
|
|
nssSession *session,
|
|
|
|
NSSSlot *slot
|
|
|
|
);
|
|
|
|
|
2001-11-05 20:18:48 +03:00
|
|
|
NSS_EXTERN PRBool
|
|
|
|
nssCKObject_IsTokenObjectTemplate
|
|
|
|
(
|
|
|
|
CK_ATTRIBUTE_PTR objectTemplate,
|
|
|
|
CK_ULONG otsize
|
|
|
|
);
|
|
|
|
|
2001-09-14 02:06:10 +04:00
|
|
|
PR_END_EXTERN_C
|
|
|
|
|
|
|
|
#endif /* CKHELPER_H */
|