开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 加密解密 > CA认证 > 查看源码
pkcs11i.h
资源名称：nss-3.1.1.tar.gz　[点击查看]
上传用户：lyxiangda
上传日期：2007-01-12
资源大小：3042k
文件大小：13k
源码类别：

CA认证

开发平台：

WINDOWS

pkcs11i.h：源码内容
  1. /*
  2.  * The contents of this file are subject to the Mozilla Public
  3.  * License Version 1.1 (the "License"); you may not use this file
  4.  * except in compliance with the License. You may obtain a copy of
  5.  * the License at http://www.mozilla.org/MPL/
  6.  * 
  7.  * Software distributed under the License is distributed on an "AS
  8.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  9.  * implied. See the License for the specific language governing
  10.  * rights and limitations under the License.
  11.  * 
  12.  * The Original Code is the Netscape security libraries.
  13.  * 
  14.  * The Initial Developer of the Original Code is Netscape
  15.  * Communications Corporation.  Portions created by Netscape are 
  16.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  17.  * Rights Reserved.
  18.  * 
  19.  * Contributor(s):
  20.  * 
  21.  * Alternatively, the contents of this file may be used under the
  22.  * terms of the GNU General Public License Version 2 or later (the
  23.  * "GPL"), in which case the provisions of the GPL are applicable 
  24.  * instead of those above.  If you wish to allow use of your 
  25.  * version of this file only under the terms of the GPL and not to
  26.  * allow others to use your version of this file under the MPL,
  27.  * indicate your decision by deleting the provisions above and
  28.  * replace them with the notice and other provisions required by
  29.  * the GPL.  If you do not delete the provisions above, a recipient
  30.  * may use your version of this file under either the MPL or the
  31.  * GPL.
  32.  */
  33. /*
  34.  * Internal data structures and functions used by pkcs11.c
  35.  */
  36. #ifndef _PKCS11I_H_
  37. #define _PKCS11I_H_ 1
  39. #include "prlock.h"
  40. #include "seccomon.h"
  41. #include "secoidt.h"
  42. #include "keytlow.h"
  43. #include "pkcs11t.h"
  45. #define PKCS11_USE_THREADS
  47. #define NO_ARENA
  48. #define MAX_OBJS_ATTRS 45
  49. #define ATTR_SPACE 50  /* hold up to a SSL premaster secret */
  52. #ifdef PKCS11_USE_THREADS
  53. #define PK11_USE_THREADS(x) x
  54. #else
  55. #define PK11_USE_THREADS(x) 
  56. #endif
  58. /* define typedefs, double as forward declarations as well */
  59. typedef struct PK11AttributeStr PK11Attribute;
  60. typedef struct PK11ObjectListStr PK11ObjectList;
  61. typedef struct PK11ObjectListElementStr PK11ObjectListElement;
  62. typedef struct PK11ObjectStr PK11Object;
  63. typedef struct PK11SessionStr PK11Session;
  64. typedef struct PK11SlotStr PK11Slot;
  65. typedef struct PK11SessionContextStr PK11SessionContext;
  66. typedef struct PK11SearchResultsStr PK11SearchResults;
  67. typedef struct PK11HashVerifyInfoStr PK11HashVerifyInfo;
  68. typedef struct PK11HashSignInfoStr PK11HashSignInfo;
  69. typedef struct PK11SSLMACInfoStr PK11SSLMACInfo;
  71. /* define function pointer typdefs for pointer tables */
  72. typedef void (*PK11Destroy)(void *, PRBool);
  73. typedef void (*PK11Begin)(void *);
  74. typedef SECStatus (*PK11Cipher)(void *,void *,unsigned int *,unsigned int,
  75. void *, unsigned int);
  76. typedef SECStatus (*PK11Verify)(void *,void *,unsigned int,void *,unsigned int);
  77. typedef void (*PK11Hash)(void *,void *,unsigned int);
  78. typedef void (*PK11End)(void *,void *,unsigned int *,unsigned int);
  79. typedef void (*PK11Free)(void *);
  81. /*
  82.  * these are data base storage hashes, not cryptographic hashes.. The define
  83.  * the effective size of the various object hash tables
  84.  */
  85. #define ATTRIBUTE_HASH_SIZE 32
  86. #define SESSION_OBJECT_HASH_SIZE 32
  87. #define TOKEN_OBJECT_HASH_SIZE 1024
  88. #define SESSION_HASH_SIZE 512
  89. #define MAX_KEY_LEN 256
  90. #define MAX_OBJECT_LIST_SIZE 800
  92. /* Value to tell if an attribute is modifiable or not.
  93.  *    NEVER: attribute is only set on creation.
  94.  *    ONCOPY: attribute is set on creation and can only be changed on copy.
  95.  *    SENSITIVE: attribute can only be changed to TRUE.
  96.  *    ALWAYS: attribute can always be changed.
  97.  */
  98. typedef enum {
  99. PK11_NEVER = 0,
  100. PK11_ONCOPY = 1,
  101. PK11_SENSITIVE = 2,
  102. PK11_ALWAYS = 3
  103. } PK11ModifyType;
  105. /*
  106.  * Free Status Enum... tell us more information when we think we're
  107.  * deleting an object.
  108.  */
  109. typedef enum {
  110. PK11_DestroyFailure,
  111. PK11_Destroyed,
  112. PK11_Busy
  113. } PK11FreeStatus;
  115. /*
  116.  * attribute values of an object.
  117.  */
  118. struct PK11AttributeStr {
  119.     PK11Attribute   *next;
  120.     PK11Attribute   *prev;
  121. #ifdef REF_COUNT_ATTRIBUTE
  122.     int  refCount;
  123.     PRLock  *refLock;
  124. #endif
  125.     /*must be called handle to make pk11queue_find work */
  126.     CK_ATTRIBUTE_TYPE handle;
  127.     CK_ATTRIBUTE  attrib;
  128. #ifdef NO_ARENA
  129.     unsigned char space[ATTR_SPACE];
  130. #endif
  131. };
  134. /*
  135.  * doubly link list of objects
  136.  */
  137. struct PK11ObjectListStr {
  138.     PK11ObjectList *next;
  139.     PK11ObjectList *prev;
  140.     PK11Object    *parent;
  141. };
  143. /*
  144.  * PKCS 11 crypto object structure
  145.  */
  146. struct PK11ObjectStr {
  147.     PK11Object *next;
  148.     PK11Object *prev;
  149.     PK11ObjectList sessionList;
  150.     CK_OBJECT_HANDLE handle;
  151. #ifdef NO_ARENA
  152.     int nextAttr;
  153. #else
  154.     PLArenaPool *arena;
  155. #endif
  156.     int refCount;
  157.     PRLock  *refLock;
  158.     PRLock *attributeLock;
  159.     PK11Session    *session;
  160.     PK11Slot     *slot;
  161.     CK_OBJECT_CLASS  objclass;
  162.     void  *objectInfo;
  163.     PK11Free  infoFree;
  164.     char *label;
  165.     PRBool inDB;
  166.     PRBool wasDerived;
  167.     PK11Attribute  *head[ATTRIBUTE_HASH_SIZE];
  168. #ifdef NO_ARENA
  169.     PK11Attribute attrList[MAX_OBJS_ATTRS];
  170. #endif
  171. };
  173. /*
  174.  * struct to deal with a temparary list of objects
  175.  */
  176. struct PK11ObjectListElementStr {
  177.     PK11ObjectListElement *next;
  178.     PK11Object  *object;
  179. };
  181. /*
  182.  * Area to hold Search results
  183.  */
  184. struct PK11SearchResultsStr {
  185.     CK_OBJECT_HANDLE *handles;
  186.     int size;
  187.     int index;
  188. };
  191. /* 
  192.  * the universal crypto/hash/sign/verify context structure
  193.  */
  194. typedef enum {
  195.     PK11_ENCRYPT,
  196.     PK11_DECRYPT,
  197.     PK11_HASH,
  198.     PK11_SIGN,
  199.     PK11_SIGN_RECOVER,
  200.     PK11_VERIFY,
  201.     PK11_VERIFY_RECOVER
  202. } PK11ContextType;
  205. #define PK11_MAX_BLOCK_SIZE 16
  206. /* currently SHA1 is the biggest hash length */
  207. #define PK11_MAX_MAC_LENGTH 20
  208. #define PK11_INVALID_MAC_SIZE 0xffffffff
  210. struct PK11SessionContextStr {
  211.     PK11ContextType type;
  212.     PRBool multi;  /* is multipart */
  213.     PRBool doPad;  /* use PKCS padding for block ciphers */
  214.     unsigned int blockSize;  /* blocksize for padding */
  215.     unsigned int padDataLength;  /* length of the valid data in padbuf */
  216.     unsigned char padBuf[PK11_MAX_BLOCK_SIZE];
  217.     unsigned char macBuf[PK11_MAX_BLOCK_SIZE];
  218.     CK_ULONG macSize; /* size of a general block cipher mac*/
  219.     void *cipherInfo;
  220.     void *hashInfo;
  221.     unsigned int cipherInfoLen;
  222.     CK_MECHANISM_TYPE currentMech;
  223.     PK11Cipher update;
  224.     PK11Hash hashUpdate;
  225.     PK11End end;
  226.     PK11Destroy destroy;
  227.     PK11Destroy hashdestroy;
  228.     PK11Verify verify;
  229.     unsigned int maxLen;
  230. };
  232. /*
  233.  * Sessions (have objects)
  234.  */
  235. struct PK11SessionStr {
  236.     PK11Session        *next;
  237.     PK11Session        *prev;
  238.     CK_SESSION_HANDLE handle;
  239.     int refCount;
  240.     PRLock  *refLock;
  241.     PRLock *objectLock;
  242.     int objectIDCount;
  243.     CK_SESSION_INFO info;
  244.     CK_NOTIFY notify;
  245.     CK_VOID_PTR appData;
  246.     PK11Slot *slot;
  247.     PK11SearchResults *search;
  248.     PK11SessionContext *enc_context;
  249.     PK11SessionContext *hash_context;
  250.     PK11SessionContext *sign_context;
  251.     PK11ObjectList *objects[1];
  252. };
  254. /*
  255.  * slots (have sessions and objects)
  256.  */
  257. struct PK11SlotStr {
  258.     CK_SLOT_ID slotID;
  259.     PRLock *sessionLock;
  260.     PRLock *objectLock;
  261.     SECItem *password;
  262.     PRBool hasTokens;
  263.     PRBool isLoggedIn;
  264.     PRBool ssoLoggedIn;
  265.     PRBool needLogin;
  266.     PRBool DB_loaded;
  267.     int sessionIDCount;
  268.     int sessionCount;
  269.     int rwSessionCount;
  270.     int tokenIDCount;
  271.     PK11Object *tokObjects[TOKEN_OBJECT_HASH_SIZE];
  272.     PK11Session *head[SESSION_HASH_SIZE];
  273. };
  275. /*
  276.  * special joint operations Contexts
  277.  */
  278. struct PK11HashVerifyInfoStr {
  279.     SECOidTag    hashOid;
  280.     SECKEYLowPublicKey *key;
  281. };
  283. struct PK11HashSignInfoStr {
  284.     SECOidTag    hashOid;
  285.     SECKEYLowPrivateKey *key;
  286. };
  288. /* context for the Final SSLMAC message */
  289. struct PK11SSLMACInfoStr {
  290.     void  *hashContext;
  291.     PK11Begin begin;
  292.     PK11Hash update;
  293.     PK11End end;
  294.     CK_ULONG macSize;
  295.     int padSize;
  296.     unsigned char key[MAX_KEY_LEN];
  297.     unsigned int keySize;
  298. };
  300. /*
  301.  * session handle modifiers
  302.  */
  303. #define PK11_PRIVATE_KEY_FLAG 0x80000000L
  304. #define PK11_FIPS_FLAG 0x40000000L
  306. /*
  307.  * object handle modifiers
  308.  */
  309. #define PK11_TOKEN_MASK 0x80000000L
  310. #define PK11_TOKEN_MAGIC 0x80000000L
  311. #define PK11_TOKEN_TYPE_MASK 0x70000000L
  312. #define PK11_TOKEN_TYPE_CERT 0x00000000L
  313. #define PK11_TOKEN_TYPE_PRIV 0x10000000L
  314. #define PK11_TOKEN_TYPE_PUB 0x20000000L
  316. /* how big a password/pin we can deal with */
  317. #define PK11_MAX_PIN 255
  319. /* slot ID's */
  320. #define NETSCAPE_SLOT_ID 1
  321. #define PRIVATE_KEY_SLOT_ID 2
  322. #define FIPS_SLOT_ID 3
  324. /* slot helper macros */
  325. #define pk11_SlotFromSession(sp) ((sp)->slot)
  326. #define pk11_isToken(id) (((id) & PK11_TOKEN_MASK) == PK11_TOKEN_MAGIC)
  328. /* queueing helper macros */
  329. #define pk11_hash(value,size) ((value) & (size-1))/*size must be a power of 2*/
  330. #define pk11queue_add(element,id,head,hash_size) 
  331. { int tmp = pk11_hash(id,hash_size); 
  332. (element)->next = (head)[tmp]; 
  333. (element)->prev = NULL; 
  334. if ((head)[tmp]) (head)[tmp]->prev = (element); 
  335. (head)[tmp] = (element); }
  336. #define pk11queue_find(element,id,head,hash_size) 
  337. for( (element) = (head)[pk11_hash(id,hash_size)]; (element) != NULL; 
  338.  (element) = (element)->next) { 
  339.     if ((element)->handle == (id)) { break; } }
  340. #define pk11queue_is_queued(element,id,head,hash_size) 
  341. ( ((element)->next) || ((element)->prev) || 
  342.  ((head)[pk11_hash(id,hash_size)] == (element)) )
  343. #define pk11queue_delete(element,id,head,hash_size) 
  344. if ((element)->next) (element)->next->prev = (element)->prev; 
  345. if ((element)->prev) (element)->prev->next = (element)->next; 
  346.    else (head)[pk11_hash(id,hash_size)] = ((element)->next); 
  347. (element)->next = NULL; 
  348. (element)->prev = NULL; 
  350. /* expand an attribute & secitem structures out */
  351. #define pk11_attr_expand(ap) (ap)->type,(ap)->pValue,(ap)->ulValueLen
  352. #define pk11_item_expand(ip) (ip)->data,(ip)->len
  354. SEC_BEGIN_PROTOS
  356. /* shared functions between PKCS11.c and PK11FIPS.c */
  357. extern CK_RV PK11_LowInitialize(CK_VOID_PTR pReserved);
  358. extern CK_RV PK11_SlotInit(CK_SLOT_ID slotID, PRBool needLogin);
  360. /* internal utility functions used by pkcs11.c */
  361. extern PK11Attribute *pk11_FindAttribute(PK11Object *object,
  362.  CK_ATTRIBUTE_TYPE type);
  363. extern void pk11_FreeAttribute(PK11Attribute *attribute);
  364. extern CK_RV pk11_AddAttributeType(PK11Object *object, CK_ATTRIBUTE_TYPE type,
  365.    void *valPtr,
  366.   CK_ULONG length);
  367. extern CK_RV pk11_Attribute2SecItem(PLArenaPool *arena, SECItem *item,
  368.     PK11Object *object, CK_ATTRIBUTE_TYPE type);
  369. extern PRBool pk11_hasAttribute(PK11Object *object, CK_ATTRIBUTE_TYPE type);
  370. extern PRBool pk11_isTrue(PK11Object *object, CK_ATTRIBUTE_TYPE type);
  371. extern void pk11_DeleteAttributeType(PK11Object *object,
  372.      CK_ATTRIBUTE_TYPE type);
  373. extern CK_RV pk11_Attribute2SecItem(PLArenaPool *arena, SECItem *item,
  374.     PK11Object *object, CK_ATTRIBUTE_TYPE type);
  375. extern CK_RV pk11_Attribute2SSecItem(PLArenaPool *arena, SECItem *item,
  376.      PK11Object *object,
  377.      CK_ATTRIBUTE_TYPE type);
  378. extern PK11ModifyType pk11_modifyType(CK_ATTRIBUTE_TYPE type,
  379.       CK_OBJECT_CLASS inClass);
  380. extern PRBool pk11_isSensitive(CK_ATTRIBUTE_TYPE type, CK_OBJECT_CLASS inClass);
  381. extern char *pk11_getString(PK11Object *object, CK_ATTRIBUTE_TYPE type);
  382. extern void pk11_nullAttribute(PK11Object *object,CK_ATTRIBUTE_TYPE type);
  383. extern CK_RV pk11_forceAttribute(PK11Object *object, CK_ATTRIBUTE_TYPE type,
  384.  void *value, unsigned int len);
  385. extern CK_RV pk11_defaultAttribute(PK11Object *object, CK_ATTRIBUTE_TYPE type,
  386.    void *value, unsigned int len);
  388. extern PK11Object *pk11_NewObject(PK11Slot *slot);
  389. extern CK_RV pk11_CopyObject(PK11Object *destObject, PK11Object *srcObject);
  390. extern PK11FreeStatus pk11_FreeObject(PK11Object *object);
  391. extern void pk11_DeleteObject(PK11Session *session, PK11Object *object);
  392. extern void pk11_ReferenceObject(PK11Object *object);
  393. extern PK11Object *pk11_ObjectFromHandle(CK_OBJECT_HANDLE handle,
  394.  PK11Session *session);
  395. extern void pk11_AddSlotObject(PK11Slot *slot, PK11Object *object);
  396. extern void pk11_AddObject(PK11Session *session, PK11Object *object);
  398. extern CK_RV pk11_searchObjectList(PK11ObjectListElement **objectList,
  399.    PK11Object **head, PRLock *lock,
  400.    CK_ATTRIBUTE_PTR inTemplate, int count,
  401.    PRBool isLoggedIn);
  402. extern PK11ObjectListElement *pk11_FreeObjectListElement(
  403.      PK11ObjectListElement *objectList);
  404. extern void pk11_FreeObjectList(PK11ObjectListElement *objectList);
  405. extern void pk11_FreeSearch(PK11SearchResults *search);
  406. extern CK_RV pk11_handleObject(PK11Object *object, PK11Session *session);
  408. extern PK11Slot *pk11_SlotFromID(CK_SLOT_ID slotID);
  409. extern PK11Slot *pk11_SlotFromSessionHandle(CK_SESSION_HANDLE handle);
  410. extern PK11Session *pk11_SessionFromHandle(CK_SESSION_HANDLE handle);
  411. extern void pk11_FreeSession(PK11Session *session);
  412. extern PK11Session *pk11_NewSession(CK_SLOT_ID slotID, CK_NOTIFY notify,
  413.     CK_VOID_PTR pApplication, CK_FLAGS flags);
  414. extern void pk11_update_state(PK11Slot *slot,PK11Session *session);
  415. extern void pk11_update_all_states(PK11Slot *slot);
  416. extern void pk11_FreeContext(PK11SessionContext *context);
  418. extern SECKEYLowPublicKey *pk11_GetPubKey(PK11Object *object,
  419.   CK_KEY_TYPE key_type);
  420. extern SECKEYLowPrivateKey *pk11_GetPrivKey(PK11Object *object,
  421.     CK_KEY_TYPE key_type);
  422. extern void pk11_FormatDESKey(unsigned char *key, int length);
  423. extern PRBool pk11_CheckDESKey(unsigned char *key);
  424. extern PRBool pk11_IsWeakKey(unsigned char *key,CK_KEY_TYPE key_type);
  426. SEC_END_PROTOS
  428. #endif /* _PKCS11I_H_ */