sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // RDbPropsFactory class - "DBMS Security" related - full security support
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <f32file.h>
sl@0: #include "D32DRVR.H"
sl@0: #include "U32STD.H"
sl@0: #include "D32Strings.h"
sl@0: #include "Sd_DbProps.h"
sl@0: #include "Sd_DbList.h"
sl@0: 
sl@0: using namespace DBSC;
sl@0: 
sl@0: /**
sl@0: Utility method, which can be used separately to remove the common part of a secure
sl@0: shared database name. The input string format is:
sl@0: "DBS_UID_<DbName>". 
sl@0: The output string format is:
sl@0: "<DbName>". 
sl@0: @param aDbName An output/input parameter. Th input format is: "DBS_UID_<DbName>".
sl@0:                The output format is: "<DbName>". 
sl@0: @panic The method will panic in debug builds in case of a bad input string.
sl@0: */
sl@0: void RDbPropsFactory::StripCommonPart(TDes& aDbName)
sl@0: 	{
sl@0: 	TInt pos = aDbName.FindF(KDbsPrefix);
sl@0: 	__ASSERT_DEBUG(pos != KErrNotFound, User::Invariant());
sl@0: 	aDbName.Delete(pos, KDbsPrefix().Length());
sl@0: 	//Remove the UID from the string
sl@0: 	TInt pos_b = aDbName.Locate('_');
sl@0: 	
sl@0: 	TPtrC right = aDbName.Mid(pos_b+1);
sl@0: 	TInt pos_e = right.Locate('_') + pos_b + 1;
sl@0: 	
sl@0: 	__ASSERT_DEBUG(pos_b != KErrNotFound && pos_e != KErrNotFound, User::Invariant());
sl@0: 	aDbName.Delete(pos_b, pos_e - pos_b + 1);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Utility method, which can be used separately to construct the common part of the secure
sl@0: shared database name. The result string format is:
sl@0: "DBS_UID_"
sl@0: @param aPolicyUid Security policy UID.
sl@0: @param aRes An output parameter, referencing the location, where the constructed string will be stored.
sl@0: */
sl@0: void RDbPropsFactory::ConstructCommonPart(TUid aPolicyUid, TDes& aRes)
sl@0: 	{
sl@0: 	aRes.Zero();
sl@0: 	aRes.Append(KDbsPrefix);
sl@0: 	aRes.Append('_');
sl@0: 	aRes.AppendNumFixedWidthUC(aPolicyUid.iUid, EHex, 8);
sl@0: 	aRes.Append('_');
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard factory method for TDbProps instances.
sl@0: The created TDbProps instance will be pushed in the cleanup stack.
sl@0: @return A pointer to the created TDbProps instance.
sl@0: @leave KErrNoMemory
sl@0: @internalComponent
sl@0: */
sl@0: static TDbProps* NewDbPropsLC()
sl@0: 	{
sl@0: 	TDbProps* dbProps = new (ELeave) TDbProps;
sl@0: 	CleanupStack::PushL(dbProps);
sl@0: 	return dbProps;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Extracts the drive number from the supplied TParse instance.
sl@0: @param aFileNameParser A reference to TParse instance, which will be used to extract the 
sl@0: drive number.
sl@0: @return Extracted TDriveNumber value.
sl@0: @leave KErrArgument aFileNameParser parameter does not contain a drive number or it cannot
sl@0: 					be constructed from the string.
sl@0: @internalComponent
sl@0: */
sl@0: static TDriveNumber ExtractDriveNumberL(TParse& aFileNameParser)
sl@0: 	{
sl@0: 	TPtrC drvPtr = aFileNameParser.Drive();
sl@0: 	if(drvPtr.Length() == 0)
sl@0: 		{
sl@0: 		__LEAVE(KErrArgument);
sl@0: 		}
sl@0: 	TInt drvId = 0;
sl@0: 	__LEAVE_IF_ERROR(RFs::CharToDrive(drvPtr[0], drvId));
sl@0: 	return static_cast <TDriveNumber> (drvId);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates private directory of the DBMS server if it does not exist (on a specific drive).
sl@0: If the supplied aDriveNumber parameter refers to a rom drive, the method does nothing.
sl@0: @param aDriveNumber The drive number, where the private DBMS data directory has to be created.
sl@0: @param aFs A file session instance.
sl@0: @leave RFs::CreatePrivatePath() leave error codes.
sl@0: @internalComponent
sl@0: */
sl@0: static void CreatePrivateDataPathL(TDriveNumber aDriveNumber, RFs& aFs)
sl@0: 	{
sl@0: 	TDriveInfo driveInfo;
sl@0: 	__LEAVE_IF_ERROR(aFs.Drive(driveInfo, aDriveNumber));
sl@0: 	if(driveInfo.iDriveAtt & KDriveAttRom)
sl@0: 		{//ROM drive - do nothing.
sl@0: 		return;
sl@0: 		}
sl@0: 	TInt err = aFs.CreatePrivatePath(aDriveNumber);
sl@0: 	if(err != KErrNone && err != KErrAlreadyExists)
sl@0: 		{
sl@0: 		__LEAVE(err);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: */
sl@0: RDbPropsFactory::RDbPropsFactory(RFs& aFs) :
sl@0: 	iFs(aFs),
sl@0: 	iFileNameParser(NULL),
sl@0: 	iPrivateDataPath(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes RDbPropsFactory instance
sl@0: @leave One of the system wide error codes, including KErrNoMemory.
sl@0: */
sl@0: void RDbPropsFactory::OpenL()
sl@0: 	{
sl@0: 	iFileNameParser = new (ELeave) TParse;
sl@0: 	iPrivateDataPath = HBufC::NewL(KMaxFileName);
sl@0: 	TPtr ptr(iPrivateDataPath->Des());
sl@0: 	__LEAVE_IF_ERROR(iFs.PrivatePath(ptr));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: */
sl@0: void RDbPropsFactory::Close()
sl@0: 	{
sl@0: 	delete iPrivateDataPath;
sl@0: 	delete iFileNameParser;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Extracts database properties from the database path and format string.
sl@0: The created and returned TDbProps instance will be pushed in the cleanup stack.
sl@0: @param aPath Database path.
sl@0: @param aFormatStr database format string.
sl@0: @return A pointer to the created TDbProps instance.
sl@0: @leave One of the system-wide error codes, including KErrNoMemory.
sl@0: */
sl@0: TDbProps* RDbPropsFactory::ExtractLC(const TDesC& aPath, const TDesC& aFormatStr)
sl@0: 	{
sl@0: 	__ASSERT(iFileNameParser);
sl@0: 	__ASSERT(iPrivateDataPath);
sl@0: 
sl@0: 	__LEAVE_IF_ERROR(iFileNameParser->Set(aPath, NULL, NULL));
sl@0: 	TDbProps* dbProps = ::NewDbPropsLC();
sl@0: 
sl@0: 	//TDbProps::iDbsUid.iUid, TDbProps::iDbsUid.iRqAccess
sl@0: 	TPtrC fmtIdent;//fmtIdent may contain KSecure keyword.
sl@0: 	::ExtractUidAndName(aFormatStr, dbProps->iDbPolicyRequest.iUid, fmtIdent);
sl@0: 	dbProps->iDbPolicyRequest.iAccessType = (fmtIdent.CompareF(KSecure) == 0 ? EATSecure : EATNonSecure);
sl@0: 
sl@0: 	//TDbProps::iDriveNumber
sl@0: 	dbProps->iDriveNumber = ::ExtractDriveNumberL(*iFileNameParser);
sl@0: 	::CheckDriveL(iFs, dbProps->iDriveNumber);
sl@0: 
sl@0: 	if(dbProps->iDbPolicyRequest.iAccessType == EATSecure)
sl@0: 		{//requested access to a secure shared database
sl@0: 		ExtractSecureL(aFormatStr, *dbProps);
sl@0: 		}
sl@0: 	else
sl@0: 		{//requested access to a non-secure database
sl@0: 		ExtractNonSecureL(aPath, aFormatStr, *dbProps);
sl@0: 		}
sl@0: 
sl@0: 	return dbProps;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Extracts database properties from the database path, assuming that this is a secure shared
sl@0: database.
sl@0: The created and returned TDbProps instance will be pushed in the cleanup stack.
sl@0: @param aPath Database path.
sl@0: @param aPolicyUid Security policy UID.
sl@0: @return A pointer to the created TDbProps instance.
sl@0: @leave One of the system-wide error codes, including KErrNoMemory.
sl@0: */
sl@0: TDbProps* RDbPropsFactory::ExtractLC(const TDesC& aPath, TUid aPolicyUid)
sl@0: 	{
sl@0: 	TBuf<32> dbFormat;
sl@0: 	dbFormat.Copy(KSecure);
sl@0: 	dbFormat.Append(aPolicyUid.Name());
sl@0: 	return ExtractLC(aPath, dbFormat);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Utility method, which can be used separately to get the common part of the secure
sl@0: shared database full path. The result string format is:
sl@0: "<Drive>:\<PrivatePath>\"
sl@0: @param aDriveNumber A drive number, for which the private data path string has to be constructed.
sl@0: @param aRes An output parameter, referencing the location, where the created private path has to be copied.
sl@0: @leave RFs::DriveToChar() leave error codes
sl@0: */
sl@0: void RDbPropsFactory::GetPrivatePathL(TDriveNumber aDriveNumber, TDes& aRes) const
sl@0: 	{
sl@0: 	aRes.Zero();
sl@0: 	TChar driveChar;
sl@0: 	__LEAVE_IF_ERROR(RFs::DriveToChar(aDriveNumber, driveChar));
sl@0: 	aRes.Append(driveChar);
sl@0: 	aRes.Append(':');
sl@0: 	aRes.Append(*iPrivateDataPath);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Extracts secure shared database properties.
sl@0: @param aFormatStr Secure shared database format string.
sl@0: @param aDbProps An output parameter, referencing the location, where the datapase properties will be stored.
sl@0: @leave KErrArgument Bad format string. Some of the other system-wide error codes.
sl@0: */
sl@0: void RDbPropsFactory::ExtractSecureL(const TDesC& aFormatStr, TDbProps& aDbProps)
sl@0: 	{	
sl@0: 	if(aDbProps.iDbPolicyRequest.iUid == KNullUid)
sl@0: 		{//Secure shared database cannot have null uid.
sl@0: 		__LEAVE(KErrArgument);
sl@0: 		}
sl@0: 	if(iFileNameParser->PathPresent())
sl@0: 		{//The path can contain only the database name.
sl@0: 		__LEAVE(KErrArgument);
sl@0: 		}
sl@0: 	TPtrC dbName = iFileNameParser->NameAndExt();
sl@0: 	if(dbName.Length() > KDbMaxName)
sl@0: 		{//There is a limit for the secure shared database names
sl@0: 		__LEAVE(KErrArgument);
sl@0: 		}
sl@0: 	::CreatePrivateDataPathL(aDbProps.iDriveNumber, iFs);
sl@0: 	ConstructFullDbPathL(aDbProps);
sl@0: 	ConstructFormatString(aDbProps, aFormatStr);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Extracts non-secure database properties.
sl@0: @param aPath Database path.
sl@0: @param aFormatStr Database format string.
sl@0: @param aDbProps An output parameter, referencing the location, where the datapase properties will be stored.
sl@0: @leave KErrPermissionDenied The database path contains the DBMS server private data path.
sl@0: */
sl@0: void RDbPropsFactory::ExtractNonSecureL(const TDesC& aPath, const TDesC& aFormatStr, 
sl@0: 										TDbProps& aDbProps)
sl@0: 	{
sl@0: 	//DBMS private data path cannot be the first in the database path. This is non-secure database.
sl@0: 	TInt pos = aPath.FindF(iPrivateDataPath->Des());
sl@0: 	if(pos != KErrNotFound)
sl@0: 		{//If pos is 2 (pos 0 - drive letter, pos 1 - ':'), then 
sl@0: 		 //the caller wants to create/open non-secure database in the DBMS private directory,
sl@0: 		 //which is not allowed. 
sl@0: 		if(pos == 2)
sl@0: 			{
sl@0: 			__LEAVE(KErrPermissionDenied);
sl@0: 			}
sl@0: 		}
sl@0: 	//The database path and format string stay the same
sl@0: 	aDbProps.iPath.Copy(aPath);
sl@0: 	aDbProps.iFormatStr.Copy(aFormatStr);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the full physical path of the secure shared database
sl@0: @param aDbProps An output parameter, where the database path will be stored.
sl@0: @leave RDbPropsFactory::GetPrivatePathL() leaving error codes
sl@0: @see RDbPropsFactory::GetPrivatePathL()
sl@0: */
sl@0: void RDbPropsFactory::ConstructFullDbPathL(TDbProps& aDbProps)
sl@0: 	{
sl@0: 	GetPrivatePathL(aDbProps.iDriveNumber, aDbProps.iPath);
sl@0: 	TBuf<32> dbNameCmnPart;
sl@0: 	RDbPropsFactory::ConstructCommonPart(aDbProps.iDbPolicyRequest.iUid, dbNameCmnPart);
sl@0: 	aDbProps.iPath.Append(dbNameCmnPart);
sl@0: 	aDbProps.iPath.Append(iFileNameParser->Name());
sl@0: 	aDbProps.iPath.Append(iFileNameParser->Ext());
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Processes the format string of secure shared database. "SECURE" keyword and security policy UID
sl@0: will be removed.
sl@0: @param aDbProps An input/output parameter, referencing TDbProps instance, where the processed
sl@0:                 database format string will be stored.
sl@0: @param aFormatStr The database format string.
sl@0: */
sl@0: void RDbPropsFactory::ConstructFormatString(TDbProps& aDbProps, const TDesC& aFormatStr)
sl@0: 	{
sl@0: 	TDes& fmtStr = aDbProps.iFormatStr;
sl@0: 	fmtStr.Copy(aFormatStr);
sl@0: 	//Remove KSecure keyword from the format string 
sl@0: 	TInt pos = fmtStr.FindF(KSecure);
sl@0: 	__ASSERT_DEBUG(pos != KErrNotFound, User::Invariant());
sl@0: 	fmtStr.Delete(pos, KSecure().Length());
sl@0: 	//Remove the UID from the format string
sl@0: 	TInt pos_b = fmtStr.Locate('[');
sl@0: 	TInt pos_e = fmtStr.Locate(']');
sl@0: 	__ASSERT_DEBUG(pos_b != KErrNotFound && pos_e != KErrNotFound, User::Invariant());
sl@0: 	fmtStr.Delete(pos_b, pos_e - pos_b + 1);
sl@0: 	}