os/security/cryptoplugins/cryptospiplugins/source/softwarecrypto/asymmetriccipherimpl.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200 (2012-06-15)
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of the License "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description: 
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
#ifndef __ASYMMETRICCIPHERIMPL_H__
sl@0
    20
#define __ASYMMETRICCIPHERIMPL_H__
sl@0
    21
sl@0
    22
/**
sl@0
    23
@file 
sl@0
    24
@internalComponent
sl@0
    25
@released
sl@0
    26
*/
sl@0
    27
sl@0
    28
#include <e32base.h>
sl@0
    29
#include <cryptospi/cryptospidef.h>
sl@0
    30
#include <padding.h>
sl@0
    31
#include "asymmetriccipherplugin.h"
sl@0
    32
#include "keys.h"
sl@0
    33
#include "common/inlines.h"
sl@0
    34
sl@0
    35
/**
sl@0
    36
 * Abstract base class for symmetric cipher plug-ins.
sl@0
    37
 */
sl@0
    38
namespace SoftwareCrypto
sl@0
    39
	{
sl@0
    40
	using namespace CryptoSpi;
sl@0
    41
	
sl@0
    42
	NONSHARABLE_CLASS(CAsymmetricCipherImpl) : public CBase, public MAsymmetricCipher
sl@0
    43
		{
sl@0
    44
	public:
sl@0
    45
		
sl@0
    46
		// Override MPlugin virtual functions
sl@0
    47
		void Close();
sl@0
    48
		void Reset(); // Always call reset in super-class if you override this
sl@0
    49
		TAny* GetExtension(TUid aExtensionId);
sl@0
    50
		void GetCharacteristicsL(const TCharacteristics*& aPluginCharacteristics);
sl@0
    51
		// End of MPlugin
sl@0
    52
		
sl@0
    53
		// Override MAsymmetricCipherBase virtual functions
sl@0
    54
		void SetKeyL(const CKey& aKey);             // override DoSetKeyL instead
sl@0
    55
		void SetCryptoModeL(TUid aCryptoMode);      // override DoSetCryptoModeL instead
sl@0
    56
		void SetPaddingModeL(TUid aPaddingMode);    // override DoSetPaddingModeL instead
sl@0
    57
		virtual TInt GetMaximumInputLengthL() const;
sl@0
    58
		virtual TInt GetMaximumOutputLengthL() const;
sl@0
    59
		// End of MAsymmetricCipherBase
sl@0
    60
		
sl@0
    61
		// Override MAsymmetricCipher virtual functions
sl@0
    62
		virtual void ProcessL(const TDesC8& aInput, TDes8& aOutput) = 0;
sl@0
    63
		// End of MAsymmetricCipher
sl@0
    64
		
sl@0
    65
		/// Destructor
sl@0
    66
		~CAsymmetricCipherImpl();
sl@0
    67
		
sl@0
    68
	protected:
sl@0
    69
		/**
sl@0
    70
		Constructor
sl@0
    71
		@param aCryptoMode Whether to encrypt or decrypt
sl@0
    72
		@param aPaddingMode The padding mode
sl@0
    73
		*/
sl@0
    74
		CAsymmetricCipherImpl(TUid aCryptoMode, TUid aPaddingMode);
sl@0
    75
sl@0
    76
		/**
sl@0
    77
		Second phase of construction. Always call ConstructL in the super-class
sl@0
    78
		if you override this method.
sl@0
    79
		
sl@0
    80
		@param aKey The key to initialise the cipher with.
sl@0
    81
		*/
sl@0
    82
		virtual void ConstructL(const CKey& aKey);
sl@0
    83
		
sl@0
    84
		/**
sl@0
    85
		Implemented by each cipher subclass to determine whether the
sl@0
    86
		specified key length is valid for that cipher.
sl@0
    87
		This is called by ConstructL and SetKeyL
sl@0
    88
		@param aKeyBytes The key length in bytes to verify.
sl@0
    89
		@return ETrue if key length is acceptable
sl@0
    90
		*/
sl@0
    91
		virtual TBool IsValidKeyLengthL(TInt aKeyBytes) const = 0;
sl@0
    92
		
sl@0
    93
		/**
sl@0
    94
		Helper function implemented by concrete cipher sub-class that allows
sl@0
    95
		GetCharacteristicsL to return the correct characteristics object.
sl@0
    96
		@return The implemention uid
sl@0
    97
		*/
sl@0
    98
		virtual TUid ImplementationUid() const = 0;
sl@0
    99
		
sl@0
   100
		/**
sl@0
   101
		Validates and sets the crypto mode (iCryptoMode)
sl@0
   102
		@param aCryptoMode The crypto mode
sl@0
   103
		*/	
sl@0
   104
		virtual void DoSetCryptoModeL(TUid aCryptoMode);
sl@0
   105
		
sl@0
   106
		/**
sl@0
   107
		Extracts the raw key from aKey and sets iKey and iKeyBytes
sl@0
   108
		The key length is also checked to meet export restrictions and
sl@0
   109
		to ensure that it is appropriate for the cipher.
sl@0
   110
		@param aKey The key
sl@0
   111
		*/
sl@0
   112
		virtual void DoSetKeyL(const CKey& aKey);
sl@0
   113
		
sl@0
   114
		/**
sl@0
   115
		Validates and sets the padding mode (iPaddingMode & iPadding)
sl@0
   116
		@param aPadding The desired padding mode
sl@0
   117
		*/
sl@0
   118
		virtual void DoSetPaddingModeL(TUid aPadding);
sl@0
   119
		
sl@0
   120
	private:
sl@0
   121
			
sl@0
   122
	protected:
sl@0
   123
		/// encryption or decryption
sl@0
   124
		TUid iCryptoMode;
sl@0
   125
		
sl@0
   126
		/// the current padding scheme
sl@0
   127
		TUid iPaddingMode;
sl@0
   128
		
sl@0
   129
		/// the key
sl@0
   130
		CKey* iKey;
sl@0
   131
		
sl@0
   132
		/// current padding scheme implementation
sl@0
   133
		CPadding* iPadding;
sl@0
   134
		};
sl@0
   135
	}
sl@0
   136
sl@0
   137
#endif	//	__ASYMMETRICCIPHERIMPL_H__