|
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 |
* cryptoplugin 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_CRYPTOPLUGIN_H__
|
|
sl@0
|
27 |
#define __CRYPTOAPI_CRYPTOPLUGIN_H__
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
#include <cryptospi/cryptobaseapi.h>
|
|
sl@0
|
30 |
#include <cryptospi/plugincharacteristics.h>
|
|
sl@0
|
31 |
#include <cryptospi/extendedcharacteristics.h>
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
namespace CryptoSpi
|
|
sl@0
|
34 |
{
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
The crypto plugin base class definition
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
class MPlugin
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
public:
|
|
sl@0
|
42 |
virtual void Close() = 0;
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
/**
|
|
sl@0
|
45 |
Resets the crypto plugin.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
virtual void Reset() = 0;
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
/**
|
|
sl@0
|
50 |
Retrieves the plugin's common characteristics
|
|
sl@0
|
51 |
@param aPluginCharacteristics The plugin characteristics value retrieved
|
|
sl@0
|
52 |
@leave ... Any of the crypto error codes defined in
|
|
sl@0
|
53 |
cryptospi_errs.h or any of the system-wide error codes.
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
virtual void GetCharacteristicsL(const TCharacteristics*& aPluginCharacteristics) = 0;
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
/**
|
|
sl@0
|
58 |
Retrieves the plugin's extended characteristics
|
|
sl@0
|
59 |
@return The extended plugin characteristics, on the heap.
|
|
sl@0
|
60 |
This should be deleted by the caller when finished with.
|
|
sl@0
|
61 |
@leave ... Any of the crypto error codes defined in
|
|
sl@0
|
62 |
cryptospi_errs.h or any of the system-wide error codes.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
virtual const CExtendedCharacteristics* GetExtendedCharacteristicsL() = 0;
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
Interface that enable plugin to extend functionality
|
|
sl@0
|
68 |
@param aExtensionId The UID for the extended functionality
|
|
sl@0
|
69 |
@return The extended handler pointer
|
|
sl@0
|
70 |
*/
|
|
sl@0
|
71 |
virtual TAny* GetExtension(TUid aExtensionId) = 0;
|
|
sl@0
|
72 |
};
|
|
sl@0
|
73 |
}
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
#endif //__CRYPTOAPI_CRYPTOPLUGIN_H__
|