os/security/crypto/weakcryptospi/test/tcryptospi/src/hmacincrementalhmacwithreplicatestep.cpp
Update contrib.
2 * Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of the License "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
15 * Example CTestStep derived implementation
24 #include "hmacincrementalhmacwithreplicatestep.h"
26 #include <cryptospi/cryptohashapi.h>
27 #include <cryptospi/keys.h>
28 #include <cryptospi/plugincharacteristics.h>
30 using namespace CryptoSpi;
32 CHmacIncrementalHmacWithReplicateStep::~CHmacIncrementalHmacWithReplicateStep()
37 CHmacIncrementalHmacWithReplicateStep::CHmacIncrementalHmacWithReplicateStep()
39 SetTestStepName(KHmacIncrementalHmacWithReplicateStep);
43 TVerdict CHmacIncrementalHmacWithReplicateStep::doTestStepPreambleL()
45 SetTestStepResult(EPass);
46 return TestStepResult();
50 TVerdict CHmacIncrementalHmacWithReplicateStep::doTestStepL()
52 if (TestStepResult()==EPass)
55 //Assume faliure, unless all is successful
56 SetTestStepResult(EFail);
58 INFO_PRINTF1(_L("*** Hmac - Incremental Hash with Replicate ***"));
59 INFO_PRINTF2(_L("HEAP CELLS: %d"), User::CountAllocCells());
61 TVariantPtrC algorithmUid;
62 TVariantPtrC operationModeUid;
68 //Extract the Test Case ID parameter from the specified INI file
69 if(!GetStringFromConfig(ConfigSection(),KConfigAlgorithmUid,algorithmUid) ||
70 !GetStringFromConfig(ConfigSection(),KConfigOperationMode,operationModeUid) ||
71 !GetStringFromConfig(ConfigSection(),KConfigSourcePath,sourcePath) ||
72 !GetStringFromConfig(ConfigSection(),KConfigExHashHmacValue,expectedHash) ||
73 !GetStringFromConfig(ConfigSection(),KConfigEncryptKey,encryptKey) ||
74 !GetStringFromConfig(ConfigSection(),KConfigEncryptKeyType,keyType))
76 ERR_PRINTF1(_L("** Error: Failed to Load Configuration Parameters **"));
77 SetTestStepResult(EFail);
81 //Create a pointer for the Hash + Key (Hmac) Implementation Object
82 CHash* hmacImpl = NULL;
84 //Convert encryption key to an 8 Bit Descriptor
85 HBufC8* keyStr = HBufC8::NewLC(encryptKey.Length());
86 TPtr8 keyStrPtr = keyStr->Des();
88 keyStrPtr.Copy(encryptKey);
90 //Create an new CryptoParams object to encapsulate the key type and secret key string
91 CCryptoParams* keyParams = CCryptoParams::NewL();
92 CleanupStack::PushL(keyParams);
93 keyParams->AddL(*keyStr,keyType);
96 TKeyProperty keyProperty;
97 CKey* key=CKey::NewL(keyProperty,*keyParams);
98 CleanupStack::PushL(key);
100 //Retrieve a Hmac Factory Object
101 TRAPD(err,CHashFactory::CreateHashL(hmacImpl,
107 if(hmacImpl && (err == KErrNone))
110 //Push the Hmac Implementation Object onto the Cleanup Stack
111 CleanupStack::PushL(hmacImpl);
115 //Create a connection to the file server
116 err = fsSession.Connect();
120 ERR_PRINTF2(_L("*** Error: File Server Connection - %d ***"), err);
121 SetTestStepResult(EFail);
126 CleanupClosePushL(sourceFile);
128 //Open the specified source file
129 err = sourceFile.Open(fsSession,sourcePath, EFileRead);
133 ERR_PRINTF2(_L("*** Error: Opening Source File - %d ***"), err);
134 SetTestStepResult(EFail);
139 TInt sourceLength = 0;
140 TInt readPosition = 0;
141 TInt readIncrement = 0;
142 TBool hashComplete = EFalse;
143 TBool hashReplicated = EFalse;
146 CHash* hmacReplicateImpl = NULL;
148 User::LeaveIfError(sourceFile.Size(sourceLength));
150 //Divide the total size of the source file up into individual equal sized blocks to read
151 //over several increments
152 readIncrement = sourceLength/KDataReadBlocks;
156 //Create a heap based descriptor to store the data
157 HBufC8* sourceData = HBufC8::NewL(readIncrement);
158 CleanupStack::PushL(sourceData);
159 TPtr8 sourcePtr = sourceData->Des();
161 //Read in a block of data from the source file from the current position
162 err = sourceFile.Read(readPosition,sourcePtr,readIncrement);
164 //Update the read position by adding the number of bytes read
165 readPosition += readIncrement;
167 if(readPosition == readIncrement)
169 //Read in the first block from the data file into the Hmac implementation object
170 if(hashReplicated == EFalse)
172 hmacImpl->Hash(*sourceData);
173 INFO_PRINTF2(_L("Intial Hmac - Bytes Read: %d"), readPosition);
177 hmacReplicateImpl->Hash(*sourceData);
178 INFO_PRINTF2(_L("Intial Hmac (Replicate) - Bytes Read: %d"), readPosition);
181 else if(readPosition >= sourceLength)
183 //Reading in the final block, constructs the complete hash value and returns it within a TPtrC8
184 hashStr.Set(hmacReplicateImpl->Final(*sourceData));
186 //Sets the Complete Flag to ETrue in order to drop out of the loop
187 hashComplete = ETrue;
189 TInt totalRead = (readPosition - readIncrement) + (*sourceData).Length();
190 INFO_PRINTF2(_L("Final Hmac - Bytes Read: %d"),totalRead);
192 //If the read position is half the source length and the implementation
193 //object hasn't already been replicated
194 else if((readPosition >= sourceLength/2) && (hashReplicated == EFalse))
196 INFO_PRINTF1(_L("Replicating Hmac Object..."));
198 //Create a Copy of the existing Hmac Object with NO internal message state
199 hmacReplicateImpl = hmacImpl->ReplicateL();
201 hashReplicated = ETrue;
203 //Sets the read position back to 0 inorder to restart the file read from the beginning
206 INFO_PRINTF2(_L("*** HMAC REPLICATE - Bytes Read: %d ***"), readPosition);
210 //Update the message data within the Hmac object with the new block
211 if(hashReplicated == EFalse)
213 hmacImpl->Update(*sourceData);
214 INFO_PRINTF2(_L("Hmac Update - Bytes Read: %d"), readPosition);
218 hmacReplicateImpl->Update(*sourceData);
219 INFO_PRINTF2(_L("Hmac Update (Replicate) - Bytes Read: %d"), readPosition);
223 CleanupStack::PopAndDestroy(sourceData);
226 }while(hashComplete == EFalse);
228 //Create a NULL TCharacteristics pointer
229 const TCharacteristics* charsPtr(NULL);
231 //Retrieve the characteristics for the hash implementation object
232 TRAP_LOG(err, hmacImpl->GetCharacteristicsL(charsPtr));
234 //Static cast the characteristics to type THashCharacteristics
235 const THashCharacteristics* hashCharsPtr = static_cast<const THashCharacteristics*>(charsPtr);
237 //The hash output size is returned in Bits, divide by 8 to get the Byte size
238 TInt hashSize = hashCharsPtr->iOutputSize/8;
240 //Retrieve the final 8bit hash value and convert to 16bit
241 HBufC* hashData = HBufC::NewLC(hashSize);
242 TPtr hashPtr = hashData->Des();
244 hashPtr.Copy(hashStr);
246 //Take the 16bit descriptor and convert the string to hexadecimal
247 TVariantPtrC convertHash;
248 convertHash.Set(hashPtr);
249 HBufC* hmacResult = convertHash.HexStringLC();
251 INFO_PRINTF2(_L("*** Hashed Data: %S ***"),&*hmacResult);
252 INFO_PRINTF2(_L("*** Expected Hash: %S ***"),&expectedHash);
254 //If the returned hash value matches the expected hash, Pass the test
255 if(*hmacResult == expectedHash)
257 INFO_PRINTF1(_L("*** Hmac - Incremental Hash with Replicate : PASS ***"));
258 SetTestStepResult(EPass);
262 ERR_PRINTF2(_L("*** FAIL: Hashed and Expected Value Mismatch ***"), err);
263 SetTestStepResult(EFail);
266 CleanupStack::PopAndDestroy(hmacResult);
267 CleanupStack::PopAndDestroy(hashData);
269 delete hmacReplicateImpl;
272 //Cleanup the Source RFile
273 CleanupStack::PopAndDestroy();
278 CleanupStack::PopAndDestroy(hmacImpl);
282 ERR_PRINTF2(_L("*** FAIL: Failed to Create Hmac Object - %d ***"), err);
283 SetTestStepResult(EFail);
286 CleanupStack::PopAndDestroy(key);
287 CleanupStack::PopAndDestroy(keyParams);
288 CleanupStack::PopAndDestroy(keyStr);
292 INFO_PRINTF2(_L("HEAP CELLS: %d"), User::CountAllocCells());
293 return TestStepResult();
297 TVerdict CHmacIncrementalHmacWithReplicateStep::doTestStepPostambleL()
299 return TestStepResult();