keylow.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:8k
源码类别:

CA认证

开发平台:

WINDOWS

  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.  * key.h - public data structures and prototypes for the private key library
  34.  *
  35.  * $Id: keylow.h,v 1.1 2000/03/31 19:26:01 relyea%netscape.com Exp $
  36.  */
  37. #ifndef _KEYLOW_H_
  38. #define _KEYLOW_H_
  39. #include "prtypes.h"
  40. #include "seccomon.h"
  41. #include "keydbt.h"
  42. #include "secoidt.h"
  43. #include "certt.h"
  44. #include "keythi.h"
  45. SEC_BEGIN_PROTOS
  46. typedef char * (* SECKEYDBNameFunc)(void *arg, int dbVersion);
  47.     
  48. /*
  49. ** Open a key database.
  50. */
  51. extern SECKEYKeyDBHandle *SECKEY_OpenKeyDB(PRBool readOnly,
  52.    SECKEYDBNameFunc namecb,
  53.    void *cbarg);
  54. extern SECKEYKeyDBHandle *SECKEY_OpenKeyDBFilename(char *filename,
  55.    PRBool readOnly);
  56. /*
  57. ** Update the database
  58. */
  59. extern SECStatus SECKEY_UpdateKeyDBPass1(SECKEYKeyDBHandle *handle);
  60. extern SECStatus SECKEY_UpdateKeyDBPass2(SECKEYKeyDBHandle *handle,
  61.  SECItem *pwitem);
  62. /*
  63.  * Clear out all the keys in the existing database
  64.  */
  65. extern SECStatus SECKEY_ResetKeyDB(SECKEYKeyDBHandle *handle);
  66. /*
  67. ** Close the specified key database.
  68. */
  69. extern void SECKEY_CloseKeyDB(SECKEYKeyDBHandle *handle);
  70. /*
  71.  * Get the version number of the database
  72.  */
  73. extern int SECKEY_GetKeyDBVersion(SECKEYKeyDBHandle *handle);
  74. /*
  75. ** Support a default key database.
  76. */
  77. extern void SECKEY_SetDefaultKeyDB(SECKEYKeyDBHandle *handle);
  78. extern SECKEYKeyDBHandle *SECKEY_GetDefaultKeyDB(void);
  79. /* set the alg id of the key encryption algorithm */
  80. extern void SECKEY_SetDefaultKeyDBAlg(SECOidTag alg);
  81. /*
  82.  * given a password and salt, produce a hash of the password
  83.  */
  84. extern SECItem *SECKEY_HashPassword(char *pw, SECItem *salt);
  85. /*
  86.  * Derive the actual password value for a key database from the
  87.  * password string value.  The derivation uses global salt value
  88.  * stored in the key database.
  89.  */
  90. extern SECItem *
  91. SECKEY_DeriveKeyDBPassword(SECKEYKeyDBHandle *handle, char *pw);
  92. /*
  93. ** Delete a key from the database
  94. */
  95. extern SECStatus SECKEY_DeleteKey(SECKEYKeyDBHandle *handle, 
  96.   SECItem *pubkey);
  97. /*
  98. ** Store a key in the database, indexed by its public key modulus.
  99. ** "pk" is the private key to store
  100. ** "f" is a the callback function for getting the password
  101. ** "arg" is the argument for the callback
  102. */
  103. extern SECStatus SECKEY_StoreKeyByPublicKey(SECKEYKeyDBHandle *handle, 
  104.     SECKEYLowPrivateKey *pk,
  105.     SECItem *pubKeyData,
  106.     char *nickname,
  107.     SECKEYGetPasswordKey f, void *arg);
  108. /* does the key for this cert exist in the database filed by modulus */
  109. extern SECStatus SECKEY_KeyForCertExists(SECKEYKeyDBHandle *handle,
  110.  CERTCertificate *cert);
  111. SECKEYLowPrivateKey *
  112. SECKEY_FindKeyByCert(SECKEYKeyDBHandle *handle, CERTCertificate *cert,
  113.      SECKEYGetPasswordKey f, void *arg);
  114. extern SECStatus SECKEY_HasKeyDBPassword(SECKEYKeyDBHandle *handle);
  115. extern SECStatus SECKEY_SetKeyDBPassword(SECKEYKeyDBHandle *handle,
  116.      SECItem *pwitem);
  117. extern SECStatus SECKEY_CheckKeyDBPassword(SECKEYKeyDBHandle *handle,
  118.    SECItem *pwitem);
  119. extern SECStatus SECKEY_ChangeKeyDBPassword(SECKEYKeyDBHandle *handle,
  120.     SECItem *oldpwitem,
  121.     SECItem *newpwitem);
  122. /*
  123. ** Destroy a private key object.
  124. ** "key" the object
  125. ** "freeit" if PR_TRUE then free the object as well as its sub-objects
  126. */
  127. extern void SECKEY_LowDestroyPrivateKey(SECKEYLowPrivateKey *key);
  128. /*
  129. ** Destroy a public key object.
  130. ** "key" the object
  131. ** "freeit" if PR_TRUE then free the object as well as its sub-objects
  132. */
  133. extern void SECKEY_LowDestroyPublicKey(SECKEYLowPublicKey *key);
  134. /*
  135. ** Return the modulus length of "pubKey".
  136. */
  137. extern unsigned int SECKEY_LowPublicModulusLen(SECKEYLowPublicKey *pubKey);
  138. /*
  139. ** Return the modulus length of "privKey".
  140. */
  141. extern unsigned int SECKEY_LowPrivateModulusLen(SECKEYLowPrivateKey *privKey);
  142. /*
  143. ** Convert a low private key "privateKey" into a public low key
  144. */
  145. extern SECKEYLowPublicKey 
  146. *SECKEY_LowConvertToPublicKey(SECKEYLowPrivateKey *privateKey);
  147. /*
  148.  * Set the Key Database password.
  149.  *   handle is a handle to the key database
  150.  *   pwitem is the new password
  151.  *   algorithm is the algorithm by which the key database 
  152.  *    password is to be encrypted.
  153.  * On failure, SECFailure is returned, otherwise SECSuccess is 
  154.  * returned.
  155.  */
  156. extern SECStatus 
  157. SECKEY_SetKeyDBPasswordAlg(SECKEYKeyDBHandle *handle,
  158. SECItem *pwitem, 
  159. SECOidTag algorithm);
  160. /* Check the key database password.
  161.  *   handle is a handle to the key database
  162.  *   pwitem is the suspect password
  163.  *   algorithm is the algorithm by which the key database 
  164.  *    password is to be encrypted.
  165.  * The password is checked against plaintext to see if it is the
  166.  * actual password.  If it is not, SECFailure is returned.
  167.  */
  168. extern SECStatus 
  169. SECKEY_CheckKeyDBPasswordAlg(SECKEYKeyDBHandle *handle,
  170. SECItem *pwitem, 
  171. SECOidTag algorithm);
  172. /* Change the key database password and/or algorithm by which
  173.  * the password is stored with.  
  174.  *   handle is a handle to the key database
  175.  *   old_pwitem is the current password
  176.  *   new_pwitem is the new password
  177.  *   old_algorithm is the algorithm by which the key database 
  178.  *    password is currently encrypted.
  179.  *   new_algorithm is the algorithm with which the new password
  180.  *      is to be encrypted.
  181.  * A return of anything but SECSuccess indicates failure.
  182.  */
  183. extern SECStatus 
  184. SECKEY_ChangeKeyDBPasswordAlg(SECKEYKeyDBHandle *handle,
  185.       SECItem *oldpwitem, SECItem *newpwitem,
  186.       SECOidTag old_algorithm);
  187. /* Store key by modulus and specify an encryption algorithm to use.
  188.  *   handle is the pointer to the key database,
  189.  *   privkey is the private key to be stored,
  190.  *   f and arg are the function and arguments to the callback
  191.  *       to get a password,
  192.  *   algorithm is the algorithm which the privKey is to be stored.
  193.  * A return of anything but SECSuccess indicates failure.
  194.  */
  195. extern SECStatus 
  196. SECKEY_StoreKeyByPublicKeyAlg(SECKEYKeyDBHandle *handle, 
  197.       SECKEYLowPrivateKey *privkey, 
  198.       SECItem *pubKeyData,
  199.       char *nickname,
  200.       SECKEYGetPasswordKey f, void *arg,
  201.       SECOidTag algorithm); 
  202. /* Find key by modulus.  This function is the inverse of store key
  203.  * by modulus.  An attempt to locate the key with "modulus" is 
  204.  * performed.  If the key is found, the private key is returned,
  205.  * else NULL is returned.
  206.  *   modulus is the modulus to locate
  207.  */
  208. extern SECKEYLowPrivateKey *
  209. SECKEY_FindKeyByPublicKey(SECKEYKeyDBHandle *handle, SECItem *modulus, 
  210.   SECKEYGetPasswordKey f, void *arg);
  211. /* Make a copy of a low private key in it's own arena.
  212.  * a return of NULL indicates an error.
  213.  */
  214. extern SECKEYLowPrivateKey *
  215. SECKEY_CopyLowPrivateKey(SECKEYLowPrivateKey *privKey);
  216. SEC_END_PROTOS
  217. #endif /* _KEYLOW_H_ */