| author | sl@SLION-WIN7.fritz.box |
| Fri, 15 Jun 2012 03:10:57 +0200 | |
| changeset 0 | bde4ae8d615e |
| permissions | -rw-r--r-- |
| 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 |
* crypto keys definition - including symmetric & asymmetric keys |
| sl@0 | 16 |
* |
| sl@0 | 17 |
*/ |
| sl@0 | 18 |
|
| sl@0 | 19 |
|
| sl@0 | 20 |
/** |
| sl@0 | 21 |
@file |
| sl@0 | 22 |
@publishedAll |
| sl@0 | 23 |
@released |
| sl@0 | 24 |
*/ |
| sl@0 | 25 |
|
| sl@0 | 26 |
#ifndef __CRYPTOAPI_KEYS_H__ |
| sl@0 | 27 |
#define __CRYPTOAPI_KEYS_H__ |
| sl@0 | 28 |
|
| sl@0 | 29 |
#include <e32base.h> |
| sl@0 | 30 |
#include <cryptospi/cryptoparams.h> |
| sl@0 | 31 |
|
| sl@0 | 32 |
namespace CryptoSpi |
| sl@0 | 33 |
{
|
| sl@0 | 34 |
class CCryptoParam; |
| sl@0 | 35 |
/** |
| sl@0 | 36 |
The key property definition. |
| sl@0 | 37 |
*/ |
| sl@0 | 38 |
class TKeyProperty |
| sl@0 | 39 |
{
|
| sl@0 | 40 |
public: |
| sl@0 | 41 |
/** |
| sl@0 | 42 |
Algorithm UID of this Key |
| sl@0 | 43 |
*/ |
| sl@0 | 44 |
TUid iAlgorithmUid; |
| sl@0 | 45 |
|
| sl@0 | 46 |
/** |
| sl@0 | 47 |
Implementation ID of the key generator |
| sl@0 | 48 |
*/ |
| sl@0 | 49 |
TUid iImplementationUid; |
| sl@0 | 50 |
|
| sl@0 | 51 |
/** |
| sl@0 | 52 |
Key Type |
| sl@0 | 53 |
*/ |
| sl@0 | 54 |
TUid iKeyType; |
| sl@0 | 55 |
|
| sl@0 | 56 |
/** |
| sl@0 | 57 |
Key Attribute |
| sl@0 | 58 |
*/ |
| sl@0 | 59 |
TUid iKeyAttribute; |
| sl@0 | 60 |
}; |
| sl@0 | 61 |
|
| sl@0 | 62 |
|
| sl@0 | 63 |
/** |
| sl@0 | 64 |
The key definition |
| sl@0 | 65 |
*/ |
| sl@0 | 66 |
NONSHARABLE_CLASS(CKey) : public CBase |
| sl@0 | 67 |
{
|
| sl@0 | 68 |
public: |
| sl@0 | 69 |
|
| sl@0 | 70 |
/** |
| sl@0 | 71 |
Creates a new key from a key property and key parameters. |
| sl@0 | 72 |
@param aKeyProperty The key property for the new key |
| sl@0 | 73 |
@param aKeyParameters The list of the key parameters |
| sl@0 | 74 |
@return A pointer to a CKey instance |
| sl@0 | 75 |
*/ |
| sl@0 | 76 |
IMPORT_C static CKey* NewL(const TKeyProperty& aKeyProperty, const CCryptoParams& aKeyParameters); |
| sl@0 | 77 |
|
| sl@0 | 78 |
/** |
| sl@0 | 79 |
Creates a new key from a key property and key parameters. |
| sl@0 | 80 |
Leave the Ckey pointer on the cleanup stack. |
| sl@0 | 81 |
@param aKeyProperty The key property for the new key |
| sl@0 | 82 |
@param aKeyParameters The list of the key parameters |
| sl@0 | 83 |
@return A pointer to a CKey instance |
| sl@0 | 84 |
*/ |
| sl@0 | 85 |
IMPORT_C static CKey* NewLC(const TKeyProperty& aKeyProperty, const CCryptoParams& aKeyParameters); |
| sl@0 | 86 |
|
| sl@0 | 87 |
/** |
| sl@0 | 88 |
Creates a new key from a CKey object. |
| sl@0 | 89 |
@param aKey the source CKey object. |
| sl@0 | 90 |
@return A pointer to a CKey instance |
| sl@0 | 91 |
*/ |
| sl@0 | 92 |
IMPORT_C static CKey* NewL(const CKey& aKey); |
| sl@0 | 93 |
|
| sl@0 | 94 |
/** |
| sl@0 | 95 |
Creates a new key from a CKey object. |
| sl@0 | 96 |
Leave the Ckey pointer on the cleanup stack. |
| sl@0 | 97 |
@param aKey the source CKey object. |
| sl@0 | 98 |
@return A pointer to a CKey instance |
| sl@0 | 99 |
*/ |
| sl@0 | 100 |
IMPORT_C static CKey* NewLC(const CKey& aKey); |
| sl@0 | 101 |
|
| sl@0 | 102 |
/** |
| sl@0 | 103 |
Destructor |
| sl@0 | 104 |
*/ |
| sl@0 | 105 |
IMPORT_C ~CKey(); |
| sl@0 | 106 |
|
| sl@0 | 107 |
/** |
| sl@0 | 108 |
Retrieve the key property |
| sl@0 | 109 |
@return The reference of the key property |
| sl@0 | 110 |
*/ |
| sl@0 | 111 |
IMPORT_C const TKeyProperty& KeyProperty() const; |
| sl@0 | 112 |
|
| sl@0 | 113 |
/** |
| sl@0 | 114 |
Retrieve the Key Parameter according to the UID of the parameter |
| sl@0 | 115 |
@param aUid The UID of the key parameter |
| sl@0 | 116 |
*/ |
| sl@0 | 117 |
IMPORT_C const TInteger& GetBigIntL(TUid aUid) const; |
| sl@0 | 118 |
IMPORT_C TInt GetTIntL(TUid aUid) const; |
| sl@0 | 119 |
IMPORT_C const TDesC8& GetTDesC8L(TUid aUid) const; |
| sl@0 | 120 |
|
| sl@0 | 121 |
IMPORT_C TBool IsPresent(TUid aUid) const; |
| sl@0 | 122 |
|
| sl@0 | 123 |
/** |
| sl@0 | 124 |
Retrieve the key property and key parameter |
| sl@0 | 125 |
@param aKeyProperty The key property |
| sl@0 | 126 |
@return The key parameters |
| sl@0 | 127 |
*/ |
| sl@0 | 128 |
IMPORT_C const CCryptoParams& KeyParameters() const; |
| sl@0 | 129 |
|
| sl@0 | 130 |
private: |
| sl@0 | 131 |
/** |
| sl@0 | 132 |
constructor |
| sl@0 | 133 |
*/ |
| sl@0 | 134 |
CKey(const TKeyProperty& aKeyProperty); |
| sl@0 | 135 |
|
| sl@0 | 136 |
/** |
| sl@0 | 137 |
2nd Phase Constructor |
| sl@0 | 138 |
*/ |
| sl@0 | 139 |
void ConstructL(const CCryptoParams& aKeyParameters); |
| sl@0 | 140 |
|
| sl@0 | 141 |
private: |
| sl@0 | 142 |
/** |
| sl@0 | 143 |
The Key Parameters of this object |
| sl@0 | 144 |
*/ |
| sl@0 | 145 |
CCryptoParams* iKeyParameters; |
| sl@0 | 146 |
|
| sl@0 | 147 |
/** |
| sl@0 | 148 |
the key property |
| sl@0 | 149 |
*/ |
| sl@0 | 150 |
TKeyProperty iKeyProperty; |
| sl@0 | 151 |
}; |
| sl@0 | 152 |
|
| sl@0 | 153 |
} // namespace CryptoSpi |
| sl@0 | 154 |
|
| sl@0 | 155 |
#endif //__CRYPTOAPI_KEYS_H__ |
| sl@0 | 156 |
|
| sl@0 | 157 |