security/nss/lib/pki/pkistore.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Netscape security libraries.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 1994-2000
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #ifndef PKISTORE_H
  38 #define PKISTORE_H
  39
  40 #ifdef DEBUG
  41 static const char PKISTORE_CVS_ID[] = "@(#) $RCSfile: pkistore.h,v $ $Revision: 1.10 $ $Date: 2006/08/22 03:30:14 $";
  42 #endif /* DEBUG */
  43
  44 #ifndef NSSPKIT_H
  45 #include "nsspkit.h"
  46 #endif /* NSSPKIT_H */
  47
  48 #ifndef BASE_H
  49 #include "base.h"
  50 #endif /* BASE_H */
  51
  52 PR_BEGIN_EXTERN_C
  53
  54 /*
  55  * PKI Stores
  56  *
  57  * This is a set of routines for managing local stores of PKI objects.
  58  * Currently, the only application is in crypto contexts, where the
  59  * certificate store is used.  In the future, methods should be added
  60  * here for storing local references to keys.
  61  */
  62
  63 /*
  64  * nssCertificateStore
  65  *
  66  * Manages local store of certificate, trust, and S/MIME profile objects.
  67  * Within a crypto context, mappings of cert to trust and cert to S/MIME
  68  * profile are always 1-1.  Therefore, it is reasonable to store all objects
  69  * in a single collection, indexed by the certificate.
  70  */
  71
  72 NSS_EXTERN nssCertificateStore *
  73 nssCertificateStore_Create
  74 (
  75   NSSArena *arenaOpt
  76 );
  77
  78 NSS_EXTERN PRStatus
  79 nssCertificateStore_Destroy
  80 (
  81   nssCertificateStore *store
  82 );
  83
  84 /* Atomic Find cert in store, or add this cert to the store.
  85 ** Ref counts properly maintained.
  86 */
  87 NSS_EXTERN NSSCertificate *
  88 nssCertificateStore_FindOrAdd
  89 (
  90   nssCertificateStore *store,
  91   NSSCertificate *c
  92 );
  93
  94 NSS_EXTERN void
  95 nssCertificateStore_RemoveCertLOCKED
  96 (
  97   nssCertificateStore *store,
  98   NSSCertificate *cert
  99 );
 100
 101 struct nssCertificateStoreTraceStr {
 102     nssCertificateStore* store;
 103     PZLock* lock;
 104     PRBool locked;
 105     PRBool unlocked;
 106 };
 107
 108 typedef struct nssCertificateStoreTraceStr nssCertificateStoreTrace;
 109
 110 static void nssCertificateStore_Check(nssCertificateStoreTrace* a,
 111                                       nssCertificateStoreTrace* b) {
 112     PORT_Assert(a->locked);
 113     PORT_Assert(b->unlocked);
 114
 115     PORT_Assert(!a->unlocked);
 116     PORT_Assert(!b->locked);
 117
 118     PORT_Assert(a->lock == b->lock);
 119     PORT_Assert(a->store == b->store);
 120 }
 121
 122 NSS_EXTERN void
 123 nssCertificateStore_Lock (
 124   nssCertificateStore *store, nssCertificateStoreTrace* out
 125 );
 126
 127 NSS_EXTERN void
 128 nssCertificateStore_Unlock (
 129   nssCertificateStore *store, nssCertificateStoreTrace* in,
 130   nssCertificateStoreTrace* out
 131 );
 132
 133 NSS_EXTERN NSSCertificate **
 134 nssCertificateStore_FindCertificatesBySubject
 135 (
 136   nssCertificateStore *store,
 137   NSSDER *subject,
 138   NSSCertificate *rvOpt[],
 139   PRUint32 maximumOpt,
 140   NSSArena *arenaOpt
 141 );
 142
 143 NSS_EXTERN NSSCertificate **
 144 nssCertificateStore_FindCertificatesByNickname
 145 (
 146   nssCertificateStore *store,
 147   NSSUTF8 *nickname,
 148   NSSCertificate *rvOpt[],
 149   PRUint32 maximumOpt,
 150   NSSArena *arenaOpt
 151 );
 152
 153 NSS_EXTERN NSSCertificate **
 154 nssCertificateStore_FindCertificatesByEmail
 155 (
 156   nssCertificateStore *store,
 157   NSSASCII7 *email,
 158   NSSCertificate *rvOpt[],
 159   PRUint32 maximumOpt,
 160   NSSArena *arenaOpt
 161 );
 162
 163 NSS_EXTERN NSSCertificate *
 164 nssCertificateStore_FindCertificateByIssuerAndSerialNumber
 165 (
 166   nssCertificateStore *store,
 167   NSSDER *issuer,
 168   NSSDER *serial
 169 );
 170
 171 NSS_EXTERN NSSCertificate *
 172 nssCertificateStore_FindCertificateByEncodedCertificate
 173 (
 174   nssCertificateStore *store,
 175   NSSDER *encoding
 176 );
 177
 178 NSS_EXTERN PRStatus
 179 nssCertificateStore_AddTrust
 180 (
 181   nssCertificateStore *store,
 182   NSSTrust *trust
 183 );
 184
 185 NSS_EXTERN NSSTrust *
 186 nssCertificateStore_FindTrustForCertificate
 187 (
 188   nssCertificateStore *store,
 189   NSSCertificate *cert
 190 );
 191
 192 NSS_EXTERN PRStatus
 193 nssCertificateStore_AddSMIMEProfile
 194 (
 195   nssCertificateStore *store,
 196   nssSMIMEProfile *profile
 197 );
 198
 199 NSS_EXTERN nssSMIMEProfile *
 200 nssCertificateStore_FindSMIMEProfileForCertificate
 201 (
 202   nssCertificateStore *store,
 203   NSSCertificate *cert
 204 );
 205
 206 NSS_EXTERN void
 207 nssCertificateStore_DumpStoreInfo
 208 (
 209   nssCertificateStore *store,
 210   void (* cert_dump_iter)(const void *, void *, void *),
 211   void *arg
 212 );
 213
 214 PR_END_EXTERN_C
 215
 216 #endif /* PKISTORE_H */