MCL/sf/os/security: crypto/weakcrypto/inc/msymmetriccipher.h@2c201484c85f (annotated)

0 2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	1	/*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	2	* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	3	* All rights reserved.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	4	* This component and the accompanying materials are made available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	5	* under the terms of the License "Eclipse Public License v1.0"
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	6	* which accompanies this distribution, and is available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	8	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	9	* Initial Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	10	* Nokia Corporation - initial contribution.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	11	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	12	* Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	13	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	14	* Description:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	15	* csymmetriccipher.h
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	16	* IMPORTANT PublishedPartner API's in this file are published to 3rd party developers via the
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	17	* Symbian website. Changes to these API's should be treated as PublishedAll API changes and the Security TA should be consulted.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	18	* CSymmetricCipher class implementation
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	19	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	20	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	21
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	22
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	23
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	24
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	25	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	26	@file
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	27	@publishedPartner
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	28	@released
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	29	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	30
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	31	#ifndef __CSYMMETRICCIPHER_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	32	#define __CSYMMETRICCIPHER_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	33
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	34	#include <e32base.h>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	35
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	36	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	37	* Top-level interface designed to collate the behaviour of all symmetric
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	38	* ciphers under one interface.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	39	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	40	* See the Cryptography api-guide documentation.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	41	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	42	* @publishedPartner
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	43	* @released
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	44	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	45	class CSymmetricCipher : public CBase
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	46	{
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	47	public:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	48	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	49	* Runs the underlying transformation on aInput and appends the result to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	50	* aOutput.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	51	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	52	* For incremental buffering rules see the Cryptography api-guide documentation.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	53	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	54	* @param aInput The input data to be processed.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	55	* @param aOutput The resulting processed data appended to aOutput. aOutput must
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	56	* have MaxOutputLength() empty bytes remaining in its length.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	57	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	58	virtual void Process(const TDesC8& aInput, TDes8& aOutput) = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	59
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	60	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	61	* Pads aInput to be block aligned using the underlying padding system, if any,
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	62	* and then runs the underlying transformation on aInput, and appends the result
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	63	* to aOutput.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	64	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	65	* For incremental buffering rules see the Cryptography api-guide documentation.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	66	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	67	* @param aInput The input data to be processed.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	68	* @param aOutput The resulting, possibly padded, processed data appended to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	69	* aOutput. aOutput must have MaxFinalOutputLength() empty bytes
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	70	* remaining in its length.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	71	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	72	virtual void ProcessFinalL(const TDesC8& aInput, TDes8& aOutput) = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	73
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	74	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	75	* Gets a tight upper bound on the number of bytes that would be returned by a
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	76	* call to Process() with aInputLength bytes of data.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	77	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	78	* @param aInputLength The length of data to be supplied to Process() in bytes.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	79	* @return The length of data which would result from a call to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	80	* Process() with an aInputLength number of bytes.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	81	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	82	virtual TInt MaxOutputLength(TInt aInputLength) const = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	83
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	84	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	85	* Gets as tight an upper bound as possible on the number of bytes that would
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	86	* be returned by a call to ProcessFinalL() with aInputLength bytes of data.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	87	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	88	* @param aInputLength The length of data to be supplied to Process() in bytes.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	89	* @return An upper bound on the length of data which would result from
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	90	* a call to ProcessFinalL() with an aInputLength number of bytes.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	91	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	92	virtual TInt MaxFinalOutputLength(TInt aInputLength) const = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	93
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	94	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	95	* Resets the cipher back to its original state. Clears all its buffers.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	96	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	97	virtual void Reset() = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	98
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	99	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	100	* Gets the block size in bytes (1 for stream ciphers).
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	101	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	102	* @return Block size of underlying cipher in bytes.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	103	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	104	virtual TInt BlockSize() const = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	105
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	106	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	107	* Gets the key size in bits.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	108	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	109	* @return Key size in bits.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	110	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	111	virtual TInt KeySize() const = 0;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	112	};
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	113
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	114
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	115	#endif // __CSYMMETRICCIPHER_H__

author	Santosh Patil <santosh.v.patil@nokia.com>
	Wed, 08 Jul 2009 11:25:26 +0100
changeset 0	2c201484c85f
child 8	35751d3474b7
permissions	-rw-r--r--