nss/lib/pk11wrap/secmodi.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4 /*
   5  * Internal header file included only by files in pkcs11 dir, or in
   6  * pkcs11 specific client and server files.
   7  */
   8 #ifndef _SECMODI_H_
   9 #define _SECMODI_H_ 1
  10 #include "pkcs11.h"
  11 #include "nssilock.h"
  12 #include "secoidt.h"
  13 #include "secdert.h"
  14 #include "certt.h"
  15 #include "secmodt.h"
  16 #include "keyt.h"
  17
  18 SEC_BEGIN_PROTOS
  19
  20 /* proto-types */
  21 extern SECStatus SECMOD_DeletePermDB(SECMODModule *module);
  22 extern SECStatus SECMOD_AddPermDB(SECMODModule *module);
  23 extern SECStatus SECMOD_Shutdown(void);
  24 void nss_DumpModuleLog(void);
  25
  26 extern int secmod_PrivateModuleCount;
  27
  28 extern void SECMOD_Init(void);
  29 SECStatus secmod_ModuleInit(SECMODModule *mod, SECMODModule **oldModule,
  30                             PRBool* alreadyLoaded);
  31
  32 /* list managment */
  33 extern SECStatus SECMOD_AddModuleToList(SECMODModule *newModule);
  34 extern SECStatus SECMOD_AddModuleToDBOnlyList(SECMODModule *newModule);
  35 extern SECStatus SECMOD_AddModuleToUnloadList(SECMODModule *newModule);
  36 extern void SECMOD_RemoveList(SECMODModuleList **,SECMODModuleList *);
  37 extern void SECMOD_AddList(SECMODModuleList *,SECMODModuleList *,SECMODListLock *);
  38 extern SECMODListLock *SECMOD_NewListLock(void);
  39 extern void SECMOD_DestroyListLock(SECMODListLock *);
  40 extern void SECMOD_GetWriteLock(SECMODListLock *);
  41 extern void SECMOD_ReleaseWriteLock(SECMODListLock *);
  42
  43 /* Operate on modules by name */
  44 extern SECMODModule *SECMOD_FindModuleByID(SECMODModuleID);
  45 extern SECMODModule *secmod_FindModuleByFuncPtr(void *funcPtr);
  46
  47 /* database/memory management */
  48 extern SECMODModuleList *SECMOD_NewModuleListElement(void);
  49 extern SECMODModuleList *SECMOD_DestroyModuleListElement(SECMODModuleList *);
  50 extern void SECMOD_DestroyModuleList(SECMODModuleList *);
  51 extern SECStatus SECMOD_AddModule(SECMODModule *newModule);
  52
  53 extern unsigned long SECMOD_InternaltoPubMechFlags(unsigned long internalFlags);
  54 extern unsigned long SECMOD_InternaltoPubCipherFlags(unsigned long internalFlags);
  55
  56 /* Library functions */
  57 SECStatus secmod_LoadPKCS11Module(SECMODModule *, SECMODModule **oldModule);
  58 SECStatus SECMOD_UnloadModule(SECMODModule *);
  59 void SECMOD_SetInternalModule(SECMODModule *);
  60 PRBool secmod_IsInternalKeySlot(SECMODModule *);
  61 void secmod_SetInternalKeySlotFlag(SECMODModule *mod, PRBool val);
  62
  63
  64 /* tools for checking if we are loading the same database twice */
  65 typedef struct SECMODConfigListStr SECMODConfigList;
  66 /* collect all the databases in a given spec */
  67 SECMODConfigList *secmod_GetConfigList(PRBool isFIPS, char *spec, int *count);
  68 /* see is a spec matches a database on the list */
  69 PRBool secmod_MatchConfigList(char *spec,
  70                               SECMODConfigList *conflist, int count);
  71 /* free our list of databases */
  72 void secmod_FreeConfigList(SECMODConfigList *conflist, int count);
  73
  74 /* parsing parameters */
  75 /* returned char * must be freed by caller with PORT_Free */
  76 /* children and ids are null terminated arrays which must be freed with
  77  * secmod_FreeChildren */
  78 char *secmod_ParseModuleSpecForTokens(PRBool convert,
  79                                       PRBool isFIPS,
  80                                       char *moduleSpec,
  81                                       char ***children,
  82                                       CK_SLOT_ID **ids);
  83 void secmod_FreeChildren(char **children, CK_SLOT_ID *ids);
  84 char *secmod_MkAppendTokensList(PLArenaPool *arena, char *origModuleSpec,
  85                                 char *newModuleSpec, CK_SLOT_ID newID,
  86                                 char **children, CK_SLOT_ID *ids);
  87
  88
  89 void SECMOD_SlotDestroyModule(SECMODModule *module, PRBool fromSlot);
  90 CK_RV pk11_notify(CK_SESSION_HANDLE session, CK_NOTIFICATION event,
  91                                                          CK_VOID_PTR pdata);
  92 void pk11_SignedToUnsigned(CK_ATTRIBUTE *attrib);
  93 CK_OBJECT_HANDLE pk11_FindObjectByTemplate(PK11SlotInfo *slot,
  94                                         CK_ATTRIBUTE *inTemplate,int tsize);
  95 CK_OBJECT_HANDLE *pk11_FindObjectsByTemplate(PK11SlotInfo *slot,
  96                         CK_ATTRIBUTE *inTemplate,int tsize, int *objCount);
  97
  98 #define PK11_GETTAB(x) ((CK_FUNCTION_LIST_PTR)((x)->functionList))
  99 #define PK11_SETATTRS(x,id,v,l) (x)->type = (id); \
 100                 (x)->pValue=(v); (x)->ulValueLen = (l);
 101 SECStatus PK11_CreateNewObject(PK11SlotInfo *slot, CK_SESSION_HANDLE session,
 102                                const CK_ATTRIBUTE *theTemplate, int count,
 103                                 PRBool token, CK_OBJECT_HANDLE *objectID);
 104
 105 SECStatus pbe_PK11AlgidToParam(SECAlgorithmID *algid,SECItem *mech);
 106 SECStatus PBE_PK11ParamToAlgid(SECOidTag algTag, SECItem *param,
 107                                 PLArenaPool *arena, SECAlgorithmID *algId);
 108
 109 PK11SymKey *pk11_TokenKeyGenWithFlagsAndKeyType(PK11SlotInfo *slot,
 110         CK_MECHANISM_TYPE type, SECItem *param, CK_KEY_TYPE keyType,
 111         int keySize, SECItem *keyId, CK_FLAGS opFlags,
 112         PK11AttrFlags attrFlags, void *wincx);
 113
 114 CK_MECHANISM_TYPE pk11_GetPBECryptoMechanism(SECAlgorithmID *algid,
 115                    SECItem **param, SECItem *pwd, PRBool faulty3DES);
 116
 117
 118
 119 extern void pk11sdr_Init(void);
 120 extern void pk11sdr_Shutdown(void);
 121
 122 /*
 123  * Private to pk11wrap.
 124  */
 125
 126 PRBool pk11_LoginStillRequired(PK11SlotInfo *slot, void *wincx);
 127 CK_SESSION_HANDLE pk11_GetNewSession(PK11SlotInfo *slot, PRBool *owner);
 128 void pk11_CloseSession(PK11SlotInfo *slot, CK_SESSION_HANDLE sess, PRBool own);
 129 PK11SymKey *pk11_ForceSlot(PK11SymKey *symKey, CK_MECHANISM_TYPE type,
 130                                                 CK_ATTRIBUTE_TYPE operation);
 131 /* Convert key operation flags to PKCS #11 attributes. */
 132 unsigned int pk11_OpFlagsToAttributes(CK_FLAGS flags,
 133                                 CK_ATTRIBUTE *attrs, CK_BBOOL *ckTrue);
 134 /* Check for bad (conflicting) attribute flags */
 135 PRBool pk11_BadAttrFlags(PK11AttrFlags attrFlags);
 136 /* Convert key attribute flags to PKCS #11 attributes. */
 137 unsigned int pk11_AttrFlagsToAttributes(PK11AttrFlags attrFlags,
 138                 CK_ATTRIBUTE *attrs, CK_BBOOL *ckTrue, CK_BBOOL *ckFalse);
 139 PRBool pk11_FindAttrInTemplate(CK_ATTRIBUTE *attr, unsigned int numAttrs,
 140                                         CK_ATTRIBUTE_TYPE target);
 141
 142 CK_MECHANISM_TYPE pk11_mapWrapKeyType(KeyType keyType);
 143 PK11SymKey *pk11_KeyExchange(PK11SlotInfo *slot, CK_MECHANISM_TYPE type,
 144                 CK_ATTRIBUTE_TYPE operation, CK_FLAGS flags, PRBool isPerm,
 145                                                 PK11SymKey *symKey);
 146
 147 PRBool pk11_HandleTrustObject(PK11SlotInfo *slot, CERTCertificate *cert,
 148                                                          CERTCertTrust *trust);
 149 CK_OBJECT_HANDLE pk11_FindPubKeyByAnyCert(CERTCertificate *cert,
 150                                          PK11SlotInfo **slot, void *wincx);
 151 SECStatus pk11_AuthenticateUnfriendly(PK11SlotInfo *slot, PRBool loadCerts,
 152                                                         void *wincx);
 153 int PK11_NumberObjectsFor(PK11SlotInfo *slot, CK_ATTRIBUTE *findTemplate,
 154                                                 int templateCount);
 155 SECItem *pk11_GetLowLevelKeyFromHandle(PK11SlotInfo *slot,
 156                                                 CK_OBJECT_HANDLE handle);
 157 SECStatus PK11_TraverseSlot(PK11SlotInfo *slot, void *arg);
 158 CK_OBJECT_HANDLE pk11_FindPrivateKeyFromCertID(PK11SlotInfo *slot,
 159                                                         SECItem *keyID);
 160 SECKEYPrivateKey *PK11_MakePrivKey(PK11SlotInfo *slot, KeyType keyType,
 161                         PRBool isTemp, CK_OBJECT_HANDLE privID, void *wincx);
 162 CERTCertificate *PK11_MakeCertFromHandle(PK11SlotInfo *slot,
 163                         CK_OBJECT_HANDLE certID, CK_ATTRIBUTE *privateLabel);
 164
 165 SECItem *pk11_GenerateNewParamWithKeyLen(CK_MECHANISM_TYPE type, int keyLen);
 166 SECItem *pk11_ParamFromIVWithLen(CK_MECHANISM_TYPE type,
 167                                  SECItem *iv, int keyLen);
 168
 169 SEC_END_PROTOS
 170
 171 #endif
 172