-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenscp.html
More file actions
637 lines (548 loc) · 56.7 KB
/
openscp.html
File metadata and controls
637 lines (548 loc) · 56.7 KB
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>openscp package — OpenSCP-Python documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="openscp" href="modules.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="openscp-package">
<h1>openscp package<a class="headerlink" href="#openscp-package" title="Permalink to this heading">¶</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">¶</a></h2>
</section>
<section id="module-openscp.aes_alg">
<span id="openscp-aes-alg-module"></span><h2>openscp.aes_alg module<a class="headerlink" href="#module-openscp.aes_alg" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.aes_alg.AesAlg">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.aes_alg.</span></span><span class="sig-name descname"><span class="pre">AesAlg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.aes_alg.AesAlg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>AES algorithm, which defines AES session keys size</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.aes_alg.AesAlg.AES_128">
<span class="sig-name descname"><span class="pre">AES_128</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.aes_alg.AesAlg.AES_128" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.aes_alg.AesAlg.AES_192">
<span class="sig-name descname"><span class="pre">AES_192</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.aes_alg.AesAlg.AES_192" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.aes_alg.AesAlg.AES_256">
<span class="sig-name descname"><span class="pre">AES_256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.aes_alg.AesAlg.AES_256" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-openscp.apdu">
<span id="openscp-apdu-module"></span><h2>openscp.apdu module<a class="headerlink" href="#module-openscp.apdu" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.apdu.Apdu">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.apdu.</span></span><span class="sig-name descname"><span class="pre">Apdu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cla</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">le</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_add_le</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.apdu.Apdu" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Data holder class for ISO 7816 Command APDU representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cla</strong> – CAPDU class byte (CLA)</p></li>
<li><p><strong>ins</strong> – CAPDU instruction byte (INS)</p></li>
<li><p><strong>p1</strong> – CAPDU parameter #1 byte (P1)</p></li>
<li><p><strong>p2</strong> – CAPDU parameter #2 byte (P2)</p></li>
<li><p><strong>data</strong> – CAPDU data bytes</p></li>
<li><p><strong>le</strong> – response length expected (Le)</p></li>
<li><p><strong>force_add_le</strong> – force addition of 0x00 Le byte to the resulting CAPDU bytes</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.cla">
<span class="sig-name descname"><span class="pre">cla</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.apdu.Apdu.cla" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em><a class="headerlink" href="#openscp.apdu.Apdu.data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.force_add_le">
<span class="sig-name descname"><span class="pre">force_add_le</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#openscp.apdu.Apdu.force_add_le" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.ins">
<span class="sig-name descname"><span class="pre">ins</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.apdu.Apdu.ins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.le">
<span class="sig-name descname"><span class="pre">le</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.apdu.Apdu.le" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.p1">
<span class="sig-name descname"><span class="pre">p1</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.apdu.Apdu.p1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.apdu.Apdu.p2">
<span class="sig-name descname"><span class="pre">p2</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.apdu.Apdu.p2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="openscp-connection-module">
<h2>openscp.connection module<a class="headerlink" href="#openscp-connection-module" title="Permalink to this heading">¶</a></h2>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.connection.SmartCardConnection">
<span class="sig-prename descclassname"><span class="pre">openscp.connection.</span></span><span class="sig-name descname"><span class="pre">SmartCardConnection</span></span><a class="headerlink" href="#openscp.connection.SmartCardConnection" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">SmartCardConnection</span></code></p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="openscp.connection.SmartCardConnection.send_and_receive">
<span class="sig-prename descclassname"><span class="pre">openscp.connection.SmartCardConnection.</span></span><span class="sig-name descname"><span class="pre">send_and_receive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apdu</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.connection.SmartCardConnection.send_and_receive" title="Permalink to this definition">¶</a></dt>
<dd><p>APDU processing callback. Will be called when library code will need communicate with a smart card.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>apdu</strong> – Command APDU bytes</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Response APDU bytes</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="openscp.connection.SmartCardConnection.is_extended_length_apdu_supported">
<span class="sig-prename descclassname"><span class="pre">openscp.connection.SmartCardConnection.</span></span><span class="sig-name descname"><span class="pre">is_extended_length_apdu_supported</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#openscp.connection.SmartCardConnection.is_extended_length_apdu_supported" title="Permalink to this definition">¶</a></dt>
<dd><p>Will be called at the connection start to choose the APDU size to use.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>is extended APDU length supported by a smart card</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="openscp.connection.SmartCardConnection.close_connection">
<span class="sig-prename descclassname"><span class="pre">openscp.connection.SmartCardConnection.</span></span><span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#openscp.connection.SmartCardConnection.close_connection" title="Permalink to this definition">¶</a></dt>
<dd><p>Smart card connection closure callback. Will be called at the end of the session.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>None</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-openscp.scp_certificate">
<span id="openscp-scp-certificate-module"></span><h2>openscp.scp_certificate module<a class="headerlink" href="#module-openscp.scp_certificate" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.scp_certificate.ScpCertificate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.scp_certificate.</span></span><span class="sig-name descname"><span class="pre">ScpCertificate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.scp_certificate.ScpCertificate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>SCP certificate class for SCP11 v1.4 usage</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>certificate</strong> – Java SCP certificate instance</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.scp_certificate.ScpCertificate.get_encoded">
<span class="sig-name descname"><span class="pre">get_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.scp_certificate.ScpCertificate.get_encoded" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>encoded certificate bytes</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.scp_certificate.ScpCertificate.get_public_key">
<span class="sig-name descname"><span class="pre">get_public_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.scp_certificate.ScpCertificate.get_public_key" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>certificate public key bytes</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-openscp.scp_mode">
<span id="openscp-scp-mode-module"></span><h2>openscp.scp_mode module<a class="headerlink" href="#module-openscp.scp_mode" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.scp_mode.ScpMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.scp_mode.</span></span><span class="sig-name descname"><span class="pre">ScpMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.scp_mode.ScpMode" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>SCP mode, which defines size of challenges, cryptograms and MACs</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.scp_mode.ScpMode.S16">
<span class="sig-name descname"><span class="pre">S16</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.ScpMode'></span></em><a class="headerlink" href="#openscp.scp_mode.ScpMode.S16" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.scp_mode.ScpMode.S8">
<span class="sig-name descname"><span class="pre">S8</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.ScpMode'></span></em><a class="headerlink" href="#openscp.scp_mode.ScpMode.S8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-openscp.session">
<span id="openscp-session-module"></span><h2>openscp.session module<a class="headerlink" href="#module-openscp.session" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.session.SecurityDomainSession">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.session.</span></span><span class="sig-name descname"><span class="pre">SecurityDomainSession</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">SmartCardConnection</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.session.SecurityDomainSession" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>SCP03 and SCP11 session implementation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>connection</strong> – <a class="reference internal" href="#openscp.SmartCardConnection" title="openscp.SmartCardConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">openscp.SmartCardConnection</span></code></a> interface implementation</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.session.SecurityDomainSession.authenticate_scp03">
<span class="sig-name descname"><span class="pre">authenticate_scp03</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enc_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mac_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dek_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scp_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.scp_mode.ScpMode" title="openscp.scp_mode.ScpMode"><span class="pre">ScpMode</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#openscp.session.SecurityDomainSession.authenticate_scp03" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform SCP03 authentication - execute INITIALIZE UPDATE & EXTERNAL AUTHENTICATE commands</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_id</strong> – SCP key identifier</p></li>
<li><p><strong>key_version</strong> – SCP key version number</p></li>
<li><p><strong>enc_key</strong> – static secure channel encryption key</p></li>
<li><p><strong>mac_key</strong> – static secure channel message authentication code key</p></li>
<li><p><strong>dek_key</strong> – static data encryption key</p></li>
<li><p><strong>scp_mode</strong> – SCP mode - S8 or S16</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.session.SecurityDomainSession.authenticate_scp11">
<span class="sig-name descname"><span class="pre">authenticate_scp11</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sd_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sd_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oce_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oce_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk_sd_ecka_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_chain_oce_ecka</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sk_oce_ecka_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_keys_alg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.aes_alg.AesAlg" title="openscp.aes_alg.AesAlg"><span class="pre">AesAlg</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">scp_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.scp_mode.ScpMode" title="openscp.scp_mode.ScpMode"><span class="pre">ScpMode</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#openscp.session.SecurityDomainSession.authenticate_scp11" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform SCP11 authentication - execute PERFORM_SECURITY_OPERATION & MUTUAL_AUTHENTICATE commands</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sd_key_id</strong> – security domain SCP key identifier of associated SK.SD.ECKA</p></li>
<li><p><strong>sd_key_version</strong> – security domain SCP key version number of associated SK.SD.ECKA</p></li>
<li><p><strong>oce_key_id</strong> – off-card entity SCP key identifier of associated SK.OCE.ECKA</p></li>
<li><p><strong>oce_key_version</strong> – off-card entity SCP key version number of associated SK.OCE.ECKA</p></li>
<li><p><strong>pk_sd_ecka_bytes</strong> – public key of the SD used for key agreement in encoded form (PK.SD.ECKA)</p></li>
<li><p><strong>cert_chain_oce_ecka</strong> – certificate chain including the certificate containing the public key of the OCE
used for key agreement in encoded form (CERT.OCE.ECKA)</p></li>
<li><p><strong>sk_oce_ecka_bytes</strong> – private key of the OCE used for key agreement in encoded form (SK.OCE.ECKA)</p></li>
<li><p><strong>session_keys_alg</strong> – AES algorithm for session keys that will be generated</p></li>
<li><p><strong>scp_mode</strong> – SCP mode - S8 or S16</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.session.SecurityDomainSession.get_certificate_bundle">
<span class="sig-name descname"><span class="pre">get_certificate_bundle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sd_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sd_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#openscp.scp_certificate.ScpCertificate" title="openscp.scp_certificate.ScpCertificate"><span class="pre">ScpCertificate</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#openscp.session.SecurityDomainSession.get_certificate_bundle" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve an SCP11 Certificate Store from smart card</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sd_key_id</strong> – security domain SCP key identifier of associated SK.SD.ECKA</p></li>
<li><p><strong>sd_key_version</strong> – security domain SCP key version number of associated SK.SD.ECKA</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of certificates from smart card</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.session.SecurityDomainSession.send_and_receive">
<span class="sig-name descname"><span class="pre">send_and_receive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capdu</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.apdu.Apdu" title="openscp.apdu.Apdu"><span class="pre">Apdu</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.session.SecurityDomainSession.send_and_receive" title="Permalink to this definition">¶</a></dt>
<dd><p>Send Command APDU, wait for Response APDU from smart card</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>capdu</strong> – Command APDU bytes</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Response APDU data bytes</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-openscp.utils">
<span id="openscp-utils-module"></span><h2>openscp.utils module<a class="headerlink" href="#module-openscp.utils" title="Permalink to this heading">¶</a></h2>
</section>
<section id="module-openscp">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-openscp" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.AesAlg">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">AesAlg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.AesAlg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>AES algorithm, which defines AES session keys size</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.AesAlg.AES_128">
<span class="sig-name descname"><span class="pre">AES_128</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.AesAlg.AES_128" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.AesAlg.AES_192">
<span class="sig-name descname"><span class="pre">AES_192</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.AesAlg.AES_192" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.AesAlg.AES_256">
<span class="sig-name descname"><span class="pre">AES_256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.AesAlg'></span></em><a class="headerlink" href="#openscp.AesAlg.AES_256" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.Apdu">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">Apdu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cla</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">le</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_add_le</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.Apdu" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Data holder class for ISO 7816 Command APDU representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cla</strong> – CAPDU class byte (CLA)</p></li>
<li><p><strong>ins</strong> – CAPDU instruction byte (INS)</p></li>
<li><p><strong>p1</strong> – CAPDU parameter #1 byte (P1)</p></li>
<li><p><strong>p2</strong> – CAPDU parameter #2 byte (P2)</p></li>
<li><p><strong>data</strong> – CAPDU data bytes</p></li>
<li><p><strong>le</strong> – response length expected (Le)</p></li>
<li><p><strong>force_add_le</strong> – force addition of 0x00 Le byte to the resulting CAPDU bytes</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.cla">
<span class="sig-name descname"><span class="pre">cla</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.Apdu.cla" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em><a class="headerlink" href="#openscp.Apdu.data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.force_add_le">
<span class="sig-name descname"><span class="pre">force_add_le</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#openscp.Apdu.force_add_le" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.ins">
<span class="sig-name descname"><span class="pre">ins</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.Apdu.ins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.le">
<span class="sig-name descname"><span class="pre">le</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.Apdu.le" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.p1">
<span class="sig-name descname"><span class="pre">p1</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.Apdu.p1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.Apdu.p2">
<span class="sig-name descname"><span class="pre">p2</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#openscp.Apdu.p2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.ScpCertificate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">ScpCertificate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.ScpCertificate" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>SCP certificate class for SCP11 v1.4 usage</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>certificate</strong> – Java SCP certificate instance</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.ScpCertificate.get_encoded">
<span class="sig-name descname"><span class="pre">get_encoded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.ScpCertificate.get_encoded" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>encoded certificate bytes</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.ScpCertificate.get_public_key">
<span class="sig-name descname"><span class="pre">get_public_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.ScpCertificate.get_public_key" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>certificate public key bytes</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.ScpMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">ScpMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.ScpMode" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>SCP mode, which defines size of challenges, cryptograms and MACs</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.ScpMode.S16">
<span class="sig-name descname"><span class="pre">S16</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.ScpMode'></span></em><a class="headerlink" href="#openscp.ScpMode.S16" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.ScpMode.S8">
<span class="sig-name descname"><span class="pre">S8</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><java</span> <span class="pre">object</span> <span class="pre">'com.samsung.openscp.ScpMode'></span></em><a class="headerlink" href="#openscp.ScpMode.S8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="openscp.SecurityDomainSession">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">SecurityDomainSession</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">SmartCardConnection</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openscp.SecurityDomainSession" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>SCP03 and SCP11 session implementation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>connection</strong> – <a class="reference internal" href="#openscp.SmartCardConnection" title="openscp.SmartCardConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">openscp.SmartCardConnection</span></code></a> interface implementation</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.SecurityDomainSession.authenticate_scp03">
<span class="sig-name descname"><span class="pre">authenticate_scp03</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enc_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mac_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dek_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scp_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.scp_mode.ScpMode" title="openscp.scp_mode.ScpMode"><span class="pre">ScpMode</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#openscp.SecurityDomainSession.authenticate_scp03" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform SCP03 authentication - execute INITIALIZE UPDATE & EXTERNAL AUTHENTICATE commands</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_id</strong> – SCP key identifier</p></li>
<li><p><strong>key_version</strong> – SCP key version number</p></li>
<li><p><strong>enc_key</strong> – static secure channel encryption key</p></li>
<li><p><strong>mac_key</strong> – static secure channel message authentication code key</p></li>
<li><p><strong>dek_key</strong> – static data encryption key</p></li>
<li><p><strong>scp_mode</strong> – SCP mode - S8 or S16</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.SecurityDomainSession.authenticate_scp11">
<span class="sig-name descname"><span class="pre">authenticate_scp11</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sd_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sd_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oce_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oce_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk_sd_ecka_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_chain_oce_ecka</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sk_oce_ecka_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_keys_alg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.aes_alg.AesAlg" title="openscp.aes_alg.AesAlg"><span class="pre">AesAlg</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">scp_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.scp_mode.ScpMode" title="openscp.scp_mode.ScpMode"><span class="pre">ScpMode</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#openscp.SecurityDomainSession.authenticate_scp11" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform SCP11 authentication - execute PERFORM_SECURITY_OPERATION & MUTUAL_AUTHENTICATE commands</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sd_key_id</strong> – security domain SCP key identifier of associated SK.SD.ECKA</p></li>
<li><p><strong>sd_key_version</strong> – security domain SCP key version number of associated SK.SD.ECKA</p></li>
<li><p><strong>oce_key_id</strong> – off-card entity SCP key identifier of associated SK.OCE.ECKA</p></li>
<li><p><strong>oce_key_version</strong> – off-card entity SCP key version number of associated SK.OCE.ECKA</p></li>
<li><p><strong>pk_sd_ecka_bytes</strong> – public key of the SD used for key agreement in encoded form (PK.SD.ECKA)</p></li>
<li><p><strong>cert_chain_oce_ecka</strong> – certificate chain including the certificate containing the public key of the OCE
used for key agreement in encoded form (CERT.OCE.ECKA)</p></li>
<li><p><strong>sk_oce_ecka_bytes</strong> – private key of the OCE used for key agreement in encoded form (SK.OCE.ECKA)</p></li>
<li><p><strong>session_keys_alg</strong> – AES algorithm for session keys that will be generated</p></li>
<li><p><strong>scp_mode</strong> – SCP mode - S8 or S16</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.SecurityDomainSession.get_certificate_bundle">
<span class="sig-name descname"><span class="pre">get_certificate_bundle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sd_key_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sd_key_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#openscp.scp_certificate.ScpCertificate" title="openscp.scp_certificate.ScpCertificate"><span class="pre">ScpCertificate</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#openscp.SecurityDomainSession.get_certificate_bundle" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve an SCP11 Certificate Store from smart card</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sd_key_id</strong> – security domain SCP key identifier of associated SK.SD.ECKA</p></li>
<li><p><strong>sd_key_version</strong> – security domain SCP key version number of associated SK.SD.ECKA</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of certificates from smart card</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>exceptions from underlying Java library</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="openscp.SecurityDomainSession.send_and_receive">
<span class="sig-name descname"><span class="pre">send_and_receive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capdu</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#openscp.apdu.Apdu" title="openscp.apdu.Apdu"><span class="pre">Apdu</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#openscp.SecurityDomainSession.send_and_receive" title="Permalink to this definition">¶</a></dt>
<dd><p>Send Command APDU, wait for Response APDU from smart card</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>capdu</strong> – Command APDU bytes</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Response APDU data bytes</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="openscp.SmartCardConnection">
<span class="sig-prename descclassname"><span class="pre">openscp.</span></span><span class="sig-name descname"><span class="pre">SmartCardConnection</span></span><a class="headerlink" href="#openscp.SmartCardConnection" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">SmartCardConnection</span></code></p>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">OpenSCP-Python</a></h1>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">openscp</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">openscp package</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">openscp</a><ul>
<li>Previous: <a href="modules.html" title="previous chapter">openscp</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2025 Samsung Electronics Co, Ltd.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/openscp.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>