os/security/crypto/weakcryptospi/test/tcryptospi/src/hmacincrementalhmacwithresetstep.cpp
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /*
     2 * Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     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".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: 
    15 * Example CTestStep derived implementation
    16 *
    17 */
    18 
    19 
    20 /**
    21  @file
    22  @internalTechnology
    23 */
    24 #include "hmacincrementalhmacwithresetstep.h"
    25 
    26 #include <cryptospi/cryptohashapi.h>
    27 #include <cryptospi/keys.h>
    28 #include <cryptospi/plugincharacteristics.h>
    29 
    30 using namespace CryptoSpi;
    31 
    32 CHmacIncrementalHmacWithResetStep::~CHmacIncrementalHmacWithResetStep()
    33 	{
    34 	}
    35 
    36 
    37 CHmacIncrementalHmacWithResetStep::CHmacIncrementalHmacWithResetStep()
    38 	{
    39 	SetTestStepName(KHmacIncrementalHmacWithResetStep);
    40 	}
    41 
    42 
    43 TVerdict CHmacIncrementalHmacWithResetStep::doTestStepPreambleL()
    44 	{
    45 	SetTestStepResult(EPass);
    46 	return TestStepResult();
    47 	}
    48 
    49 
    50 TVerdict CHmacIncrementalHmacWithResetStep::doTestStepL()
    51 	{
    52 	if (TestStepResult()==EPass)
    53 		{
    54 		
    55 		//Assume faliure, unless all is successful
    56 		SetTestStepResult(EFail);
    57 		
    58 		INFO_PRINTF1(_L("*** Hmac - Incremental Hash with Reset ***"));
    59 		INFO_PRINTF2(_L("HEAP CELLS: %d"), User::CountAllocCells());
    60 		
    61 		TVariantPtrC algorithmUid;
    62 		TVariantPtrC operationModeUid;
    63 		TPtrC sourcePath;
    64 		TPtrC expectedHash;
    65 		TPtrC encryptKey;
    66 		TVariantPtrC keyType;
    67 		
    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))
    75 			{
    76 			ERR_PRINTF1(_L("** Error: Failed to Load Configuration Parameters **"));
    77 			SetTestStepResult(EFail);
    78 			}
    79 		else
    80 			{
    81 			//Create a pointer for the Hmac Implementation Object
    82 			CHash* hmacImpl = NULL;
    83 			
    84 			//Convert encryption key to an 8 Bit Descriptor
    85 			HBufC8* keyStr = HBufC8::NewLC(encryptKey.Length());
    86 			TPtr8 keyStrPtr = keyStr->Des();
    87 			
    88 			keyStrPtr.Copy(encryptKey);
    89 			
    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);
    94 			
    95 			//Create Key Object
    96 			TKeyProperty keyProperty;
    97 			CKey* key=CKey::NewL(keyProperty,*keyParams);
    98 			CleanupStack::PushL(key);
    99 			
   100 			//Retrieve a Hmac Factory Object			
   101 			TRAPD(err,CHashFactory::CreateHashL(hmacImpl,
   102 												algorithmUid,
   103 												operationModeUid,
   104 												key,
   105 												NULL));											
   106 	
   107 			if(hmacImpl && (err==KErrNone))
   108 				{
   109 				
   110 				//Push the Hmac Implementation Object onto the Cleanup Stack
   111 				CleanupStack::PushL(hmacImpl);
   112 				
   113 				RFs fsSession;
   114 				
   115 				//Create a connection to the file server	
   116 				err = fsSession.Connect();
   117 					
   118 				if(err != KErrNone)
   119 					{
   120 					ERR_PRINTF2(_L("*** Error: File Server Connection - %d ***"), err);
   121 					SetTestStepResult(EFail);
   122 					}	
   123 				else
   124 					{
   125 					RFile sourceFile;
   126 					CleanupClosePushL(sourceFile);
   127 	    			
   128 	    			//Open the specified source file		
   129 	    			err = sourceFile.Open(fsSession,sourcePath, EFileRead);
   130 	    					
   131 	    			if(err != KErrNone)
   132 						{
   133 						ERR_PRINTF2(_L("*** Error: Opening Source File - %d ***"), err);
   134 						SetTestStepResult(EFail);
   135 						}
   136 					else
   137 						{
   138 						
   139 						TInt sourceLength = 0;
   140 						TInt readPosition = 0;
   141 						TInt readIncrement = 0;
   142 						TBool hashComplete = EFalse;
   143 						TBool hashReset = EFalse;
   144 						TPtrC8 hashStr;
   145 						
   146 						User::LeaveIfError(sourceFile.Size(sourceLength));
   147 						
   148 						//Divide the file size into seperate incremental blocks to read
   149 						readIncrement = sourceLength/KDataReadBlocks;
   150 						
   151 						do 
   152 							{
   153 							//Create a heap based descriptor to store the data
   154 							HBufC8* sourceData = HBufC8::NewL(readIncrement);
   155 							CleanupStack::PushL(sourceData);
   156 							TPtr8 sourcePtr = sourceData->Des();
   157 							
   158 							//Read in a block of data from the source file from the current position
   159 							err = sourceFile.Read(readPosition,sourcePtr,readIncrement);
   160 							
   161 							//Update the read position by adding the number of bytes read
   162 							readPosition += readIncrement;
   163 							
   164 							if(readPosition == readIncrement)
   165 								{
   166 								//Read in the first block from the data file into the Hmac implementation object
   167 								hmacImpl->Hash(*sourceData);
   168 								INFO_PRINTF2(_L("Intial Hmac - Bytes Read: %d"), readPosition);
   169 								}
   170 							else if(readPosition >= sourceLength)
   171 								{
   172 								//Reading in the final block, constructs the complete hash value and returns it within a TPtrC8
   173 								hashStr.Set(hmacImpl->Final(*sourceData));
   174 								
   175 								//Sets the Complete Flag to ETrue in order to drop out of the loop
   176 								hashComplete = ETrue;
   177 								
   178 								TInt totalRead = (readPosition - readIncrement) + (*sourceData).Length();
   179 								INFO_PRINTF2(_L("Final Hmac - Bytes Read: %d"),totalRead);
   180 								}
   181 							//If the read position is half the source length and the implementation
   182 							//object hasn't already been reset
   183 							else if((readPosition >= sourceLength/2) && (hashReset == EFalse))
   184 								{
   185 								INFO_PRINTF1(_L("Resetting Hmac Object..."));
   186 								
   187 								hmacImpl->Reset();
   188 								
   189 								//Sets the read position back to 0 inorder to restart the file read from the beginning
   190 								readPosition = 0;
   191 								
   192 								hashReset = ETrue;
   193 								
   194 								INFO_PRINTF2(_L("*** HMAC RESET - Bytes Read: %d ***"), readPosition);
   195 								}
   196 							else
   197 								{
   198 								//Update the message data within the Hmac object with the new block
   199 								hmacImpl->Update(*sourceData);
   200 								INFO_PRINTF2(_L("Hmac Update - Bytes Read: %d"), readPosition);	
   201 								}
   202 							
   203 							CleanupStack::PopAndDestroy(sourceData);
   204 								
   205 							}while(hashComplete == EFalse);
   206 							
   207 						//Create a NULL TCharacteristics pointer
   208 						const TCharacteristics* charsPtr(NULL);
   209 						
   210 						//Retrieve the characteristics for the hash implementation object
   211 						TRAP_LOG(err, hmacImpl->GetCharacteristicsL(charsPtr));
   212 						
   213 						//Static cast the characteristics to type THashCharacteristics
   214 						const THashCharacteristics* hashCharsPtr = static_cast<const THashCharacteristics*>(charsPtr);
   215 						
   216 						//The hash output size is returned in Bits, divide by 8 to get the Byte size
   217 						TInt hashSize = hashCharsPtr->iOutputSize/8;
   218 						
   219 						//Retrieve the final 8bit hash value and convert to 16bit												
   220 						HBufC* hashData = HBufC::NewLC(hashSize);
   221 						TPtr hashPtr = hashData->Des();
   222 						
   223 						hashPtr.Copy(hashStr);
   224 						
   225 						//Take the 16bit descriptor and convert the string to hexadecimal
   226 						TVariantPtrC convertHash;
   227 						convertHash.Set(hashPtr);
   228 						HBufC* hmacResult = convertHash.HexStringLC();								
   229 						
   230 						INFO_PRINTF2(_L("*** Hashed Data: %S ***"),&*hmacResult);
   231 						INFO_PRINTF2(_L("*** Expected Hash: %S ***"),&expectedHash);
   232 						
   233 						//If the returned hash value matches the expected hash, Pass the test	
   234 						if(*hmacResult == expectedHash)
   235 							{
   236 							INFO_PRINTF1(_L("*** Hmac - Incremental Hash with Reset : PASS ***"));
   237 							SetTestStepResult(EPass);	
   238 							}
   239 						else
   240 							{
   241 							ERR_PRINTF2(_L("*** FAIL: Hashed and Expected Value Mismatch  ***"), err);
   242 							SetTestStepResult(EFail);	
   243 							}
   244 													
   245 						CleanupStack::PopAndDestroy(hmacResult);
   246 						CleanupStack::PopAndDestroy(hashData);
   247 						}
   248 						
   249 					//Cleanup the Source RFile	
   250 					CleanupStack::PopAndDestroy();	
   251 					}
   252 
   253 				fsSession.Close();
   254 				
   255 				CleanupStack::PopAndDestroy(hmacImpl);	
   256 				}
   257 			else
   258 				{
   259 				ERR_PRINTF2(_L("*** FAIL: Failed to Create Hmac Object - %d ***"), err);
   260 				SetTestStepResult(EFail);	
   261 				}
   262 			
   263 			CleanupStack::PopAndDestroy(key);
   264 			CleanupStack::PopAndDestroy(keyParams);	
   265 			CleanupStack::PopAndDestroy(keyStr);
   266 			}
   267 		}
   268 		
   269 	INFO_PRINTF2(_L("HEAP CELLS: %d"), User::CountAllocCells());
   270 	return TestStepResult();
   271 	}
   272 
   273 
   274 TVerdict CHmacIncrementalHmacWithResetStep::doTestStepPostambleL()
   275 	{
   276 	return TestStepResult();
   277 	}