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

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 for pkcs7 types.
  35.  *
  36.  * $Id: pkcs7t.h,v 1.1 2000/03/31 19:16:07 relyea%netscape.com Exp $
  37.  */
  38. #ifndef _PKCS7T_H_
  39. #define _PKCS7T_H_
  40. #include "plarena.h"
  41. #include "seccomon.h"
  42. #include "secoidt.h"
  43. #include "certt.h"
  44. #include "secmodt.h"
  45. /* Opaque objects */
  46. typedef struct SEC_PKCS7DecoderContextStr SEC_PKCS7DecoderContext;
  47. typedef struct SEC_PKCS7EncoderContextStr SEC_PKCS7EncoderContext;
  48. /* Non-opaque objects.  NOTE, though: I want them to be treated as
  49.  * opaque as much as possible.  If I could hide them completely,
  50.  * I would.  (I tried, but ran into trouble that was taking me too
  51.  * much time to get out of.)  I still intend to try to do so.
  52.  * In fact, the only type that "outsiders" should even *name* is
  53.  * SEC_PKCS7ContentInfo, and they should not reference its fields.
  54.  */
  55. /* rjr: PKCS #11 cert handling (pk11cert.c) does use SEC_PKCS7RecipientInfo's.
  56.  * This is because when we search the recipient list for the cert and key we
  57.  * want, we need to invert the order of the loops we used to have. The old
  58.  * loops were:
  59.  *
  60.  *  For each recipient {
  61.  *       find_cert = PK11_Find_AllCert(recipient->issuerSN);
  62.  *       [which unrolls to... ]
  63.  *       For each slot {
  64.  *            Log into slot;
  65.  *            search slot for cert;
  66.  *      }
  67.  *  }
  68.  *
  69.  *  the new loop searchs all the recipients at once on a slot. this allows
  70.  *  PKCS #11 to order slots in such a way that logout slots don't get checked
  71.  *  if we can find the cert on a logged in slot. This eliminates lots of
  72.  *  spurious password prompts when smart cards are installed... so why this
  73.  *  comment? If you make SEC_PKCS7RecipientInfo completely opaque, you need
  74.  *  to provide a non-opaque list of issuerSN's (the only field PKCS#11 needs
  75.  *  and fix up pk11cert.c first. NOTE: Only S/MIME calls this special PKCS #11
  76.  *  function.
  77.  */
  78. typedef struct SEC_PKCS7ContentInfoStr SEC_PKCS7ContentInfo;
  79. typedef struct SEC_PKCS7SignedDataStr SEC_PKCS7SignedData;
  80. typedef struct SEC_PKCS7EncryptedContentInfoStr SEC_PKCS7EncryptedContentInfo;
  81. typedef struct SEC_PKCS7EnvelopedDataStr SEC_PKCS7EnvelopedData;
  82. typedef struct SEC_PKCS7SignedAndEnvelopedDataStr
  83. SEC_PKCS7SignedAndEnvelopedData;
  84. typedef struct SEC_PKCS7SignerInfoStr SEC_PKCS7SignerInfo;
  85. typedef struct SEC_PKCS7RecipientInfoStr SEC_PKCS7RecipientInfo;
  86. typedef struct SEC_PKCS7DigestedDataStr SEC_PKCS7DigestedData;
  87. typedef struct SEC_PKCS7EncryptedDataStr SEC_PKCS7EncryptedData;
  88. typedef struct SEC_PKCS7SMIMEKEAParametersStr SEC_PKCS7SMIMEKEAParameters;
  89. /*
  90.  * The following is not actually a PKCS7 type, but for now it is only
  91.  * used by PKCS7, so we have adopted it.  If someone else *ever* needs
  92.  * it, its name should be changed and it should be moved out of here.
  93.  * Do not dare to use it without doing so!
  94.  */
  95. typedef struct SEC_PKCS7AttributeStr SEC_PKCS7Attribute;
  96. struct SEC_PKCS7ContentInfoStr {
  97.     PRArenaPool *poolp; /* local; not part of encoding */
  98.     PRBool created; /* local; not part of encoding */
  99.     int refCount; /* local; not part of encoding */
  100.     SECOidData *contentTypeTag; /* local; not part of encoding */
  101.     SECKEYGetPasswordKey pwfn; /* local; not part of encoding */
  102.     void *pwfn_arg; /* local; not part of encoding */
  103.     SECItem contentType;
  104.     union {
  105. SECItem *data;
  106. SEC_PKCS7DigestedData *digestedData;
  107. SEC_PKCS7EncryptedData *encryptedData;
  108. SEC_PKCS7EnvelopedData *envelopedData;
  109. SEC_PKCS7SignedData *signedData;
  110. SEC_PKCS7SignedAndEnvelopedData *signedAndEnvelopedData;
  111.     } content;
  112. };
  113. struct SEC_PKCS7SignedDataStr {
  114.     SECItem version;
  115.     SECAlgorithmID **digestAlgorithms;
  116.     SEC_PKCS7ContentInfo contentInfo;
  117.     SECItem **rawCerts;
  118.     CERTSignedCrl **crls;
  119.     SEC_PKCS7SignerInfo **signerInfos;
  120.     SECItem **digests; /* local; not part of encoding */
  121.     CERTCertificate **certs; /* local; not part of encoding */
  122.     CERTCertificateList **certLists; /* local; not part of encoding */
  123. };
  124. #define SEC_PKCS7_SIGNED_DATA_VERSION 1 /* what we *create* */
  125. struct SEC_PKCS7EncryptedContentInfoStr {
  126.     SECOidData *contentTypeTag; /* local; not part of encoding */
  127.     SECItem contentType;
  128.     SECAlgorithmID contentEncAlg;
  129.     SECItem encContent;
  130.     SECItem plainContent; /* local; not part of encoding */
  131. /* bytes not encrypted, but encoded */
  132.     int keysize; /* local; not part of encoding */
  133. /* size of bulk encryption key
  134.  * (only used by creation code) */
  135.     SECOidTag encalg; /* local; not part of encoding */
  136. /* oid tag of encryption algorithm
  137.  * (only used by creation code) */
  138. };
  139. struct SEC_PKCS7EnvelopedDataStr {
  140.     SECItem version;
  141.     SEC_PKCS7RecipientInfo **recipientInfos;
  142.     SEC_PKCS7EncryptedContentInfo encContentInfo;
  143. };
  144. #define SEC_PKCS7_ENVELOPED_DATA_VERSION 0 /* what we *create* */
  145. struct SEC_PKCS7SignedAndEnvelopedDataStr {
  146.     SECItem version;
  147.     SEC_PKCS7RecipientInfo **recipientInfos;
  148.     SECAlgorithmID **digestAlgorithms;
  149.     SEC_PKCS7EncryptedContentInfo encContentInfo;
  150.     SECItem **rawCerts;
  151.     CERTSignedCrl **crls;
  152.     SEC_PKCS7SignerInfo **signerInfos;
  153.     SECItem **digests; /* local; not part of encoding */
  154.     CERTCertificate **certs; /* local; not part of encoding */
  155.     CERTCertificateList **certLists; /* local; not part of encoding */
  156.     PK11SymKey *sigKey; /* local; not part of encoding */
  157. };
  158. #define SEC_PKCS7_SIGNED_AND_ENVELOPED_DATA_VERSION 1 /* what we *create* */
  159. struct SEC_PKCS7SignerInfoStr {
  160.     SECItem version;
  161.     CERTIssuerAndSN *issuerAndSN;
  162.     SECAlgorithmID digestAlg;
  163.     SEC_PKCS7Attribute **authAttr;
  164.     SECAlgorithmID digestEncAlg;
  165.     SECItem encDigest;
  166.     SEC_PKCS7Attribute **unAuthAttr;
  167.     CERTCertificate *cert; /* local; not part of encoding */
  168.     CERTCertificateList *certList; /* local; not part of encoding */
  169. };
  170. #define SEC_PKCS7_SIGNER_INFO_VERSION 1 /* what we *create* */
  171. struct SEC_PKCS7RecipientInfoStr {
  172.     SECItem version;
  173.     CERTIssuerAndSN *issuerAndSN;
  174.     SECAlgorithmID keyEncAlg;
  175.     SECItem encKey;
  176.     CERTCertificate *cert; /* local; not part of encoding */
  177. };
  178. #define SEC_PKCS7_RECIPIENT_INFO_VERSION 0 /* what we *create* */
  179. struct SEC_PKCS7DigestedDataStr {
  180.     SECItem version;
  181.     SECAlgorithmID digestAlg;
  182.     SEC_PKCS7ContentInfo contentInfo;
  183.     SECItem digest;
  184. };
  185. #define SEC_PKCS7_DIGESTED_DATA_VERSION 0 /* what we *create* */
  186. struct SEC_PKCS7EncryptedDataStr {
  187.     SECItem version;
  188.     SEC_PKCS7EncryptedContentInfo encContentInfo;
  189. };
  190. #define SEC_PKCS7_ENCRYPTED_DATA_VERSION 0 /* what we *create* */
  191. /*
  192.  * See comment above about this type not really belonging to PKCS7.
  193.  */
  194. struct SEC_PKCS7AttributeStr {
  195.     /* The following fields make up an encoded Attribute: */
  196.     SECItem type;
  197.     SECItem **values; /* data may or may not be encoded */
  198.     /* The following fields are not part of an encoded Attribute: */
  199.     SECOidData *typeTag;
  200.     PRBool encoded; /* when true, values are encoded */
  201. };
  202. /* An enumerated type used to select templates based on the encryption
  203.    scenario and data specifics. */
  204. typedef enum
  205. {
  206. SECKEAUsesSkipjack,
  207. SECKEAUsesNonSkipjack,
  208. SECKEAUsesNonSkipjackWithPaddedEncKey
  209. } SECKEATemplateSelector;
  210. /* ### mwelch - S/MIME KEA parameters. These don't really fit here,
  211.                 but I cannot think of a more appropriate place at this time. */
  212. struct SEC_PKCS7SMIMEKEAParametersStr {
  213. SECItem originatorKEAKey; /* sender KEA key (encrypted?) */
  214. SECItem originatorRA; /* random number generated by sender */
  215. SECItem nonSkipjackIV; /* init'n vector for SkipjackCBC64
  216.    decryption of KEA key if Skipjack
  217.    is not the bulk algorithm used on
  218.    the message */
  219. SECItem bulkKeySize; /* if Skipjack is not the bulk
  220.    algorithm used on the message,
  221.    and the size of the bulk encryption
  222.    key is not the same as that of
  223.    originatorKEAKey (due to padding
  224.    perhaps), this field will contain
  225.    the real size of the bulk encryption
  226.    key. */
  227. };
  228. /*
  229.  * Type of function passed to SEC_PKCS7Decode or SEC_PKCS7DecoderStart.
  230.  * If specified, this is where the content bytes (only) will be "sent"
  231.  * as they are recovered during the decoding.
  232.  *
  233.  * XXX Should just combine this with SEC_PKCS7EncoderContentCallback type
  234.  * and use a simpler, common name.
  235.  */
  236. typedef void (* SEC_PKCS7DecoderContentCallback)(void *arg,
  237.  const char *buf,
  238.  unsigned long len);
  239. /*
  240.  * Type of function passed to SEC_PKCS7Encode or SEC_PKCS7EncoderStart.
  241.  * This is where the encoded bytes will be "sent".
  242.  *
  243.  * XXX Should just combine this with SEC_PKCS7DecoderContentCallback type
  244.  * and use a simpler, common name.
  245.  */
  246. typedef void (* SEC_PKCS7EncoderOutputCallback)(void *arg,
  247. const char *buf,
  248. unsigned long len);
  249. /*
  250.  * Type of function passed to SEC_PKCS7Decode or SEC_PKCS7DecoderStart
  251.  * to retrieve the decryption key.  This function is inteded to be
  252.  * used for EncryptedData content info's which do not have a key available
  253.  * in a certificate, etc.
  254.  */
  255. typedef PK11SymKey * (* SEC_PKCS7GetDecryptKeyCallback)(void *arg, 
  256. SECAlgorithmID *algid);
  257. /* 
  258.  * Type of function passed to SEC_PKCS7Decode or SEC_PKCS7DecoderStart.
  259.  * This function in intended to be used to verify that decrypting a
  260.  * particular crypto algorithm is allowed.  Content types which do not
  261.  * require decryption will not need the callback.  If the callback
  262.  * is not specified for content types which require decryption, the
  263.  * decryption will be disallowed.
  264.  */
  265. typedef PRBool (* SEC_PKCS7DecryptionAllowedCallback)(SECAlgorithmID *algid,  
  266.       PK11SymKey *bulkkey);
  267. #endif /* _PKCS7T_H_ */