diff --git a/security/nss/lib/softoken/cdbhdl.h b/security/nss/lib/softoken/cdbhdl.h index da70013c1df..04ccb13ca1a 100644 --- a/security/nss/lib/softoken/cdbhdl.h +++ b/security/nss/lib/softoken/cdbhdl.h @@ -34,7 +34,7 @@ * cdbhdl.h - certificate database handle * private to the certdb module * - * $Id: cdbhdl.h,v 1.5 2002-05-16 20:39:00 relyea%netscape.com Exp $ + * $Id: cdbhdl.h,v 1.6 2002-08-28 21:51:07 relyea%netscape.com Exp $ */ #ifndef _CDBHDL_H_ #define _CDBHDL_H_ @@ -67,7 +67,11 @@ typedef DB * (*rdbfunc)(const char *appName, const char *prefix, DB * rdbopen(const char *appName, const char *prefix, const char *type, int flags); +DB *dbsopen (const char *dbname , int flags, int mode, DBTYPE type, + const void * appData); SECStatus db_Copy(DB *dest,DB *src); int db_BeginTransaction(DB *db); int db_FinishTransaction(DB *db, PRBool abort); + + #endif diff --git a/security/nss/lib/softoken/dbmshim.c b/security/nss/lib/softoken/dbmshim.c new file mode 100644 index 00000000000..4754c114070 --- /dev/null +++ b/security/nss/lib/softoken/dbmshim.c @@ -0,0 +1,606 @@ +/* + * 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 Netscape are + * Copyright (C) 1994-2000 Netscape Communications Corporation. All + * Rights Reserved. + * + * Contributor(s): + * + * Alternatively, the contents of this file may be used under the + * terms of the GNU General Public License Version 2 or later (the + * "GPL"), in which case the provisions of the GPL are applicable + * instead of those above. If you wish to allow use of your + * version of this file only under the terms of the GPL and not to + * allow others to use your version of this file under the MPL, + * indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by + * the GPL. If you do not delete the provisions above, a recipient + * may use your version of this file under either the MPL or the + * GPL. + */ + +/* + * Berkeley DB 1.85 Shim code to handle blobs. + * + * $Id: dbmshim.c,v 1.1 2002-08-28 21:51:08 relyea%netscape.com Exp $ + */ +#include "mcom_db.h" +#include "secitem.h" +#include "secder.h" +#include "prprf.h" +#include "cdbhdl.h" + +/* Call to PK11_FreeSlot below */ + +#include "pcertt.h" +#include "secasn1.h" +#include "secerr.h" +#include "base64.h" +#include "sechash.h" + +#include "pkcs11i.h" + +#define DBS_MAX_ENTRY_SIZE (64*1024) /* 64 k */ +#define ROUNDDIV(x,y) (x+(y-1))/y +#define BLOB_NAME_HEAD_LEN 4 +#define BLOB_NAME_LENGTH_START BLOB_NAME_HEAD_LEN +#define BLOB_NAME_LENGTH_LEN 4 +#define BLOB_NAME_START BLOB_NAME_LENGTH_START+BLOB_NAME_LENGTH_LEN +#define BLOB_NAME_LEN 1+ROUNDDIV(SHA1_LENGTH*4,3)+2 +#define BLOB_NAME_BUF_LEN BLOB_NAME_HEAD_LEN+BLOB_NAME_LENGTH_LEN+BLOB_NAME_LEN + +/* a Shim data structure. This data structure has a db built into it. */ +typedef struct DBSStr DBS; + +struct DBSStr { + DB db; + char *blobdir; + int mode; + PRBool readOnly; +}; + + + +/* + * return true if the Datablock contains a blobtype + */ +static PRBool +dbs_IsBlob(DBT *blobData) +{ + unsigned char *addr = (unsigned char *)blobData->data; + if (blobData->size < BLOB_NAME_BUF_LEN) { + return PR_FALSE; + } + return addr && ((certDBEntryType) addr[1] == certDBEntryTypeBlob); +} + +/* + * extract the filename in the blob of the real data set. + * This value is not malloced (does not need to be freed by the caller. + */ +static const char * +dbs_getBlobFileName(DBT *blobData) +{ + char *addr = (char *)blobData->data; + + return &addr[BLOB_NAME_START]; +} + +/* + * extract the size of the actual blob from the blob record + */ +static PRUint32 +dbs_getBlobSize(DBT *blobData) +{ + unsigned char *addr = (unsigned char *)blobData->data; + + return (PRUint32)(addr[BLOB_NAME_LENGTH_START+3] << 24) | + (addr[BLOB_NAME_LENGTH_START+2] << 16) | + (addr[BLOB_NAME_LENGTH_START+1] << 8) | + addr[BLOB_NAME_LENGTH_START]; +} + + +/* We are using base64 data for the filename, but base64 data can include a + * '/' which is interpreted as a path separator on many platforms. Replace it + * with an inocuous '-'. We don't need to convert back because we never actual + * decode the filename. + */ + +static void +dbs_replaceSlash(unsigned char *cp, int len) +{ + while (len--) { + if (*cp == '/') *cp = '-'; + cp++; + } +} + +/* + * create a blob record from a key, data and return it in blobData. + * NOTE: The data element is static data (keeping with the dbm model). + */ +static void +dbs_mkBlob(const DBT *key, const DBT *data, DBT *blobData) +{ + unsigned char sha1_data[SHA1_LENGTH]; + static unsigned char b[BLOB_NAME_BUF_LEN]; + PRUint32 length = data->size; + SECItem sha1Item; + + b[0] = CERT_DB_FILE_VERSION; /* certdb version number */ + b[1] = (unsigned char) certDBEntryTypeBlob; /* type */ + b[2] = 0; /* flags */ + b[3] = 0; /* reserved */ + b[BLOB_NAME_LENGTH_START] = length & 0xff; + b[BLOB_NAME_LENGTH_START+1] = (length >> 8) & 0xff; + b[BLOB_NAME_LENGTH_START+2] = (length >> 16) & 0xff; + b[BLOB_NAME_LENGTH_START+3] = (length >> 24) & 0xff; + sha1Item.data = sha1_data; + sha1Item.len = SHA1_LENGTH; + SHA1_HashBuf(sha1_data,key->data,key->size); + b[BLOB_NAME_START]='b'; /* Make sure we start with a alpha */ + PORT_Memset(&b[BLOB_NAME_START+1],0, BLOB_NAME_LEN-1); + NSSBase64_EncodeItem(NULL,&b[BLOB_NAME_START+1],BLOB_NAME_LEN-1,&sha1Item); + dbs_replaceSlash(&b[BLOB_NAME_START+1],BLOB_NAME_LEN-1); + blobData->data = b; + blobData->size = BLOB_NAME_BUF_LEN; + return; +} + + +/* + * construct a patch to the actual blob. The string returned must be + * freed by the caller with PR_smprintf_free. + * + * Note: this file does lots of consistancy checks on the DBT. The + * routines that call this depend on these checks, so they don't worry + * about them (success of this routine implies a good blobdata record). + */ +static char * +dbs_getBlobFilePath(char *blobdir,DBT *blobData) +{ + const char *name; + + if (blobdir == NULL) { + return NULL; + } + if (!dbs_IsBlob(blobData)) { + return NULL; + } + name = dbs_getBlobFileName(blobData); + if (!name || *name == 0) { + return NULL; + } + return PR_smprintf("%s" PATH_SEPARATOR "%s", blobdir, name); +} + +/* + * Delete a blob file pointed to by the blob record. + */ +static void +dbs_removeBlob(char *blobdir, DBT *blobData) +{ + char *file; + + file = dbs_getBlobFilePath(blobdir, blobData); + if (!file) { + return; + } + PR_Delete(file); + PR_smprintf_free(file); +} + +/* + * Directory modes are slightly different, the 'x' bit needs to be on to + * access them. Copy all the read bits to 'x' bits + */ +static int +dbs_DirMode(int mode) +{ + int x_bits = (mode >> 2) & 0111; + return mode | x_bits; +} + +/* + * write a data blob to it's file. blobdData is the blob record that will be + * stored in the database. data is the actual data to go out on disk. + */ +static int +dbs_writeBlob(char *blobdir, int mode, DBT *blobData, const DBT *data) +{ + char *file = NULL; + PRFileDesc *filed; + PRStatus status; + int len; + int error = 0; + + file = dbs_getBlobFilePath(blobdir, blobData); + if (!file) { + goto loser; + } + if (PR_Access(blobdir, PR_ACCESS_EXISTS) != PR_SUCCESS) { + status = PR_MkDir(blobdir,dbs_DirMode(mode)); + if (status != PR_SUCCESS) { + goto loser; + } + } + filed = PR_OpenFile(file,PR_CREATE_FILE|PR_TRUNCATE|PR_WRONLY, mode); + if (filed == NULL) { + error = PR_GetError(); + goto loser; + } + len = PR_Write(filed,data->data,data->size); + error = PR_GetError(); + PR_Close(filed); + if (len < (int)data->size) { + goto loser; + } + PR_smprintf_free(file); + return 0; + +loser: + if (file) { + PR_Delete(file); + PR_smprintf_free(file); + } + /* don't let close or delete reset the error */ + PR_SetError(error,0); + return -1; +} + + +/* + * we need to keep a address map in memory between calls to DBM. + * remember what we have mapped can close it when we get another dbm + * call. + */ +static PRFileMap *dbs_mapfile = NULL; +static unsigned char *dbs_addr = NULL; +static PRUint32 dbs_len = 0; + +static void +dbs_freemap(void) +{ + if (dbs_mapfile) { + PR_MemUnmap(dbs_addr,dbs_len); + PR_CloseFileMap(dbs_mapfile); + dbs_mapfile = NULL; + dbs_addr = NULL; + dbs_len = 0; + } else if (dbs_addr) { + PORT_Free(dbs_addr); + } + return; +} + +static void +dbs_setmap(PRFileMap *mapfile, unsigned char *addr, PRUint32 len) +{ + dbs_mapfile = mapfile; + dbs_addr = addr; + dbs_len = len; +} + +/* + * platforms that cannot map the file need to read it into a temp buffer. + */ +static unsigned char * +dbs_EmulateMap(PRFileDesc *filed, int len) +{ + unsigned char *addr; + PRInt32 dataRead; + + addr = PORT_Alloc(len); + if (addr == NULL) { + return NULL; + } + + dataRead = PR_Read(filed,addr,len); + if (dataRead != len) { + PORT_Free(addr); + if (dataRead > 0) { + /* PR_Read didn't set an error, we need to */ + PR_SetError(SEC_ERROR_BAD_DATABASE,0); + } + return NULL; + } + + return addr; +} + + +/* + * pull a database record off the disk + * data points to the blob record on input and the real record (if we could + * read it) on output. if there is an error data is not modified. + */ +static int +dbs_readBlob(char *blobdir, DBT *data) +{ + char *file = NULL; + PRFileDesc *filed = NULL; + PRFileMap *mapfile = NULL; + unsigned char *addr = NULL; + int error; + int len; + + file = dbs_getBlobFilePath(blobdir, data); + if (!file) { + goto loser; + } + filed = PR_OpenFile(file,PR_RDONLY,0); + PR_smprintf_free(file); file = NULL; + if (filed == NULL) { + goto loser; + } + + len = dbs_getBlobSize(data); + mapfile = PR_CreateFileMap(filed, len, PR_PROT_READONLY); + if (mapfile == NULL) { + /* USE PR_GetError instead of PORT_GetError here + * because we are getting the error from PR_xxx + * function */ + if (PR_GetError() != PR_NOT_IMPLEMENTED_ERROR) { + goto loser; + } + addr = dbs_EmulateMap(filed, len); + } else { + addr = PR_MemMap(mapfile, 0, len); + } + if (addr == NULL) { + goto loser; + } + PR_Close(filed); + dbs_setmap(mapfile,addr,len); + + data->data = addr; + data->size = len; + return 0; + +loser: + /* preserve the error code */ + error = PR_GetError(); + if (addr) { + PR_MemUnmap(addr,len); + } + if (mapfile) { + PR_CloseFileMap(mapfile); + } + if (filed) { + PR_Close(filed); + } + PR_SetError(error,0); + return -1; +} + +/* + * actual DBM shims + */ +static int +dbs_get(const DB *dbs, const DBT *key, DBT *data, unsigned int flags) +{ + int ret; + DBS *dbsp = (DBS *)dbs; + DB *db = (DB *)dbs->internal; + + + dbs_freemap(); + + ret = (* db->get)(db, key, data, flags); + if ((ret == 0) && dbs_IsBlob(data)) { + ret = dbs_readBlob(dbsp->blobdir,data); + } + + return(ret); +} + +static int +dbs_put(const DB *dbs, DBT *key, const DBT *data, unsigned int flags) +{ + DBT blob; + int ret = 0; + DBS *dbsp = (DBS *)dbs; + DB *db = (DB *)dbs->internal; + + dbs_freemap(); + + /* If the db is readonly, just pass the data down to rdb and let it fail */ + if (!dbsp->readOnly) { + DBT oldData; + int ret1; + + /* make sure the current record is deleted if it's a blob */ + ret1 = (*db->get)(db,key,&oldData,0); + if ((ret1 == 0) && dbs_IsBlob(&oldData)) { + dbs_removeBlob(dbsp->blobdir, &oldData); + } + + if (data->size > DBS_MAX_ENTRY_SIZE) { + dbs_mkBlob(key,data,&blob); + ret = dbs_writeBlob(dbsp->blobdir, dbsp->mode, &blob, data); + data = &blob; + } + } + + if (ret == 0) { + ret = (* db->put)(db, key, data, flags); + } + return(ret); +} + +static int +dbs_sync(const DB *dbs, unsigned int flags) +{ + int ret; + DB *db = (DB *)dbs->internal; + + dbs_freemap(); + + return (* db->sync)(db, flags); +} + +static int +dbs_del(const DB *dbs, const DBT *key, unsigned int flags) +{ + PRStatus prstat; + int ret; + DBS *dbsp = (DBS *)dbs; + DB *db = (DB *)dbs->internal; + + dbs_freemap(); + + if (!dbsp->readOnly) { + DBT oldData; + ret = (*db->get)(db,key,&oldData,0); + if ((ret == 0) && dbs_IsBlob(&oldData)) { + dbs_removeBlob(dbsp->blobdir,&oldData); + } + } + + return (* db->del)(db, key, flags); +} + +static int +dbs_seq(const DB *dbs, DBT *key, DBT *data, unsigned int flags) +{ + PRStatus prstat; + int ret; + DBS *dbsp = (DBS *)dbs; + DB *db = (DB *)dbs->internal; + + dbs_freemap(); + + ret = (* db->seq)(db, key, data, flags); + if ((ret == 0) && dbs_IsBlob(data)) { + /* don't return a blob read as an error so traversals keep going */ + (void) dbs_readBlob(dbsp->blobdir,data); + } + + return(ret); +} + +static int +dbs_close(DB *dbs) +{ + DBS *dbsp = (DBS *)dbs; + DB *db = (DB *)dbs->internal; + int ret; + + ret = (* db->close)(db); + PORT_Free(dbsp->blobdir); + PORT_Free(dbsp); + return ret; +} + +static int +dbs_fd(const DB *dbs) +{ + DB *db = (DB *)dbs->internal; + + return (* db->fd)(db); +} + +/* + * the naming convention we use is + * change the .xxx into .dir. (for nss it's always .db); + * if no .extension exists or is equal to .dir, add a .dir + * the returned data must be freed. + */ +#define DIRSUFFIX ".dir" +static char * +dbs_mkBlobDirName(const char *dbname) +{ + int dbname_len = PORT_Strlen(dbname); + int dbname_end = dbname_len; + const char *cp; + char *blobDir = NULL; + + /* scan back from the end looking for either a directory separator, a '.', + * or the end of the string. NOTE: Windows should check for both separators + * here. For now this is safe because we know NSS always uses a '.' + */ + for (cp = &dbname[dbname_len]; + (cp > dbname) && (*cp != '.') && (*cp != *PATH_SEPARATOR) ; + cp--) + /* Empty */ ; + if (*cp == '.') { + dbname_end = cp - dbname; + if (PORT_Strcmp(cp,DIRSUFFIX) == 0) { + dbname_end = dbname_len; + } + } + blobDir = PORT_ZAlloc(dbname_end+sizeof(DIRSUFFIX)); + if (blobDir == NULL) { + return NULL; + } + PORT_Memcpy(blobDir,dbname,dbname_end); + PORT_Memcpy(&blobDir[dbname_end],DIRSUFFIX,sizeof(DIRSUFFIX)); + return blobDir; +} + +/* + * the open function. NOTE: this is the only exposed function in this file. + * everything else is called through the function table pointer. + */ +DB * +dbsopen(const char *dbname, int flags, int mode, DBTYPE type, + const void *userData) +{ + DB *db = NULL,*dbs = NULL; + DBS *dbsp = NULL; + + + dbsp = (DBS *)PORT_ZAlloc(sizeof(DBS)); + if (!dbsp) { + return NULL; + } + dbs = &dbsp->db; + + dbsp->blobdir=dbs_mkBlobDirName(dbname); + if (dbsp->blobdir == NULL) { + goto loser; + } + dbsp->mode = mode; + dbsp->readOnly = (PRBool)(flags == NO_RDONLY); + + /* the real dbm call */ + db = dbopen(dbname, flags, mode, type, userData); + if (db == NULL) { + goto loser; + } + dbs->internal = (void *) db; + dbs->type = type; + dbs->close = dbs_close; + dbs->get = dbs_get; + dbs->del = dbs_del; + dbs->put = dbs_put; + dbs->seq = dbs_seq; + dbs->sync = dbs_sync; + dbs->fd = dbs_fd; + + return dbs; +loser: + if (db) { + (*db->close)(db); + } + if (dbsp && dbsp->blobdir) { + PORT_Free(dbsp->blobdir); + } + if (dbsp) { + PORT_Free(dbsp); + } + return NULL; +} diff --git a/security/nss/lib/softoken/keydb.c b/security/nss/lib/softoken/keydb.c index 26d6db1a909..1d96cdfd484 100644 --- a/security/nss/lib/softoken/keydb.c +++ b/security/nss/lib/softoken/keydb.c @@ -32,7 +32,7 @@ * * Private Key Database code * - * $Id: keydb.c,v 1.26 2002-08-08 18:02:34 relyea%netscape.com Exp $ + * $Id: keydb.c,v 1.27 2002-08-28 21:51:08 relyea%netscape.com Exp $ */ #include "lowkeyi.h" @@ -844,7 +844,7 @@ openNewDB(const char *appName, const char *prefix, const char *dbname, if (appName) { handle->db = rdbopen( appName, prefix, "key", NO_CREATE); } else { - handle->db = dbopen( dbname, NO_CREATE, 0600, DB_HASH, 0 ); + handle->db = dbsopen( dbname, NO_CREATE, 0600, DB_HASH, 0 ); } /* if create fails then we lose */ if ( handle->db == NULL ) { @@ -963,7 +963,7 @@ nsslowkey_OpenKeyDB(PRBool readOnly, const char *appName, const char *prefix, if (appName) { handle->db = rdbopen( appName, prefix, "key", openflags); } else { - handle->db = dbopen( dbname, openflags, 0600, DB_HASH, 0 ); + handle->db = dbsopen( dbname, openflags, 0600, DB_HASH, 0 ); } /* check for correct version number */ @@ -2430,7 +2430,7 @@ nsslowkey_ResetKeyDB(NSSLOWKEYDBHandle *handle) if (handle->appname) { handle->db=rdbopen(handle->appname, handle->dbname, "key", NO_CREATE); } else { - handle->db = dbopen( handle->dbname, NO_CREATE, 0600, DB_HASH, 0 ); + handle->db = dbsopen( handle->dbname, NO_CREATE, 0600, DB_HASH, 0 ); } if (handle->db == NULL) { /* set an error code */ diff --git a/security/nss/lib/softoken/manifest.mn b/security/nss/lib/softoken/manifest.mn index 379481a072c..f19bde2055a 100644 --- a/security/nss/lib/softoken/manifest.mn +++ b/security/nss/lib/softoken/manifest.mn @@ -61,6 +61,7 @@ PRIVATE_EXPORTS = \ CSRCS = \ alghmac.c \ dbinit.c \ + dbmshim.c \ fipstest.c \ fipstokn.c \ keydb.c \ diff --git a/security/nss/lib/softoken/pcertdb.c b/security/nss/lib/softoken/pcertdb.c index 55ba363c352..98bf7db331b 100644 --- a/security/nss/lib/softoken/pcertdb.c +++ b/security/nss/lib/softoken/pcertdb.c @@ -34,7 +34,7 @@ /* * Permanent Certificate database handling code * - * $Id: pcertdb.c,v 1.29 2002-08-21 00:09:22 relyea%netscape.com Exp $ + * $Id: pcertdb.c,v 1.30 2002-08-28 21:51:09 relyea%netscape.com Exp $ */ #include "prtime.h" @@ -3755,7 +3755,7 @@ openNewCertDB(const char *appName, const char *prefix, const char *certdbname, if (appName) { handle->permCertDB=rdbopen( appName, prefix, "cert", NO_CREATE); } else { - handle->permCertDB=dbopen(certdbname, NO_CREATE, 0600, DB_HASH, 0); + handle->permCertDB=dbsopen(certdbname, NO_CREATE, 0600, DB_HASH, 0); } /* if create fails then we lose */ @@ -3862,7 +3862,7 @@ nsslowcert_OpenPermCertDB(NSSLOWCERTCertDBHandle *handle, PRBool readOnly, if (appName) { handle->permCertDB = rdbopen( appName, prefix, "cert", openflags); } else { - handle->permCertDB = dbopen( certdbname, openflags, 0600, DB_HASH, 0 ); + handle->permCertDB = dbsopen( certdbname, openflags, 0600, DB_HASH, 0 ); } /* check for correct version number */ diff --git a/security/nss/lib/softoken/pcertt.h b/security/nss/lib/softoken/pcertt.h index a3685f5c0c4..a82f9ae3f35 100644 --- a/security/nss/lib/softoken/pcertt.h +++ b/security/nss/lib/softoken/pcertt.h @@ -33,7 +33,7 @@ /* * certt.h - public data structures for the certificate library * - * $Id: pcertt.h,v 1.8 2002-07-25 03:59:38 wtc%netscape.com Exp $ + * $Id: pcertt.h,v 1.9 2002-08-28 21:51:10 relyea%netscape.com Exp $ */ #ifndef _PCERTT_H_ #define _PCERTT_H_ @@ -48,7 +48,6 @@ #include "prio.h" #include "prmon.h" - /* Non-opaque objects */ typedef struct NSSLOWCERTCertDBHandleStr NSSLOWCERTCertDBHandle; typedef struct NSSLOWCERTCertKeyStr NSSLOWCERTCertKey; @@ -213,7 +212,8 @@ typedef enum { certDBEntryTypeRevocation = 4, certDBEntryTypeKeyRevocation = 5, certDBEntryTypeSMimeProfile = 6, - certDBEntryTypeContentVersion = 7 + certDBEntryTypeContentVersion = 7, + certDBEntryTypeBlob = 8 } certDBEntryType; typedef struct {