зеркало из https://github.com/mozilla/pjs.git
396 строки
15 KiB
C
396 строки
15 KiB
C
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is the Netscape security libraries.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1994-2000
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
/*
|
|
* certi.h - private data structures for the certificate library
|
|
*
|
|
* $Id: certi.h,v 1.31 2009/07/31 18:35:30 christophe.ravel.bugs%sun.com Exp $
|
|
*/
|
|
#ifndef _CERTI_H_
|
|
#define _CERTI_H_
|
|
|
|
#include "certt.h"
|
|
#include "nssrwlkt.h"
|
|
|
|
/*
|
|
#define GLOBAL_RWLOCK 1
|
|
*/
|
|
|
|
#define DPC_RWLOCK 1
|
|
|
|
/* all definitions in this file are subject to change */
|
|
|
|
typedef struct OpaqueCRLFieldsStr OpaqueCRLFields;
|
|
typedef struct CRLEntryCacheStr CRLEntryCache;
|
|
typedef struct CRLDPCacheStr CRLDPCache;
|
|
typedef struct CRLIssuerCacheStr CRLIssuerCache;
|
|
typedef struct CRLCacheStr CRLCache;
|
|
typedef struct CachedCrlStr CachedCrl;
|
|
typedef struct NamedCRLCacheStr NamedCRLCache;
|
|
typedef struct NamedCRLCacheEntryStr NamedCRLCacheEntry;
|
|
|
|
struct OpaqueCRLFieldsStr {
|
|
PRBool partial;
|
|
PRBool decodingError;
|
|
PRBool badEntries;
|
|
PRBool badDER;
|
|
PRBool badExtensions;
|
|
PRBool heapDER;
|
|
};
|
|
|
|
typedef struct PreAllocatorStr PreAllocator;
|
|
|
|
struct PreAllocatorStr
|
|
{
|
|
PRSize len;
|
|
void* data;
|
|
PRSize used;
|
|
PRArenaPool* arena;
|
|
PRSize extra;
|
|
};
|
|
|
|
/* CRL entry cache.
|
|
This is the same as an entry plus the next/prev pointers for the hash table
|
|
*/
|
|
|
|
struct CRLEntryCacheStr {
|
|
CERTCrlEntry entry;
|
|
CRLEntryCache *prev, *next;
|
|
};
|
|
|
|
#define CRL_CACHE_INVALID_CRLS 0x0001 /* this state will be set
|
|
if we have CRL objects with an invalid DER or signature. Can be
|
|
cleared if the invalid objects are deleted from the token */
|
|
#define CRL_CACHE_LAST_FETCH_FAILED 0x0002 /* this state will be set
|
|
if the last CRL fetch encountered an error. Can be cleared if a
|
|
new fetch succeeds */
|
|
|
|
#define CRL_CACHE_OUT_OF_MEMORY 0x0004 /* this state will be set
|
|
if we don't have enough memory to build the hash table of entries */
|
|
|
|
typedef enum {
|
|
CRL_OriginToken = 0, /* CRL came from PKCS#11 token */
|
|
CRL_OriginExplicit = 1 /* CRL was explicitly added to the cache, from RAM */
|
|
} CRLOrigin;
|
|
|
|
typedef enum {
|
|
dpcacheNoEntry = 0, /* no entry found for this SN */
|
|
dpcacheFoundEntry = 1, /* entry found for this SN */
|
|
dpcacheCallerError = 2, /* invalid args */
|
|
dpcacheInvalidCacheError = 3, /* CRL in cache may be bad DER */
|
|
/* or unverified */
|
|
dpcacheEmpty = 4, /* no CRL in cache */
|
|
dpcacheLookupError = 5 /* internal error */
|
|
} dpcacheStatus;
|
|
|
|
|
|
struct CachedCrlStr {
|
|
CERTSignedCrl* crl;
|
|
CRLOrigin origin;
|
|
/* hash table of entries. We use a PLHashTable and pre-allocate the
|
|
required amount of memory in one shot, so that our allocator can
|
|
simply pass offsets into it when hashing.
|
|
|
|
This won't work anymore when we support delta CRLs and iCRLs, because
|
|
the size of the hash table will vary over time. At that point, the best
|
|
solution will be to allocate large CRLEntry structures by modifying
|
|
the DER decoding template. The extra space would be for next/prev
|
|
pointers. This would allow entries from different CRLs to be mixed in
|
|
the same hash table.
|
|
*/
|
|
PLHashTable* entries;
|
|
PreAllocator* prebuffer; /* big pre-allocated buffer mentioned above */
|
|
PRBool sigChecked; /* this CRL signature has already been checked */
|
|
PRBool sigValid; /* signature verification status .
|
|
Only meaningful if checked is PR_TRUE . */
|
|
PRBool unbuildable; /* Avoid using assosiated CRL is it fails
|
|
* a decoding step */
|
|
};
|
|
|
|
/* CRL distribution point cache object
|
|
This is a cache of CRL entries for a given distribution point of an issuer
|
|
It is built from a collection of one full and 0 or more delta CRLs.
|
|
*/
|
|
|
|
struct CRLDPCacheStr {
|
|
#ifdef DPC_RWLOCK
|
|
NSSRWLock* lock;
|
|
#else
|
|
PRLock* lock;
|
|
#endif
|
|
CERTCertificate* issuer; /* cert issuer
|
|
XXX there may be multiple issuer certs,
|
|
with different validity dates. Also
|
|
need to deal with SKID/AKID . See
|
|
bugzilla 217387, 233118 */
|
|
SECItem* subject; /* DER of issuer subject */
|
|
SECItem* distributionPoint; /* DER of distribution point. This may be
|
|
NULL when distribution points aren't
|
|
in use (ie. the CA has a single CRL).
|
|
Currently not used. */
|
|
|
|
/* array of full CRLs matching this distribution point */
|
|
PRUint32 ncrls; /* total number of CRLs in crls */
|
|
CachedCrl** crls; /* array of all matching CRLs */
|
|
/* XCRL With iCRLs and multiple DPs, the CRL can be shared accross several
|
|
issuers. In the future, we'll need to globally recycle the CRL in a
|
|
separate list in order to avoid extra lookups, decodes, and copies */
|
|
|
|
/* pointers to good decoded CRLs used to build the cache */
|
|
CachedCrl* selected; /* full CRL selected for use in the cache */
|
|
#if 0
|
|
/* for future use */
|
|
PRInt32 numdeltas; /* number of delta CRLs used for the cache */
|
|
CachedCrl** deltas; /* delta CRLs used for the cache */
|
|
#endif
|
|
/* cache invalidity bitflag */
|
|
PRUint16 invalid; /* this state will be set if either
|
|
CRL_CACHE_INVALID_CRLS or CRL_CACHE_LAST_FETCH_FAILED is set.
|
|
In those cases, all certs are considered revoked as a
|
|
security precaution. The invalid state can only be cleared
|
|
during an update if all error states are cleared */
|
|
PRBool refresh; /* manual refresh from tokens has been forced */
|
|
PRBool mustchoose; /* trigger reselection algorithm, for case when
|
|
RAM CRL objects are dropped from the cache */
|
|
PRTime lastfetch; /* time a CRL token fetch was last performed */
|
|
PRTime lastcheck; /* time CRL token objects were last checked for
|
|
existence */
|
|
};
|
|
|
|
/* CRL issuer cache object
|
|
This object tracks all the distribution point caches for a given issuer.
|
|
XCRL once we support multiple issuing distribution points, this object
|
|
will be a hash table. For now, it just holds the single CRL distribution
|
|
point cache structure.
|
|
*/
|
|
|
|
struct CRLIssuerCacheStr {
|
|
SECItem* subject; /* DER of issuer subject */
|
|
CRLDPCache* dpp;
|
|
#if 0
|
|
/* XCRL for future use.
|
|
We don't need to lock at the moment because we only have one DP,
|
|
which gets created at the same time as this object */
|
|
NSSRWLock* lock;
|
|
CRLDPCache** dps;
|
|
PLHashTable* distributionpoints;
|
|
CERTCertificate* issuer;
|
|
#endif
|
|
};
|
|
|
|
/* CRL revocation cache object
|
|
This object tracks all the issuer caches
|
|
*/
|
|
|
|
struct CRLCacheStr {
|
|
#ifdef GLOBAL_RWLOCK
|
|
NSSRWLock* lock;
|
|
#else
|
|
PRLock* lock;
|
|
#endif
|
|
/* hash table of issuer to CRLIssuerCacheStr,
|
|
indexed by issuer DER subject */
|
|
PLHashTable* issuers;
|
|
};
|
|
|
|
SECStatus InitCRLCache(void);
|
|
SECStatus ShutdownCRLCache(void);
|
|
|
|
/* Returns a pointer to an environment-like string, a series of
|
|
** null-terminated strings, terminated by a zero-length string.
|
|
** This function is intended to be internal to NSS.
|
|
*/
|
|
extern char * cert_GetCertificateEmailAddresses(CERTCertificate *cert);
|
|
|
|
/*
|
|
* These functions are used to map subjectKeyID extension values to certs.
|
|
*/
|
|
SECStatus
|
|
cert_CreateSubjectKeyIDHashTable(void);
|
|
|
|
SECStatus
|
|
cert_AddSubjectKeyIDMapping(SECItem *subjKeyID, CERTCertificate *cert);
|
|
|
|
/*
|
|
* Call this function to remove an entry from the mapping table.
|
|
*/
|
|
SECStatus
|
|
cert_RemoveSubjectKeyIDMapping(SECItem *subjKeyID);
|
|
|
|
SECStatus
|
|
cert_DestroySubjectKeyIDHashTable(void);
|
|
|
|
SECItem*
|
|
cert_FindDERCertBySubjectKeyID(SECItem *subjKeyID);
|
|
|
|
/* return maximum length of AVA value based on its type OID tag. */
|
|
extern int cert_AVAOidTagToMaxLen(SECOidTag tag);
|
|
|
|
/* Make an AVA, allocated from pool, from OID and DER encoded value */
|
|
extern CERTAVA * CERT_CreateAVAFromRaw(PRArenaPool *pool,
|
|
const SECItem * OID, const SECItem * value);
|
|
|
|
/* Make an AVA from binary input specified by SECItem */
|
|
extern CERTAVA * CERT_CreateAVAFromSECItem(PRArenaPool *arena, SECOidTag kind,
|
|
int valueType, SECItem *value);
|
|
|
|
/*
|
|
* get a DPCache object for the given issuer subject and dp
|
|
* Automatically creates the cache object if it doesn't exist yet.
|
|
*/
|
|
SECStatus AcquireDPCache(CERTCertificate* issuer, const SECItem* subject,
|
|
const SECItem* dp, int64 t, void* wincx,
|
|
CRLDPCache** dpcache, PRBool* writeLocked);
|
|
|
|
/* check if a particular SN is in the CRL cache and return its entry */
|
|
dpcacheStatus DPCache_Lookup(CRLDPCache* cache, SECItem* sn,
|
|
CERTCrlEntry** returned);
|
|
|
|
/* release a DPCache object that was previously acquired */
|
|
void ReleaseDPCache(CRLDPCache* dpcache, PRBool writeLocked);
|
|
|
|
/* this function assumes the caller holds a lock on the DPCache */
|
|
SECStatus DPCache_GetAllCRLs(CRLDPCache* dpc, PRArenaPool* arena,
|
|
CERTSignedCrl*** crls, PRUint16* status);
|
|
|
|
/* this function assumes the caller holds a lock on the DPCache */
|
|
SECStatus DPCache_GetCRLEntry(CRLDPCache* cache, PRBool readlocked,
|
|
CERTSignedCrl* crl, SECItem* sn,
|
|
CERTCrlEntry** returned);
|
|
|
|
/*
|
|
* map Stan errors into NSS errors
|
|
* This function examines the stan error stack and automatically sets
|
|
* PORT_SetError(); to the appropriate SEC_ERROR value.
|
|
*/
|
|
void CERT_MapStanError();
|
|
|
|
/* Interface function for libpkix cert validation engine:
|
|
* cert_verify wrapper. */
|
|
SECStatus
|
|
cert_VerifyCertChainPkix(CERTCertificate *cert,
|
|
PRBool checkSig,
|
|
SECCertUsage requiredUsage,
|
|
PRTime time,
|
|
void *wincx,
|
|
CERTVerifyLog *log,
|
|
PRBool *sigError,
|
|
PRBool *revoked);
|
|
|
|
SECStatus cert_InitLocks(void);
|
|
|
|
SECStatus cert_DestroyLocks(void);
|
|
|
|
/*
|
|
* fill in nsCertType field of the cert based on the cert extension
|
|
*/
|
|
extern SECStatus cert_GetCertType(CERTCertificate *cert);
|
|
|
|
/*
|
|
* compute and return the value of nsCertType for cert, but do not
|
|
* update the CERTCertificate.
|
|
*/
|
|
extern PRUint32 cert_ComputeCertType(CERTCertificate *cert);
|
|
|
|
void cert_AddToVerifyLog(CERTVerifyLog *log,CERTCertificate *cert,
|
|
unsigned long errorCode, unsigned int depth,
|
|
void *arg);
|
|
|
|
/* Insert a DER CRL into the CRL cache, and take ownership of it.
|
|
*
|
|
* cert_CacheCRLByGeneralName takes ownership of the memory in crl argument
|
|
* completely. crl must be freeable by SECITEM_FreeItem. It will be freed
|
|
* immediately if it is rejected from the CRL cache, or later during cache
|
|
* updates when a new crl is available, or at shutdown time.
|
|
*
|
|
* canonicalizedName represents the source of the CRL, a GeneralName.
|
|
* The format of the encoding is not restricted, but all callers of
|
|
* cert_CacheCRLByGeneralName and cert_FindCRLByGeneralName must use
|
|
* the same encoding. To facilitate X.500 name matching, a canonicalized
|
|
* encoding of the GeneralName should be used, if available.
|
|
*/
|
|
|
|
SECStatus cert_CacheCRLByGeneralName(CERTCertDBHandle* dbhandle, SECItem* crl,
|
|
const SECItem* canonicalizedName);
|
|
|
|
struct NamedCRLCacheStr {
|
|
PRLock* lock;
|
|
PLHashTable* entries;
|
|
};
|
|
|
|
/* NamedCRLCacheEntryStr is filled in by cert_CacheCRLByGeneralName,
|
|
* and read by cert_FindCRLByGeneralName */
|
|
struct NamedCRLCacheEntryStr {
|
|
SECItem* canonicalizedName;
|
|
SECItem* crl; /* DER, kept only if CRL
|
|
* is successfully cached */
|
|
PRBool inCRLCache;
|
|
PRTime successfulInsertionTime; /* insertion time */
|
|
PRTime lastAttemptTime; /* time of last call to
|
|
cert_CacheCRLByGeneralName with this name */
|
|
PRBool badDER; /* ASN.1 error */
|
|
PRBool dupe; /* matching DER CRL already in CRL cache */
|
|
PRBool unsupported; /* IDP, delta, any other reason */
|
|
};
|
|
|
|
typedef enum {
|
|
certRevocationStatusRevoked = 0,
|
|
certRevocationStatusValid = 1,
|
|
certRevocationStatusUnknown = 2
|
|
} CERTRevocationStatus;
|
|
|
|
/* Returns detailed status of the cert(revStatus variable). Tells if
|
|
* issuer cache has OriginFetchedWithTimeout crl in it. */
|
|
SECStatus
|
|
cert_CheckCertRevocationStatus(CERTCertificate* cert, CERTCertificate* issuer,
|
|
const SECItem* dp, PRTime t, void *wincx,
|
|
CERTRevocationStatus *revStatus,
|
|
CERTCRLEntryReasonCode *revReason);
|
|
|
|
|
|
SECStatus cert_AcquireNamedCRLCache(NamedCRLCache** returned);
|
|
|
|
/* cert_FindCRLByGeneralName must be called only while the named cache is
|
|
* acquired, and the entry is only valid until cache is released.
|
|
*/
|
|
SECStatus cert_FindCRLByGeneralName(NamedCRLCache* ncc,
|
|
const SECItem* canonicalizedName,
|
|
NamedCRLCacheEntry** retEntry);
|
|
|
|
SECStatus cert_ReleaseNamedCRLCache(NamedCRLCache* ncc);
|
|
|
|
#endif /* _CERTI_H_ */
|
|
|