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

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. /*
  34.  * Header file for routines specific to S/MIME.  Keep things that are pure
  35.  * pkcs7 out of here; this is for S/MIME policy, S/MIME interoperability, etc.
  36.  *
  37.  * $Id: smime.h,v 1.4 2000/06/20 16:28:57 chrisk%netscape.com Exp $
  38.  */
  39. #ifndef _SECMIME_H_
  40. #define _SECMIME_H_ 1
  41. #include "cms.h"
  42. /************************************************************************/
  43. SEC_BEGIN_PROTOS
  44. /*
  45.  * Initialize the local recording of the user S/MIME cipher preferences.
  46.  * This function is called once for each cipher, the order being
  47.  * important (first call records greatest preference, and so on).
  48.  * When finished, it is called with a "which" of CIPHER_FAMILID_MASK.
  49.  * If the function is called again after that, it is assumed that
  50.  * the preferences are being reset, and the old preferences are
  51.  * discarded.
  52.  *
  53.  * XXX This is for a particular user, and right now the storage is
  54.  * XXX local, static.  The preference should be stored elsewhere to allow
  55.  * XXX for multiple uses of one library?  How does SSL handle this;
  56.  * XXX it has something similar?
  57.  *
  58.  *  - The "which" values are defined in ciferfam.h (the SMIME_* values,
  59.  *    for example SMIME_DES_CBC_56).
  60.  *  - If "on" is non-zero then the named cipher is enabled, otherwise
  61.  *    it is disabled.  (It is not necessary to call the function for
  62.  *    ciphers that are disabled, however, as that is the default.)
  63.  *
  64.  * If the cipher preference is successfully recorded, SECSuccess
  65.  * is returned.  Otherwise SECFailure is returned.  The only errors
  66.  * are due to failure allocating memory or bad parameters/calls:
  67.  * SEC_ERROR_XXX ("which" is not in the S/MIME cipher family)
  68.  * SEC_ERROR_XXX (function is being called more times than there
  69.  * are known/expected ciphers)
  70.  */
  71. extern SECStatus NSS_SMIMEUtil_EnableCipher(long which, int on);
  72. /*
  73.  * Initialize the local recording of the S/MIME policy.
  74.  * This function is called to allow/disallow a particular cipher.
  75.  *
  76.  * XXX This is for a the current module, I think, so local, static storage
  77.  * XXX is okay.  Is that correct, or could multiple uses of the same
  78.  * XXX library expect to operate under different policies?
  79.  *
  80.  *  - The "which" values are defined in ciferfam.h (the SMIME_* values,
  81.  *    for example SMIME_DES_CBC_56).
  82.  *  - If "on" is non-zero then the named cipher is enabled, otherwise
  83.  *    it is disabled.
  84.  */
  85. extern SECStatus NSS_SMIMEUtils_AllowCipher(long which, int on);
  86. /*
  87.  * Does the current policy allow S/MIME decryption of this particular
  88.  * algorithm and keysize?
  89.  */
  90. extern PRBool NSS_SMIMEUtil_DecryptionAllowed(SECAlgorithmID *algid, PK11SymKey *key);
  91. /*
  92.  * Does the current policy allow *any* S/MIME encryption (or decryption)?
  93.  *
  94.  * This tells whether or not *any* S/MIME encryption can be done,
  95.  * according to policy.  Callers may use this to do nicer user interface
  96.  * (say, greying out a checkbox so a user does not even try to encrypt
  97.  * a message when they are not allowed to) or for any reason they want
  98.  * to check whether S/MIME encryption (or decryption, for that matter)
  99.  * may be done.
  100.  *
  101.  * It takes no arguments.  The return value is a simple boolean:
  102.  *   PR_TRUE means encryption (or decryption) is *possible*
  103.  * (but may still fail due to other reasons, like because we cannot
  104.  * find all the necessary certs, etc.; PR_TRUE is *not* a guarantee)
  105.  *   PR_FALSE means encryption (or decryption) is not permitted
  106.  *
  107.  * There are no errors from this routine.
  108.  */
  109. extern PRBool NSS_SMIMEUtil_EncryptionPossible(void);
  110. /*
  111.  * NSS_SMIMEUtil_CreateSMIMECapabilities - get S/MIME capabilities attr value
  112.  *
  113.  * scans the list of allowed and enabled ciphers and construct a PKCS9-compliant
  114.  * S/MIME capabilities attribute value.
  115.  */
  116. extern SECStatus NSS_SMIMEUtil_CreateSMIMECapabilities(PLArenaPool *poolp, SECItem *dest, PRBool includeFortezzaCiphers);
  117. /*
  118.  * NSS_SMIMEUtil_CreateSMIMEEncKeyPrefs - create S/MIME encryption key preferences attr value
  119.  */
  120. extern SECStatus NSS_SMIMEUtil_CreateSMIMEEncKeyPrefs(PLArenaPool *poolp, SECItem *dest, CERTCertificate *cert);
  121. /*
  122.  * NSS_SMIMEUtil_GetCertFromEncryptionKeyPreference - find cert marked by EncryptionKeyPreference
  123.  *          attribute
  124.  */
  125. extern CERTCertificate *NSS_SMIMEUtil_GetCertFromEncryptionKeyPreference(CERTCertDBHandle *certdb, SECItem *DERekp);
  126. /*
  127.  * NSS_SMIMEUtil_FindBulkAlgForRecipients - find bulk algorithm suitable for all recipients
  128.  */
  129. extern SECStatus
  130. NSS_SMIMEUtil_FindBulkAlgForRecipients(CERTCertificate **rcerts, SECOidTag *bulkalgtag, int *keysize);
  131. /************************************************************************/
  132. SEC_END_PROTOS
  133. #endif /* _SECMIME_H_ */