|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1997-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 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
/**
|
|
sl@0
|
20 |
@file
|
|
sl@0
|
21 |
@publishedPartner
|
|
sl@0
|
22 |
@released
|
|
sl@0
|
23 |
*/
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef __SECDLG_H__
|
|
sl@0
|
26 |
#define __SECDLG_H__
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#include <ct.h>
|
|
sl@0
|
29 |
#include <securitydefs.h>
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
/** Security Dialog API */
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
/** The maximum length of a PIN label */
|
|
sl@0
|
35 |
const TInt KPINLabelMaxLength = 64;
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
/** TPINLabel is a human-readable name for the PIN to be entered. */
|
|
sl@0
|
38 |
//64 = 255 bytes / poss 4bytes per unicode character
|
|
sl@0
|
39 |
typedef TBuf<KPINLabelMaxLength> TPINLabel;
|
|
sl@0
|
40 |
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
/**
|
|
sl@0
|
43 |
* Provides information associated with the PIN,
|
|
sl@0
|
44 |
* to enable the dialog to display the name and do some basic correctness checking.
|
|
sl@0
|
45 |
*/
|
|
sl@0
|
46 |
class TPINParams
|
|
sl@0
|
47 |
{
|
|
sl@0
|
48 |
public:
|
|
sl@0
|
49 |
/** The label that identifies the PIN */
|
|
sl@0
|
50 |
TPINLabel iPINLabel;
|
|
sl@0
|
51 |
/** The label of the token */
|
|
sl@0
|
52 |
TPINLabel iTokenLabel;
|
|
sl@0
|
53 |
/** The minimum length of the PIN */
|
|
sl@0
|
54 |
TInt iMinLength;
|
|
sl@0
|
55 |
/** The maximum length of the PIN */
|
|
sl@0
|
56 |
TInt iMaxLength;
|
|
sl@0
|
57 |
};
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
/** The max PIN length should not exceed 32, because this is the maximum
|
|
sl@0
|
60 |
* size possible in the CEikSecretEditor class. */
|
|
sl@0
|
61 |
const TInt KMaxPINLength = 32;
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
/** A PIN value */
|
|
sl@0
|
64 |
typedef TBuf<KMaxPINLength> TPINValue;
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/** Unblocking PINs can be up to 64 characters if they are entered in the clear. */
|
|
sl@0
|
67 |
const TInt KMaxUnblockPINLength = 64;
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
/** An unblocking PIN value */
|
|
sl@0
|
70 |
typedef TBuf<KMaxUnblockPINLength> TUnblockPINValue;
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
* Definition of the security dialog interface
|
|
sl@0
|
74 |
* @since 7.0
|
|
sl@0
|
75 |
*/
|
|
sl@0
|
76 |
class MSecurityDialog
|
|
sl@0
|
77 |
{
|
|
sl@0
|
78 |
public:
|
|
sl@0
|
79 |
/**
|
|
sl@0
|
80 |
* TConnectionType defines the possible protocols used in EstablishSecureConnection
|
|
sl@0
|
81 |
* which allows the type of the certificate to be derived.
|
|
sl@0
|
82 |
*/
|
|
sl@0
|
83 |
enum TConnectionType
|
|
sl@0
|
84 |
{
|
|
sl@0
|
85 |
/** WTLS */
|
|
sl@0
|
86 |
EWTLS,
|
|
sl@0
|
87 |
/** TLS */
|
|
sl@0
|
88 |
ETLS
|
|
sl@0
|
89 |
};
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
|
|
sl@0
|
92 |
public:
|
|
sl@0
|
93 |
/**
|
|
sl@0
|
94 |
* Prompts the user to enter a PIN.
|
|
sl@0
|
95 |
*
|
|
sl@0
|
96 |
* @param aPINParams Information about the PIN to enter.
|
|
sl@0
|
97 |
* @param aRetry Indicates whether the user is retrying.
|
|
sl@0
|
98 |
* @param aPINValue On return, the PIN the user entered:
|
|
sl@0
|
99 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
100 |
* be presented to the user.
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
virtual void EnterPIN( const TPINParams& aPINParams, TBool aRetry, TPINValue& aPINValue,
|
|
sl@0
|
103 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/**
|
|
sl@0
|
106 |
* Prompts the user to change a PIN.
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* @param aPINParams Information about the PIN to change
|
|
sl@0
|
109 |
* @param aRetry Indicates whether the user is retrying
|
|
sl@0
|
110 |
* @param aOldPINValue On return, the old PIN the user entered
|
|
sl@0
|
111 |
* @param aNewPINValue On return, the new PIN the user entered
|
|
sl@0
|
112 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
113 |
* be presented to the user.
|
|
sl@0
|
114 |
*/
|
|
sl@0
|
115 |
virtual void ChangePIN( const TPINParams& aPINParams, TBool aRetry,
|
|
sl@0
|
116 |
TPINValue& aOldPINValue, TPINValue& aNewPINValue,
|
|
sl@0
|
117 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
118 |
|
|
sl@0
|
119 |
|
|
sl@0
|
120 |
|
|
sl@0
|
121 |
/**
|
|
sl@0
|
122 |
* Prompts the user to enable a PIN.
|
|
sl@0
|
123 |
*
|
|
sl@0
|
124 |
* @param aPINParams Information about the PIN to enable.
|
|
sl@0
|
125 |
* @param aRetry Indicates whether the user is retrying.
|
|
sl@0
|
126 |
* @param aPINValue On return, the PIN the user entered:
|
|
sl@0
|
127 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
128 |
* be presented to the user.
|
|
sl@0
|
129 |
*/
|
|
sl@0
|
130 |
virtual void EnablePIN( const TPINParams& aPINParams, TBool aRetry, TPINValue& aPINValue,
|
|
sl@0
|
131 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
132 |
|
|
sl@0
|
133 |
/**
|
|
sl@0
|
134 |
* Prompts the user to disable a PIN.
|
|
sl@0
|
135 |
*
|
|
sl@0
|
136 |
* @param aPINParams Information about the PIN to disable.
|
|
sl@0
|
137 |
* @param aRetry Indicates whether the user is retrying.
|
|
sl@0
|
138 |
* @param aPINValue On return, the PIN the user entered:
|
|
sl@0
|
139 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
140 |
* be presented to the user.
|
|
sl@0
|
141 |
*/
|
|
sl@0
|
142 |
virtual void DisablePIN( const TPINParams& aPINParams, TBool aRetry,
|
|
sl@0
|
143 |
TPINValue& aPINValue, TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
144 |
/**
|
|
sl@0
|
145 |
* Prompts the user to unblock a PIN.
|
|
sl@0
|
146 |
*
|
|
sl@0
|
147 |
* The unblocking PIN is not displayed as it is entered, and can be a
|
|
sl@0
|
148 |
* maximum of 32 characters long - hence it is passed back as a TPINValue.
|
|
sl@0
|
149 |
*
|
|
sl@0
|
150 |
* @param aBlockedPINParams Information about the PIN to unblock
|
|
sl@0
|
151 |
* @param aUnblockingPINParams Information about the unblocking PIN
|
|
sl@0
|
152 |
* @param aRetry Indicates whether the user is retrying
|
|
sl@0
|
153 |
* @param aUnblockingPINValue On return, the PIN the user entered
|
|
sl@0
|
154 |
* @param aNewPINValue On return, the new PIN the user entered
|
|
sl@0
|
155 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
156 |
* be presented to the user.
|
|
sl@0
|
157 |
*/
|
|
sl@0
|
158 |
virtual void UnblockPIN( const TPINParams& aBlockedPINParams,
|
|
sl@0
|
159 |
const TPINParams& aUnblockingPINParams, TBool aRetry,
|
|
sl@0
|
160 |
TPINValue& aUnblockingPINValue, TPINValue& aNewPINValue,
|
|
sl@0
|
161 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/**
|
|
sl@0
|
164 |
* Informs the user that the PIN has become blocked.
|
|
sl@0
|
165 |
*
|
|
sl@0
|
166 |
* @param aPINParams Information about the blocked PIN.
|
|
sl@0
|
167 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
168 |
* be presented to the user.
|
|
sl@0
|
169 |
*/
|
|
sl@0
|
170 |
virtual void PINBlocked( const TPINParams& aPINParams, TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
171 |
|
|
sl@0
|
172 |
|
|
sl@0
|
173 |
/**
|
|
sl@0
|
174 |
* Informs the user that a secure connection is being established with the given
|
|
sl@0
|
175 |
* server, allowing them to proceed or cancel the operation.
|
|
sl@0
|
176 |
*
|
|
sl@0
|
177 |
* @param aCertData The certificate sent by the server.
|
|
sl@0
|
178 |
* @param aCertHandleList A selection of certificates to display to the user. All
|
|
sl@0
|
179 |
* certificates are displayed if this is empty.
|
|
sl@0
|
180 |
* @param aConnectionType This allows the type of certificate to be identified.
|
|
sl@0
|
181 |
* @param aDoClientAuthentication Determines whether the user is prompted to
|
|
sl@0
|
182 |
* agree to authenticate themselves to the server.
|
|
sl@0
|
183 |
* If this was true before the function was called, it
|
|
sl@0
|
184 |
* will contain the result of the user's decision on return.
|
|
sl@0
|
185 |
* @param aCertHandle An identifier for the certificate the user selected.
|
|
sl@0
|
186 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
187 |
* be presented to the user.
|
|
sl@0
|
188 |
*/
|
|
sl@0
|
189 |
virtual void EstablishSecureConnection( const TDesC8& aCertData,
|
|
sl@0
|
190 |
const RArray<TCTTokenObjectHandle>& aCertHandleList,
|
|
sl@0
|
191 |
MSecurityDialog::TConnectionType aConnectionType,
|
|
sl@0
|
192 |
TBool& aDoClientAuthentication, TCTTokenObjectHandle& aCertHandle,
|
|
sl@0
|
193 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
194 |
|
|
sl@0
|
195 |
/**
|
|
sl@0
|
196 |
* Signs some text.
|
|
sl@0
|
197 |
*
|
|
sl@0
|
198 |
* @param aTextToSign The text to be signed.
|
|
sl@0
|
199 |
* @param aCertHandleList A selection of certificates to display to the user.
|
|
sl@0
|
200 |
* All certificates are displayed if this is empty.
|
|
sl@0
|
201 |
* @param aCertHandle On return, an identifier for the certificate the user selected.
|
|
sl@0
|
202 |
* aStatus - this will be set to KErrNotFound if no certificates
|
|
sl@0
|
203 |
* could be presented to the user.
|
|
sl@0
|
204 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
205 |
* be presented to the user.
|
|
sl@0
|
206 |
*/
|
|
sl@0
|
207 |
virtual void SignText( const TDesC& aTextToSign,
|
|
sl@0
|
208 |
const RArray<TCTTokenObjectHandle>& aCertHandleList,
|
|
sl@0
|
209 |
TCTTokenObjectHandle& aCertHandle,
|
|
sl@0
|
210 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
211 |
|
|
sl@0
|
212 |
/**
|
|
sl@0
|
213 |
* Frees resources of the MSecurityDialog class
|
|
sl@0
|
214 |
*/
|
|
sl@0
|
215 |
virtual void Release()=0;
|
|
sl@0
|
216 |
/**
|
|
sl@0
|
217 |
* Informs the user that the server authentication has failed.
|
|
sl@0
|
218 |
*
|
|
sl@0
|
219 |
* @param aServerName The name of the server.
|
|
sl@0
|
220 |
* @param aFailurereason The server authentication failure reason
|
|
sl@0
|
221 |
* @param aencodedCert The certificate sent by the server.
|
|
sl@0
|
222 |
* @param aStatus This will be set to KErrNone or KErrAbort depending upon
|
|
sl@0
|
223 |
* the EContinue or EStop.
|
|
sl@0
|
224 |
*
|
|
sl@0
|
225 |
*/
|
|
sl@0
|
226 |
virtual void ServerAuthenticationFailure(const TDesC8& aServerName,
|
|
sl@0
|
227 |
const TValidationError& aFailureReason, const TDesC8& aEncodedCert,
|
|
sl@0
|
228 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
229 |
|
|
sl@0
|
230 |
protected:
|
|
sl@0
|
231 |
/**
|
|
sl@0
|
232 |
* Destructor for the MSecurityDialog class
|
|
sl@0
|
233 |
*/
|
|
sl@0
|
234 |
inline virtual ~MSecurityDialog()=0;
|
|
sl@0
|
235 |
public:
|
|
sl@0
|
236 |
// This is at the end to preserve BC
|
|
sl@0
|
237 |
/**
|
|
sl@0
|
238 |
* Informs the user that the unblock PIN has been blocked.
|
|
sl@0
|
239 |
*
|
|
sl@0
|
240 |
* @param aPINParams Information about the blocked PIN.
|
|
sl@0
|
241 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
242 |
* be presented to the user.
|
|
sl@0
|
243 |
*/
|
|
sl@0
|
244 |
virtual void TotalBlocked( const TPINParams& aPINParams, TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
245 |
|
|
sl@0
|
246 |
/**
|
|
sl@0
|
247 |
* Prompts the user to unblock a PIN.
|
|
sl@0
|
248 |
*
|
|
sl@0
|
249 |
* The unblocking PIN is displayed to the user in the clear as it is
|
|
sl@0
|
250 |
* entered, and can be a maximum of 64 characters long - it is passed back
|
|
sl@0
|
251 |
* as a TUnblockPINValue.
|
|
sl@0
|
252 |
*
|
|
sl@0
|
253 |
* @param aBlockedPINParams Information about the PIN to unblock
|
|
sl@0
|
254 |
* @param aUnblockingPINParams Information about the unblocking PIN
|
|
sl@0
|
255 |
* @param aRetry Indicates whether the user is retrying
|
|
sl@0
|
256 |
* @param aUnblockingPINValue On return, the PIN the user entered
|
|
sl@0
|
257 |
* @param aNewPINValue On return, the new PIN the user entered
|
|
sl@0
|
258 |
* @param aStatus This will be set to KErrNotFound if no certificates could
|
|
sl@0
|
259 |
* be presented to the user.
|
|
sl@0
|
260 |
*/
|
|
sl@0
|
261 |
virtual void UnblockPINInClear( const TPINParams& aBlockedPINParams,
|
|
sl@0
|
262 |
const TPINParams& aUnblockingPINParams, TBool aRetry,
|
|
sl@0
|
263 |
TUnblockPINValue& aUnblockingPINValue, TPINValue& aNewPINValue,
|
|
sl@0
|
264 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
265 |
|
|
sl@0
|
266 |
/**
|
|
sl@0
|
267 |
* Cancels an ongoing dialog.
|
|
sl@0
|
268 |
*/
|
|
sl@0
|
269 |
virtual void Cancel() = 0;
|
|
sl@0
|
270 |
};
|
|
sl@0
|
271 |
|
|
sl@0
|
272 |
inline MSecurityDialog::~MSecurityDialog() {}
|
|
sl@0
|
273 |
|
|
sl@0
|
274 |
/**
|
|
sl@0
|
275 |
* Factory for creating the relevant concrete subclass of the security dialog
|
|
sl@0
|
276 |
*/
|
|
sl@0
|
277 |
class SecurityDialogFactory
|
|
sl@0
|
278 |
{
|
|
sl@0
|
279 |
public:
|
|
sl@0
|
280 |
/**
|
|
sl@0
|
281 |
* Creates an instance of a subclass of MSecurityDialog. Implement to create
|
|
sl@0
|
282 |
* the appropriate security dialog
|
|
sl@0
|
283 |
*
|
|
sl@0
|
284 |
* @return An object that implements MSecurityDialog functions
|
|
sl@0
|
285 |
*/
|
|
sl@0
|
286 |
IMPORT_C static MSecurityDialog* CreateL();
|
|
sl@0
|
287 |
};
|
|
sl@0
|
288 |
|
|
sl@0
|
289 |
|
|
sl@0
|
290 |
#endif
|