security/nss/lib/softoken/sftkdbti.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  * Red Hat Inc.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  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 SFTKDBTI_H
  38 #define SFTKDBTI_H 1
  39
  40 /*
  41  * private defines
  42  */
  43 struct SFTKDBHandleStr {
  44     SDB   *db;
  45     PRInt32 ref;
  46     CK_OBJECT_HANDLE  type;
  47     SECItem passwordKey;
  48     SECItem *newKey;
  49     SECItem *oldKey;
  50     SECItem *updatePasswordKey;
  51     PZLock *passwordLock;
  52     SFTKDBHandle *peerDB;
  53     SDB   *update;
  54     char  *updateID;
  55     PRBool updateDBIsInit;
  56 };
  57
  58 #define SFTK_KEYDB_TYPE 0x40000000
  59 #define SFTK_CERTDB_TYPE 0x00000000
  60 #define SFTK_OBJ_TYPE_MASK 0xc0000000
  61 #define SFTK_OBJ_ID_MASK (~SFTK_OBJ_TYPE_MASK)
  62 #define SFTK_TOKEN_TYPE 0x80000000
  63
  64 /* the following is the number of id's to handle on the stack at a time,
  65  * it's not an upper limit of IDS that can be stored in the database */
  66 #define SFTK_MAX_IDS 10
  67
  68 #define SFTK_GET_SDB(handle) \
  69         ((handle)->update ? (handle)->update : (handle)->db)
  70
  71 SECStatus sftkdb_DecryptAttribute(SECItem *passKey, SECItem *cipherText,
  72                         SECItem **plainText);
  73 SECStatus sftkdb_EncryptAttribute(PLArenaPool *arena, SECItem *passKey,
  74                         SECItem *plainText, SECItem **cipherText);
  75 SECStatus sftkdb_SignAttribute(PLArenaPool *arena, SECItem *passKey,
  76                         CK_OBJECT_HANDLE objectID,
  77                         CK_ATTRIBUTE_TYPE attrType,
  78                         SECItem *plainText, SECItem **sigText);
  79 SECStatus sftkdb_VerifyAttribute(SECItem *passKey,
  80                         CK_OBJECT_HANDLE objectID,
  81                         CK_ATTRIBUTE_TYPE attrType,
  82                         SECItem *plainText, SECItem *sigText);
  83
  84 void sftk_ULong2SDBULong(unsigned char *data, CK_ULONG value);
  85 CK_RV sftkdb_Update(SFTKDBHandle *handle, SECItem *key);
  86 CK_RV sftkdb_PutAttributeSignature(SFTKDBHandle *handle,
  87                 SDB *keyTarget, CK_OBJECT_HANDLE objectID,
  88                 CK_ATTRIBUTE_TYPE type, SECItem *signText);
  89
  90
  91
  92 #endif