summaryrefslogtreecommitdiff
path: root/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs
blob: 06ef7cb6e2bd2643ab3774fb9bc640b5f312ace4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/*
 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System;
using System.Runtime.InteropServices;
using System.Collections.Generic;

namespace Tizen.Network.Nfc
{
    /// <summary>
    /// A class for NFC CardEmulation mode. It allows applications to handle Card Emulation informations.
    /// </summary>
    /// <since_tizen> 3 </since_tizen>
    /// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
    public class NfcCardEmulationAdapter : IDisposable
    {
        private bool disposed = false;

        private event EventHandler<SecureElementEventArgs> _secureElementEvent;
        private event EventHandler<SecureElementTranscationEventArgs> _secureElementTransactionEvent;
        private event EventHandler<HostCardEmulationEventArgs> _hostCardEmulationEvent;

        private Interop.Nfc.SecureElementEventCallback _secureElementEventCallback;
        private Interop.Nfc.SecureElementTransactionEventCallback _secureElementTransactionEventCallback;
        private Interop.Nfc.HostCardEmulationEventCallback _hostCardEmulationEventCallback;

        /// <summary>
        /// Event that is called when receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public event EventHandler<SecureElementEventArgs> SecureElementEvent
        {
            add
            {
                if (_secureElementEvent == null)
                {
                    RegisterSecureElementEvent();
                }
                _secureElementEvent += value;
            }
            remove
            {
                _secureElementEvent -= value;
                if (_secureElementEvent == null)
                {
                    UnregisterSecureElementEvent();
                }
            }
        }

        /// <summary>
        /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'ESE(SmartMX)' type.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public event EventHandler<SecureElementTranscationEventArgs> EseSecureElementTransactionEvent
        {
            add
            {
                if (_secureElementTransactionEvent == null)
                {
                    RegisterSecureElementTransactionEvent(NfcSecureElementType.EmbeddedSE);
                }
                _secureElementTransactionEvent += value;
            }
            remove
            {
                _secureElementTransactionEvent -= value;
                if (_secureElementTransactionEvent == null)
                {
                    UnregisterSecureElementTransactionEvent(NfcSecureElementType.EmbeddedSE);
                }
            }
        }

        /// <summary>
        /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'UICC' type.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public event EventHandler<SecureElementTranscationEventArgs> UiccSecureElementTransactionEvent
        {
            add
            {
                if (_secureElementTransactionEvent == null)
                {
                    RegisterSecureElementTransactionEvent(NfcSecureElementType.Uicc);
                }
                _secureElementTransactionEvent += value;
            }
            remove
            {
                _secureElementTransactionEvent -= value;
                if (_secureElementTransactionEvent == null)
                {
                    UnregisterSecureElementTransactionEvent(NfcSecureElementType.Uicc);
                }
            }
        }

        /// <summary>
        /// Event that is called when when receiving HCE(Host Card Emulation) event.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public event EventHandler<HostCardEmulationEventArgs> HostCardEmulationEvent
        {
            add
            {
                if (_hostCardEmulationEvent == null)
                {
                    RegisterHostCardEmulationEvent();
                }
                _hostCardEmulationEvent += value;
            }
            remove
            {
                _hostCardEmulationEvent -= value;
                if (_hostCardEmulationEvent == null)
                {
                    UnregisterHostCardEmulationEvent();
                }
            }
        }

        internal NfcCardEmulationAdapter()
        {
        }

        ~NfcCardEmulationAdapter()
        {
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        private void Dispose(bool disposing)
        {
            if (disposed)
                return;

            if (disposing)
            {
                // Free managed objects.
            }
            //Free unmanaged objects
            disposed = true;
        }

        /// <summary>
        /// Enable card emulation mode.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void EnableCardEmulation()
        {
            int ret = Interop.Nfc.CardEmulation.EnableCardEmulation();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to enable card emulation mode, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Disable card emulation mode.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void DisableCardEmulation()
        {
            int ret = Interop.Nfc.CardEmulation.DisableCardEmulatiion();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to disable card emulation mode, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Get the current card emulation mode.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <returns>Enumeration value of NfcSecureElementCardEmulationMode.</returns>
        public NfcSecureElementCardEmulationMode GetCardEmulationMode()
        {
            int mode = 0;
            int ret = Interop.Nfc.CardEmulation.GetCardEmulationMode(out mode);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to get card emulation mode, Error - " + (NfcError)ret);
            }

            return (NfcSecureElementCardEmulationMode)mode;
        }

        /// <summary>
        /// Give the priority to the foreground application when dispatching transaction event.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void EnableTransactionForegroundDispatch()
        {
            int ret = Interop.Nfc.EnableTransactionForegroundDispatch();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to enable foreground dispatch, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Disable foreground dispatch for "EVT_TRANSACTION" to the givin application.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void DisableTransactionForegroundDispatch()
        {
            int ret = Interop.Nfc.DisableTransactionForegroundDispatch();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to disable foreground dispatch, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Gets the state whether an application to call this api is currently the activated handler for specific AID.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <returns>'True' when application is currently the activated handler, otherwise 'False'.</returns>
        /// <param name="seType">The type of Secure Element.</param>
        /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param>
        public bool IsActivatedHandlerForAid(NfcSecureElementType seType, string aid)
        {
            bool isActivatedHandle = false;
            int ret = Interop.Nfc.CardEmulation.IsActivatedHandlerForAid((int)seType, aid, out isActivatedHandle);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to check activated handle for aid, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }

            return isActivatedHandle;
        }

        /// <summary>
        /// Gets the state whether an application to call this api is currently the activated handler for category.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <returns>'True' when application is currently the activated handler, otherwise 'False'.</returns>
        /// <param name="seType">The type of Secure Element.</param>
        /// <param name="category">Enumeration value of category.</param>
        public bool IsActivatedHandlerForCategory(NfcSecureElementType seType, NfcCardEmulationCategoryType category)
        {
            bool isActivatedHandle = false;
            int ret = Interop.Nfc.CardEmulation.IsActivatedHandlerForCategory((int)seType, (int)category, out isActivatedHandle);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to check activated handle for category, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }

            return isActivatedHandle;
        }

        /// <summary>
        /// Registers a AID for a specific category.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="seType">The type of Secure Element.</param>
        /// <param name="category">Enumeration value of category.</param>
        /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param>
        public void RegisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)
        {
            int ret = Interop.Nfc.CardEmulation.RegisterAid((int)seType, (int)category, aid);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to register aid, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Unregisters a previously registered AID for the specified category.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <param name="seType">The type of Secure Element.</param>
        /// <param name="category">Enumeration value of category.</param>
        /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param>
        public void UnregisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)
        {
            int ret = Interop.Nfc.CardEmulation.UnregisterAid((int)seType, (int)category, aid);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to unregister aid, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Sets the application as a preferred handler.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void SetPreferredApplication()
        {
            int ret = Interop.Nfc.CardEmulation.SetPreferredHandler();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to set preferred handler, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Unsets the application as a preferred handler.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        public void UnsetPreferredApplication()
        {
            int ret = Interop.Nfc.CardEmulation.UnsetPreferredHandler();
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to unset preferred handler, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        /// <summary>
        /// Retrieves all registered AID.
        /// </summary>
        /// <since_tizen> 3 </since_tizen>
        /// <returns>List of NfcRegisteredAidInformation objects.</returns>
        /// <param name="seType">The type of Secure Element.</param>
        /// <param name="category">Enumeration value of category.</param>
        public IEnumerable<NfcRegisteredAidInformation> GetRegisteredAidInformation(NfcSecureElementType seType, NfcCardEmulationCategoryType category)
        {
            List<NfcRegisteredAidInformation> infoList = new List<NfcRegisteredAidInformation>();
            Interop.Nfc.SecureElementRegisteredAidCallback callback = (int type, IntPtr aid, bool readOnly, IntPtr userData) =>
            {
                if (aid != IntPtr.Zero)
                {
                    NfcRegisteredAidInformation aidInfo = new NfcRegisteredAidInformation((NfcSecureElementType)type, Marshal.PtrToStringAnsi(aid), readOnly);

                    infoList.Add(aidInfo);
                }
            };

            int ret = Interop.Nfc.CardEmulation.ForeachRegisterdAids((int)seType, (int)category, callback, IntPtr.Zero);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to get all registerd aid informations, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }

            return infoList;
        }

        private void RegisterSecureElementEvent()
        {
            _secureElementEventCallback = (int eventType, IntPtr userData) =>
            {
                NfcSecureElementEvent _eventType = (NfcSecureElementEvent)eventType;
                SecureElementEventArgs e = new SecureElementEventArgs(_eventType);
                _secureElementEvent.SafeInvoke(null, e);
            };

            int ret = Interop.Nfc.SetSecureElementEventCallback(_secureElementEventCallback, IntPtr.Zero);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to set secure element event callback, Error - " + (NfcError)ret);
            }
        }

        private void UnregisterSecureElementEvent()
        {
            Interop.Nfc.UnsetSecureElementEventCallback();
        }

        private void RegisterSecureElementTransactionEvent(NfcSecureElementType seType)
        {
            _secureElementTransactionEventCallback = (int type, IntPtr aid, int aidSize, IntPtr param, int paramSize, IntPtr userData) =>
            {
                NfcSecureElementType _secureElementType = (NfcSecureElementType)type;
                byte[] _aid = NfcConvertUtil.IntLengthIntPtrToByteArray(aid, aidSize);
                byte[] _param = NfcConvertUtil.IntLengthIntPtrToByteArray(param, paramSize);
                SecureElementTranscationEventArgs e = new SecureElementTranscationEventArgs(_secureElementType, _aid, _param);
                _secureElementTransactionEvent.SafeInvoke(null, e);
            };

            int ret = Interop.Nfc.SetSecureElementTransactionEventCallback((int)seType, _secureElementTransactionEventCallback, IntPtr.Zero);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to set secure element transaction event callback, Error - " + (NfcError)ret);
            }
        }

        private void UnregisterSecureElementTransactionEvent(NfcSecureElementType seType)
        {
            Interop.Nfc.UnsetSecureElementTransactionEventCallback((int)seType);
        }

        private void RegisterHostCardEmulationEvent()
        {
            _hostCardEmulationEventCallback = (IntPtr handle, int eventType, IntPtr apdu, uint apduLen, IntPtr userData) =>
            {
                IntPtr _seHandle = handle;
                NfcHceEvent _hcdEventType = (NfcHceEvent)eventType;
                byte[] _apdu = NfcConvertUtil.UintLengthIntPtrToByteArray(apdu, apduLen);
                HostCardEmulationEventArgs e = new HostCardEmulationEventArgs(_seHandle, _hcdEventType, _apdu);
                _hostCardEmulationEvent.SafeInvoke(null, e);
            };

            int ret = Interop.Nfc.SetHostCardEmulationEventCallback(_hostCardEmulationEventCallback, IntPtr.Zero);
            if (ret != (int)NfcError.None)
            {
                Log.Error(Globals.LogTag, "Failed to set host card emulation event callback, Error - " + (NfcError)ret);
                NfcErrorFactory.ThrowNfcException(ret);
            }
        }

        private void UnregisterHostCardEmulationEvent()
        {
            Interop.Nfc.UnsetHostCardEmulationEventCallback();
        }
    }
}