FCL/sf/os/security: crypto/weakcryptospi/inc/spi/randomplugin.h@9b5a3a9fddf8 (annotated)

8 35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1	/*
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	2	* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	3	* All rights reserved.
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	4	* This component and the accompanying materials are made available
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	5	* under the terms of the License "Eclipse Public License v1.0"
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	6	* which accompanies this distribution, and is available
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	8	*
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	9	* Initial Contributors:
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	10	* Nokia Corporation - initial contribution.
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	11	*
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	12	* Contributors:
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	13	*
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	14	* Description:
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	15	* Random generator interface
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	16	*
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	17	*/
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	18
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	19
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	20	/**
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	21	@file
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	22	@publishedPartner
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	23	@released
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	24	*/
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	25
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	26	#ifndef __CRYPTOAPI_RANDOMPLUGIN_H__
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	27	#define __CRYPTOAPI_RANDOMPLUGIN_H__
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	28
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	29	#include <cryptospi/cryptoplugin.h>
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	30
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	31	namespace CryptoSpi
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	32	{
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	33	/**
43 9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	34	A pseudo-random number generator (PRNG).
8 35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	35	Generates random numbers derived from entropy obtained from another
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	36	source, usually a hardware random number generator or if unavailable,
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	37	from a combination variety of unpredictable system variables, added
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	38	to an entropy pool which is used for seeding. This might include
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	39	keypresses generated by a user, hardware interrupts, etc.
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	40	*/
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	41	class MRandom : public MPlugin
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	42	{
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	43	public:
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	44	/**
43 9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	45	* Implementations of this method should fill the passed
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	46	* buffer with the generated pseudo-random data up to the
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	47	* current length, discarding any current contents. The
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	48	* implementations should leave with KErrNotSecure when
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	49	* the generated random data is not secure enough.
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	50	*
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	51	* @param aDest The buffer to fill with random data
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	52	* @leave KErrNotSecure Random data generated is not
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	53	* secure enough for crytographic operations
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	54	* otherwise, leaves with any other system wide error code.
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	55	*
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	56	*/
8 35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	57	virtual void GenerateRandomBytesL(TDes8& aDest) = 0;
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	58	};
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	59
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	60
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	61	class MAsyncRandom : public MPlugin
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	62	{
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	63	public:
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	64	/**
43 9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	65	* Implementations of this method should fill the passed
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	66	* buffer with the generated pseudo-random data up to the
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	67	* current length, discarding any current contents. The
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	68	* implementations should leave with KErrNotSecure when
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	69	* the generated random data is not secure enough.
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	70	*
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	71	* @param aDest The buffer to fill with random data
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	72	* @param aStatus The argument to carry the asynchonous request completion
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	73	* status to notify the client when buffer is filled with random data.
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	74	* @leave KErrNotSecure Random data generated is not
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	75	* secure enough for crytographic operations
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	76	* otherwise, leaves with any other system wide error code.
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	77	*
9b5a3a9fddf8 Revision: 201007 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 8 diff changeset	78	*/
8 35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	79	virtual void GenerateRandomBytesL(TDes8& aDest, TRequestStatus& aStatus) = 0;
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	80
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	81	/**
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	82	Cancel an outstanding request
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	83	*/
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	84	virtual void Cancel() = 0;
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	85	};
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	86
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	87	}
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	88
35751d3474b7 Revision: 200935 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	89	#endif // __CRYPTOAPI_RANDOMPLUGIN_H__

author	Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
	Sat, 20 Feb 2010 00:36:18 +0200
branch	RCL_3
changeset 43	9b5a3a9fddf8
parent 8	35751d3474b7
permissions	-rw-r--r--