security/nss/lib/softoken/legacydb/keydbi.h

   1 /*
   2  * private.h - Private data structures for the software token library
   3  *
   4  * ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is the Netscape security libraries.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1994-2000
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39 /* $Id: keydbi.h,v 1.2 2007/06/13 00:24:57 rrelyea%redhat.com Exp $ */
  40
  41 #ifndef _KEYDBI_H_
  42 #define _KEYDBI_H_
  43
  44 #include "nspr.h"
  45 #include "seccomon.h"
  46 #include "mcom_db.h"
  47
  48 /*
  49  * Handle structure for open key databases
  50  */
  51 struct NSSLOWKEYDBHandleStr {
  52     DB *db;
  53     DB *updatedb;               /* used when updating an old version */
  54     SECItem *global_salt;       /* password hashing salt for this db */
  55     int version;                /* version of the database */
  56     char *appname;              /* multiaccess app name */
  57     char *dbname;               /* name of the openned DB */
  58     PRBool readOnly;            /* is the DB read only */
  59     PRLock *lock;
  60     PRInt32 ref;                /* reference count */
  61 };
  62
  63 /*
  64 ** Typedef for callback for traversing key database.
  65 **      "key" is the key used to index the data in the database (nickname)
  66 **      "data" is the key data
  67 **      "pdata" is the user's data
  68 */
  69 typedef SECStatus (* NSSLOWKEYTraverseKeysFunc)(DBT *key, DBT *data, void *pdata);
  70
  71
  72 SEC_BEGIN_PROTOS
  73
  74 /*
  75 ** Traverse the entire key database, and pass the nicknames and keys to a
  76 ** user supplied function.
  77 **      "f" is the user function to call for each key
  78 **      "udata" is the user's data, which is passed through to "f"
  79 */
  80 extern SECStatus nsslowkey_TraverseKeys(NSSLOWKEYDBHandle *handle,
  81                                 NSSLOWKEYTraverseKeysFunc f,
  82                                 void *udata);
  83
  84 SEC_END_PROTOS
  85
  86 #endif /* _KEYDBI_H_ */