security/nss/lib/crmf/cmmfit.h

   1 /* -*- Mode: C; tab-width: 8 -*-*/
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Netscape security libraries.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1994-2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _CMMFIT_H_
  39 #define _CMMFIT_H_
  40
  41 /*
  42  * All fields marked by a PKIStausInfo in comments is an integer
  43  * with the following possible values.
  44  *
  45  *  Integer Value          Meaning
  46  *  -------------          -------
  47  *         0               granted- got exactly what you asked for.
  48  *
  49  *         1               grantedWithMods-got something like what you asked
  50  *                          for;requester is responsible for ascertainging the
  51  *                          differences.
  52  *
  53  *         2               rejection-you don't get what you asked for; more
  54  *                          information elsewhere in the message
  55  *
  56  *         3               waiting-the request body part has not yet been
  57  *                          processed, expect to hear more later.
  58  *
  59  *         4               revocationWarning-this message contains a warning
  60  *                          that a revocation is imminent.
  61  *
  62  *         5               revocationNotification-notification that a
  63  *                          revocation has occurred.
  64  *
  65  *         6               keyUpdateWarning-update already done for the
  66  *                          oldCertId specified in FullCertTemplate.
  67  */
  68
  69 struct CMMFPKIStatusInfoStr {
  70     SECItem status;
  71     SECItem statusString;
  72     SECItem failInfo;
  73 };
  74
  75 struct CMMFCertOrEncCertStr {
  76     union {
  77         CERTCertificate    *certificate;
  78         CRMFEncryptedValue *encryptedCert;
  79     } cert;
  80     CMMFCertOrEncCertChoice choice;
  81     SECItem                 derValue;
  82 };
  83
  84 struct CMMFCertifiedKeyPairStr {
  85     CMMFCertOrEncCert   certOrEncCert;
  86     CRMFEncryptedValue *privateKey;
  87     SECItem             derPublicationInfo; /* We aren't creating
  88                                              * PKIPublicationInfo's, so
  89                                              * we'll store away the der
  90                                              * here if we decode one that
  91                                              * does have pubInfo.
  92                                              */
  93     SECItem unwrappedPrivKey;
  94 };
  95
  96 struct CMMFCertResponseStr {
  97     SECItem               certReqId;
  98     CMMFPKIStatusInfo     status; /*PKIStatusInfo*/
  99     CMMFCertifiedKeyPair *certifiedKeyPair;
 100 };
 101
 102 struct CMMFCertRepContentStr {
 103     CERTCertificate  **caPubs;
 104     CMMFCertResponse **response;
 105     PRArenaPool       *poolp;
 106     PRBool             isDecoded;
 107 };
 108
 109 struct CMMFChallengeStr {
 110     SECAlgorithmID  *owf;
 111     SECItem          witness;
 112     SECItem          senderDER;
 113     SECItem          key;
 114     SECItem          challenge;
 115     SECItem          randomNumber;
 116 };
 117
 118 struct CMMFRandStr {
 119     SECItem          integer;
 120     SECItem          senderHash;
 121     CERTGeneralName *sender;
 122 };
 123
 124 struct CMMFPOPODecKeyChallContentStr {
 125     CMMFChallenge **challenges;
 126     PRArenaPool    *poolp;
 127     int             numChallenges;
 128     int             numAllocated;
 129 };
 130
 131 struct CMMFPOPODecKeyRespContentStr {
 132     SECItem     **responses;
 133     PRArenaPool  *poolp;
 134 };
 135
 136 struct CMMFKeyRecRepContentStr {
 137     CMMFPKIStatusInfo      status; /* PKIStatusInfo */
 138     CERTCertificate       *newSigCert;
 139     CERTCertificate      **caCerts;
 140     CMMFCertifiedKeyPair **keyPairHist;
 141     PRArenaPool           *poolp;
 142     int                    numKeyPairs;
 143     int                    allocKeyPairs;
 144     PRBool                 isDecoded;
 145 };
 146
 147 #endif /* _CMMFIT_H_ */
 148