/*

* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#include "CKeyDataManager.h"

#include "fsdatatypes.h"

#include "fstokencliserv.h"

#include "fstokenutil.h"

#include "keystorepassphrase.h"

_LIT(KKeyStoreFilename,"keys.dat");

#ifdef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

#include <e32property.h>

#include <authserver/aspubsubdefs.h>

#else

const TInt KDefaultPassphraseTimeout = 30;

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

//	*********************************************************************

//	Key store data manager - maintains array of objects representing keys

//	*********************************************************************

/*static*/ CFileKeyDataManager* CFileKeyDataManager::NewL()

	{

	CFileKeyDataManager* self = new (ELeave) CFileKeyDataManager();

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	return self;

	}

CFileKeyDataManager::~CFileKeyDataManager()

	{

	if (iFileStore)

		{

		CompactStore();

		delete iFileStore;

		}

	iFile.Close(); // May already have been closed by store

	iFs.Close();

	iKeys.ResetAndDestroy();

	iKeys.Close();

	#ifdef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	iIdentityId.Close();

	#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	}

CFileKeyDataManager::CFileKeyDataManager() :

	iRootStreamId(KNullStreamId),

	iInfoStreamId(KNullStreamId)

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	,iPassStreamId(KNullStreamId),

	iTimeoutStreamId(KNullStreamId)

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	{

	}

void CFileKeyDataManager::ConstructL()

	{

	User::LeaveIfError(iFs.Connect());

	OpenStoreL();

	RStoreReadStream lookupStream;

	lookupStream.OpenLC(*iFileStore, iInfoStreamId);

	#ifdef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	User::LeaveIfError(iIdentityId.Attach(	AuthServer::KAuthServerSecureId,

											AuthServer::KUidAuthServerAuthChangeEvent));

	#else

	iPassStreamId = (TStreamId) lookupStream.ReadUint32L();

	iTimeoutStreamId = (TStreamId) lookupStream.ReadUint32L();

	#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	TInt count = lookupStream.ReadInt32L();

	for (TInt index = 0; index < count; index++)

		{

		const CFileKeyData* keyData = CFileKeyData::NewL(lookupStream);

		if (keyData->Handle() > iKeyIdentifier)

			iKeyIdentifier = keyData->Handle();

		iKeys.Append(keyData);

		}

	CleanupStack::PopAndDestroy(&lookupStream);

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	ReadPassphraseTimeoutL();

#endif //SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	}

CPassphraseManager* CFileKeyDataManager::CreatePassphraseManagerLC()

	{

	CPassphraseManager* result = CPassphraseManager::NewL(*iFileStore);

	CleanupStack::PushL(result);

	return result;

	}

void CFileKeyDataManager::OpenStoreL()

	{

	//	Tries to locate a key store file on the default drive and then from ROM

	//	If it cannot find one, tries to create a file with permanent file store

	//	inside it In all cases, should initialise iFileStore unless it cannot

	//	create the file/store/streams

	__ASSERT_DEBUG(!iFileStore, PanicServer(EPanicStoreInitialised));

	TFileName fullPath;

	FileUtils::MakePrivateFilenameL(iFs, KKeyStoreFilename, fullPath);

	FileUtils::EnsurePathL(iFs, fullPath);

	TRAPD(result, OpenStoreInFileL(fullPath));

	if (result == KErrInUse) 

		{		

		// Cannot access the file now. Abort server startup rather than wiping the keystore.

		User::Leave(result); 

		}

	if (result != KErrNone)

		{		

		// Not yet opened a valid store, either no file to be found, or no valid

		// store in it. Copy the original one stored in the ROM.

		delete iFileStore;

		iFileStore = NULL;

		TFileName romPath;

		FileUtils::MakePrivateROMFilenameL(iFs, KKeyStoreFilename, romPath);

		if (result != KErrNotFound)

			{

			// Wipe the keystore if we can't open it (it's corrupt anyway)

			User::LeaveIfError(iFs.Delete(fullPath));

			}

		// Copy data from rom and open it	

		TRAPD(err,

			  FileUtils::CopyL(iFs, romPath, fullPath);

			  OpenStoreInFileL(fullPath)

			);

		if (KErrNone != err)

			{

			// We tried to copy the keystore from ROM. For some reason this

			// failed and we still cannot open the file. Create a new one from

			// scratch.

			CreateStoreInFileL(fullPath);

			}

		}

	__ASSERT_DEBUG(iFileStore, PanicServer(EPanicStoreInitialised));

	__ASSERT_DEBUG((KNullStreamId!=iRootStreamId), PanicServer(EPanicRootStreamNotReady));

	__ASSERT_DEBUG((KNullStreamId!=iInfoStreamId), PanicServer(EPanicManagerStreamNotReady));

	}

void CFileKeyDataManager::CreateStoreInFileL(const TDesC& aFile)

	{

	TInt r = iFs.MkDirAll(aFile);

	if ( (r!=KErrNone) && (r!=KErrAlreadyExists) )

		User::Leave(r);

	iFileStore = CPermanentFileStore::ReplaceL(iFs, aFile, EFileRead | EFileWrite | EFileShareExclusive);

	iFileStore->SetTypeL(KPermanentFileStoreLayoutUid);

	TCleanupItem cleanupStore(RevertStore, iFileStore);

	CleanupStack::PushL(cleanupStore);

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	// Create timeout stream with default timeout

	RStoreWriteStream timeoutStream;

	iTimeoutStreamId = timeoutStream.CreateLC(*iFileStore);

	timeoutStream.WriteUint32L(KDefaultPassphraseTimeout);

	timeoutStream.CommitL();

	CleanupStack::PopAndDestroy(&timeoutStream);

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	// Create info stream - Currently no passphrase created, and no keys

	RStoreWriteStream infoStream;

	iInfoStreamId = infoStream.CreateLC(*iFileStore);

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	infoStream.WriteUint32L(KNullStreamId.Value());

	infoStream.WriteUint32L(iTimeoutStreamId.Value());

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	infoStream.WriteUint32L(0); // Write key count of zero

	infoStream.CommitL();

	CleanupStack::PopAndDestroy(&infoStream);

	// Create root stream - just contains id of info stream

	RStoreWriteStream rootStream;

	iRootStreamId = rootStream.CreateLC(*iFileStore);

	iFileStore->SetRootL(iRootStreamId);

	rootStream.WriteUint32L(iInfoStreamId.Value());		

	rootStream.CommitL();

	CleanupStack::PopAndDestroy(&rootStream);

	WriteKeysToStoreL();

	iFileStore->CommitL();

	CleanupStack::Pop(); // cleanupStore

	}

void CFileKeyDataManager::OpenStoreInFileL(const TDesC& aFile)

	{

	// Make sure the file isn't write protected

	User::LeaveIfError(iFs.SetAtt(aFile, 0, KEntryAttReadOnly));

	User::LeaveIfError(iFile.Open(iFs, aFile, EFileRead | EFileWrite | EFileShareExclusive));

	iFileStore = CPermanentFileStore::FromL(iFile);		

	// Get the salt, root and manager TStreamIds

	iRootStreamId = iFileStore->Root();

	if (iRootStreamId == KNullStreamId)

		{

		User::Leave(KErrCorrupt);

		}

	RStoreReadStream rootStream;

	rootStream.OpenLC(*iFileStore, iRootStreamId);

	iInfoStreamId = (TStreamId)(rootStream.ReadUint32L());

	CleanupStack::PopAndDestroy(&rootStream);

	}

// Methods dealing with atomic updates to key data file ////////////////////////

// This is a cleanup item that reverts the store

void CFileKeyDataManager::RevertStore(TAny* aStore)

{

	CPermanentFileStore* store = reinterpret_cast<CPermanentFileStore*>(aStore);

	TRAP_IGNORE(store->RevertL());

	// We're ignoring the leave code from this becuase there's no way we can

	// handle this sensibly.  This shouldn't be a problem in practice - this

	// will leave if for example the file store is on removable which is

	// unexpectedly remove, and this is never the case for us.

}

// Rewrites the info stream (ie the array of key data info) to the store

void CFileKeyDataManager::WriteKeysToStoreL()

	{

	RStoreWriteStream lookupStream;

	lookupStream.ReplaceLC(*iFileStore, iInfoStreamId);

	#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

		lookupStream.WriteUint32L(iPassStreamId.Value());

		lookupStream.WriteUint32L(iTimeoutStreamId.Value());

	#endif //SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	TInt keyCount = iKeys.Count();

	lookupStream.WriteInt32L(keyCount);

	for (TInt index = 0; index < keyCount; index++)

		{

		const CFileKeyData* key = iKeys[index];

		key->ExternalizeL(lookupStream);

		}

	lookupStream.CommitL();

	CleanupStack::PopAndDestroy(&lookupStream);

	}

/**

 * Add a key to the store.  Assumes that the key data streams (info, public key

 * and private key) have already been written.

 */

void CFileKeyDataManager::AddL(const CFileKeyData* aKeyData)

	{

	ASSERT(aKeyData);

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

		ASSERT(aKeyData->PassphraseStreamId() != KNullStreamId);

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	// Add the key to to the array, rewrite the infostream and 

	// ONLY THEN commit the store

	User::LeaveIfError(iKeys.Append(aKeyData));

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	TStreamId oldDefaultPassphraseId;

	// Set the default passphrase id if this is the first key

	oldDefaultPassphraseId = iPassStreamId;

	if (iKeys.Count() == 1)

		{

		iPassStreamId = aKeyData->PassphraseStreamId();

		}

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	TRAPD(err,UpdateStoreL());

	if (err != KErrNone)

		{

		iKeys.Remove(iKeys.Count() - 1);

		#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

			iPassStreamId = oldDefaultPassphraseId;

		#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

		User::Leave(err);

		}

	}

void CFileKeyDataManager::UpdateStoreL()

	{

	WriteKeysToStoreL();

	// Release ownership of key data and reset default passphrase id if store

	// can't be written

	TCleanupItem cleanupStore(RevertStore, iFileStore);

	CleanupStack::PushL(cleanupStore);

	iFileStore->CommitL();

	CleanupStack::Pop(); // cleanupStore

	}

/**

 * "Transaction safe" key removal - only removes the key in memory and file if

 * all operations are successful.

 */

void CFileKeyDataManager::RemoveL(TInt aObjectId)

	{

	TInt index;

	const CFileKeyData* key = NULL;

	for (index = 0 ; index < iKeys.Count() ; ++index)

		{

		if (iKeys[index]->Handle() == aObjectId)

			{

			key = iKeys[index];

			break;

			}

		}

	if (!key)

		{

		User::Leave(KErrNotFound);

		}

	TCleanupItem cleanupStore(RevertStore, iFileStore);

	CleanupStack::PushL(cleanupStore);	

	iFileStore->DeleteL(key->PrivateDataStreamId());

	iFileStore->DeleteL(key->PublicDataStreamId());

	iFileStore->DeleteL(key->InfoDataStreamId());

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	// Remove the passphrase if it's the last key

	TStreamId oldPassphraseId = iPassStreamId;

	if (Count() == 1)

		{

		iFileStore->DeleteL(iPassStreamId);

		iPassStreamId = KNullStreamId;

		}

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

	// Remove the key

	iKeys.Remove(index);

	TRAPD(res, WriteKeysToStoreL());

	if (res != KErrNone)

		{

#ifndef SYMBIAN_KEYSTORE_USE_AUTH_SERVER		

		iPassStreamId = oldPassphraseId;

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

		User::LeaveIfError(iKeys.Append(key)); // Put it back, shouldn't leave

		User::Leave(res);

		}

	else 

		{

		delete key;   // Cannot leave from the point it's removed to here, so no cleanup stack!

		}		

	iFileStore->CommitL();

	CleanupStack::Pop(); // cleanupStore

	CompactStore();

}

#ifdef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

TBool CFileKeyDataManager::IsKeyAlreadyInStore(const TDesC& aKeyLabel, AuthServer::TIdentityId aIdentity) const

	{//	Check each key in the store to determine if aKeyLabel already exists

	TInt keyCount = iKeys.Count();

	TBool isInStore = EFalse;

	for (TInt index = 0; index < keyCount; ++index)

		{

		const TDesC& keyLabel = iKeys[index]->Label();

		if (keyLabel.Compare(aKeyLabel)==0 && (iKeys[index]->Identity() == aIdentity))

			{

			isInStore = ETrue;

			break;

			}

		}

	return (isInStore);

	}

#else

TBool CFileKeyDataManager::IsKeyAlreadyInStore(const TDesC& aKeyLabel) const

{//	Check each key in the store to determine if aKeyLabel already exists

	TInt keyCount = iKeys.Count();

	TBool isInStore = EFalse;

	for (TInt index = 0; index < keyCount; index++)

	{

		const TDesC& keyLabel = iKeys[index]->Label();

		if (keyLabel.Compare(aKeyLabel)==0)

		{

			isInStore = ETrue;

			break;

		}

	}

	return (isInStore);

}

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

TInt CFileKeyDataManager::Count() const

	{

	return iKeys.Count();

	}	

const CFileKeyData* CFileKeyDataManager::operator[](TInt aIndex) const

	{

	return iKeys[aIndex];

	}

const CFileKeyData* CFileKeyDataManager::Lookup(TInt aObjectId) const

	{

	TInt count = Count();

	for (TInt i = 0; i < count; ++i)

		{

		if ((*this)[i]->Handle() == aObjectId)

			{

			return (*this)[i];

			}

		}

	return NULL;

	}

//	*********************************************************************

//	Management of file and store therein

//	*********************************************************************

#ifdef SYMBIAN_KEYSTORE_USE_AUTH_SERVER

const CFileKeyData* CFileKeyDataManager::CreateKeyDataLC(const TDesC& aLabel, AuthServer::TIdentityId aIdentityId)

	{

	TInt objectId = ++iKeyIdentifier;

	TStreamId infoData = CreateWriteStreamL();

	TStreamId publicKeyData = CreateWriteStreamL();

	TStreamId privateKeyData = CreateWriteStreamL();

	return CFileKeyData::NewLC(objectId, aLabel, infoData, publicKeyData, privateKeyData, aIdentityId);

	}

#else

const CFileKeyData* CFileKeyDataManager::CreateKeyDataLC(const TDesC& aLabel, TStreamId aPassStreamId)

	{

	ASSERT(aPassStreamId != KNullStreamId);

	TInt objectId = ++iKeyIdentifier;

	TStreamId infoData = CreateWriteStreamL();

	TStreamId publicKeyData = CreateWriteStreamL();

	TStreamId privateKeyData = CreateWriteStreamL();

	return CFileKeyData::NewLC(objectId, aLabel, infoData, aPassStreamId, publicKeyData, privateKeyData);

	}

#endif // SYMBIAN_KEYSTORE_USE_AUTH_SERVER

//	Creates a new write stream in the store (which it then closes)

//	Returns the TStreamId associated with it

TStreamId CFileKeyDataManager::CreateWriteStreamL()

	{

	__ASSERT_DEBUG(iFileStore, PanicServer(EPanicStoreInitialised));

	if (!iFileStore)

		User::Leave(KErrNotReady);

	RStoreWriteStream newStream;

	TStreamId result = newStream.CreateLC(*iFileStore);

	if (KNullStreamId == result)