os/security/crypto/weakcryptospi/inc/spi/keypairgeneratorplugin.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200 (2014-06-10)
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2006-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
* Key Pair Generator Abstract interface
sl@0
    16
*
sl@0
    17
*/
sl@0
    18
sl@0
    19
sl@0
    20
/**
sl@0
    21
 @file
sl@0
    22
 @publishedPartner
sl@0
    23
 @released
sl@0
    24
*/
sl@0
    25
sl@0
    26
#ifndef __CRYPTOAPI_KEYPAIRGENERATORPLUGIN_H__
sl@0
    27
#define __CRYPTOAPI_KEYPAIRGENERATORPLUGIN_H__
sl@0
    28
sl@0
    29
#include <cryptospi/cryptoplugin.h>
sl@0
    30
sl@0
    31
namespace CryptoSpi
sl@0
    32
	{
sl@0
    33
	class CKeyPair;
sl@0
    34
	/**
sl@0
    35
	The Key Pair Generator definition. Intended to allow plug-ins
sl@0
    36
	to implement extensible Key Pair Generator functionality, and
sl@0
    37
	to work with all known existing Key pair Generator algorithms
sl@0
    38
	*/
sl@0
    39
sl@0
    40
sl@0
    41
	class MKeyPairGenerator : public MPlugin
sl@0
    42
		{
sl@0
    43
	public:
sl@0
    44
sl@0
    45
		/**
sl@0
    46
		Generates a key pair
sl@0
    47
		@param aKeySize	The algorithm-specific metric as a number of bits
sl@0
    48
		@param aKeyParameters	The list of algorithm-specific parameters used by the generator to generate the key pair
sl@0
    49
		@param aKeyPair	The generated key pair
sl@0
    50
sl@0
    51
		@leave ...	Any of the crypto error codes defined in 
sl@0
    52
  					cryptospi_errs.h or any of the system-wide error codes.
sl@0
    53
		*/
sl@0
    54
		virtual void GenerateKeyPairL(TInt aKeySize, const CCryptoParams& aKeyParameters, CKeyPair*& aKeyPair) = 0;
sl@0
    55
		};
sl@0
    56
sl@0
    57
sl@0
    58
	class MAsyncKeyPairGenerator : public MPlugin
sl@0
    59
		{
sl@0
    60
	public:
sl@0
    61
sl@0
    62
		/**
sl@0
    63
		Generates a key pair
sl@0
    64
		@param aKeySize	The algorithm-specific metric as a number of bits
sl@0
    65
		@param aKeyParameters	The list of algorithm-specific parameters used by the generator to generate the key pair
sl@0
    66
		@param aKeyPair	The generated key pair
sl@0
    67
		@param aRequestStatus
sl@0
    68
sl@0
    69
		@leave ...	Any of the crypto error codes defined in 
sl@0
    70
  					cryptospi_errs.h or any of the system-wide error codes.
sl@0
    71
		*/
sl@0
    72
		virtual void GenerateKeyPairL(TInt aKeySize, const CCryptoParams& aKeyParameters, CKeyPair*& aKeyPair, TRequestStatus& aRequestStatus) = 0;
sl@0
    73
sl@0
    74
		/**
sl@0
    75
		Cancel the outstanding request
sl@0
    76
		*/
sl@0
    77
		virtual void Cancel() = 0;
sl@0
    78
sl@0
    79
		};
sl@0
    80
sl@0
    81
	} // namespace CryptoSpi
sl@0
    82
sl@0
    83
#endif //__CRYPTOAPI_KEYPAIRGENERATORPLUGIN_H__