1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/sdbms/Sd_Cli2.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,289 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// DBMS client/server session class - "DBMS security" related - full security support
1.18 +//
1.19 +//
1.20 +
1.21 +#include "SD_STD.H"
1.22 +
1.23 +/**
1.24 +Retrieves a list of names of secure shared databases, which share the same security policy,
1.25 +as determined by the supplied UID.
1.26 +If a database name is longer than KDbMaxName, it will not be added to the list.
1.27 +
1.28 +@param aDrive The drive number to be searched.
1.29 +@param aPolicyUid Database security policy UID.
1.30 +@return A list with names of the found databases, which have the same database security uid.
1.31 + The database name output format is: \<name\>.\<ext\>. The caller is resonsible for deleting
1.32 + the database names list.
1.33 +@leave KErrNoMemory - not enough memory for the operation to be done
1.34 +@leave KErrArgument - invalid UID parameter (including KNullUid value)
1.35 +@leave KErrBadName - invalid drive number (not in A-Z range)
1.36 +@leave KErrNotReady - the drive is not presented in the system
1.37 +@leave Some other system-wide error codes
1.38 +
1.39 +@publishedAll
1.40 +@released
1.41 +*/
1.42 +EXPORT_C CDbDatabaseNames* RDbs::DatabaseNamesL(TDriveNumber aDrive, TUid aPolicyUid)
1.43 + {
1.44 + TIpcArgs args(aDrive, aPolicyUid.iUid);
1.45 + RReadStream in(HDbsBuf::NewLC(*this, EDbsDatabaseList, args));
1.46 + CDbDatabaseNames* dbNames = CDbDatabaseNames::NewLC();
1.47 + in >> *dbNames;
1.48 + CleanupStack::Pop(dbNames);
1.49 + CleanupStack::PopAndDestroy();//HDbsBuf
1.50 + return dbNames;
1.51 + }
1.52 +
1.53 +/**
1.54 +Copies an existing secure shared database to a new secure shared database.
1.55 +The new database will have the same security policy as the old one.
1.56 +The maximum length of the target database name (with the extension) is KDbMaxName.
1.57 +
1.58 +@param aSrcDbName Source database name (\<drive\>:\<name\>.\<ext\> format)
1.59 +@param aDestDbName Destination database name (\<drive\>:\<name\>.\<ext\> format)
1.60 +@param aPolicyUid The database security policy UID. The destination database will have
1.61 + the same policy UID.
1.62 +@return KErrNone if successful, otherwise one of the system-wide error codes, including:
1.63 + KErrPermissionDenied - the caller has not enough rights to do the operation or
1.64 + the destination drive is a ROM drive;
1.65 + KErrArgument - invalid source or destination database names (null name, too long name, only drive letter);
1.66 + invalid or null UID;
1.67 + KErrNotReady - the drive in database name is not presented in the system;
1.68 + KErrNotFound - the source database not found;
1.69 + KErrInUse - the source database is in use;
1.70 + KErrAlreadyExists - the destination database already exists;
1.71 + KErrNoMemory - not enough memory for the operation to be done;
1.72 +
1.73 +@capability Note For a secure shared database, the caller must satisfy the schema
1.74 + access policy for the database.
1.75 +
1.76 +@publishedAll
1.77 +@released
1.78 +*/
1.79 +EXPORT_C TInt RDbs::CopyDatabase(const TDesC& aSrcDbName, const TDesC& aDestDbName, TUid aPolicyUid)
1.80 + {
1.81 + TIpcArgs args(&aSrcDbName, &aDestDbName, aPolicyUid.iUid);
1.82 + return SendReceive(DbsMessage(EDbsCopyDatabase, KDbsSessionHandle), args);
1.83 + }
1.84 +
1.85 +/**
1.86 +Deletes an existing secure shared database.
1.87 +
1.88 +@param aDbName Source database name (\<drive\>:\<name\>.\<ext\> format)
1.89 +@param aPolicyUid Database security policy UID.
1.90 +@return KErrNone if successful, otherwise one of the system-wide error codes, including:
1.91 + KErrInUse (if the database is in use at the moment);
1.92 + KErrNotFound - the database not found;
1.93 + KErrPermissionDenied - the caller has not enough rights to do the operation;
1.94 +
1.95 +@capability Note For a secure shared database, the caller must satisfy the schema
1.96 + access policy for the database.
1.97 +
1.98 +@publishedAll
1.99 +@released
1.100 +*/
1.101 +EXPORT_C TInt RDbs::DeleteDatabase(const TDesC& aDbName, TUid aPolicyUid)
1.102 + {
1.103 + TIpcArgs args(&aDbName, aPolicyUid.iUid);
1.104 + return SendReceive(DbsMessage(EDbsDeleteDatabase, KDbsSessionHandle), args);
1.105 + }
1.106 +
1.107 +/**
1.108 +Returns in aPolicy output parameter requested database/table security policy of type aPolicyType.
1.109 +@param aPolicyUid Database security policy UID
1.110 +@param aTableName Table name.
1.111 +@param aMask Bit-field: it includes ther policy type: EReadPolicy, EWritePolicy, ESchemaPolicy
1.112 + and the request type - database or table.
1.113 +@param aPolicy It will be initialized with the requested security policy data after a successfull call.
1.114 +@return KErrNone if successful, otherwise some of the system-wide error codes, including:
1.115 + KErrArgument - some of the arguments has an invalid value.
1.116 + KErrNotSupported - the method has been called with aMask containing ESchemaPolicy
1.117 + for a table object.
1.118 +
1.119 +@publishedAll
1.120 +@released
1.121 +*/
1.122 +TInt RDbs::GetPolicy(TUid aPolicyUid, const TDesC& aTableName, TUint aMask,
1.123 + TSecurityPolicy& aPolicy)
1.124 + {
1.125 + TBuf8<sizeof(TSecurityPolicy)> spData;
1.126 + TIpcArgs args(aPolicyUid.iUid, aMask, &aTableName, &spData);
1.127 + TInt err = SendReceive(DbsMessage(EDbsGetSecurityPolicy, KDbsSessionHandle), args);
1.128 + if(err == KErrNone)
1.129 + {
1.130 + err = aPolicy.Set(spData);
1.131 + }
1.132 + return err;
1.133 + }
1.134 +
1.135 +/**
1.136 +Returns in the aDbPolicy output parameter the requested database security policy of type aPolicyType.
1.137 +
1.138 +@param aPolicyUid Database security policy UID.
1.139 +@param aPolicyType Policy type: EReadPolicy, EWritePolicy, ESchemaPolicy.
1.140 +@param aDbPolicy It will be initialized with the requested security policy data after a successfull call.
1.141 +@return KErrNone if successful, otherwise one of the system-wide error codes, including
1.142 + KErrArgument - some of the arguments has an invalid value.
1.143 +
1.144 +@publishedAll
1.145 +@released
1.146 +*/
1.147 +EXPORT_C TInt RDbs::GetDatabasePolicy(TUid aPolicyUid, TPolicyType aPolicyType,
1.148 + TSecurityPolicy& aDbPolicy)
1.149 + {
1.150 + return GetPolicy(aPolicyUid, KNullDesC, aPolicyType, aDbPolicy);
1.151 + }
1.152 +
1.153 +/**
1.154 +Returns in the aTablePolicy output parameter the requested table security policy of type aPolicyType.
1.155 +
1.156 +@param aPolicyUid Database security policy UID.
1.157 +@param aTableName Table name.
1.158 +@param aPolicyType Policy type: EReadPolicy, EWritePolicy.
1.159 +@param aTablePolicy It will be initialized with the requested security policy data after a successfull call.
1.160 +@return KErrNone if successful, otherwise one of the system-wide error codes, including:
1.161 + KErrArgument - some of the arguments has an invalid value.
1.162 + KErrNotSupported - the method has been called with aPolicyType = ESchemaPolicy;
1.163 +
1.164 +@publishedAll
1.165 +@released
1.166 +*/
1.167 +EXPORT_C TInt RDbs::GetTablePolicy(TUid aPolicyUid, const TDesC& aTableName, TPolicyType aPolicyType,
1.168 + TSecurityPolicy& aTablePolicy)
1.169 + {
1.170 + return GetPolicy(aPolicyUid, aTableName, aPolicyType | KTablePolicyMaskBit, aTablePolicy);
1.171 + }
1.172 +
1.173 +/**
1.174 +Returns in the aDbPolicy and aTablePolicy output parameters the requested database and table
1.175 +security policies of type aPolicyType.
1.176 +
1.177 +@param aPolicyUid Database security policy UID.
1.178 +@param aTableName Table name.
1.179 +@param aPolicyType Policy type: EReadPolicy, EWritePolicy.
1.180 +@param aDbPolicy It will be initialized with the requested security policy data after a successfull call.
1.181 +@param aTablePolicy It will be initialized with the requested security policy data after a successfull call.
1.182 +@return KErrNone if successful, otherwise one of the system-wide error codes, including:
1.183 + KErrArgument - some of the arguments has an invalid value.
1.184 + KErrNotSupported - the method has been called with aPolicyType = ESchemaPolicy;
1.185 +
1.186 +@publishedAll
1.187 +@released
1.188 +*/
1.189 +EXPORT_C TInt RDbs::GetTablePolicies(TUid aPolicyUid, const TDesC& aTableName, TPolicyType aPolicyType,
1.190 + TSecurityPolicy& aDbPolicy, TSecurityPolicy& aTablePolicy)
1.191 + {
1.192 + TInt err = GetDatabasePolicy(aPolicyUid, aPolicyType, aDbPolicy);
1.193 + if(err == KErrNone)
1.194 + {
1.195 + err = GetTablePolicy(aPolicyUid, aTableName, aPolicyType, aTablePolicy);
1.196 + }
1.197 + return err;
1.198 + }
1.199 +
1.200 +/**
1.201 +The method will fill out aBackupPath argument with the full path of aDbName secure
1.202 +shared database.
1.203 +@param aRequesterSID Security ID of the process which is supposed to backup or restore
1.204 + the database. 0 or ECapability_None are invalid values for
1.205 + aRequesterSID parameter.
1.206 +@param aDbName Secure shared database name, which path will be set in aBackupPath
1.207 + parameter. The name's format is \<drive\>:\<name\>.\<ext\>
1.208 +@param aDbPolicyUid Database security policy UID.
1.209 +@param aBackupPath An output parameter. After a successfull call, the DBMS server
1.210 + will fill out the full database path there. aBackupPath must offer
1.211 + enough space to get the whole database path. Probably the best
1.212 + aBackupPath length is KMaxPath value.
1.213 +@return KErrNone if successful, otherwise one of the system-wide error codes, including:
1.214 + - KErrArgument - 0 or ECapability_None process SID, null UID,
1.215 + null or invalid database name,
1.216 + the database is not secure shared database;
1.217 + - KErrNotFound - the database file does not exist;
1.218 + - KErrPermissionDenied - the supplied process SID does not match the database backup&
1.219 + restore SID or the database backup&restore SID is 0 or ECapability_None.
1.220 +@deprecated
1.221 +*/
1.222 +EXPORT_C TInt RDbs::GetBackupPath(TSecureId aRequesterSID, const TDesC& aDbName,
1.223 + TUid aDbPolicyUid, TDes& aBackupPath)
1.224 + {
1.225 + TIpcArgs args(aRequesterSID.iId, aDbPolicyUid.iUid, &aDbName, &aBackupPath);
1.226 + return SendReceive(DbsMessage(EDbsGetBackupPath, KDbsSessionHandle), args);
1.227 + }
1.228 +
1.229 +/**
1.230 +Retrieves a list of paths of secure shared databases, which share the same security policy,
1.231 +as determined by the supplied aDbPolicyUid parameter.
1.232 +Note: If there is a database file which full path length is bigger than KDbMaxStrLen characters,
1.233 + then this file will not be added to the returned CDbStrings array.
1.234 +
1.235 +@param aRequesterSID Security ID of the process which is supposed to backup or restore
1.236 + the database. 0 and ECapability_None are invalid values for
1.237 + aRequesterSID parameter.
1.238 +@param aDbPolicyUid Database security policy UID.
1.239 +@return A list with paths of the found databases, which have the same database security uid.
1.240 + The caller is resonsible for deleting the database paths list.
1.241 +@leave KErrArgument - 0 or ECapability_None process SID, null database security UID.
1.242 +@leave KErrPermissionDenied - the supplied process SID does not match the database backup&
1.243 + restore SID or the database backup&restore SID is 0 or ECapability_None.
1.244 +@leave Some other system-wide error codes
1.245 +
1.246 +@publishedAll
1.247 +@released
1.248 +*/
1.249 +EXPORT_C CDbStrings* RDbs::BackupPathsL(TSecureId aRequesterSid, TUid aDbPolicyUid)
1.250 + {
1.251 + TIpcArgs args(aRequesterSid.iId, aDbPolicyUid.iUid);
1.252 + RReadStream in(HDbsBuf::NewLC(*this, EDbsGetBackupPaths, args));
1.253 + CDbStrings* dbPaths = CDbStrings::NewLC();
1.254 + in >> *dbPaths;
1.255 + CleanupStack::Pop(dbPaths);
1.256 + CleanupStack::PopAndDestroy();//HDbsBuf
1.257 + return dbPaths;
1.258 + }
1.259 +
1.260 +/**
1.261 +Creates a secure shared database.
1.262 +Max allowed database name length (with the extension) is KDbMaxName symbols.
1.263 +
1.264 +In this "client-server" mode the database can be shared with the other clients.
1.265 +
1.266 +For creating a non-secure database, see RDbNamedDatabase::Create(), which first
1.267 +argument is a RFs reference (or RDbNamedDatabase::Replace()).
1.268 +
1.269 +@param aDbs A reference to DBMS session instance.
1.270 +@param aDatabase Database name. The name format is: \<drive\>:\<name\>.\<ext\>
1.271 +@param aFormat Database format string. The string format is: "SECURE[UID]", where UID
1.272 + is the database security policy UID. "SECURE" keyword is case insensitive.
1.273 +@return KErrNone if successful otherwise one of the system-wide error codes, including:
1.274 + KErrAlreadyExists - the database already exists;
1.275 + KErrNotSupported - invalid format string;
1.276 + KErrArgument - bad argument, including null/invaluid uids, the database name includes a path;
1.277 + KErrPermissionDenied - the caller has not enough rights to do the operation;
1.278 +
1.279 +@capability Note For a secure shared database, the caller must satisfy the schema
1.280 + access policy for the database.
1.281 +
1.282 +@see RDbNamedDatabase::Create(RFs& aFs, const TDesC& aSource, const TDesC& aFormat)
1.283 +@see RDbNamedDatabase::Replace(RFs& aFs, const TDesC& aSource, const TDesC& aFormat)
1.284 +
1.285 +@publishedAll
1.286 +@released
1.287 +*/
1.288 +EXPORT_C TInt RDbNamedDatabase::Create(RDbs& aDbs, const TDesC& aDatabase, const TDesC& aFormat)
1.289 + {
1.290 + TRAPD(r,iDatabase=CDbsSecureDatabase::NewL(aDbs,aDatabase,aFormat));
1.291 + return r;
1.292 + }