security/nss/lib/ckfw/dbm/token.c

   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 #ifdef DEBUG
  38 static const char CVS_ID[] = "@(#) $RCSfile: token.c,v $ $Revision: 1.4 $ $Date: 2006/03/02 22:48:54 $";
  39 #endif /* DEBUG */
  40
  41 #include "ckdbm.h"
  42
  43 static CK_RV
  44 nss_dbm_mdToken_Setup
  45 (
  46   NSSCKMDToken *mdToken,
  47   NSSCKFWToken *fwToken,
  48   NSSCKMDInstance *mdInstance,
  49   NSSCKFWInstance *fwInstance
  50 )
  51 {
  52   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
  53   CK_RV rv = CKR_OK;
  54
  55   token->arena = NSSCKFWToken_GetArena(fwToken, &rv);
  56   token->session_db = nss_dbm_db_open(token->arena, fwInstance, (char *)NULL,
  57                                       O_RDWR|O_CREAT, &rv);
  58   if( (nss_dbm_db_t *)NULL == token->session_db ) {
  59     return rv;
  60   }
  61
  62   /* Add a label record if there isn't one? */
  63
  64   return CKR_OK;
  65 }
  66
  67 static void
  68 nss_dbm_mdToken_Invalidate
  69 (
  70   NSSCKMDToken *mdToken,
  71   NSSCKFWToken *fwToken,
  72   NSSCKMDInstance *mdInstance,
  73   NSSCKFWInstance *fwInstance
  74 )
  75 {
  76   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
  77
  78   if( (nss_dbm_db_t *)NULL != token->session_db ) {
  79     nss_dbm_db_close(token->session_db);
  80     token->session_db = (nss_dbm_db_t *)NULL;
  81   }
  82 }
  83
  84 static CK_RV
  85 nss_dbm_mdToken_InitToken
  86 (
  87   NSSCKMDToken *mdToken,
  88   NSSCKFWToken *fwToken,
  89   NSSCKMDInstance *mdInstance,
  90   NSSCKFWInstance *fwInstance,
  91   NSSItem *pin,
  92   NSSUTF8 *label
  93 )
  94 {
  95   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
  96   nss_dbm_instance_t *instance = (nss_dbm_instance_t *)mdInstance->etc;
  97   CK_RV rv;
  98
  99   /* Wipe the session object data */
 100
 101   if( (nss_dbm_db_t *)NULL != token->session_db ) {
 102     nss_dbm_db_close(token->session_db);
 103   }
 104
 105   token->session_db = nss_dbm_db_open(token->arena, fwInstance, (char *)NULL,
 106                                       O_RDWR|O_CREAT, &rv);
 107   if( (nss_dbm_db_t *)NULL == token->session_db ) {
 108     return rv;
 109   }
 110
 111   /* Wipe the token object data */
 112
 113   if( token->slot->flags & O_RDWR ) {
 114     if( (nss_dbm_db_t *)NULL != token->slot->token_db ) {
 115       nss_dbm_db_close(token->slot->token_db);
 116     }
 117
 118     token->slot->token_db = nss_dbm_db_open(instance->arena, fwInstance,
 119                                             token->slot->filename,
 120                                             token->slot->flags | O_CREAT | O_TRUNC,
 121                                             &rv);
 122     if( (nss_dbm_db_t *)NULL == token->slot->token_db ) {
 123       return rv;
 124     }
 125
 126     /* PIN is irrelevant */
 127
 128     rv = nss_dbm_db_set_label(token->slot->token_db, label);
 129     if( CKR_OK != rv ) {
 130       return rv;
 131     }
 132   }
 133
 134   return CKR_OK;
 135 }
 136
 137 static NSSUTF8 *
 138 nss_dbm_mdToken_GetLabel
 139 (
 140   NSSCKMDToken *mdToken,
 141   NSSCKFWToken *fwToken,
 142   NSSCKMDInstance *mdInstance,
 143   NSSCKFWInstance *fwInstance,
 144   CK_RV *pError
 145 )
 146 {
 147   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
 148
 149   if( (NSSUTF8 *)NULL == token->label ) {
 150     token->label = nss_dbm_db_get_label(token->slot->token_db, token->arena, pError);
 151   }
 152
 153   /* If no label has been set, return *something* */
 154   if( (NSSUTF8 *)NULL == token->label ) {
 155     return token->slot->filename;
 156   }
 157
 158   return token->label;
 159 }
 160
 161 static NSSUTF8 *
 162 nss_dbm_mdToken_GetManufacturerID
 163 (
 164   NSSCKMDToken *mdToken,
 165   NSSCKFWToken *fwToken,
 166   NSSCKMDInstance *mdInstance,
 167   NSSCKFWInstance *fwInstance,
 168   CK_RV *pError
 169 )
 170 {
 171   return "mozilla.org NSS";
 172 }
 173
 174 static NSSUTF8 *
 175 nss_dbm_mdToken_GetModel
 176 (
 177   NSSCKMDToken *mdToken,
 178   NSSCKFWToken *fwToken,
 179   NSSCKMDInstance *mdInstance,
 180   NSSCKFWInstance *fwInstance,
 181   CK_RV *pError
 182 )
 183 {
 184   return "dbm";
 185 }
 186
 187 /* GetSerialNumber is irrelevant */
 188 /* GetHasRNG defaults to CK_FALSE */
 189
 190 static CK_BBOOL
 191 nss_dbm_mdToken_GetIsWriteProtected
 192 (
 193   NSSCKMDToken *mdToken,
 194   NSSCKFWToken *fwToken,
 195   NSSCKMDInstance *mdInstance,
 196   NSSCKFWInstance *fwInstance
 197 )
 198 {
 199   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
 200
 201   if( token->slot->flags & O_RDWR ) {
 202     return CK_FALSE;
 203   } else {
 204     return CK_TRUE;
 205   }
 206 }
 207
 208 /* GetLoginRequired defaults to CK_FALSE */
 209 /* GetUserPinInitialized defaults to CK_FALSE */
 210 /* GetRestoreKeyNotNeeded is irrelevant */
 211 /* GetHasClockOnToken defaults to CK_FALSE */
 212 /* GetHasProtectedAuthenticationPath defaults to CK_FALSE */
 213 /* GetSupportsDualCryptoOperations is irrelevant */
 214
 215 static CK_ULONG
 216 nss_dbm_mdToken_effectively_infinite
 217 (
 218   NSSCKMDToken *mdToken,
 219   NSSCKFWToken *fwToken,
 220   NSSCKMDInstance *mdInstance,
 221   NSSCKFWInstance *fwInstance
 222 )
 223 {
 224   return CK_EFFECTIVELY_INFINITE;
 225 }
 226
 227 static CK_VERSION
 228 nss_dbm_mdToken_GetHardwareVersion
 229 (
 230   NSSCKMDToken *mdToken,
 231   NSSCKFWToken *fwToken,
 232   NSSCKMDInstance *mdInstance,
 233   NSSCKFWInstance *fwInstance
 234 )
 235 {
 236   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
 237   return nss_dbm_db_get_format_version(token->slot->token_db);
 238 }
 239
 240 /* GetFirmwareVersion is irrelevant */
 241 /* GetUTCTime is irrelevant */
 242
 243 static NSSCKMDSession *
 244 nss_dbm_mdToken_OpenSession
 245 (
 246   NSSCKMDToken *mdToken,
 247   NSSCKFWToken *fwToken,
 248   NSSCKMDInstance *mdInstance,
 249   NSSCKFWInstance *fwInstance,
 250   NSSCKFWSession *fwSession,
 251   CK_BBOOL rw,
 252   CK_RV *pError
 253 )
 254 {
 255   nss_dbm_token_t *token = (nss_dbm_token_t *)mdToken->etc;
 256   return nss_dbm_mdSession_factory(token, fwSession, fwInstance, rw, pError);
 257 }
 258
 259 /* GetMechanismCount defaults to zero */
 260 /* GetMechanismTypes is irrelevant */
 261 /* GetMechanism is irrelevant */
 262
 263 NSS_IMPLEMENT NSSCKMDToken *
 264 nss_dbm_mdToken_factory
 265 (
 266   nss_dbm_slot_t *slot,
 267   CK_RV *pError
 268 )
 269 {
 270   nss_dbm_token_t *token;
 271   NSSCKMDToken *rv;
 272
 273   token = nss_ZNEW(slot->instance->arena, nss_dbm_token_t);
 274   if( (nss_dbm_token_t *)NULL == token ) {
 275     *pError = CKR_HOST_MEMORY;
 276     return (NSSCKMDToken *)NULL;
 277   }
 278
 279   rv = nss_ZNEW(slot->instance->arena, NSSCKMDToken);
 280   if( (NSSCKMDToken *)NULL == rv ) {
 281     *pError = CKR_HOST_MEMORY;
 282     return (NSSCKMDToken *)NULL;
 283   }
 284
 285   token->slot = slot;
 286
 287   rv->etc = (void *)token;
 288   rv->Setup = nss_dbm_mdToken_Setup;
 289   rv->Invalidate = nss_dbm_mdToken_Invalidate;
 290   rv->InitToken = nss_dbm_mdToken_InitToken;
 291   rv->GetLabel = nss_dbm_mdToken_GetLabel;
 292   rv->GetManufacturerID = nss_dbm_mdToken_GetManufacturerID;
 293   rv->GetModel = nss_dbm_mdToken_GetModel;
 294   /*  GetSerialNumber is irrelevant */
 295   /*  GetHasRNG defaults to CK_FALSE */
 296   rv->GetIsWriteProtected = nss_dbm_mdToken_GetIsWriteProtected;
 297   /*  GetLoginRequired defaults to CK_FALSE */
 298   /*  GetUserPinInitialized defaults to CK_FALSE */
 299   /*  GetRestoreKeyNotNeeded is irrelevant */
 300   /*  GetHasClockOnToken defaults to CK_FALSE */
 301   /*  GetHasProtectedAuthenticationPath defaults to CK_FALSE */
 302   /*  GetSupportsDualCryptoOperations is irrelevant */
 303   rv->GetMaxSessionCount = nss_dbm_mdToken_effectively_infinite;
 304   rv->GetMaxRwSessionCount = nss_dbm_mdToken_effectively_infinite;
 305   /*  GetMaxPinLen is irrelevant */
 306   /*  GetMinPinLen is irrelevant */
 307   /*  GetTotalPublicMemory defaults to CK_UNAVAILABLE_INFORMATION */
 308   /*  GetFreePublicMemory defaults to CK_UNAVAILABLE_INFORMATION */
 309   /*  GetTotalPrivateMemory defaults to CK_UNAVAILABLE_INFORMATION */
 310   /*  GetFreePrivateMemory defaults to CK_UNAVAILABLE_INFORMATION */
 311   rv->GetHardwareVersion = nss_dbm_mdToken_GetHardwareVersion;
 312   /*  GetFirmwareVersion is irrelevant */
 313   /*  GetUTCTime is irrelevant */
 314   rv->OpenSession = nss_dbm_mdToken_OpenSession;
 315   rv->null = NULL;
 316
 317   return rv;
 318 }