libxmlsec/include/tokens.h

   1 /**
   2  * XMLSec library
   3  *
   4  * This is free software; see Copyright file in the source
   5  * distribution for preciese wording.
   6  *
   7  * Copyright (c) 2003 Sun Microsystems, Inc.  All rights reserved.
   8  *
   9  * Contributor(s): _____________________________
  10  *
  11  */
  12 #ifndef __XMLSEC_NSS_TOKENS_H__
  13 #define __XMLSEC_NSS_TOKENS_H__
  14
  15 #include <string.h>
  16
  17 #include <nss.h>
  18 #include <pk11func.h>
  19
  20 #include <xmlsec/xmlsec.h>
  21 #include <xmlsec/list.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 /**
  28  * xmlSecNssKeySlotListId
  29  *
  30  * The crypto mechanism list klass
  31  */
  32 #define xmlSecNssKeySlotListId xmlSecNssKeySlotListGetKlass()
  33 XMLSEC_CRYPTO_EXPORT xmlSecPtrListId xmlSecNssKeySlotListGetKlass( void ) ;
  34
  35 /*******************************************
  36  * KeySlot interfaces
  37  *******************************************/
  38 /**
  39  * Internal NSS key slot data
  40  * @mechanismList:      the mechanisms that the slot bound with.
  41  * @slot:               the pkcs slot
  42  *
  43  * This context is located after xmlSecPtrList
  44  */
  45 typedef struct _xmlSecNssKeySlot    xmlSecNssKeySlot ;
  46 typedef struct _xmlSecNssKeySlot*   xmlSecNssKeySlotPtr ;
  47
  48 struct _xmlSecNssKeySlot {
  49     CK_MECHANISM_TYPE_PTR   mechanismList ; /* mech. array, NULL ternimated */
  50     PK11SlotInfo*           slot ;
  51 } ;
  52
  53 XMLSEC_CRYPTO_EXPORT int
  54 xmlSecNssKeySlotSetMechList(
  55     xmlSecNssKeySlotPtr keySlot ,
  56     CK_MECHANISM_TYPE_PTR mechanismList
  57 ) ;
  58
  59 XMLSEC_CRYPTO_EXPORT int
  60 xmlSecNssKeySlotEnableMech(
  61     xmlSecNssKeySlotPtr keySlot ,
  62     CK_MECHANISM_TYPE mechanism
  63 ) ;
  64
  65 XMLSEC_CRYPTO_EXPORT int
  66 xmlSecNssKeySlotDisableMech(
  67     xmlSecNssKeySlotPtr keySlot ,
  68     CK_MECHANISM_TYPE mechanism
  69 ) ;
  70
  71 XMLSEC_CRYPTO_EXPORT CK_MECHANISM_TYPE_PTR
  72 xmlSecNssKeySlotGetMechList(
  73     xmlSecNssKeySlotPtr keySlot
  74 ) ;
  75
  76 XMLSEC_CRYPTO_EXPORT int
  77 xmlSecNssKeySlotSetSlot(
  78     xmlSecNssKeySlotPtr keySlot ,
  79     PK11SlotInfo* slot
  80 ) ;
  81
  82 XMLSEC_CRYPTO_EXPORT int
  83 xmlSecNssKeySlotInitialize(
  84     xmlSecNssKeySlotPtr keySlot ,
  85     PK11SlotInfo* slot
  86 ) ;
  87
  88 XMLSEC_CRYPTO_EXPORT void
  89 xmlSecNssKeySlotFinalize(
  90     xmlSecNssKeySlotPtr keySlot
  91 ) ;
  92
  93 XMLSEC_CRYPTO_EXPORT PK11SlotInfo*
  94 xmlSecNssKeySlotGetSlot(
  95     xmlSecNssKeySlotPtr keySlot
  96 ) ;
  97
  98 XMLSEC_CRYPTO_EXPORT xmlSecNssKeySlotPtr
  99 xmlSecNssKeySlotCreate() ;
 100
 101 XMLSEC_CRYPTO_EXPORT int
 102 xmlSecNssKeySlotCopy(
 103     xmlSecNssKeySlotPtr newKeySlot ,
 104     xmlSecNssKeySlotPtr keySlot
 105 ) ;
 106
 107 XMLSEC_CRYPTO_EXPORT xmlSecNssKeySlotPtr
 108 xmlSecNssKeySlotDuplicate(
 109     xmlSecNssKeySlotPtr keySlot
 110 ) ;
 111
 112 XMLSEC_CRYPTO_EXPORT void
 113 xmlSecNssKeySlotDestroy(
 114         xmlSecNssKeySlotPtr keySlot
 115 ) ;
 116
 117 XMLSEC_CRYPTO_EXPORT int
 118 xmlSecNssKeySlotBindMech(
 119     xmlSecNssKeySlotPtr keySlot ,
 120     CK_MECHANISM_TYPE type
 121 ) ;
 122
 123 XMLSEC_CRYPTO_EXPORT int
 124 xmlSecNssKeySlotSupportMech(
 125     xmlSecNssKeySlotPtr keySlot ,
 126     CK_MECHANISM_TYPE type
 127 ) ;
 128
 129
 130 /************************************************************************
 131  * PKCS#11 crypto token interfaces
 132  *
 133  * A PKCS#11 slot repository will be defined internally. From the
 134  * repository, a user can specify a particular slot for a certain crypto
 135  * mechanism.
 136  *
 137  * In some situation, some cryptographic operation should act in a user
 138  * designated devices. The interfaces defined here provide the way. If
 139  * the user do not initialize the repository distinctly, the interfaces
 140  * use the default functions provided by NSS itself.
 141  *
 142  ************************************************************************/
 143 /**
 144  * Initialize NSS pkcs#11 slot repository
 145  *
 146  * Returns 0 if success or -1 if an error occurs.
 147  */
 148 XMLSEC_CRYPTO_EXPORT int xmlSecNssSlotInitialize( void ) ;
 149
 150 /**
 151  * Shutdown and destroy NSS pkcs#11 slot repository
 152  */
 153 XMLSEC_CRYPTO_EXPORT void xmlSecNssSlotShutdown() ;
 154
 155 /**
 156  * Get PKCS#11 slot handler
 157  * @type    the mechanism that the slot must support.
 158  *
 159  * Returns a pointer to PKCS#11 slot or NULL if an error occurs.
 160  *
 161  * Notes: The returned handler must be destroied distinctly.
 162  */
 163 XMLSEC_CRYPTO_EXPORT PK11SlotInfo* xmlSecNssSlotGet( CK_MECHANISM_TYPE type ) ;
 164
 165 /**
 166  * Adopt a pkcs#11 slot with a mechanism into the repository
 167  * @slot:   the pkcs#11 slot.
 168  * @mech:   the mechanism.
 169  *
 170  * If @mech is available( @mech != CKM_INVALID_MECHANISM ), every operation with
 171  * this mechanism only can perform on the @slot.
 172  *
 173  * Returns 0 if success or -1 if an error occurs.
 174  */
 175 XMLSEC_CRYPTO_EXPORT int xmlSecNssSlotAdopt( PK11SlotInfo* slot, CK_MECHANISM_TYPE mech ) ;
 176
 177 #ifdef __cplusplus
 178 }
 179 #endif /* __cplusplus */
 180
 181 #endif  /* __XMLSEC_NSS_TOKENS_H__ */
 182
 183