| blob | 1cf347b1d0b425b8b6230270498bf687858bbaef |
1 {
2 "commands": {
3 "analyse a": {
4 "command": "analyse a",
5 "description": "Iceman's personal garbage test command",
6 "notes": [
7 "analyse a -d 137AF00A0A0D"
8 ],
9 "offline": true,
10 "options": [
11 "-h, --help This help",
12 "-d, --data <hex> bytes to manipulate"
13 ],
14 "usage": "analyse a [-h] -d <hex>"
15 },
16 "analyse chksum": {
17 "command": "analyse chksum",
18 "description": "The bytes will be added with eachother and than limited with the applied mask Finally compute ones' complement of the least significant bytes.",
19 "notes": [
20 "analyse chksum -d 137AF00A0A0D -> expected output: 0x61",
21 "analyse chksum -d 137AF00A0A0D -m FF"
22 ],
23 "offline": true,
24 "options": [
25 "-h, --help This help",
26 "-d, --data <hex> bytes to calc checksum",
27 "-m, --mask <hex> bit mask to limit the output (4 hex bytes max)",
28 "-v, --verbose verbose output"
29 ],
30 "usage": "analyse chksum [-hv] -d <hex> [-m <hex>]"
31 },
32 "analyse crc": {
33 "command": "analyse crc",
34 "description": "A stub method to test different crc implementations inside the PM3 sourcecode. Just because you figured out the poly, doesn't mean you get the desired output",
35 "notes": [
36 "analyse crc -d 137AF00A0A0D"
37 ],
38 "offline": true,
39 "options": [
40 "-h, --help This help",
41 "-d, --data <hex> bytes to calc crc"
42 ],
43 "usage": "analyse crc [-h] -d <hex>"
44 },
45 "analyse dates": {
46 "command": "analyse dates",
47 "description": "Tool to look for date/time stamps in a given array of bytes",
48 "notes": [
49 "analyse dates"
50 ],
51 "offline": true,
52 "options": [
53 "-h, --help This help"
54 ],
55 "usage": "analyse dates [-h]"
56 },
57 "analyse demodbuff": {
58 "command": "analyse demodbuff",
59 "description": "loads a binary string into DemodBuffer",
60 "notes": [
61 "analyse demodbuff -d 0011101001001011"
62 ],
63 "offline": true,
64 "options": [
65 "-h, --help This help",
66 "-d, --data <bin> binary string to load"
67 ],
68 "usage": "analyse demodbuff [-h] -d <bin>"
69 },
70 "analyse foo": {
71 "command": "analyse foo",
72 "description": "experiments of cliparse",
73 "notes": [
74 "analyse foo -r a0000000a0002021"
75 ],
76 "offline": true,
77 "options": [
78 "-h, --help This help",
79 "-r, --raw <hex> raw bytes"
80 ],
81 "usage": "analyse foo [-h] -r <hex>"
82 },
83 "analyse freq": {
84 "command": "analyse freq",
85 "description": "calc wave lengths",
86 "notes": [
87 "analyse freq"
88 ],
89 "offline": true,
90 "options": [
91 "-h, --help This help",
92 "-F, --freq <int> resonating frequency F in hertz (Hz)",
93 "-L, --cap <int> capacitance C in micro farads (F)",
94 "-C, --ind <int> inductance in micro henries (H)"
95 ],
96 "usage": "analyse freq [-h] [-F <int>] [-L <int>] [-C <int>]"
97 },
98 "analyse help": {
99 "command": "analyse help",
100 "description": "help This help lcr Generate final byte for XOR LRC crc Stub method for CRC evaluations chksum Checksum with adding, masking and one's complement dates Look for datestamps in a given array of bytes lfsr LFSR tests a num bits test nuid create NUID from 7byte UID demodbuff Load binary string to DemodBuffer freq Calc wave lengths foo muxer units convert ETU <> US <> SSP_CLK (3.39MHz) --------------------------------------------------------------------------------------- analyse lcr available offline: yes Specifying the bytes of a UID with a known LRC will find the last byte value needed to generate that LRC with a rolling XOR. All bytes should be specified in HEX.",
101 "notes": [
102 "analyse lcr -d 04008064BA -> Target (BA) requires final LRC XOR byte value: 5A"
103 ],
104 "offline": true,
105 "options": [
106 "-h, --help This help",
107 "-d, --data <hex> bytes to calc missing XOR in a LCR"
108 ],
109 "usage": "analyse lcr [-h] -d <hex>"
110 },
111 "analyse lfsr": {
112 "command": "analyse lfsr",
113 "description": "looks at LEGIC Prime's lfsr, iterates the first 48 values",
114 "notes": [
115 "analyse lfsr --iv 55"
116 ],
117 "offline": true,
118 "options": [
119 "-h, --help This help",
120 "--iv <hex> init vector data (1 hex byte)",
121 "--find <hex> lfsr data to find (1 hex byte)"
122 ],
123 "usage": "analyse lfsr [-h] --iv <hex> [--find <hex>]"
124 },
125 "analyse nuid": {
126 "command": "analyse nuid",
127 "description": "Generate 4byte NUID from 7byte UID",
128 "notes": [
129 "analyse nuid -d 11223344556677"
130 ],
131 "offline": true,
132 "options": [
133 "-h, --help This help",
134 "-d, --data <hex> bytes to send",
135 "-t, --test self test"
136 ],
137 "usage": "analyse nuid [-ht] [-d <hex>]"
138 },
139 "analyse units": {
140 "command": "analyse units",
141 "description": "experiments of unit conversions found in HF. ETU (1/13.56mhz), US or SSP_CLK (1/3.39MHz)",
142 "notes": [
143 "analyse uints --etu 10",
144 "analyse uints --us 100"
145 ],
146 "offline": true,
147 "options": [
148 "-h, --help This help",
149 "--etu <dec> number in ETU",
150 "--us <dec> number in micro seconds (us)",
151 "-t, --selftest self tests"
152 ],
153 "usage": "analyse units [-ht] [--etu <dec>] [--us <dec>]"
154 },
155 "clear": {
156 "command": "clear",
157 "description": "Clear the Proxmark3 client terminal screen",
158 "notes": [
159 "clear -> clear the terminal screen",
160 "clear -b -> clear the terminal screen and the scrollback buffer"
161 ],
162 "offline": true,
163 "options": [
164 "-h, --help This help",
165 "-b, --back also clear the scrollback buffer"
166 ],
167 "usage": "clear [-hb]"
168 },
169 "data askedgedetect": {
170 "command": "data askedgedetect",
171 "description": "Adjust Graph for manual ASK demod using the length of sample differences to detect the edge of a wave",
172 "notes": [
173 "data askedgedetect -t 20"
174 ],
175 "offline": true,
176 "options": [
177 "-h, --help This help",
178 "-t, --thres <dec> threshold, use 20 - 45 (def 25)"
179 ],
180 "usage": "data askedgedetect [-h] [-t <dec>]"
181 },
182 "data asn1": {
183 "command": "data asn1",
184 "description": "Decode ASN1 bytearray",
185 "notes": [
186 "data asn1 -d 303381050186922305a5020500a6088101010403030008a7188516eeee4facacf4fbde5e5c49d95e55bfbca74267b02407a9020500"
187 ],
188 "offline": true,
189 "options": [
190 "-h, --help This help",
191 "-d <hex> ASN1 encoded byte array",
192 "-t, --test perform self test"
193 ],
194 "usage": "data asn1 [-ht] [-d <hex>]"
195 },
196 "data atr": {
197 "command": "data atr",
198 "description": "look up ATR record from bytearray",
199 "notes": [
200 "data atr -d 3B6B00000031C064BE1B0100079000"
201 ],
202 "offline": true,
203 "options": [
204 "-h, --help This help",
205 "-d <hex> ASN1 encoded byte array"
206 ],
207 "usage": "data atr [-h] [-d <hex>]"
208 },
209 "data autocorr": {
210 "command": "data autocorr",
211 "description": "Autocorrelate over window is used to detect repeating sequences. We use it as detection of how long in bits a message inside the signal is",
212 "notes": [
213 "data autocorr -w 4000",
214 "data autocorr -w 4000 -g"
215 ],
216 "offline": true,
217 "options": [
218 "-h, --help This help",
219 "-g save back to GraphBuffer (overwrite)",
220 "-w, --win <dec> window length for correlation. def 4000"
221 ],
222 "usage": "data autocorr [-hg] [-w <dec>]"
223 },
224 "data biphaserawdecode": {
225 "command": "data biphaserawdecode",
226 "description": "Biphase decode binary stream in DemodBuffer Converts 10 or 01 -> 1 and 11 or 00 -> 0 - must have binary sequence in DemodBuffer (run `data rawdemod --ar` before) - invert for Conditional Dephase Encoding (CDP) AKA Differential Manchester",
227 "notes": [
228 "data biphaserawdecode -> decode biphase bitstream from the DemodBuffer",
229 "data biphaserawdecode -oi -> decode biphase bitstream from the DemodBuffer, adjust offset, and invert output"
230 ],
231 "offline": true,
232 "options": [
233 "-h, --help This help",
234 "-o, --offset set to adjust decode start position",
235 "-i, --inv invert output",
236 "--err <dec> set max errors tolerated (def 20)"
237 ],
238 "usage": "data biphaserawdecode [-hoi] [--err <dec>]"
239 },
240 "data bitsamples": {
241 "command": "data bitsamples",
242 "description": "Get raw samples from device as bitstring",
243 "notes": [
244 "data bitsamples"
245 ],
246 "offline": false,
247 "options": [
248 "-h, --help This help"
249 ],
250 "usage": "data bitsamples [-h]"
251 },
252 "data bmap": {
253 "command": "data bmap",
254 "description": "Breaks down a hex value to binary according a template data bmap -d 16 -m 4,4 This will give two rows each with four bits",
255 "notes": [
256 "data bmap -d 3B",
257 "data bmap -d 3B -m 2,5,1"
258 ],
259 "offline": true,
260 "options": [
261 "-h, --help This help",
262 "-d <hex> hex string",
263 "-m <str> binary template"
264 ],
265 "usage": "data bmap [-h] [-d <hex>] [-m <str>]"
266 },
267 "data convertbitstream": {
268 "command": "data convertbitstream",
269 "description": "Convert GraphBuffer's 0|1 values to 127|-127",
270 "notes": [
271 "data convertbitstream"
272 ],
273 "offline": true,
274 "options": [
275 "-h, --help This help"
276 ],
277 "usage": "data convertbitstream [-h]"
278 },
279 "data crypto": {
280 "command": "data crypto",
281 "description": "Encrypt data, right here, right now. Or decrypt.",
282 "notes": [
283 "Supply data, key, IV (needed for des MAC or aes), and cryptography action.",
284 "To calculate a MAC for FMCOS, supply challenge as IV, data as data, and session/line protection key as key.",
285 "To calculate a MAC for FeliCa, supply first RC as IV, BLE+data as data and session key as key.",
286 "data crypto -d 04D6850E06AABB80 -k FFFFFFFFFFFFFFFF --iv 9EA0401A00000000 --des -> Calculate a MAC for FMCOS chip. The result should be ED3A0133"
287 ],
288 "offline": true,
289 "options": [
290 "-h, --help This help",
291 "-d, --data <hex> Data to process",
292 "-k, --key <hex> Key to use",
293 "-r, --rev Decrypt, not encrypt",
294 "--des Cipher with DES, not AES",
295 "--mac Calculate AES CMAC/FeliCa Lite MAC",
296 "--iv <hex> IV value if needed"
297 ],
298 "usage": "data crypto [-hr] -d <hex> -k <hex> [--des] [--mac] [--iv <hex>]"
299 },
300 "data cthreshold": {
301 "command": "data cthreshold",
302 "description": "Inverse of dirty threshold command, all values between up and down will be average out",
303 "notes": [
304 "data cthreshold -u 10 -d -10"
305 ],
306 "offline": true,
307 "options": [
308 "-h, --help This help",
309 "-d, --down <dec> threshold down",
310 "-u, --up <dec> threshold up"
311 ],
312 "usage": "data cthreshold [-h] -d <dec> -u <dec>"
313 },
314 "data decimate": {
315 "command": "data decimate",
316 "description": "Performs decimation, by reducing samples N times in the grapbuf. Good for PSK",
317 "notes": [
318 "data decimate",
319 "data decimate -n 4"
320 ],
321 "offline": true,
322 "options": [
323 "-h, --help This help",
324 "-n <dec> factor to reduce sample set (default 2)"
325 ],
326 "usage": "data decimate [-h] [-n <dec>]"
327 },
328 "data detectclock": {
329 "command": "data detectclock",
330 "description": "Detect ASK, FSK, NRZ, PSK clock rate of wave in GraphBuffer",
331 "notes": [
332 "data detectclock --ask",
333 "data detectclock --nzr -> detect clock of an nrz/direct wave in GraphBuffer"
334 ],
335 "offline": true,
336 "options": [
337 "-h, --help This help",
338 "--ask specify ASK modulation clock detection",
339 "--fsk specify FSK modulation clock detection",
340 "--nzr specify NZR/DIRECT modulation clock detection",
341 "--psk specify PSK modulation clock detection"
342 ],
343 "usage": "data detectclock [-h] [--ask] [--fsk] [--nzr] [--psk]"
344 },
345 "data diff": {
346 "command": "data diff",
347 "description": "Diff takes a multitude of input data and makes a binary compare. It accepts filenames (filesystem or RDV4 flashmem SPIFFS), emulator memory, magic gen1",
348 "notes": [
349 "data diff -w 4 -a hf-mfu-01020304.bin -b hf-mfu-04030201.bin",
350 "data diff -a fileA -b fileB",
351 "data diff -a fileA --eb",
352 "data diff --fa fileA -b fileB",
353 "data diff --fa fileA --fb fileB"
354 ],
355 "offline": true,
356 "options": [
357 "-h, --help This help",
358 "-a <fn> input file name A",
359 "-b <fn> input file name B",
360 "--eb emulator memory <hf mf esave>",
361 "--fa <fn> input spiffs file A",
362 "--fb <fn> input spiffs file B",
363 "-w <4|8|16> Width of data output"
364 ],
365 "usage": "data diff [-h] [-a <fn>] [-b <fn>] [--eb] [--fa <fn>] [--fb <fn>] [-w <4|8|16>]"
366 },
367 "data dirthreshold": {
368 "command": "data dirthreshold",
369 "description": "Max rising higher up-thres/ Min falling lower down-thres, keep rest as prev.",
370 "notes": [
371 "data dirthreshold -u 10 -d -10"
372 ],
373 "offline": true,
374 "options": [
375 "-h, --help This help",
376 "-d, --down <dec> threshold down",
377 "-u, --up <dec> threshold up"
378 ],
379 "usage": "data dirthreshold [-h] -d <dec> -u <dec>"
380 },
381 "data envelope": {
382 "command": "data envelope",
383 "description": "Create an square envelop of the samples",
384 "notes": [
385 "data envelop"
386 ],
387 "offline": true,
388 "options": [
389 "-h, --help This help"
390 ],
391 "usage": "data envelop [-h]"
392 },
393 "data fsktonrz": {
394 "command": "data fsktonrz",
395 "description": "Convert fsk2 to nrz wave for alternate fsk demodulating (for weak fsk) Omitted values are autodetect instead",
396 "notes": [
397 "data fsktonrz",
398 "data fsktonrz -c 32 --low 8 --hi 10"
399 ],
400 "offline": true,
401 "options": [
402 "-h, --help This help",
403 "-c, --clk <dec> clock",
404 "--low <dec> low field clock",
405 "--hi <dec> high field clock"
406 ],
407 "usage": "data fsktonrz [-h] [-c <dec>] [--low <dec>] [--hi <dec>]"
408 },
409 "data getbitstream": {
410 "command": "data getbitstream",
411 "description": "Convert GraphBuffer's value accordingly - larger or equal to ONE becomes ONE - less than ONE becomes ZERO",
412 "notes": [
413 "data getbitstream"
414 ],
415 "offline": true,
416 "options": [
417 "-h, --help This help"
418 ],
419 "usage": "data getbitstream [-h]"
420 },
421 "data grid": {
422 "command": "data grid",
423 "description": "This function overlay grid on graph plot window. use zero value to turn off either",
424 "notes": [
425 "data grid -> turn off",
426 "data grid -x 64 -y 50"
427 ],
428 "offline": true,
429 "options": [
430 "-h, --help This help",
431 "-x <dec> plot grid X coord",
432 "-y <dec> plot grid Y coord"
433 ],
434 "usage": "data grid [-h] [-x <dec>] [-y <dec>]"
435 },
436 "data help": {
437 "command": "data help",
438 "description": "help This help ----------- ------------------------- General------------------------- clear Clears various buffers used by the graph window hide Hide the graph window load Load contents of file into graph window num Converts dec/hex/bin plot Show the graph window print Print the data in the DemodBuffer save Save signal trace data setdebugmode Set Debugging Level on client side xor Xor a input string ----------- ------------------------- Modulation------------------------- biphaserawdecode Biphase decode bin stream in DemodBuffer detectclock Detect ASK, FSK, NRZ, PSK clock rate of wave in GraphBuffer fsktonrz Convert fsk2 to nrz wave for alternate fsk demodulating (for weak fsk) manrawdecode Manchester decode binary stream in DemodBuffer modulation Identify LF signal for clock and modulation rawdemod Demodulate the data in the GraphBuffer and output binary ----------- ------------------------- Graph------------------------- askedgedetect Adjust Graph for manual ASK demod autocorr Autocorrelation over window convertbitstream Convert GraphBuffer's 0/1 values to 127 / -127 cthreshold Average out all values between dirthreshold Max rising higher up-thres/ Min falling lower down-thres decimate Decimate samples envelope Generate square envelope of samples grid overlay grid on graph window getbitstream Convert GraphBuffer's >=1 values to 1 and <1 to 0 hpf Remove DC offset from trace iir Apply IIR buttersworth filter on plot data ltrim Trim samples from left of trace mtrim Trim out samples from the specified start to the specified stop norm Normalize max/min to +/-128 rtrim Trim samples from right of trace setgraphmarkers Set the markers in the graph window shiftgraphzero Shift 0 for Graphed wave + or - shift value timescale Set cursor display timescale undecimate Un-decimate samples zerocrossings Count time between zero-crossings ----------- ------------------------- Operations------------------------- asn1 ASN1 decoder atr ATR lookup bmap Convert hex value according a binary template crypto Encrypt and decrypt data diff Diff of input files --------------------------------------------------------------------------------------- data clear available offline: yes This function clears the BigBuf on device side and graph window ( graphbuffer )",
439 "notes": [
440 "data clear"
441 ],
442 "offline": true,
443 "options": [
444 "-h, --help This help"
445 ],
446 "usage": "data clear [-h]"
447 },
448 "data hexsamples": {
449 "command": "data hexsamples",
450 "description": "Dump big buffer as hex bytes",
451 "notes": [
452 "data hexsamples -n 128 -> dumps 128 bytes from offset 0"
453 ],
454 "offline": false,
455 "options": [
456 "-h, --help This help",
457 "-b, --breaks <dec> row break, def 16",
458 "-n <dec> num of bytes to download",
459 "-o, --offset <hex> offset in big buffer"
460 ],
461 "usage": "data hexsamples [-h] [-b <dec>] [-n <dec>] [-o <hex>]"
462 },
463 "data hide": {
464 "command": "data hide",
465 "description": "Show graph window",
466 "notes": [
467 "data hide"
468 ],
469 "offline": true,
470 "options": [
471 "-h, --help This help"
472 ],
473 "usage": "data hide [-h]"
474 },
475 "data hpf": {
476 "command": "data hpf",
477 "description": "Remove DC offset from trace. It should centralize around 0",
478 "notes": [
479 "data hpf"
480 ],
481 "offline": true,
482 "options": [
483 "-h, --help This help"
484 ],
485 "usage": "data hpf [-h]"
486 },
487 "data iir": {
488 "command": "data iir",
489 "description": "Apply IIR buttersworth filter on plot data",
490 "notes": [
491 "data iir -n 2"
492 ],
493 "offline": true,
494 "options": [
495 "-h, --help This help",
496 "-n <dec> factor n"
497 ],
498 "usage": "data iir [-h] -n <dec>"
499 },
500 "data load": {
501 "command": "data load",
502 "description": "This command loads the contents of a pm3 file into graph window",
503 "notes": [
504 "data load -f myfilename"
505 ],
506 "offline": true,
507 "options": [
508 "-h, --help This help",
509 "-f, --file <fn> file to load",
510 "-b, --bin binary file",
511 "-n, --no-fix Load data from file without any transformations"
512 ],
513 "usage": "data load [-hbn] -f <fn>"
514 },
515 "data ltrim": {
516 "command": "data ltrim",
517 "description": "Trim samples from left of trace",
518 "notes": [
519 "data ltrim -i 300 -> remove from start 0 to index 300"
520 ],
521 "offline": true,
522 "options": [
523 "-h, --help This help",
524 "-i, --idx <dec> index in graph buffer"
525 ],
526 "usage": "data ltrim [-h] -i <dec>"
527 },
528 "data manrawdecode": {
529 "command": "data manrawdecode",
530 "description": "Manchester decode binary stream in DemodBuffer Converts 10 and 01 and converts to 0 and 1 respectively - must have binary sequence in DemodBuffer (run `data rawdemod --ar` before)",
531 "notes": [
532 "data manrawdecode"
533 ],
534 "offline": true,
535 "options": [
536 "-h, --help This help",
537 "-i, --inv invert output",
538 "--err <dec> set max errors tolerated (def 20)"
539 ],
540 "usage": "data manrawdecode [-hi] [--err <dec>]"
541 },
542 "data modulation": {
543 "command": "data modulation",
544 "description": "search LF signal after clock and modulation",
545 "notes": [
546 "data modulation"
547 ],
548 "offline": true,
549 "options": [
550 "-h, --help This help"
551 ],
552 "usage": "data modulation [-h]"
553 },
554 "data mtrim": {
555 "command": "data mtrim",
556 "description": "Trim out samples from start 0 to `-s index` AND from `-e index` to end of graph buffer",
557 "notes": [
558 "data mtrim -s 1000 -e 2000 -> keep all between index 1000 and 2000"
559 ],
560 "offline": true,
561 "options": [
562 "-h, --help This help",
563 "-s, --start <dec> start point",
564 "-e, --end <dec> end point"
565 ],
566 "usage": "data mtrim [-h] -s <dec> -e <dec>"
567 },
568 "data norm": {
569 "command": "data norm",
570 "description": "Normalize max/min to +/-128",
571 "notes": [
572 "data norm"
573 ],
574 "offline": true,
575 "options": [
576 "-h, --help This help"
577 ],
578 "usage": "data norm [-h]"
579 },
580 "data num": {
581 "command": "data num",
582 "description": "Function takes a decimal or hexdecimal number and print it in decimal/hex/binary Will print message if number is a prime number",
583 "notes": [
584 "data num --dec 2023",
585 "data num --hex 0x1000"
586 ],
587 "offline": true,
588 "options": [
589 "-h, --help This help",
590 "--dec <dec> decimal value",
591 "--hex <hex> hexadecimal value",
592 "--bin <bin> binary value",
593 "-i print inverted value",
594 "-r print reversed value"
595 ],
596 "usage": "data num [-hir] [--dec <dec>] [--hex <hex>] [--bin <bin>]"
597 },
598 "data plot": {
599 "command": "data plot",
600 "description": "Show graph window hit 'h' in window for detail keystroke help available",
601 "notes": [
602 "data plot"
603 ],
604 "offline": true,
605 "options": [
606 "-h, --help This help"
607 ],
608 "usage": "data plot [-h]"
609 },
610 "data print": {
611 "command": "data print",
612 "description": "Print the data in the DemodBuffer as hex or binary. Defaults to binary output",
613 "notes": [
614 "data print"
615 ],
616 "offline": true,
617 "options": [
618 "-h, --help This help",
619 "-i, --inv invert DemodBuffer before printing",
620 "-o, --offset <dec> offset in # of bits",
621 "-s, --strip strip leading zeroes, i.e. set offset to first bit equal to one",
622 "-x, --hex output in hex (omit for binary output)"
623 ],
624 "usage": "data print [-hisx] [-o <dec>]"
625 },
626 "data rawdemod": {
627 "command": "data rawdemod",
628 "description": "Demodulate the data in the GraphBuffer and output binary",
629 "notes": [
630 "data rawdemod --fs -> demod FSK - autodetect",
631 "data rawdemod --ab -> demod ASK/BIPHASE - autodetect",
632 "data rawdemod --am -> demod ASK/MANCHESTER - autodetect",
633 "data rawdemod --ar -> demod ASK/RAW - autodetect",
634 "data rawdemod --nr -> demod NRZ/DIRECT - autodetect",
635 "data rawdemod --p1 -> demod PSK1 - autodetect",
636 "data rawdemod --p2 -> demod PSK2 - autodetect"
637 ],
638 "offline": true,
639 "options": [
640 "-h, --help This help",
641 "--ab ASK/Biphase demodulation",
642 "--am ASK/Manchester demodulation",
643 "--ar ASK/Raw demodulation",
644 "--fs FSK demodulation",
645 "--nr NRZ/Direct demodulation",
646 "--p1 PSK 1 demodulation",
647 "--p2 PSK 2 demodulation",
648 "<params> params for sub command"
649 ],
650 "usage": "data rawdemod [-h] [--ab] [--am] [--ar] [--fs] [--nr] [--p1] [--p2] [<params>]..."
651 },
652 "data rtrim": {
653 "command": "data rtrim",
654 "description": "Trim samples from right of trace",
655 "notes": [
656 "data rtrim -i 4000 -> remove from index 4000 to end of graph buffer"
657 ],
658 "offline": true,
659 "options": [
660 "-h, --help This help",
661 "-i, --idx <dec> index in graph buffer"
662 ],
663 "usage": "data rtrim [-h] -i <dec>"
664 },
665 "data samples": {
666 "command": "data samples",
667 "description": "Get raw samples for graph window (GraphBuffer) from device. If 0, then get whole big buffer from device.",
668 "notes": [
669 "data samples",
670 "data samples -n 10000"
671 ],
672 "offline": false,
673 "options": [
674 "-h, --help This help",
675 "-n <dec> num of samples (512 - 40000)",
676 "-v, --verbose verbose output"
677 ],
678 "usage": "data samples [-hv] [-n <dec>]"
679 },
680 "data save": {
681 "command": "data save",
682 "description": "Save signal trace from graph window , i.e. the GraphBuffer This is a text file with number -127 to 127. With the option `w` you can save it as wave file Filename should be without file extension",
683 "notes": [
684 "data save -f myfilename -> save graph buffer to file",
685 "data save --wave -f myfilename -> save graph buffer to wave file"
686 ],
687 "offline": true,
688 "options": [
689 "-h, --help This help",
690 "-w, --wave save as wave format (.wav)",
691 "-f, --file <fn w/o ext> save file name"
692 ],
693 "usage": "data save [-hw] -f <fn w/o ext>"
694 },
695 "data setdebugmode": {
696 "command": "data setdebugmode",
697 "description": "Set debugging level on client side",
698 "notes": [
699 "data setdebugmode"
700 ],
701 "offline": true,
702 "options": [
703 "-h, --help This help",
704 "-0 no debug messages",
705 "-1 debug",
706 "-2 verbose debugging"
707 ],
708 "usage": "data setdebugmode [-h012]"
709 },
710 "data setgraphmarkers": {
711 "command": "data setgraphmarkers",
712 "description": "Set the locations of the markers in the graph window",
713 "notes": [
714 "data setgraphmarkers -> reset the markers",
715 "data setgraphmarkers -a 64 -> set A, reset the rest",
716 "data setgraphmarkers -d --keep -> set D, keep the rest"
717 ],
718 "offline": true,
719 "options": [
720 "-h, --help This help",
721 "--keep keep the current values of the markers",
722 "-a <dec> yellow marker",
723 "-b <dec> purple marker",
724 "-c <dec> orange marker",
725 "-d <dec> blue marker"
726 ],
727 "usage": "data setgraphmarkers [-h] [--keep] [-a <dec>] [-b <dec>] [-c <dec>] [-d <dec>]"
728 },
729 "data shiftgraphzero": {
730 "command": "data shiftgraphzero",
731 "description": "Shift 0 for Graphed wave + or - shift value",
732 "notes": [
733 "data shiftgraphzero -n 10 -> shift 10 points",
734 "data shiftgraphzero -n -22 -> shift negative 22 points"
735 ],
736 "offline": true,
737 "options": [
738 "-h, --help This help",
739 "-n <dec> shift + or -"
740 ],
741 "usage": "data shiftgraphzero [-h] -n <dec>"
742 },
743 "data test_ss32": {
744 "command": "data test_ss32",
745 "description": "Tests the implementation of Buffer Save States (32-bit buffer)",
746 "notes": [
747 "data test_ss32"
748 ],
749 "offline": false,
750 "options": [
751 "-h, --help This help"
752 ],
753 "usage": "data test_ss32 [-h]"
754 },
755 "data test_ss32s": {
756 "command": "data test_ss32s",
757 "description": "Tests the implementation of Buffer Save States (32-bit signed buffer)",
758 "notes": [
759 "data test_ss32s"
760 ],
761 "offline": false,
762 "options": [
763 "-h, --help This help"
764 ],
765 "usage": "data test_ss32s [-h]"
766 },
767 "data test_ss8": {
768 "command": "data test_ss8",
769 "description": "Tests the implementation of Buffer Save States (8-bit buffer)",
770 "notes": [
771 "data test_ss8"
772 ],
773 "offline": false,
774 "options": [
775 "-h, --help This help"
776 ],
777 "usage": "data test_ss8 [-h]"
778 },
779 "data timescale": {
780 "command": "data timescale",
781 "description": "Set cursor display timescale. Setting the timescale makes the differential `dt` reading between the yellow and purple markers meaningful. once the timescale is set, the differential reading between brackets can become a time duration.",
782 "notes": [
783 "data timescale --sr 125 -u ms -> for LF sampled at 125 kHz. Reading will be in milliseconds",
784 "data timescale --sr 1.695 -u us -> for HF sampled at 16 * fc/128. Reading will be in microseconds",
785 "data timescale --sr 16 -u ETU -> for HF with 16 samples per ETU (fc/128). Reading will be in ETUs"
786 ],
787 "offline": true,
788 "options": [
789 "-h, --help This help",
790 "--sr <float> sets timescale factor according to sampling rate",
791 "-u, --unit <string> time unit to display (max 10 chars)"
792 ],
793 "usage": "data timescale [-h] --sr <float> [-u <string>]"
794 },
795 "data undecimate": {
796 "command": "data undecimate",
797 "description": "Performs un-decimation, by repeating each sample N times in the graphbuf",
798 "notes": [
799 "data undecimate",
800 "data undecimate -n 4"
801 ],
802 "offline": true,
803 "options": [
804 "-h, --help This help",
805 "-n <dec> factor to repeat each sample (default 2)"
806 ],
807 "usage": "data undecimate [-h] [-n <dec>]"
808 },
809 "data xor": {
810 "command": "data xor",
811 "description": "takes input string and xor string. Perform xor on it. If no xor string, try the most reoccuring value to xor against",
812 "notes": [
813 "data xor -d 99aabbcc8888888888",
814 "data xor -d 99aabbcc --xor 88888888"
815 ],
816 "offline": true,
817 "options": [
818 "-h, --help This help",
819 "-d, --data <hex> input hex string",
820 "-x, --xor <str> input xor string"
821 ],
822 "usage": "data xor [-h] -d <hex> [-x <str>]"
823 },
824 "data zerocrossings": {
825 "command": "data zerocrossings",
826 "description": "Count time between zero-crossings",
827 "notes": [
828 "data zerocrossings"
829 ],
830 "offline": true,
831 "options": [
832 "-h, --help This help"
833 ],
834 "usage": "data zerocrossings [-h]"
835 },
836 "emv challenge": {
837 "command": "emv challenge",
838 "description": "Executes Generate Challenge command. It returns 4 or 8-byte random number from card. Needs a EMV applet to be selected and GPO to be executed.",
839 "notes": [
840 "emv challenge -> get challenge",
841 "emv challenge -k -> get challenge, keep filled ON"
842 ],
843 "offline": false,
844 "options": [
845 "-h, --help This help",
846 "-k, --keep Keep field ON for next command",
847 "-a, --apdu Show APDU requests and responses",
848 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)"
849 ],
850 "usage": "emv challenge [-hkaw]"
851 },
852 "emv exec": {
853 "command": "emv exec",
854 "description": "Executes EMV contactless transaction",
855 "notes": [
856 "emv exec -sat -> select card, execute MSD transaction, show APDU and TLV",
857 "emv exec -satc -> select card, execute CDA transaction, show APDU and TLV"
858 ],
859 "offline": false,
860 "options": [
861 "-h, --help This help",
862 "-s, --select Activate field and select card",
863 "-a, --apdu Show APDU requests and responses",
864 "-t, --tlv TLV decode results",
865 "-j, --jload Load transaction parameters from `emv_defparams.json` file",
866 "--force Force search AID. Search AID instead of execute PPSE",
867 "By default: Transaction type - MSD",
868 "-v, --qvsdc Transaction type - qVSDC or M/Chip",
869 "-c, --qvsdccda Transaction type - qVSDC or M/Chip plus CDA (SDAD generation)",
870 "-x, --vsdc Transaction type - VSDC. For test only. Not a standard behavior",
871 "-g, --acgpo VISA. generate AC from GPO",
872 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)"
873 ],
874 "usage": "emv exec [-hsatjvcxgw] [--force] By default:"
875 },
876 "emv genac": {
877 "command": "emv genac",
878 "description": "Generate Application Cryptogram command. It returns data in TLV format. Needs a EMV applet to be selected and GPO to be executed.",
879 "notes": [
880 "emv genac -k 0102 -> generate AC with 2-byte CDOLdata and keep field ON after command",
881 "emv genac -t 01020304 -> generate AC with 4-byte CDOL data, show result in TLV",
882 "emv genac -Daac 01020304 -> generate AC with 4-byte CDOL data and terminal decision 'declined'",
883 "emv genac -pmt 9F 37 04 -> load params from file, make CDOL data from CDOL, generate AC with CDOL, show result in TLV"
884 ],
885 "offline": false,
886 "options": [
887 "-h, --help This help",
888 "-k, --keep Keep field ON for next command",
889 "-c, --cda Executes CDA transaction. Needs to get SDAD in results.",
890 "-d, --decision <aac|tc|arqc> Terminal decision. aac - declined, tc - approved, arqc - online authorisation requested",
891 "-p, --params Load parameters from `emv_defparams.json` file for CDOLdata making from CDOL and parameters",
892 "-m, --make Make CDOLdata from CDOL (tag 8C and 8D) and parameters (def: use default parameters)",
893 "-a, --apdu Show APDU requests and responses",
894 "-t, --tlv TLV decode results of selected applets",
895 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
896 "<hex> CDOLdata/CDOL"
897 ],
898 "usage": "emv genac [-hkcpmatw] [-d <aac|tc|arqc>] <hex> [<hex>]..."
899 },
900 "emv gpo": {
901 "command": "emv gpo",
902 "description": "Executes Get Processing Options command. It returns data in TLV format (0x77 - format2) or plain format (0x80 - format1). Needs a EMV applet to be selected.",
903 "notes": [
904 "emv gpo -k -> execute GPO",
905 "emv gpo -t 01020304 -> execute GPO with 4-byte PDOL data, show result in TLV",
906 "emv gpo -pmt 9F 37 04 -> load params from file, make PDOL data from PDOL, execute GPO with PDOL, show result in TLV"
907 ],
908 "offline": false,
909 "options": [
910 "-h, --help This help",
911 "-k, --keep Keep field ON for next command",
912 "-p, --params Load parameters from `emv_defparams.json` file for PDOLdata making from PDOL and parameters",
913 "-m, --make Make PDOLdata from PDOL (tag 9F38) and parameters (def: uses default parameters)",
914 "-a, --apdu Show APDU requests and responses",
915 "-t, --tlv TLV decode results of selected applets",
916 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
917 "<hex> PDOLdata/PDOL"
918 ],
919 "usage": "emv gpo [-hkpmatw] [<hex>]..."
920 },
921 "emv help": {
922 "command": "emv help",
923 "description": "----------- ----------------------- General ----------------------- help This help list List ISO7816 history test Crypto logic selftest --------------------------------------------------------------------------------------- emv list available offline: yes Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
924 "notes": [
925 "emv list --frame -> show frame delay times",
926 "emv list -1 -> use trace buffer"
927 ],
928 "offline": true,
929 "options": [
930 "-h, --help This help",
931 "-1, --buffer use data from trace buffer",
932 "--frame show frame delay times",
933 "-c mark CRC bytes",
934 "-r show relative times (gap and duration)",
935 "-u display times in microseconds instead of clock cycles",
936 "-x show hexdump to convert to pcap(ng)",
937 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
938 "-f, --file <fn> filename of dictionary"
939 ],
940 "usage": "emv list [-h1crux] [--frame] [-f <fn>]"
941 },
942 "emv intauth": {
943 "command": "emv intauth",
944 "description": "Generate Internal Authenticate command. Usually needs 4-byte random number. It returns data in TLV format . Needs a EMV applet to be selected and GPO to be executed.",
945 "notes": [
946 "emv intauth -k 01020304 -> execute Internal Authenticate with 4-byte DDOLdata and keep field ON after command",
947 "emv intauth -t 01020304 -> execute Internal Authenticate with 4-byte DDOL data, show result in TLV",
948 "emv intauth -pmt 9F 37 04 -> load params from file, make DDOL data from DDOL, Internal Authenticate with DDOL, show result in TLV"
949 ],
950 "offline": false,
951 "options": [
952 "-h, --help This help",
953 "-k, --keep Keep field ON for next command",
954 "-p, --params Load parameters from `emv_defparams.json` file for DDOLdata making from DDOL and parameters",
955 "-m, --make Make DDOLdata from DDOL (tag 9F49) and parameters (def: use default parameters)",
956 "-a, --apdu Show APDU requests and responses",
957 "-t, --tlv TLV decode results of selected applets",
958 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
959 "<hex> DDOLdata/DDOL"
960 ],
961 "usage": "emv intauth [-hkpmatw] <hex> [<hex>]..."
962 },
963 "emv pse": {
964 "command": "emv pse",
965 "description": "Executes PSE/PPSE select command. It returns list of applet on the card:",
966 "notes": [
967 "emv pse -s1 -> select, get pse",
968 "emv pse -st2 -> select, get ppse, show result in TLV"
969 ],
970 "offline": false,
971 "options": [
972 "-h, --help This help",
973 "-s, --select Activate field and select card",
974 "-k, --keep Keep field ON for next command",
975 "-1, --pse PSE (1PAY.SYS.DDF01) mode",
976 "-2, --ppse PPSE (2PAY.SYS.DDF01) mode (def)",
977 "-a, --apdu Show APDU requests and responses",
978 "-t, --tlv TLV decode results of selected applets",
979 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)"
980 ],
981 "usage": "emv pse [-hsk12atw]"
982 },
983 "emv reader": {
984 "command": "emv reader",
985 "description": "Act as a EMV reader to identify tag. Look for EMV tags until Enter or the pm3 button is pressed In `verbose` mode it will also try to extract and decode the transaction logs stored on card in either channel.",
986 "notes": [
987 "emv reader",
988 "emv reader -v",
989 "emv reader -@ -> Continuous mode"
990 ],
991 "offline": false,
992 "options": [
993 "-h, --help This help",
994 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
995 "-v, --verbose Verbose output",
996 "-@ continuous reader mode"
997 ],
998 "usage": "emv reader [-hwv@]"
999 },
1000 "emv readrec": {
1001 "command": "emv readrec",
1002 "description": "Executes Read Record command. It returns data in TLV format. Needs a bank applet to be selected and sometimes needs GPO to be executed.",
1003 "notes": [
1004 "emv readrec -k 0101 -> read file SFI=01, SFIrec=01",
1005 "emv readrec -kt 0201 -> read file 0201 and show result in TLV"
1006 ],
1007 "offline": false,
1008 "options": [
1009 "-h, --help This help",
1010 "-k, --keep Keep field ON for next command",
1011 "-a, --apdu Show APDU requests and responses",
1012 "-t, --tlv TLV decode results of selected applets",
1013 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
1014 "<hex> <SFI 1 byte><SFIrecord 1 byte"
1015 ],
1016 "usage": "emv readrec [-hkatw] <hex> [<hex>]..."
1017 },
1018 "emv roca": {
1019 "command": "emv roca",
1020 "description": "Tries to extract public keys and run the ROCA test against them.",
1021 "notes": [
1022 "emv roca -w -> select --CONTACT-- card and run test",
1023 "emv roca -> select --CONTACTLESS-- card and run test"
1024 ],
1025 "offline": false,
1026 "options": [
1027 "-h, --help This help",
1028 "-t, --selftest Self test",
1029 "-a, --apdu Show APDU requests and responses",
1030 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)"
1031 ],
1032 "usage": "emv roca [-htaw]"
1033 },
1034 "emv scan": {
1035 "command": "emv scan",
1036 "description": "Scan EMV card and save it contents to a file. It executes EMV contactless transaction and saves result to a file which can be used for emulation",
1037 "notes": [
1038 "emv scan -at -> scan MSD transaction mode and show APDU and TLV",
1039 "emv scan -c -> scan CDA transaction mode"
1040 ],
1041 "offline": false,
1042 "options": [
1043 "-h, --help This help",
1044 "-a, --apdu Show APDU requests and responses",
1045 "-t, --tlv TLV decode results",
1046 "-e, --extract Extract TLV elements and fill Application Data",
1047 "-j, --jload Load transaction parameters from `emv_defparams.json` file",
1048 "By default: Transaction type - MSD",
1049 "-v, --qvsdc Transaction type - qVSDC or M/Chip",
1050 "-c, --qvsdccda Transaction type - qVSDC or M/Chip plus CDA (SDAD generation)",
1051 "-x, --vsdc Transaction type - VSDC. For test only. Not a standard behavior",
1052 "-g, --acgpo VISA. generate AC from GPO",
1053 "-m, --merge Merge output file with card's data. (warning: the file may be corrupted!)",
1054 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
1055 "<fn> JSON output file name"
1056 ],
1057 "usage": "emv scan [-hatejvcxgmw] By default: <fn>"
1058 },
1059 "emv search": {
1060 "command": "emv search",
1061 "description": "Tries to select all applets from applet list",
1062 "notes": [
1063 "emv search -s -> select card and search",
1064 "emv search -st -> select card, search and show result in TLV"
1065 ],
1066 "offline": false,
1067 "options": [
1068 "-h, --help This help",
1069 "-s, --select Activate field and select card",
1070 "-k, --keep Keep field ON for next command",
1071 "-a, --apdu Show APDU requests and responses",
1072 "-t, --tlv TLV decode results of selected applets",
1073 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)"
1074 ],
1075 "usage": "emv search [-hskatw]"
1076 },
1077 "emv select": {
1078 "command": "emv select",
1079 "description": "Executes select applet command",
1080 "notes": [
1081 "emv select -s a00000000101 -> select card, select applet",
1082 "emv select -st a00000000101 -> select card, select applet, show result in TLV"
1083 ],
1084 "offline": false,
1085 "options": [
1086 "-h, --help This help",
1087 "-s, --select Activate field and select card",
1088 "-k, --keep Keep field for next command",
1089 "-a, --apdu Show APDU requests and responses",
1090 "-t, --tlv TLV decode results",
1091 "-w, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
1092 "<hex> Applet AID"
1093 ],
1094 "usage": "emv select [-hskatw] <hex>"
1095 },
1096 "emv test": {
1097 "command": "emv test",
1098 "description": "Executes tests",
1099 "notes": [
1100 "emv test -i",
1101 "emv test --long"
1102 ],
1103 "offline": true,
1104 "options": [
1105 "-h, --help This help",
1106 "-i, --ignore Ignore timing tests for VM",
1107 "-l, --long Run long tests too"
1108 ],
1109 "usage": "emv test [-hil]"
1110 },
1111 "exit": {
1112 "command": "exit",
1113 "description": "Quit the Proxmark3 client terminal",
1114 "notes": [
1115 "quit"
1116 ],
1117 "offline": true,
1118 "options": [
1119 "-h, --help This help"
1120 ],
1121 "usage": "quit [-h]"
1122 },
1123 "help": {
1124 "command": "help",
1125 "description": "help Use `<command> help` for details of a command prefs { Edit client/device preferences... } -------- ----------------------- Technology ----------------------- analyse { Analyse utils... } data { Plot window / data buffer manipulation... } emv { EMV ISO-14443 / ISO-7816... } hf { High frequency commands... } hw { Hardware commands... } lf { Low frequency commands... } nfc { NFC commands... } piv { PIV commands... } reveng { CRC calculations from RevEng software... } smart { Smart card ISO-7816 commands... } script { Scripting commands... } trace { Trace manipulation... } wiegand { Wiegand format manipulation... } -------- ----------------------- General ----------------------- clear Clear screen hints Turn hints on / off msleep Add a pause in milliseconds rem Add a text line in log file quit exit Exit program --------------------------------------------------------------------------------------- auto available offline: no Run LF SEARCH / HF SEARCH / DATA PLOT / DATA SAVE",
1126 "notes": [
1127 "auto"
1128 ],
1129 "offline": true,
1130 "options": [
1131 "-h, --help This help",
1132 "-c Continue searching even after a first hit"
1133 ],
1134 "usage": "auto [-hc]"
1135 },
1136 "hf 14a antifuzz": {
1137 "command": "hf 14a antifuzz",
1138 "description": "Tries to fuzz the ISO14443a anticollision phase",
1139 "notes": [
1140 "hf 14a antifuzz -4"
1141 ],
1142 "offline": false,
1143 "options": [
1144 "-h, --help This help",
1145 "-4 4 byte uid",
1146 "-7 7 byte uid",
1147 "--10 10 byte uid"
1148 ],
1149 "usage": "hf 14a antifuzz [-h47] [--10]"
1150 },
1151 "hf 14a apdu": {
1152 "command": "hf 14a apdu",
1153 "description": "Sends an ISO 7816-4 APDU via ISO 14443-4 block transmission protocol (T=CL). Works with all APDU types from ISO 7816-4:2013 note: `-m` and `-d` goes hand in hand -m <CLA INS P1 P2> -d 325041592E5359532E4444463031 OR use `-d` with complete APDU data -d 00A404000E325041592E5359532E444446303100",
1154 "notes": [
1155 "hf 14a apdu -st -d 00A404000E325041592E5359532E444446303100",
1156 "hf 14a apdu -sd -d 00A404000E325041592E5359532E444446303100 -> decode apdu",
1157 "hf 14a apdu -sm 00A40400 -d 325041592E5359532E4444463031 -l 256 -> encode standard apdu",
1158 "hf 14a apdu -sm 00A40400 -d 325041592E5359532E4444463031 -el 65536 -> encode extended apdu"
1159 ],
1160 "offline": false,
1161 "options": [
1162 "-h, --help This help",
1163 "-s, --select activate field and select card",
1164 "-k, --keep keep signal field ON after receive",
1165 "-t, --tlv decode TLV",
1166 "--decode decode APDU request",
1167 "-m, --make <hex> APDU header, 4 bytes <CLA INS P1 P2>",
1168 "-e, --extended make extended length apdu if `m` parameter included",
1169 "-l, --le <dec> Le APDU parameter if `m` parameter included",
1170 "-d, --data <hex> full APDU package or data if `m` parameter included"
1171 ],
1172 "usage": "hf 14a apdu [-hskte] [--decode] [-m <hex>] [-l <dec>] -d <hex> [-d <hex>]..."
1173 },
1174 "hf 14a apdufind": {
1175 "command": "hf 14a apdufind",
1176 "description": "Enumerate APDU's of ISO7816 protocol to find valid CLS/INS/P1/P2 commands. It loops all 256 possible values for each byte. The loop oder is INS -> P1/P2 (alternating) -> CLA. Tag must be on antenna before running.",
1177 "notes": [
1178 "hf 14a apdufind",
1179 "hf 14a apdufind --cla 80",
1180 "hf 14a apdufind --cla 80 --error-limit 20 --skip-ins a4 --skip-ins b0 --with-le"
1181 ],
1182 "offline": false,
1183 "options": [
1184 "-h, --help This help",
1185 "-c, --cla <hex> Start value of CLASS (1 hex byte)",
1186 "-i, --ins <hex> Start value of INSTRUCTION (1 hex byte)",
1187 "--p1 <hex> Start value of P1 (1 hex byte)",
1188 "--p2 <hex> Start value of P2 (1 hex byte)",
1189 "-r, --reset <number> Minimum secondes before resetting the tag (to prevent timeout issues). Default is 5 minutes",
1190 "-e, --error-limit <number> Maximum times an status word other than 0x9000 or 0x6D00 is shown. Default is 512.",
1191 "-s, --skip-ins <hex> Do not test an instruction (can be specified multiple times)",
1192 "-l, --with-le Search for APDUs with Le=0 (case 2S) as well",
1193 "-v, --verbose Verbose output"
1194 ],
1195 "usage": "hf 14a apdufind [-hlv] [-c <hex>] [-i <hex>] [--p1 <hex>] [--p2 <hex>] [-r <number>] [-e <number>] [-s <hex>]..."
1196 },
1197 "hf 14a chaining": {
1198 "command": "hf 14a chaining",
1199 "description": "Enable/Disable ISO14443a input chaining. Maximum input length goes from ATS.",
1200 "notes": [
1201 "hf 14a chaining -> show chaining enable/disable state",
1202 "hf 14a chaining --off -> disable chaining"
1203 ],
1204 "offline": false,
1205 "options": [
1206 "-h, --help This help",
1207 "-1, --on enabled chaining",
1208 "-0, --off disable chaining"
1209 ],
1210 "usage": "hf 14a chaining [-h10]"
1211 },
1212 "hf 14a cuids": {
1213 "command": "hf 14a cuids",
1214 "description": "Collect n>0 ISO14443-a UIDs in one go",
1215 "notes": [
1216 "hf 14a cuids -n 5 -> Collect 5 UIDs"
1217 ],
1218 "offline": false,
1219 "options": [
1220 "-h, --help This help",
1221 "-n, --num <dec> Number of UIDs to collect"
1222 ],
1223 "usage": "hf 14a cuids [-h] [-n <dec>]"
1224 },
1225 "hf 14a help": {
1226 "command": "hf 14a help",
1227 "description": "----------- ----------------------- General ----------------------- help This help list List ISO 14443-a history --------------------------------------------------------------------------------------- hf 14a list available offline: yes Alias of `trace list -t 14a -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
1228 "notes": [
1229 "hf 14a list --frame -> show frame delay times",
1230 "hf 14a list -1 -> use trace buffer"
1231 ],
1232 "offline": true,
1233 "options": [
1234 "-h, --help This help",
1235 "-1, --buffer use data from trace buffer",
1236 "--frame show frame delay times",
1237 "-c mark CRC bytes",
1238 "-r show relative times (gap and duration)",
1239 "-u display times in microseconds instead of clock cycles",
1240 "-x show hexdump to convert to pcap(ng)",
1241 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
1242 "-f, --file <fn> filename of dictionary"
1243 ],
1244 "usage": "hf 14a list [-h1crux] [--frame] [-f <fn>]"
1245 },
1246 "hf 14a info": {
1247 "command": "hf 14a info",
1248 "description": "This command makes more extensive tests against a ISO14443a tag in order to collect information",
1249 "notes": [
1250 "hf 14a info -nsv -> shows full information about the card"
1251 ],
1252 "offline": false,
1253 "options": [
1254 "-h, --help This help",
1255 "-v, --verbose verbose output",
1256 "-n, --nacktest test for nack bug",
1257 "-s, --aidsearch checks if AIDs from aidlist.json is present on the card and prints information about found AIDs"
1258 ],
1259 "usage": "hf 14a info [-hvns]"
1260 },
1261 "hf 14a ndefformat": {
1262 "command": "hf 14a ndefformat",
1263 "description": "Format ISO14443-a Tag as a NFC tag with Data Exchange Format (NDEF)",
1264 "notes": [
1265 "hf 14a ndefformat"
1266 ],
1267 "offline": false,
1268 "options": [
1269 "-h, --help This help",
1270 "-v, --verbose verbose output"
1271 ],
1272 "usage": "hf 14a ndefformat [-hv]"
1273 },
1274 "hf 14a ndefread": {
1275 "command": "hf 14a ndefread",
1276 "description": "Read NFC Data Exchange Format (NDEF) file on Type 4 NDEF tag",
1277 "notes": [
1278 "hf 14a ndefread",
1279 "hf 14a ndefread -f myfilename -> save raw NDEF to file"
1280 ],
1281 "offline": false,
1282 "options": [
1283 "-h, --help This help",
1284 "-f, --file <fn> save raw NDEF to file",
1285 "-v, --verbose verbose output"
1286 ],
1287 "usage": "hf 14a ndefread [-hv] [-f <fn>]"
1288 },
1289 "hf 14a ndefwrite": {
1290 "command": "hf 14a ndefwrite",
1291 "description": "Write raw NDEF hex bytes to tag. This commands assumes tag already been NFC/NDEF formatted.",
1292 "notes": [
1293 "hf 14a ndefwrite -d 0300FE -> write empty record to tag",
1294 "hf 14a ndefwrite -f myfilename",
1295 "hf 14a ndefwrite -d 003fd1023a53709101195405656e2d55534963656d616e2054776974746572206c696e6b5101195502747769747465722e636f6d2f686572726d616e6e31303031"
1296 ],
1297 "offline": false,
1298 "options": [
1299 "-h, --help This help",
1300 "-d <hex> raw NDEF hex bytes",
1301 "-f, --file <fn> write raw NDEF file to tag",
1302 "-p fix NDEF record headers / terminator block if missing",
1303 "-v, --verbose verbose output"
1304 ],
1305 "usage": "hf 14a ndefwrite [-hpv] [-d <hex>] [-f <fn>]"
1306 },
1307 "hf 14a raw": {
1308 "command": "hf 14a raw",
1309 "description": "Sends raw bytes over ISO14443a. With option to use TOPAZ 14a mode.",
1310 "notes": [
1311 "hf 14a raw -sc 3000 -> select, crc, where 3000 == 'read block 00'",
1312 "hf 14a raw -ak -b 7 40 -> send 7 bit byte 0x40",
1313 "hf 14a raw --ecp -s -> send ECP before select"
1314 ],
1315 "offline": false,
1316 "options": [
1317 "-h, --help This help",
1318 "-a Active signal field ON without select",
1319 "-c Calculate and append CRC",
1320 "-k Keep signal field ON after receive",
1321 "-3 ISO14443-3 select only (skip RATS)",
1322 "-r Do not read response",
1323 "-s Active signal field ON with select",
1324 "-t, --timeout <ms> Timeout in milliseconds",
1325 "-b <dec> Number of bits to send. Useful for send partial byte",
1326 "-v, --verbose Verbose output",
1327 "--ecp Use enhanced contactless polling",
1328 "--mag Use Apple magsafe polling",
1329 "--topaz Use Topaz protocol to send command",
1330 "<hex> Raw bytes to send"
1331 ],
1332 "usage": "hf 14a raw [-hack3rsv] [-t <ms>] [-b <dec>] [--ecp] [--mag] [--topaz] <hex> [<hex>]..."
1333 },
1334 "hf 14a reader": {
1335 "command": "hf 14a reader",
1336 "description": "Act as a ISO-14443a reader to identify tag. Look for ISO-14443a tags until Enter or the pm3 button is pressed",
1337 "notes": [
1338 "hf 14a reader",
1339 "hf 14a reader -@ -> Continuous mode",
1340 "hf 14a reader --ecp -> trigger apple enhanced contactless polling",
1341 "hf 14a reader --mag -> trigger apple magsafe polling"
1342 ],
1343 "offline": false,
1344 "options": [
1345 "-h, --help This help",
1346 "-k, --keep keep the field active after command executed",
1347 "-s, --silent silent (no messages)",
1348 "--drop just drop the signal field",
1349 "--skip ISO14443-3 select only (skip RATS)",
1350 "--ecp Use enhanced contactless polling",
1351 "--mag Use Apple magsafe polling",
1352 "-@ continuous reader mode"
1353 ],
1354 "usage": "hf 14a reader [-hks@] [--drop] [--skip] [--ecp] [--mag]"
1355 },
1356 "hf 14a sim": {
1357 "command": "hf 14a sim",
1358 "description": "Simulate ISO/IEC 14443 type A tag with 4,7 or 10 byte UID Use type 7 for Mifare Ultralight EV1, Amiibo (NTAG215 pack 0x8080)",
1359 "notes": [
1360 "hf 14a sim -t 1 --uid 11223344 -> MIFARE Classic 1k",
1361 "hf 14a sim -t 2 -> MIFARE Ultralight",
1362 "hf 14a sim -t 3 -> MIFARE Desfire",
1363 "hf 14a sim -t 4 -> ISO/IEC 14443-4",
1364 "hf 14a sim -t 5 -> MIFARE Tnp3xxx",
1365 "hf 14a sim -t 6 -> MIFARE Mini",
1366 "hf 14a sim -t 7 -> MFU EV1 / NTAG 215 Amiibo",
1367 "hf 14a sim -t 8 -> MIFARE Classic 4k",
1368 "hf 14a sim -t 9 -> FM11RF005SH Shanghai Metro",
1369 "hf 14a sim -t 10 -> ST25TA IKEA Rothult",
1370 "hf 14a sim -t 11 -> Javacard (JCOP)",
1371 "hf 14a sim -t 12 -> 4K Seos card"
1372 ],
1373 "offline": false,
1374 "options": [
1375 "-h, --help This help",
1376 "-t, --type <1-12> Simulation type to use",
1377 "-u, --uid <hex> <4|7|10> hex bytes UID",
1378 "-n, --num <dec> Exit simulation after <numreads> blocks have been read by reader. 0 = infinite",
1379 "-x Performs the 'reader attack', nr/ar attack against a reader",
1380 "--sk Fill simulator keys from found keys",
1381 "-v, --verbose verbose output"
1382 ],
1383 "usage": "hf 14a sim [-hxv] -t <1-12> [-u <hex>] [-n <dec>] [--sk]"
1384 },
1385 "hf 14a sniff": {
1386 "command": "hf 14a sniff",
1387 "description": "Sniff the communication between Hitag reader and tag. Use `hf 14a list` to view collected data.",
1388 "notes": [
1389 "hf 14a sniff -c -r"
1390 ],
1391 "offline": false,
1392 "options": [
1393 "-h, --help This help",
1394 "-c, --card triggered by first data from card",
1395 "-r, --reader triggered by first 7-bit request from reader (REQ, WUP)",
1396 "-i, --interactive Console will not be returned until sniff finishes or is aborted"
1397 ],
1398 "usage": "hf 14a sniff [-hcri]"
1399 },
1400 "hf 14b apdu": {
1401 "command": "hf 14b apdu",
1402 "description": "Sends an ISO 7816-4 APDU via ISO 14443-4 block transmission protocol (T=CL). works with all apdu types from ISO 7816-4:2013",
1403 "notes": [
1404 "hf 14b apdu -s -d 94a40800043f000002",
1405 "hf 14b apdu -s --decode -d 00A404000E325041592E5359532E444446303100 -> decode apdu",
1406 "hf 14b apdu -sm 00A40400 -l 256 -d 325041592E5359532E4444463031 -> encode standard apdu",
1407 "hf 14b apdu -sm 00A40400 -el 65536 -d 325041592E5359532E4444463031 -> encode extended apdu"
1408 ],
1409 "offline": false,
1410 "options": [
1411 "-h, --help This help",
1412 "-s, --select activate field and select card",
1413 "-k, --keep leave the signal field ON after receive response",
1414 "-t, --tlv executes TLV decoder if it possible",
1415 "--decode decode apdu request if it possible",
1416 "-m, --make <hex> make apdu with head from this field and data from data field.",
1417 "must be 4 bytes: <CLA INS P1 P2>",
1418 "-e, --extended make extended length apdu if `m` parameter included",
1419 "-l, --le <int> Le apdu parameter if `m` parameter included",
1420 "-d, --data <hex> <APDU | data> if `m` parameter included",
1421 "--timeout <dec> timeout in ms"
1422 ],
1423 "usage": "hf 14b apdu [-hskte] [--decode] [-m <hex>] [-l <int>] -d <hex> [--timeout <dec>]"
1424 },
1425 "hf 14b calypso": {
1426 "command": "hf 14b calypso",
1427 "description": "Reads out the contents of a ISO14443B Calypso card",
1428 "notes": [
1429 "hf 14b calypso"
1430 ],
1431 "offline": false,
1432 "options": [
1433 "-h, --help This help"
1434 ],
1435 "usage": "hf 14b calypso [-h]"
1436 },
1437 "hf 14b dump": {
1438 "command": "hf 14b dump",
1439 "description": "This command dumps the contents of a ISO-14443-B tag and save it to file Tries to autodetect cardtype, memory size defaults to SRI4K",
1440 "notes": [
1441 "hf 14b dump",
1442 "hf 14b dump -f myfilename"
1443 ],
1444 "offline": false,
1445 "options": [
1446 "-h, --help This help",
1447 "-f, --file <fn> (optional) filename, if no <name> UID will be used as filename",
1448 "--ns no save to file",
1449 "-z, --dense dense dump output style"
1450 ],
1451 "usage": "hf 14b dump [-hz] [-f <fn>] [--ns]"
1452 },
1453 "hf 14b help": {
1454 "command": "hf 14b help",
1455 "description": "--------- ----------------------- General ----------------------- help This help list List ISO-14443-B history --------- ----------------------- Operations ----------------------- view Display content from tag dump file valid SRIX4 checksum test --------- ------------------ Calypso / Mobib ------------------ --------------------------------------------------------------------------------------- hf 14b list available offline: yes Alias of `trace list -t 14b -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
1456 "notes": [
1457 "hf 14b list --frame -> show frame delay times",
1458 "hf 14b list -1 -> use trace buffer"
1459 ],
1460 "offline": true,
1461 "options": [
1462 "-h, --help This help",
1463 "-1, --buffer use data from trace buffer",
1464 "--frame show frame delay times",
1465 "-c mark CRC bytes",
1466 "-r show relative times (gap and duration)",
1467 "-u display times in microseconds instead of clock cycles",
1468 "-x show hexdump to convert to pcap(ng)",
1469 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
1470 "-f, --file <fn> filename of dictionary"
1471 ],
1472 "usage": "hf 14b list [-h1crux] [--frame] [-f <fn>]"
1473 },
1474 "hf 14b info": {
1475 "command": "hf 14b info",
1476 "description": "Tag information for ISO/IEC 14443 type B based tags",
1477 "notes": [
1478 "hf 14b info"
1479 ],
1480 "offline": false,
1481 "options": [
1482 "-h, --help This help",
1483 "-s, --aidsearch checks if AIDs from aidlist.json is present on the card and prints information about found AIDs",
1484 "-v, --verbose verbose output"
1485 ],
1486 "usage": "hf 14b info [-hsv]"
1487 },
1488 "hf 14b mobib": {
1489 "command": "hf 14b mobib",
1490 "description": "Reads out the contents of a ISO14443B Mobib card",
1491 "notes": [
1492 "hf 14b mobib"
1493 ],
1494 "offline": false,
1495 "options": [
1496 "-h, --help This help"
1497 ],
1498 "usage": "hf 14b mobib [-h]"
1499 },
1500 "hf 14b ndefread": {
1501 "command": "hf 14b ndefread",
1502 "description": "Print NFC Data Exchange Format (NDEF)",
1503 "notes": [
1504 "hf 14b ndefread",
1505 "hf 14b ndefread -f myfilename -> save raw NDEF to file"
1506 ],
1507 "offline": false,
1508 "options": [
1509 "-h, --help This help",
1510 "-f, --file <fn> Save raw NDEF to file",
1511 "-v, --verbose Verbose output"
1512 ],
1513 "usage": "hf 14b ndefread [-hv] [-f <fn>]"
1514 },
1515 "hf 14b raw": {
1516 "command": "hf 14b raw",
1517 "description": "Sends raw bytes to card. Activates field by default",
1518 "notes": [
1519 "hf 14b raw -cks --data 0200a40400 -> standard select, apdu 0200a4000 (7816)",
1520 "hf 14b raw -ck --sr --data 0200a40400 -> SRx select",
1521 "hf 14b raw -ck --cts --data 0200a40400 -> C-ticket select"
1522 ],
1523 "offline": false,
1524 "options": [
1525 "-h, --help This help",
1526 "-a active signal field ON without select",
1527 "-c, --crc calculate and append CRC",
1528 "-k, --keep leave the signal field ON after receive response",
1529 "-d, --data <hex> data, bytes to send",
1530 "-r do not read response from card",
1531 "-t, --timeout <dec> timeout in ms",
1532 "-s, --std use ISO14B select",
1533 "--sr use SRx ST select",
1534 "--cts use ASK C-ticket select",
1535 "--xrx use Fuji/Xerox select",
1536 "--pico use Picopass select",
1537 "-v, --verbose verbose output"
1538 ],
1539 "usage": "hf 14b raw [-hackrsv] [-d <hex>] [-t <dec>] [--sr] [--cts] [--xrx] [--pico]"
1540 },
1541 "hf 14b rdbl": {
1542 "command": "hf 14b rdbl",
1543 "description": "Read SRI512 | SRIX4K block",
1544 "notes": [
1545 "hf 14b rdbl -b 06"
1546 ],
1547 "offline": false,
1548 "options": [
1549 "-h, --help This help",
1550 "-b, --block <dec> block number"
1551 ],
1552 "usage": "hf 14b rdbl [-h] [-b <dec>]"
1553 },
1554 "hf 14b reader": {
1555 "command": "hf 14b reader",
1556 "description": "Act as a 14443B reader to identify a tag",
1557 "notes": [
1558 "hf 14b reader",
1559 "hf 14b reader -@ -> continuous reader mode"
1560 ],
1561 "offline": false,
1562 "options": [
1563 "-h, --help This help",
1564 "--plot show anticollision signal trace in plot window",
1565 "-v, --verbose verbose output",
1566 "-@ optional - continuous reader mode"
1567 ],
1568 "usage": "hf 14b reader [-hv@] [--plot]"
1569 },
1570 "hf 14b restore": {
1571 "command": "hf 14b restore",
1572 "description": "Restore data from (bin/eml/json) dump file to tag If the dump file includes the special block at the end it will be ignored",
1573 "notes": [
1574 "hf 14b restore --4k -f myfilename",
1575 "hf 14b restore --512 -f myfilename"
1576 ],
1577 "offline": false,
1578 "options": [
1579 "-h, --help This help",
1580 "-f, --file <fn> (optional) filename, if no <name> UID will be used as filename",
1581 "--512 target SRI 512 tag",
1582 "--4k target SRIX 4k tag (def)"
1583 ],
1584 "usage": "hf 14b restore [-h] [-f <fn>] [--512] [--4k]"
1585 },
1586 "hf 14b sim": {
1587 "command": "hf 14b sim",
1588 "description": "Simulate a ISO/IEC 14443 type B tag with 4 byte UID / PUPI",
1589 "notes": [
1590 "hf 14b sim -u 11AA33BB"
1591 ],
1592 "offline": false,
1593 "options": [
1594 "-h, --help This help",
1595 "-u, --uid hex 4byte UID/PUPI"
1596 ],
1597 "usage": "hf 14b sim [-h] -u hex"
1598 },
1599 "hf 14b sniff": {
1600 "command": "hf 14b sniff",
1601 "description": "Sniff the communication between reader and tag. Use `hf 14b list` to view collected data.",
1602 "notes": [
1603 "hf 14b sniff"
1604 ],
1605 "offline": false,
1606 "options": [
1607 "-h, --help This help"
1608 ],
1609 "usage": "hf 14b sniff [-h]"
1610 },
1611 "hf 14b valid": {
1612 "command": "hf 14b valid",
1613 "description": "SRIX checksum test",
1614 "notes": [
1615 "hf 14b valid"
1616 ],
1617 "offline": true,
1618 "options": [
1619 "-h, --help This help"
1620 ],
1621 "usage": "hf 14b valid [-h]"
1622 },
1623 "hf 14b view": {
1624 "command": "hf 14b view",
1625 "description": "Print a ISO14443-B dump file (bin/eml/json) note: - command expects the filename to contain a UID which is needed to determine card memory type",
1626 "notes": [
1627 "hf 14b view -f hf-14b-01020304-dump.bin"
1628 ],
1629 "offline": true,
1630 "options": [
1631 "-h, --help This help",
1632 "-f, --file <fn> Specify a filename for dump file",
1633 "-v, --verbose verbose output",
1634 "-z, --dense dense dump output style"
1635 ],
1636 "usage": "hf 14b view [-hvz] -f <fn>"
1637 },
1638 "hf 14b wrbl": {
1639 "command": "hf 14b wrbl",
1640 "description": "Write data to a SRI512 or SRIX4K block If writing to a block out-of-range, use `--force` to override checks Special block at end denots OTP and lock bits among others",
1641 "notes": [
1642 "hf 14b wrbl --4k -b 100 -d 11223344",
1643 "hf 14b wrbl --4k --sb -d 11223344 -> special block write",
1644 "hf 14b wrbl --512 -b 15 -d 11223344",
1645 "hf 14b wrbl --512 --sb -d 11223344 -> special block write"
1646 ],
1647 "offline": false,
1648 "options": [
1649 "-h, --help This help",
1650 "-b, --block <dec> block number",
1651 "-d, --data <hex> 4 hex bytes",
1652 "--512 target SRI 512 tag",
1653 "--4k target SRIX 4k tag (def)",
1654 "--sb special block write at end of memory (0xFF)",
1655 "--force overrides block range checks"
1656 ],
1657 "usage": "hf 14b wrbl [-h] [-b <dec>] -d <hex> [--512] [--4k] [--sb] [--force]"
1658 },
1659 "hf 15 csetuid": {
1660 "command": "hf 15 csetuid",
1661 "description": "Set UID for magic Chinese card (only works with such cards)",
1662 "notes": [
1663 "hf 15 csetuid -u E011223344556677 -> use gen1 command",
1664 "hf 15 csetuid -u E011223344556677 --v2 -> use gen2 command"
1665 ],
1666 "offline": false,
1667 "options": [
1668 "-h, --help This help",
1669 "-u, --uid <hex> UID, 8 hex bytes",
1670 "-2, --v2 Use gen2 magic command"
1671 ],
1672 "usage": "hf 15 csetuid [-h2] -u <hex>"
1673 },
1674 "hf 15 demod": {
1675 "command": "hf 15 demod",
1676 "description": "Tries to demodulate / decode ISO-15693, from downloaded samples. Gather samples with 'hf 15 samples' / 'hf 15 sniff'",
1677 "notes": [
1678 "hf 15 demod"
1679 ],
1680 "offline": true,
1681 "options": [
1682 "-h, --help This help"
1683 ],
1684 "usage": "hf 15 demod [-h]"
1685 },
1686 "hf 15 dump": {
1687 "command": "hf 15 dump",
1688 "description": "This command dumps the contents of a ISO-15693 tag and save to file (bin/json)",
1689 "notes": [
1690 "hf 15 dump",
1691 "hf 15 dump -*",
1692 "hf 15 dump -u E011223344556677 -f hf-15-my-dump.bin"
1693 ],
1694 "offline": false,
1695 "options": [
1696 "-h, --help This help",
1697 "-u, --uid <hex> full UID (8 hex bytes)",
1698 "--ua unaddressed mode",
1699 "-* scan for tag",
1700 "-2 use slower '1 out of 256' mode",
1701 "-o, --opt set OPTION Flag (needed for TI)",
1702 "-f, --file <fn> Specify a filename for dump file",
1703 "--bs <dec> block size (def 4)",
1704 "--ns no save to file",
1705 "-v, --verbose verbose output",
1706 "-z, --dense dense dump output style"
1707 ],
1708 "usage": "hf 15 dump [-h*2ovz] [-u <hex>] [--ua] [-f <fn>] [--bs <dec>] [--ns]"
1709 },
1710 "hf 15 eload": {
1711 "command": "hf 15 eload",
1712 "description": "Load memory dump from file to be used with 'hf 15 sim'",
1713 "notes": [
1714 "hf 15 eload -f hf-15-01020304.bin"
1715 ],
1716 "offline": false,
1717 "options": [
1718 "-h, --help This help",
1719 "-f, --file <fn> filename of dump"
1720 ],
1721 "usage": "hf 15 eload [-h] -f <fn>"
1722 },
1723 "hf 15 esave": {
1724 "command": "hf 15 esave",
1725 "description": "Save emulator memory into two files (bin/json)",
1726 "notes": [
1727 "hf 15 esave -f hf-15-01020304"
1728 ],
1729 "offline": false,
1730 "options": [
1731 "-h, --help This help",
1732 "-f, --file <fn> Specify a filename for dump file"
1733 ],
1734 "usage": "hf 15 esave [-h] -f <fn>"
1735 },
1736 "hf 15 eview": {
1737 "command": "hf 15 eview",
1738 "description": "It displays emulator memory",
1739 "notes": [
1740 "hf 15 eview",
1741 "hf 15 eview -z"
1742 ],
1743 "offline": false,
1744 "options": [
1745 "-h, --help This help",
1746 "-z, --dense dense dump output style"
1747 ],
1748 "usage": "hf 15 eview [-hz]"
1749 },
1750 "hf 15 findafi": {
1751 "command": "hf 15 findafi",
1752 "description": "This command attempts to brute force AFI of an ISO-15693 tag Estimated execution time is around 2 minutes",
1753 "notes": [
1754 "hf 15 findafi"
1755 ],
1756 "offline": false,
1757 "options": [
1758 "-h, --help This help",
1759 "-2 use slower '1 out of 256' mode"
1760 ],
1761 "usage": "hf 15 findafi [-h2]"
1762 },
1763 "hf 15 help": {
1764 "command": "hf 15 help",
1765 "description": "----------- ----------------------- General ----------------------- help This help list List ISO-15693 history ----------- ----------------------- Operations ----------------------- demod Demodulate ISO-15693 from tag view Display content from tag dump file --------------------------------------------------------------------------------------- hf 15 list available offline: yes Alias of `trace list -t 15 -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
1766 "notes": [
1767 "hf 15 list --frame -> show frame delay times",
1768 "hf 15 list -1 -> use trace buffer"
1769 ],
1770 "offline": true,
1771 "options": [
1772 "-h, --help This help",
1773 "-1, --buffer use data from trace buffer",
1774 "--frame show frame delay times",
1775 "-c mark CRC bytes",
1776 "-r show relative times (gap and duration)",
1777 "-u display times in microseconds instead of clock cycles",
1778 "-x show hexdump to convert to pcap(ng)",
1779 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
1780 "-f, --file <fn> filename of dictionary"
1781 ],
1782 "usage": "hf 15 list [-h1crux] [--frame] [-f <fn>]"
1783 },
1784 "hf 15 info": {
1785 "command": "hf 15 info",
1786 "description": "Uses the optional command `get_systeminfo` 0x2B to try and extract information",
1787 "notes": [
1788 "hf 15 info",
1789 "hf 15 info -*",
1790 "hf 15 info -u E011223344556677"
1791 ],
1792 "offline": false,
1793 "options": [
1794 "-h, --help This help",
1795 "-u, --uid <hex> full UID (8 hex bytes)",
1796 "--ua unaddressed mode",
1797 "-* scan for tag",
1798 "-2 use slower '1 out of 256' mode",
1799 "-o, --opt set OPTION Flag (needed for TI)"
1800 ],
1801 "usage": "hf 15 info [-h*2o] [-u <hex>] [--ua]"
1802 },
1803 "hf 15 passprotectafi": {
1804 "command": "hf 15 passprotectafi",
1805 "description": "This command enables the password protect of AFI. *** OBS! This action can not be undone! ***",
1806 "notes": [
1807 "hf 15 passprotectafi -p 00000000 --force"
1808 ],
1809 "offline": false,
1810 "options": [
1811 "-h, --help This help",
1812 "-p, --pwd <hex> EAS/AFI password, 4 hex bytes",
1813 "--force Force execution of command (irreversible)"
1814 ],
1815 "usage": "hf 15 passprotectafi [-h] -p <hex> [--force]"
1816 },
1817 "hf 15 passprotecteas": {
1818 "command": "hf 15 passprotecteas",
1819 "description": "This command enables the password protect of EAS. *** OBS! This action can not be undone! ***",
1820 "notes": [
1821 "hf 15 passprotecteas -p 00000000 --force"
1822 ],
1823 "offline": false,
1824 "options": [
1825 "-h, --help This help",
1826 "-p, --pwd <hex> EAS/AFI password, 4 hex bytes",
1827 "--force Force execution of command (irreversible)"
1828 ],
1829 "usage": "hf 15 passprotecteas [-h] -p <hex> [--force]"
1830 },
1831 "hf 15 raw": {
1832 "command": "hf 15 raw",
1833 "description": "Sends raw bytes over ISO-15693 to card",
1834 "notes": [
1835 "hf 15 raw -ac -d 260100 -> activate, add crc",
1836 "hf 15 raw -akrc -d 260100 -> activate, add crc, keep field on, skip response"
1837 ],
1838 "offline": false,
1839 "options": [
1840 "-h, --help This help",
1841 "-a activate field",
1842 "-c, --crc calculate and append CRC",
1843 "-k keep signal field ON after receive",
1844 "-2 use slower '1 out of 256' mode",
1845 "-r do not read response",
1846 "-d, --data <hex> raw bytes to send",
1847 "-w, --wait wait longer for response. For writes etc."
1848 ],
1849 "usage": "hf 15 raw [-hack2rw] -d <hex>"
1850 },
1851 "hf 15 rdbl": {
1852 "command": "hf 15 rdbl",
1853 "description": "Read page on ISO-15693 tag",
1854 "notes": [
1855 "hf 15 rdbl -* -b 12",
1856 "hf 15 rdbl -u E011223344556677 -b 12"
1857 ],
1858 "offline": false,
1859 "options": [
1860 "-h, --help This help",
1861 "-u, --uid <hex> full UID (8 hex bytes)",
1862 "--ua unaddressed mode",
1863 "-* scan for tag",
1864 "-2 use slower '1 out of 256' mode",
1865 "-o, --opt set OPTION Flag (needed for TI)",
1866 "-b, --blk <dec> page number (0-255)",
1867 "--bs <dec> block size (def 4)",
1868 "-v, --verbose verbose output"
1869 ],
1870 "usage": "hf 15 rdbl [-h*2ov] [-u <hex>] [--ua] -b <dec> [--bs <dec>]"
1871 },
1872 "hf 15 rdmulti": {
1873 "command": "hf 15 rdmulti",
1874 "description": "Read multiple pages on a ISO-15693 tag",
1875 "notes": [
1876 "hf 15 rdmulti -* -b 1 --cnt 6 -> read 6 blocks",
1877 "hf 15 rdmulti -u E011223344556677 -b 12 --cnt 3 -> read three blocks"
1878 ],
1879 "offline": false,
1880 "options": [
1881 "-h, --help This help",
1882 "-u, --uid <hex> full UID (8 hex bytes)",
1883 "--ua unaddressed mode",
1884 "-* scan for tag",
1885 "-2 use slower '1 out of 256' mode",
1886 "-o, --opt set OPTION Flag (needed for TI)",
1887 "-b <dec> first page number (0-255)",
1888 "--cnt <dec> number of pages (1-6)",
1889 "--bs <dec> block size (def 4)",
1890 "-v, --verbose verbose output"
1891 ],
1892 "usage": "hf 15 rdmulti [-h*2ov] [-u <hex>] [--ua] -b <dec> --cnt <dec> [--bs <dec>]"
1893 },
1894 "hf 15 reader": {
1895 "command": "hf 15 reader",
1896 "description": "Act as a ISO-15693 reader. Look for ISO-15693 tags until Enter or the pm3 button is pressed",
1897 "notes": [
1898 "hf 15 reader",
1899 "hf 15 reader -@ -> Continuous mode"
1900 ],
1901 "offline": false,
1902 "options": [
1903 "-h, --help This help",
1904 "-@ continuous reader mode"
1905 ],
1906 "usage": "hf 15 reader [-h@]"
1907 },
1908 "hf 15 restore": {
1909 "command": "hf 15 restore",
1910 "description": "This command restore the contents of a dump file (bin/eml/json) onto a ISO-15693 tag",
1911 "notes": [
1912 "hf 15 restore",
1913 "hf 15 restore -*",
1914 "hf 15 restore -u E011223344556677 -f hf-15-my-dump.bin"
1915 ],
1916 "offline": false,
1917 "options": [
1918 "-h, --help This help",
1919 "-u, --uid <hex> full UID (8 hex bytes)",
1920 "--ua unaddressed mode",
1921 "-* scan for tag",
1922 "-2 use slower '1 out of 256' mode",
1923 "-o, --opt set OPTION Flag (needed for TI)",
1924 "-f, --file <fn> Specify a filename for dump file",
1925 "-r, --retry <dec> number of retries (def 3)",
1926 "-v, --verbose verbose output"
1927 ],
1928 "usage": "hf 15 restore [-h*2ov] [-u <hex>] [--ua] [-f <fn>] [-r <dec>]"
1929 },
1930 "hf 15 samples": {
1931 "command": "hf 15 samples",
1932 "description": "Acquire samples as Reader (enables carrier, send inquiry and download it to graphbuffer. Try 'hf 15 demod' to try to demodulate/decode signal",
1933 "notes": [
1934 "hf 15 samples"
1935 ],
1936 "offline": false,
1937 "options": [
1938 "-h, --help This help"
1939 ],
1940 "usage": "hf 15 samples [-h]"
1941 },
1942 "hf 15 sim": {
1943 "command": "hf 15 sim",
1944 "description": "Simulate a ISO-15693 tag",
1945 "notes": [
1946 "hf 15 sim",
1947 "hf 15 sim -u E011223344556677"
1948 ],
1949 "offline": false,
1950 "options": [
1951 "-h, --help This help",
1952 "-u, --uid <hex> UID, 8 hex bytes",
1953 "-b, --blocksize <dec> block size (def 4)"
1954 ],
1955 "usage": "hf 15 sim [-h] [-u <hex>] [-b <dec>]"
1956 },
1957 "hf 15 slixeasdisable": {
1958 "command": "hf 15 slixeasdisable",
1959 "description": "Disable EAS mode on SLIX ISO-15693 tag",
1960 "notes": [
1961 "hf 15 slixeasdisable -p 0F0F0F0F"
1962 ],
1963 "offline": false,
1964 "options": [
1965 "-h, --help This help",
1966 "-p, --pwd <hex> optional password, 4 hex bytes"
1967 ],
1968 "usage": "hf 15 slixeasdisable [-h] [-p <hex>]"
1969 },
1970 "hf 15 slixeasenable": {
1971 "command": "hf 15 slixeasenable",
1972 "description": "Enable EAS mode on SLIX ISO-15693 tag",
1973 "notes": [
1974 "hf 15 slixeasenable -p 0F0F0F0F"
1975 ],
1976 "offline": false,
1977 "options": [
1978 "-h, --help This help",
1979 "-p, --pwd <hex> optional password, 4 hex bytes"
1980 ],
1981 "usage": "hf 15 slixeasenable [-h] [-p <hex>]"
1982 },
1983 "hf 15 slixprivacydisable": {
1984 "command": "hf 15 slixprivacydisable",
1985 "description": "Disable privacy mode on SLIX ISO-15693 tag",
1986 "notes": [
1987 "hf 15 slixprivacydisable -p 0F0F0F0F"
1988 ],
1989 "offline": false,
1990 "options": [
1991 "-h, --help This help",
1992 "-p, --pwd <hex> password, 4 hex bytes"
1993 ],
1994 "usage": "hf 15 slixprivacydisable [-h] -p <hex>"
1995 },
1996 "hf 15 slixprivacyenable": {
1997 "command": "hf 15 slixprivacyenable",
1998 "description": "Enable privacy mode on SLIX ISO-15693 tag",
1999 "notes": [
2000 "hf 15 slixprivacyenable -p 0F0F0F0F"
2001 ],
2002 "offline": false,
2003 "options": [
2004 "-h, --help This help",
2005 "-p, --pwd <hex> password, 4 hex bytes"
2006 ],
2007 "usage": "hf 15 slixprivacyenable [-h] -p <hex>"
2008 },
2009 "hf 15 slixwritepwd": {
2010 "command": "hf 15 slixwritepwd",
2011 "description": "Write a password on a SLIX family ISO-15693 tag.nSome tags do not support all different password types.",
2012 "notes": [
2013 "hf 15 slixwritepwd -t READ -o 00000000 -n 12131415"
2014 ],
2015 "offline": false,
2016 "options": [
2017 "-h, --help This help",
2018 "-t, --type <read|write|privacy|destroy|easafi> which password field to write to",
2019 "-o, --old <hex> old password (if present), 4 hex bytes",
2020 "-n, --new <hex> new password, 4 hex bytes"
2021 ],
2022 "usage": "hf 15 slixwritepwd [-h] -t <read|write|privacy|destroy|easafi> [-o <hex>] -n <hex>"
2023 },
2024 "hf 15 sniff": {
2025 "command": "hf 15 sniff",
2026 "description": "Sniff activity without enabling carrier",
2027 "notes": [
2028 "hf 15 sniff"
2029 ],
2030 "offline": false,
2031 "options": [
2032 "-h, --help This help"
2033 ],
2034 "usage": "hf 15 sniff [-h]"
2035 },
2036 "hf 15 view": {
2037 "command": "hf 15 view",
2038 "description": "Print a ISO-15693 tag dump file (bin/eml/json)",
2039 "notes": [
2040 "hf 15 view -f hf-iclass-AA162D30F8FF12F1-dump.bin"
2041 ],
2042 "offline": true,
2043 "options": [
2044 "-h, --help This help",
2045 "-f, --file <fn> Specify a filename for dump file",
2046 "-z, --dense dense dump output style"
2047 ],
2048 "usage": "hf 15 view [-hz] -f <fn>"
2049 },
2050 "hf 15 wipe": {
2051 "command": "hf 15 wipe",
2052 "description": "Wipe a ISO-15693 tag by filled memory with zeros",
2053 "notes": [
2054 "hf 15 wipe"
2055 ],
2056 "offline": false,
2057 "options": [
2058 "-h, --help This help",
2059 "-u, --uid <hex> full UID (8 hex bytes)",
2060 "--ua unaddressed mode",
2061 "-* scan for tag",
2062 "-2 use slower '1 out of 256' mode",
2063 "-o, --opt set OPTION Flag (needed for TI)",
2064 "--bs <dec> block size (def 4)",
2065 "-v, --verbose verbose output"
2066 ],
2067 "usage": "hf 15 wipe [-h*2ov] [-u <hex>] [--ua] [--bs <dec>]"
2068 },
2069 "hf 15 wrbl": {
2070 "command": "hf 15 wrbl",
2071 "description": "Write block on ISO-15693 tag",
2072 "notes": [
2073 "hf 15 wrbl -* -b 12 -d AABBCCDD",
2074 "hf 15 wrbl -u E011223344556677 -b 12 -d AABBCCDD"
2075 ],
2076 "offline": false,
2077 "options": [
2078 "-h, --help This help",
2079 "-u, --uid <hex> full UID (8 hex bytes)",
2080 "--ua unaddressed mode",
2081 "-* scan for tag",
2082 "-2 use slower '1 out of 256' mode",
2083 "-o, --opt set OPTION Flag (needed for TI)",
2084 "-b, --blk <dec> page number (0-255)",
2085 "-d, --data <hex> data, 4 bytes",
2086 "-v, --verbose verbose output"
2087 ],
2088 "usage": "hf 15 wrbl [-h*2ov] [-u <hex>] [--ua] -b <dec> -d <hex>"
2089 },
2090 "hf 15 writeafi": {
2091 "command": "hf 15 writeafi",
2092 "description": "Write AFI on card",
2093 "notes": [
2094 "hf 15 writeafi -* --afi 12",
2095 "hf 15 writeafi -u E011223344556677 --afi 12 -p 0F0F0F0F"
2096 ],
2097 "offline": false,
2098 "options": [
2099 "-h, --help This help",
2100 "-u, --uid <hex> full UID, 8 hex bytes",
2101 "--afi <dec> AFI number (0-255)",
2102 "-p, --pwd <hex> optional AFI/EAS password"
2103 ],
2104 "usage": "hf 15 writeafi [-h] [-u <hex>] --afi <dec> [-p <hex>]"
2105 },
2106 "hf 15 writedsfid": {
2107 "command": "hf 15 writedsfid",
2108 "description": "Write DSFID on card",
2109 "notes": [
2110 "hf 15 writedsfid -* --dsfid 12",
2111 "hf 15 writedsfid -u E011223344556677 --dsfid 12"
2112 ],
2113 "offline": false,
2114 "options": [
2115 "-h, --help This help",
2116 "-u, --uid <hex> full UID (8 hex bytes)",
2117 "--ua unaddressed mode",
2118 "-* scan for tag",
2119 "-2 use slower '1 out of 256' mode",
2120 "-o, --opt set OPTION Flag (needed for TI)",
2121 "--dsfid <dec> DSFID number (0-255)",
2122 "-v, --verbose verbose output"
2123 ],
2124 "usage": "hf 15 writedsfid [-h*2ov] [-u <hex>] [--ua] --dsfid <dec>"
2125 },
2126 "hf cipurse aread": {
2127 "command": "hf cipurse aread",
2128 "description": "Read file attributes by file ID with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2129 "notes": [
2130 "hf cipurse aread --fid 2ff7 -> Select MF, Authenticate with keyID 1, read file attributes with id 2ff7",
2131 "hf cipurse aread --mfd -> read file attributes for master file (MF)",
2132 "hf cipurse aread --chfid 0102 -> read file 0102 attributes in the default application",
2133 "hf cipurse aread --aid 4144204632 --chfid 0102 -> read file 0102 attributes in the 4144204632 application",
2134 "hf cipurse aread -n 2 -k 65656565656565656565656565656565 --fid 2ff7 -> Authenticate keyID 2, read file attributes"
2135 ],
2136 "offline": false,
2137 "options": [
2138 "-h, --help This help",
2139 "-a, --apdu Show APDU requests and responses",
2140 "-v, --verbose Verbose mode",
2141 "-n <dec> Key ID",
2142 "-k, --key <hex> Auth key",
2143 "--mfd Show info about master file",
2144 "--aid <hex> Select application ID (AID) ( 1..16 bytes )",
2145 "--fid <hex> File ID",
2146 "--chfid <hex> Child file ID (EF under application/master file) ( 2 bytes )",
2147 "--noauth Read file attributes without authentication",
2148 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2149 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)"
2150 ],
2151 "usage": "hf cipurse aread [-hav] [-n <dec>] [-k <hex>] [--mfd] [--aid <hex>] [--fid <hex>] [--chfid <hex>] [--noauth] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>]"
2152 },
2153 "hf cipurse auth": {
2154 "command": "hf cipurse auth",
2155 "description": "Authenticate with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2156 "notes": [
2157 "hf cipurse auth -> Authenticate with keyID 1, default key",
2158 "hf cipurse auth -n 2 -k 65656565656565656565656565656565 -> Authenticate keyID 2 with key"
2159 ],
2160 "offline": false,
2161 "options": [
2162 "-h, --help This help",
2163 "-a, --apdu Show APDU requests and responses",
2164 "-v, --verbose Verbose mode",
2165 "--aid <hex> Application ID (AID) ( 1..16 bytes )",
2166 "--fid <hex> Top file/application ID (FID) ( 2 bytes )",
2167 "--mfd Select masterfile by empty id",
2168 "-n <dec> Key ID",
2169 "-k, --key <hex> Auth key"
2170 ],
2171 "usage": "hf cipurse auth [-hav] [--aid <hex>] [--fid <hex>] [--mfd] [-n <dec>] [-k <hex>]"
2172 },
2173 "hf cipurse awrite": {
2174 "command": "hf cipurse awrite",
2175 "description": "Write file attributes by file ID with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2176 "notes": [
2177 "hf cipurse awrite --fid 2ff7 -d 080000C1C1C1C1C1C1C1C1C1 -> write default file attributes with id 2ff7",
2178 "hf cipurse awrite --mfd -d 080000FFFFFFFFFFFFFFFFFF86023232 --commit -> write file attributes for master file (MF)",
2179 "hf cipurse awrite --chfid 0102 -d 020000ffffff -> write file 0102 attributes in the default application to full access",
2180 "hf cipurse awrite --chfid 0102 -d 02000040ffff -> write file 0102 attributes in the default application to full access with keys 1 and 2"
2181 ],
2182 "offline": false,
2183 "options": [
2184 "-h, --help This help",
2185 "-a, --apdu Show APDU requests and responses",
2186 "-v, --verbose Verbose mode",
2187 "-n <dec> Key ID",
2188 "-k, --key <hex> Auth key",
2189 "--mfd Show info about master file",
2190 "--aid <hex> Select application ID (AID) ( 1..16 bytes )",
2191 "--fid <hex> File ID",
2192 "--chfid <hex> Child file ID (EF under application/master file) ( 2 bytes )",
2193 "--noauth Read file attributes without authentication",
2194 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2195 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)",
2196 "-d, --data <hex> File attributes",
2197 "--commit Commit after write"
2198 ],
2199 "usage": "hf cipurse awrite [-hav] [-n <dec>] [-k <hex>] [--mfd] [--aid <hex>] [--fid <hex>] [--chfid <hex>] [--noauth] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>] [-d <hex>] [--commit]"
2200 },
2201 "hf cipurse create": {
2202 "command": "hf cipurse create",
2203 "description": "Create application/file/key by provide appropriate DGI. If no key is supplied, default key of 737373...7373 will be used",
2204 "notes": [
2205 "hf cipurse create -d 9200123F00200008000062098407A0000005070100 -> create PTSE file with FID 0x2000 and space for 8 AIDs",
2206 "hf cipurse create -d 92002438613F010A050200004040FF021009021009621084054144204631D407A0000005070100A00F2873737373737373737373737373737373015FD67B000102030405060708090A0B0C0D0E0F01C6A13B -> create default file with FID 3F01 and 2 keys",
2207 "hf cipurse create --aid 4144204631 -d 92010C010001020030020000FFFFFF -> create 0x0102 binary data EF under application 4144204631"
2208 ],
2209 "offline": false,
2210 "options": [
2211 "-h, --help This help",
2212 "-a, --apdu Show APDU requests and responses",
2213 "-v, --verbose Verbose mode",
2214 "-n <dec> Key ID",
2215 "-k, --key <hex> Auth key",
2216 "--aid <hex> Application ID (AID) ( 1..16 bytes )",
2217 "--fid <hex> File ID (FID) ( 2 bytes )",
2218 "--mfd Select masterfile by empty id",
2219 "-d, --data <hex> Data with DGI for create",
2220 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2221 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)",
2222 "--no-auth Execute without authentication",
2223 "--commit Commit after create"
2224 ],
2225 "usage": "hf cipurse create [-hav] [-n <dec>] [-k <hex>] [--aid <hex>] [--fid <hex>] [--mfd] [-d <hex>] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>] [--no-auth] [--commit]"
2226 },
2227 "hf cipurse default": {
2228 "command": "hf cipurse default",
2229 "description": "Set default parameters for access to cipurse card",
2230 "notes": [
2231 "hf cipurse default --reset -> reset parameters to default",
2232 "hf cipurse default -n 1 -k 65656565656565656565656565656565 --fid 2ff7 -> Set key, key id and file id",
2233 "hf cipurse default --aid 4144204632 -> set default application id"
2234 ],
2235 "offline": false,
2236 "options": [
2237 "-h, --help This help",
2238 "--clear Resets to defaults",
2239 "-n <dec> Key ID",
2240 "-k, --key <hex> Authentication key",
2241 "--aid <hex> Application ID (AID) ( 1..16 bytes )",
2242 "--fid <hex> File ID ( 2 bytes )"
2243 ],
2244 "usage": "hf cipurse default [-h] [--clear] [-n <dec>] [-k <hex>] [--aid <hex>] [--fid <hex>]"
2245 },
2246 "hf cipurse delete": {
2247 "command": "hf cipurse delete",
2248 "description": "Delete file by file ID with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2249 "notes": [
2250 "hf cipurse delete --fid 2ff7 -> Authenticate with keyID 1, delete file with id 2ff7 at top level",
2251 "hf cipurse delete -n 2 -k 65656565656565656565656565656565 --fid 2ff7 -> Authenticate keyID 2 and delete file",
2252 "hf cipurse delete --aid A0000005070100 --no-auth -> delete PTSE file with AID A0000005070100 without authentication",
2253 "hf cipurse delete --aid 4144204631 --chfid 0102 -> delete EF with FID 0x0102 under default application"
2254 ],
2255 "offline": false,
2256 "options": [
2257 "-h, --help This help",
2258 "-a, --apdu Show APDU requests and responses",
2259 "-v, --verbose Verbose mode",
2260 "-n <dec> Key ID",
2261 "-k, --key <hex> Auth key",
2262 "--fid <hex> File/application ID under MF for delete",
2263 "--aid <hex> Application ID (AID) for delete ( 1..16 bytes )",
2264 "--chfid <hex> Child file ID (EF under application/master file) ( 2 bytes )",
2265 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2266 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)",
2267 "--no-auth Execute without authentication",
2268 "--commit commit after delete"
2269 ],
2270 "usage": "hf cipurse delete [-hav] [-n <dec>] [-k <hex>] [--fid <hex>] [--aid <hex>] [--chfid <hex>] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>] [--no-auth] [--commit]"
2271 },
2272 "hf cipurse formatall": {
2273 "command": "hf cipurse formatall",
2274 "description": "Format card. Erases all the data at the card level!",
2275 "notes": [
2276 "hf cipurse formatall -> Format card with default key",
2277 "hf cipurse formatall -n 2 -k 65656565656565656565656565656565 -> Format card with keyID 2",
2278 "hf cipurse formatall --no-auth -> Format card without authentication. Works for card in perso state"
2279 ],
2280 "offline": false,
2281 "options": [
2282 "-h, --help This help",
2283 "-a, --apdu Show APDU requests and responses",
2284 "-v, --verbose Verbose mode",
2285 "-n <dec> Key ID",
2286 "-k, --key <hex> Auth key",
2287 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2288 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)",
2289 "--no-auth Execute without authentication"
2290 ],
2291 "usage": "hf cipurse formatall [-hav] [-n <dec>] [-k <hex>] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>] [--no-auth]"
2292 },
2293 "hf cipurse help": {
2294 "command": "hf cipurse help",
2295 "description": "help This help. test Regression tests --------------------------------------------------------------------------------------- hf cipurse info available offline: no Get info from CIPURSE tags",
2296 "notes": [
2297 "hf cipurse info"
2298 ],
2299 "offline": true,
2300 "options": [
2301 "-h, --help This help"
2302 ],
2303 "usage": "hf cipurse info [-h]"
2304 },
2305 "hf cipurse read": {
2306 "command": "hf cipurse read",
2307 "description": "Read file in the application by file ID with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2308 "notes": [
2309 "hf cipurse read --fid 2ff7 -> Authenticate with keyID 1, read file with id 2ff7",
2310 "hf cipurse read -n 2 -k 65656565656565656565656565656565 --fid 2ff7 -> Authenticate keyID 2 and read file",
2311 "hf cipurse read --aid 4144204631 --fid 0102 -> read file with id 0102 from application 4144204631"
2312 ],
2313 "offline": false,
2314 "options": [
2315 "-h, --help This help",
2316 "-a, --apdu Show APDU requests and responses",
2317 "-v, --verbose Verbose mode",
2318 "-n <dec> Key ID",
2319 "-k, --key <hex> Auth key",
2320 "--aid <hex> Application ID (AID) ( 1..16 bytes )",
2321 "--fid <hex> File ID",
2322 "-o, --offset <dec> Offset for reading data from file",
2323 "--noauth Read file without authentication",
2324 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2325 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)"
2326 ],
2327 "usage": "hf cipurse read [-hav] [-n <dec>] [-k <hex>] [--aid <hex>] [--fid <hex>] [-o <dec>] [--noauth] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>]"
2328 },
2329 "hf cipurse select": {
2330 "command": "hf cipurse select",
2331 "description": "Select application or file",
2332 "notes": [
2333 "hf cipurse select --aid A0000005070100 -> Select PTSE application by AID",
2334 "hf cipurse select --fid 3f00 -> Select master file by FID 3f00",
2335 "hf cipurse select --fid 2ff7 -> Select attribute file by FID 2ff7",
2336 "hf cipurse select --mfd -vt -> Select default file by empty FID and show response data in plain and TLV decoded format"
2337 ],
2338 "offline": false,
2339 "options": [
2340 "-h, --help This help",
2341 "-a, --apdu Show APDU requests and responses",
2342 "-v, --verbose Verbose mode",
2343 "-t, --tlv TLV decode returned data",
2344 "--aid <hex> Application ID (AID) 1..16 bytes",
2345 "--fid <hex> Top level file (or application) ID (FID) 2 bytes",
2346 "--mfd Select masterfile by empty id",
2347 "--chfid <hex> Child file ID (EF under application/master file) 2 bytes"
2348 ],
2349 "usage": "hf cipurse select [-havt] [--aid <hex>] [--fid <hex>] [--mfd] [--chfid <hex>]"
2350 },
2351 "hf cipurse test": {
2352 "command": "hf cipurse test",
2353 "description": "Regression tests",
2354 "notes": [
2355 "hf cipurse test"
2356 ],
2357 "offline": true,
2358 "options": [
2359 "-h, --help This help"
2360 ],
2361 "usage": "hf cipurse test [-h]"
2362 },
2363 "hf cipurse updakey": {
2364 "command": "hf cipurse updakey",
2365 "description": "Update key attributes. Factory default - 0x02. b0 - Update right - 1 self b1 - Change key and rights - 0 frozen b2 - Use as key encryption key - 1 blocked b8 - Key validity - 0 valid",
2366 "notes": [
2367 "hf cipurse updakey --trgkeyn 2 --attr 80 -> block key 2 for lifetime (WARNING!)",
2368 "hf cipurse updakey --trgkeyn 1 --attr 02 --commit -> for key 1"
2369 ],
2370 "offline": false,
2371 "options": [
2372 "-h, --help This help",
2373 "-a, --apdu Show APDU requests and responses",
2374 "-v, --verbose Show technical data",
2375 "-n <dec> Key ID for authentication",
2376 "-k, --key <hex> Auth key",
2377 "--aid <hex 1..16 bytes> Application ID (AID)",
2378 "--fid <hex 2 bytes> File ID (FID)",
2379 "--mfd Select masterfile by empty id",
2380 "--trgkeyn <dec> Target key ID",
2381 "--attr <hex 1 byte> Key attributes 1 byte",
2382 "--sreq <plain|mac(default)|encode> Communication reader-PICC security level",
2383 "--sresp <plain|mac(default)|encode> Communication PICC-reader security level",
2384 "--no-auth Execute without authentication",
2385 "--commit Commit"
2386 ],
2387 "usage": "hf cipurse updakey [-hav] [-n <dec>] [-k <hex>] [--aid <hex 1..16 bytes>] [--fid <hex 2 bytes>] [--mfd] [--trgkeyn <dec>] [--attr <hex 1 byte>] [--sreq <plain|mac(default)|encode>] [--sresp <plain|mac(default)|encode>] [--no-auth] [--commit]"
2388 },
2389 "hf cipurse updkey": {
2390 "command": "hf cipurse updkey",
2391 "description": "Update key",
2392 "notes": [
2393 "hf cipurse updkey --aid 4144204631 --newkeyn 2 --newkeya 00 --newkey 73737373737373737373737373737373 -> update default application key 2 with default value 73..73",
2394 "hf cipurse updkey --newkeyn 1 --newkeya 00 --newkey 0102030405060708090a0b0c0d0e0f10 --commit -> for key 1"
2395 ],
2396 "offline": false,
2397 "options": [
2398 "-h, --help This help",
2399 "-a, --apdu Show APDU requests and responses",
2400 "-v, --verbose Show technical data",
2401 "-n <dec> Key ID for authentication",
2402 "-k, --key <hex> Auth key",
2403 "--aid <hex 1..16 bytes> Application ID (AID)",
2404 "--fid <hex 2 bytes> File ID (FID)",
2405 "--mfd Select masterfile by empty id",
2406 "--newkeyn <dec> Target key ID",
2407 "--newkey <hex 16 byte> New key",
2408 "--newkeya <hex 1 byte> New key additional info (def: 0x00)",
2409 "--enckeyn <dec> Encrypt key ID (must be equal to the key on the card)",
2410 "--enckey <hex 16 byte> Encrypt key (must be equal to the key on the card)",
2411 "--sreq <plain|mac(default)|encode> Communication reader-PICC security level",
2412 "--sresp <plain|mac(default)|encode> Communication PICC-reader security level",
2413 "--no-auth Execute without authentication",
2414 "--commit Commit"
2415 ],
2416 "usage": "hf cipurse updkey [-hav] [-n <dec>] [-k <hex>] [--aid <hex 1..16 bytes>] [--fid <hex 2 bytes>] [--mfd] [--newkeyn <dec>] [--newkey <hex 16 byte>] [--newkeya <hex 1 byte>] [--enckeyn <dec>] [--enckey <hex 16 byte>] [--sreq <plain|mac(default)|encode>] [--sresp <plain|mac(default)|encode>] [--no-auth] [--commit]"
2417 },
2418 "hf cipurse write": {
2419 "command": "hf cipurse write",
2420 "description": "Write file in the application by file ID with key ID and key. If no key is supplied, default key of 737373...7373 will be used",
2421 "notes": [
2422 "hf cipurse write --fid 2ff7 -d aabb -> Authenticate with keyID 1, write file with id 2ff7",
2423 "hf cipurse write -n 2 -k 65656565656565656565656565656565 --fid 2ff7 -d aabb -> Authenticate keyID 2 and write file",
2424 "hf cipurse write --aid 4144204631 --fid 0102 -d aabb -> write file with id 0102 in the 4144204631 application",
2425 "hf cipurse write --fid 0102 -d aabb --commit -> write file with id 0102 and perform commit after write"
2426 ],
2427 "offline": false,
2428 "options": [
2429 "-h, --help This help",
2430 "-a, --apdu Show APDU requests and responses",
2431 "-v, --verbose Verbose mode",
2432 "-n <dec> Key ID",
2433 "-k, --key <hex> Auth key",
2434 "--aid <hex> Application ID (AID) ( 1..16 bytes )",
2435 "--fid <hex> File ID",
2436 "-o, --offset <dec> Offset for reading data from file",
2437 "--noauth Read file without authentication",
2438 "--sreq <plain|mac|encode> Communication reader-PICC security level (def: mac)",
2439 "--sresp <plain|mac|encode> Communication PICC-reader security level (def: mac)",
2440 "-d, --data <hex> Data to write to new file",
2441 "--commit Commit after write"
2442 ],
2443 "usage": "hf cipurse write [-hav] [-n <dec>] [-k <hex>] [--aid <hex>] [--fid <hex>] [-o <dec>] [--noauth] [--sreq <plain|mac|encode>] [--sresp <plain|mac|encode>] [-d <hex>] [--commit]"
2444 },
2445 "hf emrtd help": {
2446 "command": "hf emrtd help",
2447 "description": "help This help info Display info about an eMRTD list List ISO 14443A/7816 history --------------------------------------------------------------------------------------- hf emrtd dump available offline: no Dump all files on an eMRTD",
2448 "notes": [
2449 "hf emrtd dump",
2450 "hf emrtd dump --dir ../dump",
2451 "hf emrtd dump -n 123456789 -d 890101 -e 250401"
2452 ],
2453 "offline": true,
2454 "options": [
2455 "-h, --help This help",
2456 "-n, --doc <alphanum> document number, up to 9 chars",
2457 "-d, --date <YYMMDD> date of birth in YYMMDD format",
2458 "-e, --expiry <YYMMDD> expiry in YYMMDD format",
2459 "-m, --mrz <[0-9A-Z<]> 2nd line of MRZ, 44 chars",
2460 "--dir <str> save dump to the given dirpath"
2461 ],
2462 "usage": "hf emrtd dump [-h] [-n <alphanum>] [-d <YYMMDD>] [-e <YYMMDD>] [-m <[0-9A-Z<]>] [--dir <str>]"
2463 },
2464 "hf emrtd info": {
2465 "command": "hf emrtd info",
2466 "description": "Display info about an eMRTD",
2467 "notes": [
2468 "hf emrtd info",
2469 "hf emrtd info --dir ../dumps",
2470 "hf emrtd info -n 123456789 -d 890101 -e 250401",
2471 "hf emrtd info -n 123456789 -d 890101 -e 250401 -i"
2472 ],
2473 "offline": true,
2474 "options": [
2475 "-h, --help This help",
2476 "-n, --doc <alphanum> document number, up to 9 chars",
2477 "-d, --date <YYMMDD> date of birth in YYMMDD format",
2478 "-e, --expiry <YYMMDD> expiry in YYMMDD format",
2479 "-m, --mrz <[0-9A-Z<]> 2nd line of MRZ, 44 chars (passports only)",
2480 "--dir <str> display info from offline dump stored in dirpath",
2481 "-i, --images show images"
2482 ],
2483 "usage": "hf emrtd info [-hi] [-n <alphanum>] [-d <YYMMDD>] [-e <YYMMDD>] [-m <[0-9A-Z<]>] [--dir <str>]"
2484 },
2485 "hf emrtd list": {
2486 "command": "hf emrtd list",
2487 "description": "Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
2488 "notes": [
2489 "hf emrtd list --frame -> show frame delay times",
2490 "hf emrtd list -1 -> use trace buffer"
2491 ],
2492 "offline": true,
2493 "options": [
2494 "-h, --help This help",
2495 "-1, --buffer use data from trace buffer",
2496 "--frame show frame delay times",
2497 "-c mark CRC bytes",
2498 "-r show relative times (gap and duration)",
2499 "-u display times in microseconds instead of clock cycles",
2500 "-x show hexdump to convert to pcap(ng)",
2501 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
2502 "-f, --file <fn> filename of dictionary"
2503 ],
2504 "usage": "hf emrtd list [-h1crux] [--frame] [-f <fn>]"
2505 },
2506 "hf epa help": {
2507 "command": "hf epa help",
2508 "description": "help This help --------------------------------------------------------------------------------------- hf epa cnonces available offline: no Tries to collect nonces when doing part of PACE protocol.",
2509 "notes": [
2510 "hf epa cnonces --size 4 --num 4 --delay 1"
2511 ],
2512 "offline": true,
2513 "options": [
2514 "-h, --help This help",
2515 "--size <dec> nonce size",
2516 "--num <dec> number of nonces to collect",
2517 "-d, --delay <dec> delay between attempts"
2518 ],
2519 "usage": "hf epa cnonces [-h] --size <dec> --num <dec> -d <dec>"
2520 },
2521 "hf epa replay": {
2522 "command": "hf epa replay",
2523 "description": "Perform PACE protocol by replaying given APDUs",
2524 "notes": [
2525 "hf epa replay --mse 0022C1A4 --get 1068000000 --map 1086000002 --pka 1234ABCDEF --ma 1A2B3C4D"
2526 ],
2527 "offline": false,
2528 "options": [
2529 "-h, --help This help",
2530 "--mse <hex> msesa APDU",
2531 "--get <hex> gn APDU",
2532 "--map <hex> map APDU",
2533 "--pka <hex> pka APDU",
2534 "--ma <hex> ma APDU"
2535 ],
2536 "usage": "hf epa replay [-h] --mse <hex> --get <hex> --map <hex> --pka <hex> --ma <hex>"
2537 },
2538 "hf epa sim": {
2539 "command": "hf epa sim",
2540 "description": "Simulate PACE protocol with given password pwd of type pty. The crypto is performed on pc or proxmark",
2541 "notes": [
2542 "hf epa sim --pwd 112233445566",
2543 "hf epa sim --pc --pty 1 --pwd 112233445566"
2544 ],
2545 "offline": false,
2546 "options": [
2547 "-h, --help This help",
2548 "--pc perform crypto on PC",
2549 "--pty <hex> type of password",
2550 "-p, --pwd <hex> password"
2551 ],
2552 "usage": "hf epa sim [-h] --pc --pty <hex> -p <hex>"
2553 },
2554 "hf felica auth1": {
2555 "command": "hf felica auth1",
2556 "description": "Initiate mutual authentication. This command must always be executed before Auth2 command and mutual authentication is achieve only after Auth2 command has succeeded. INCOMPLETE / EXPERIMENTAL COMMAND!!!",
2557 "notes": [
2558 "hf felica auth1 --an 01 --acl 0000 --sn 01 --scl 8B00 --key AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBB",
2559 "hf felica auth1 --an 01 --acl 0000 --sn 01 --scl 8B00 --key AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBBAAAAAAAAAAAAAAAA",
2560 "hf felica auth1 -i 11100910C11BC407 --an 01 --acl 0000 --sn 01 ..scl 8B00 --key AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBB"
2561 ],
2562 "offline": false,
2563 "options": [
2564 "-h, --help This help",
2565 "--an <hex> number of areas, 1 byte",
2566 "--acl <hex> area code list, 2 bytes",
2567 "-i <hex> set custom IDm",
2568 "--sn <hex> number of service, 1 byte",
2569 "--scl <hex> service code list, 2 bytes",
2570 "-k, --key <hex> 3des key, 16 bytes",
2571 "-v, --verbose verbose output"
2572 ],
2573 "usage": "hf felica auth1 [-hv] [--an <hex>] [--acl <hex>] [-i <hex>] [--sn <hex>] [--scl <hex>] [-k <hex>]"
2574 },
2575 "hf felica auth2": {
2576 "command": "hf felica auth2",
2577 "description": "Complete mutual authentication. This command can only be executed subsquent to Auth1 INCOMPLETE / EXPERIMENTAL COMMAND!!! EXPERIMENTAL COMMAND - M2c/P2c will be not checked",
2578 "notes": [
2579 "hf felica auth2 --cc 0102030405060708 --key AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBB",
2580 "hf felica auth2 -i 11100910C11BC407 --cc 0102030405060708 --key AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBB"
2581 ],
2582 "offline": false,
2583 "options": [
2584 "-h, --help This help",
2585 "-i <hex> set custom IDm",
2586 "-c, --cc <hex> M3c card challenge, 8 bytes",
2587 "-k, --key <hex> 3des M3c decryption key, 16 bytes",
2588 "-v, --verbose verbose output"
2589 ],
2590 "usage": "hf felica auth2 [-hv] [-i <hex>] [-c <hex>] [-k <hex>]"
2591 },
2592 "hf felica help": {
2593 "command": "hf felica help",
2594 "description": "----------- ----------------------- General ----------------------- help This help list List ISO 18092/FeliCa history ----------- ----------------------- Operations ----------------------- ----------- ----------------------- FeliCa Standard ----------------------- ----------- ----------------------- FeliCa Light ----------------------- --------------------------------------------------------------------------------------- hf felica list available offline: yes Alias of `trace list -t felica` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
2595 "notes": [
2596 "hf felica list --frame -> show frame delay times",
2597 "hf felica list -1 -> use trace buffer"
2598 ],
2599 "offline": true,
2600 "options": [
2601 "-h, --help This help",
2602 "-1, --buffer use data from trace buffer",
2603 "--frame show frame delay times",
2604 "-c mark CRC bytes",
2605 "-r show relative times (gap and duration)",
2606 "-u display times in microseconds instead of clock cycles",
2607 "-x show hexdump to convert to pcap(ng)",
2608 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
2609 "-f, --file <fn> filename of dictionary"
2610 ],
2611 "usage": "hf felica list [-h1crux] [--frame] [-f <fn>]"
2612 },
2613 "hf felica info": {
2614 "command": "hf felica info",
2615 "description": "Reader for FeliCa based tags",
2616 "notes": [
2617 "hf felica info"
2618 ],
2619 "offline": false,
2620 "options": [
2621 "-h, --help This help"
2622 ],
2623 "usage": "hf felica info [-h]"
2624 },
2625 "hf felica litedump": {
2626 "command": "hf felica litedump",
2627 "description": "Dump ISO/18092 FeliCa Lite tag. It will timeout after 200sec",
2628 "notes": [
2629 "hf felica litedump"
2630 ],
2631 "offline": false,
2632 "options": [
2633 "-h, --help This help"
2634 ],
2635 "usage": "hf felica litedump [-h]"
2636 },
2637 "hf felica litesim": {
2638 "command": "hf felica litesim",
2639 "description": "Emulating ISO/18092 FeliCa Lite tag",
2640 "notes": [
2641 "hf felica litesim -u 1122334455667788"
2642 ],
2643 "offline": false,
2644 "options": [
2645 "-h, --help This help",
2646 "-u, --uid <hex> UID/NDEF2 8 hex bytes"
2647 ],
2648 "usage": "hf felica litesim [-h] -u <hex>"
2649 },
2650 "hf felica raw": {
2651 "command": "hf felica raw",
2652 "description": "Send raw hex data to tag",
2653 "notes": [
2654 "hf felica raw -cs 20",
2655 "hf felica raw -cs 2008"
2656 ],
2657 "offline": false,
2658 "options": [
2659 "-h, --help This help",
2660 "-a active signal field ON without select",
2661 "-c calculate and append CRC",
2662 "-k keep signal field ON after receive",
2663 "-n <dec> number of bits",
2664 "-r do not read response",
2665 "-s active signal field ON with select",
2666 "<hex> raw bytes to send"
2667 ],
2668 "usage": "hf felica raw [-hackrs] [-n <dec>] <hex>"
2669 },
2670 "hf felica rdbl": {
2671 "command": "hf felica rdbl",
2672 "description": "Use this command to read block data from authentication-not-required Service. - Mode shall be Mode0. - Successful == block data - Unsuccessful == Status Flag1 and Flag2",
2673 "notes": [
2674 "hf felica rdbl --sn 01 --scl 8B00 --bn 01 --ble 8000",
2675 "hf felica rdbl --sn 01 --scl 4B18 --bn 01 --ble 8000 -b",
2676 "hf felica rdbl -i 01100910c11bc407 --sn 01 --scl 8B00 --bn 01 --ble 8000"
2677 ],
2678 "offline": false,
2679 "options": [
2680 "-h, --help This help",
2681 "-b get all block list elements 00 -> FF",
2682 "-i <hex> set custom IDm",
2683 "-l, --long use 3 byte block list element block number",
2684 "--sn <hex> number of service",
2685 "--scl <hex> service code list",
2686 "--bn <hex> number of block",
2687 "--ble <hex> block list element (def 2|3 bytes)",
2688 "-v, --verbose verbose output"
2689 ],
2690 "usage": "hf felica rdbl [-hblv] [-i <hex>] [--sn <hex>] [--scl <hex>] [--bn <hex>] [--ble <hex>]"
2691 },
2692 "hf felica reader": {
2693 "command": "hf felica reader",
2694 "description": "Act as a ISO 18092 / FeliCa reader. Look for FeliCa tags until Enter or the pm3 button is pressed",
2695 "notes": [
2696 "hf felica reader -@ -> Continuous mode"
2697 ],
2698 "offline": false,
2699 "options": [
2700 "-h, --help This help",
2701 "-s, --silent silent (no messages)",
2702 "-@ optional - continuous reader mode"
2703 ],
2704 "usage": "hf felica reader [-hs@]"
2705 },
2706 "hf felica resetmode": {
2707 "command": "hf felica resetmode",
2708 "description": "Use this command to reset Mode to Mode 0.",
2709 "notes": [
2710 "hf felica resetmode",
2711 "hf felica resetmode -r 0001",
2712 "hf felica resetmode -i 11100910C11BC407"
2713 ],
2714 "offline": false,
2715 "options": [
2716 "-h, --help This help",
2717 "-i <hex> set custom IDm",
2718 "-r <hex> set custom reserve",
2719 "-v, --verbose verbose output"
2720 ],
2721 "usage": "hf felica resetmode [-hv] [-i <hex>] [-r <hex>]"
2722 },
2723 "hf felica rqresponse": {
2724 "command": "hf felica rqresponse",
2725 "description": "Use this command to verify the existence of a card and its Mode. - current mode of the card is returned",
2726 "notes": [
2727 "hf felica rqresponse -i 11100910C11BC407"
2728 ],
2729 "offline": false,
2730 "options": [
2731 "-h, --help This help",
2732 "-i <hex> set custom IDm"
2733 ],
2734 "usage": "hf felica rqresponse [-h] [-i <hex>]"
2735 },
2736 "hf felica rqservice": {
2737 "command": "hf felica rqservice",
2738 "description": "Use this command to verify the existence of Area and Service, and to acquire Key Version: - When the specified Area or Service exists, the card returns Key Version. - When the specified Area or Service does not exist, the card returns FFFFh as Key Version. For Node Code List of a command packet, Area Code or Service Code of the target of acquisition of Key Version shall be enumerated in Little Endian format. If Key Version of System is the target of acquisition, FFFFh shall be specified in the command packet.",
2739 "notes": [
2740 "hf felcia rqservice --node 01 --code FFFF",
2741 "hf felcia rqservice -a --code FFFF",
2742 "hf felica rqservice -i 011204126417E405 --node 01 --code FFFF"
2743 ],
2744 "offline": false,
2745 "options": [
2746 "-h, --help This help",
2747 "-a, --all auto node number mode, iterates through all nodes 1 < n < 32",
2748 "-n, --node <hex> Number of Node",
2749 "-c, --code <hex> Node Code List (little endian)",
2750 "-i, --idm <hex> use custom IDm"
2751 ],
2752 "usage": "hf felica rqservice [-ha] [-n <hex>] [-c <hex>] [-i <hex>]"
2753 },
2754 "hf felica rqspecver": {
2755 "command": "hf felica rqspecver",
2756 "description": "Use this command to acquire the version of card OS. Response: - Format version: Fixed value 00h. Provided only if Status Flag1 = 00h - Basic version: Each value of version is expressed in BCD notation. Provided only if Status Flag1 = 00h - Number of Option: value = 0: AES card, value = 1: AES/DES card. Provided only if Status Flag1 = 00h - Option version list: Provided only if Status Flag1 = 00h - AES card: not added - AES/DES card: DES option version is added - BCD notation",
2757 "notes": [
2758 "hf felica rqspecver",
2759 "hf felica rqspecver -r 0001",
2760 "hf felica rqspecver -i 11100910C11BC407"
2761 ],
2762 "offline": false,
2763 "options": [
2764 "-h, --help This help",
2765 "-i <hex> set custom IDm",
2766 "-r <hex> set custom reserve",
2767 "-v, --verbose verbose output"
2768 ],
2769 "usage": "hf felica rqspecver [-hv] [-i <hex>] [-r <hex>]"
2770 },
2771 "hf felica rqsyscode": {
2772 "command": "hf felica rqsyscode",
2773 "description": "Use this command to acquire System Code registered to the card. - if a card is divided into more than one System, this command acquires System Code of each System existing in the card.",
2774 "notes": [
2775 "hf felica rqsyscode",
2776 "hf felica rqsyscode -i 11100910C11BC407"
2777 ],
2778 "offline": false,
2779 "options": [
2780 "-h, --help This help",
2781 "-i <hex> set custom IDm"
2782 ],
2783 "usage": "hf felica rqsyscode [-h] [-i <hex>]"
2784 },
2785 "hf felica scsvcode": {
2786 "command": "hf felica scsvcode",
2787 "description": "Feature not implemented yet. Feel free to contribute!",
2788 "notes": [
2789 "hf felica scsvcode"
2790 ],
2791 "offline": false,
2792 "options": [
2793 "-h, --help This help"
2794 ],
2795 "usage": "hf felica scsvcode [-h]"
2796 },
2797 "hf felica sniff": {
2798 "command": "hf felica sniff",
2799 "description": "Collect data from the field and save into command buffer. Buffer accessible from `hf felica list`",
2800 "notes": [
2801 "hf felica sniff",
2802 "hf felica sniff -s 10 -t 19"
2803 ],
2804 "offline": false,
2805 "options": [
2806 "-h, --help This help",
2807 "-s, --samples <dec> samples to skip",
2808 "-t, --trig <dec> triggers to skip"
2809 ],
2810 "usage": "hf felica sniff [-h] [-s <dec>] [-t <dec>]"
2811 },
2812 "hf felica wrbl": {
2813 "command": "hf felica wrbl",
2814 "description": "Use this command to write block data to authentication-not-required Service. - Mode shall be Mode0. - Un-/Ssuccessful == Status Flag1 and Flag2",
2815 "notes": [
2816 "hf felica wrbl --sn 01 --scl CB10 --bn 01 --ble 8001 -d 0102030405060708090A0B0C0D0E0F10",
2817 "hf felica wrbl -i 01100910c11bc407 --sn 01 --scl CB10 --bn 01 --ble 8001 -d 0102030405060708090A0B0C0D0E0F10"
2818 ],
2819 "offline": false,
2820 "options": [
2821 "-h, --help This help",
2822 "-d, --data <hex> data, 16 hex bytes",
2823 "-i <hex> set custom IDm",
2824 "--sn <hex> number of service",
2825 "--scl <hex> service code list",
2826 "--bn <hex> number of block",
2827 "--ble <hex> block list element (def 2|3 bytes)",
2828 "-v, --verbose verbose output"
2829 ],
2830 "usage": "hf felica wrbl [-hv] [-d <hex>] [-i <hex>] [--sn <hex>] [--scl <hex>] [--bn <hex>] [--ble <hex>]"
2831 },
2832 "hf fido assert": {
2833 "command": "hf fido assert",
2834 "description": "Execute a FIDO2 Get Assertion command. Needs json file with parameters. Sample file `fido2_defparams.json` in `client/resources/`. - Needs if `rk` option is `false` (authenticator doesn't store credential to its memory) - for yubikey there must be only one option `\"up\": true` or false note: `-vv` shows full certificates data",
2835 "notes": [
2836 "hf fido assert -> default parameters file `fido2_defparams.json`",
2837 "hf fido assert -f test.json -l -> use parameters file `text.json` and add to request CredentialId"
2838 ],
2839 "offline": false,
2840 "options": [
2841 "-h, --help This help",
2842 "-a, --apdu Show APDU requests and responses",
2843 "-v, --verbose Verbose output",
2844 "-c, --cbor Show CBOR decoded data",
2845 "-l, --list Add CredentialId from json to allowList",
2846 "-f, --file <fn> Parameter JSON file name"
2847 ],
2848 "usage": "hf fido assert [-havcl] [-f <fn>]"
2849 },
2850 "hf fido auth": {
2851 "command": "hf fido auth",
2852 "description": "Initiate a U2F token authentication. Needs key handle and two 32-byte hash numbers. key handle(var 0..255), challenge parameter (32b) and application parameter (32b) The default config filename is `fido2_defparams.json`",
2853 "notes": [
2854 "hf fido auth --kh 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f -> execute command with 2 parameters, filled 0x00 and key handle",
2855 "hf fido auth",
2856 "--kh 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f",
2857 "--cpx 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f",
2858 "--apx 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f -> execute command with parameters"
2859 ],
2860 "offline": false,
2861 "options": [
2862 "-h, --help This help",
2863 "-a, --apdu Show APDU requests and responses",
2864 "-v, --verbose Verbose output",
2865 "default mode: dont-enforce-user-presence-and-sign",
2866 "-u, --user mode: enforce-user-presence-and-sign",
2867 "-c, --check mode: check-only",
2868 "-f, --file <fn> JSON file name for parameters",
2869 "-k, --key <hex> Public key to verify signature",
2870 "--kh <hex> Key handle (var 0..255b)",
2871 "--cp <str> Challenge parameter (1..16 chars)",
2872 "--ap <str> Application parameter (1..16 chars)",
2873 "--cpx <hex> Challenge parameter (32 bytes hex)",
2874 "--apx <hex> Application parameter (32 bytes hex)"
2875 ],
2876 "usage": "hf fido auth [-havuc] default mode: [-f <fn>] [-k <hex>] [--kh <hex>] [--cp <str>] [--ap <str>] [--cpx <hex>] [--apx <hex>]"
2877 },
2878 "hf fido help": {
2879 "command": "hf fido help",
2880 "description": "help This help. list List ISO 14443A history --------------------------------------------------------------------------------------- hf fido list available offline: yes Alias of `trace list -t 14a` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
2881 "notes": [
2882 "hf fido list --frame -> show frame delay times",
2883 "hf fido list -1 -> use trace buffer"
2884 ],
2885 "offline": true,
2886 "options": [
2887 "-h, --help This help",
2888 "-1, --buffer use data from trace buffer",
2889 "--frame show frame delay times",
2890 "-c mark CRC bytes",
2891 "-r show relative times (gap and duration)",
2892 "-u display times in microseconds instead of clock cycles",
2893 "-x show hexdump to convert to pcap(ng)",
2894 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
2895 "-f, --file <fn> filename of dictionary"
2896 ],
2897 "usage": "hf fido list [-h1crux] [--frame] [-f <fn>]"
2898 },
2899 "hf fido info": {
2900 "command": "hf fido info",
2901 "description": "Get info from Fido tags",
2902 "notes": [
2903 "hf fido info"
2904 ],
2905 "offline": false,
2906 "options": [
2907 "-h, --help This help"
2908 ],
2909 "usage": "hf fido info [-h]"
2910 },
2911 "hf fido make": {
2912 "command": "hf fido make",
2913 "description": "Execute a FIDO2 Make Credential command. Needs json file with parameters. Sample file `fido2_defparams.json` in `client/resources/`. - for yubikey there must be only one option `\"rk\": true` or false note: `-vv` shows full certificates data",
2914 "notes": [
2915 "hf fido make -> use default parameters file `fido2_defparams.json`",
2916 "hf fido make -f test.json -> use parameters file `text.json`"
2917 ],
2918 "offline": false,
2919 "options": [
2920 "-h, --help This help",
2921 "-a, --apdu Show APDU requests and responses",
2922 "-v, --verbose Verbose output",
2923 "-t, --tlv Show DER certificate contents in TLV representation",
2924 "-c, --cbor Show CBOR decoded data",
2925 "-f, --file <fn> Parameter JSON file name"
2926 ],
2927 "usage": "hf fido make [-havtc] [-f <fn>]"
2928 },
2929 "hf fido reg": {
2930 "command": "hf fido reg",
2931 "description": "Initiate a U2F token registration. Needs two 32-byte hash numbers. challenge parameter (32b) and application parameter (32b). The default config filename is `fido2_defparams.json` note: `-vv` shows full certificates data",
2932 "notes": [
2933 "hf fido reg -> execute command with 2 parameters, filled 0x00",
2934 "hf fido reg --cp s0 --ap s1 -> execute command with plain parameters",
2935 "hf fido reg --cpx 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f --apx 000102030405060708090a0b0c0d0e0f000102030405060708090a0b0c0d0e0f",
2936 "hf fido reg -f fido2-params -> execute command with custom config file"
2937 ],
2938 "offline": false,
2939 "options": [
2940 "-h, --help This help",
2941 "-a, --apdu Show APDU requests and responses",
2942 "-v, --verbose Verbose output",
2943 "-t, --tlv Show DER certificate contents in TLV representation",
2944 "-f, --file <fn> JSON input file name for parameters",
2945 "--cp <str> Challenge parameter (1..16 chars)",
2946 "--ap <str> Application parameter (1..16 chars)",
2947 "--cpx <hex> Challenge parameter (32 bytes hex)",
2948 "--apx <hex> Application parameter (32 bytes hex)"
2949 ],
2950 "usage": "hf fido reg [-havt] [-f <fn>] [--cp <str>] [--ap <str>] [--cpx <hex>] [--apx <hex>]"
2951 },
2952 "hf fudan dump": {
2953 "command": "hf fudan dump",
2954 "description": "Dump FUDAN tag to file (bin/json) If no <name> given, UID will be used as filename",
2955 "notes": [
2956 "hf fudan dump -f mydump -> dump using filename"
2957 ],
2958 "offline": false,
2959 "options": [
2960 "-h, --help This help",
2961 "-f, --file <fn> Specify a filename for dump file",
2962 "--ns no save to file"
2963 ],
2964 "usage": "hf fudan dump [-h] [-f <fn>] [--ns]"
2965 },
2966 "hf fudan help": {
2967 "command": "hf fudan help",
2968 "description": "help This help view Display content from tag dump file --------------------------------------------------------------------------------------- hf fudan reader available offline: no Read a fudan tag",
2969 "notes": [
2970 "hf fudan reader",
2971 "hf fudan reader -@ -> continuous reader mode"
2972 ],
2973 "offline": true,
2974 "options": [
2975 "-h, --help This help",
2976 "-v, --verbose verbose output",
2977 "-@ optional - continuous reader mode"
2978 ],
2979 "usage": "hf fudan reader [-hv@]"
2980 },
2981 "hf fudan rdbl": {
2982 "command": "hf fudan rdbl",
2983 "description": "Read fudan block",
2984 "notes": [
2985 "hf fudan rdbl --blk 0 -k FFFFFFFFFFFF",
2986 "hf fudan rdbl --blk 3 -v"
2987 ],
2988 "offline": false,
2989 "options": [
2990 "-h, --help This help",
2991 "--blk <dec> block number",
2992 "-k, --key <hex> key, 6 hex bytes",
2993 "-v, --verbose verbose output"
2994 ],
2995 "usage": "hf fudan rdbl [-hv] --blk <dec> [-k <hex>]"
2996 },
2997 "hf fudan view": {
2998 "command": "hf fudan view",
2999 "description": "Print a FUDAN dump file (bin/eml/json)",
3000 "notes": [
3001 "hf fudan view -f hf-fudan-01020304-dump.bin"
3002 ],
3003 "offline": true,
3004 "options": [
3005 "-h, --help This help",
3006 "-f, --file <fn> Specify a filename for dump file"
3007 ],
3008 "usage": "hf fudan view [-h] -f <fn>"
3009 },
3010 "hf fudan wrbl": {
3011 "command": "hf fudan wrbl",
3012 "description": "Write fudan block with 4 hex bytes of data",
3013 "notes": [
3014 "hf fudan wrbl --blk 1 -k FFFFFFFFFFFF -d 01020304"
3015 ],
3016 "offline": false,
3017 "options": [
3018 "-h, --help This help",
3019 "--blk <dec> block number",
3020 "-k, --key <hex> key, 6 hex bytes",
3021 "-d, --data <hex> bytes to write, 4 hex bytes"
3022 ],
3023 "usage": "hf fudan wrbl [-h] --blk <dec> [-k <hex>] [-d <hex>]"
3024 },
3025 "hf gallagher clone": {
3026 "command": "hf gallagher clone",
3027 "description": "Clone Gallagher credentials to a writable DESFire card Specify site key is required if using non-default key Key, lengths for the different crypto: DES 8 bytes 2TDEA or AES 16 bytes 3TDEA 24 bytes AID, default finds lowest available in range 0x??81F4, where ?? >= 0x20.",
3028 "notes": [
3029 "hf gallagher clone --rc 1 --fc 22 --cn 3333 --il 4 --sitekey 00112233445566778899aabbccddeeff"
3030 ],
3031 "offline": false,
3032 "options": [
3033 "-h, --help This help",
3034 "-n, --keynum <dec> PICC key number [default = 0]",
3035 "-t, --algo <DES|2TDEA|3TDEA|AES> PICC crypt algo: DES, 2TDEA, 3TDEA, AES",
3036 "-k, --key <hex> Key for authentication to the PICC to create applications",
3037 "--rc <dec> Region code. 4 bits max",
3038 "--fc <dec> Facility code. 2 bytes max",
3039 "--cn <dec> Card number. 3 bytes max",
3040 "--il <dec> Issue level. 4 bits max",
3041 "--aid <hex> Application ID to write (3 bytes) [default automatically chooses]",
3042 "--sitekey <hex> Site key to compute diversified keys (16 bytes)",
3043 "--cadkey <hex> Custom AES key 0 to modify the Card Application Directory (16 bytes)",
3044 "--nocadupdate Don't modify the Card Application Directory (only creates the app)",
3045 "--noappcreate Don't create the application (only modifies the CAD)",
3046 "--apdu Show APDU requests and responses",
3047 "-v, --verbose Verbose output"
3048 ],
3049 "usage": "hf gallagher clone [-hv] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] --rc <dec> --fc <dec> --cn <dec> --il <dec> [--aid <hex>] [--sitekey <hex>] [--cadkey <hex>] [--nocadupdate] [--noappcreate] [--apdu]"
3050 },
3051 "hf gallagher decode": {
3052 "command": "hf gallagher decode",
3053 "description": "Decode Gallagher credential block Credential block can be specified with or without the bitwise inverse.",
3054 "notes": [
3055 "hf gallagher decode --data A3B4B0C151B0A31B"
3056 ],
3057 "offline": true,
3058 "options": [
3059 "-h, --help This help",
3060 "--data <hex> Credential block (8 or 16 bytes)"
3061 ],
3062 "usage": "hf gallagher decode [-h] --data <hex>"
3063 },
3064 "hf gallagher delete": {
3065 "command": "hf gallagher delete",
3066 "description": "Delete Gallagher application from a DESFire card Specify site key is required if using non-default key",
3067 "notes": [
3068 "hf gallagher delete --aid 2081f4 --sitekey 00112233445566778899aabbccddeeff"
3069 ],
3070 "offline": false,
3071 "options": [
3072 "-h, --help This help",
3073 "--aid <hex> Application ID to delete (3 bytes)",
3074 "--sitekey <hex> Site key to compute diversified keys (16 bytes)",
3075 "--cadkey <hex> Custom AES key 0 to modify the Card Application Directory (16 bytes)",
3076 "--nocadupdate Don't modify the Card Application Directory (only deletes the app)",
3077 "--noappdelete Don't delete the application (only modifies the CAD)",
3078 "--apdu Show APDU requests and responses",
3079 "-v, --verbose Verbose output"
3080 ],
3081 "usage": "hf gallagher delete [-hv] --aid <hex> [--sitekey <hex>] [--cadkey <hex>] [--nocadupdate] [--noappdelete] [--apdu]"
3082 },
3083 "hf gallagher diversifykey": {
3084 "command": "hf gallagher diversifykey",
3085 "description": "Diversify Gallagher key Specify site key is required if using non-default key",
3086 "notes": [
3087 "hf gallagher diversify --uid 11223344556677 --aid 2081f4"
3088 ],
3089 "offline": true,
3090 "options": [
3091 "-h, --help This help",
3092 "--aid <hex> Application ID for diversification (3 bytes)",
3093 "--keynum <dec> Key number [default = 0]",
3094 "--uid <hex> Card UID to delete (4 or 7 bytes)",
3095 "--sitekey <hex> Site key to compute diversified keys (16 bytes)",
3096 "--apdu Show APDU requests and responses"
3097 ],
3098 "usage": "hf gallagher diversify [-h] --aid <hex> [--keynum <dec>] [--uid <hex>] [--sitekey <hex>] [--apdu]"
3099 },
3100 "hf gallagher help": {
3101 "command": "hf gallagher help",
3102 "description": "help This help diversifykey Diversify Gallagher key decode Decode Gallagher credential block --------------------------------------------------------------------------------------- hf gallagher reader available offline: no Read a Gallagher DESFire tag from the Card Application Directory, CAD Specify site key is required if using non-default key",
3103 "notes": [
3104 "hf gallagher reader -@ -> continuous reader mode",
3105 "hf gallagher reader --aid 2081f4 --sitekey 00112233445566778899aabbccddeeff -> skip CAD"
3106 ],
3107 "offline": true,
3108 "options": [
3109 "-h, --help This help",
3110 "--aid <hex> Application ID to read (3 bytes). If specified, the CAD is not used",
3111 "--sitekey <hex> Site key to compute diversified keys (16 bytes)",
3112 "-@, --continuous Continuous reader mode",
3113 "--apdu Show APDU requests and responses",
3114 "-v, --verbose Verbose output"
3115 ],
3116 "usage": "hf gallagher reader [-h@v] [--aid <hex>] [--sitekey <hex>] [--apdu]"
3117 },
3118 "hf help": {
3119 "command": "hf help",
3120 "description": "-------- ----------------------- High Frequency ----------------------- 14a { ISO14443A RFIDs... } 14b { ISO14443B RFIDs... } 15 { ISO15693 RFIDs... } cipurse { Cipurse transport Cards... } epa { German Identification Card... } emrtd { Machine Readable Travel Document... } felica { ISO18092 / FeliCa RFIDs... } fido { FIDO and FIDO2 authenticators... } fudan { Fudan RFIDs... } gallagher { Gallagher DESFire RFIDs... } iclass { ICLASS RFIDs... } ict { ICT MFC/DESfire RFIDs... } jooki { Jooki RFIDs... } ksx6924 { KS X 6924 (T-Money, Snapper+) RFIDs } legic { LEGIC RFIDs... } lto { LTO Cartridge Memory RFIDs... } mf { MIFARE RFIDs... } mfp { MIFARE Plus RFIDs... } mfu { MIFARE Ultralight RFIDs... } mfdes { MIFARE Desfire RFIDs... } ntag424 { NXP NTAG 4242 DNA RFIDs... } seos { SEOS RFIDs... } st25ta { ST25TA RFIDs... } tesla { TESLA Cards... } texkom { Texkom RFIDs... } thinfilm { Thinfilm RFIDs... } topaz { TOPAZ (NFC Type 1) RFIDs... } vas { Apple Value Added Service } waveshare { Waveshare NFC ePaper... } xerox { Fuji/Xerox cartridge RFIDs... } ----------- --------------------- General --------------------- help This help list List protocol data in trace buffer search Search for known HF tags --------------------------------------------------------------------------------------- hf list available offline: yes Alias of `trace list -t raw` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
3121 "notes": [
3122 "hf list --frame -> show frame delay times",
3123 "hf list -1 -> use trace buffer"
3124 ],
3125 "offline": true,
3126 "options": [
3127 "-h, --help This help",
3128 "-1, --buffer use data from trace buffer",
3129 "--frame show frame delay times",
3130 "-c mark CRC bytes",
3131 "-r show relative times (gap and duration)",
3132 "-u display times in microseconds instead of clock cycles",
3133 "-x show hexdump to convert to pcap(ng)",
3134 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
3135 "-f, --file <fn> filename of dictionary"
3136 ],
3137 "usage": "hf list [-h1crux] [--frame] [-f <fn>]"
3138 },
3139 "hf iclass calcnewkey": {
3140 "command": "hf iclass calcnewkey",
3141 "description": "Calculate new keys for updating (blocks 3 & 4)",
3142 "notes": [
3143 "hf iclass calcnewkey --old 1122334455667788 --new 2233445566778899 --csn deadbeafdeadbeaf --elite2 -> e key to e key given csn",
3144 "hf iclass calcnewkey --old 1122334455667788 --new 2233445566778899 --elite -> std key to e key read csn",
3145 "hf iclass calcnewkey --old 1122334455667788 --new 2233445566778899 -> std to std read csn"
3146 ],
3147 "offline": true,
3148 "options": [
3149 "-h, --help This help",
3150 "--old <hex> Specify key as 8 hex bytes",
3151 "--oki <dec> Old key index to select key from memory 'hf iclass managekeys'",
3152 "--new <hex> Specify key as 8 hex bytes",
3153 "--nki <dec> New key index to select key from memory 'hf iclass managekeys'",
3154 "--csn <hex> Specify a Card Serial Number (CSN) to diversify the key (if omitted will attempt to read a CSN)",
3155 "--elite Elite computations applied to new key",
3156 "--elite2 Elite computations applied to both old and new key",
3157 "--oldelite Elite computations applied only to old key"
3158 ],
3159 "usage": "hf iclass calcnewkey [-h] [--old <hex>] [--oki <dec>] [--new <hex>] [--nki <dec>] [--csn <hex>] [--elite] [--elite2] [--oldelite]"
3160 },
3161 "hf iclass chk": {
3162 "command": "hf iclass chk",
3163 "description": "Checkkeys loads a dictionary text file with 8byte hex keys to test authenticating against a iClass tag",
3164 "notes": [
3165 "hf iclass chk -f iclass_default_keys.dic",
3166 "hf iclass chk -f iclass_elite_keys.dic --elite"
3167 ],
3168 "offline": false,
3169 "options": [
3170 "-h, --help This help",
3171 "-f, --file <fn> Dictionary file with default iclass keys",
3172 "--credit key is assumed to be the credit key",
3173 "--elite elite computations applied to key",
3174 "--raw no computations applied to key (raw)",
3175 "--shallow use shallow (ASK) reader modulation instead of OOK"
3176 ],
3177 "usage": "hf iclass chk [-h] -f <fn> [--credit] [--elite] [--raw] [--shallow]"
3178 },
3179 "hf iclass configcard": {
3180 "command": "hf iclass configcard",
3181 "description": "Manage reader configuration card via Cardhelper or internal database, The generated config card will be uploaded to device emulator memory. You can start simulating `hf iclass sim -t 3` or use the emul commands",
3182 "notes": [
3183 "hf iclass configcard -l -> download config card settings from cardhelper",
3184 "hf iclass configcard -p -> print all config cards in the database",
3185 "hf iclass configcard --ci 1 -> view config card setting in slot 1",
3186 "hf iclass configcard -g --ci 0 -> generate config file from slot 0"
3187 ],
3188 "offline": false,
3189 "options": [
3190 "-h, --help This help",
3191 "--ci <dec> use config slot at index",
3192 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3193 "-g generate card dump file",
3194 "-l load available cards",
3195 "-p print available cards"
3196 ],
3197 "usage": "hf iclass configcard [-hglp] [--ci <dec>] [--ki <dec>]"
3198 },
3199 "hf iclass creditepurse": {
3200 "command": "hf iclass creditepurse",
3201 "description": "Credit the epurse on an iCLASS tag. The provided key must be the credit key. The first two bytes of the epurse are the debit value (big endian) and may be any value except FFFF. The remaining two bytes of the epurse are the credit value and must be smaller than the previous value.",
3202 "notes": [
3203 "hf iclass creditepurse -d FEFFFFFF -k 001122334455667B",
3204 "hf iclass creditepurse -d FEFFFFFF --ki 0"
3205 ],
3206 "offline": false,
3207 "options": [
3208 "-h, --help This help",
3209 "-k, --key <hex> Credit key as 8 hex bytes",
3210 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3211 "-d, --data <hex> data to write as 8 hex bytes",
3212 "--elite elite computations applied to key",
3213 "--raw no computations applied to key",
3214 "-v, --verbose verbose output",
3215 "--shallow use shallow (ASK) reader modulation instead of OOK"
3216 ],
3217 "usage": "hf iclass creditepurse [-hv] [-k <hex>] [--ki <dec>] -d <hex> [--elite] [--raw] [--shallow]"
3218 },
3219 "hf iclass decrypt": {
3220 "command": "hf iclass decrypt",
3221 "description": "3DES decrypt data This is a naive implementation, it tries to decrypt every block after block 6. Correct behaviour would be to decrypt only the application areas where the key is valid, which is defined by the configuration block. OBS! In order to use this function, the file `iclass_decryptionkey.bin` must reside in the resources directory. The file must be 16 bytes binary data or... make sure your cardhelper is placed in the sim module",
3222 "notes": [
3223 "hf iclass decrypt -f hf-iclass-AA162D30F8FF12F1-dump.bin",
3224 "hf iclass decrypt -f hf-iclass-AA162D30F8FF12F1-dump.bin -k 000102030405060708090a0b0c0d0e0f",
3225 "hf iclass decrypt -d 1122334455667788 -k 000102030405060708090a0b0c0d0e0f"
3226 ],
3227 "offline": true,
3228 "options": [
3229 "-h, --help This help",
3230 "-f, --file <fn> Specify a filename for dump file",
3231 "-d, --data <hex> 3DES encrypted data",
3232 "-k, --key <hex> 3DES transport key",
3233 "-v, --verbose verbose output",
3234 "--d6 decode as block 6",
3235 "-z, --dense dense dump output style"
3236 ],
3237 "usage": "hf iclass decrypt [-hvz] [-f <fn>] [-d <hex>] [-k <hex>] [--d6]"
3238 },
3239 "hf iclass dump": {
3240 "command": "hf iclass dump",
3241 "description": "Dump all memory from a iCLASS tag",
3242 "notes": [
3243 "hf iclass dump -k 001122334455667B",
3244 "hf iclass dump -k AAAAAAAAAAAAAAAA --credit 001122334455667B",
3245 "hf iclass dump -k AAAAAAAAAAAAAAAA --elite",
3246 "hf iclass dump --ki 0",
3247 "hf iclass dump --ki 0 --ci 2"
3248 ],
3249 "offline": false,
3250 "options": [
3251 "-h, --help This help",
3252 "-f, --file <fn> save filename",
3253 "-k, --key <hex> debit key or NR/MAC for replay as 8 hex bytes",
3254 "--ki <dec> debit key index to select key from memory 'hf iclass managekeys'",
3255 "--credit <hex> credit key as 8 hex bytes",
3256 "--ci <dec> credit key index to select key from memory 'hf iclass managekeys'",
3257 "--elite elite computations applied to key",
3258 "--raw raw, the key is interpreted as raw block 3/4",
3259 "--nr replay of NR/MAC",
3260 "-z, --dense dense dump output style",
3261 "--force force unsecure card read",
3262 "--shallow use shallow (ASK) reader modulation instead of OOK",
3263 "--ns no save to file"
3264 ],
3265 "usage": "hf iclass dump [-hz] [-f <fn>] [-k <hex>] [--ki <dec>] [--credit <hex>] [--ci <dec>] [--elite] [--raw] [--nr] [--force] [--shallow] [--ns]"
3266 },
3267 "hf iclass eload": {
3268 "command": "hf iclass eload",
3269 "description": "Load emulator memory with data from (bin/json) iCLASS dump file",
3270 "notes": [
3271 "hf iclass eload -f hf-iclass-AA162D30F8FF12F1-dump.json",
3272 "hf iclass eload -f hf-iclass-AA162D30F8FF12F1-dump.bin -m"
3273 ],
3274 "offline": false,
3275 "options": [
3276 "-h, --help This help",
3277 "-f, --file <fn> Specify a filename for dump file",
3278 "-m, --mem use RDV4 spiffs",
3279 "-v, --verbose verbose output"
3280 ],
3281 "usage": "hf iclass eload [-hmv] -f <fn>"
3282 },
3283 "hf iclass encode": {
3284 "command": "hf iclass encode",
3285 "description": "Encode binary wiegand to block 7,8,9 Use either --bin or --wiegand/--fc/--cn",
3286 "notes": [
3287 "hf iclass encode --bin 10001111100000001010100011 --ki 0 -> FC 31 CN 337 (H10301)",
3288 "hf iclass encode -w H10301 --fc 31 --cn 337 --ki 0 -> FC 31 CN 337 (H10301)",
3289 "hf iclass encode --bin 10001111100000001010100011 --ki 0 --elite -> FC 31 CN 337 (H10301), writing w elite key"
3290 ],
3291 "offline": true,
3292 "options": [
3293 "-h, --help This help",
3294 "--bin <bin> Binary string i.e 0001001001",
3295 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3296 "--credit key is assumed to be the credit key",
3297 "--elite elite computations applied to key",
3298 "--raw no computations applied to key",
3299 "--enckey <hex> 3DES transport key, 16 hex bytes",
3300 "--fc <dec> facility code",
3301 "--cn <dec> card number",
3302 "-w, --wiegand <format> see `wiegand list` for available formats",
3303 "--shallow use shallow (ASK) reader modulation instead of OOK",
3304 "-v verbose (print encoded blocks)"
3305 ],
3306 "usage": "hf iclass encode [-hv] [--bin <bin>] --ki <dec> [--credit] [--elite] [--raw] [--enckey <hex>] [--fc <dec>] [--cn <dec>] [-w <format>] [--shallow]"
3307 },
3308 "hf iclass encrypt": {
3309 "command": "hf iclass encrypt",
3310 "description": "3DES encrypt data OBS! In order to use this function, the file 'iclass_decryptionkey.bin' must reside in the resources directory. The file should be 16 hex bytes of binary data",
3311 "notes": [
3312 "hf iclass encrypt -d 0102030405060708",
3313 "hf iclass encrypt -d 0102030405060708 -k 00112233445566778899AABBCCDDEEFF"
3314 ],
3315 "offline": true,
3316 "options": [
3317 "-h, --help This help",
3318 "-d, --data <hex> data to encrypt",
3319 "-k, --key <hex> 3DES transport key",
3320 "-v, --verbose verbose output"
3321 ],
3322 "usage": "hf iclass encrypt [-hv] -d <hex> [-k <hex>]"
3323 },
3324 "hf iclass esave": {
3325 "command": "hf iclass esave",
3326 "description": "Save emulator memory to file (bin/json) if filename is not supplied, CSN will be used.",
3327 "notes": [
3328 "hf iclass esave",
3329 "hf iclass esave -f hf-iclass-dump",
3330 "hf iclass esave -s 2048 -f hf-iclass-dump"
3331 ],
3332 "offline": false,
3333 "options": [
3334 "-h, --help This help",
3335 "-f, --file <fn> Specify a filename for dump file",
3336 "-s, --size <256|2048> number of bytes to save (default 256)"
3337 ],
3338 "usage": "hf iclass esave [-h] [-f <fn>] [-s <256|2048>]"
3339 },
3340 "hf iclass esetblk": {
3341 "command": "hf iclass esetblk",
3342 "description": "Sets an individual block in emulator memory.",
3343 "notes": [
3344 "hf iclass esetblk --blk 7 -d 0000000000000000"
3345 ],
3346 "offline": false,
3347 "options": [
3348 "-h, --help This help",
3349 "--blk <dec> block number",
3350 "-d, --data <hex> bytes to write, 8 hex bytes"
3351 ],
3352 "usage": "hf iclass esetblk [-h] --blk <dec> [-d <hex>]"
3353 },
3354 "hf iclass eview": {
3355 "command": "hf iclass eview",
3356 "description": "Display emulator memory. Number of bytes to download defaults to 256. Other value is 2048.",
3357 "notes": [
3358 "hf iclass eview",
3359 "hf iclass eview -s 2048",
3360 "hf iclass eview -s 2048 -v"
3361 ],
3362 "offline": false,
3363 "options": [
3364 "-h, --help This help",
3365 "-s, --size <256|2048> number of bytes to save (default 256)",
3366 "-v, --verbose verbose output",
3367 "-z, --dense dense dump output style"
3368 ],
3369 "usage": "hf iclass eview [-hvz] [-s <256|2048>]"
3370 },
3371 "hf iclass help": {
3372 "command": "hf iclass help",
3373 "description": "help This help list List iclass history view Display content from tag dump file ----------- --------------------- Recovery -------------------- loclass Use loclass to perform bruteforce reader attack lookup Uses authentication trace to check for key in dictionary file ----------- ---------------------- Utils ---------------------- calcnewkey Calc diversified keys (blocks 3 & 4) to write new keys encode Encode binary wiegand to block 7 encrypt Encrypt given block data decrypt Decrypt given block data or tag dump file managekeys Manage keys to use with iclass commands permutekey Permute function from 'heart of darkness' paper --------------------------------------------------------------------------------------- hf iclass list available offline: yes Alias of `trace list -t iclass -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
3374 "notes": [
3375 "hf iclass list --frame -> show frame delay times",
3376 "hf iclass list -1 -> use trace buffer"
3377 ],
3378 "offline": true,
3379 "options": [
3380 "-h, --help This help",
3381 "-1, --buffer use data from trace buffer",
3382 "--frame show frame delay times",
3383 "-c mark CRC bytes",
3384 "-r show relative times (gap and duration)",
3385 "-u display times in microseconds instead of clock cycles",
3386 "-x show hexdump to convert to pcap(ng)",
3387 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
3388 "-f, --file <fn> filename of dictionary"
3389 ],
3390 "usage": "hf iclass list [-h1crux] [--frame] [-f <fn>]"
3391 },
3392 "hf iclass info": {
3393 "command": "hf iclass info",
3394 "description": "Act as a iCLASS reader. Reads / fingerprints a iCLASS tag.",
3395 "notes": [
3396 "hf iclass info"
3397 ],
3398 "offline": false,
3399 "options": [
3400 "-h, --help This help",
3401 "--shallow use shallow (ASK) reader modulation instead of OOK"
3402 ],
3403 "usage": "hf iclass info [-h] [--shallow]"
3404 },
3405 "hf iclass loclass": {
3406 "command": "hf iclass loclass",
3407 "description": "Execute the offline part of loclass attack An iclass dumpfile is assumed to consist of an arbitrary number of malicious CSNs, and their protocol responses The binary format of the file is expected to be as follows: <8 byte CSN><8 byte CC><4 byte NR><4 byte MAC> <8 byte CSN><8 byte CC><4 byte NR><4 byte MAC> <8 byte CSN><8 byte CC><4 byte NR><4 byte MAC> ... totalling N*24 bytes",
3408 "notes": [
3409 "hf iclass loclass -f iclass_dump.bin",
3410 "hf iclass loclass --test"
3411 ],
3412 "offline": true,
3413 "options": [
3414 "-h, --help This help",
3415 "-f, --file <fn> filename with nr/mac data from `hf iclass sim -t 2`",
3416 "--test Perform self test",
3417 "--long Perform self test, including long ones"
3418 ],
3419 "usage": "hf iclass loclass [-h] [-f <fn>] [--test] [--long]"
3420 },
3421 "hf iclass lookup": {
3422 "command": "hf iclass lookup",
3423 "description": "This command take sniffed trace data and try to recovery a iCLASS Standard or iCLASS Elite key.",
3424 "notes": [
3425 "hf iclass lookup --csn 9655a400f8ff12e0 --epurse f0ffffffffffffff --macs 0000000089cb984b -f iclass_default_keys.dic",
3426 "hf iclass lookup --csn 9655a400f8ff12e0 --epurse f0ffffffffffffff --macs 0000000089cb984b -f iclass_default_keys.dic --elite"
3427 ],
3428 "offline": true,
3429 "options": [
3430 "-h, --help This help",
3431 "-f, --file <fn> Dictionary file with default iclass keys",
3432 "--csn <hex> Specify CSN as 8 hex bytes",
3433 "--epurse <hex> Specify ePurse as 8 hex bytes",
3434 "--macs <hex> MACs",
3435 "--elite Elite computations applied to key",
3436 "--raw no computations applied to key"
3437 ],
3438 "usage": "hf iclass lookup [-h] -f <fn> --csn <hex> --epurse <hex> --macs <hex> [--elite] [--raw]"
3439 },
3440 "hf iclass managekeys": {
3441 "command": "hf iclass managekeys",
3442 "description": "Manage iCLASS Keys in client memory",
3443 "notes": [
3444 "hf iclass managekeys --ki 0 -k 1122334455667788 -> set key 1122334455667788 at index 0",
3445 "hf iclass managekeys -f mykeys.bin --save -> save key file",
3446 "hf iclass managekeys -f mykeys.bin --load -> load key file",
3447 "hf iclass managekeys -p -> print keys"
3448 ],
3449 "offline": true,
3450 "options": [
3451 "-h, --help This help",
3452 "-f, --file <fn> Specify a filename for load / save operations",
3453 "-k, --key <hex> Access key as 8 hex bytes",
3454 "--ki <dec> Specify key index to set key in memory",
3455 "--save Save keys in memory to file specified by filename",
3456 "--load Load keys to memory from file specified by filename",
3457 "-p, --print Print keys loaded into memory"
3458 ],
3459 "usage": "hf iclass managekeys [-hp] [-f <fn>] [-k <hex>] [--ki <dec>] [--save] [--load]"
3460 },
3461 "hf iclass permutekey": {
3462 "command": "hf iclass permutekey",
3463 "description": "Permute function from 'heart of darkness' paper.",
3464 "notes": [
3465 "hf iclass permutekey --reverse --key 0123456789abcdef",
3466 "hf iclass permutekey --key ff55330f0055330f"
3467 ],
3468 "offline": true,
3469 "options": [
3470 "-h, --help This help",
3471 "-r, --reverse reverse permuted key",
3472 "--key <hex> input key, 8 hex bytes"
3473 ],
3474 "usage": "hf iclass permutekey [-hr] --key <hex>"
3475 },
3476 "hf iclass rdbl": {
3477 "command": "hf iclass rdbl",
3478 "description": "Read a iCLASS block from tag",
3479 "notes": [
3480 "hf iclass rdbl --blk 6 -k 0011223344556677",
3481 "hf iclass rdbl --blk 27 -k 0011223344556677 --credit",
3482 "hf iclass rdbl --blk 10 --ki 0"
3483 ],
3484 "offline": false,
3485 "options": [
3486 "-h, --help This help",
3487 "-k, --key <hex> Access key as 8 hex bytes",
3488 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3489 "--blk <dec> Block number",
3490 "--credit key is assumed to be the credit key",
3491 "--elite elite computations applied to key",
3492 "--raw no computations applied to key",
3493 "--nr replay of NR/MAC",
3494 "-v, --verbose verbose output",
3495 "--shallow use shallow (ASK) reader modulation instead of OOK"
3496 ],
3497 "usage": "hf iclass rdbl [-hv] [-k <hex>] [--ki <dec>] --blk <dec> [--credit] [--elite] [--raw] [--nr] [--shallow]"
3498 },
3499 "hf iclass reader": {
3500 "command": "hf iclass reader",
3501 "description": "Act as a iCLASS reader. Look for iCLASS tags until Enter or the pm3 button is pressed",
3502 "notes": [
3503 "hf iclass reader -@ -> continuous reader mode"
3504 ],
3505 "offline": false,
3506 "options": [
3507 "-h, --help This help",
3508 "-@ optional - continuous reader mode",
3509 "--shallow use shallow (ASK) reader modulation instead of OOK"
3510 ],
3511 "usage": "hf iclass reader [-h@] [--shallow]"
3512 },
3513 "hf iclass restore": {
3514 "command": "hf iclass restore",
3515 "description": "Restore data from dumpfile (bin/eml/json) onto a iCLASS tag",
3516 "notes": [
3517 "hf iclass restore -f hf-iclass-AA162D30F8FF12F1-dump.bin --first 6 --last 18 --ki 0",
3518 "hf iclass restore -f hf-iclass-AA162D30F8FF12F1-dump.bin --first 6 --last 18 --ki 0 --elite",
3519 "hf iclass restore -f hf-iclass-AA162D30F8FF12F1-dump.bin --first 6 --last 18 -k 1122334455667788 --elite"
3520 ],
3521 "offline": false,
3522 "options": [
3523 "-h, --help This help",
3524 "-f, --file <fn> specify a filename to restore",
3525 "-k, --key <hex> Access key as 8 hex bytes",
3526 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3527 "--first <dec> The first block number to restore",
3528 "--last <dec> The last block number to restore",
3529 "--credit key is assumed to be the credit key",
3530 "--elite elite computations applied to key",
3531 "--raw no computations applied to key",
3532 "-v, --verbose verbose output",
3533 "--shallow use shallow (ASK) reader modulation instead of OOK"
3534 ],
3535 "usage": "hf iclass restore [-hv] -f <fn> [-k <hex>] [--ki <dec>] --first <dec> --last <dec> [--credit] [--elite] [--raw] [--shallow]"
3536 },
3537 "hf iclass sam": {
3538 "command": "hf iclass sam",
3539 "description": "Extract PACS via a HID SAM",
3540 "notes": [
3541 "hf iclass sam"
3542 ],
3543 "offline": false,
3544 "options": [
3545 "-h, --help This help",
3546 "-v, --verbose verbose output"
3547 ],
3548 "usage": "hf iclass sam [-hv]"
3549 },
3550 "hf iclass sim": {
3551 "command": "hf iclass sim",
3552 "description": "Simulate a iCLASS legacy/standard tag",
3553 "notes": [
3554 "hf iclass sim -t 0 --csn 031FEC8AF7FF12E0 -> simulate with specified CSN",
3555 "hf iclass sim -t 1 -> simulate with default CSN",
3556 "hf iclass sim -t 2 -> execute loclass attack online part",
3557 "hf iclass sim -t 3 -> simulate full iCLASS 2k tag",
3558 "hf iclass sim -t 4 -> Reader-attack, adapted for KeyRoll mode, gather reader responses to extract elite key"
3559 ],
3560 "offline": false,
3561 "options": [
3562 "-h, --help This help",
3563 "-t, --type <0-4> Simulation type to use",
3564 "--csn <hex> Specify CSN as 8 hex bytes to use with sim type 0"
3565 ],
3566 "usage": "hf iclass sim [-h] -t <0-4> [--csn <hex>]"
3567 },
3568 "hf iclass sniff": {
3569 "command": "hf iclass sniff",
3570 "description": "Sniff the communication reader and tag",
3571 "notes": [
3572 "hf iclass sniff",
3573 "hf iclass sniff -j -> jam e-purse updates"
3574 ],
3575 "offline": false,
3576 "options": [
3577 "-h, --help This help",
3578 "-j, --jam Jam (prevent) e-purse updates"
3579 ],
3580 "usage": "hf iclass sniff [-hj]"
3581 },
3582 "hf iclass view": {
3583 "command": "hf iclass view",
3584 "description": "Print a iCLASS tag dump file (bin/eml/json)",
3585 "notes": [
3586 "hf iclass view -f hf-iclass-AA162D30F8FF12F1-dump.bin",
3587 "hf iclass view --first 1 -f hf-iclass-AA162D30F8FF12F1-dump.bin",
3588 "",
3589 "If --first is not specified it will default to the first user block",
3590 "which is block 6 for secured chips or block 3 for non-secured chips"
3591 ],
3592 "offline": true,
3593 "options": [
3594 "-h, --help This help",
3595 "-f, --file <fn> Specify a filename for dump file",
3596 "--first <dec> Begin printing from this block (default first user block)",
3597 "--last <dec> End printing at this block (default 0, ALL)",
3598 "-v, --verbose verbose output",
3599 "-z, --dense dense dump output style"
3600 ],
3601 "usage": "hf iclass view [-hvz] -f <fn> [--first <dec>] [--last <dec>]"
3602 },
3603 "hf iclass wrbl": {
3604 "command": "hf iclass wrbl",
3605 "description": "Write data to an iCLASS tag",
3606 "notes": [
3607 "hf iclass wrbl --blk 10 -d AAAAAAAAAAAAAAAA -k 001122334455667B",
3608 "hf iclass wrbl --blk 10 -d AAAAAAAAAAAAAAAA -k 001122334455667B --credit",
3609 "hf iclass wrbl --blk 10 -d AAAAAAAAAAAAAAAA --ki 0"
3610 ],
3611 "offline": false,
3612 "options": [
3613 "-h, --help This help",
3614 "-k, --key <hex> Access key as 8 hex bytes",
3615 "--ki <dec> Key index to select key from memory 'hf iclass managekeys'",
3616 "--blk <dec> block number",
3617 "-d, --data <hex> data to write as 8 hex bytes",
3618 "-m, --mac <hex> replay mac data (4 hex bytes)",
3619 "--credit key is assumed to be the credit key",
3620 "--elite elite computations applied to key",
3621 "--raw no computations applied to key",
3622 "--nr replay of NR/MAC",
3623 "-v, --verbose verbose output",
3624 "--shallow use shallow (ASK) reader modulation instead of OOK"
3625 ],
3626 "usage": "hf iclass wrbl [-hv] [-k <hex>] [--ki <dec>] --blk <dec> -d <hex> [-m <hex>] [--credit] [--elite] [--raw] [--nr] [--shallow]"
3627 },
3628 "hf ict help": {
3629 "command": "hf ict help",
3630 "description": "help This help list List ICT history reader Act like an IS14443-a reader --------------------------------------------------------------------------------------- hf ict credential available offline: no Read ICT sector from tag and decode",
3631 "notes": [
3632 "hf ict credential"
3633 ],
3634 "offline": true,
3635 "options": [
3636 "-h, --help This help",
3637 "-v, --verbose verbose output"
3638 ],
3639 "usage": "hf ict credential [-hv]"
3640 },
3641 "hf ict info": {
3642 "command": "hf ict info",
3643 "description": "Get info from ICT encoded credential tags (MIFARE Classic / DESfire)",
3644 "notes": [
3645 "hf ict info"
3646 ],
3647 "offline": false,
3648 "options": [
3649 "-h, --help This help"
3650 ],
3651 "usage": "hf ict info [-h]"
3652 },
3653 "hf ict list": {
3654 "command": "hf ict list",
3655 "description": "Alias of `trace list -t 14a -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
3656 "notes": [
3657 "hf ict list --frame -> show frame delay times",
3658 "hf ict list -1 -> use trace buffer"
3659 ],
3660 "offline": true,
3661 "options": [
3662 "-h, --help This help",
3663 "-1, --buffer use data from trace buffer",
3664 "--frame show frame delay times",
3665 "-c mark CRC bytes",
3666 "-r show relative times (gap and duration)",
3667 "-u display times in microseconds instead of clock cycles",
3668 "-x show hexdump to convert to pcap(ng)",
3669 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
3670 "-f, --file <fn> filename of dictionary"
3671 ],
3672 "usage": "hf ict list [-h1crux] [--frame] [-f <fn>]"
3673 },
3674 "hf ict reader": {
3675 "command": "hf ict reader",
3676 "description": "Act as a reader",
3677 "notes": [
3678 "hf ict reader"
3679 ],
3680 "offline": true,
3681 "options": [
3682 "-h, --help This help"
3683 ],
3684 "usage": "hf ict reader [-h]"
3685 },
3686 "hf jooki decode": {
3687 "command": "hf jooki decode",
3688 "description": "Decode a base64-encode Jooki token in NDEF URI format",
3689 "notes": [
3690 "hf jooki decode -d 7WzlgEzqLgwTnWNy"
3691 ],
3692 "offline": true,
3693 "options": [
3694 "-h, --help This help",
3695 "-d, --data <base64> base64 url parameter",
3696 "-v, --verbose verbose output"
3697 ],
3698 "usage": "hf jooki decode [-hv] -d <base64>"
3699 },
3700 "hf jooki encode": {
3701 "command": "hf jooki encode",
3702 "description": "Encode a Jooki token to base64 NDEF URI format",
3703 "notes": [
3704 "hf jooki encode -t -> selftest",
3705 "hf jooki encode -r --dragon -> read uid from tag and use for encoding",
3706 "hf jooki encode --uid 04010203040506 --dragon",
3707 "hf jooki encode --uid 04010203040506 --tid 1 --fid 1"
3708 ],
3709 "offline": true,
3710 "options": [
3711 "-h, --help This help",
3712 "-u, --uid <hex> uid bytes",
3713 "-r read uid from tag instead",
3714 "-t self test",
3715 "-v, --verbose verbose output",
3716 "--dragon figurine type",
3717 "--fox figurine type",
3718 "--ghost figurine type",
3719 "--knight figurine type",
3720 "--whale figurine type",
3721 "--blackdragon figurine type",
3722 "--blackfox figurine type",
3723 "--blackknight figurine type",
3724 "--blackwhale figurine type",
3725 "--whitedragon figurine type",
3726 "--whitefox figurine type",
3727 "--whiteknight figurine type",
3728 "--whitewhale figurine type",
3729 "--tid <dec> figurine type id",
3730 "--fid <dec> figurine id"
3731 ],
3732 "usage": "hf jooki encode [-hrtv] [-u <hex>] [--dragon] [--fox] [--ghost] [--knight] [--whale] [--blackdragon] [--blackfox] [--blackknight] [--blackwhale] [--whitedragon] [--whitefox] [--whiteknight] [--whitewhale] [--tid <dec>] [--fid <dec>]"
3733 },
3734 "hf jooki help": {
3735 "command": "hf jooki help",
3736 "description": "help This help decode Decode Jooki token encode Encode Jooki token --------------------------------------------------------------------------------------- hf jooki clone available offline: no Write a Jooki token to a Ultralight or NTAG tag",
3737 "notes": [
3738 "hf jooki clone -d <hex bytes> -> where hex is raw NDEF",
3739 "hf jooki clone --b64 7WzlgEzqLgwTnWNy -> using base64 url parameter"
3740 ],
3741 "offline": true,
3742 "options": [
3743 "-h, --help This help",
3744 "-b, --b64 <base64> base64 url parameter",
3745 "-d, --data <hex> raw NDEF bytes",
3746 "-p, --pwd <hex> password for authentication (EV1/NTAG 4 bytes)"
3747 ],
3748 "usage": "hf jooki clone [-h] [-b <base64>] [-d <hex>] [-p <hex>]"
3749 },
3750 "hf jooki sim": {
3751 "command": "hf jooki sim",
3752 "description": "Simulate a Jooki token. Either `hf mfu eload` before or use `-d` param",
3753 "notes": [
3754 "hf jooki sim -> use token in emulator memory",
3755 "hf jooki sim -b 7WzlgEzqLgwTnWNy -> using base64 url parameter"
3756 ],
3757 "offline": false,
3758 "options": [
3759 "-h, --help This help",
3760 "-b, --b64 <base64> base64 url parameter"
3761 ],
3762 "usage": "hf jooki sim [-h] [-b <base64>]"
3763 },
3764 "hf ksx6924 balance": {
3765 "command": "hf ksx6924 balance",
3766 "description": "Gets the current purse balance",
3767 "notes": [
3768 "hf ksx6924 balance"
3769 ],
3770 "offline": false,
3771 "options": [
3772 "-h, --help This help",
3773 "-k, --keep keep field ON for next command",
3774 "-a, --apdu Show APDU requests and responses"
3775 ],
3776 "usage": "hf ksx6924 balance [-hka]"
3777 },
3778 "hf ksx6924 help": {
3779 "command": "hf ksx6924 help",
3780 "description": "help This help --------------------------------------------------------------------------------------- hf ksx6924 select available offline: no Selects KS X 6924 application, and leaves field up",
3781 "notes": [
3782 "hf ksx6924 select"
3783 ],
3784 "offline": true,
3785 "options": [
3786 "-h, --help This help",
3787 "-a, --apdu Show APDU requests and responses"
3788 ],
3789 "usage": "hf ksx6924 select [-ha]"
3790 },
3791 "hf ksx6924 info": {
3792 "command": "hf ksx6924 info",
3793 "description": "Get info about a KS X 6924 transit card. This application is used by T-Money (South Korea) and Snapper+ (Wellington, New Zealand).",
3794 "notes": [
3795 "hf ksx6924 info"
3796 ],
3797 "offline": false,
3798 "options": [
3799 "-h, --help This help",
3800 "-k, --keep keep field ON for next command",
3801 "-a, --apdu Show APDU requests and responses"
3802 ],
3803 "usage": "hf ksx6924 info [-hka]"
3804 },
3805 "hf ksx6924 init": {
3806 "command": "hf ksx6924 init",
3807 "description": "Perform transaction initialization with Mpda (Money of Purchase Transaction)",
3808 "notes": [
3809 "hf ksx6924 init 000003e8 -> Mpda"
3810 ],
3811 "offline": false,
3812 "options": [
3813 "-h, --help This help",
3814 "-k, --keep keep field ON for next command",
3815 "-a, --apdu Show APDU requests and responses"
3816 ],
3817 "usage": "hf ksx6924 init [-hka] <Mpda 4 bytes hex>"
3818 },
3819 "hf ksx6924 prec": {
3820 "command": "hf ksx6924 prec",
3821 "description": "Executes proprietary read record command. Data format is unknown. Other records are available with 'emv getrec'.",
3822 "notes": [
3823 "hf ksx6924 prec 0b -> read proprietary record 0x0b"
3824 ],
3825 "offline": false,
3826 "options": [
3827 "-h, --help This help",
3828 "-k, --keep keep field ON for next command",
3829 "-a, --apdu Show APDU requests and responses"
3830 ],
3831 "usage": "hf ksx6924 prec [-hka] <record 1byte HEX>"
3832 },
3833 "hf legic crc": {
3834 "command": "hf legic crc",
3835 "description": "Calculates the legic crc8/crc16 on the given data",
3836 "notes": [
3837 "hf legic crc -d deadbeef1122",
3838 "hf legic crc -d deadbeef1122 --mcc 9A -t 16 -> CRC Type 16"
3839 ],
3840 "offline": true,
3841 "options": [
3842 "-h, --help This help",
3843 "-d, --data <hex> bytes to calculate crc over",
3844 "--mcc <hex> MCC hex byte (UID CRC)",
3845 "-t, --type <dec> CRC Type (default: 8)"
3846 ],
3847 "usage": "hf legic crc [-h] -d <hex> [--mcc <hex>] [-t <dec>]"
3848 },
3849 "hf legic einfo": {
3850 "command": "hf legic einfo",
3851 "description": "It decodes and displays emulator memory",
3852 "notes": [
3853 "hf legic einfo",
3854 "hf legic eview --22"
3855 ],
3856 "offline": false,
3857 "options": [
3858 "-h, --help This help",
3859 "--22 LEGIC Prime MIM22",
3860 "--256 LEGIC Prime MIM256 (def)",
3861 "--1024 LEGIC Prime MIM1024"
3862 ],
3863 "usage": "hf legic einfo [-h] [--22] [--256] [--1024]"
3864 },
3865 "hf legic eload": {
3866 "command": "hf legic eload",
3867 "description": "Loads a LEGIC Prime dump file into emulator memory",
3868 "notes": [
3869 "hf legic eload -f myfile",
3870 "hf legic eload -f myfile --obfuscate"
3871 ],
3872 "offline": false,
3873 "options": [
3874 "-h, --help This help",
3875 "-f, --file <fn> Filename to load",
3876 "--obfuscate Obfuscate dump data (xor with MCC)"
3877 ],
3878 "usage": "hf legic eload [-h] -f <fn> [--obfuscate]"
3879 },
3880 "hf legic esave": {
3881 "command": "hf legic esave",
3882 "description": "Saves a (bin/json) dump file of emulator memory",
3883 "notes": [
3884 "hf legic esave -> uses UID as filename",
3885 "hf legic esave -f myfile --22",
3886 "hf legic esave -f myfile --22 --de"
3887 ],
3888 "offline": false,
3889 "options": [
3890 "-h, --help This help",
3891 "-f, --file <fn> Filename to save",
3892 "--22 LEGIC Prime MIM22",
3893 "--256 LEGIC Prime MIM256 (def)",
3894 "--1024 LEGIC Prime MIM1024",
3895 "--de De-obfuscate dump data (xor with MCC)"
3896 ],
3897 "usage": "hf legic esave [-h] [-f <fn>] [--22] [--256] [--1024] [--de]"
3898 },
3899 "hf legic eview": {
3900 "command": "hf legic eview",
3901 "description": "It displays emulator memory",
3902 "notes": [
3903 "hf legic eview",
3904 "hf legic eview --22"
3905 ],
3906 "offline": false,
3907 "options": [
3908 "-h, --help This help",
3909 "--22 LEGIC Prime MIM22",
3910 "--256 LEGIC Prime MIM256 (def)",
3911 "--1024 LEGIC Prime MIM1024",
3912 "-v, --verbose verbose output"
3913 ],
3914 "usage": "hf legic eview [-hv] [--22] [--256] [--1024]"
3915 },
3916 "hf legic help": {
3917 "command": "hf legic help",
3918 "description": "----------- --------------------- operations --------------------- help This help list List LEGIC history ----------- --------------------- simulation --------------------- ----------- --------------------- utils --------------------- crc Calculate Legic CRC over given bytes view Display deobfuscated and decoded content from tag dump file --------------------------------------------------------------------------------------- hf legic dump available offline: no Read all memory from LEGIC Prime tags and saves to (bin/json) dump file It autodetects card type (MIM22, MIM256, MIM1024)",
3919 "notes": [
3920 "hf legic dump -> use UID as filename",
3921 "hf legic dump -f myfile",
3922 "hf legic dump --de -> use UID as filename and deobfuscate data"
3923 ],
3924 "offline": true,
3925 "options": [
3926 "-h, --help This help",
3927 "-f, --file <fn> Dump filename",
3928 "--de deobfuscate dump data (xor with MCC)"
3929 ],
3930 "usage": "hf legic dump [-h] [-f <fn>] [--de]"
3931 },
3932 "hf legic info": {
3933 "command": "hf legic info",
3934 "description": "Gets information from a LEGIC Prime tag like systemarea, user areas, etc",
3935 "notes": [
3936 "hf legic info"
3937 ],
3938 "offline": false,
3939 "options": [
3940 "-h, --help This help",
3941 "-v, --verbose verbose output"
3942 ],
3943 "usage": "hf legic info [-hv]"
3944 },
3945 "hf legic list": {
3946 "command": "hf legic list",
3947 "description": "Alias of `trace list -t legic` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
3948 "notes": [
3949 "hf legic list --frame -> show frame delay times",
3950 "hf legic list -1 -> use trace buffer"
3951 ],
3952 "offline": true,
3953 "options": [
3954 "-h, --help This help",
3955 "-1, --buffer use data from trace buffer",
3956 "--frame show frame delay times",
3957 "-c mark CRC bytes",
3958 "-r show relative times (gap and duration)",
3959 "-u display times in microseconds instead of clock cycles",
3960 "-x show hexdump to convert to pcap(ng)",
3961 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
3962 "-f, --file <fn> filename of dictionary"
3963 ],
3964 "usage": "hf legic list [-h1crux] [--frame] [-f <fn>]"
3965 },
3966 "hf legic rdbl": {
3967 "command": "hf legic rdbl",
3968 "description": "Read data from a LEGIC Prime tag",
3969 "notes": [
3970 "hf legic rdbl -o 0 -l 16 -> read 16 bytes from offset 0 (system header)",
3971 "hf legic rdbl -o 0 -l 4 --iv 55 -> read 4 bytes from offset 0",
3972 "hf legic rdbl -o 0 -l 256 --iv 55 -> read 256 bytes from offset 0"
3973 ],
3974 "offline": false,
3975 "options": [
3976 "-h, --help This help",
3977 "-o, --offset <dec> offset in data array to start download from",
3978 "-l, --length <dec> number of bytes to read",
3979 "--iv <hex> Initialization vector to use. Must be odd and 7bits max"
3980 ],
3981 "usage": "hf legic rdbl [-h] [-o <dec>] [-l <dec>] [--iv <hex>]"
3982 },
3983 "hf legic reader": {
3984 "command": "hf legic reader",
3985 "description": "Read UID and type information from a LEGIC Prime tag",
3986 "notes": [
3987 "hf legic reader"
3988 ],
3989 "offline": false,
3990 "options": [
3991 "-h, --help This help",
3992 "-@ optional - continuous reader mode"
3993 ],
3994 "usage": "hf legic reader [-h@]"
3995 },
3996 "hf legic restore": {
3997 "command": "hf legic restore",
3998 "description": "Reads (bin/eml/json) file and it autodetects card type and verifies that the file has the same size Then write the data back to card. All bytes except the first 7bytes [UID(4) MCC(1) DCF(2)]",
3999 "notes": [
4000 "hf legic restore -f myfile -> use user specified filename",
4001 "hf legic restore -f myfile --ob -> use UID as filename and obfuscate data"
4002 ],
4003 "offline": false,
4004 "options": [
4005 "-h, --help This help",
4006 "-f, --file <fn> Specify a filename to restore",
4007 "--ob obfuscate dump data (xor with MCC)"
4008 ],
4009 "usage": "hf legic restore [-h] -f <fn> [--ob]"
4010 },
4011 "hf legic sim": {
4012 "command": "hf legic sim",
4013 "description": "Simulates a LEGIC Prime tag. Following types supported (MIM22, MIM256, MIM1024)",
4014 "notes": [
4015 "hf legic sim --22"
4016 ],
4017 "offline": false,
4018 "options": [
4019 "-h, --help This help",
4020 "--22 LEGIC Prime MIM22",
4021 "--256 LEGIC Prime MIM256 (def)",
4022 "--1024 LEGIC Prime MIM1024"
4023 ],
4024 "usage": "hf legic sim [-h] [--22] [--256] [--1024]"
4025 },
4026 "hf legic view": {
4027 "command": "hf legic view",
4028 "description": "Print a LEGIC Prime dump file (bin/eml/json)",
4029 "notes": [
4030 "hf legic view -f hf-legic-01020304-dump.bin"
4031 ],
4032 "offline": true,
4033 "options": [
4034 "-h, --help This help",
4035 "-f, --file <fn> Specify a filename for dump file",
4036 "-v, --verbose verbose output"
4037 ],
4038 "usage": "hf legic view [-hv] -f <fn>"
4039 },
4040 "hf legic wipe": {
4041 "command": "hf legic wipe",
4042 "description": "Fills a LEGIC Prime tags memory with zeros. From byte7 and to the end It autodetects card type",
4043 "notes": [
4044 "hf legic wipe"
4045 ],
4046 "offline": false,
4047 "options": [
4048 "-h, --help This help"
4049 ],
4050 "usage": "hf legic wipe [-h]"
4051 },
4052 "hf legic wrbl": {
4053 "command": "hf legic wrbl",
4054 "description": "Write data to a LEGIC Prime tag. It autodetects tagsize to ensure proper write",
4055 "notes": [
4056 "hf legic wrbl -o 0 -d 11223344 -> Write 0x11223344 starting from offset 0)",
4057 "hf legic wrbl -o 10 -d DEADBEEF -> Write 0xdeadbeef starting from offset 10"
4058 ],
4059 "offline": false,
4060 "options": [
4061 "-h, --help This help",
4062 "-o, --offset <dec> offset in data array to start writing",
4063 "-d, --data <hex> data to write",
4064 "--danger Auto-confirm dangerous operations"
4065 ],
4066 "usage": "hf legic wrbl [-h] -o <dec> -d <hex> [--danger]"
4067 },
4068 "hf lto help": {
4069 "command": "hf lto help",
4070 "description": "help This help list List LTO-CM history --------------------------------------------------------------------------------------- hf lto dump available offline: no Dump data from LTO tag",
4071 "notes": [
4072 "hf lto dump -f myfile"
4073 ],
4074 "offline": true,
4075 "options": [
4076 "-h, --help This help",
4077 "-f, --file <fn> specify a filename for dumpfile"
4078 ],
4079 "usage": "hf lto dump [-h] [-f <fn>]"
4080 },
4081 "hf lto info": {
4082 "command": "hf lto info",
4083 "description": "Get info from LTO tags",
4084 "notes": [
4085 "hf lto info"
4086 ],
4087 "offline": false,
4088 "options": [
4089 "-h, --help This help"
4090 ],
4091 "usage": "hf lto info [-h]"
4092 },
4093 "hf lto list": {
4094 "command": "hf lto list",
4095 "description": "Alias of `trace list -t lto -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
4096 "notes": [
4097 "hf lto list --frame -> show frame delay times",
4098 "hf lto list -1 -> use trace buffer"
4099 ],
4100 "offline": true,
4101 "options": [
4102 "-h, --help This help",
4103 "-1, --buffer use data from trace buffer",
4104 "--frame show frame delay times",
4105 "-c mark CRC bytes",
4106 "-r show relative times (gap and duration)",
4107 "-u display times in microseconds instead of clock cycles",
4108 "-x show hexdump to convert to pcap(ng)",
4109 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
4110 "-f, --file <fn> filename of dictionary"
4111 ],
4112 "usage": "hf lto list [-h1crux] [--frame] [-f <fn>]"
4113 },
4114 "hf lto rdbl": {
4115 "command": "hf lto rdbl",
4116 "description": "Reead blocks from LTO tag",
4117 "notes": [
4118 "hf lto rdbl --first 0 --last 254"
4119 ],
4120 "offline": false,
4121 "options": [
4122 "-h, --help This help",
4123 "--first <dec> The first block number to read as an integer",
4124 "--last <dec> The last block number to read as an integer"
4125 ],
4126 "usage": "hf lto rdbl [-h] [--first <dec>] [--last <dec>]"
4127 },
4128 "hf lto reader": {
4129 "command": "hf lto reader",
4130 "description": "Act as a LTO-CM reader. Look for LTO-CM tags until Enter or the pm3 button is pressed",
4131 "notes": [
4132 "hf lto reader -@ -> continuous reader mode"
4133 ],
4134 "offline": false,
4135 "options": [
4136 "-h, --help This help",
4137 "-@ optional - continuous reader mode"
4138 ],
4139 "usage": "hf lto reader [-h@]"
4140 },
4141 "hf lto restore": {
4142 "command": "hf lto restore",
4143 "description": "Restore data from dumpfile to LTO tag",
4144 "notes": [
4145 "hf lto restore -f hf-lto-92C7842CFF.bin|.eml"
4146 ],
4147 "offline": false,
4148 "options": [
4149 "-h, --help This help",
4150 "-f, --file <fn> specify a filename for dumpfile"
4151 ],
4152 "usage": "hf lto restore [-h] -f <fn>"
4153 },
4154 "hf lto wrbl": {
4155 "command": "hf lto wrbl",
4156 "description": "Write data to block on LTO tag",
4157 "notes": [
4158 "hf lto wrbl --blk 128 -d 0001020304050607080910111213141516171819202122232425262728293031"
4159 ],
4160 "offline": false,
4161 "options": [
4162 "-h, --help This help",
4163 "-d, --data <hex> 32 bytes of data to write (64 hex symbols, no spaces)",
4164 "--blk <dec> The block number to write to as an integer"
4165 ],
4166 "usage": "hf lto wrbl [-h] -d <hex> --blk <dec>"
4167 },
4168 "hf mf acl": {
4169 "command": "hf mf acl",
4170 "description": "Print decoded MIFARE access rights (ACL), A = key A B = key B AB = both key A and B ACCESS = access bytes inside sector trailer block Increment, decrement, transfer, restore is for value blocks",
4171 "notes": [
4172 "hf mf acl",
4173 "hf mf acl -d FF0780"
4174 ],
4175 "offline": true,
4176 "options": [
4177 "-h, --help This help",
4178 "-d, --data <hex> ACL bytes specified as 3 hex bytes"
4179 ],
4180 "usage": "hf mf acl [-h] -d <hex>"
4181 },
4182 "hf mf auth4": {
4183 "command": "hf mf auth4",
4184 "description": "Executes AES authentication command in ISO14443-4",
4185 "notes": [
4186 "hf mf auth4 -n 4000 -k 000102030405060708090a0b0c0d0e0f -> executes authentication",
4187 "hf mf auth4 -n 9003 -k FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF -> executes authentication"
4188 ],
4189 "offline": false,
4190 "options": [
4191 "-h, --help This help",
4192 "-n <hex> key num, 2 hex bytes",
4193 "-k, --key <hex> key, 16 hex bytes"
4194 ],
4195 "usage": "hf mf auth4 [-h] -n <hex> -k <hex>"
4196 },
4197 "hf mf autopwn": {
4198 "command": "hf mf autopwn",
4199 "description": "This command automates the key recovery process on MIFARE Classic cards. It uses the fchk, chk, darkside, nested, hardnested and staticnested to recover keys. If all keys are found, it try dumping card content both to file and emulator memory.",
4200 "notes": [
4201 "hf mf autopwn",
4202 "hf mf autopwn -s 0 -a -k FFFFFFFFFFFF -> target MFC 1K card, Sector 0 with known key A 'FFFFFFFFFFFF'",
4203 "hf mf autopwn --1k -f mfc_default_keys -> target MFC 1K card, default dictionary",
4204 "hf mf autopwn --1k -s 0 -a -k FFFFFFFFFFFF -f mfc_default_keys -> combo of the two above samples",
4205 "hf mf autopwn --1k -s 0 -a -k FFFFFFFFFFFF -k a0a1a2a3a4a5 -> multiple user supplied keys"
4206 ],
4207 "offline": false,
4208 "options": [
4209 "-h, --help This help",
4210 "-k, --key <hex> Known key, 12 hex bytes",
4211 "-s, --sector <dec> Input sector number",
4212 "-a Input key A (def)",
4213 "-b Input key B",
4214 "-f, --file <fn> filename of dictionary",
4215 "--slow Slower acquisition (required by some non standard cards)",
4216 "-l, --legacy legacy mode (use the slow `hf mf chk`)",
4217 "-v, --verbose verbose output",
4218 "--mini MIFARE Classic Mini / S20",
4219 "--1k MIFARE Classic 1k / S50 (default)",
4220 "--2k MIFARE Classic/Plus 2k",
4221 "--4k MIFARE Classic 4k / S70",
4222 "--in None (use CPU regular instruction set)",
4223 "--im MMX",
4224 "--is SSE2",
4225 "--ia AVX",
4226 "--i2 AVX2",
4227 "--i5 AVX512"
4228 ],
4229 "usage": "hf mf autopwn [-hablv] [-k <hex>]... [-s <dec>] [-f <fn>] [--slow] [--mini] [--1k] [--2k] [--4k] [--in] [--im] [--is] [--ia] [--i2] [--i5]"
4230 },
4231 "hf mf brute": {
4232 "command": "hf mf brute",
4233 "description": "This is a smart bruteforce, exploiting common patterns, bugs and bad designs in key generators.",
4234 "notes": [
4235 "hf mf brute --mini -> Key recovery against MIFARE Mini",
4236 "hf mf brute --1k -> Key recovery against MIFARE Classic 1k",
4237 "hf mf brute --2k -> Key recovery against MIFARE 2k",
4238 "hf mf brute --4k -> Key recovery against MIFARE 4k",
4239 "hf mf brute --1k --emu -> Target 1K, write keys to emulator memory",
4240 "hf mf brute --1k --dump -> Target 1K, write keys to file"
4241 ],
4242 "offline": false,
4243 "options": [
4244 "-h, --help This help",
4245 "--mini MIFARE Classic Mini / S20",
4246 "--1k MIFARE Classic 1k / S50 (default)",
4247 "--2k MIFARE Classic/Plus 2k",
4248 "--4k MIFARE Classic 4k / S70",
4249 "--emu Fill simulator keys from found keys",
4250 "--dump Dump found keys to binary file"
4251 ],
4252 "usage": "hf mf brute [-h] [--mini] [--1k] [--2k] [--4k] [--emu] [--dump]"
4253 },
4254 "hf mf cgetblk": {
4255 "command": "hf mf cgetblk",
4256 "description": "Get block data from magic Chinese card. Only works with magic gen1a cards",
4257 "notes": [
4258 "hf mf cgetblk --blk 0 -> get block 0 (manufacturer)",
4259 "hf mf cgetblk --blk 3 -v -> get block 3, decode sector trailer"
4260 ],
4261 "offline": false,
4262 "options": [
4263 "-h, --help This help",
4264 "-b, --blk <dec> block number",
4265 "-v, --verbose verbose output"
4266 ],
4267 "usage": "hf mf cgetblk [-hv] -b <dec>"
4268 },
4269 "hf mf cgetsc": {
4270 "command": "hf mf cgetsc",
4271 "description": "Get sector data from magic Chinese card. Only works with magic gen1a cards",
4272 "notes": [
4273 "hf mf cgetsc -s 0"
4274 ],
4275 "offline": false,
4276 "options": [
4277 "-h, --help This help",
4278 "-s, --sec <dec> sector number",
4279 "-v, --verbose verbose output"
4280 ],
4281 "usage": "hf mf cgetsc [-hv] -s <dec>"
4282 },
4283 "hf mf chk": {
4284 "command": "hf mf chk",
4285 "description": "Check keys on MIFARE Classic card",
4286 "notes": [
4287 "hf mf chk --mini -k FFFFFFFFFFFF -> Check all sectors, all keys against MIFARE Mini",
4288 "hf mf chk --1k -k FFFFFFFFFFFF -> Check all sectors, all keys against MIFARE Classic 1k",
4289 "hf mf chk --2k -k FFFFFFFFFFFF -> Check all sectors, all keys against MIFARE 2k",
4290 "hf mf chk --4k -k FFFFFFFFFFFF -> Check all sectors, all keys against MIFARE 4k",
4291 "hf mf chk --1k --emu -> Check all sectors, all keys, 1K, and write to emulator memory",
4292 "hf mf chk --1k --dump -> Check all sectors, all keys, 1K, and write to file",
4293 "hf mf chk -a --tblk 0 -f mfc_default_keys.dic -> Check dictionary against block 0, key A"
4294 ],
4295 "offline": false,
4296 "options": [
4297 "-h, --help This help",
4298 "-k, --key <hex> Key specified as 12 hex symbols",
4299 "--tblk <dec> Target block number",
4300 "-a Target Key A",
4301 "-b Target Key B",
4302 "-*, --all Target both key A & B (default)",
4303 "--mini MIFARE Classic Mini / S20",
4304 "--1k MIFARE Classic 1k / S50 (default)",
4305 "--2k MIFARE Classic/Plus 2k",
4306 "--4k MIFARE Classic 4k / S70",
4307 "--emu Fill simulator keys from found keys",
4308 "--dump Dump found keys to binary file",
4309 "-f, --file <fn> Filename of dictionary"
4310 ],
4311 "usage": "hf mf chk [-hab*] [-k <hex>]... [--tblk <dec>] [--mini] [--1k] [--2k] [--4k] [--emu] [--dump] [-f <fn>]"
4312 },
4313 "hf mf cload": {
4314 "command": "hf mf cload",
4315 "description": "Load magic gen1a card with data from (bin/eml/json) dump file or from emulator memory.",
4316 "notes": [
4317 "hf mf cload --emu",
4318 "hf mf cload -f hf-mf-01020304.eml"
4319 ],
4320 "offline": false,
4321 "options": [
4322 "-h, --help This help",
4323 "-f, --file <fn> Specify a filename for dump file",
4324 "--mini MIFARE Classic Mini / S20",
4325 "--1k MIFARE Classic 1k / S50 (def)",
4326 "--2k MIFARE Classic/Plus 2k",
4327 "--4k MIFARE Classic 4k / S70",
4328 "--emu from emulator memory"
4329 ],
4330 "usage": "hf mf cload [-h] [-f <fn>] [--mini] [--1k] [--2k] [--4k] [--emu]"
4331 },
4332 "hf mf csave": {
4333 "command": "hf mf csave",
4334 "description": "Save magic gen1a card memory to file (bin/json)or into emulator memory",
4335 "notes": [
4336 "hf mf csave",
4337 "hf mf csave --4k"
4338 ],
4339 "offline": false,
4340 "options": [
4341 "-h, --help This help",
4342 "-f, --file <fn> Specify a filename for dump file",
4343 "--mini MIFARE Classic Mini / S20",
4344 "--1k MIFARE Classic 1k / S50 (def)",
4345 "--2k MIFARE Classic/Plus 2k",
4346 "--4k MIFARE Classic 4k / S70",
4347 "--emu to emulator memory"
4348 ],
4349 "usage": "hf mf csave [-h] [-f <fn>] [--mini] [--1k] [--2k] [--4k] [--emu]"
4350 },
4351 "hf mf csetblk": {
4352 "command": "hf mf csetblk",
4353 "description": "Set block data on a magic gen1a card",
4354 "notes": [
4355 "hf mf csetblk --blk 1 -d 000102030405060708090a0b0c0d0e0f"
4356 ],
4357 "offline": false,
4358 "options": [
4359 "-h, --help This help",
4360 "-b, --blk <dec> block number",
4361 "-d, --data <hex> bytes to write, 16 hex bytes",
4362 "-w, --wipe wipes card with backdoor cmd before writing"
4363 ],
4364 "usage": "hf mf csetblk [-hw] -b <dec> [-d <hex>]"
4365 },
4366 "hf mf csetuid": {
4367 "command": "hf mf csetuid",
4368 "description": "Set UID, ATQA, and SAK for magic gen1a card",
4369 "notes": [
4370 "hf mf csetuid -u 01020304",
4371 "hf mf csetuid -w -u 01020304 --atqa 0004 --sak 08"
4372 ],
4373 "offline": false,
4374 "options": [
4375 "-h, --help This help",
4376 "-w, --wipe wipes card with backdoor cmd`",
4377 "-u, --uid <hex> UID, 4/7 hex bytes",
4378 "-a, --atqa <hex> ATQA, 2 hex bytes",
4379 "-s, --sak <hex> SAK, 1 hex byte"
4380 ],
4381 "usage": "hf mf csetuid [-hw] [-u <hex>] [-a <hex>] [-s <hex>]"
4382 },
4383 "hf mf cview": {
4384 "command": "hf mf cview",
4385 "description": "View `magic gen1a` card memory",
4386 "notes": [
4387 "hf mf cview",
4388 "hf mf cview --4k"
4389 ],
4390 "offline": false,
4391 "options": [
4392 "-h, --help This help",
4393 "--mini MIFARE Classic Mini / S20",
4394 "--1k MIFARE Classic 1k / S50 (def)",
4395 "--2k MIFARE Classic/Plus 2k",
4396 "--4k MIFARE Classic 4k / S70",
4397 "-v, --verbose verbose output"
4398 ],
4399 "usage": "hf mf cview [-hv] [--mini] [--1k] [--2k] [--4k]"
4400 },
4401 "hf mf cwipe": {
4402 "command": "hf mf cwipe",
4403 "description": "Wipe gen1 magic chinese card. Set UID / ATQA / SAK / Data / Keys / Access to default values",
4404 "notes": [
4405 "hf mf cwipe",
4406 "hf mf cwipe -u 09080706 -a 0004 -s 18 -> set UID, ATQA and SAK and wipe card"
4407 ],
4408 "offline": false,
4409 "options": [
4410 "-h, --help This help",
4411 "-u, --uid <hex> UID, 4 hex bytes",
4412 "-a, --atqa <hex> ATQA, 2 hex bytes",
4413 "-s, --sak <hex> SAK, 1 hex byte"
4414 ],
4415 "usage": "hf mf cwipe [-h] [-u <hex>] [-a <hex>] [-s <hex>]"
4416 },
4417 "hf mf darkside": {
4418 "command": "hf mf darkside",
4419 "description": "Darkside attack",
4420 "notes": [
4421 "hf mf darkside",
4422 "hf mf darkside --blk 16",
4423 "hf mf darkside --blk 16 -b"
4424 ],
4425 "offline": false,
4426 "options": [
4427 "-h, --help This help",
4428 "--blk <dec> Target block",
4429 "-b Target key B instead of default key A"
4430 ],
4431 "usage": "hf mf darkside [-hb] [--blk <dec> ]"
4432 },
4433 "hf mf decrypt": {
4434 "command": "hf mf decrypt",
4435 "description": "Decrypt Crypto-1 encrypted bytes given some known state of crypto. See tracelog to gather needed values",
4436 "notes": [
4437 "hf mf decrypt --nt b830049b --ar 9248314a --at 9280e203 -d 41e586f9",
4438 "-> 41e586f9 becomes 3003999a",
4439 "-> which annotates 30 03 [99 9a] read block 3 [crc]"
4440 ],
4441 "offline": true,
4442 "options": [
4443 "-h, --help This help",
4444 "--nt <hex> tag nonce",
4445 "--ar <hex> ar_enc, encrypted reader response",
4446 "--at <hex> at_enc, encrypted tag response",
4447 "-d, --data <hex> encrypted data, taken directly after at_enc and forward"
4448 ],
4449 "usage": "hf mf decrypt [-h] --nt <hex> --ar <hex> --at <hex> -d <hex>"
4450 },
4451 "hf mf dump": {
4452 "command": "hf mf dump",
4453 "description": "Dump MIFARE Classic tag to file (bin/json) If no <name> given, UID will be used as filename",
4454 "notes": [
4455 "hf mf dump --mini -> MIFARE Mini",
4456 "hf mf dump --1k -> MIFARE Classic 1k",
4457 "hf mf dump --2k -> MIFARE 2k",
4458 "hf mf dump --4k -> MIFARE 4k",
4459 "hf mf dump --keys hf-mf-066C8B78-key.bin -> MIFARE 1k with keys from specified file"
4460 ],
4461 "offline": false,
4462 "options": [
4463 "-h, --help This help",
4464 "-f, --file <fn> Specify a filename for dump file",
4465 "-k, --keys <fn> filename of keys",
4466 "--mini MIFARE Classic Mini / S20",
4467 "--1k MIFARE Classic 1k / S50 (def)",
4468 "--2k MIFARE Classic/Plus 2k",
4469 "--4k MIFARE Classic 4k / S70",
4470 "--ns no save to file",
4471 "-v, --verbose verbose output"
4472 ],
4473 "usage": "hf mf dump [-hv] [-f <fn>] [-k <fn>] [--mini] [--1k] [--2k] [--4k] [--ns]"
4474 },
4475 "hf mf ecfill": {
4476 "command": "hf mf ecfill",
4477 "description": "Dump card and transfer the data to emulator memory. Keys must be in the emulator memory",
4478 "notes": [
4479 "hf mf ecfill -> use key type A",
4480 "hf mf ecfill --4k -b -> target 4K card with key type B"
4481 ],
4482 "offline": false,
4483 "options": [
4484 "-h, --help This help",
4485 "-a input key type is key A(def)",
4486 "-b input key type is key B",
4487 "--mini MIFARE Classic Mini / S20",
4488 "--1k MIFARE Classic 1k / S50 (def)",
4489 "--2k MIFARE Classic/Plus 2k",
4490 "--4k MIFARE Classic 4k / S70"
4491 ],
4492 "usage": "hf mf ecfill [-hab] [--mini] [--1k] [--2k] [--4k]"
4493 },
4494 "hf mf eclr": {
4495 "command": "hf mf eclr",
4496 "description": "It set card emulator memory to empty data blocks and key A/B FFFFFFFFFFFF",
4497 "notes": [
4498 "hf mf eclr"
4499 ],
4500 "offline": false,
4501 "options": [
4502 "-h, --help This help"
4503 ],
4504 "usage": "hf mf eclr [-h]"
4505 },
4506 "hf mf egetblk": {
4507 "command": "hf mf egetblk",
4508 "description": "Get emulator memory block",
4509 "notes": [
4510 "hf mf egetblk --blk 0 -> get block 0 (manufacturer)",
4511 "hf mf egetblk --blk 3 -v -> get block 3, decode sector trailer"
4512 ],
4513 "offline": false,
4514 "options": [
4515 "-h, --help This help",
4516 "-b, --blk <dec> block number",
4517 "-v, --verbose verbose output"
4518 ],
4519 "usage": "hf mf egetblk [-hv] -b <dec>"
4520 },
4521 "hf mf egetsc": {
4522 "command": "hf mf egetsc",
4523 "description": "Get emulator memory sector",
4524 "notes": [
4525 "hf mf egetsc -s 0"
4526 ],
4527 "offline": false,
4528 "options": [
4529 "-h, --help This help",
4530 "-s, --sec <dec> sector number",
4531 "-v, --verbose verbose output"
4532 ],
4533 "usage": "hf mf egetsc [-hv] -s <dec>"
4534 },
4535 "hf mf ekeyprn": {
4536 "command": "hf mf ekeyprn",
4537 "description": "Download and print the keys from emulator memory",
4538 "notes": [
4539 "hf mf ekeyprn --1k -> print MFC 1K keyset",
4540 "hf mf ekeyprn -w -> write keys to binary file"
4541 ],
4542 "offline": false,
4543 "options": [
4544 "-h, --help This help",
4545 "-w, --write write keys to binary file `hf-mf-<UID>-key.bin`",
4546 "--mini MIFARE Classic Mini / S20",
4547 "--1k MIFARE Classic 1k / S50 (def)",
4548 "--2k MIFARE Classic/Plus 2k",
4549 "--4k MIFARE Classic 4k / S70"
4550 ],
4551 "usage": "hf mf ekeyprn [-hw] [--mini] [--1k] [--2k] [--4k]"
4552 },
4553 "hf mf eload": {
4554 "command": "hf mf eload",
4555 "description": "Load emulator memory with data from (bin/eml/json) dump file",
4556 "notes": [
4557 "hf mf eload -f hf-mf-01020304.bin",
4558 "hf mf eload --4k -f hf-mf-01020304.eml"
4559 ],
4560 "offline": false,
4561 "options": [
4562 "-h, --help This help",
4563 "-f, --file <fn> Specify a filename for dump file",
4564 "--mini MIFARE Classic Mini / S20",
4565 "--1k MIFARE Classic 1k / S50 (def)",
4566 "--2k MIFARE Classic/Plus 2k",
4567 "--4k MIFARE Classic 4k / S70",
4568 "--ul MIFARE Ultralight family",
4569 "-m, --mem use RDV4 spiffs",
4570 "-q, --qty <dec> manually set number of blocks (overrides)",
4571 "-v, --verbose verbose output"
4572 ],
4573 "usage": "hf mf eload [-hmv] -f <fn> [--mini] [--1k] [--2k] [--4k] [--ul] [-q <dec>]"
4574 },
4575 "hf mf encodehid": {
4576 "command": "hf mf encodehid",
4577 "description": "Encode binary wiegand to card Use either --bin or --wiegand/--fc/--cn",
4578 "notes": [
4579 "hf mf encodehid --bin 10001111100000001010100011 -> FC 31 CN 337 (H10301)",
4580 "hf mf encodehid -w H10301 --fc 31 --cn 337"
4581 ],
4582 "offline": false,
4583 "options": [
4584 "-h, --help This help",
4585 "--bin <bin> Binary string i.e 0001001001",
4586 "--fc <dec> facility code",
4587 "--cn <dec> card number",
4588 "-w, --wiegand <format> see `wiegand list` for available formats",
4589 "-v, --verbose verbose output"
4590 ],
4591 "usage": "hf mf encodehid [-hv] [--bin <bin>] [--fc <dec>] [--cn <dec>] [-w <format>]"
4592 },
4593 "hf mf esave": {
4594 "command": "hf mf esave",
4595 "description": "Save emulator memory to file (bin/json)",
4596 "notes": [
4597 "hf mf esave",
4598 "hf mf esave --4k",
4599 "hf mf esave --4k -f hf-mf-01020304.eml"
4600 ],
4601 "offline": false,
4602 "options": [
4603 "-h, --help This help",
4604 "-f, --file <fn> Specify a filename for dump file",
4605 "--mini MIFARE Classic Mini / S20",
4606 "--1k MIFARE Classic 1k / S50 (def)",
4607 "--2k MIFARE Classic/Plus 2k",
4608 "--4k MIFARE Classic 4k / S70"
4609 ],
4610 "usage": "hf mf esave [-h] [-f <fn>] [--mini] [--1k] [--2k] [--4k]"
4611 },
4612 "hf mf esetblk": {
4613 "command": "hf mf esetblk",
4614 "description": "Set emulator memory block",
4615 "notes": [
4616 "hf mf esetblk --blk 1 -d 000102030405060708090a0b0c0d0e0f"
4617 ],
4618 "offline": false,
4619 "options": [
4620 "-h, --help This help",
4621 "-b, --blk <dec> block number",
4622 "-d, --data <hex> bytes to write, 16 hex bytes"
4623 ],
4624 "usage": "hf mf esetblk [-h] -b <dec> [-d <hex>]"
4625 },
4626 "hf mf eview": {
4627 "command": "hf mf eview",
4628 "description": "It displays emulator memory",
4629 "notes": [
4630 "hf mf eview",
4631 "hf mf eview --4k"
4632 ],
4633 "offline": false,
4634 "options": [
4635 "-h, --help This help",
4636 "--mini MIFARE Classic Mini / S20",
4637 "--1k MIFARE Classic 1k / S50 (def)",
4638 "--2k MIFARE Classic/Plus 2k",
4639 "--4k MIFARE Classic 4k / S70",
4640 "-v, --verbose verbose output",
4641 "--sk Save extracted keys to binary file"
4642 ],
4643 "usage": "hf mf eview [-hv] [--mini] [--1k] [--2k] [--4k] [--sk]"
4644 },
4645 "hf mf fchk": {
4646 "command": "hf mf fchk",
4647 "description": "This is a improved checkkeys method speedwise. It checks MIFARE Classic tags sector keys against a dictionary file with keys",
4648 "notes": [
4649 "hf mf fchk --mini -k FFFFFFFFFFFF -> Key recovery against MIFARE Mini",
4650 "hf mf fchk --1k -k FFFFFFFFFFFF -> Key recovery against MIFARE Classic 1k",
4651 "hf mf fchk --2k -k FFFFFFFFFFFF -> Key recovery against MIFARE 2k",
4652 "hf mf fchk --4k -k FFFFFFFFFFFF -> Key recovery against MIFARE 4k",
4653 "hf mf fchk --1k -f mfc_default_keys.dic -> Target 1K using default dictionary file",
4654 "hf mf fchk --1k --emu -> Target 1K, write keys to emulator memory",
4655 "hf mf fchk --1k --dump -> Target 1K, write keys to file",
4656 "hf mf fchk --1k --mem -> Target 1K, use dictionary from flash memory"
4657 ],
4658 "offline": false,
4659 "options": [
4660 "-h, --help This help",
4661 "-k, --key <hex> Key specified as 12 hex symbols",
4662 "--mini MIFARE Classic Mini / S20",
4663 "--1k MIFARE Classic 1k / S50 (default)",
4664 "--2k MIFARE Classic/Plus 2k",
4665 "--4k MIFARE Classic 4k / S70",
4666 "--emu Fill simulator keys from found keys",
4667 "--dump Dump found keys to binary file",
4668 "--mem Use dictionary from flashmemory",
4669 "-f, --file <fn> filename of dictionary"
4670 ],
4671 "usage": "hf mf fchk [-h] [-k <hex>]... [--mini] [--1k] [--2k] [--4k] [--emu] [--dump] [--mem] [-f <fn>]"
4672 },
4673 "hf mf gchpwd": {
4674 "command": "hf mf gchpwd",
4675 "description": "Change access password for Gen4 GTU card. WARNING! If you dont KNOW the password - you CAN'T access it!!!",
4676 "notes": [
4677 "hf mf gchpwd --pwd 00000000 --newpwd 01020304"
4678 ],
4679 "offline": false,
4680 "options": [
4681 "-h, --help This help",
4682 "-p, --pwd <hex> password 4 bytes",
4683 "-n, --newpwd <hex> new password 4 bytes",
4684 "-v, --verbose verbose output"
4685 ],
4686 "usage": "hf mf gchpwd [-hv] [-p <hex>] [-n <hex>]"
4687 },
4688 "hf mf gdmcfg": {
4689 "command": "hf mf gdmcfg",
4690 "description": "Get configuration data from magic gen4 GDM card.",
4691 "notes": [
4692 "hf mf gdmcfg"
4693 ],
4694 "offline": false,
4695 "options": [
4696 "-h, --help This help",
4697 "-k, --key <hex> key 6 bytes (only for regular wakeup)",
4698 "--gen1a use gen1a (40/43) magic wakeup",
4699 "--gdm use gdm alt (20/23) magic wakeup"
4700 ],
4701 "usage": "hf mf gdmcfg [-h] [-k <hex>] [--gen1a] [--gdm]"
4702 },
4703 "hf mf gdmparsecfg": {
4704 "command": "hf mf gdmparsecfg",
4705 "description": "Parse configuration data on a magic gen4 GDM card",
4706 "notes": [
4707 "hf mf gdmparsecfg -d 850000000000000000005A5A00000008"
4708 ],
4709 "offline": true,
4710 "options": [
4711 "-h, --help This help",
4712 "-d, --data <hex> bytes to write, 16 hex bytes"
4713 ],
4714 "usage": "hf mf gdmparsecfg [-h] -d <hex>"
4715 },
4716 "hf mf gdmsetblk": {
4717 "command": "hf mf gdmsetblk",
4718 "description": "Set block data on a magic gen4 GDM card `--force` param is used to override warnings like bad ACL writes. if not specified, it will exit if detected",
4719 "notes": [
4720 "hf mf gdmsetblk --blk 1 -d 000102030405060708090a0b0c0d0e0f"
4721 ],
4722 "offline": false,
4723 "options": [
4724 "-h, --help This help",
4725 "--blk <dec> block number",
4726 "-d, --data <hex> bytes to write, 16 hex bytes",
4727 "-k, --key <hex> key, 6 hex bytes",
4728 "--force override warnings"
4729 ],
4730 "usage": "hf mf gdmsetblk [-h] --blk <dec> [-d <hex>] [-k <hex>] [--force]"
4731 },
4732 "hf mf gdmsetcfg": {
4733 "command": "hf mf gdmsetcfg",
4734 "description": "Set configuration data on a magic gen4 GDM card",
4735 "notes": [
4736 "hf mf gdmsetcfg -d 850000000000000000005A5A00000008"
4737 ],
4738 "offline": false,
4739 "options": [
4740 "-h, --help This help",
4741 "-d, --data <hex> bytes to write, 16 hex bytes",
4742 "-k, --key <hex> key 6 bytes (only for regular wakeup)",
4743 "--gen1a use gen1a (40/43) magic wakeup",
4744 "--gdm use gdm alt (20/23) magic wakeup"
4745 ],
4746 "usage": "hf mf gdmsetcfg [-h] -d <hex> [-k <hex>] [--gen1a] [--gdm]"
4747 },
4748 "hf mf gen3blk": {
4749 "command": "hf mf gen3blk",
4750 "description": "Overwrite full manufacturer block for magic Gen3 card - You can specify part of manufacturer block as 4/7-bytes for UID change only NOTE: BCC, SAK, ATQA will be calculated automatically",
4751 "notes": [
4752 "hf mf gen3blk -> print current data",
4753 "hf mf gen3blk -d 01020304 -> set 4 byte uid",
4754 "hf mf gen3blk -d 01020304050607 -> set 7 byte uid",
4755 "hf mf gen3blk -d 01020304FFFFFFFF0102030405060708"
4756 ],
4757 "offline": false,
4758 "options": [
4759 "-h, --help This help",
4760 "-d, --data <hex> manufacturer block data up to 16 hex bytes"
4761 ],
4762 "usage": "hf mf gen3blk [-h] [-d <hex>]"
4763 },
4764 "hf mf gen3freeze": {
4765 "command": "hf mf gen3freeze",
4766 "description": "Perma lock further UID changes. No more UID changes available after operation completed Note: operation is ! irreversible !",
4767 "notes": [
4768 "hf mf gen3freeze -y"
4769 ],
4770 "offline": false,
4771 "options": [
4772 "-h, --help This help",
4773 "-y, --yes confirm UID lock operation"
4774 ],
4775 "usage": "hf mf gen3freeze -y[h]"
4776 },
4777 "hf mf gen3uid": {
4778 "command": "hf mf gen3uid",
4779 "description": "Set UID for magic Gen3 card _without_ changes to manufacturer block 0",
4780 "notes": [
4781 "hf mf gen3uid --uid 01020304 -> set 4 byte uid",
4782 "hf mf gen3uid --uid 01020304050607 -> set 7 byte uid"
4783 ],
4784 "offline": false,
4785 "options": [
4786 "-h, --help This help",
4787 "-u, --uid <hex> UID 4/7 hex bytes"
4788 ],
4789 "usage": "hf mf gen3uid [-h] [-u <hex>]"
4790 },
4791 "hf mf ggetblk": {
4792 "command": "hf mf ggetblk",
4793 "description": "Get block data from magic gen4 GTU card.",
4794 "notes": [
4795 "hf mf ggetblk --blk 0 -> get block 0 (manufacturer)",
4796 "hf mf ggetblk --blk 3 -v -> get block 3, decode sector trailer"
4797 ],
4798 "offline": false,
4799 "options": [
4800 "-h, --help This help",
4801 "-b, --blk <dec> block number",
4802 "-v, --verbose verbose output",
4803 "-p, --pwd <hex> password 4bytes"
4804 ],
4805 "usage": "hf mf ggetblk [-hv] -b <dec> [-p <hex>]"
4806 },
4807 "hf mf ginfo": {
4808 "command": "hf mf ginfo",
4809 "description": "Read info about magic gen4 GTU card.",
4810 "notes": [
4811 "hf mf ginfo -> get info with default password 00000000",
4812 "hf mf ginfo --pwd 01020304 -> get info with password",
4813 "hf mf ginfo -d 00000000000002090978009102BDAC19131011121314151604001800FF0002FD -v -> decode config block"
4814 ],
4815 "offline": false,
4816 "options": [
4817 "-h, --help This help",
4818 "-v, --verbose verbose output",
4819 "-p, --pwd <hex> password 4 bytes",
4820 "-d, --data <hex> config bytes 32 bytes"
4821 ],
4822 "usage": "hf mf ginfo [-hv] [-p <hex>] [-d <hex>]"
4823 },
4824 "hf mf gload": {
4825 "command": "hf mf gload",
4826 "description": "Load magic gen4 gtu card with data from (bin/eml/json) dump file or from emulator memory.",
4827 "notes": [
4828 "hf mf gload --emu",
4829 "hf mf gload -f hf-mf-01020304.eml",
4830 "hf mf gload -p AABBCCDD --4k -v -f hf-mf-01020304-dump.bin",
4831 "",
4832 "Card must be configured beforehand with `script run hf_mf_ultimatecard`.",
4833 "Blocks are 16 bytes long."
4834 ],
4835 "offline": false,
4836 "options": [
4837 "-h, --help This help",
4838 "--mini MIFARE Classic Mini / S20",
4839 "--1k MIFARE Classic 1k / S50 (def)",
4840 "--2k MIFARE Classic/Plus 2k",
4841 "--4k MIFARE Classic 4k / S70",
4842 "-p, --pwd <hex> password 4bytes",
4843 "-v, --verbose verbose output",
4844 "-f, --file <fn> Specify a filename for dump file",
4845 "--emu from emulator memory",
4846 "--start <dec> index of block to start writing (default 0)",
4847 "--end <dec> index of block to end writing (default last block)"
4848 ],
4849 "usage": "hf mf gload [-hv] [--mini] [--1k] [--2k] [--4k] [-p <hex>] [-f <fn>] [--emu] [--start <dec>] [--end <dec>]"
4850 },
4851 "hf mf gsave": {
4852 "command": "hf mf gsave",
4853 "description": "Save `magic gen4 gtu` card memory to file (bin/json)or into emulator memory",
4854 "notes": [
4855 "hf mf gsave",
4856 "hf mf gsave --4k",
4857 "hf mf gsave -p DEADBEEF -f hf-mf-01020304.json"
4858 ],
4859 "offline": false,
4860 "options": [
4861 "-h, --help This help",
4862 "--mini MIFARE Classic Mini / S20",
4863 "--1k MIFARE Classic 1k / S50 (def)",
4864 "--2k MIFARE Classic/Plus 2k",
4865 "--4k MIFARE Classic 4k / S70",
4866 "-p, --pwd <hex> password 4 bytes",
4867 "-f, --file <fn> Specify a filename for dump file",
4868 "--emu to emulator memory"
4869 ],
4870 "usage": "hf mf gsave [-h] [--mini] [--1k] [--2k] [--4k] [-p <hex>] [-f <fn>] [--emu]"
4871 },
4872 "hf mf gsetblk": {
4873 "command": "hf mf gsetblk",
4874 "description": "Set block data on a magic gen4 GTU card",
4875 "notes": [
4876 "hf mf gsetblk --blk 1 -d 000102030405060708090a0b0c0d0e0f"
4877 ],
4878 "offline": false,
4879 "options": [
4880 "-h, --help This help",
4881 "-b, --blk <dec> block number",
4882 "-d, --data <hex> bytes to write, 16 hex bytes",
4883 "-p, --pwd <hex> password 4bytes"
4884 ],
4885 "usage": "hf mf gsetblk [-h] -b <dec> [-d <hex>] [-p <hex>]"
4886 },
4887 "hf mf gview": {
4888 "command": "hf mf gview",
4889 "description": "View `magic gen4 gtu` card memory",
4890 "notes": [
4891 "hf mf gview",
4892 "hf mf gview --4k"
4893 ],
4894 "offline": false,
4895 "options": [
4896 "-h, --help This help",
4897 "--mini MIFARE Classic Mini / S20",
4898 "--1k MIFARE Classic 1k / S50 (def)",
4899 "--2k MIFARE Classic/Plus 2k",
4900 "--4k MIFARE Classic 4k / S70",
4901 "-p, --pwd <hex> password 4bytes",
4902 "-v, --verbose verbose output"
4903 ],
4904 "usage": "hf mf gview [-hv] [--mini] [--1k] [--2k] [--4k] [-p <hex>]"
4905 },
4906 "hf mf hardnested": {
4907 "command": "hf mf hardnested",
4908 "description": "Nested attack for hardened MIFARE Classic cards. if card is EV1, command can detect and use known key see example below `--i<X>` set type of SIMD instructions. Without this flag programs autodetect it. or hf mf hardnested -r --tk [known target key] Add the known target key to check if it is present in the remaining key space hf mf hardnested --blk 0 -a -k A0A1A2A3A4A5 --tblk 4 --ta --tk FFFFFFFFFFFF",
4909 "notes": [
4910 "hf mf hardnested --tblk 4 --ta -> works for MFC EV1",
4911 "hf mf hardnested --blk 0 -a -k FFFFFFFFFFFF --tblk 4 --ta",
4912 "hf mf hardnested --blk 0 -a -k FFFFFFFFFFFF --tblk 4 --ta -w",
4913 "hf mf hardnested --blk 0 -a -k FFFFFFFFFFFF --tblk 4 --ta -f nonces.bin -w -s",
4914 "hf mf hardnested -r",
4915 "hf mf hardnested -r --tk a0a1a2a3a4a5",
4916 "hf mf hardnested -t --tk a0a1a2a3a4a5",
4917 "hf mf hardnested --blk 0 -a -k a0a1a2a3a4a5 --tblk 4 --ta --tk FFFFFFFFFFFF"
4918 ],
4919 "offline": true,
4920 "options": [
4921 "-h, --help This help",
4922 "-k, --key <hex> Key, 12 hex bytes",
4923 "--blk <dec> Input block number",
4924 "-a Input key A (def)",
4925 "-b Input key B",
4926 "--tblk <dec> Target block number",
4927 "--ta Target key A",
4928 "--tb Target key B",
4929 "--tk <hex> Target key, 12 hex bytes",
4930 "-u, --uid <hex> R/W `hf-mf-<UID>-nonces.bin` instead of default name",
4931 "-f, --file <fn> R/W <name> instead of default name",
4932 "-r, --read Read `hf-mf-<UID>-nonces.bin` if tag present, otherwise `nonces.bin`, and start attack",
4933 "-s, --slow Slower acquisition (required by some non standard cards)",
4934 "-t, --tests Run tests",
4935 "-w, --wr Acquire nonces and UID, and write them to file `hf-mf-<UID>-nonces.bin`",
4936 "--in None (use CPU regular instruction set)",
4937 "--im MMX",
4938 "--is SSE2",
4939 "--ia AVX",
4940 "--i2 AVX2",
4941 "--i5 AVX512"
4942 ],
4943 "usage": "hf mf hardnested [-habrstw] [-k <hex>] [--blk <dec>] [--tblk <dec>] [--ta] [--tb] [--tk <hex>] [-u <hex>] [-f <fn>] [--in] [--im] [--is] [--ia] [--i2] [--i5]"
4944 },
4945 "hf mf help": {
4946 "command": "hf mf help",
4947 "description": "help This help list List MIFARE history hardnested Nested attack for hardened MIFARE Classic cards decrypt Decrypt Crypto1 data from sniff or trace acl Decode and print MIFARE Classic access rights bytes mad Checks and prints MAD value Value blocks view Display content from tag dump file gdmparsecfg Parse config block to card --------------------------------------------------------------------------------------- hf mf list available offline: yes Alias of `trace list -t mf -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
4948 "notes": [
4949 "hf mf list --frame -> show frame delay times",
4950 "hf mf list -1 -> use trace buffer"
4951 ],
4952 "offline": true,
4953 "options": [
4954 "-h, --help This help",
4955 "-1, --buffer use data from trace buffer",
4956 "--frame show frame delay times",
4957 "-c mark CRC bytes",
4958 "-r show relative times (gap and duration)",
4959 "-u display times in microseconds instead of clock cycles",
4960 "-x show hexdump to convert to pcap(ng)",
4961 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
4962 "-f, --file <fn> filename of dictionary"
4963 ],
4964 "usage": "hf mf list [-h1crux] [--frame] [-f <fn>]"
4965 },
4966 "hf mf info": {
4967 "command": "hf mf info",
4968 "description": "Information and check vulnerabilities in a MIFARE Classic card Some cards in order to extract information you need to specify key and/or specific keys in the command line",
4969 "notes": [
4970 "hf mf info",
4971 "hf mf info -k FFFFFFFFFFFF -n -v"
4972 ],
4973 "offline": false,
4974 "options": [
4975 "-h, --help This help",
4976 "--blk <dec> block number",
4977 "-a input key type is key A (def)",
4978 "-b input key type is key B",
4979 "-k, --key <hex> key, 6 hex bytes",
4980 "-n, --nack do nack test",
4981 "-v, --verbose verbose output"
4982 ],
4983 "usage": "hf mf info [-habnv] [--blk <dec>] [-k <hex>]"
4984 },
4985 "hf mf mad": {
4986 "command": "hf mf mad",
4987 "description": "Checks and prints MIFARE Application Directory (MAD)",
4988 "notes": [
4989 "hf mf mad -> shows MAD if exists",
4990 "hf mf mad --aid e103 -k ffffffffffff -b -> shows NDEF data if exists. read card with custom key and key B",
4991 "hf mf mad --dch -k ffffffffffff -> decode CardHolder information"
4992 ],
4993 "offline": true,
4994 "options": [
4995 "-h, --help This help",
4996 "-v, --verbose verbose output",
4997 "--aid <hex> print all sectors with specified aid",
4998 "-k, --key <hex> key for printing sectors",
4999 "-b, --keyb use key B for access printing sectors (by default: key A)",
5000 "--be (optional, BigEndian)",
5001 "--dch decode Card Holder information",
5002 "-f, --file <fn> load dump file and decode MAD"
5003 ],
5004 "usage": "hf mf mad [-hvb] [--aid <hex>] [-k <hex>] [--be] [--dch] [-f <fn>]"
5005 },
5006 "hf mf nack": {
5007 "command": "hf mf nack",
5008 "description": "Test a MIFARE Classic based card for the NACK bug",
5009 "notes": [
5010 "hf mf nack"
5011 ],
5012 "offline": false,
5013 "options": [
5014 "-h, --help This help",
5015 "-v, --verbose verbose output`"
5016 ],
5017 "usage": "hf mf nack [-hv]"
5018 },
5019 "hf mf ndefformat": {
5020 "command": "hf mf ndefformat",
5021 "description": "format MIFARE Classic Tag as a NFC tag with Data Exchange Format (NDEF) If no <name> given, UID will be used as filename. It will try default keys and MAD keys to detect if tag is already formatted in order to write. If not, it will try finding a key file based on your UID. ie, if you ran autopwn before",
5022 "notes": [
5023 "hf mf ndefformat",
5024 "hf mf ndefformat --1k -> MIFARE Classic 1k",
5025 "hf mf ndefformat --keys hf-mf-01020304-key.bin -> MIFARE 1k with keys from specified file"
5026 ],
5027 "offline": false,
5028 "options": [
5029 "-h, --help This help",
5030 "-k, --keys <fn> filename of keys",
5031 "--mini MIFARE Classic Mini / S20",
5032 "--1k MIFARE Classic 1k / S50 (def)",
5033 "--2k MIFARE Classic/Plus 2k",
5034 "--4k MIFARE Classic 4k / S70"
5035 ],
5036 "usage": "hf mf ndefformat [-h] [-k <fn>] [--mini] [--1k] [--2k] [--4k]"
5037 },
5038 "hf mf ndefread": {
5039 "command": "hf mf ndefread",
5040 "description": "Prints NFC Data Exchange Format (NDEF)",
5041 "notes": [
5042 "hf mf ndefread -> shows NDEF parsed data",
5043 "hf mf ndefread -vv -> shows NDEF parsed and raw data",
5044 "hf mf ndefread --aid e103 -k ffffffffffff -b -> shows NDEF data with custom AID, key and with key B",
5045 "hf mf ndefread -f myfilename -> save raw NDEF to file"
5046 ],
5047 "offline": false,
5048 "options": [
5049 "-h, --help This help",
5050 "-v, --verbose Verbose output",
5051 "--aid <aid> replace default aid for NDEF",
5052 "-k, --key <key> replace default key for NDEF",
5053 "-b, --keyb use key B for access sectors (by default: key A)",
5054 "-f, --file <fn> save raw NDEF to file"
5055 ],
5056 "usage": "hf mf ndefread [-hvb] [--aid <aid>] [-k <key>] [-f <fn>]"
5057 },
5058 "hf mf ndefwrite": {
5059 "command": "hf mf ndefwrite",
5060 "description": "Write raw NDEF hex bytes to tag. This commands assumes tag already been NFC/NDEF formatted.",
5061 "notes": [
5062 "hf mf ndefwrite -d 0300FE -> write empty record to tag",
5063 "hf mf ndefwrite -f myfilename",
5064 "hf mf ndefwrite -d 033fd1023a53709101195405656e2d55534963656d616e2054776974746572206c696e6b5101195502747769747465722e636f6d2f686572726d616e6e31303031"
5065 ],
5066 "offline": false,
5067 "options": [
5068 "-h, --help This help",
5069 "-d <hex> raw NDEF hex bytes",
5070 "-f, --file <fn> write raw NDEF file to tag",
5071 "-p fix NDEF record headers / terminator block if missing",
5072 "--mini MIFARE Classic Mini / S20",
5073 "--1k MIFARE Classic 1k / S50 (def)",
5074 "--2k MIFARE Classic/Plus 2k",
5075 "--4k MIFARE Classic 4k / S70",
5076 "-v, --verbose verbose output"
5077 ],
5078 "usage": "hf mf ndefwrite [-hpv] [-d <hex>] [-f <fn>] [--mini] [--1k] [--2k] [--4k]"
5079 },
5080 "hf mf nested": {
5081 "command": "hf mf nested",
5082 "description": "Execute Nested attack against MIFARE Classic card for key recovery",
5083 "notes": [
5084 "hf mf nested --blk 0 -a -k FFFFFFFFFFFF --tblk 4 --ta -> Use block 0 Key A to find block 4 Key A (single sector key recovery)",
5085 "hf mf nested --mini --blk 0 -a -k FFFFFFFFFFFF -> Key recovery against MIFARE Mini",
5086 "hf mf nested --1k --blk 0 -a -k FFFFFFFFFFFF -> Key recovery against MIFARE Classic 1k",
5087 "hf mf nested --2k --blk 0 -a -k FFFFFFFFFFFF -> Key recovery against MIFARE 2k",
5088 "hf mf nested --4k --blk 0 -a -k FFFFFFFFFFFF -> Key recovery against MIFARE 4k"
5089 ],
5090 "offline": false,
5091 "options": [
5092 "-h, --help This help",
5093 "-k, --key <hex> Key specified as 12 hex symbols",
5094 "--mini MIFARE Classic Mini / S20",
5095 "--1k MIFARE Classic 1k / S50",
5096 "--2k MIFARE Classic/Plus 2k",
5097 "--4k MIFARE Classic 4k / S70",
5098 "--blk <dec> Input block number",
5099 "-a Input key specified is A key (default)",
5100 "-b Input key specified is B key",
5101 "--tblk <dec> Target block number",
5102 "--ta Target A key (default)",
5103 "--tb Target B key",
5104 "--emu Fill simulator keys from found keys",
5105 "--dump Dump found keys to file",
5106 "--mem Use dictionary from flashmemory"
5107 ],
5108 "usage": "hf mf nested [-hab] [-k <hex>] [--mini] [--1k] [--2k] [--4k] [--blk <dec>] [--tblk <dec>] [--ta] [--tb] [--emu] [--dump] [--mem]"
5109 },
5110 "hf mf personalize": {
5111 "command": "hf mf personalize",
5112 "description": "Personalize the UID of a MIFARE Classic EV1 card. This is only possible if it is a 7Byte UID card and if it is not already personalized.",
5113 "notes": [
5114 "hf mf personalize --f0 -> double size UID",
5115 "hf mf personalize --f1 -> double size UID, optional usage of selection process shortcut",
5116 "hf mf personalize --f2 -> single size random ID",
5117 "hf mf personalize --f3 -> single size NUID",
5118 "hf mf personalize -b -k B0B1B2B3B4B5 --f3 -> use key B = 0xB0B1B2B3B4B5"
5119 ],
5120 "offline": false,
5121 "options": [
5122 "-h, --help This help",
5123 "-a use key A to authenticate sector 0 (def)",
5124 "-b use key B to authenticate sector 0",
5125 "-k, --key <hex> key (def FFFFFFFFFFFF)",
5126 "--f0 UIDFO, double size UID",
5127 "--f1 UIDF1, double size UID, optional usage of selection process shortcut",
5128 "--f2 UIDF2, single size random ID",
5129 "--f3 UIDF3, single size NUID"
5130 ],
5131 "usage": "hf mf personalize [-hab] [-k <hex>] [--f0] [--f1] [--f2] [--f3]"
5132 },
5133 "hf mf rdbl": {
5134 "command": "hf mf rdbl",
5135 "description": "Read MIFARE Classic block",
5136 "notes": [
5137 "hf mf rdbl --blk 0",
5138 "hf mf rdbl --blk 0 -k A0A1A2A3A4A5",
5139 "hf mf rdbl --blk 3 -v -> get block 3, decode sector trailer"
5140 ],
5141 "offline": false,
5142 "options": [
5143 "-h, --help This help",
5144 "--blk <dec> block number",
5145 "-a input key type is key A (def)",
5146 "-b input key type is key B",
5147 "-k, --key <hex> key, 6 hex bytes",
5148 "-v, --verbose verbose output"
5149 ],
5150 "usage": "hf mf rdbl [-habv] --blk <dec> [-k <hex>]"
5151 },
5152 "hf mf rdsc": {
5153 "command": "hf mf rdsc",
5154 "description": "Read MIFARE Classic sector",
5155 "notes": [
5156 "hf mf rdsc -s 0",
5157 "hf mf rdsc -s 0 -k A0A1A2A3A4A5"
5158 ],
5159 "offline": false,
5160 "options": [
5161 "-h, --help This help",
5162 "-a input key specified is A key (def)",
5163 "-b input key specified is B key",
5164 "-k, --key <hex> key specified as 6 hex bytes",
5165 "-s, --sec <dec> sector number",
5166 "-v, --verbose verbose output"
5167 ],
5168 "usage": "hf mf rdsc [-habv] [-k <hex>] -s <dec>"
5169 },
5170 "hf mf restore": {
5171 "command": "hf mf restore",
5172 "description": "Restore MIFARE Classic dump file to tag. The key file and dump file will program the card sector trailers. By default we authenticate to card with key 0xFFFFFFFFFFFF. If access rights in dump file is all zeros, it will be replaced with default values `--uid` param is used for filename templates `hf-mf-<uid>-dump.bin` and `hf-mf-<uid>-key.bin. if not specified, it will read the card uid instead. `--ka` param you can indicate that the key file should be used for authentication instead. if so we also try both B/A keys `--force` param is used to override warnings and allow bad ACL block writes. if not specified, it will skip blocks with bad ACL.",
5173 "notes": [
5174 "hf mf restore",
5175 "hf mf restore --1k --uid 04010203",
5176 "hf mf restore --1k --uid 04010203 -k hf-mf-AABBCCDD-key.bin",
5177 "hf mf restore --4k"
5178 ],
5179 "offline": false,
5180 "options": [
5181 "-h, --help This help",
5182 "--mini MIFARE Classic Mini / S20",
5183 "--1k MIFARE Classic 1k / S50 (def)",
5184 "--2k MIFARE Classic/Plus 2k",
5185 "--4k MIFARE Classic 4k / S70",
5186 "-u, --uid <hex> uid, (4|7|10 hex bytes)",
5187 "-f, --file <fn> specify a filename for dump file",
5188 "-k, --kfn <fn> key filename",
5189 "--ka use specified keyfile to authenticate",
5190 "--force override warnings"
5191 ],
5192 "usage": "hf mf restore [-h] [--mini] [--1k] [--2k] [--4k] [-u <hex>] [-f <fn>] [-k <fn>] [--ka] [--force]"
5193 },
5194 "hf mf setmod": {
5195 "command": "hf mf setmod",
5196 "description": "Sets the load modulation strength of a MIFARE Classic EV1 card",
5197 "notes": [
5198 "hf mf setmod -k ffffffffffff -0"
5199 ],
5200 "offline": false,
5201 "options": [
5202 "-h, --help This help",
5203 "-0 normal modulation",
5204 "-1 strong modulation (def)",
5205 "-k, --key <hex> key A, Sector 0, 6 hex bytes"
5206 ],
5207 "usage": "hf mf setmod [-h01] [-k <hex>]"
5208 },
5209 "hf mf sim": {
5210 "command": "hf mf sim",
5211 "description": "Simulate MIFARE Classic family type based upon ISO/IEC 14443 type A tag with 4,7 or 10 byte UID from emulator memory. See `hf mf eload` first. The UID from emulator memory will be used if not specified.",
5212 "notes": [
5213 "hf mf sim --mini -> MIFARE Mini",
5214 "hf mf sim --1k -> MIFARE Classic 1k (default)",
5215 "hf mf sim --1k -u 0a0a0a0a -> MIFARE Classic 1k with 4b UID",
5216 "hf mf sim --1k -u 11223344556677 -> MIFARE Classic 1k with 7b UID",
5217 "hf mf sim --1k -u 11223344 -i -x -> Perform reader attack in interactive mode",
5218 "hf mf sim --2k -> MIFARE 2k",
5219 "hf mf sim --4k -> MIFARE 4k"
5220 ],
5221 "offline": false,
5222 "options": [
5223 "-h, --help This help",
5224 "-u, --uid <hex> <4|7|10> hex bytes UID",
5225 "--mini MIFARE Classic Mini / S20",
5226 "--1k MIFARE Classic 1k / S50",
5227 "--2k MIFARE Classic/Plus 2k",
5228 "--4k MIFARE Classic 4k / S70",
5229 "--atqa <hex> Provide explicit ATQA (2 bytes, overrides option t)",
5230 "--sak <hex> Provide explicit SAK (1 bytes, overrides option t)",
5231 "-n, --num <dec> Automatically exit simulation after <numreads> blocks have been read by reader. 0 = infinite",
5232 "-i, --interactive Console will not be returned until simulation finishes or is aborted",
5233 "-x Performs the 'reader attack', nr/ar attack against a reader",
5234 "-e, --emukeys Fill simulator keys from found keys",
5235 "-v, --verbose verbose output",
5236 "--cve trigger CVE 2021_0430"
5237 ],
5238 "usage": "hf mf sim [-hixev] [-u <hex>] [--mini] [--1k] [--2k] [--4k] [--atqa <hex>] [--sak <hex>] [-n <dec> ] [--cve]"
5239 },
5240 "hf mf staticnested": {
5241 "command": "hf mf staticnested",
5242 "description": "Execute static nested attack against MIFARE Classic card with static nonce for key recovery. Supply a known key from one block to recover all keys",
5243 "notes": [
5244 "hf mf staticnested --mini --blk 0 -a -k FFFFFFFFFFFF",
5245 "hf mf staticnested --1k --blk 0 -a -k FFFFFFFFFFFF",
5246 "hf mf staticnested --2k --blk 0 -a -k FFFFFFFFFFFF",
5247 "hf mf staticnested --4k --blk 0 -a -k FFFFFFFFFFFF"
5248 ],
5249 "offline": false,
5250 "options": [
5251 "-h, --help This help",
5252 "-k, --key <hex> Known key (12 hex symbols)",
5253 "--mini MIFARE Classic Mini / S20",
5254 "--1k MIFARE Classic 1k / S50",
5255 "--2k MIFARE Classic/Plus 2k",
5256 "--4k MIFARE Classic 4k / S70",
5257 "--blk <dec> Input block number",
5258 "-a Input key specified is keyA (def)",
5259 "-b Input key specified is keyB",
5260 "-e, --emukeys Fill simulator keys from found keys",
5261 "--dumpkeys Dump found keys to file"
5262 ],
5263 "usage": "hf mf staticnested [-habe] [-k <hex>] [--mini] [--1k] [--2k] [--4k] [--blk <dec>] [--dumpkeys]"
5264 },
5265 "hf mf supercard": {
5266 "command": "hf mf supercard",
5267 "description": "Extract info from a `super card`",
5268 "notes": [
5269 "hf mf supercard -> recover key",
5270 "hf mf supercard -r -> reset card",
5271 "hf mf supercard -u 11223344 -> change UID"
5272 ],
5273 "offline": false,
5274 "options": [
5275 "-h, --help This help",
5276 "-r, --reset Reset card",
5277 "-u, --uid <hex> New UID (4 hex bytes)",
5278 "--furui Furui detection card"
5279 ],
5280 "usage": "hf mf supercard [-hr] [-u <hex>] [--furui]"
5281 },
5282 "hf mf value": {
5283 "command": "hf mf value",
5284 "description": "MIFARE Classic value data commands",
5285 "notes": [
5286 "hf mf value --blk 16 -k FFFFFFFFFFFF --set 1000",
5287 "hf mf value --blk 16 -k FFFFFFFFFFFF --inc 10",
5288 "hf mf value --blk 16 -k FFFFFFFFFFFF -b --dec 10",
5289 "hf mf value --blk 16 -k FFFFFFFFFFFF -b --get",
5290 "hf mf value --blk 16 -k FFFFFFFFFFFF --res --transfer 30 --tk FFFFFFFFFFFF -> transfer block 16 value to block 30 (even if block can't be incremented by ACL)",
5291 "hf mf value --get -d 87D612007829EDFF87D6120011EE11EE"
5292 ],
5293 "offline": true,
5294 "options": [
5295 "-h, --help This help",
5296 "-k, --key <hex> key, 6 hex bytes",
5297 "-a input key type is key A (def)",
5298 "-b input key type is key B",
5299 "--inc <dec> Increment value by X (0 - 2147483647)",
5300 "--dec <dec> Decrement value by X (0 - 2147483647)",
5301 "--set <dec> Set value to X (-2147483647 - 2147483647)",
5302 "--transfer <dec> Transfer value to other block (after inc/dec/restore)",
5303 "--tkey <hex> transfer key, 6 hex bytes (if transfer is preformed to other sector)",
5304 "--ta transfer key type is key A (def)",
5305 "--tb transfer key type is key B",
5306 "--get Get value from block",
5307 "--res Restore (copy value to card buffer, should be used with --transfer)",
5308 "--blk <dec> block number",
5309 "-d, --data <hex> block data to extract values from (16 hex bytes)"
5310 ],
5311 "usage": "hf mf value [-hab] [-k <hex>] [--inc <dec>] [--dec <dec>] [--set <dec>] [--transfer <dec>] [--tkey <hex>] [--ta] [--tb] [--get] [--res] [--blk <dec>] [-d <hex>]"
5312 },
5313 "hf mf view": {
5314 "command": "hf mf view",
5315 "description": "Print a MIFARE Classic dump file (bin/eml/json)",
5316 "notes": [
5317 "hf mf view -f hf-mf-01020304-dump.bin"
5318 ],
5319 "offline": true,
5320 "options": [
5321 "-h, --help This help",
5322 "-f, --file <fn> Specify a filename for dump file",
5323 "-v, --verbose verbose output",
5324 "--sk Save extracted keys to binary file"
5325 ],
5326 "usage": "hf mf view [-hv] -f <fn> [--sk]"
5327 },
5328 "hf mf wipe": {
5329 "command": "hf mf wipe",
5330 "description": "Wipe card to zeros and default keys/acc. This command takes a key file to wipe card Will use UID from card to generate keyfile name if not specified. New A/B keys..... FF FF FF FF FF FF New acc rights... FF 07 80 New GPB.......... 69",
5331 "notes": [
5332 "hf mf wipe -> reads card uid to generate file name",
5333 "hf mf wipe --gen2 -> force write to S0, B0 manufacture block",
5334 "hf mf wipe -f mykey.bin -> use mykey.bin"
5335 ],
5336 "offline": false,
5337 "options": [
5338 "-h, --help This help",
5339 "-f, --file <fn> key filename",
5340 "--gen2 force write to Sector 0, block 0 (GEN2)"
5341 ],
5342 "usage": "hf mf wipe [-h] [-f <fn>] [--gen2]"
5343 },
5344 "hf mf wrbl": {
5345 "command": "hf mf wrbl",
5346 "description": "Write MIFARE Classic block with 16 hex bytes of data Sector 0 / Block 0 - Manufacturer block When writing to block 0 you must use a VALID block 0 data (UID, BCC, SAK, ATQA) Writing an invalid block 0 means rendering your Magic GEN2 card undetectable. Look in the magic_cards_notes.md file for help to resolve it. `--force` param is used to override warnings like bad ACL and BLOCK 0 writes. if not specified, it will exit if detected",
5347 "notes": [
5348 "hf mf wrbl --blk 1 -d 000102030405060708090a0b0c0d0e0f",
5349 "hf mf wrbl --blk 1 -k A0A1A2A3A4A5 -d 000102030405060708090a0b0c0d0e0f"
5350 ],
5351 "offline": false,
5352 "options": [
5353 "-h, --help This help",
5354 "--blk <dec> block number",
5355 "-a input key type is key A (def)",
5356 "-b input key type is key B",
5357 "--force override warnings",
5358 "-k, --key <hex> key, 6 hex bytes",
5359 "-d, --data <hex> bytes to write, 16 hex bytes"
5360 ],
5361 "usage": "hf mf wrbl [-hab] --blk <dec> [--force] [-k <hex>] [-d <hex>]"
5362 },
5363 "hf mfdes auth": {
5364 "command": "hf mfdes auth",
5365 "description": "Select application on the card. It selects app if it is a valid one or returns an error.",
5366 "notes": [
5367 "hf mfdes auth -n 0 -t des -k 0000000000000000 --kdf none -> select PICC level and authenticate with key num=0, key type=des, key=00..00 and key derivation = none",
5368 "hf mfdes auth -n 0 -t aes -k 00000000000000000000000000000000 -> select PICC level and authenticate with key num=0, key type=aes, key=00..00 and key derivation = none",
5369 "hf mfdes auth -n 0 -t des -k 0000000000000000 --save -> select PICC level and authenticate and in case of successful authentication - save channel parameters to defaults",
5370 "hf mfdes auth --aid 123456 -> select application 123456 and authenticate via parameters from `default` command"
5371 ],
5372 "offline": false,
5373 "options": [
5374 "-h, --help This help",
5375 "-a, --apdu Show APDU requests and responses",
5376 "-v, --verbose Verbose output",
5377 "-n, --keyno <dec> Key number",
5378 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5379 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5380 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5381 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5382 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5383 "-c, --ccset <native|niso|iso> Communicaton command set",
5384 "--schann <d40|ev1|ev2|lrp> Secure channel",
5385 "--aid <hex> Application ID of application for some parameters (3 hex bytes, big endian)",
5386 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5387 "--save saves channels parameters to defaults if authentication succeeds"
5388 ],
5389 "usage": "hf mfdes auth [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--save]"
5390 },
5391 "hf mfdes bruteaid": {
5392 "command": "hf mfdes bruteaid",
5393 "description": "Recover AIDs by bruteforce. WARNING: This command takes a loooong time",
5394 "notes": [
5395 "hf mfdes bruteaid -> Search all apps",
5396 "hf mfdes bruteaid --start F0000F -i 16 -> Search MAD range manually"
5397 ],
5398 "offline": false,
5399 "options": [
5400 "-h, --help This help",
5401 "--start <hex> Starting App ID as hex bytes (3 bytes, big endian)",
5402 "--end <hex> Last App ID as hex bytes (3 bytes, big endian)",
5403 "-i, --step <dec> Increment step when bruteforcing",
5404 "-m, --mad Only bruteforce the MAD range"
5405 ],
5406 "usage": "hf mfdes bruteaid [-hm] [--start <hex>] [--end <hex>] [-i <dec>]"
5407 },
5408 "hf mfdes changekey": {
5409 "command": "hf mfdes changekey",
5410 "description": "Change PICC/Application key. Needs to provide keynum/key for a valid authentication (may get from default parameters).",
5411 "notes": [
5412 "Change crypto algorithm for PICC key is possible,",
5413 "but for APP keys crypto algorithm is set by createapp command and can't be changed wo application delete",
5414 "",
5415 "hf mfdes changekey --aid 123456 -> execute with default factory setup. change des key 0 in the app 123456 from 00..00 to 00..00",
5416 "hf mfdes changekey --isoid df01 -t aes --schann lrp --newkeyno 01 -> change key 01 via lrp channelhf mfdes changekey -t des --newalgo aes --newkey 11223344556677889900112233445566 --newver a5 -> change card master key to AES one",
5417 "hf mfdes changekey --aid 123456 -t aes --key 00000000000000000000000000000000 --newkey 11223344556677889900112233445566 -> change app master key",
5418 "hf mfdes changekey --aid 123456 -t des -n 0 --newkeyno 1 --oldkey 5555555555555555 --newkey 1122334455667788 -> change key 1 with auth from key 0",
5419 "hf mfdes changekey --aid 123456 -t 3tdea --newkey 112233445566778899001122334455667788990011223344 -> change 3tdea key 0 from default 00..00 to provided"
5420 ],
5421 "offline": false,
5422 "options": [
5423 "-h, --help This help",
5424 "-a, --apdu Show APDU requests and responses",
5425 "-v, --verbose Verbose output",
5426 "-n, --keyno <dec> Key number",
5427 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5428 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5429 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5430 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5431 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5432 "-c, --ccset <native|niso|iso> Communicaton command set",
5433 "--schann <d40|ev1|ev2|lrp> Secure channel",
5434 "--aid <hex> Application ID of application (3 hex bytes, big endian)",
5435 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
5436 "--oldalgo <DES|2TDEA|3TDEA|AES> Old key crypto algorithm",
5437 "--oldkey <old key> Old key (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5438 "--newkeyno <dec> Key number for change",
5439 "--newalgo <DES|2TDEA|3TDEA|AES> New key crypto algorithm",
5440 "--newkey <hex> New key (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5441 "--newver <hex> Version of new key (1 hex byte)"
5442 ],
5443 "usage": "hf mfdes changekey [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--oldalgo <DES|2TDEA|3TDEA|AES>] [--oldkey <old key>] [--newkeyno <dec>] [--newalgo <DES|2TDEA|3TDEA|AES>] [--newkey <hex>] [--newver <hex>]"
5444 },
5445 "hf mfdes chfilesettings": {
5446 "command": "hf mfdes chfilesettings",
5447 "description": "Get File Settings from file from application. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
5448 "notes": [
5449 "hf mfdes chfilesettings --aid 123456 --fid 01 --amode plain --rrights free --wrights free --rwrights free --chrights key0 -> change file settings app=123456, file=01 with defaults from `default` command",
5450 "hf mfdes chfilesettings -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 --rawdata 00EEEE -> execute with default factory setup",
5451 "hf mfdes chfilesettings --aid 123456 --fid 01 --rawdata 810000021f112f22 -> change file settings with additional rights for keys 1 and 2",
5452 "hf mfdes chfilesettings --isoid df01 --fid 00 --amode plain --rawrights eee0 --schann lrp -t aes -> change file settings via lrp channel"
5453 ],
5454 "offline": false,
5455 "options": [
5456 "-h, --help This help",
5457 "-a, --apdu Show APDU requests and responses",
5458 "-v, --verbose Verbose output",
5459 "-n, --keyno <dec> Key number",
5460 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5461 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5462 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5463 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5464 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5465 "-c, --ccset <native|niso|iso> Communicaton command set",
5466 "--schann <d40|ev1|ev2|lrp> Secure channel",
5467 "--aid <hex> Application ID (3 hex bytes, big endian)",
5468 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5469 "--fid <hex> File ID (1 hex byte)",
5470 "--rawdata <hex> File settings (HEX > 5 bytes). Have priority over the other settings",
5471 "--amode <plain|mac|encrypt> File access mode",
5472 "--rawrights <hex> Access rights for file (2 hex bytes) R/W/RW/Chg, 0x0 - 0xD Key, 0xE Free, 0xF Denied",
5473 "--rrights <key0..13|free|deny> Read file access mode: the specified key, free, deny",
5474 "--wrights <key0..13|free|deny> Write file access mode: the specified key, free, deny",
5475 "--rwrights <key0..13|free|deny> Read/Write file access mode: the specified key, free, deny",
5476 "--chrights <key0..13|free|deny> Change file settings access mode: the specified key, free, deny",
5477 "--no-auth Execute without authentication"
5478 ],
5479 "usage": "hf mfdes chfilesettings [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [--rawdata <hex>] [--amode <plain|mac|encrypt>] [--rawrights <hex>] [--rrights <key0..13|free|deny>] [--wrights <key0..13|free|deny>] [--rwrights <key0..13|free|deny>] [--chrights <key0..13|free|deny>] [--no-auth]"
5480 },
5481 "hf mfdes chk": {
5482 "command": "hf mfdes chk",
5483 "description": "Checks keys with MIFARE DESFire card.",
5484 "notes": [
5485 "hf mfdes chk --aid 123456 -k 000102030405060708090a0b0c0d0e0f -> check key on aid 0x123456",
5486 "hf mfdes chk -d mfdes_default_keys -> check keys against all existing aid on card",
5487 "hf mfdes chk -d mfdes_default_keys --aid 123456 -> check keys against aid 0x123456",
5488 "hf mfdes chk --aid 123456 --pattern1b -j keys -> check all 1-byte keys pattern on aid 0x123456 and save found keys to `keys.json`",
5489 "hf mfdes chk --aid 123456 --pattern2b --startp2b FA00 -> check all 2-byte keys pattern on aid 0x123456. Start from key FA00FA00...FA00"
5490 ],
5491 "offline": false,
5492 "options": [
5493 "-h, --help This help",
5494 "--aid <hex> Use specific AID (3 hex bytes, big endian)",
5495 "-k, --key <hex> Key for checking (HEX 16 bytes)",
5496 "-d, --dict <fn> Dictionary file with keys",
5497 "--pattern1b Check all 1-byte combinations of key (0000...0000, 0101...0101, 0202...0202, ...)",
5498 "--pattern2b Check all 2-byte combinations of key (0000...0000, 0001...0001, 0002...0002, ...)",
5499 "--startp2b <pattern> Start key (2-byte HEX) for 2-byte search (use with `--pattern2b`)",
5500 "-j, --json <fn> Json file name to save keys",
5501 "-v, --verbose Verbose output",
5502 "--kdf <0|1|2> Key Derivation Function (KDF) (0=None, 1=AN10922, 2=Gallagher)",
5503 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5504 "-a, --apdu Show APDU requests and responses"
5505 ],
5506 "usage": "hf mfdes chk [-hva] [--aid <hex>] [-k <hex>] [-d <fn>] [--pattern1b] [--pattern2b] [--startp2b <pattern>] [-j <fn>] [--kdf <0|1|2>] [-i <hex>]"
5507 },
5508 "hf mfdes chkeysettings": {
5509 "command": "hf mfdes chkeysettings",
5510 "description": "Change key settings for card level or application level. WARNING: card level changes may block the card!",
5511 "notes": [
5512 "hf mfdes chkeysettings -d 0f -> set picc key settings with default key/channel setup",
5513 "hf mfdes chkeysettings --aid 123456 -d 0f -> set app 123456 key settings with default key/channel setup"
5514 ],
5515 "offline": false,
5516 "options": [
5517 "-h, --help This help",
5518 "-a, --apdu Show APDU requests and responses",
5519 "-v, --verbose Verbose output",
5520 "-n, --keyno <dec> Key number",
5521 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5522 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5523 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5524 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5525 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5526 "-c, --ccset <native|niso|iso> Communicaton command set",
5527 "--schann <d40|ev1|ev2|lrp> Secure channel",
5528 "--aid <hex> Application ID (3 hex bytes, big endian)",
5529 "-d, --data <HEX> Key settings (1 hex byte)"
5530 ],
5531 "usage": "hf mfdes chkeysettings [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [-d <HEX>]"
5532 },
5533 "hf mfdes clearrecfile": {
5534 "command": "hf mfdes clearrecfile",
5535 "description": "Clear record file. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
5536 "notes": [
5537 "hf mfdes clearrecfile --aid 123456 --fid 01 -> clear record file for: app=123456, file=01 with defaults from `default` command",
5538 "hf mfdes clearrecfile --isoid df01 --fid 01 --schann lrp -t aes -n 3 -> clear record file for lrp channel with key number 3"
5539 ],
5540 "offline": false,
5541 "options": [
5542 "-h, --help This help",
5543 "-a, --apdu Show APDU requests and responses",
5544 "-v, --verbose Verbose output",
5545 "-n, --keyno <dec> Key number",
5546 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5547 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5548 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5549 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5550 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5551 "-c, --ccset <native|niso|iso> Communicaton command set",
5552 "--schann <d40|ev1|ev2|lrp> Secure channel",
5553 "--aid <hex> Application ID (3 hex bytes, big endian)",
5554 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5555 "--fid <hex> File ID for clearing (1 hex byte)",
5556 "--no-auth Execute without authentication"
5557 ],
5558 "usage": "hf mfdes clearrecfile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [--no-auth]"
5559 },
5560 "hf mfdes createapp": {
5561 "command": "hf mfdes createapp",
5562 "description": "Create application. Master key needs to be provided.",
5563 "notes": [
5564 "option rawdata have priority over the rest settings, and options ks1 and ks2 have priority over corresponded key settings",
5565 "",
5566 "KeySetting 1 (AMK Setting, ks1):",
5567 "0: Allow change master key. 1 - allow, 0 - frozen",
5568 "1: Free Directory list access without master key",
5569 "0: AMK auth needed for GetFileSettings and GetKeySettings",
5570 "1: No AMK auth needed for GetFileIDs, GetISOFileIDs, GetFileSettings, GetKeySettings",
5571 "2: Free create/delete without master key",
5572 "0: CreateFile/DeleteFile only with AMK auth",
5573 "1: CreateFile/DeleteFile always",
5574 "3: Configuration changeable",
5575 "0: Configuration frozen",
5576 "1: Configuration changeable if authenticated with AMK (default)",
5577 "4-7: ChangeKey Access Rights",
5578 "0: Application master key needed (default)",
5579 "0x1..0xD: Auth with specific key needed to change any key",
5580 "0xE: Auth with the key to be changed (same KeyNo) is necessary to change a key",
5581 "0xF: All Keys within this application are frozen",
5582 "",
5583 "KeySetting 2 (ks2):",
5584 "0..3: Number of keys stored within the application (max. 14 keys)",
5585 "4: ks3 is present",
5586 "5: Use of 2 byte ISO FID, 0: No, 1: Yes",
5587 "6..7: Crypto Method 00: DES|2TDEA, 01: 3TDEA, 10: AES, 11: RFU",
5588 "Example:",
5589 "2E = with FID, DES|2TDEA, 14 keys",
5590 "6E = with FID, 3TDEA, 14 keys",
5591 "AE = with FID, AES, 14 keys",
5592 "",
5593 "hf mfdes createapp --rawdata 5634122F2E4523616964313233343536 -> execute create by rawdata",
5594 "hf mfdes createapp --aid 123456 --fid 2345 --dfname aid123456 -> app aid, iso file id, and iso df name is specified",
5595 "hf mfdes createapp --aid 123456 --fid 2345 --dfname aid123456 --dstalgo aes -> with algorithm for key AES"
5596 ],
5597 "offline": false,
5598 "options": [
5599 "-h, --help This help",
5600 "-a, --apdu Show APDU requests and responses",
5601 "-v, --verbose Verbose output",
5602 "-n, --keyno <dec> Key number",
5603 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5604 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5605 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5606 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5607 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5608 "-c, --ccset <native|niso|iso> Communicaton command set",
5609 "--schann <d40|ev1|ev2|lrp> Secure channel",
5610 "--rawdata <hex> Raw data that sends to command",
5611 "--aid <hex> Application ID for create. Mandatory. (3 hex bytes, big endian)",
5612 "--fid <hex> ISO file ID. Forbidden values: 0000 3F00, 3FFF, FFFF. (2 hex bytes, big endian)",
5613 "--dfname <string> ISO DF Name (1..16 chars)",
5614 "--dfhex <hex> ISO DF Name as hex (1..16 bytes)",
5615 "--ks1 <hex> Key settings 1 (1 hex byte). Application Master Key Settings (def: 0x0F)",
5616 "--ks2 <hex> Key settings 2 (1 hex byte). (def: 0x0E)",
5617 "--dstalgo <DES|2TDEA|3TDEA|AES> Application key crypt algo (def: DES)",
5618 "--numkeys <dec> Number of keys 0x00..0x0e (def: 0x0E)",
5619 "--no-auth Execute without authentication"
5620 ],
5621 "usage": "hf mfdes createapp [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--rawdata <hex>] [--aid <hex>] [--fid <hex>] [--dfname <string>] [--dfhex <hex>] [--ks1 <hex>] [--ks2 <hex>] [--dstalgo <DES|2TDEA|3TDEA|AES>] [--numkeys <dec>] [--no-auth]"
5622 },
5623 "hf mfdes createfile": {
5624 "command": "hf mfdes createfile",
5625 "description": "Create Standard/Backup file in the application. Application master key needs to be provided or flag --no-auth set (depend on application settings).",
5626 "notes": [
5627 "--rawtype/--rawdata have priority over the other settings. and with these parameters you can create any file. file id comes from parameters, all the rest data must be in the --rawdata parameter",
5628 "--rawrights have priority over the separate rights settings.",
5629 "Key/mode/etc of the authentication depends on application settings",
5630 "hf mfdes createfile --aid 123456 --fid 01 --isofid 0001 --size 000010 -> create file with iso id. Authentication with defaults from `default` command",
5631 "hf mfdes createfile --aid 123456 --fid 01 --rawtype 01 --rawdata 000100EEEE000100 -> create file via sending rawdata to the card. Can be used to create any type of file. Authentication with defaults from `default` command",
5632 "hf mfdes createfile --aid 123456 --fid 01 --amode plain --rrights free --wrights free --rwrights free --chrights key0 -> create file app=123456, file=01 and mentioned rights with defaults from `default` command",
5633 "hf mfdes createfile -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 --rawtype 00 --rawdata 00EEEE000100 -> execute with default factory setup"
5634 ],
5635 "offline": false,
5636 "options": [
5637 "-h, --help This help",
5638 "-a, --apdu Show APDU requests and responses",
5639 "-v, --verbose Verbose output",
5640 "-n, --keyno <dec> Key number",
5641 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5642 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5643 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5644 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5645 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5646 "-c, --ccset <native|niso|iso> Communicaton command set",
5647 "--schann <d40|ev1|ev2|lrp> Secure channel",
5648 "--aid <hex> Application ID (3 hex bytes, big endian)",
5649 "--fid <hex> File ID (1 hex byte)",
5650 "--isofid <hex> ISO File ID (2 hex bytes)",
5651 "--rawtype <hex> Raw file type (1 hex byte)",
5652 "--rawdata <hex> Raw file settings (hex > 5 bytes)",
5653 "--amode <plain|mac|encrypt> File access mode",
5654 "--rawrights <hex> Access rights for file (2 hex bytes) R/W/RW/Chg, 0x0 - 0xD Key, 0xE Free, 0xF Denied",
5655 "--rrights <key0..key13|free|deny> Read file access mode: the specified key, free, deny",
5656 "--wrights <key0..key13|free|deny> Write file access mode: the specified key, free, deny",
5657 "--rwrights <key0..key13|free|deny> Read/Write file access mode: the specified key, free, deny",
5658 "--chrights <key0..key13|free|deny> Change file settings access mode: the specified key, free, deny",
5659 "--no-auth Execute without authentication",
5660 "--size <hex> File size (3 hex bytes, big endian)",
5661 "--backup Create backupfile instead of standard file"
5662 ],
5663 "usage": "hf mfdes createfile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--fid <hex>] [--isofid <hex>] [--rawtype <hex>] [--rawdata <hex>] [--amode <plain|mac|encrypt>] [--rawrights <hex>] [--rrights <key0..key13|free|deny>] [--wrights <key0..key13|free|deny>] [--rwrights <key0..key13|free|deny>] [--chrights <key0..key13|free|deny>] [--no-auth] [--size <hex>] [--backup]"
5664 },
5665 "hf mfdes createmacfile": {
5666 "command": "hf mfdes createmacfile",
5667 "description": "Create Transaction MAC file in the application. Application master key needs to be provided or flag --no-auth set (depend on application settings).",
5668 "notes": [
5669 "--rawrights have priority over the separate rights settings.",
5670 "Key/mode/etc of the authentication depends on application settings",
5671 "Write right should be always 0xF. Read-write right should be 0xF if you not need to submit CommitReaderID command each time transaction starts",
5672 "",
5673 "hf mfdes createmacfile --aid 123456 --fid 01 --rawrights 0FF0 --mackey 00112233445566778899aabbccddeeff --mackeyver 01 -> create transaction mac file with parameters. Rights from default. Authentication with defaults from `default` command",
5674 "hf mfdes createmacfile --aid 123456 --fid 01 --amode plain --rrights free --wrights deny --rwrights free --chrights key0 --mackey 00112233445566778899aabbccddeeff -> create file app=123456, file=01, with key, and mentioned rights with defaults from `default` command",
5675 "hf mfdes createmacfile -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 -> execute with default factory setup. key and keyver == 0x00..00",
5676 "hf mfdes createmacfile --isoid df01 --fid 0f --schann lrp -t aes --rawrights 0FF0 --mackey 00112233445566778899aabbccddeeff --mackeyver 01 -> create transaction mac file via lrp channel",
5677 "hf mfdes createmacfile --isoid df01 --fid 0f --schann lrp -t aes --rawrights 0F10 --mackey 00112233445566778899aabbccddeeff --mackeyver 01 -> create transaction mac file via lrp channel with CommitReaderID command enable"
5678 ],
5679 "offline": false,
5680 "options": [
5681 "-h, --help This help",
5682 "-a, --apdu Show APDU requests and responses",
5683 "-v, --verbose Verbose output",
5684 "-n, --keyno <dec> Key number",
5685 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5686 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5687 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5688 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5689 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5690 "-c, --ccset <native|niso|iso> Communicaton command set",
5691 "--schann <d40|ev1|ev2|lrp> Secure channel",
5692 "--aid <hex> Application ID (3 hex bytes, big endian)",
5693 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5694 "--fid <hex> File ID (1 hex byte)",
5695 "--amode <plain|mac|encrypt> File access mode",
5696 "--rawrights <hex> Access rights for file (2 hex bytes) R/W/RW/Chg, 0x0 - 0xD Key, 0xE Free, 0xF Denied",
5697 "--rrights <key0..key13|free|deny> Read file access mode: the specified key, free, deny",
5698 "--wrights <key0..key13|free|deny> Write file access mode: the specified key, free, deny",
5699 "--rwrights <key0..key13|free|deny> Read/Write file access mode: the specified key, free, deny",
5700 "--chrights <key0..key13|free|deny> Change file settings access mode: the specified key, free, deny",
5701 "--no-auth Execute without authentication",
5702 "--mackey <hex> AES-128 key for MAC (16 hex bytes, big endian). (def: all zeros)",
5703 "--mackeyver <hex> AES key version for MAC (1 hex byte). (def: 0x0)"
5704 ],
5705 "usage": "hf mfdes createmacfile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [--amode <plain|mac|encrypt>] [--rawrights <hex>] [--rrights <key0..key13|free|deny>] [--wrights <key0..key13|free|deny>] [--rwrights <key0..key13|free|deny>] [--chrights <key0..key13|free|deny>] [--no-auth] [--mackey <hex>] [--mackeyver <hex>]"
5706 },
5707 "hf mfdes createrecordfile": {
5708 "command": "hf mfdes createrecordfile",
5709 "description": "Create Linear/Cyclic Record file in the application. Application master key needs to be provided or flag --no-auth set (depend on application settings).",
5710 "notes": [
5711 "--rawrights have priority over the separate rights settings.",
5712 "Key/mode/etc of the authentication depends on application settings",
5713 "hf mfdes createrecordfile --aid 123456 --fid 01 --size 000010 --maxrecord 000010 --cyclic -> create cyclic record file with parameters. Rights from default. Authentication with defaults from `default` command",
5714 "hf mfdes createrecordfile --aid 123456 --fid 01 --amode plain --rrights free --wrights free --rwrights free --chrights key0 --size 000010 --maxrecord 000010 -> create linear record file app=123456, file=01 and mentioned rights with defaults from `default` command",
5715 "hf mfdes createrecordfile -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 --size 000010 --maxrecord 000010 -> execute with default factory setup"
5716 ],
5717 "offline": false,
5718 "options": [
5719 "-h, --help This help",
5720 "-a, --apdu Show APDU requests and responses",
5721 "-v, --verbose Verbose output",
5722 "-n, --keyno <dec> Key number",
5723 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5724 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5725 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5726 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5727 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5728 "-c, --ccset <native|niso|iso> Communicaton command set",
5729 "--schann <d40|ev1|ev2|lrp> Secure channel",
5730 "--aid <hex> Application ID (3 hex bytes, big endian)",
5731 "--fid <hex> File ID (1 hex byte)",
5732 "--isofid <hex> ISO File ID (2 hex bytes)",
5733 "--amode <plain|mac|encrypt> File access mode",
5734 "--rawrights <hex> Access rights for file (2 hex bytes) R/W/RW/Chg, 0x0 - 0xD Key, 0xE Free, 0xF Denied",
5735 "--rrights <key0..key13|free|deny> Read file access mode: the specified key, free, deny",
5736 "--wrights <key0..key13|free|deny> Write file access mode: the specified key, free, deny",
5737 "--rwrights <key0..key13|free|deny> Read/Write file access mode: the specified key, free, deny",
5738 "--chrights <key0..key13|free|deny> Change file settings access mode: the specified key, free, deny",
5739 "--no-auth Execute without authentication",
5740 "--size <hex> Record size (3 hex bytes, big endian, 000001 to FFFFFF)",
5741 "--maxrecord <hex> Max. Number of Records (3 hex bytes, big endian)",
5742 "--cyclic Create cyclic record file instead of linear record file"
5743 ],
5744 "usage": "hf mfdes createrecordfile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--fid <hex>] [--isofid <hex>] [--amode <plain|mac|encrypt>] [--rawrights <hex>] [--rrights <key0..key13|free|deny>] [--wrights <key0..key13|free|deny>] [--rwrights <key0..key13|free|deny>] [--chrights <key0..key13|free|deny>] [--no-auth] [--size <hex>] [--maxrecord <hex>] [--cyclic]"
5745 },
5746 "hf mfdes createvaluefile": {
5747 "command": "hf mfdes createvaluefile",
5748 "description": "Create Value file in the application. Application master key needs to be provided or flag --no-auth set (depend on application settings).",
5749 "notes": [
5750 "--rawrights have priority over the separate rights settings.",
5751 "Key/mode/etc of the authentication depends on application settings",
5752 "hf mfdes createvaluefile --aid 123456 --fid 01 --lower 00000010 --upper 00010000 --value 00000100 -> create file with parameters. Rights from default. Authentication with defaults from `default` command",
5753 "hf mfdes createvaluefile --aid 123456 --fid 01 --amode plain --rrights free --wrights free --rwrights free --chrights key0 -> create file app=123456, file=01 and mentioned rights with defaults from `default` command",
5754 "hf mfdes createvaluefile -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 -> execute with default factory setup"
5755 ],
5756 "offline": false,
5757 "options": [
5758 "-h, --help This help",
5759 "-a, --apdu Show APDU requests and responses",
5760 "-v, --verbose Verbose output",
5761 "-n, --keyno <dec> Key number",
5762 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5763 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5764 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5765 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5766 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5767 "-c, --ccset <native|niso|iso> Communicaton command set",
5768 "--schann <d40|ev1|ev2|lrp> Secure channel",
5769 "--aid <hex> Application ID (3 hex bytes, big endian)",
5770 "--fid <hex> File ID (1 hex byte)",
5771 "--amode <plain|mac|encrypt> File access mode",
5772 "--rawrights <hex> Access rights for file (2 hex bytes) R/W/RW/Chg, 0x0 - 0xD Key, 0xE Free, 0xF Denied",
5773 "--rrights <key0..key13|free|deny> Read file access mode: the specified key, free, deny",
5774 "--wrights <key0..key13|free|deny> Write file access mode: the specified key, free, deny",
5775 "--rwrights <key0..key13|free|deny> Read/Write file access mode: the specified key, free, deny",
5776 "--chrights <key0..key13|free|deny> Change file settings access mode: the specified key, free, deny",
5777 "--no-auth Execute without authentication",
5778 "--lower <hex> Lower limit (4 hex bytes, big endian)",
5779 "--upper <hex> Upper limit (4 hex bytes, big endian)",
5780 "--value <hex> Value (4 hex bytes, big endian)",
5781 "--lcredit <dec> Limited Credit enabled (Bit 0 = Limited Credit, 1 = FreeValue)"
5782 ],
5783 "usage": "hf mfdes createvaluefile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--fid <hex>] [--amode <plain|mac|encrypt>] [--rawrights <hex>] [--rrights <key0..key13|free|deny>] [--wrights <key0..key13|free|deny>] [--rwrights <key0..key13|free|deny>] [--chrights <key0..key13|free|deny>] [--no-auth] [--lower <hex>] [--upper <hex>] [--value <hex>] [--lcredit <dec>]"
5784 },
5785 "hf mfdes default": {
5786 "command": "hf mfdes default",
5787 "description": "Set default parameters for access to MIFARE DESfire card.",
5788 "notes": [
5789 "hf mfdes default -n 0 -t des -k 0000000000000000 --kdf none -> save to the default parameters"
5790 ],
5791 "offline": false,
5792 "options": [
5793 "-h, --help This help",
5794 "-n, --keyno <dec> Key number",
5795 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5796 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5797 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5798 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5799 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5800 "-c, --ccset <native|niso|iso> Communicaton command set",
5801 "--schann <d40|ev1|ev2|lrp> Secure channel"
5802 ],
5803 "usage": "hf mfdes default [-h] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>]"
5804 },
5805 "hf mfdes deleteapp": {
5806 "command": "hf mfdes deleteapp",
5807 "description": "Delete application by its 3-byte AID. Master key needs to be provided.",
5808 "notes": [
5809 "hf mfdes deleteapp --aid 123456 -> execute with default factory setup"
5810 ],
5811 "offline": false,
5812 "options": [
5813 "-h, --help This help",
5814 "-a, --apdu Show APDU requests and responses",
5815 "-v, --verbose Verbose output",
5816 "-n, --keyno <dec> Key number",
5817 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5818 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5819 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5820 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5821 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5822 "-c, --ccset <native|niso|iso> Communicaton command set",
5823 "--schann <d40|ev1|ev2|lrp> Secure channel",
5824 "--aid <hex> Application ID to delete (3 hex bytes, big endian)"
5825 ],
5826 "usage": "hf mfdes deleteapp [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>]"
5827 },
5828 "hf mfdes deletefile": {
5829 "command": "hf mfdes deletefile",
5830 "description": "Delete file from application. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
5831 "notes": [
5832 "hf mfdes deletefile --aid 123456 --fid 01 -> delete file for: app=123456, file=01 with defaults from `default` command",
5833 "hf mfdes deletefile --isoid df01 --fid 0f --schann lrp -t aes -> delete file for lrp channel"
5834 ],
5835 "offline": false,
5836 "options": [
5837 "-h, --help This help",
5838 "-a, --apdu Show APDU requests and responses",
5839 "-v, --verbose Verbose output",
5840 "-n, --keyno <dec> Key number",
5841 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5842 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5843 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5844 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5845 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5846 "-c, --ccset <native|niso|iso> Communicaton command set",
5847 "--schann <d40|ev1|ev2|lrp> Secure channel",
5848 "--aid <hex> Application ID (3 hex bytes, big endian)",
5849 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5850 "--fid <hex> File ID (1 hex byte)",
5851 "--no-auth Execute without authentication"
5852 ],
5853 "usage": "hf mfdes deletefile [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [--no-auth]"
5854 },
5855 "hf mfdes detect": {
5856 "command": "hf mfdes detect",
5857 "description": "Detect key type and tries to find one from the list.",
5858 "notes": [
5859 "hf mfdes detect -> detect key 0 from PICC level",
5860 "hf mfdes detect --schann d40 -> detect key 0 from PICC level via secure channel D40",
5861 "hf mfdes detect --dict mfdes_default_keys -> detect key 0 from PICC level with help of the standard dictionary",
5862 "hf mfdes detect --aid 123456 -n 2 --save -> detect key 2 from app 123456 and if succeed - save params to defaults (`default` command)",
5863 "hf mfdes detect --isoid df01 --save -> detect key 0 and save to defaults with card in the LRP mode"
5864 ],
5865 "offline": false,
5866 "options": [
5867 "-h, --help This help",
5868 "-a, --apdu Show APDU requests and responses",
5869 "-v, --verbose Verbose output",
5870 "-n, --keyno <dec> Key number",
5871 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5872 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5873 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5874 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5875 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5876 "-c, --ccset <native|niso|iso> Communicaton command set",
5877 "--schann <d40|ev1|ev2|lrp> Secure channel",
5878 "--aid <hex> Application ID (3 hex bytes, big endian)",
5879 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
5880 "--dict <fn> Dictionary file name with keys",
5881 "--save Save found key and parameters to defaults"
5882 ],
5883 "usage": "hf mfdes detect [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--dict <fn>] [--save]"
5884 },
5885 "hf mfdes dump": {
5886 "command": "hf mfdes dump",
5887 "description": "For each application show fil list and then file content. Key needs to be provided for authentication or flag --no-auth set (depend on cards settings).",
5888 "notes": [
5889 "hf mfdes dump --aid 123456 -> show file dump for: app=123456 with channel defaults from `default` command/nhf mfdes dump --isoid df01 --schann lrp -t aes --length 000090 -> lrp default settings with length limit"
5890 ],
5891 "offline": false,
5892 "options": [
5893 "-h, --help This help",
5894 "-a, --apdu Show APDU requests and responses",
5895 "-v, --verbose Verbose output",
5896 "-n, --keyno <dec> Key number",
5897 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5898 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5899 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5900 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5901 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5902 "-c, --ccset <native|niso|iso> Communicaton command set",
5903 "--schann <d40|ev1|ev2|lrp> Secure channel",
5904 "--aid <hex> Application ID (3 hex bytes, big endian)",
5905 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
5906 "-l, --length <hex> Maximum length for read data files (3 hex bytes, big endian)",
5907 "--no-auth Execute without authentication"
5908 ],
5909 "usage": "hf mfdes dump [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [-l <hex>] [--no-auth]"
5910 },
5911 "hf mfdes formatpicc": {
5912 "command": "hf mfdes formatpicc",
5913 "description": "Format card. Can be done only if enabled in the configuration. Master key needs to be provided.",
5914 "notes": [
5915 "hf mfdes formatpicc -> execute with default factory setup"
5916 ],
5917 "offline": false,
5918 "options": [
5919 "-h, --help This help",
5920 "-a, --apdu Show APDU requests and responses",
5921 "-v, --verbose Verbose output",
5922 "-n, --keyno <dec> Key number",
5923 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5924 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5925 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5926 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5927 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5928 "-c, --ccset <native|niso|iso> Communicaton command set",
5929 "--schann <d40|ev1|ev2|lrp> Secure channel",
5930 "--aid <hex> Application ID of delegated application (3 hex bytes, big endian)"
5931 ],
5932 "usage": "hf mfdes formatpicc [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>]"
5933 },
5934 "hf mfdes freemem": {
5935 "command": "hf mfdes freemem",
5936 "description": "Get card's free memory. Can be done with or without authentication. Master key may be provided.",
5937 "notes": [
5938 "hf mfdes getfreemem -> execute with default factory setup"
5939 ],
5940 "offline": false,
5941 "options": [
5942 "-h, --help This help",
5943 "-a, --apdu Show APDU requests and responses",
5944 "-v, --verbose Verbose output",
5945 "-n, --keyno <dec> Key number",
5946 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5947 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5948 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5949 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5950 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5951 "-c, --ccset <native|niso|iso> Communicaton command set",
5952 "--schann <d40|ev1|ev2|lrp> Secure channel",
5953 "--no-auth Execute without authentication"
5954 ],
5955 "usage": "hf mfdes getfreemem [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--no-auth]"
5956 },
5957 "hf mfdes getaids": {
5958 "command": "hf mfdes getaids",
5959 "description": "Get Application IDs list from card. Master key needs to be provided or flag --no-auth set.",
5960 "notes": [
5961 "hf mfdes getaids -n 0 -t des -k 0000000000000000 --kdf none -> execute with default factory setup"
5962 ],
5963 "offline": false,
5964 "options": [
5965 "-h, --help This help",
5966 "-a, --apdu Show APDU requests and responses",
5967 "-v, --verbose Verbose output",
5968 "-n, --keyno <dec> Key number",
5969 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5970 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5971 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5972 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5973 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5974 "-c, --ccset <native|niso|iso> Communicaton command set",
5975 "--schann <d40|ev1|ev2|lrp> Secure channel",
5976 "--no-auth Execute without authentication"
5977 ],
5978 "usage": "hf mfdes getaids [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--no-auth]"
5979 },
5980 "hf mfdes getappnames": {
5981 "command": "hf mfdes getappnames",
5982 "description": "Get Application IDs, ISO IDs and DF names from card. Master key needs to be provided or flag --no-auth set.",
5983 "notes": [
5984 "hf mfdes getappnames -n 0 -t des -k 0000000000000000 --kdf none -> execute with default factory setup"
5985 ],
5986 "offline": false,
5987 "options": [
5988 "-h, --help This help",
5989 "-a, --apdu Show APDU requests and responses",
5990 "-v, --verbose Verbose output",
5991 "-n, --keyno <dec> Key number",
5992 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
5993 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
5994 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
5995 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
5996 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
5997 "-c, --ccset <native|niso|iso> Communicaton command set",
5998 "--schann <d40|ev1|ev2|lrp> Secure channel",
5999 "--no-auth Execute without authentication"
6000 ],
6001 "usage": "hf mfdes getappnames [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--no-auth]"
6002 },
6003 "hf mfdes getfileids": {
6004 "command": "hf mfdes getfileids",
6005 "description": "Get File IDs list from card. Master key needs to be provided or flag --no-auth set.",
6006 "notes": [
6007 "hf mfdes getfileids --aid 123456 -> execute with defaults from `default` command",
6008 "hf mfdes getfileids -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 -> execute with default factory setup"
6009 ],
6010 "offline": false,
6011 "options": [
6012 "-h, --help This help",
6013 "-a, --apdu Show APDU requests and responses",
6014 "-v, --verbose Verbose output",
6015 "-n, --keyno <dec> Key number",
6016 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6017 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6018 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6019 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6020 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6021 "-c, --ccset <native|niso|iso> Communicaton command set",
6022 "--schann <d40|ev1|ev2|lrp> Secure channel",
6023 "--aid <hex> Application ID (3 hex bytes, big endian)",
6024 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
6025 "--no-auth Execute without authentication"
6026 ],
6027 "usage": "hf mfdes getfileids [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--no-auth]"
6028 },
6029 "hf mfdes getfileisoids": {
6030 "command": "hf mfdes getfileisoids",
6031 "description": "Get File IDs list from card. Master key needs to be provided or flag --no-auth set.",
6032 "notes": [
6033 "hf mfdes getfileisoids --aid 123456 -> execute with defaults from `default` command",
6034 "hf mfdes getfileisoids -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 -> execute with default factory setup",
6035 "hf mfdes getfileisoids --isoid df01 -> get iso file ids from Desfire Light with factory card settings",
6036 "hf mfdes getfileisoids --isoid df01 --schann lrp -t aes -> get iso file ids from Desfire Light via lrp channel with default key authentication"
6037 ],
6038 "offline": false,
6039 "options": [
6040 "-h, --help This help",
6041 "-a, --apdu Show APDU requests and responses",
6042 "-v, --verbose Verbose output",
6043 "-n, --keyno <dec> Key number",
6044 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6045 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6046 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6047 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6048 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6049 "-c, --ccset <native|niso|iso> Communicaton command set",
6050 "--schann <d40|ev1|ev2|lrp> Secure channel",
6051 "--aid <hex> Application ID (3 hex bytes, big endian)",
6052 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
6053 "--no-auth Execute without authentication"
6054 ],
6055 "usage": "hf mfdes getfileisoids [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--no-auth]"
6056 },
6057 "hf mfdes getfilesettings": {
6058 "command": "hf mfdes getfilesettings",
6059 "description": "Get File Settings from file from application. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
6060 "notes": [
6061 "hf mfdes getfilesettings --aid 123456 --fid 01 -> execute with defaults from `default` command",
6062 "hf mfdes getfilesettings --isoid df01 --fid 00 --no-auth -> get file settings with select by iso id",
6063 "hf mfdes getfilesettings -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 -> execute with default factory setup"
6064 ],
6065 "offline": false,
6066 "options": [
6067 "-h, --help This help",
6068 "-a, --apdu Show APDU requests and responses",
6069 "-v, --verbose Verbose output",
6070 "-n, --keyno <dec> Key number",
6071 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6072 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6073 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6074 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6075 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6076 "-c, --ccset <native|niso|iso> Communicaton command set",
6077 "--schann <d40|ev1|ev2|lrp> Secure channel",
6078 "--aid <hex> Application ID (3 hex bytes, big endian)",
6079 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6080 "--fid <hex> File ID (1 hex byte). (def: 1)",
6081 "--no-auth Execute without authentication"
6082 ],
6083 "usage": "hf mfdes getfilesettings [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [--no-auth]"
6084 },
6085 "hf mfdes getkeysettings": {
6086 "command": "hf mfdes getkeysettings",
6087 "description": "Get key settings for card level or application level.",
6088 "notes": [
6089 "hf mfdes getkeysettings -> get picc key settings with default key/channel setup",
6090 "hf mfdes getkeysettings --aid 123456 -> get app 123456 key settings with default key/channel setup"
6091 ],
6092 "offline": false,
6093 "options": [
6094 "-h, --help This help",
6095 "-a, --apdu Show APDU requests and responses",
6096 "-v, --verbose Verbose output",
6097 "-n, --keyno <dec> Key number",
6098 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6099 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6100 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6101 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6102 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6103 "-c, --ccset <native|niso|iso> Communicaton command set",
6104 "--schann <d40|ev1|ev2|lrp> Secure channel",
6105 "--aid <hex> Application ID (3 hex bytes, big endian)"
6106 ],
6107 "usage": "hf mfdes getkeysettings [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>]"
6108 },
6109 "hf mfdes getkeyversions": {
6110 "command": "hf mfdes getkeyversions",
6111 "description": "Get key versions for card level or application level.",
6112 "notes": [
6113 "--keynum parameter: App level: key number. PICC level: 00..0d - keys count, 21..23 vc keys, default 0x00.",
6114 "hf mfdes getkeyversions --keynum 00 -> get picc master key version with default key/channel setup",
6115 "hf mfdes getkeyversions --aid 123456 --keynum 0d -> get app 123456 all key versions with default key/channel setup",
6116 "hf mfdes getkeyversions --aid 123456 --keynum 0d --no-auth -> get key version without authentication"
6117 ],
6118 "offline": false,
6119 "options": [
6120 "-h, --help This help",
6121 "-a, --apdu Show APDU requests and responses",
6122 "-v, --verbose Verbose output",
6123 "-n, --keyno <dec> Key number for authentication",
6124 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6125 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6126 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6127 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6128 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6129 "-c, --ccset <native|niso|iso> Communicaton command set",
6130 "--schann <d40|ev1|ev2|lrp> Secure channel",
6131 "--aid <hex> Application ID (3 hex bytes, big endian)",
6132 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
6133 "--keynum <hex> Key number/count (1 hex byte). (def: 0x00)",
6134 "--keyset <hex> Keyset number (1 hex byte)",
6135 "--no-auth Execute without authentication"
6136 ],
6137 "usage": "hf mfdes getkeyversions [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--keynum <hex>] [--keyset <hex>] [--no-auth]"
6138 },
6139 "hf mfdes getuid": {
6140 "command": "hf mfdes getuid",
6141 "description": "Get UID from card. Get the real UID if the random UID bit is on and get the same UID as in anticollision if not. Any card's key needs to be provided.",
6142 "notes": [
6143 "hf mfdes getuid -> execute with default factory setup",
6144 "hf mfdes getuid --isoid df01 -t aes --schan lrp -> for desfire lights default settings"
6145 ],
6146 "offline": false,
6147 "options": [
6148 "-h, --help This help",
6149 "-a, --apdu Show APDU requests and responses",
6150 "-v, --verbose Verbose output",
6151 "-n, --keyno <dec> Key number",
6152 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6153 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6154 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6155 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6156 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6157 "-c, --ccset <native|niso|iso> Communicaton command set",
6158 "--schann <d40|ev1|ev2|lrp> Secure channel",
6159 "--aid <hex> Application ID (3 hex bytes, big endian)",
6160 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)"
6161 ],
6162 "usage": "hf mfdes getuid [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>]"
6163 },
6164 "hf mfdes help": {
6165 "command": "hf mfdes help",
6166 "description": "help This help list List DESFire (ISO 14443A) history test Regression crypto tests --------------------------------------------------------------------------------------- hf mfdes list available offline: yes Alias of `trace list -t des -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
6167 "notes": [
6168 "hf mfdes list --frame -> show frame delay times",
6169 "hf mfdes list -1 -> use trace buffer"
6170 ],
6171 "offline": true,
6172 "options": [
6173 "-h, --help This help",
6174 "-1, --buffer use data from trace buffer",
6175 "--frame show frame delay times",
6176 "-c mark CRC bytes",
6177 "-r show relative times (gap and duration)",
6178 "-u display times in microseconds instead of clock cycles",
6179 "-x show hexdump to convert to pcap(ng)",
6180 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
6181 "-f, --file <fn> filename of dictionary"
6182 ],
6183 "usage": "hf mfdes list [-h1crux] [--frame] [-f <fn>]"
6184 },
6185 "hf mfdes info": {
6186 "command": "hf mfdes info",
6187 "description": "Get info from MIFARE DESfire tags",
6188 "notes": [
6189 "hf mfdes info"
6190 ],
6191 "offline": false,
6192 "options": [
6193 "-h, --help This help"
6194 ],
6195 "usage": "hf mfdes info [-h]"
6196 },
6197 "hf mfdes lsapp": {
6198 "command": "hf mfdes lsapp",
6199 "description": "Show application list. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
6200 "notes": [
6201 "hf mfdes lsapp -> show application list with defaults from `default` command",
6202 "hf mfdes lsapp --files -> show application list and show each file type/settings/etc"
6203 ],
6204 "offline": false,
6205 "options": [
6206 "-h, --help This help",
6207 "-a, --apdu Show APDU requests and responses",
6208 "-v, --verbose Verbose output",
6209 "-n, --keyno <dec> Key number",
6210 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6211 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6212 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6213 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6214 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6215 "-c, --ccset <native|niso|iso> Communicaton command set",
6216 "--schann <d40|ev1|ev2|lrp> Secure channel",
6217 "--no-auth Execute without authentication",
6218 "--no-deep not to check authentication commands that avail for any application",
6219 "--files scan files and print file settings"
6220 ],
6221 "usage": "hf mfdes lsapp [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--no-auth] [--no-deep] [--files]"
6222 },
6223 "hf mfdes lsfiles": {
6224 "command": "hf mfdes lsfiles",
6225 "description": "This commands List files inside application AID / ISOID. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
6226 "notes": [
6227 "hf mfdes lsfiles --aid 123456 -> AID 123456, list files using `default` command creds",
6228 "hf mfdes lsfiles --isoid df01 --no-auth -> list files for DESFire light"
6229 ],
6230 "offline": false,
6231 "options": [
6232 "-h, --help This help",
6233 "-a, --apdu Show APDU requests and responses",
6234 "-v, --verbose Verbose output",
6235 "-n, --keyno <dec> Key number",
6236 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6237 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6238 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6239 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6240 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6241 "-c, --ccset <native|niso|iso> Communicaton command set",
6242 "--schann <d40|ev1|ev2|lrp> Secure channel",
6243 "--aid <hex> Application ID (3 hex bytes, big endian)",
6244 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6245 "--no-auth Execute without authentication"
6246 ],
6247 "usage": "hf mfdes lsfiles [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--no-auth]"
6248 },
6249 "hf mfdes mad": {
6250 "command": "hf mfdes mad",
6251 "description": "Reads and prints MIFARE Application directory (MAD).",
6252 "notes": [
6253 "MAD consists of one file with issuer info (AID ffffff) and several files with AID in the special format `faaaav` (a - MAD ID, v - multiple AID over one MAD ID)",
6254 "The MIFARE DESFire Card Master Key settings have to allow the MIFARE DESFire command GetApplicationIDs without authentication (from datasheet)",
6255 "",
6256 "hf mfdes mad -> shows MAD data",
6257 "hf mfdes mad -v -> shows MAD parsed and raw data",
6258 "hf mfdes mad -a e103 -k d3f7d3f7d3f7d3f7d3f7d3f7d3f7d3f7 -> shows MAD data with custom AID and key"
6259 ],
6260 "offline": false,
6261 "options": [
6262 "-h, --help This help",
6263 "-a, --apdu Show APDU requests and responses",
6264 "-v, --verbose Verbose output",
6265 "-n, --keyno <dec> Key number",
6266 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6267 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6268 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6269 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6270 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6271 "-c, --ccset <native|niso|iso> Communicaton command set",
6272 "--schann <d40|ev1|ev2|lrp> Secure channel",
6273 "--aid <hex> Application ID of issuer info file, (3 hex bytes, big endian), (non-standard feature!)",
6274 "--auth Authenticate to get info from GetApplicationIDs command (non-standard feature!)"
6275 ],
6276 "usage": "hf mfdes mad [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--auth]"
6277 },
6278 "hf mfdes read": {
6279 "command": "hf mfdes read",
6280 "description": "Read data from file. Key needs to be provided or flag --no-auth set (depend on file settings).",
6281 "notes": [
6282 "It reads file via all command sets.",
6283 "For ISO command set it can be read by specifying full 2-byte iso id or 1-byte short iso id (first byte of the full iso id). ISO id lays in the data in BIG ENDIAN format.",
6284 "ISO record commands: offset - record number (0-current, 1..ff-number, 1-lastest), length - if 0 - all records, if 1 - one",
6285 "",
6286 "hf mfdes read --aid 123456 --fid 01 -> read file: app=123456, file=01, offset=0, all the data. use default channel settings from `default` command",
6287 "hf mfdes read --aid 123456 --fid 01 --type record --offset 000000 --length 000001 -> read one last record from record file. use default channel settings from `default` command",
6288 "hf mfdes read --aid 123456 --fid 10 --type data -c iso -> read file via ISO channel: app=123456, short iso id=10, offset=0.",
6289 "hf mfdes read --aid 123456 --fileisoid 1000 --type data -c iso -> read file via ISO channel: app=123456, iso id=1000, offset=0. Select via native ISO wrapper",
6290 "hf mfdes read --isoid 0102 --fileisoid 1000 --type data -c iso -> read file via ISO channel: app iso id=0102, iso id=1000, offset=0. Select via ISO commands",
6291 "hf mfdes read --isoid 0102 --fileisoid 1100 --type record -c iso --offset 000005 --length 000001 -> get one record (number 5) from file 1100 via iso commands",
6292 "hf mfdes read --isoid 0102 --fileisoid 1100 --type record -c iso --offset 000005 --length 000000 -> get all record (from 5 to 1) from file 1100 via iso commands",
6293 "hf mfdes read --isoid df01 --fid 00 --schann lrp -t aes --length 000010 -> read via lrp channel",
6294 "hf mfdes read --isoid df01 --fid 00 --schann ev2 -t aes --length 000010 --isochain -> read Desfire Light via ev2 channel"
6295 ],
6296 "offline": false,
6297 "options": [
6298 "-h, --help This help",
6299 "-a, --apdu Show APDU requests and responses",
6300 "-v, --verbose Verbose output",
6301 "-n, --keyno <dec> Key number",
6302 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6303 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6304 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6305 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6306 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6307 "-c, --ccset <native|niso|iso> Communicaton command set",
6308 "--schann <d40|ev1|ev2|lrp> Secure channel",
6309 "--aid <hex> Application ID (3 hex bytes, big endian)",
6310 "--fid <hex> File ID (1 hex byte)",
6311 "--no-auth Execute without authentication",
6312 "--type <auto|data|value|record|mac> File Type, Auto - check file settings and then read. (def: auto)",
6313 "-o, --offset <hex> File Offset (3 hex bytes, big endian). For records - record number (0 - lastest record). (def: 0)",
6314 "-l, --length <hex> Length to read (3 hex bytes, big endian -> 000000 = Read all data). For records - records count (0 - all). (def: 0)",
6315 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6316 "--fileisoid <hex> File ISO ID (ISO DF ID) (2 hex bytes, big endian). Works only for ISO read commands",
6317 "--isochain use iso chaining commands. Switched on by default if secure channel = lrp"
6318 ],
6319 "usage": "hf mfdes read [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--fid <hex>] [--no-auth] [--type <auto|data|value|record|mac>] [-o <hex>] [-l <hex>] [--isoid <hex>] [--fileisoid <hex>] [--isochain]"
6320 },
6321 "hf mfdes selectapp": {
6322 "command": "hf mfdes selectapp",
6323 "description": "Select application on the card. It selects app if it is a valid one or returns an error.",
6324 "notes": [
6325 "hf mfdes selectapp --aid 123456 -> select application 123456",
6326 "hf mfdes selectapp --mf -> select master file (PICC level)",
6327 "hf mfdes selectapp --dfname aid123456 -> select application aid123456 by DF name",
6328 "hf mfdes selectapp --isoid 1111 -> select application 1111 by ISO ID",
6329 "hf mfdes selectapp --isoid 1111 --fileisoid 2222 -> select application 1111 file 2222 by ISO ID",
6330 "hf mfdes selectapp --isoid 01df --fileisoid 00ef -> select file 00 on the Desfire Light"
6331 ],
6332 "offline": false,
6333 "options": [
6334 "-h, --help This help",
6335 "-a, --apdu Show APDU requests and responses",
6336 "-v, --verbose Verbose output",
6337 "-n, --keyno <dec> Key number",
6338 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6339 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6340 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6341 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6342 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6343 "-c, --ccset <native|niso|iso> Communicaton command set",
6344 "--schann <d40|ev1|ev2|lrp> Secure channel",
6345 "--aid <hex> Application ID of application for some parameters (3 hex bytes, big endian)",
6346 "--dfname <str> Application DF Name (string, max 16 chars). Selects application via ISO SELECT command",
6347 "--mf Select MF (master file) via ISO channel",
6348 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6349 "--fileisoid <hex> Select file inside application by ISO ID (ISO DF ID) (2 hex bytes, big endian)."
6350 ],
6351 "usage": "hf mfdes selectapp [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--dfname <str>] [--mf] [--isoid <hex>] [--fileisoid <hex>]"
6352 },
6353 "hf mfdes setconfig": {
6354 "command": "hf mfdes setconfig",
6355 "description": "Set card configuration. WARNING! Danger zone! Needs to provide card's master key and works if not blocked by config.",
6356 "notes": [
6357 "More about options MF2DLHX0.pdf.",
6358 "Options list:",
6359 "00h PICC configuration.",
6360 "02h ATS update.",
6361 "03h SAK update",
6362 "04h Secure Messaging Configuration.",
6363 "05h Capability data. (here change for LRP in the Desfire Light [enable 00000000010000000000])",
6364 "06h DF Name renaming (one-time)",
6365 "08h File renaming (one-time)",
6366 "09h Value file configuration (one-time)",
6367 "0Ah Failed authentication counter setting [disable 00ffffffff]",
6368 "0Bh HW configuration",
6369 "",
6370 "hf mfdes setconfig --param 03 --data 0428 -> set SAK",
6371 "hf mfdes setconfig --param 02 --data 0875778102637264 -> set ATS (first byte - length)",
6372 "hf mfdes setconfig --isoid df01 -t aes --schann ev2 --param 05 --data 00000000020000000000 -> set LRP mode enable for Desfire Light",
6373 "hf mfdes setconfig --isoid df01 -t aes --schann ev2 --param 0a --data 00ffffffff -> Disable failed auth counters for Desfire Light",
6374 "hf mfdes setconfig --isoid df01 -t aes --schann lrp --param 0a --data 00ffffffff -> Disable failed auth counters for Desfire Light via lrp"
6375 ],
6376 "offline": false,
6377 "options": [
6378 "-h, --help This help",
6379 "-a, --apdu Show APDU requests and responses",
6380 "-v, --verbose Verbose output",
6381 "-n, --keyno <dec> Key number",
6382 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6383 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6384 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6385 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6386 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6387 "-c, --ccset <native|niso|iso> Communicaton command set",
6388 "--schann <d40|ev1|ev2|lrp> Secure channel",
6389 "--aid <hex> Application ID of application for some parameters (3 hex bytes, big endian)",
6390 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian).",
6391 "-p, --param <hex> Parameter id (1 hex byte)",
6392 "-d, --data <hex> Data for parameter (1..30 hex bytes)"
6393 ],
6394 "usage": "hf mfdes setconfig [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [-p <hex>] [-d <hex>]"
6395 },
6396 "hf mfdes test": {
6397 "command": "hf mfdes test",
6398 "description": "Regression crypto tests",
6399 "notes": [
6400 "hf mfdes test"
6401 ],
6402 "offline": true,
6403 "options": [
6404 "-h, --help This help"
6405 ],
6406 "usage": "hf mfdes test [-h]"
6407 },
6408 "hf mfdes value": {
6409 "command": "hf mfdes value",
6410 "description": "Get File Settings from file from application. Master key needs to be provided or flag --no-auth set (depend on cards settings).",
6411 "notes": [
6412 "hf mfdes value --aid 123456 --fid 01 -> get value app=123456, file=01 with defaults from `default` command",
6413 "hf mfdes value --aid 123456 --fid 01 --op credit -d 00000001 -> credit value app=123456, file=01 with defaults from `default` command",
6414 "hf mfdes value -n 0 -t des -k 0000000000000000 --kdf none --aid 123456 --fid 01 -> get value with default factory setup",
6415 "hf mfdes val --isoid df01 --fid 03 --schann lrp -t aes -n 1 --op credit --d 00000001 -m encrypt -> credit value in the lrp encrypted mode",
6416 "hf mfdes val --isoid df01 --fid 03 --schann lrp -t aes -n 1 --op get -m plain -> get value in plain (nevertheless of mode) works for desfire light (look SetConfiguration option 0x09)"
6417 ],
6418 "offline": false,
6419 "options": [
6420 "-h, --help This help",
6421 "-a, --apdu Show APDU requests and responses",
6422 "-v, --verbose Verbose output",
6423 "-n, --keyno <dec> Key number",
6424 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6425 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6426 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6427 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6428 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6429 "-c, --ccset <native|niso|iso> Communicaton command set",
6430 "--schann <d40|ev1|ev2|lrp> Secure channel",
6431 "--aid <hex> Application ID (3 hex bytes, big endian)",
6432 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6433 "--fid <hex> File ID (1 hex byte)",
6434 "-o, --op <get/credit/limcredit/debit/clear> Operation: get(default)/credit/limcredit(limited credit)/debit/clear. Operation clear: get-getopt-debit to min value",
6435 "-d, --data <hex> Value for operation (HEX 4 bytes)",
6436 "--no-auth Execute without authentication"
6437 ],
6438 "usage": "hf mfdes value [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--isoid <hex>] [--fid <hex>] [-o <get/credit/limcredit/debit/clear>] [-d <hex>] [--no-auth]"
6439 },
6440 "hf mfdes write": {
6441 "command": "hf mfdes write",
6442 "description": "Write data from file. Key needs to be provided or flag --no-auth set (depend on file settings).",
6443 "notes": [
6444 "In the mode with CommitReaderID to decode previous reader id command needs to read transaction counter via dump/read command and specify --trkey",
6445 "",
6446 "hf mfdes write --aid 123456 --fid 01 -d 01020304 -> AID 123456, file=01, offset=0, get file type from card. use default channel settings from `default` command",
6447 "hf mfdes write --aid 123456 --fid 01 --type data -d 01020304 --0ffset 000100 -> write data to std file with offset 0x100",
6448 "hf mfdes write --aid 123456 --fid 01 --type data -d 01020304 --commit -> write data to backup file with commit",
6449 "hf mfdes write --aid 123456 --fid 01 --type value -d 00000001 -> increment value file",
6450 "hf mfdes write --aid 123456 --fid 01 --type value -d 00000001 --debit -> decrement value file",
6451 "hf mfdes write --aid 123456 --fid 01 -d 01020304 -> write data to file with `auto` type",
6452 "hf mfdes write --aid 123456 --fid 01 --type record -d 01020304 -> write data to record file",
6453 "hf mfdes write --aid 123456 --fid 01 --type record -d 01020304 --updaterec 0 -> update record in the record file. record 0 - lastest record.",
6454 "hf mfdes write --aid 123456 --fid 01 --type record --offset 000000 -d 11223344 -> write record to record file. use default channel settings from `default` command",
6455 "hf mfdes write --isoid 1234 --fileisoid 1000 --type data -c iso -d 01020304 -> write data to std/backup file via iso commandset",
6456 "hf mfdes write --isoid 1234 --fileisoid 2000 --type record -c iso -d 01020304 -> send record to record file via iso commandset",
6457 "hf mfdes write --aid 123456 --fid 01 -d 01020304 --readerid 010203 -> write data to file with CommitReaderID command before write and CommitTransaction after write",
6458 "hf mfdes write --isoid df01 --fid 04 -d 01020304 --trkey 00112233445566778899aabbccddeeff --readerid 5532 -t aes --schann lrp -> advanced CommitReaderID via lrp channel sample"
6459 ],
6460 "offline": false,
6461 "options": [
6462 "-h, --help This help",
6463 "-a, --apdu Show APDU requests and responses",
6464 "-v, --verbose Verbose output",
6465 "-n, --keyno <dec> Key number",
6466 "-t, --algo <DES|2TDEA|3TDEA|AES> Crypt algo",
6467 "-k, --key <hex> Key for authenticate (HEX 8(DES), 16(2TDEA or AES) or 24(3TDEA) bytes)",
6468 "--kdf <none|AN10922|gallagher> Key Derivation Function (KDF)",
6469 "-i, --kdfi <hex> KDF input (1-31 hex bytes)",
6470 "-m, --cmode <plain|mac|encrypt> Communicaton mode",
6471 "-c, --ccset <native|niso|iso> Communicaton command set",
6472 "--schann <d40|ev1|ev2|lrp> Secure channel",
6473 "--aid <hex> Application ID (3 hex bytes, big endian)",
6474 "--fid <hex> File ID (1 hex byte)",
6475 "--no-auth Execute without authentication",
6476 "--type <auto|data|value|record|mac> File Type, Auto - check file settings and then write. (def: auto)",
6477 "-o, --offset <hex> File Offset (3 hex bytes, big endian). For records - record number (0 - lastest record). (def: 0)",
6478 "-d, --data <hex> data for write (data/record file), credit/debit(value file)",
6479 "--debit use for value file debit operation instead of credit",
6480 "--commit commit needs for backup file only. For the other file types and in the `auto` mode - command set it automatically",
6481 "--updaterec <dec> Record number for update record command. Updates record instead of write. Lastest record - 0",
6482 "--isoid <hex> Application ISO ID (ISO DF ID) (2 hex bytes, big endian)",
6483 "--fileisoid <hex> File ISO ID (ISO DF ID) (2 hex bytes, big endian). Works only for ISO write commands",
6484 "--readerid <hex> reader id for CommitReaderID command. If present - the command issued before write command",
6485 "--trkey <hex> key for decode previous reader id"
6486 ],
6487 "usage": "hf mfdes write [-hav] [-n <dec>] [-t <DES|2TDEA|3TDEA|AES>] [-k <hex>] [--kdf <none|AN10922|gallagher>] [-i <hex>] [-m <plain|mac|encrypt>] [-c <native|niso|iso>] [--schann <d40|ev1|ev2|lrp>] [--aid <hex>] [--fid <hex>] [--no-auth] [--type <auto|data|value|record|mac>] [-o <hex>] [-d <hex>] [--debit] [--commit] [--updaterec <dec>] [--isoid <hex>] [--fileisoid <hex>] [--readerid <hex>] [--trkey <hex>]"
6488 },
6489 "hf mfp auth": {
6490 "command": "hf mfp auth",
6491 "description": "Executes AES authentication command for MIFARE Plus card",
6492 "notes": [
6493 "hf mfp auth --ki 4000 --key 000102030405060708090a0b0c0d0e0f -> executes authentication",
6494 "hf mfp auth --ki 9003 --key FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF -v -> executes authentication and shows all the system data"
6495 ],
6496 "offline": false,
6497 "options": [
6498 "-h, --help This help",
6499 "-v, --verbose Verbose output",
6500 "--ki <hex> Key number, 2 hex bytes",
6501 "--key <hex> Key, 16 hex bytes"
6502 ],
6503 "usage": "hf mfp auth [-hv] --ki <hex> --key <hex>"
6504 },
6505 "hf mfp chconf": {
6506 "command": "hf mfp chconf",
6507 "description": "Change the configuration on a Mifare Plus tag. DANGER!",
6508 "notes": [
6509 "This requires Card Master Key (9000) or Card Configuration Key (9001).",
6510 "Configuration block info can be found below.",
6511 "* Block B000 (00; CMK): Max amount of commands without MAC (byte 0), as well as plain mode access (unknown).",
6512 "* Block B001 (01; CCK): Installation identifier for Virtual Card. Please consult NXP for data.",
6513 "* Block B002 (02; CCK): ATS data.",
6514 "* Block B003 (03; CCK): Use Random ID in SL3, decide whether proximity check is mandatory.",
6515 "* DO NOT WRITE THIS BLOCK UNDER ANY CIRCUMSTANCES! Risk of bricking.",
6516 "More configuration tips to follow. Check JMY600 Series IC Card Module.",
6517 "hf mfp chconf -c 00 -d 10ffffffffffffffffffffffffffffff --key A0A1A2A3A4A5A6A7A0A1A2A3A4A5A6A7 -> Allow 16 commands without MAC in a single transaction."
6518 ],
6519 "offline": false,
6520 "options": [
6521 "-h, --help This help",
6522 "-v, --verbose Verbose output",
6523 "--nmr Do not expect MAC in response",
6524 "-c, --conf <hex> Config block number, 0-3",
6525 "-k, --key <hex> Card key, 16 hex bytes",
6526 "--cck Auth as Card Configuration key instead of Card Master Key",
6527 "-d, --data <hex> New configuration data, 16 hex bytes"
6528 ],
6529 "usage": "hf mfp chconf [-hv] [--nmr] -c <hex> [-k <hex>] [--cck] -d <hex>"
6530 },
6531 "hf mfp chk": {
6532 "command": "hf mfp chk",
6533 "description": "Checks keys on MIFARE Plus card",
6534 "notes": [
6535 "hf mfp chk -k 000102030405060708090a0b0c0d0e0f -> check key on sector 0 as key A and B",
6536 "hf mfp chk -s 2 -a -> check default key list on sector 2, only key A",
6537 "hf mfp chk -d mfp_default_keys -s0 -e6 -> check keys from dictionary against sectors 0-6",
6538 "hf mfp chk --pattern1b --dump -> check all 1-byte keys pattern and save found keys to file",
6539 "hf mfp chk --pattern2b --startp2b FA00 -> check all 2-byte keys pattern. Start from key FA00FA00...FA00"
6540 ],
6541 "offline": false,
6542 "options": [
6543 "-h, --help This help",
6544 "-a, --keya Check only key A (def: check all keys)",
6545 "-b, --keyb Check only key B (def: check all keys)",
6546 "-s, --startsec <0..255> Start sector number",
6547 "-e, --endsec <0..255> End sector number",
6548 "-k, --key <hex> Key for checking (HEX 16 bytes)",
6549 "-d, --dict <fn> Dictionary file with keys",
6550 "--pattern1b Check all 1-byte combinations of key (0000...0000, 0101...0101, 0202...0202, ...)",
6551 "--pattern2b Check all 2-byte combinations of key (0000...0000, 0001...0001, 0002...0002, ...)",
6552 "--startp2b <pattern> Start key (2-byte HEX) for 2-byte search (use with `--pattern2b`)",
6553 "--dump Dump found keys to JSON file",
6554 "-v, --verbose Verbose output"
6555 ],
6556 "usage": "hf mfp chk [-habv] [-s <0..255>] [-e <0..255>] [-k <hex>] [-d <fn>] [--pattern1b] [--pattern2b] [--startp2b <pattern>] [--dump]"
6557 },
6558 "hf mfp chkey": {
6559 "command": "hf mfp chkey",
6560 "description": "Change the keys on a Mifare Plus tag",
6561 "notes": [
6562 "This requires the key that can update the key that you are trying to update.",
6563 "hf mfp chkey --ki 401f -d FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF --key A0A1A2A3A4A5A6A7A0A1A2A3A4A5A6A7 -> Change key B for Sector 15 from MAD to default",
6564 "hf mfp chkey --ki 9000 -d 32F9351A1C02B35FF97E0CA943F814F6 --key FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF -> Change card master key to custom from default"
6565 ],
6566 "offline": false,
6567 "options": [
6568 "-h, --help This help",
6569 "-v, --verbose Verbose output",
6570 "--nmr Do not expect MAC in response",
6571 "--ki <hex> Key Index, 2 hex bytes",
6572 "-k, --key <hex> Current sector key, 16 hex bytes",
6573 "-b, --typeb Sector key is key B",
6574 "-d, --data <hex> New key, 16 hex bytes"
6575 ],
6576 "usage": "hf mfp chkey [-hvb] [--nmr] --ki <hex> [-k <hex>] -d <hex>"
6577 },
6578 "hf mfp commitp": {
6579 "command": "hf mfp commitp",
6580 "description": "Executes Commit Perso command. Can be used in SL0 mode only. OBS! This command will not be executed if CardConfigKey, CardMasterKey and L3SwitchKey AES keys are not written.",
6581 "notes": [
6582 "hf mfp commitp"
6583 ],
6584 "offline": false,
6585 "options": [
6586 "-h, --help This help",
6587 "-v, --verbose Verbose output"
6588 ],
6589 "usage": "hf mfp commitp [-hv]"
6590 },
6591 "hf mfp dump": {
6592 "command": "hf mfp dump",
6593 "description": "Dump MIFARE Plus tag to file (bin/json) If no <name> given, UID will be used as filename",
6594 "notes": [
6595 "hf mfp dump",
6596 "hf mfp dump --keys hf-mf-066C8B78-key.bin -> MIFARE Plus with keys from specified file"
6597 ],
6598 "offline": false,
6599 "options": [
6600 "-h, --help This help",
6601 "-f, --file <fn> Specify a filename for dump file",
6602 "-k, --keys <fn> Specify a filename for keys file"
6603 ],
6604 "usage": "hf mfp dump [-h] [-f <fn>] [-k <fn>]"
6605 },
6606 "hf mfp help": {
6607 "command": "hf mfp help",
6608 "description": "help This help list List MIFARE Plus history --------------------------------------------------------------------------------------- hf mfp list available offline: yes Alias of `trace list -t mfp -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
6609 "notes": [
6610 "hf mfp list --frame -> show frame delay times",
6611 "hf mfp list -1 -> use trace buffer"
6612 ],
6613 "offline": true,
6614 "options": [
6615 "-h, --help This help",
6616 "-1, --buffer use data from trace buffer",
6617 "--frame show frame delay times",
6618 "-c mark CRC bytes",
6619 "-r show relative times (gap and duration)",
6620 "-u display times in microseconds instead of clock cycles",
6621 "-x show hexdump to convert to pcap(ng)",
6622 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
6623 "-f, --file <fn> filename of dictionary"
6624 ],
6625 "usage": "hf mfp list [-h1crux] [--frame] [-f <fn>]"
6626 },
6627 "hf mfp info": {
6628 "command": "hf mfp info",
6629 "description": "Get info from MIFARE Plus tags",
6630 "notes": [
6631 "hf mfp info"
6632 ],
6633 "offline": false,
6634 "options": [
6635 "-h, --help This help"
6636 ],
6637 "usage": "hf mfp info [-h]"
6638 },
6639 "hf mfp initp": {
6640 "command": "hf mfp initp",
6641 "description": "Executes Write Perso command for all card's keys. Can be used in SL0 mode only.",
6642 "notes": [
6643 "hf mfp initp --key 000102030405060708090a0b0c0d0e0f -> fill all the keys with key (00..0f)",
6644 "hf mfp initp -vv -> fill all the keys with default key(0xff..0xff) and show all the data exchange"
6645 ],
6646 "offline": false,
6647 "options": [
6648 "-h, --help This help",
6649 "-v, --verbose Verbose output",
6650 "-k, --key <hex> Key, 16 hex bytes"
6651 ],
6652 "usage": "hf mfp initp [-hv] [-k <hex>]"
6653 },
6654 "hf mfp mad": {
6655 "command": "hf mfp mad",
6656 "description": "Checks and prints MIFARE Application Directory (MAD)",
6657 "notes": [
6658 "hf mfp mad",
6659 "hf mfp mad --aid e103 -k d3f7d3f7d3f7d3f7d3f7d3f7d3f7d3f7 -> read and print NDEF data from MAD aid"
6660 ],
6661 "offline": false,
6662 "options": [
6663 "-h, --help This help",
6664 "-v, --verbose Verbose output",
6665 "--aid <hex> Print all sectors with aid",
6666 "-k, --key <hex> Key for printing sectors",
6667 "-b, --keyb Use key B for access printing sectors (def: key A)",
6668 "--be (optional: BigEndian)",
6669 "--dch Decode Card Holder information"
6670 ],
6671 "usage": "hf mfp mad [-hvb] [--aid <hex>] [-k <hex>] [--be] [--dch]"
6672 },
6673 "hf mfp ndefformat": {
6674 "command": "hf mfp ndefformat",
6675 "description": "format MIFARE Plus Tag as a NFC tag with Data Exchange Format (NDEF) If no <name> given, UID will be used as filename. It will try default keys and MAD keys to detect if tag is already formatted in order to write. If not, it will try finding a key file based on your UID. ie, if you ran autopwn before",
6676 "notes": [
6677 "hf mfp ndefformat",
6678 "hf mfp ndefformat --keys hf-mf-01020304-key.bin -> with keys from specified file"
6679 ],
6680 "offline": false,
6681 "options": [
6682 "-h, --help This help",
6683 "-k, --keys <fn> filename of keys"
6684 ],
6685 "usage": "hf mfp ndefformat [-h] [-k <fn>]"
6686 },
6687 "hf mfp ndefread": {
6688 "command": "hf mfp ndefread",
6689 "description": "Prints NFC Data Exchange Format (NDEF)",
6690 "notes": [
6691 "hf mfp ndefread",
6692 "hf mfp ndefread -vv -> shows NDEF parsed and raw data",
6693 "hf mfp ndefread --aid e103 -k d3f7d3f7d3f7d3f7d3f7d3f7d3f7d3f7 -> shows NDEF data with custom AID and key",
6694 "hf mfp ndefread -f myfilename -> save raw NDEF to file"
6695 ],
6696 "offline": false,
6697 "options": [
6698 "-h, --help This help",
6699 "-v, --verbose verbose output",
6700 "--aid <aid> replace default aid for NDEF",
6701 "-k, --key <key> replace default key for NDEF",
6702 "-b, --keyb use key B for access sectors (by default: key A)",
6703 "-f, --file <fn> save raw NDEF to file"
6704 ],
6705 "usage": "hf mfp ndefread [-hvb] [--aid <aid>] [-k <key>] [-f <fn>]"
6706 },
6707 "hf mfp ndefwrite": {
6708 "command": "hf mfp ndefwrite",
6709 "description": "Write raw NDEF hex bytes to tag. This commands assumes tag already been NFC/NDEF formatted.",
6710 "notes": [
6711 "hf mfp ndefwrite -d 0300FE -> write empty record to tag",
6712 "hf mfp ndefwrite -f myfilename",
6713 "hf mfp ndefwrite -d 033fd1023a53709101195405656e2d55534963656d616e2054776974746572206c696e6b5101195502747769747465722e636f6d2f686572726d616e6e31303031"
6714 ],
6715 "offline": false,
6716 "options": [
6717 "-h, --help This help",
6718 "-d <hex> raw NDEF hex bytes",
6719 "-f, --file <fn> write raw NDEF file to tag",
6720 "-p fix NDEF record headers / terminator block if missing",
6721 "-v, --verbose verbose output"
6722 ],
6723 "usage": "hf mfp ndefwrite [-hpv] [-d <hex>] [-f <fn>]"
6724 },
6725 "hf mfp rdbl": {
6726 "command": "hf mfp rdbl",
6727 "description": "Reads blocks from MIFARE Plus card",
6728 "notes": [
6729 "hf mfp rdbl --blk 0 --key 000102030405060708090a0b0c0d0e0f -> executes authentication and read block 0 data",
6730 "hf mfp rdbl --blk 1 -v -> executes authentication and shows sector 1 data with default key 0xFF..0xFF"
6731 ],
6732 "offline": false,
6733 "options": [
6734 "-h, --help This help",
6735 "-v, --verbose Verbose output",
6736 "-n, --count <dec> Blocks count (def: 1)",
6737 "-b, --keyb Use key B (def: keyA)",
6738 "-p, --plain Do not use encrypted communication mode between reader and card",
6739 "--nmc Do not append MAC to command",
6740 "--nmr Do not expect MAC in reply",
6741 "--blk <0..255> Block number",
6742 "-k, --key <hex> Key, 16 hex bytes"
6743 ],
6744 "usage": "hf mfp rdbl [-hvbp] [-n <dec>] [--nmc] [--nmr] --blk <0..255> [-k <hex>]"
6745 },
6746 "hf mfp rdsc": {
6747 "command": "hf mfp rdsc",
6748 "description": "Reads one sector from MIFARE Plus card",
6749 "notes": [
6750 "hf mfp rdsc -s 0 --key 000102030405060708090a0b0c0d0e0f -> executes authentication and read sector 0 data",
6751 "hf mfp rdsc -s 1 -v -> executes authentication and shows sector 1 data with default key"
6752 ],
6753 "offline": false,
6754 "options": [
6755 "-h, --help This help",
6756 "-v, --verbose Verbose output",
6757 "-b, --keyb Use key B (def: keyA)",
6758 "-p, --plain Do not use encrypted communication mode between reader and card",
6759 "--nmc Do not append MAC to command",
6760 "--nmr Do not expect MAC in reply",
6761 "-s, --sn <0..255> Sector number",
6762 "-k, --key <hex> Key, 16 hex bytes"
6763 ],
6764 "usage": "hf mfp rdsc [-hvbp] [--nmc] [--nmr] -s <0..255> [-k <hex>]"
6765 },
6766 "hf mfp wrbl": {
6767 "command": "hf mfp wrbl",
6768 "description": "Writes one block to MIFARE Plus card",
6769 "notes": [
6770 "hf mfp wrbl --blk 1 -d ff0000000000000000000000000000ff --key 000102030405060708090a0b0c0d0e0f -> write block 1 data",
6771 "hf mfp wrbl --blk 2 -d ff0000000000000000000000000000ff -v -> write block 2 data with default key 0xFF..0xFF"
6772 ],
6773 "offline": false,
6774 "options": [
6775 "-h, --help This help",
6776 "-v, --verbose Verbose output",
6777 "-b, --keyb Use key B (def: keyA)",
6778 "--blk <0..255> Block number",
6779 "-p, --plain Do not use encrypted transmission",
6780 "--nmr Do not expect MAC in response",
6781 "-d, --data <hex> Data, 16 hex bytes",
6782 "-k, --key <hex> Key, 16 hex bytes"
6783 ],
6784 "usage": "hf mfp wrbl [-hvbp] --blk <0..255> [--nmr] -d <hex> [-k <hex>]"
6785 },
6786 "hf mfp wrp": {
6787 "command": "hf mfp wrp",
6788 "description": "Executes Write Perso command. Can be used in SL0 mode only.",
6789 "notes": [
6790 "Use this command to program AES keys, as well as personalize other data on the tag.",
6791 "You can program:",
6792 "* Address 00 [00-FF]: Memory blocks (as well as ACLs and Crypto1 keys)",
6793 "* Address 40 [00-40]: AES sector keys",
6794 "* Address 90 [00-04]: AES administrative keys",
6795 "* Address A0 [00, 01, 80, 81]: Virtual Card keys",
6796 "* Address B0 [00-03]: Configuration data (DO NOT TOUCH B003)",
6797 "Examples:",
6798 "hf mfp wrp --adr 4000 --data 000102030405060708090a0b0c0d0e0f -> write key (00..0f) to key number 4000",
6799 "hf mfp wrp --adr 4000 -> write default key(0xff..0xff) to key number 4000",
6800 "hf mfp wrp --adr b000 -d FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF -> allow 255 commands without MAC in configuration block (B000)",
6801 "hf mfp wrp --adr 0003 -d 1234561234567F078869B0B1B2B3B4B5 -> write crypto1 keys A: 123456123456 and B: B0B1B2B3B4B5 to block 3"
6802 ],
6803 "offline": false,
6804 "options": [
6805 "-h, --help This help",
6806 "-v, --verbose Verbose output",
6807 "-a, --adr <hex> Address, 2 hex bytes",
6808 "-d, --data <hex> Data, 16 hex bytes"
6809 ],
6810 "usage": "hf mfp wrp [-hv] -a <hex> [-d <hex>]"
6811 },
6812 "hf mfu amiibo": {
6813 "command": "hf mfu amiibo",
6814 "description": "Tries to read all memory from amiibo tag and decrypt it",
6815 "notes": [
6816 "hf mfu amiiboo --dec -f hf-mfu-04579DB27C4880-dump.bin -> decrypt file",
6817 "hf mfu amiiboo -v --dec -> decrypt tag"
6818 ],
6819 "offline": false,
6820 "options": [
6821 "-h, --help This help",
6822 "--dec Decrypt memory",
6823 "--enc Encrypt memory",
6824 "-i, --in <fn> Specify a filename for input dump file",
6825 "-o, --out <fn> Specify a filename for output dump file",
6826 "-v, --verbose Verbose output"
6827 ],
6828 "usage": "hf mfu amiibo [-hv] [--dec] [--enc] [-i <fn>] [-o <fn>]"
6829 },
6830 "hf mfu cauth": {
6831 "command": "hf mfu cauth",
6832 "description": "Tests 3DES password on Mifare Ultralight-C tag. If password is not specified, a set of known defaults will be tested.",
6833 "notes": [
6834 "hf mfu cauth",
6835 "hf mfu cauth --key 000102030405060708090a0b0c0d0e0f"
6836 ],
6837 "offline": false,
6838 "options": [
6839 "-h, --help This help",
6840 "--key <hex> Authentication key (UL-C 16 hex bytes)",
6841 "-l Swap entered key's endianness",
6842 "-k Keep field on (only if a password is provided)"
6843 ],
6844 "usage": "hf mfu cauth [-hlk] [--key <hex>]"
6845 },
6846 "hf mfu dump": {
6847 "command": "hf mfu dump",
6848 "description": "Dump MIFARE Ultralight/NTAG tag to files (bin/json) It autodetects card type.Supports: Ultralight, Ultralight-C, Ultralight EV1 NTAG 203, NTAG 210, NTAG 212, NTAG 213, NTAG 215, NTAG 216",
6849 "notes": [
6850 "hf mfu dump -f myfile",
6851 "hf mfu dump -k AABBCCDD -> dump whole tag using pwd AABBCCDD",
6852 "hf mfu dump -p 10 -> start at page 10 and dump rest of blocks",
6853 "hf mfu dump -p 10 -q 2 -> start at page 10 and dump two blocks",
6854 "hf mfu dump --key 00112233445566778899AABBCCDDEEFF"
6855 ],
6856 "offline": false,
6857 "options": [
6858 "-h, --help This help",
6859 "-f, --file <fn> Specify a filename for dump file",
6860 "-k, --key <hex> Key for authentication (UL-C 16 bytes, EV1/NTAG 4 bytes)",
6861 "-l Swap entered key's endianness",
6862 "-p, --page <dec> Manually set start page number to start from",
6863 "-q, --qty <dec> Manually set number of pages to dump",
6864 "--ns no save to file",
6865 "-z, --dense dense dump output style"
6866 ],
6867 "usage": "hf mfu dump [-hlz] [-f <fn>] [-k <hex>] [-p <dec>] [-q <dec>] [--ns]"
6868 },
6869 "hf mfu eload": {
6870 "command": "hf mfu eload",
6871 "description": "Load emulator memory with data from (bin/eml/json) dump file",
6872 "notes": [
6873 "hf mfu eload -f hf-mfu-04010203040506.bin",
6874 "hf mfu eload -f hf-mfu-04010203040506.bin -q 57 -> load 57 blocks from myfile"
6875 ],
6876 "offline": false,
6877 "options": [
6878 "-h, --help This help",
6879 "-f, --file <fn> Specify a filename for dump file",
6880 "-q, --qty <dec> Number of blocks to load from eml file",
6881 "-v, --verbose verbose output"
6882 ],
6883 "usage": "hf mfu eload [-hv] -f <fn> [-q <dec>]"
6884 },
6885 "hf mfu esave": {
6886 "command": "hf mfu esave",
6887 "description": "Saves emulator memory to a MIFARE Ultralight/NTAG dump file (bin/json) By default number of pages saved depends on defined tag type. You can override this with option --end.",
6888 "notes": [
6889 "hf mfu esave",
6890 "hf mfu esave --end 255 -> saves whole memory",
6891 "hf mfu esave -f hf-mfu-04010203040506-dump"
6892 ],
6893 "offline": false,
6894 "options": [
6895 "-h, --help This help",
6896 "-e, --end <dec> index of last block",
6897 "-f, --file <fn> Specify a filename for dump file"
6898 ],
6899 "usage": "hf mfu esave [-h] [-e <dec>] [-f <fn>]"
6900 },
6901 "hf mfu eview": {
6902 "command": "hf mfu eview",
6903 "description": "Displays emulator memory By default number of pages shown depends on defined tag type. You can override this with option --end.",
6904 "notes": [
6905 "hf mfu eview",
6906 "hf mfu eview --end 255 -> dumps whole memory"
6907 ],
6908 "offline": false,
6909 "options": [
6910 "-h, --help This help",
6911 "-e, --end <dec> index of last block",
6912 "-z, --dense dense dump output style"
6913 ],
6914 "usage": "hf mfu eview [-hz] [-e <dec>]"
6915 },
6916 "hf mfu help": {
6917 "command": "hf mfu help",
6918 "description": "help This help list List MIFARE Ultralight / NTAG history keygen Generate DES/3DES/AES MIFARE diversified keys pwdgen Generate pwd from known algos view Display content from tag dump file --------------------------------------------------------------------------------------- hf mfu list available offline: yes Alias of `trace list -t 14a -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
6919 "notes": [
6920 "hf 14a list --frame -> show frame delay times",
6921 "hf 14a list -1 -> use trace buffer"
6922 ],
6923 "offline": true,
6924 "options": [
6925 "-h, --help This help",
6926 "-1, --buffer use data from trace buffer",
6927 "--frame show frame delay times",
6928 "-c mark CRC bytes",
6929 "-r show relative times (gap and duration)",
6930 "-u display times in microseconds instead of clock cycles",
6931 "-x show hexdump to convert to pcap(ng)",
6932 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
6933 "-f, --file <fn> filename of dictionary"
6934 ],
6935 "usage": "hf 14a list [-h1crux] [--frame] [-f <fn>]"
6936 },
6937 "hf mfu info": {
6938 "command": "hf mfu info",
6939 "description": "Get info about MIFARE Ultralight Family styled tag. Sometimes the tags are locked down, and you may need a key to be able to read the information",
6940 "notes": [
6941 "hf mfu info",
6942 "hf mfu info -k AABBCCDD",
6943 "hf mfu info --key 00112233445566778899AABBCCDDEEFF"
6944 ],
6945 "offline": false,
6946 "options": [
6947 "-h, --help This help",
6948 "-k, --key <hex> Authentication key (UL-C 16 bytes, EV1/NTAG 4 bytes)",
6949 "-l Swap entered key's endianness",
6950 "--force override `hw dbg` settings"
6951 ],
6952 "usage": "hf mfu info [-hl] [-k <hex>] [--force]"
6953 },
6954 "hf mfu keygen": {
6955 "command": "hf mfu keygen",
6956 "description": "Set the DES/3DES/AES key on MIFARE Ultralight-C tag.",
6957 "notes": [
6958 "hf mfu keygen -r",
6959 "hf mfu keygen --uid 11223344556677"
6960 ],
6961 "offline": true,
6962 "options": [
6963 "-h, --help This help",
6964 "-u, --uid <hex> <4|7> hex byte UID",
6965 "-r Read UID from tag",
6966 "-b, --blk <dec> Block number"
6967 ],
6968 "usage": "hf mfu keygen [-hr] [-u <hex>] [-b <dec>]"
6969 },
6970 "hf mfu ndefread": {
6971 "command": "hf mfu ndefread",
6972 "description": "Prints NFC Data Exchange Format (NDEF)",
6973 "notes": [
6974 "hf mfu ndefread -> shows NDEF data",
6975 "hf mfu ndefread -k ffffffff -> shows NDEF data with key",
6976 "hf mfu ndefread -f myfilename -> save raw NDEF to file"
6977 ],
6978 "offline": false,
6979 "options": [
6980 "-h, --help This help",
6981 "-l Swap entered key's endianness",
6982 "-f, --file <fn> Save raw NDEF to file",
6983 "-v, --verbose Verbose output"
6984 ],
6985 "usage": "hf mfu ndefread [-hlv] [-k Replace default key for NDEF] [-f <fn>]"
6986 },
6987 "hf mfu otptear": {
6988 "command": "hf mfu otptear",
6989 "description": "Tear-off test against OTP block",
6990 "notes": [
6991 "hf mfu otptear -b 3",
6992 "hf mfu otptear -b 3 -i 100 -s 1000",
6993 "hf mfu otptear -b 3 -i 1 -e 200",
6994 "hf mfu otptear -b 3 -i 100 -s 200 -e 2500 -d FFFFFFFF -t EEEEEEEE",
6995 "hf mfu otptear -b 3 -i 100 -s 200 -e 2500 -d FFFFFFFF -t EEEEEEEE -m 00000000 -> quit when OTP is reset"
6996 ],
6997 "offline": false,
6998 "options": [
6999 "-h, --help This help",
7000 "-b, --blk <dec> target block (def 8)",
7001 "-i, --inc <dec> increase time steps (def 500 us)",
7002 "-e, --end <dec> end time (def 3000 us)",
7003 "-s, --start <dec> start time (def 0 us)",
7004 "-d, --data <hex> initialise data before run (4 bytes)",
7005 "-t, --test <hex> test write data (4 bytes, 00000000 by default)",
7006 "-m, --match <hex> exit criteria, if block matches this value (4 bytes)"
7007 ],
7008 "usage": "hf mfu otptear [-h] [-b <dec>] [-i <dec>] [-e <dec>] [-s <dec>] [-d <hex>] [-t <hex>] [-m <hex>]"
7009 },
7010 "hf mfu pwdgen": {
7011 "command": "hf mfu pwdgen",
7012 "description": "Generate different passwords from known pwdgen algos",
7013 "notes": [
7014 "hf mfu pwdgen -r",
7015 "hf mfu pwdgen -t",
7016 "hf mfu pwdgen --uid 11223344556677"
7017 ],
7018 "offline": true,
7019 "options": [
7020 "-h, --help This help",
7021 "-u, --uid <hex> UID (7 hex bytes)",
7022 "-r Read UID from tag",
7023 "-t Selftest"
7024 ],
7025 "usage": "hf mfu pwdgen [-hrt] [-u <hex>]"
7026 },
7027 "hf mfu rdbl": {
7028 "command": "hf mfu rdbl",
7029 "description": "Read a block and print. It autodetects card type.",
7030 "notes": [
7031 "hf mfu rdbl -b 0",
7032 "hf mfu rdbl -b 0 -k AABBCCDD",
7033 "hf mfu rdbl -b 0 --key 00112233445566778899AABBCCDDEEFF"
7034 ],
7035 "offline": false,
7036 "options": [
7037 "-h, --help This help",
7038 "-k, --key <hex> Authentication key (UL-C 16 bytes, EV1/NTAG 4 bytes)",
7039 "-l Swap entered key's endianness",
7040 "-b, --block <dec> Block number to read",
7041 "--force Force operation even if address is out of range"
7042 ],
7043 "usage": "hf mfu rdbl [-hl] [-k <hex>] -b <dec> [--force]"
7044 },
7045 "hf mfu restore": {
7046 "command": "hf mfu restore",
7047 "description": "Restore MIFARE Ultralight/NTAG dump file (bin/eml/json) to tag.",
7048 "notes": [
7049 "hf mfu restore -f myfile -s -> special write",
7050 "hf mfu restore -f myfile -k AABBCCDD -s -> special write, use key",
7051 "hf mfu restore -f myfile -k AABBCCDD -ser -> special write, use key, write dump pwd, ..."
7052 ],
7053 "offline": false,
7054 "options": [
7055 "-h, --help This help",
7056 "-f, --file <fn> Specify a filename for dump file",
7057 "-k, --key <hex> key for authentication (UL-C 16 bytes, EV1/NTAG 4 bytes)",
7058 "-l swap entered key's endianness",
7059 "-s enable special write UID -MAGIC TAG ONLY-",
7060 "-e enable special write version/signature -MAGIC NTAG 21* ONLY-",
7061 "-r use password found in dumpfile to configure tag. Requires '-e' parameter to work",
7062 "-v, --verbose verbose output",
7063 "-z, --dense dense dump output style"
7064 ],
7065 "usage": "hf mfu restore [-hlservz] -f <fn> [-k <hex>]"
7066 },
7067 "hf mfu setpwd": {
7068 "command": "hf mfu setpwd",
7069 "description": "Set the 3DES key on MIFARE Ultralight-C tag.",
7070 "notes": [
7071 "hf mfu setpwd --key 000102030405060708090a0b0c0d0e0f"
7072 ],
7073 "offline": false,
7074 "options": [
7075 "-h, --help This help",
7076 "-k, --key <hex> New key (16 hex bytes)"
7077 ],
7078 "usage": "hf mfu setpwd [-h] [-k <hex>]"
7079 },
7080 "hf mfu setuid": {
7081 "command": "hf mfu setuid",
7082 "description": "Set UID on MIFARE Ultralight tag. This only works for `magic Ultralight` tags.",
7083 "notes": [
7084 "hf mfu setuid --uid 11223344556677"
7085 ],
7086 "offline": false,
7087 "options": [
7088 "-h, --help This help",
7089 "-u, --uid <hex> New UID (7 hex bytes)"
7090 ],
7091 "usage": "hf mfu setuid [-h] [-u <hex>]"
7092 },
7093 "hf mfu sim": {
7094 "command": "hf mfu sim",
7095 "description": "Simulate MIFARE Ultralight family type based upon ISO/IEC 14443 type A tag with 4,7 or 10 byte UID from emulator memory. See `hf mfu eload` first. The UID from emulator memory will be used if not specified. See `hf 14a sim -h` to see available types. You want 2 or 7 usually.",
7096 "notes": [
7097 "hf mfu sim -t 2 --uid 11223344556677 -> MIFARE Ultralight",
7098 "hf mfu sim -t 7 --uid 11223344556677 -n 5 -> MFU EV1 / NTAG 215 Amiibo",
7099 "hf mfu sim -t 7 -> MFU EV1 / NTAG 215 Amiibo"
7100 ],
7101 "offline": false,
7102 "options": [
7103 "-h, --help This help",
7104 "-t, --type <1..12> Simulation type to use",
7105 "-u, --uid <hex> <4|7|10> hex bytes UID",
7106 "-n, --num <dec> Exit simulation after <numreads> blocks. 0 = infinite",
7107 "-v, --verbose Verbose output"
7108 ],
7109 "usage": "hf mfu sim [-hv] -t <1..12> [-u <hex>] [-n <dec>]"
7110 },
7111 "hf mfu tamper": {
7112 "command": "hf mfu tamper",
7113 "description": "Set the configuration of the NTAG 213TT tamper feature Supports: NTAG 213TT",
7114 "notes": [
7115 "hf mfu tamper -e -> enable tamper feature",
7116 "hf mfu tamper -d -> disable tamper feature",
7117 "hf mfu tamper -m 0A0A0A0A -> set the tamper message to 0A0A0A0A",
7118 "hf mfu tamper --lockmessage -> permanently lock the tamper message and mask it from memory"
7119 ],
7120 "offline": false,
7121 "options": [
7122 "-h, --help This help",
7123 "-e, --enable Enable the tamper feature",
7124 "-d, --disable Disable the tamper feature",
7125 "-m, --message <hex> Set the tamper message (4 bytes)",
7126 "--lockmessage Permanently lock the tamper message and mask it from memory (does not lock tamper feature itself)"
7127 ],
7128 "usage": "hf mfu tamper [-hed] [-m <hex>] [--lockmessage]"
7129 },
7130 "hf mfu view": {
7131 "command": "hf mfu view",
7132 "description": "Print a MIFARE Ultralight/NTAG dump file (bin/eml/json)",
7133 "notes": [
7134 "hf mfu view -f hf-mfu-01020304-dump.bin"
7135 ],
7136 "offline": true,
7137 "options": [
7138 "-h, --help This help",
7139 "-f, --file <fn> Specify a filename for dump file",
7140 "-v, --verbose Verbose output",
7141 "-z, --dense dense dump output style"
7142 ],
7143 "usage": "hf mfu view [-hvz] -f <fn>"
7144 },
7145 "hf mfu wipe": {
7146 "command": "hf mfu wipe",
7147 "description": "Wipe card to zeros. It will ignore block0,1,2,3 you will need to call it with password in order to wipe the config and sett default pwd/pack Abort by pressing a key New password... FFFFFFFF",
7148 "notes": [
7149 "hf mfu wipe"
7150 ],
7151 "offline": false,
7152 "options": [
7153 "-h, --help This help",
7154 "-k, --key <hex> Key for authentication (UL-C 16 bytes, EV1/NTAG 4 bytes)",
7155 "-l Swap entered key's endianness"
7156 ],
7157 "usage": "hf mfu wipe [-hl] [-k <hex>]"
7158 },
7159 "hf mfu wrbl": {
7160 "command": "hf mfu wrbl",
7161 "description": "Write a block. It autodetects card type.",
7162 "notes": [
7163 "hf mfu wrbl -b 0 -d 01234567",
7164 "hf mfu wrbl -b 0 -d 01234567 -k AABBCCDD",
7165 "hf mfu wrbl -b 0 -d 01234567 -k 00112233445566778899AABBCCDDEEFF"
7166 ],
7167 "offline": false,
7168 "options": [
7169 "-h, --help This help",
7170 "-k, --key <hex> Authentication key (UL-C 16 bytes, EV1/NTAG 4 bytes)",
7171 "-l Swap entered key's endianness",
7172 "-b, --block <dec> Block number to write",
7173 "-d, --data <hex> Block data (4 or 16 hex bytes, 16 hex bytes will do a compatibility write)",
7174 "--force Force operation even if address is out of range"
7175 ],
7176 "usage": "hf mfu wrbl [-hl] [-k <hex>] -b <dec> -d <hex> [--force]"
7177 },
7178 "hf ntag424 auth": {
7179 "command": "hf ntag424 auth",
7180 "description": "Authenticate with selected key against NTAG424.",
7181 "notes": [
7182 "hf ntag424 auth --keyno 0 -k 00000000000000000000000000000000"
7183 ],
7184 "offline": false,
7185 "options": [
7186 "-h, --help This help",
7187 "--keyno <dec> Key number",
7188 "-k, --key <hex> Key for authenticate (HEX 16 bytes)"
7189 ],
7190 "usage": "hf ntag424 auth [-h] --keyno <dec> -k <hex>"
7191 },
7192 "hf ntag424 changefs": {
7193 "command": "hf ntag424 changefs",
7194 "description": "Updates file settings for file, must be authenticated. This is a short explanation of the settings. See AN12196 for more information: options: byte with bit flags Bit: Setting: 6 Enable SDM and mirroring access: two byte access rights. Each nibble is a key number, or E for free access. Order is key for readwrite, change, read and write sdmoptions: byte with bit flags Bit: Setting: 0 ASCII encoding 4 SDMEncFileData 5 SDMReadCtrLimit 6 SDMReadCtr 7 SDMOptionsUID sdmaccess: two byte access rights. Each nibble is a key, or E for plain mirror and F for no mirroring Order is Reserved, SDMCtrRet, SDMMetaRead and SDMFileRead sdm_data: Three bytes of data used to control SDM settings. Can be specified multiple times. Data means different things depending on settings. Note: Not all of these settings will be written. It depends on the option byte, and the keys set. See AN12196 for more information. You must also start with sdmdata1, then sdmdata2, up to the number of sdm_data you want to write",
7195 "notes": [
7196 "hf ntag424 changefs --fileno 2 --keyno 0 -k 00000000000000000000000000000000 -o 40 -a 00E0 -s C1 -c F000 --data1 000020 --data2 000043 --data3 000043"
7197 ],
7198 "offline": false,
7199 "options": [
7200 "-h, --help This help",
7201 "--fileno <dec> File number",
7202 "--keyno <dec> Key number",
7203 "-k, --key <hex> Key for authentication (HEX 16 bytes)",
7204 "-o, --options <hex> File options byte (HEX 1 byte)",
7205 "-a, --access <hex> File access settings (HEX 2 bytes)",
7206 "-s, --sdmoptions <hex> SDM options (HEX 1 byte)",
7207 "-c, --sdmaccess <hex> SDM access settings (HEX 2 bytes)",
7208 "--data1 <hex> SDM data (HEX 3 bytes)",
7209 "--data2 <hex> SDM data (HEX 3 bytes)",
7210 "--data3 <hex> SDM data (HEX 3 bytes)",
7211 "--data4 <hex> SDM data (HEX 3 bytes)",
7212 "--data5 <hex> SDM data (HEX 3 bytes)",
7213 "--data6 <hex> SDM data (HEX 3 bytes)",
7214 "--data7 <hex> SDM data (HEX 3 bytes)",
7215 "--data8 <hex> SDM data (HEX 3 bytes)"
7216 ],
7217 "usage": "hf ntag424 changefs [-h] --fileno <dec> --keyno <dec> -k <hex> [-o <hex>] [-a <hex>] [-s <hex>] [-c <hex>] [--data1 <hex>] [--data2 <hex>] [--data3 <hex>] [--data4 <hex>] [--data5 <hex>] [--data6 <hex>] [--data7 <hex>] [--data8 <hex>]"
7218 },
7219 "hf ntag424 changekey": {
7220 "command": "hf ntag424 changekey",
7221 "description": "Change a key. Authentication key must currently be different to the one we want to change.",
7222 "notes": [
7223 "hf ntag424 changekey --keyno 1 --oldkey 00000000000000000000000000000000 --newkey 11111111111111111111111111111111 --key0 00000000000000000000000000000000 --kv 1",
7224 "hf ntag424 changekey --keyno 0 --newkey 11111111111111111111111111111111 --key0 00000000000000000000000000000000 --kv 1"
7225 ],
7226 "offline": false,
7227 "options": [
7228 "-h, --help This help",
7229 "--keyno <dec> Key number to change",
7230 "--oldkey <hex> Old key (only needed when changing key 1-4, HEX 16 bytes)",
7231 "--newkey <hex> New key (HEX 16 bytes)",
7232 "--key0 <hex> Authentication key (must be key 0, HEX 16 bytes)",
7233 "--kv <dec> New key version number"
7234 ],
7235 "usage": "hf ntag424 changekey [-h] --keyno <dec> [--oldkey <hex>] --newkey <hex> --key0 <hex> --kv <dec>"
7236 },
7237 "hf ntag424 getfs": {
7238 "command": "hf ntag424 getfs",
7239 "description": "Read and print file settings for file",
7240 "notes": [
7241 "hf ntag424 getfs --fileno 2"
7242 ],
7243 "offline": false,
7244 "options": [
7245 "-h, --help This help",
7246 "--fileno <dec> File number"
7247 ],
7248 "usage": "hf ntag424 getfs [-h] --fileno <dec>"
7249 },
7250 "hf ntag424 help": {
7251 "command": "hf ntag424 help",
7252 "description": "help This help view Display content from tag dump file --------------------------------------------------------------------------------------- hf ntag424 info available offline: no Get info about NXP NTAG424 DNA Family styled tag.",
7253 "notes": [
7254 "hf ntag424 info"
7255 ],
7256 "offline": true,
7257 "options": [
7258 "-h, --help This help"
7259 ],
7260 "usage": "hf ntag424 info [-h]"
7261 },
7262 "hf ntag424 read": {
7263 "command": "hf ntag424 read",
7264 "description": "Read and print data from file on NTAG424 tag. Will authenticate if key information is provided.",
7265 "notes": [
7266 "hf ntag424 read --fileno 1 --keyno 0 -k 00000000000000000000000000000000 -o 0 -l 32",
7267 "hf ntag424 read --fileno 2 --keyno 0 -k 00000000000000000000000000000000 -o 0 -l 256",
7268 "hf ntag424 read --fileno 3 --keyno 3 -k 00000000000000000000000000000000 -o 0 -l 128 -m encrypt"
7269 ],
7270 "offline": false,
7271 "options": [
7272 "-h, --help This help",
7273 "--fileno <1|2|3> File number",
7274 "--keyno <dec> Key number",
7275 "-k, --key <hex> Key for authentication (HEX 16 bytes)",
7276 "-o, --offset <dec> Offset to read in file (def 0)",
7277 "-l, --length <dec> Number of bytes to read",
7278 "-m, --cmode <plain|mac|encrypt> Communication mode"
7279 ],
7280 "usage": "hf ntag424 read [-h] --fileno <1|2|3> [--keyno <dec>] [-k <hex>] [-o <dec>] -l <dec> [-m <plain|mac|encrypt>]"
7281 },
7282 "hf ntag424 view": {
7283 "command": "hf ntag424 view",
7284 "description": "Print a NTAG 424 DNA dump file (bin/eml/json)",
7285 "notes": [
7286 "hf ntag424 view -f hf-ntag424-01020304-dump.bin"
7287 ],
7288 "offline": true,
7289 "options": [
7290 "-h, --help This help",
7291 "-f, --file <fn> Specify a filename for dump file",
7292 "-v, --verbose Verbose output"
7293 ],
7294 "usage": "hf ntag424 view [-hv] -f <fn>"
7295 },
7296 "hf ntag424 write": {
7297 "command": "hf ntag424 write",
7298 "description": "Write data to file on NTAG424 tag. Will authenticate if key information is provided.",
7299 "notes": [
7300 "hf ntag424 write --fileno 2 --keyno 0 -k 00000000000000000000000000000000 -o 0 -d 1122334455667788",
7301 "hf ntag424 write --fileno 3 --keyno 3 -k 00000000000000000000000000000000 -o 0 -d 1122334455667788 -m encrypt"
7302 ],
7303 "offline": false,
7304 "options": [
7305 "-h, --help This help",
7306 "--fileno <1|2|3> File number (def 2)",
7307 "--keyno <dec> Key number",
7308 "-k, --key <hex> Key for authentication (HEX 16 bytes)",
7309 "-o, --offset <dec> Offset to write in file (def 0)",
7310 "-d, --data <hex> Data to write",
7311 "-m, --cmode <plain|mac|encrypt> Communication mode"
7312 ],
7313 "usage": "hf ntag424 write [-h] --fileno <1|2|3> [--keyno <dec>] [-k <hex>] [-o <dec>] -d <hex> [-m <plain|mac|encrypt>]"
7314 },
7315 "hf plot": {
7316 "command": "hf plot",
7317 "description": "Plots HF signal after RF signal path and A/D conversion.",
7318 "notes": [
7319 "This can be used after any hf command and will show the last few milliseconds of the HF signal.",
7320 "Note: If the last hf command terminated because of a timeout you will most probably see nothing."
7321 ],
7322 "offline": false,
7323 "options": [
7324 "-h, --help This help"
7325 ],
7326 "usage": "hf plot [-h]"
7327 },
7328 "hf search": {
7329 "command": "hf search",
7330 "description": "Will try to find a HF read out of the unknown tag. Continues to search for all different HF protocols.",
7331 "notes": [
7332 "hf search"
7333 ],
7334 "offline": true,
7335 "options": [
7336 "-h, --help This help",
7337 "-v, --verbose verbose output"
7338 ],
7339 "usage": "hf search [-hv]"
7340 },
7341 "hf seos help": {
7342 "command": "hf seos help",
7343 "description": "help This help list List SEOS history --------------------------------------------------------------------------------------- hf seos info available offline: no Get info from SEOS tags",
7344 "notes": [
7345 "hf seos info"
7346 ],
7347 "offline": true,
7348 "options": [
7349 "-h, --help This help"
7350 ],
7351 "usage": "hf seos info [-h]"
7352 },
7353 "hf seos list": {
7354 "command": "hf seos list",
7355 "description": "Alias of `trace list -t seos -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7356 "notes": [
7357 "hf seos list --frame -> show frame delay times",
7358 "hf seos list -1 -> use trace buffer"
7359 ],
7360 "offline": true,
7361 "options": [
7362 "-h, --help This help",
7363 "-1, --buffer use data from trace buffer",
7364 "--frame show frame delay times",
7365 "-c mark CRC bytes",
7366 "-r show relative times (gap and duration)",
7367 "-u display times in microseconds instead of clock cycles",
7368 "-x show hexdump to convert to pcap(ng)",
7369 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7370 "-f, --file <fn> filename of dictionary"
7371 ],
7372 "usage": "hf seos list [-h1crux] [--frame] [-f <fn>]"
7373 },
7374 "hf sniff": {
7375 "command": "hf sniff",
7376 "description": "The high frequency sniffer will assign all available memory on device for sniffed data. Use `data samples` to download from device and `data plot` to visualize it. Press button to quit the sniffing.",
7377 "notes": [
7378 "hf sniff",
7379 "hf sniff --sp 1000 --st 0 -> skip 1000 pairs, skip 0 triggers"
7380 ],
7381 "offline": false,
7382 "options": [
7383 "-h, --help This help",
7384 "--sp <dec> skip sample pairs",
7385 "--st <dec> skip number of triggers",
7386 "--smode [none|drop|min|max|avg] Skip mode. It switches on the function that applies to several samples before they saved to memory",
7387 "--sratio <dec, ms> Skip ratio. It applied the function above to (ratio * 2) samples. For ratio = 1 it 2 samples."
7388 ],
7389 "usage": "hf sniff [-h] [--sp <dec>] [--st <dec>] [--smode [none|drop|min|max|avg]] [--sratio <dec, ms>]"
7390 },
7391 "hf st25ta help": {
7392 "command": "hf st25ta help",
7393 "description": "help This help list List ISO 14443A/7816 history ndefread read NDEF file on tag --------------------------------------------------------------------------------------- hf st25ta info available offline: no Get info about ST25TA tag",
7394 "notes": [
7395 "hf st25ta info"
7396 ],
7397 "offline": true,
7398 "options": [
7399 "-h, --help This help"
7400 ],
7401 "usage": "hf st25ta info [-h]"
7402 },
7403 "hf st25ta list": {
7404 "command": "hf st25ta list",
7405 "description": "Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7406 "notes": [
7407 "hf st25ta list --frame -> show frame delay times",
7408 "hf st25ta list -1 -> use trace buffer"
7409 ],
7410 "offline": true,
7411 "options": [
7412 "-h, --help This help",
7413 "-1, --buffer use data from trace buffer",
7414 "--frame show frame delay times",
7415 "-c mark CRC bytes",
7416 "-r show relative times (gap and duration)",
7417 "-u display times in microseconds instead of clock cycles",
7418 "-x show hexdump to convert to pcap(ng)",
7419 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7420 "-f, --file <fn> filename of dictionary"
7421 ],
7422 "usage": "hf st25ta list [-h1crux] [--frame] [-f <fn>]"
7423 },
7424 "hf st25ta ndefread": {
7425 "command": "hf st25ta ndefread",
7426 "description": "Read NFC Data Exchange Format (NDEF) file on ST25TA",
7427 "notes": [
7428 "hf st25ta ndefread -p 82E80053D4CA5C0B656D852CC696C8A1",
7429 "hf st25ta ndefread -f myfilename -> save raw NDEF to file"
7430 ],
7431 "offline": true,
7432 "options": [
7433 "-h, --help This help",
7434 "-p, --pwd <hex> 16 byte read password",
7435 "-f, --file <fn> save raw NDEF to file",
7436 "-v, --verbose verbose output"
7437 ],
7438 "usage": "hf st25ta ndefread [-hv] [-p <hex>] [-f <fn>]"
7439 },
7440 "hf st25ta protect": {
7441 "command": "hf st25ta protect",
7442 "description": "Change read or write protection for NFC Data Exchange Format (NDEF) file on ST25TA",
7443 "notes": [
7444 "hf st25ta protect -p 82E80053D4CA5C0B656D852CC696C8A1 -r -e -> enable read protection",
7445 "hf st25ta protect -p 82E80053D4CA5C0B656D852CC696C8A1 -w -d -> disable write protection"
7446 ],
7447 "offline": false,
7448 "options": [
7449 "-h, --help This help",
7450 "-e, --enable enable protection",
7451 "-d, --disable disable protection (default)",
7452 "-r, --read change read protection",
7453 "-w, --write change write protection (default)",
7454 "-p, --password <hex> 16 byte write password"
7455 ],
7456 "usage": "hf st25ta protect [-hedrw] -p <hex>"
7457 },
7458 "hf st25ta pwd": {
7459 "command": "hf st25ta pwd",
7460 "description": "Change read or write password for NFC Data Exchange Format (NDEF) file on ST25TA",
7461 "notes": [
7462 "hf st25ta pwd -p 82E80053D4CA5C0B656D852CC696C8A1 -r -n 00000000000000000000000000000000 -> change read password",
7463 "hf st25ta pwd -p 82E80053D4CA5C0B656D852CC696C8A1 -w -n 00000000000000000000000000000000 -> change write password"
7464 ],
7465 "offline": false,
7466 "options": [
7467 "-h, --help This help",
7468 "-r, --read change the read password (default)",
7469 "-w, --write change the write password",
7470 "-p, --password <hex> current 16 byte write password",
7471 "-n, --new <hex> new 16 byte password"
7472 ],
7473 "usage": "hf st25ta pwd [-hrw] -p <hex> -n <hex>"
7474 },
7475 "hf st25ta sim": {
7476 "command": "hf st25ta sim",
7477 "description": "Emulating ST25TA512B tag with 7 byte UID",
7478 "notes": [
7479 "hf st25ta sim -u 02E2007D0FCA4C"
7480 ],
7481 "offline": false,
7482 "options": [
7483 "-h, --help This help",
7484 "-u, --uid <hex> 7 byte UID"
7485 ],
7486 "usage": "hf st25ta sim [-h] -u <hex>"
7487 },
7488 "hf tesla help": {
7489 "command": "hf tesla help",
7490 "description": "help This help list List ISO 14443A/7816 history --------------------------------------------------------------------------------------- hf tesla info available offline: no Get info about TESLA Key tag",
7491 "notes": [
7492 "hf tesla info"
7493 ],
7494 "offline": true,
7495 "options": [
7496 "-h, --help This help"
7497 ],
7498 "usage": "hf telsa info [-h]"
7499 },
7500 "hf tesla list": {
7501 "command": "hf tesla list",
7502 "description": "Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7503 "notes": [
7504 "hf tesla list --frame -> show frame delay times",
7505 "hf tesla list -1 -> use trace buffer"
7506 ],
7507 "offline": true,
7508 "options": [
7509 "-h, --help This help",
7510 "-1, --buffer use data from trace buffer",
7511 "--frame show frame delay times",
7512 "-c mark CRC bytes",
7513 "-r show relative times (gap and duration)",
7514 "-u display times in microseconds instead of clock cycles",
7515 "-x show hexdump to convert to pcap(ng)",
7516 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7517 "-f, --file <fn> filename of dictionary"
7518 ],
7519 "usage": "hf tesla list [-h1crux] [--frame] [-f <fn>]"
7520 },
7521 "hf texkom help": {
7522 "command": "hf texkom help",
7523 "description": "help This help --------------------------------------------------------------------------------------- hf texkom reader available offline: no Read a texkom tag",
7524 "notes": [
7525 "hf texkom reader",
7526 "hf texkom reader -@ -> continuous reader mode"
7527 ],
7528 "offline": true,
7529 "options": [
7530 "-h, --help This help",
7531 "-1 Use data from Graphbuffer (offline mode)",
7532 "-v, --verbose Verbose output",
7533 "-@ optional - continuous reader mode"
7534 ],
7535 "usage": "hf texkom reader [-h1v@]"
7536 },
7537 "hf texkom sim": {
7538 "command": "hf texkom sim",
7539 "description": "Simulate a texkom tag",
7540 "notes": [
7541 "hf texkom sim",
7542 "hf texkom sim --raw FFFF638C7DC45553 -> simulate TK13 tag with id 8C7DC455",
7543 "hf texkom sim --tk17 --raw FFFFCA17F31EC512 -> simulate TK17 tag with id 17F31EC5",
7544 "hf texkom sim --id 8C7DC455 -> simulate TK13 tag with id 8C7DC455",
7545 "hf texkom sim --id 8C7DC455 --tk17 -> simulate TK17 tag with id 17F31EC5"
7546 ],
7547 "offline": false,
7548 "options": [
7549 "-h, --help This help",
7550 "-v, --verbose Verbose output",
7551 "-t, --tk17 Use TK-17 modulation (TK-13 by default)",
7552 "--raw <hex 8 bytes> Raw data for texkom card, 8 bytes. Manual modulation select.",
7553 "--id <hex 4 bytes> Raw data for texkom card, 8 bytes. Manual modulation select.",
7554 "--timeout <dec, ms> Simulation timeout in the ms. If not specified or 0 - infinite. Command can be skipped by pressing the button"
7555 ],
7556 "usage": "hf texkom sim [-hvt] [--raw <hex 8 bytes>] [--id <hex 4 bytes>] [--timeout <dec, ms>]"
7557 },
7558 "hf thinfilm help": {
7559 "command": "hf thinfilm help",
7560 "description": "help This help list List NFC Barcode / Thinfilm history - not correct --------------------------------------------------------------------------------------- hf thinfilm info available offline: no Get info from Thinfilm tags",
7561 "notes": [
7562 "hf thinfilm info"
7563 ],
7564 "offline": true,
7565 "options": [
7566 "-h, --help This help"
7567 ],
7568 "usage": "hf thinfilm info [-h]"
7569 },
7570 "hf thinfilm list": {
7571 "command": "hf thinfilm list",
7572 "description": "Alias of `trace list -t thinfilm` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7573 "notes": [
7574 "hf thinfilm list --frame -> show frame delay times",
7575 "hf thinfilm list -1 -> use trace buffer"
7576 ],
7577 "offline": true,
7578 "options": [
7579 "-h, --help This help",
7580 "-1, --buffer use data from trace buffer",
7581 "--frame show frame delay times",
7582 "-c mark CRC bytes",
7583 "-r show relative times (gap and duration)",
7584 "-u display times in microseconds instead of clock cycles",
7585 "-x show hexdump to convert to pcap(ng)",
7586 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7587 "-f, --file <fn> filename of dictionary"
7588 ],
7589 "usage": "hf thinfilm list [-h1crux] [--frame] [-f <fn>]"
7590 },
7591 "hf thinfilm sim": {
7592 "command": "hf thinfilm sim",
7593 "description": "Simulate Thinfilm tag",
7594 "notes": [
7595 "hf thinfilm sim -d B70470726f786d61726b2e636f6d"
7596 ],
7597 "offline": false,
7598 "options": [
7599 "-h, --help This help",
7600 "-d, --data <hex> bytes to send",
7601 "--raw raw, provided bytes should include CRC"
7602 ],
7603 "usage": "hf thinfilm sim [-h] -d <hex> [--raw]"
7604 },
7605 "hf topaz dump": {
7606 "command": "hf topaz dump",
7607 "description": "Dump TOPAZ tag to file (bin/json) If no <name> given, UID will be used as filename",
7608 "notes": [
7609 "hf topaz dump"
7610 ],
7611 "offline": false,
7612 "options": [
7613 "-h, --help This help",
7614 "-f, --file <fn> Specify a filename for dump file",
7615 "--ns no save to file"
7616 ],
7617 "usage": "hf topaz dump [-h] [-f <fn>] [--ns]"
7618 },
7619 "hf topaz help": {
7620 "command": "hf topaz help",
7621 "description": "help This help list List Topaz history view Display content from tag dump file --------------------------------------------------------------------------------------- hf topaz list available offline: yes Alias of `trace list -t topaz -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7622 "notes": [
7623 "hf topaz list --frame -> show frame delay times",
7624 "hf topaz list -1 -> use trace buffer"
7625 ],
7626 "offline": true,
7627 "options": [
7628 "-h, --help This help",
7629 "-1, --buffer use data from trace buffer",
7630 "--frame show frame delay times",
7631 "-c mark CRC bytes",
7632 "-r show relative times (gap and duration)",
7633 "-u display times in microseconds instead of clock cycles",
7634 "-x show hexdump to convert to pcap(ng)",
7635 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7636 "-f, --file <fn> filename of dictionary"
7637 ],
7638 "usage": "hf topaz list [-h1crux] [--frame] [-f <fn>]"
7639 },
7640 "hf topaz info": {
7641 "command": "hf topaz info",
7642 "description": "Get info from Topaz tags",
7643 "notes": [
7644 "hf topaz info",
7645 "hf topaz info -f myfilename -> save raw NDEF to file"
7646 ],
7647 "offline": false,
7648 "options": [
7649 "-h, --help This help",
7650 "-f, --file <fn> save raw NDEF to file",
7651 "-v, --verbose verbose output"
7652 ],
7653 "usage": "hf topaz info [-hv] [-f <fn>]"
7654 },
7655 "hf topaz raw": {
7656 "command": "hf topaz raw",
7657 "description": "Send raw hex data to Topaz tags",
7658 "notes": [
7659 "hf topaz raw"
7660 ],
7661 "offline": false,
7662 "options": [
7663 "-h, --help This help"
7664 ],
7665 "usage": "hf topaz raw [-h]"
7666 },
7667 "hf topaz rdbl": {
7668 "command": "hf topaz rdbl",
7669 "description": "Read Topaz block",
7670 "notes": [
7671 "hf topaz rdbl --blk 7"
7672 ],
7673 "offline": false,
7674 "options": [
7675 "-h, --help This help",
7676 "--blk <dec> Block number"
7677 ],
7678 "usage": "hf topaz rdbl [-h] --blk <dec>"
7679 },
7680 "hf topaz reader": {
7681 "command": "hf topaz reader",
7682 "description": "Read UID from Topaz tags",
7683 "notes": [
7684 "hf topaz reader",
7685 "hf topaz reader -@ -> Continuous mode"
7686 ],
7687 "offline": false,
7688 "options": [
7689 "-h, --help This help",
7690 "-v, --verbose verbose output",
7691 "-@ optional - continuous reader mode"
7692 ],
7693 "usage": "hf topaz reader [-hv@]"
7694 },
7695 "hf topaz sim": {
7696 "command": "hf topaz sim",
7697 "description": "Simulate a Topaz tag",
7698 "notes": [
7699 "hf topaz sim -> Not yet implemented"
7700 ],
7701 "offline": false,
7702 "options": [
7703 "-h, --help This help"
7704 ],
7705 "usage": "hf topaz sim [-h]"
7706 },
7707 "hf topaz sniff": {
7708 "command": "hf topaz sniff",
7709 "description": "Sniff Topaz reader-tag communication",
7710 "notes": [
7711 "hf topaz sniff"
7712 ],
7713 "offline": false,
7714 "options": [
7715 "-h, --help This help"
7716 ],
7717 "usage": "hf topaz sniff [-h]"
7718 },
7719 "hf topaz view": {
7720 "command": "hf topaz view",
7721 "description": "Print a Topaz tag dump file (bin/eml/json)",
7722 "notes": [
7723 "hf topaz view -f hf-topaz-04010203-dump.bin"
7724 ],
7725 "offline": true,
7726 "options": [
7727 "-h, --help This help",
7728 "-f, --file <fn> Specify a filename for dump file"
7729 ],
7730 "usage": "hf topaz view [-h] -f <fn>"
7731 },
7732 "hf topaz wrbl": {
7733 "command": "hf topaz wrbl",
7734 "description": "Write Topaz block with 8 hex bytes of data",
7735 "notes": [
7736 "hf topaz wrbl --blk 7 -d 1122334455667788"
7737 ],
7738 "offline": false,
7739 "options": [
7740 "-h, --help This help",
7741 "--blk <dec> Block number",
7742 "-d, --data <hex> Block data (8 hex bytes)"
7743 ],
7744 "usage": "hf topaz wrbl [-h] --blk <dec> -d <hex>"
7745 },
7746 "hf tune": {
7747 "command": "hf tune",
7748 "description": "Continuously measure HF antenna tuning. Press pm3 button or <Enter> to interrupt.",
7749 "notes": [
7750 "hf tune",
7751 "hf tune --mix"
7752 ],
7753 "offline": false,
7754 "options": [
7755 "-h, --help This help",
7756 "-n, --iter <dec> number of iterations (default: 0=infinite)",
7757 "--bar bar style",
7758 "--mix mixed style",
7759 "--value values style",
7760 "-v, --verbose verbose output"
7761 ],
7762 "usage": "hf tune [-hv] [-n <dec>] [--bar] [--mix] [--value]"
7763 },
7764 "hf vas decrypt": {
7765 "command": "hf vas decrypt",
7766 "description": "Decrypt a previously captured cryptogram",
7767 "notes": [
7768 "hf vas decrypt --pid pass.com.passkit.pksamples.nfcdemo -f vas_privkey.der -d c0b77375eae416b79449347f9fe838c05cdb57dc7470b97b93b806cb348771d9bfbe29d58538c7c7d7c3d015fa205b68bfccd726058a62f7f44085ac98dbf877120fd9059f1507b956e0a6d56d0a"
7769 ],
7770 "offline": true,
7771 "options": [
7772 "-h, --help This help",
7773 "--pid <str> PID, pass type id",
7774 "-f, --file <fn> path to terminal private key file",
7775 "-d, --data <hex> cryptogram to decrypt"
7776 ],
7777 "usage": "hf vas decrypt [-h] [--pid <str>] [-f <fn>] [-d <hex>]"
7778 },
7779 "hf vas help": {
7780 "command": "hf vas help",
7781 "description": "-------- ----------- Value Added Service ----------- help This help -------- ----------------- General ----------------- decrypt Decrypt a previously captured VAS cryptogram --------------------------------------------------------------------------------------- hf vas reader available offline: no Read and decrypt Value Added Services (VAS) message",
7782 "notes": [
7783 "hf vas reader --url https://example.com -> URL Only mode",
7784 "hf vas reader --pid pass.com.passkit.pksamples.nfcdemo -f vas_privkey.der -@"
7785 ],
7786 "offline": true,
7787 "options": [
7788 "-h, --help This help",
7789 "--pid <str> PID, pass type id",
7790 "-f, --file <fn> path to terminal private key file",
7791 "--url <str> a URL to provide to the mobile device",
7792 "-@ continuous mode",
7793 "-v, --verbose Verbose output"
7794 ],
7795 "usage": "hf vas reader [-h@v] [--pid <str>] [-f <fn>] [--url <str>]"
7796 },
7797 "hf waveshare help": {
7798 "command": "hf waveshare help",
7799 "description": "help This help load Load image file to Waveshare NFC ePaper --------------------------------------------------------------------------------------- hf waveshare load available offline: yes Load image file to Waveshare NFC ePaper",
7800 "notes": [
7801 "hf waveshare load -f myfile -m 0 -> 2.13 inch e-paper ( 122, 250 )",
7802 "hf waveshare load -f myfile -m 1 -> 2.9 inch e-paper ( 296, 128 )",
7803 "hf waveshare load -f myfile -m 2 -> 4.2 inch e-paper ( 400, 300 )",
7804 "hf waveshare load -f myfile -m 3 -> 7.5 inch e-paper ( 800, 480 )",
7805 "hf waveshare load -f myfile -m 4 -> 2.7 inch e-paper ( 176, 276 )",
7806 "hf waveshare load -f myfile -m 5 -> 2.13 inch e-paper B (with red) ( 104, 212 )",
7807 "hf waveshare load -f myfile -m 6 -> 1.54 inch e-paper B (with red) ( 200, 200 )",
7808 "hf waveshare load -f myfile -m 7 -> 7.5 inch e-paper HD ( 880, 528 )"
7809 ],
7810 "offline": true,
7811 "options": [
7812 "-h, --help This help",
7813 "-m <nr> model number [0 - 7] of your tag",
7814 "-f, --file <fn> specify image to upload to tag",
7815 "-s, --save <fn> save paletized version in file"
7816 ],
7817 "usage": "hf waveshare load [-h] -m <nr> -f <fn> [-s <fn>]"
7818 },
7819 "hf xerox dump": {
7820 "command": "hf xerox dump",
7821 "description": "Dump all memory from a Fuji/Xerox tag ISO/IEC 14443 type B based communications",
7822 "notes": [
7823 "hf xerox dump"
7824 ],
7825 "offline": false,
7826 "options": [
7827 "-h, --help This help",
7828 "-f, --file <fn> filename to save dump to",
7829 "-d, --decrypt decrypt secret blocks",
7830 "--ns no save to file",
7831 "-v, --verbose verbose output",
7832 "-z, --dense dense dump output style"
7833 ],
7834 "usage": "hf xerox dump [-hdvz] [-f <fn>] [--ns]"
7835 },
7836 "hf xerox help": {
7837 "command": "hf xerox help",
7838 "description": "help This help list List ISO-14443B history -------- ----------------------- General ----------------------- view Display content from tag dump file --------------------------------------------------------------------------------------- hf xerox list available offline: yes Alias of `trace list -t 14b -c` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
7839 "notes": [
7840 "hf 14b list --frame -> show frame delay times",
7841 "hf 14b list -1 -> use trace buffer"
7842 ],
7843 "offline": true,
7844 "options": [
7845 "-h, --help This help",
7846 "-1, --buffer use data from trace buffer",
7847 "--frame show frame delay times",
7848 "-c mark CRC bytes",
7849 "-r show relative times (gap and duration)",
7850 "-u display times in microseconds instead of clock cycles",
7851 "-x show hexdump to convert to pcap(ng)",
7852 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
7853 "-f, --file <fn> filename of dictionary"
7854 ],
7855 "usage": "hf 14b list [-h1crux] [--frame] [-f <fn>]"
7856 },
7857 "hf xerox info": {
7858 "command": "hf xerox info",
7859 "description": "Tag information for Fuji Xerox based tags ISO/IEC 14443 type B based communications",
7860 "notes": [
7861 "hf xerox info"
7862 ],
7863 "offline": false,
7864 "options": [
7865 "-h, --help This help",
7866 "-v, --verbose verbose output"
7867 ],
7868 "usage": "hf xerox info [-hv]"
7869 },
7870 "hf xerox rdbl": {
7871 "command": "hf xerox rdbl",
7872 "description": "Read a Fuji/Xerox tag block",
7873 "notes": [
7874 "hf xerox rdbl -b 1"
7875 ],
7876 "offline": false,
7877 "options": [
7878 "-h, --help This help",
7879 "-b, --blk <dec> page number (0-255)"
7880 ],
7881 "usage": "hf xerox rdbl [-h] -b <dec>"
7882 },
7883 "hf xerox reader": {
7884 "command": "hf xerox reader",
7885 "description": "Act as a 14443B reader to identify a Fuji Xerox based tag ISO/IEC 14443 type B based communications",
7886 "notes": [
7887 "hf xerox reader",
7888 "hf xerox reader -@"
7889 ],
7890 "offline": false,
7891 "options": [
7892 "-h, --help This help",
7893 "-v, --verbose verbose output",
7894 "-@ optional - continuous reader mode"
7895 ],
7896 "usage": "hf xerox reader [-hv@]"
7897 },
7898 "hf xerox view": {
7899 "command": "hf xerox view",
7900 "description": "Print a Fuji/Xerox dump file (bin/eml/json) note: - command expects the filename to contain a UID which is needed to determine card memory type",
7901 "notes": [
7902 "hf xerox view -f hf-xerox-0102030405060708-dump.bin"
7903 ],
7904 "offline": true,
7905 "options": [
7906 "-h, --help This help",
7907 "-f, --file <fn> Specify a filename for dump file",
7908 "-v, --verbose verbose output",
7909 "-z, --dense dense dump output style"
7910 ],
7911 "usage": "hf xerox view [-hvz] -f <fn>"
7912 },
7913 "hints": {
7914 "command": "hints",
7915 "description": "Turn on/off hints",
7916 "notes": [
7917 "hints --on",
7918 "hints -1"
7919 ],
7920 "offline": true,
7921 "options": [
7922 "-h, --help This help",
7923 "-1, --on turn on hints",
7924 "-0, --off turn off hints"
7925 ],
7926 "usage": "hints [-h10]"
7927 },
7928 "hw bootloader": {
7929 "command": "hw bootloader",
7930 "description": "Reboot Proxmark3 into bootloader mode",
7931 "notes": [
7932 "hw bootloader"
7933 ],
7934 "offline": false,
7935 "options": [
7936 "-h, --help This help"
7937 ],
7938 "usage": "hw bootloader [-h]"
7939 },
7940 "hw break": {
7941 "command": "hw break",
7942 "description": "send break loop package",
7943 "notes": [
7944 "hw break"
7945 ],
7946 "offline": false,
7947 "options": [
7948 "-h, --help This help"
7949 ],
7950 "usage": "hw break [-h]"
7951 },
7952 "hw connect": {
7953 "command": "hw connect",
7954 "description": "Connects to a Proxmark3 device via specified serial port. Baudrate here is only for physical UART or UART-BT, NOT for USB-CDC or blue shark add-on",
7955 "notes": [
7956 "hw connect -p /dev/ttyACM0",
7957 "hw connect -p /dev/ttyACM0 -b 115200"
7958 ],
7959 "offline": true,
7960 "options": [
7961 "-h, --help This help",
7962 "-p, --port <string> Serial port to connect to, else retry the last used one",
7963 "-b, --baud <dec> Baudrate"
7964 ],
7965 "usage": "hw connect [-h] [-p <string>] [-b <dec>]"
7966 },
7967 "hw dbg": {
7968 "command": "hw dbg",
7969 "description": "Set device side debug level output. Note: option `-4`, this option may cause malfunction itself by introducing delays in time critical functions like simulation or sniffing",
7970 "notes": [
7971 "hw dbg -> get current log level",
7972 "hw dbg -1 -> set log level to _error_"
7973 ],
7974 "offline": false,
7975 "options": [
7976 "-h, --help This help",
7977 "-0 no debug messages",
7978 "-1 error messages",
7979 "-2 plus information messages",
7980 "-3 plus debug messages",
7981 "-4 print even debug messages in timing critical functions"
7982 ],
7983 "usage": "hw dbg [-h01234]"
7984 },
7985 "hw fpgaoff": {
7986 "command": "hw fpgaoff",
7987 "description": "Turn of fpga and antenna field",
7988 "notes": [
7989 "hw fpgaoff"
7990 ],
7991 "offline": false,
7992 "options": [
7993 "-h, --help This help"
7994 ],
7995 "usage": "hw fpgaoff [-h]"
7996 },
7997 "hw help": {
7998 "command": "hw help",
7999 "description": "help This help ------------- ----------------------- Operation ----------------------- timeout Set the communication timeout on the client side version Show version information about the client and Proxmark3 ------------- ----------------------- Hardware ----------------------- connect Connect to the device via serial port --------------------------------------------------------------------------------------- hw detectreader available offline: no Start to detect presences of reader field",
8000 "notes": [
8001 "hw detectreader",
8002 "hw detectreader -L"
8003 ],
8004 "offline": true,
8005 "options": [
8006 "-h, --help This help",
8007 "-L, --LF only detect low frequency 125/134 kHz",
8008 "-H, --HF only detect high frequency 13.56 MHZ"
8009 ],
8010 "usage": "hw detectreader [-hLH]"
8011 },
8012 "hw lcd": {
8013 "command": "hw lcd",
8014 "description": "Send command/data to LCD",
8015 "notes": [
8016 "hw lcd -r AA -c 03 -> sends 0xAA three times"
8017 ],
8018 "offline": false,
8019 "options": [
8020 "-h, --help This help",
8021 "-r, --raw <hex> data",
8022 "-c, --cnt <dec> number of times to send"
8023 ],
8024 "usage": "hw lcd [-h] -r <hex> -c <dec>"
8025 },
8026 "hw lcdreset": {
8027 "command": "hw lcdreset",
8028 "description": "Hardware reset LCD",
8029 "notes": [
8030 "hw lcdreset"
8031 ],
8032 "offline": false,
8033 "options": [
8034 "-h, --help This help"
8035 ],
8036 "usage": "hw lcdreset [-h]"
8037 },
8038 "hw ping": {
8039 "command": "hw ping",
8040 "description": "Test if the Proxmark3 is responsive",
8041 "notes": [
8042 "hw ping",
8043 "hw ping --len 32"
8044 ],
8045 "offline": false,
8046 "options": [
8047 "-h, --help This help",
8048 "-l, --len <dec> length of payload to send"
8049 ],
8050 "usage": "hw ping [-h] [-l <dec>]"
8051 },
8052 "hw readmem": {
8053 "command": "hw readmem",
8054 "description": "Reads processor flash memory into a file or views on console",
8055 "notes": [
8056 "hw readmem -f myfile -> save 512KB processor flash memory to file",
8057 "hw readmem -a 8192 -l 512 -> display 512 bytes from offset 8192"
8058 ],
8059 "offline": false,
8060 "options": [
8061 "-h, --help This help",
8062 "-a, --adr <dec> flash address to start reading from",
8063 "-l, --len <dec> length (default 32 or 512KB)",
8064 "-f, --file <fn> save to file",
8065 "-c, --cols <dec> column breaks",
8066 "-r, --raw use raw address mode: read from anywhere, not just flash"
8067 ],
8068 "usage": "hw readmem [-hr] [-a <dec>] [-l <dec>] [-f <fn>] [-c <dec>]"
8069 },
8070 "hw reset": {
8071 "command": "hw reset",
8072 "description": "Reset the Proxmark3 device.",
8073 "notes": [
8074 "hw reset"
8075 ],
8076 "offline": false,
8077 "options": [
8078 "-h, --help This help"
8079 ],
8080 "usage": "hw reset [-h]"
8081 },
8082 "hw sethfthresh": {
8083 "command": "hw sethfthresh",
8084 "description": "Set thresholds in HF/14a and Legic mode.",
8085 "notes": [
8086 "hw sethfthresh -t 7 -i 20 -l 8"
8087 ],
8088 "offline": false,
8089 "options": [
8090 "-h, --help This help",
8091 "-t, --thresh <dec> threshold, used in 14a reader mode (def 7)",
8092 "-i, --high <dec> high threshold, used in 14a sniff mode (def 20)",
8093 "-l, --legic <dec> threshold used in Legic mode (def 8)"
8094 ],
8095 "usage": "hw sethfthresh [-h] [-t <dec>] [-i <dec>] [-l <dec>]"
8096 },
8097 "hw setlfdivisor": {
8098 "command": "hw setlfdivisor",
8099 "description": "Drive LF antenna at 12 MHz / (divisor + 1).",
8100 "notes": [
8101 "hw setlfdivisor -d 88"
8102 ],
8103 "offline": false,
8104 "options": [
8105 "-h, --help This help",
8106 "-d, --div <dec> 19 - 255 divisor value (def 95)"
8107 ],
8108 "usage": "hw setlfdivisor [-h] -d <dec>"
8109 },
8110 "hw setmux": {
8111 "command": "hw setmux",
8112 "description": "Set the ADC mux to a specific value",
8113 "notes": [
8114 "hw setmux --hipkd -> set HIGH PEAK"
8115 ],
8116 "offline": false,
8117 "options": [
8118 "-h, --help This help",
8119 "--lopkd low peak",
8120 "--loraw low raw",
8121 "--hipkd high peak",
8122 "--hiraw high raw"
8123 ],
8124 "usage": "hw setmux [-h] [--lopkd] [--loraw] [--hipkd] [--hiraw]"
8125 },
8126 "hw standalone": {
8127 "command": "hw standalone",
8128 "description": "Start standalone mode",
8129 "notes": [
8130 "hw standalone -> start",
8131 "hw standalone -a 1 -> start and send arg 1"
8132 ],
8133 "offline": false,
8134 "options": [
8135 "-h, --help This help",
8136 "-a, --arg <dec> argument byte",
8137 "-b <str> UniSniff arg: 14a, 14b, 15, iclass"
8138 ],
8139 "usage": "hw standalone [-h] [-a <dec>] [-b <str>]"
8140 },
8141 "hw status": {
8142 "command": "hw status",
8143 "description": "Show runtime status information about the connected Proxmark3",
8144 "notes": [
8145 "hw status",
8146 "hw status --ms 1000 -> Test connection speed with 1000ms timeout"
8147 ],
8148 "offline": false,
8149 "options": [
8150 "-h, --help This help",
8151 "-m, --ms <ms> speed test timeout in micro seconds"
8152 ],
8153 "usage": "hw status [-h] [-m <ms>]"
8154 },
8155 "hw tearoff": {
8156 "command": "hw tearoff",
8157 "description": "Configure a tear-off hook for the next write command supporting tear-off After having been triggered by a write command, the tear-off hook is deactivated Delay (in us) must be between 1 and 43000 (43ms). Precision is about 1/3us.",
8158 "notes": [
8159 "hw tearoff --delay 1200 -> define delay of 1200us",
8160 "hw tearoff --on -> (re)activate a previously defined delay",
8161 "hw tearoff --off -> deactivate a previously activated but not yet triggered hook"
8162 ],
8163 "offline": false,
8164 "options": [
8165 "-h, --help This help",
8166 "--delay <dec> Delay in us before triggering tear-off, must be between 1 and 43000",
8167 "--on Activate tear-off hook",
8168 "--off Deactivate tear-off hook",
8169 "-s, --silent less verbose output"
8170 ],
8171 "usage": "hw tearoff [-hs] [--delay <dec>] [--on] [--off]"
8172 },
8173 "hw tia": {
8174 "command": "hw tia",
8175 "description": "Trigger a Timing Interval Acquisition to re-adjust the RealTimeCounter divider",
8176 "notes": [
8177 "hw tia"
8178 ],
8179 "offline": false,
8180 "options": [
8181 "-h, --help This help"
8182 ],
8183 "usage": "hw tia [-h]"
8184 },
8185 "hw timeout": {
8186 "command": "hw timeout",
8187 "description": "Set the communication timeout on the client side",
8188 "notes": [
8189 "hw timeout -> Show current timeout",
8190 "hw timeout -m 20 -> Set the timeout to 20ms",
8191 "hw timeout --ms 500 -> Set the timeout to 500ms"
8192 ],
8193 "offline": true,
8194 "options": [
8195 "-h, --help This help",
8196 "-m, --ms <ms> timeout in micro seconds"
8197 ],
8198 "usage": "hw timeout [-h] [-m <ms>]"
8199 },
8200 "hw tune": {
8201 "command": "hw tune",
8202 "description": "Measure tuning of device antenna. Results shown in graph window. This command doesn't actively tune your antennas, it's only informative by measuring voltage that the antennas will generate",
8203 "notes": [
8204 "hw tune"
8205 ],
8206 "offline": false,
8207 "options": [
8208 "-h, --help This help"
8209 ],
8210 "usage": "hw tune [-h]"
8211 },
8212 "hw version": {
8213 "command": "hw version",
8214 "description": "Show version information about the client and the connected Proxmark3",
8215 "notes": [
8216 "hw version"
8217 ],
8218 "offline": true,
8219 "options": [
8220 "-h, --help This help"
8221 ],
8222 "usage": "hw version [-h]"
8223 },
8224 "lf awid brute": {
8225 "command": "lf awid brute",
8226 "description": "Enables bruteforce of AWID reader with specified facility-code. This is a attack against reader. if cardnumber is given, it starts with it and goes up / down one step if cardnumber is not given, it starts with 1 and goes up to 65535",
8227 "notes": [
8228 "lf awid brute --fmt 26 --fc 224",
8229 "lf awid brute --fmt 50 --fc 2001 --delay 2000",
8230 "lf awid brute --fmt 50 --fc 2001 --cn 200 --delay 2000 -v"
8231 ],
8232 "offline": false,
8233 "options": [
8234 "-h, --help This help",
8235 "--fmt <dec> format length 26|50",
8236 "--fc <dec> 8|16bit value facility code",
8237 "--cn <dec> optional - card number to start with, max 65535",
8238 "--delay <dec> optional - delay betweens attempts in ms. Default 1000ms",
8239 "-v, --verbose verbose output"
8240 ],
8241 "usage": "lf awid brute [-hv] --fmt <dec> --fc <dec> [--cn <dec>] [--delay <dec>]"
8242 },
8243 "lf awid clone": {
8244 "command": "lf awid clone",
8245 "description": "clone a AWID Prox tag to a T55x7, Q5/T5555 or EM4305/4469 tag",
8246 "notes": [
8247 "lf awid clone --fmt 26 --fc 123 --cn 1337 -> encode for T55x7 tag",
8248 "lf awid clone --fmt 50 --fc 2001 --cn 13371337 -> encode long fmt for T55x7 tag",
8249 "lf awid clone --fmt 26 --fc 123 --cn 1337 --q5 -> encode for Q5/T5555 tag",
8250 "lf awid clone --fmt 26 --fc 123 --cn 1337 --em -> encode for EM4305/4469"
8251 ],
8252 "offline": false,
8253 "options": [
8254 "-h, --help This help",
8255 "--fmt <dec> format length 26|34|37|50",
8256 "--fc <dec> 8|16bit value facility code",
8257 "--cn <dec> 16|32-bit value card number",
8258 "--q5 optional - specify writing to Q5/T5555 tag",
8259 "--em optional - specify writing to EM4305/4469 tag"
8260 ],
8261 "usage": "lf awid clone [-h] --fmt <dec> --fc <dec> --cn <dec> [--q5] [--em]"
8262 },
8263 "lf awid demod": {
8264 "command": "lf awid demod",
8265 "description": "Try to find AWID Prox preamble, if found decode / descramble data",
8266 "notes": [
8267 "lf awid demod",
8268 "lf awid demod --raw"
8269 ],
8270 "offline": true,
8271 "options": [
8272 "-h, --help This help"
8273 ],
8274 "usage": "lf awid demod [-h]"
8275 },
8276 "lf awid help": {
8277 "command": "lf awid help",
8278 "description": "help this help demod demodulate an AWID FSK tag from the GraphBuffer --------------------------------------------------------------------------------------- lf awid brute available offline: no Enables bruteforce of AWID reader with specified facility-code. This is a attack against reader. if cardnumber is given, it starts with it and goes up / down one step if cardnumber is not given, it starts with 1 and goes up to 65535",
8279 "notes": [
8280 "lf awid brute --fmt 26 --fc 224",
8281 "lf awid brute --fmt 50 --fc 2001 --delay 2000",
8282 "lf awid brute --fmt 50 --fc 2001 --cn 200 --delay 2000 -v"
8283 ],
8284 "offline": true,
8285 "options": [
8286 "-h, --help This help",
8287 "--fmt <dec> format length 26|50",
8288 "--fc <dec> 8|16bit value facility code",
8289 "--cn <dec> optional - card number to start with, max 65535",
8290 "--delay <dec> optional - delay betweens attempts in ms. Default 1000ms",
8291 "-v, --verbose verbose output"
8292 ],
8293 "usage": "lf awid brute [-hv] --fmt <dec> --fc <dec> [--cn <dec>] [--delay <dec>]"
8294 },
8295 "lf awid reader": {
8296 "command": "lf awid reader",
8297 "description": "read a AWID Prox tag",
8298 "notes": [
8299 "lf awid reader -@ -> continuous reader mode"
8300 ],
8301 "offline": false,
8302 "options": [
8303 "-h, --help This help",
8304 "-@ optional - continuous reader mode"
8305 ],
8306 "usage": "lf awid reader [-h@]"
8307 },
8308 "lf awid sim": {
8309 "command": "lf awid sim",
8310 "description": "Enables simulation of AWID card with specified facility-code and card number. Simulation runs until the button is pressed or another USB command is issued.",
8311 "notes": [
8312 "lf awid sim --fmt 26 --fc 123 --cn 1337",
8313 "lf awid sim --fmt 50 --fc 2001 --cn 13371337"
8314 ],
8315 "offline": false,
8316 "options": [
8317 "-h, --help This help",
8318 "--fmt <dec> format length 26|32|36|40",
8319 "--fc <dec> 8-bit value facility code",
8320 "--cn <dec> 16-bit value card number"
8321 ],
8322 "usage": "lf awid sim [-h] --fmt <dec> --fc <dec> --cn <dec>"
8323 },
8324 "lf awid watch": {
8325 "command": "lf awid watch",
8326 "description": "Enables AWID compatible reader mode printing details of scanned AWID26 or AWID50 tags. Run until the button is pressed or another USB command is issued.",
8327 "notes": [
8328 "lf awid watch"
8329 ],
8330 "offline": false,
8331 "options": [
8332 "-h, --help This help"
8333 ],
8334 "usage": "lf awid watch [-h]"
8335 },
8336 "lf cmdread": {
8337 "command": "lf cmdread",
8338 "description": "Modulate LF reader field to send command before read. All periods in microseconds. - use `lf config` to set parameters",
8339 "notes": [
8340 "lf cmdread -d 50 -z 116 -o 166 -e W3000 -c W00110 -> probing for Hitag1/S",
8341 "lf cmdread -d 50 -z 116 -o 166 -e W3000 -c W11000 -> probing for Hitag2",
8342 "lf cmdread -d 50 -z 116 -o 166 -e W3000 -c W11000 -s 2000 -@ -> probing for Hitag2, oscilloscope style",
8343 "lf cmdread -d 48 -z 112 -o 176 -e W3000 -e S240 -e E336 -c W0S00000010000E -> probing for Hitag (us)"
8344 ],
8345 "offline": false,
8346 "options": [
8347 "-h, --help This help",
8348 "-d, --duration <us> delay OFF period, (0 for bitbang mode)",
8349 "-c, --cmd <0|1|...> command symbols",
8350 "-e, --extra <us> Extra symbol definition and duration (up to 4)",
8351 "-o, --one <us> ONE time period",
8352 "-z, --zero <us> ZERO time period",
8353 "-s, --samples <dec> number of samples to collect",
8354 "-v, --verbose verbose output",
8355 "-k, --keep keep signal field ON after receive",
8356 "--crc-ht calculate and append CRC-8/HITAG (also for ZX8211)",
8357 "-@ continuous mode"
8358 ],
8359 "usage": "lf cmdread [-hvk@] [-d <us>] [-c <0|1|...>] [-e <us>]... [-o <us>] [-z <us>] [-s <dec>] [--crc-ht]"
8360 },
8361 "lf cotag help": {
8362 "command": "lf cotag help",
8363 "description": "help This help demod demodulate an COTAG tag --------------------------------------------------------------------------------------- lf cotag demod available offline: yes Try to find COTAG preamble, if found decode / descramble data",
8364 "notes": [
8365 "lf cotag demod"
8366 ],
8367 "offline": true,
8368 "options": [
8369 "-h, --help This help",
8370 "-v, --verbose verbose output"
8371 ],
8372 "usage": "lf cotag demod [-hv]"
8373 },
8374 "lf cotag reader": {
8375 "command": "lf cotag reader",
8376 "description": "read a COTAG tag, the current support for COTAG is limited.",
8377 "notes": [
8378 "lf cotag reader -2"
8379 ],
8380 "offline": false,
8381 "options": [
8382 "-h, --help This help",
8383 "-1 HIGH/LOW signal; maxlength bigbuff",
8384 "-2 translation of HIGH/LOW into bytes with manchester 0,1",
8385 "-3 raw signal; maxlength bigbuff"
8386 ],
8387 "usage": "lf cotag reader [-h123]"
8388 },
8389 "lf destron clone": {
8390 "command": "lf destron clone",
8391 "description": "clone a Destron tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
8392 "notes": [
8393 "lf destron clone --uid 1A2B3C4D5E",
8394 "lf destron clone --q5 --uid 1A2B3C4D5E -> encode for Q5/T5555 tag",
8395 "lf destron clone --em --uid 1A2B3C4D5E -> encode for EM4305/4469"
8396 ],
8397 "offline": false,
8398 "options": [
8399 "-h, --help This help",
8400 "-u, --uid <hex> 5 bytes max",
8401 "--q5 optional - specify writing to Q5/T5555 tag",
8402 "--em optional - specify writing to EM4305/4469 tag"
8403 ],
8404 "usage": "lf destron clone [-h] -u <hex> [--q5] [--em]"
8405 },
8406 "lf destron help": {
8407 "command": "lf destron help",
8408 "description": "help This help demod demodulate an Destron tag from the GraphBuffer --------------------------------------------------------------------------------------- lf destron demod available offline: yes Try to find Destron preamble, if found decode / descramble data",
8409 "notes": [
8410 "lf destron demod"
8411 ],
8412 "offline": true,
8413 "options": [
8414 "-h, --help This help"
8415 ],
8416 "usage": "lf destron demod [-h]"
8417 },
8418 "lf destron reader": {
8419 "command": "lf destron reader",
8420 "description": "read a Destron tag",
8421 "notes": [
8422 "lf destron reader -@ -> continuous reader mode"
8423 ],
8424 "offline": false,
8425 "options": [
8426 "-h, --help This help",
8427 "-@ optional - continuous reader mode"
8428 ],
8429 "usage": "lf destron reader [-h@]"
8430 },
8431 "lf destron sim": {
8432 "command": "lf destron sim",
8433 "description": "Try to find Destron preamble, if found decode / descramble data",
8434 "notes": [
8435 "lf destron sim"
8436 ],
8437 "offline": false,
8438 "options": [
8439 "-h, --help This help"
8440 ],
8441 "usage": "lf destron sim [-h]"
8442 },
8443 "lf em 410x brute": {
8444 "command": "lf em 410x brute",
8445 "description": "bruteforcing by emulating EM 410x tag",
8446 "notes": [
8447 "lf em 410x brute -f ids.txt",
8448 "lf em 410x brute -f ids.txt --clk 32",
8449 "lf em 410x brute -f ids.txt --delay 3000",
8450 "lf em 410x brute -f ids.txt --delay 3000 --clk 32"
8451 ],
8452 "offline": false,
8453 "options": [
8454 "-h, --help This help",
8455 "--clk <dec> <32|64> clock (default 64)",
8456 "--delay <dec> pause delay in milliseconds between UIDs simulation (default 1000ms)",
8457 "-f, --file <hex> file with EM Tag IDs, one id per line",
8458 "--gap <dec> gap (0's) between ID repeats (default 20)"
8459 ],
8460 "usage": "lf em 410x brute [-h] [--clk <dec>] [--delay <dec>] -f <hex> [--gap <dec>]"
8461 },
8462 "lf em 410x clone": {
8463 "command": "lf em 410x clone",
8464 "description": "clone a EM410x ID to a T55x7, Q5/T5555 or EM4305/4469 tag.",
8465 "notes": [
8466 "lf em 410x clone --id 0F0368568B -> encode for T55x7 tag",
8467 "lf em 410x clone --id 0F0368568B --q5 -> encode for Q5/T5555 tag",
8468 "lf em 410x clone --id 0F0368568B --em -> encode for EM4305/4469"
8469 ],
8470 "offline": false,
8471 "options": [
8472 "-h, --help This help",
8473 "--clk <dec> <16|32|40|64> clock (default 64)",
8474 "--id <hex> EM Tag ID number (5 hex bytes)",
8475 "--q5 optional - specify writing to Q5/T5555 tag",
8476 "--em optional - specify writing to EM4305/4469 tag",
8477 "--electra optional - add Electra blocks to tag"
8478 ],
8479 "usage": "lf em 410x clone [-h] [--clk <dec>] --id <hex> [--q5] [--em] [--electra]"
8480 },
8481 "lf em 410x reader": {
8482 "command": "lf em 410x reader",
8483 "description": "read EM 410x tag",
8484 "notes": [
8485 "lf em 410x reader",
8486 "lf em 410x reader -@ -> continuous reader mode",
8487 "lf em 410x reader --clk 32 -> using a clock of RF/32",
8488 "lf em 410x reader --clk 32 -i -> using a clock of RF/32 and inverting data",
8489 "lf em 410x reader -i -> inverting data",
8490 "lf em 410x reader --clk 64 -i --err 0 -> using a clock of RF/64 and inverting data and allowing 0 demod errors"
8491 ],
8492 "offline": false,
8493 "options": [
8494 "-h, --help This help",
8495 "--clk <dec> clock (default autodetect)",
8496 "--err <dec> maximum allowed errors (default 100)",
8497 "--len <dec> maximum length",
8498 "-i, --invert invert output",
8499 "-a, --amp amplify signal",
8500 "-b break on first found",
8501 "-@ continuous reader mode",
8502 "-v, --verbose verbose output"
8503 ],
8504 "usage": "lf em 410x reader [-hiab@v] [--clk <dec>] [--err <dec>] [--len <dec>]"
8505 },
8506 "lf em 410x sim": {
8507 "command": "lf em 410x sim",
8508 "description": "Enables simulation of EM 410x card. Simulation runs until the button is pressed or another USB command is issued.",
8509 "notes": [
8510 "lf em 410x sim --id 0F0368568B",
8511 "lf em 410x sim --id 0F0368568B --clk 32",
8512 "lf em 410x sim --id 0F0368568B --gap 0"
8513 ],
8514 "offline": false,
8515 "options": [
8516 "-h, --help This help",
8517 "--clk <dec> <32|64> clock (default 64)",
8518 "--id <hex> EM Tag ID number (5 hex bytes)",
8519 "--gap <dec> gap (0's) between ID repeats (default 20)"
8520 ],
8521 "usage": "lf em 410x sim [-h] [--clk <dec>] --id <hex> [--gap <dec>]"
8522 },
8523 "lf em 410x spoof": {
8524 "command": "lf em 410x spoof",
8525 "description": "Watch 'nd Spoof, activates reader Waits until a EM 410x tag gets presented then Proxmark3 starts simulating the found EM Tag ID",
8526 "notes": [
8527 "lf em 410x spoof"
8528 ],
8529 "offline": false,
8530 "options": [
8531 "-h, --help This help"
8532 ],
8533 "usage": "lf em 410x spoof [-h]"
8534 },
8535 "lf em 410x watch": {
8536 "command": "lf em 410x watch",
8537 "description": "Enables Electro Marine (EM) compatible reader mode printing details of scanned tags. Run until the button is pressed or another USB command is issued.",
8538 "notes": [
8539 "lf em 410x watch"
8540 ],
8541 "offline": false,
8542 "options": [
8543 "-h, --help This help"
8544 ],
8545 "usage": "lf em 410x watch [-h]"
8546 },
8547 "lf em 4x05 brute": {
8548 "command": "lf em 4x05 brute",
8549 "description": "This command tries to bruteforce the password of a EM4205/4305/4469/4569 The loop is running on device side, press Proxmark3 button to abort",
8550 "notes": [
8551 "Note: if you get many false positives, change position on the antennalf em 4x05 brute",
8552 "lf em 4x05 brute -n 1 -> stop after first candidate found",
8553 "lf em 4x05 brute -s 000022AA -> start at 000022AA"
8554 ],
8555 "offline": false,
8556 "options": [
8557 "-h, --help This help",
8558 "-s, --start <hex> Start bruteforce enumeration from this password value",
8559 "-n <dec> Stop after having found n candidates. Default: 0 (infinite)"
8560 ],
8561 "usage": "lf em 4x05 brute [-h] [-s <hex>] [-n <dec>]"
8562 },
8563 "lf em 4x05 chk": {
8564 "command": "lf em 4x05 chk",
8565 "description": "This command uses a dictionary attack against EM4205/4305/4469/4569",
8566 "notes": [
8567 "lf em 4x05 chk",
8568 "lf em 4x05 chk -e 000022B8 -> check password 000022B8",
8569 "lf em 4x05 chk -f t55xx_default_pwds -> use T55xx default dictionary"
8570 ],
8571 "offline": false,
8572 "options": [
8573 "-h, --help This help",
8574 "-f, --file <fn> loads a default keys dictionary file <*.dic>",
8575 "-e, --em <EM4100> try the calculated password from some cloners based on EM4100 ID"
8576 ],
8577 "usage": "lf em 4x05 chk [-h] [-f <fn>] [-e <EM4100>]"
8578 },
8579 "lf em 4x05 config": {
8580 "command": "lf em 4x05 config",
8581 "description": "Create common configuration blocks",
8582 "notes": [
8583 "lf em 4x05 config"
8584 ],
8585 "offline": true,
8586 "options": [
8587 "-h, --help This help"
8588 ],
8589 "usage": "lf em 4x05 config [-h]"
8590 },
8591 "lf em 4x05 demod": {
8592 "command": "lf em 4x05 demod",
8593 "description": "Try to find EM 4x05 preamble, if found decode / descramble data",
8594 "notes": [
8595 "lf em 4x05 demod"
8596 ],
8597 "offline": true,
8598 "options": [
8599 "-h, --help This help"
8600 ],
8601 "usage": "lf em 4x05 demod [-h]"
8602 },
8603 "lf em 4x05 dump": {
8604 "command": "lf em 4x05 dump",
8605 "description": "Dump EM4x05/EM4x69. Tag must be on antenna.",
8606 "notes": [
8607 "lf em 4x05 dump",
8608 "lf em 4x05 dump -p 11223344",
8609 "lf em 4x05 dump -f myfile -p 11223344"
8610 ],
8611 "offline": false,
8612 "options": [
8613 "-h, --help This help",
8614 "-p, --pwd <hex> password (00000000)",
8615 "-f, --file <fn> override filename prefix (optional). Default is based on UID",
8616 "--ns no save to file"
8617 ],
8618 "usage": "lf em 4x05 dump [-h] [-p <hex>] [-f <fn>] [--ns]"
8619 },
8620 "lf em 4x05 help": {
8621 "command": "lf em 4x05 help",
8622 "description": "----------- ----------------------- General ----------------------- help This help ----------- ----------------------- Operations ----------------------- config Create common configuration words demod Demodulate a EM4x05/EM4x69 tag from the GraphBuffer sniff Attempt to recover em4x05 commands from sample buffer view Display content from tag dump file --------------------------------------------------------------------------------------- lf em 4x05 clonehelp available offline: no Display a list of available commands for cloning specific techs on EM4305/4469 tags",
8623 "notes": [
8624 "lf em 4x05 clonehelp"
8625 ],
8626 "offline": true,
8627 "options": [
8628 "-h, --help This help"
8629 ],
8630 "usage": "lf em 4x05 clonehelp [-h]"
8631 },
8632 "lf em 4x05 info": {
8633 "command": "lf em 4x05 info",
8634 "description": "Tag information EM4205/4305/4469//4569 tags. Tag must be on antenna.",
8635 "notes": [
8636 "lf em 4x05 info",
8637 "lf em 4x05 info -p 11223344"
8638 ],
8639 "offline": false,
8640 "options": [
8641 "-h, --help This help",
8642 "-p, --pwd <hex> optional - password, 4 hex bytes",
8643 "-v, --verbose Verbose output"
8644 ],
8645 "usage": "lf em 4x05 info [-hv] [-p <hex>]"
8646 },
8647 "lf em 4x05 read": {
8648 "command": "lf em 4x05 read",
8649 "description": "Read EM4x05/EM4x69. Tag must be on antenna.",
8650 "notes": [
8651 "lf em 4x05 read -a 1",
8652 "lf em 4x05 read --addr 1 --pwd 11223344"
8653 ],
8654 "offline": false,
8655 "options": [
8656 "-h, --help This help",
8657 "-a, --addr <dec> memory address to read. (0-15)",
8658 "-p, --pwd <hex> optional - password, 4 bytes hex"
8659 ],
8660 "usage": "lf em 4x05 read [-h] -a <dec> [-p <hex>]"
8661 },
8662 "lf em 4x05 sniff": {
8663 "command": "lf em 4x05 sniff",
8664 "description": "Sniff EM4x05 commands sent from a programmer",
8665 "notes": [
8666 "lf em 4x05 sniff -> sniff via lf sniff",
8667 "lf em 4x05 sniff -1 -> sniff from data loaded into the buffer",
8668 "lf em 4x05 sniff -r -> reverse the bit order when showing block data"
8669 ],
8670 "offline": true,
8671 "options": [
8672 "-h, --help This help",
8673 "-1, --buf Use the data in the buffer",
8674 "-r, --rev Reverse the bit order for data blocks"
8675 ],
8676 "usage": "lf em 4x05 sniff [-h1r]"
8677 },
8678 "lf em 4x05 unlock": {
8679 "command": "lf em 4x05 unlock",
8680 "description": "execute tear off against EM4205/4305/4469/4569",
8681 "notes": [
8682 "lf em 4x05 unlock",
8683 "lf em 4x05 unlock -s 4100 -e 4100 -> lock on and autotune at 4100us",
8684 "lf em 4x05 unlock -n 10 -s 3000 -e 4400 -> scan delays 3000us -> 4400us"
8685 ],
8686 "offline": false,
8687 "options": [
8688 "-h, --help This help",
8689 "-n <int> steps to skip",
8690 "-s, --start <us> start scan from delay (us)",
8691 "-e, --end <us> end scan at delay (us)",
8692 "-p, --pwd <hex> password (def 00000000)",
8693 "-v, --verbose verbose output"
8694 ],
8695 "usage": "lf em 4x05 unlock [-hv] [-n <int>] [-s <us>] [-e <us>] [-p <hex>]"
8696 },
8697 "lf em 4x05 view": {
8698 "command": "lf em 4x05 view",
8699 "description": "Print a EM4205/4305/4369/4469 dump file note: We don't track if password is known in current dump file formats. All zeros password block might be filler data",
8700 "notes": [
8701 "lf em 4x05 view -f lf-4x05-01020304-dump.json"
8702 ],
8703 "offline": true,
8704 "options": [
8705 "-h, --help This help",
8706 "-f, --file <fn> Specify a filename for dump file",
8707 "-v, --verbose Verbose output"
8708 ],
8709 "usage": "lf em 4x05 view [-hv] -f <fn>"
8710 },
8711 "lf em 4x05 wipe": {
8712 "command": "lf em 4x05 wipe",
8713 "description": "Wipe EM4x05/EM4x69. Tag must be on antenna.",
8714 "notes": [
8715 "lf em 4x05 wipe --4305 -p 11223344 -> wipe EM 4305 w pwd",
8716 "lf em 4x05 wipe --4205 -> wipe EM 4205",
8717 "lf em 4x05 wipe --4369 -> wipe EM 4369"
8718 ],
8719 "offline": false,
8720 "options": [
8721 "-h, --help This help",
8722 "--4205 target chip type EM 4205",
8723 "--4305 target chip type EM 4305 (default)",
8724 "--4369 target chip type EM 4369",
8725 "--4469 target chip type EM 4469",
8726 "-p, --pwd <hex> optional - password, 4 bytes hex"
8727 ],
8728 "usage": "lf em 4x05 wipe [-h] [--4205] [--4305] [--4369] [--4469] [-p <hex>]"
8729 },
8730 "lf em 4x05 write": {
8731 "command": "lf em 4x05 write",
8732 "description": "Write EM4x05/EM4x69. Tag must be on antenna.",
8733 "notes": [
8734 "lf em 4x05 write -a 1 -d deadc0de",
8735 "lf em 4x05 write --addr 1 --pwd 11223344 --data deadc0de",
8736 "lf em 4x05 write --po --pwd 11223344 --data deadc0de"
8737 ],
8738 "offline": false,
8739 "options": [
8740 "-h, --help This help",
8741 "-a, --addr <dec> memory address to write to. (0-13)",
8742 "-d, --data <hex> data to write (4 hex bytes)",
8743 "-p, --pwd <hex> password (4 hex bytes)",
8744 "--po protect operation"
8745 ],
8746 "usage": "lf em 4x05 write [-h] [-a <dec>] -d <hex> [-p <hex>] [--po]"
8747 },
8748 "lf em 4x50 chk": {
8749 "command": "lf em 4x50 chk",
8750 "description": "Run dictionary key recovery against EM4x50 card.",
8751 "notes": [
8752 "lf em 4x50 chk -> uses T55xx default dictionary",
8753 "lf em 4x50 chk -f my.dic"
8754 ],
8755 "offline": false,
8756 "options": [
8757 "-h, --help This help",
8758 "-f, --file <fn> specify dictionary filename"
8759 ],
8760 "usage": "lf em 4x50 chk [-h] [-f <fn>]"
8761 },
8762 "lf em 4x50 dump": {
8763 "command": "lf em 4x50 dump",
8764 "description": "Reads all blocks/words from EM4x50 tag and saves dump in (bin/json) format",
8765 "notes": [
8766 "lf em 4x50 dump",
8767 "lf em 4x50 dump -f mydump",
8768 "lf em 4x50 dump -p 12345678",
8769 "lf em 4x50 dump -f mydump -p 12345678"
8770 ],
8771 "offline": false,
8772 "options": [
8773 "-h, --help This help",
8774 "-f, --file <fn> specify dump filename",
8775 "-p, --pwd <hex> password, 4 hex bytes, lsb",
8776 "--ns no save to file"
8777 ],
8778 "usage": "lf em 4x50 dump [-h] [-f <fn>] [-p <hex>] [--ns]"
8779 },
8780 "lf em 4x50 eload": {
8781 "command": "lf em 4x50 eload",
8782 "description": "Loads EM4x50 tag dump (bin/eml/json) into emulator memory on device",
8783 "notes": [
8784 "lf em 4x50 eload -f mydump.bin"
8785 ],
8786 "offline": false,
8787 "options": [
8788 "-h, --help This help",
8789 "-f, --file <fn> Specify a filename for dump file"
8790 ],
8791 "usage": "lf em 4x50 eload [-h] -f <fn>"
8792 },
8793 "lf em 4x50 esave": {
8794 "command": "lf em 4x50 esave",
8795 "description": "Saves bin/json dump file of emulator memory.",
8796 "notes": [
8797 "lf em 4x50 esave -> use UID as filename",
8798 "lf em 4x50 esave -f mydump"
8799 ],
8800 "offline": false,
8801 "options": [
8802 "-h, --help This help",
8803 "-f, --file <fn> specifiy filename"
8804 ],
8805 "usage": "lf em 4x50 esave [-h] [-f <fn>]"
8806 },
8807 "lf em 4x50 eview": {
8808 "command": "lf em 4x50 eview",
8809 "description": "Displays em4x50 content of emulator memory.",
8810 "notes": [
8811 "lf em 4x50 eview"
8812 ],
8813 "offline": false,
8814 "options": [
8815 "-h, --help This help"
8816 ],
8817 "usage": "lf em 4x50 eview [-h]"
8818 },
8819 "lf em 4x50 help": {
8820 "command": "lf em 4x50 help",
8821 "description": "help This help ----------- --------------------- operations --------------------- view Display content from tag dump file ----------- --------------------- simulation --------------------- --------------------------------------------------------------------------------------- lf em 4x50 brute available offline: no Tries to bruteforce the password of a EM4x50 card. Function can be stopped by pressing pm3 button.",
8822 "notes": [
8823 "lf em 4x50 brute --mode range --begin 12330000 --end 12340000 -> tries pwds from 0x12330000 to 0x12340000",
8824 "lf em 4x50 brute --mode charset --digits --uppercase -> tries all combinations of ASCII codes for digits and uppercase letters",
8825 "lf em 4x50 brute --mode smart -> enable 'smart' pattern key cracking"
8826 ],
8827 "offline": true,
8828 "options": [
8829 "-h, --help This help",
8830 "--mode <str> Bruteforce mode (range|charset|smart)",
8831 "--begin <hex> Range mode - start of the key range",
8832 "--end <hex> Range mode - end of the key range",
8833 "--digits Charset mode - include ASCII codes for digits",
8834 "--uppercase Charset mode - include ASCII codes for uppercase letters"
8835 ],
8836 "usage": "lf em 4x50 brute [-h] --mode <str> [--begin <hex>] [--end <hex>] [--digits] [--uppercase]"
8837 },
8838 "lf em 4x50 info": {
8839 "command": "lf em 4x50 info",
8840 "description": "Tag information EM4x50.",
8841 "notes": [
8842 "lf em 4x50 info",
8843 "lf em 4x50 info -v -> show data section",
8844 "lf em 4x50 info -p 12345678 -> uses pwd 0x12345678"
8845 ],
8846 "offline": false,
8847 "options": [
8848 "-h, --help This help",
8849 "-p, --pwd <hex> password, 4 hex bytes, lsb",
8850 "-v, --verbose verbose output"
8851 ],
8852 "usage": "lf em 4x50 info [-hv] [-p <hex>]"
8853 },
8854 "lf em 4x50 login": {
8855 "command": "lf em 4x50 login",
8856 "description": "Login into EM4x50 tag.",
8857 "notes": [
8858 "lf em 4x50 login -p 12345678 -> login with password 12345678"
8859 ],
8860 "offline": false,
8861 "options": [
8862 "-h, --help This help",
8863 "-p, --passsword <hex> password, 4 bytes, lsb"
8864 ],
8865 "usage": "lf em 4x50 login [-h] -p <hex>"
8866 },
8867 "lf em 4x50 rdbl": {
8868 "command": "lf em 4x50 rdbl",
8869 "description": "Reads single EM4x50 block/word.",
8870 "notes": [
8871 "lf em 4x50 rdbl -b 3",
8872 "lf em 4x50 rdbl -b 32 -p 12345678 -> reads block 32 with pwd 0x12345678"
8873 ],
8874 "offline": false,
8875 "options": [
8876 "-h, --help This help",
8877 "-b, --block <dec> block/word address",
8878 "-p, --pwd <hex> password, 4 hex bytes, lsb"
8879 ],
8880 "usage": "lf em 4x50 rdbl [-h] -b <dec> [-p <hex>]"
8881 },
8882 "lf em 4x50 reader": {
8883 "command": "lf em 4x50 reader",
8884 "description": "Shows standard read data of EM4x50 tag.",
8885 "notes": [
8886 "lf em 4x50 reader",
8887 "lf em 4x50 reader -@ -> continuous reader mode"
8888 ],
8889 "offline": false,
8890 "options": [
8891 "-h, --help This help",
8892 "-@ optional - continuous reader mode"
8893 ],
8894 "usage": "lf em 4x50 reader [-h@]"
8895 },
8896 "lf em 4x50 restore": {
8897 "command": "lf em 4x50 restore",
8898 "description": "Restores data from dumpfile (bin/eml/json) onto a EM4x50 tag. if used with -u, the filetemplate `lf-4x50-UID-dump.bin` is used as filename",
8899 "notes": [
8900 "lf em 4x50 restore -u 1b5aff5c -> uses lf-4x50-1B5AFF5C-dump.bin",
8901 "lf em 4x50 restore -f mydump.eml",
8902 "lf em 4x50 restore -u 1b5aff5c -p 12345678",
8903 "lf em 4x50 restore -f mydump.eml -p 12345678"
8904 ],
8905 "offline": false,
8906 "options": [
8907 "-h, --help This help",
8908 "-u, --uid <hex> uid, 4 hex bytes, msb",
8909 "-f, --file <fn> specify a filename for dump file",
8910 "-p, --pwd <hex> password, 4 hex bytes, lsb"
8911 ],
8912 "usage": "lf em 4x50 restore [-h] [-u <hex>] [-f <fn>] [-p <hex>]"
8913 },
8914 "lf em 4x50 sim": {
8915 "command": "lf em 4x50 sim",
8916 "description": "Simulates a EM4x50 tag First upload to device using `lf em 4x50 eload`",
8917 "notes": [
8918 "lf em 4x50 sim",
8919 "lf em 4x50 sim -p 27182818 -> uses password for eload data"
8920 ],
8921 "offline": false,
8922 "options": [
8923 "-h, --help This help",
8924 "-p, --passsword <hex> password, 4 bytes, lsb"
8925 ],
8926 "usage": "lf em 4x50 sim [-h] [-p <hex>]"
8927 },
8928 "lf em 4x50 view": {
8929 "command": "lf em 4x50 view",
8930 "description": "Print a EM4x50 dump file",
8931 "notes": [
8932 "lf em 4x50 view -f lf-4x50-01020304-dump.json"
8933 ],
8934 "offline": true,
8935 "options": [
8936 "-h, --help This help",
8937 "-f, --file <fn> specify a filename for dump file"
8938 ],
8939 "usage": "lf em 4x50 view [-h] [-f <fn>]"
8940 },
8941 "lf em 4x50 wipe": {
8942 "command": "lf em 4x50 wipe",
8943 "description": "Wipes EM4x50 tag by filling it with zeros, including the new password Must give a password.",
8944 "notes": [
8945 "lf em 4x50 wipe -p 12345678"
8946 ],
8947 "offline": false,
8948 "options": [
8949 "-h, --help This help",
8950 "-p, --passsword <hex> password, 4 bytes, lsb"
8951 ],
8952 "usage": "lf em 4x50 wipe [-h] -p <hex>"
8953 },
8954 "lf em 4x50 wrbl": {
8955 "command": "lf em 4x50 wrbl",
8956 "description": "Writes single block/word to EM4x50 tag.",
8957 "notes": [
8958 "lf em 4x50 wrbl -b 3 -d 4f22e7ff",
8959 "lf em 4x50 wrbl -b 3 -d 4f22e7ff -p 12345678"
8960 ],
8961 "offline": false,
8962 "options": [
8963 "-h, --help This help",
8964 "-b, --block <dec> block/word address, dec",
8965 "-d, --data <hex> data, 4 bytes, lsb",
8966 "-p, --pwd <hex> password, 4 bytes, lsb"
8967 ],
8968 "usage": "lf em 4x50 wrbl [-h] -b <dec> -d <hex> [-p <hex>]"
8969 },
8970 "lf em 4x50 wrpwd": {
8971 "command": "lf em 4x50 wrpwd",
8972 "description": "Writes EM4x50 password.",
8973 "notes": [
8974 "lf em 4x50 wrpwd -p 4f22e7ff -n 12345678"
8975 ],
8976 "offline": false,
8977 "options": [
8978 "-h, --help This help",
8979 "-p, --pwd <hex> password, 4 hex bytes, lsb",
8980 "-n, --new <hex> new password, 4 hex bytes, lsb"
8981 ],
8982 "usage": "lf em 4x50 wrpwd [-h] -p <hex> -n <hex>"
8983 },
8984 "lf em 4x70 auth": {
8985 "command": "lf em 4x70 auth",
8986 "description": "Authenticate against an EM4x70 by sending random number (RN) and F(RN) If F(RN) is incorrect based on the tag key, the tag will not respond If F(RN) is correct based on the tag key, the tag will give a 20-bit response",
8987 "notes": [
8988 "lf em 4x70 auth --rnd 45F54ADA252AAC --frn 4866BB70 -> (using pm3 test key)",
8989 "lf em 4x70 auth --rnd 3FFE1FB6CC513F --frn F355F1A0 -> (using research paper key)",
8990 "lf em 4x70 auth --rnd 7D5167003571F8 --frn 982DBCC0 -> (autorecovery test key)"
8991 ],
8992 "offline": false,
8993 "options": [
8994 "-h, --help This help",
8995 "--par Add parity bit when sending commands",
8996 "--rnd <hex> Random 56-bit",
8997 "--frn <hex> F(RN) 28-bit as 4 hex bytes"
8998 ],
8999 "usage": "lf em 4x70 auth [-h] [--par] --rnd <hex> --frn <hex>"
9000 },
9001 "lf em 4x70 autorecover": {
9002 "command": "lf em 4x70 autorecover",
9003 "description": "This command will perform automatic recovery of the key from a writable tag. All steps are possible to do manually. The corresponding sequence, if done manually, is as follows: 1. Verify passed parameters authenticate with the tag (safety check) lf em 4x70 auth --rnd <rnd_1> --frn <frn_1> 2. Brute force the key bits in block 9 lf em 4x70 write -b 9 -d 0000 lf em 4x70 recover -b 9 --rnd <rnd_1> --frn <frn_1> lf em 4x70 write -b 9 -d <key_block_9> 3. Brute force the key bits in block 8 lf em 4x70 write -b 8 -d 0000 lf em 4x70 recover -b 8 --rnd <rnd_1> --frn <frn_1> lf em 4x70 write -b 8 -d <key_block_8> 4. Brute force the key bits in block 7 lf em 4x70 write -b 7 -d 0000) lf em 4x70 recover -b 7 --rnd <rnd_1> --frn <frn_1> lf em 4x70 write -b 7 -d <key_block_7> 5. Recover potential values of the lower 48 bits of the key lf em 4x70 recover --key <key_block_9><key_block_8><key_block_7> --rnd <rnd_1> --frn <frn_1> 6. Verify which potential key is actually on the tag (using a different rnd/frn combination) lf em 4x70 auth --rnd <rnd_2> --frn <frn_N> 7. Print the validated key This command simply requires the rnd/frn/grn from a single known-good authentication.",
9004 "notes": [
9005 "lf em 4x70 autorecover --rnd 45F54ADA252AAC --frn 4866BB70 --grn 9BD180 (pm3 test key)",
9006 "lf em 4x70 autorecover --rnd 3FFE1FB6CC513F --frn F355F1A0 --grn 609D60 (research paper key)",
9007 "lf em 4x70 autorecover --rnd 7D5167003571F8 --frn 982DBCC0 --grn 36C0E0 (autorecovery test key)"
9008 ],
9009 "offline": false,
9010 "options": [
9011 "-h, --help This help",
9012 "--par Add parity bit when sending commands",
9013 "--rnd <hex> Random 56-bit from known-good authentication",
9014 "--frn <hex> F(RN) 28-bit as 4 hex bytes from known-good authentication",
9015 "--grn <hex> G(RN) 20-bit as 3 hex bytes from known-good authentication"
9016 ],
9017 "usage": "lf em 4x70 autorecover [-h] [--par] --rnd <hex> --frn <hex> --grn <hex>"
9018 },
9019 "lf em 4x70 help": {
9020 "command": "lf em 4x70 help",
9021 "description": "help This help recover Recover remaining key from partial key --------------------------------------------------------------------------------------- lf em 4x70 brute available offline: no Optimized partial key-update attack of 16-bit key block 7, 8 or 9 of an EM4x70 This attack does NOT write anything to the tag. Before starting this attack, 0000 must be written to the 16-bit key block: 'lf em 4x70 write -b 9 -d 0000'. After success, the 16-bit key block have to be restored with the key found: 'lf em 4x70 write -b 9 -d c0de'",
9022 "notes": [
9023 "lf em 4x70 brute -b 9 --rnd 45F54ADA252AAC --frn 4866BB70 -> bruteforcing key bits k95...k80"
9024 ],
9025 "offline": true,
9026 "options": [
9027 "-h, --help This help",
9028 "--par Add parity bit when sending commands",
9029 "-b, --block <dec> block/word address, dec",
9030 "--rnd <hex> Random 56-bit",
9031 "--frn <hex> F(RN) 28-bit as 4 hex bytes",
9032 "-s, --start <hex> Start bruteforce enumeration from this key value"
9033 ],
9034 "usage": "lf em 4x70 brute [-h] [--par] -b <dec> --rnd <hex> --frn <hex> [-s <hex>]"
9035 },
9036 "lf em 4x70 info": {
9037 "command": "lf em 4x70 info",
9038 "description": "Tag Information EM4x70 Tag variants include ID48 automotive transponder. ID48 does not use command parity (default). V4070 and EM4170 do require parity bit.",
9039 "notes": [
9040 "lf em 4x70 info",
9041 "lf em 4x70 info --par -> adds parity bit to command"
9042 ],
9043 "offline": false,
9044 "options": [
9045 "-h, --help This help",
9046 "--par Add parity bit when sending commands"
9047 ],
9048 "usage": "lf em 4x70 info [-h] [--par]"
9049 },
9050 "lf em 4x70 recover": {
9051 "command": "lf em 4x70 recover",
9052 "description": "After obtaining key bits 95..48 (such as via 'lf em 4x70 brute'), this command will recover key bits 47..00. By default, this process does NOT require a tag to be present. By default, the potential keys are shown (typically 1-6) along with a corresponding 'lf em 4x70 auth' command that will authenticate, if that potential key is correct. The user can copy/paste these commands when the tag is present to manually check which of the potential keys is correct.",
9053 "notes": [
9054 "lf em 4x70 recover --key F32AA98CF5BE --rnd 45F54ADA252AAC --frn 4866BB70 --grn 9BD180 (pm3 test key)",
9055 "lf em 4x70 recover --key A090A0A02080 --rnd 3FFE1FB6CC513F --frn F355F1A0 --grn 609D60 (research paper key)"
9056 ],
9057 "offline": true,
9058 "options": [
9059 "-h, --help This help",
9060 "--par Add parity bit when sending commands",
9061 "-k, --key <hex> Key as 6 hex bytes",
9062 "--rnd <hex> Random 56-bit",
9063 "--frn <hex> F(RN) 28-bit as 4 hex bytes",
9064 "--grn <hex> G(RN) 20-bit as 3 hex bytes"
9065 ],
9066 "usage": "lf em 4x70 recover [-h] [--par] -k <hex> --rnd <hex> --frn <hex> --grn <hex>"
9067 },
9068 "lf em 4x70 setkey": {
9069 "command": "lf em 4x70 setkey",
9070 "description": "Write new 96-bit key to tag",
9071 "notes": [
9072 "lf em 4x70 setkey -k F32AA98CF5BE4ADFA6D3480B (pm3 test key)",
9073 "lf em 4x70 setkey -k A090A0A02080000000000000 (research paper key)",
9074 "lf em 4x70 setkey -k 022A028C02BE000102030405 (autorecovery test key)"
9075 ],
9076 "offline": false,
9077 "options": [
9078 "-h, --help This help",
9079 "--par Add parity bit when sending commands",
9080 "-k, --key <hex> Key as 12 hex bytes"
9081 ],
9082 "usage": "lf em 4x70 setkey [-h] [--par] -k <hex>"
9083 },
9084 "lf em 4x70 setpin": {
9085 "command": "lf em 4x70 setpin",
9086 "description": "Write new PIN",
9087 "notes": [
9088 "lf em 4x70 setpin -p 11223344 -> Write new PIN",
9089 "lf em 4x70 setpin -p 11223344 --par -> Write new PIN using parity commands"
9090 ],
9091 "offline": false,
9092 "options": [
9093 "-h, --help This help",
9094 "--par Add parity bit when sending commands",
9095 "-p, --pin <hex> pin, 4 bytes"
9096 ],
9097 "usage": "lf em 4x70 setpin [-h] [--par] -p <hex>"
9098 },
9099 "lf em 4x70 unlock": {
9100 "command": "lf em 4x70 unlock",
9101 "description": "Unlock EM4x70 by sending PIN Default pin may be: AAAAAAAA 00000000",
9102 "notes": [
9103 "lf em 4x70 unlock -p 11223344 -> Unlock with PIN",
9104 "lf em 4x70 unlock -p 11223344 --par -> Unlock with PIN using parity commands"
9105 ],
9106 "offline": false,
9107 "options": [
9108 "-h, --help This help",
9109 "--par Add parity bit when sending commands",
9110 "-p, --pin <hex> pin, 4 bytes"
9111 ],
9112 "usage": "lf em 4x70 unlock [-h] [--par] -p <hex>"
9113 },
9114 "lf em 4x70 write": {
9115 "command": "lf em 4x70 write",
9116 "description": "Write EM4x70",
9117 "notes": [
9118 "lf em 4x70 write -b 15 -d c0de -> write 'c0de' to block 15",
9119 "lf em 4x70 write -b 15 -d c0de --par -> adds parity bit to commands"
9120 ],
9121 "offline": false,
9122 "options": [
9123 "-h, --help This help",
9124 "--par Add parity bit when sending commands",
9125 "-b, --block <dec> block/word address, dec",
9126 "-d, --data <hex> data, 2 bytes"
9127 ],
9128 "usage": "lf em 4x70 write [-h] [--par] -b <dec> -d <hex>"
9129 },
9130 "lf em help": {
9131 "command": "lf em help",
9132 "description": "help This help 410x { EM 4102 commands... } 4x05 { EM 4205 / 4305 / 4369 / 4469 commands... } 4x50 { EM 4350 / 4450 commands... } 4x70 { EM 4070 / 4170 commands... } ======================================================================================= lf em 410x { EM 4102 commands... } --------------------------------------------------------------------------------------- lf em 410x help available offline: yes help This help demod demodulate a EM410x tag from the GraphBuffer --------------------------------------------------------------------------------------- lf em 410x demod available offline: yes Try to find EM 410x preamble, if found decode / descramble data",
9133 "notes": [
9134 "lf em 410x demod -> demod an EM410x Tag ID from GraphBuffer",
9135 "lf em 410x demod --clk 32 -> demod an EM410x Tag ID from GraphBuffer using a clock of RF/32",
9136 "lf em 410x demod --clk 32 -i -> demod an EM410x Tag ID from GraphBuffer using a clock of RF/32 and inverting data",
9137 "lf em 410x demod -i -> demod an EM410x Tag ID from GraphBuffer while inverting data",
9138 "lf em 410x demod --clk 64 -i --err 0 -> demod an EM410x Tag ID from GraphBuffer using a clock of RF/64 and inverting data and allowing 0 demod errors"
9139 ],
9140 "offline": true,
9141 "options": [
9142 "-h, --help This help",
9143 "--clk <dec> clock (default autodetect)",
9144 "--err <dec> maximum allowed errors (default 100)",
9145 "--len <dec> maximum length",
9146 "-i, --invert invert output",
9147 "-a, --amp amplify signal",
9148 "--bin <bin> Binary string i.e 0001001001"
9149 ],
9150 "usage": "lf em 410x demod [-hia] [--clk <dec>] [--err <dec>] [--len <dec>] [--bin <bin>]"
9151 },
9152 "lf fdxb clone": {
9153 "command": "lf fdxb clone",
9154 "description": "clone a FDX-B tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
9155 "notes": [
9156 "lf fdxb clone --country 999 --national 1337 --animal -> encode for T55x7 tag, with animal bit",
9157 "lf fdxb clone --country 999 --national 1337 --extended 016A -> encode for T55x7 tag, with extended data",
9158 "lf fdxb clone --country 999 --national 1337 --q5 -> encode for Q5/T5555 tag",
9159 "lf fdxb clone --country 999 --national 1337 --em -> encode for EM4305/4469"
9160 ],
9161 "offline": false,
9162 "options": [
9163 "-h, --help This help",
9164 "-c, --country <dec> country code",
9165 "-n, --national <dec> national code",
9166 "--extended <hex> extended data",
9167 "-a, --animal optional - set animal bit",
9168 "--q5 optional - specify writing to Q5/T5555 tag",
9169 "--em optional - specify writing to EM4305/4469 tag"
9170 ],
9171 "usage": "lf fdxb clone [-ha] -c <dec> -n <dec> [--extended <hex>] [--q5] [--em]"
9172 },
9173 "lf fdxb help": {
9174 "command": "lf fdxb help",
9175 "description": "help this help demod demodulate a FDX-B ISO11784/85 tag from the GraphBuffer --------------------------------------------------------------------------------------- lf fdxb demod available offline: yes Try to find FDX-B preamble, if found decode / descramble data",
9176 "notes": [
9177 "lf fdxb demod"
9178 ],
9179 "offline": true,
9180 "options": [
9181 "-h, --help This help"
9182 ],
9183 "usage": "lf fdxb demod [-h]"
9184 },
9185 "lf fdxb reader": {
9186 "command": "lf fdxb reader",
9187 "description": "read a FDX-B animal tag Note that the continuous mode is less verbose",
9188 "notes": [
9189 "lf fdxb reader -@ -> continuous reader mode"
9190 ],
9191 "offline": false,
9192 "options": [
9193 "-h, --help This help",
9194 "-@ optional - continuous reader mode"
9195 ],
9196 "usage": "lf fdxb reader [-h@]"
9197 },
9198 "lf fdxb sim": {
9199 "command": "lf fdxb sim",
9200 "description": "Enables simulation of FDX-B animal tag. Simulation runs until the button is pressed or another USB command is issued.",
9201 "notes": [
9202 "lf fdxb sim --country 999 --national 1337 --animal",
9203 "lf fdxb sim --country 999 --national 1337 --extended 016A"
9204 ],
9205 "offline": false,
9206 "options": [
9207 "-h, --help This help",
9208 "-c, --country <dec> country code",
9209 "-n, --national <dec> national code",
9210 "--extended <hex> extended data",
9211 "-a, --animal optional - set animal bit"
9212 ],
9213 "usage": "lf fdxb sim [-ha] -c <dec> -n <dec> [--extended <hex>]"
9214 },
9215 "lf gallagher clone": {
9216 "command": "lf gallagher clone",
9217 "description": "clone a GALLAGHER tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
9218 "notes": [
9219 "lf gallagher clone --raw 0FFD5461A9DA1346B2D1AC32 -> encode for T55x7 tag",
9220 "lf gallagher clone --raw 0FFD5461A9DA1346B2D1AC32 --q5 -> encode for Q5/T5555 tag",
9221 "lf gallagher clone --raw 0FFD5461A9DA1346B2D1AC32 --em -> encode for EM4305/4469",
9222 "lf gallagher clone --rc 0 --fc 9876 --cn 1234 --il 1 -> encode for T55x7 tag from decoded data"
9223 ],
9224 "offline": false,
9225 "options": [
9226 "-h, --help This help",
9227 "-r, --raw <hex> raw hex data. 12 bytes max",
9228 "--q5 optional - specify writing to Q5/T5555 tag",
9229 "--em optional - specify writing to EM4305/4469 tag",
9230 "--rc <decimal> Region code. 4 bits max",
9231 "--fc <decimal> Facility code. 2 bytes max",
9232 "--cn <decimal> Card number. 3 bytes max",
9233 "--il <decimal> Issue level. 4 bits max"
9234 ],
9235 "usage": "lf gallagher clone [-h] [-r <hex>] [--q5] [--em] [--rc <decimal>] [--fc <decimal>] [--cn <decimal>] [--il <decimal>]"
9236 },
9237 "lf gallagher help": {
9238 "command": "lf gallagher help",
9239 "description": "help This help demod demodulate an GALLAGHER tag from the GraphBuffer --------------------------------------------------------------------------------------- lf gallagher demod available offline: yes Try to find GALLAGHER preamble, if found decode / descramble data",
9240 "notes": [
9241 "lf gallagher demod"
9242 ],
9243 "offline": true,
9244 "options": [
9245 "-h, --help This help"
9246 ],
9247 "usage": "lf gallagher demod [-h]"
9248 },
9249 "lf gallagher reader": {
9250 "command": "lf gallagher reader",
9251 "description": "read a GALLAGHER tag",
9252 "notes": [
9253 "lf gallagher reader -@ -> continuous reader mode"
9254 ],
9255 "offline": false,
9256 "options": [
9257 "-h, --help This help",
9258 "-@ optional - continuous reader mode"
9259 ],
9260 "usage": "lf gallagher reader [-h@]"
9261 },
9262 "lf gallagher sim": {
9263 "command": "lf gallagher sim",
9264 "description": "Enables simulation of GALLAGHER card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
9265 "notes": [
9266 "lf gallagher sim --raw 0FFD5461A9DA1346B2D1AC32",
9267 "lf gallagher sim --rc 0 --fc 9876 --cn 1234 --il 1"
9268 ],
9269 "offline": false,
9270 "options": [
9271 "-h, --help This help",
9272 "-r, --raw <hex> raw hex data. 12 bytes max",
9273 "--rc <decimal> Region code. 4 bits max",
9274 "--fc <decimal> Facility code. 2 bytes max",
9275 "--cn <decimal> Card number. 3 bytes max",
9276 "--il <decimal> Issue level. 4 bits max"
9277 ],
9278 "usage": "lf gallagher sim [-h] [-r <hex>] [--rc <decimal>] [--fc <decimal>] [--cn <decimal>] [--il <decimal>]"
9279 },
9280 "lf gproxii clone": {
9281 "command": "lf gproxii clone",
9282 "description": "Clone a Guardall tag to a T55x7, Q5/T5555 or EM4305/4469 tag. The facility-code is 8-bit and the card number is 20-bit. Larger values are truncated. Currently work only on 26 | 36 bit format",
9283 "notes": [
9284 "lf gproxii clone --xor 141 --fmt 26 --fc 123 --cn 1337 -> encode for T55x7 tag",
9285 "lf gproxii clone --xor 141 --fmt 26 --fc 123 --cn 1337 --q5 -> encode for Q5/T5555 tag",
9286 "lf gproxii clone --xor 141 --fmt 26 --fc 123 --cn 1337 --em -> encode for EM4305/4469"
9287 ],
9288 "offline": false,
9289 "options": [
9290 "-h, --help This help",
9291 "--xor <dec> 8-bit xor value (installation dependant)",
9292 "--fmt <dec> format length 26|32|36|40",
9293 "--fc <dec> 8-bit value facility code",
9294 "--cn <dec> 16-bit value card number",
9295 "--q5 optional - specify writing to Q5/T5555 tag",
9296 "--em optional - specify writing to EM4305/4469 tag"
9297 ],
9298 "usage": "lf gproxii clone [-h] --xor <dec> --fmt <dec> --fc <dec> --cn <dec> [--q5] [--em]"
9299 },
9300 "lf gproxii help": {
9301 "command": "lf gproxii help",
9302 "description": "help this help demod demodulate a G Prox II tag from the GraphBuffer --------------------------------------------------------------------------------------- lf gproxii demod available offline: yes Try to find Guardall Prox-II preamble, if found decode / descramble data",
9303 "notes": [
9304 "lf gproxii demod -> use graphbuffer to decode",
9305 "lf gproxii demod --raw fb8ee718ee3b8cc785c11b92 ->"
9306 ],
9307 "offline": true,
9308 "options": [
9309 "-h, --help This help",
9310 "-r, --raw <hex> raw bytes"
9311 ],
9312 "usage": "lf gproxii demod [-h] [-r <hex>]"
9313 },
9314 "lf gproxii reader": {
9315 "command": "lf gproxii reader",
9316 "description": "read a Guardall tag",
9317 "notes": [
9318 "lf gproxii reader -@ -> continuous reader mode"
9319 ],
9320 "offline": false,
9321 "options": [
9322 "-h, --help This help",
9323 "-@ optional - continuous reader mode"
9324 ],
9325 "usage": "lf gproxii reader [-h@]"
9326 },
9327 "lf gproxii sim": {
9328 "command": "lf gproxii sim",
9329 "description": "Enables simulation of Guardall card with specified card number. Simulation runs until the button is pressed or another USB command is issued. The facility-code is 8-bit and the card number is 16-bit. Larger values are truncated. Currently work only on 26 | 36 bit format",
9330 "notes": [
9331 "lf gproxii sim --xor 141 --fmt 26 --fc 123 --cn 1337"
9332 ],
9333 "offline": false,
9334 "options": [
9335 "-h, --help This help",
9336 "--xor <dec> 8-bit xor value (installation dependant)",
9337 "--fmt <dec> format length 26|32|36|40",
9338 "--fc <dec> 8-bit value facility code",
9339 "--cn <dec> 16-bit value card number"
9340 ],
9341 "usage": "lf gproxii sim [-h] --xor <dec> --fmt <dec> --fc <dec> --cn <dec>"
9342 },
9343 "lf help": {
9344 "command": "lf help",
9345 "description": "help This help ----------- -------------- Low Frequency -------------- awid { AWID RFIDs... } cotag { COTAG CHIPs... } destron { FDX-A Destron RFIDs... } em { EM CHIPs & RFIDs... } fdxb { FDX-B RFIDs... } gallagher { GALLAGHER RFIDs... } gproxii { Guardall Prox II RFIDs... } hid { HID Prox RFIDs... } hitag { Hitag CHIPs... } idteck { Idteck RFIDs... } indala { Indala RFIDs... } io { ioProx RFIDs... } jablotron { Jablotron RFIDs... } keri { KERI RFIDs... } motorola { Motorola Flexpass RFIDs... } nedap { Nedap RFIDs... } nexwatch { NexWatch RFIDs... } noralsy { Noralsy RFIDs... } pac { PAC/Stanley RFIDs... } paradox { Paradox RFIDs... } pcf7931 { PCF7931 CHIPs... } presco { Presco RFIDs... } pyramid { Farpointe/Pyramid RFIDs... } securakey { Securakey RFIDs... } ti { TI CHIPs... } t55xx { T55xx CHIPs... } viking { Viking RFIDs... } visa2000 { Visa2000 RFIDs... } ----------- --------------------- General --------------------- search Read and Search for valid known tag --------------------------------------------------------------------------------------- lf config available offline: no Get/Set config for LF sampling, bit/sample, decimation, frequency These changes are temporary, will be reset after a power cycle. - use `lf read` performs a read (active field) - use `lf sniff` performs a sniff (no active field)",
9346 "notes": [
9347 "lf config -> shows current config",
9348 "lf config -b 8 --125 -> samples at 125 kHz, 8 bps",
9349 "lf config -b 4 --134 --dec 3 -> samples at 134 kHz, averages three samples into one, stored with a resolution of 4 bits per sample",
9350 "lf config --trig 20 -s 10000 -> trigger sampling when above 20, skip 10 000 first samples after triggered",
9351 "lf config --reset -> reset back to default values"
9352 ],
9353 "offline": true,
9354 "options": [
9355 "-h, --help This help",
9356 "--125 125 kHz frequency",
9357 "--134 134 kHz frequency",
9358 "-a, --avg <0|1> averaging - if set, will average the stored sample value when decimating (default 1)",
9359 "-b, --bps <1-8> sets resolution of bits per sample (default 8)",
9360 "--dec <1-8> sets decimation. A value of N saves only 1 in N samples (default 1)",
9361 "--divisor <19-255> Manually set freq divisor. 88 -> 134 kHz, 95 -> 125 kHz",
9362 "-f, --freq <47-600> manually set frequency in kHz",
9363 "-r, --reset reset values to defaults",
9364 "-s, --skip <dec> sets a number of samples to skip before capture (default 0)",
9365 "-t, --trig <0-128> sets trigger threshold. 0 means no threshold"
9366 ],
9367 "usage": "lf config [-hr] [--125] [--134] [-a <0|1>] [-b <1-8>] [--dec <1-8>] [--divisor <19-255>] [-f <47-600>] [-s <dec>] [-t <0-128>]"
9368 },
9369 "lf hid brute": {
9370 "command": "lf hid brute",
9371 "description": "Enables bruteforce of HID readers with specified facility code or card number. This is an attack against the reader. If the field being bruteforced is provided, it starts with it and goes up / down one step while maintaining other supplied values. If the field being bruteforced is not provided, it will iterate through the full range while maintaining other supplied values.",
9372 "notes": [
9373 "lf hid brute -w H10301 --field fc --fc 224 --cn 6278",
9374 "lf hid brute -w H10301 --field cn --fc 21 -d 2000",
9375 "lf hid brute -v -w H10301 --field cn --fc 21 --cn 200 -d 2000",
9376 "lf hid brute -v -w H10301 --field fc --fc 21 --cn 200 -d 2000 --up"
9377 ],
9378 "offline": false,
9379 "options": [
9380 "-h, --help This help",
9381 "-v, --verbose verbose output",
9382 "-w, --wiegand <format> see `wiegand list` for available formats",
9383 "--field <fc|cn> field to bruteforce",
9384 "--fc <dec> facility code",
9385 "--cn <dec> card number",
9386 "-i, --issue <dec> issue level",
9387 "-o, --oem <dec> OEM code",
9388 "-d, --delay <dec> delay betweens attempts in ms. (def is 1000)",
9389 "--up direction to increment field value. (def is both directions)",
9390 "--down direction to decrement field value. (def is both directions)"
9391 ],
9392 "usage": "lf hid brute [-hv] -w <format> --field <fc|cn> [--fc <dec>] [--cn <dec>] [-i <dec>] [-o <dec>] [-d <dec>] [--up] [--down]"
9393 },
9394 "lf hid clone": {
9395 "command": "lf hid clone",
9396 "description": "clone a HID Prox tag to a T55x7, Q5/T5555 or EM4305/4469 tag. Tag must be on the antenna when issuing this command.",
9397 "notes": [
9398 "lf hid clone -r 2006ec0c86 -> write raw value for T55x7 tag (HID 10301 26 bit)",
9399 "lf hid clone -r 2e0ec00c87 -> write raw value for T55x7 tag (HID Corporate 35 bit)",
9400 "lf hid clone -r 01f0760643c3 -> write raw value for T55x7 tag (HID P10001 40 bit)",
9401 "lf hid clone -r 01400076000c86 -> write raw value for T55x7 tag (HID Corporate 48 bit)",
9402 "lf hid clone -w H10301 --fc 118 --cn 1603 -> HID 10301 26 bit, encode for T55x7 tag",
9403 "lf hid clone -w H10301 --fc 118 --cn 1603 --q5 -> HID 10301 26 bit, encode for Q5/T5555 tag",
9404 "lf hid clone -w H10301 --fc 118 --cn 1603 --em -> HID 10301 26 bit, encode for EM4305/4469"
9405 ],
9406 "offline": false,
9407 "options": [
9408 "-h, --help This help",
9409 "-w, --wiegand <format> see `wiegand list` for available formats",
9410 "--fc <dec> facility code",
9411 "--cn <dec> card number",
9412 "-i <dec> issue level",
9413 "-o, --oem <dec> OEM code",
9414 "-r, --raw <hex> raw bytes",
9415 "--q5 optional - specify writing to Q5/T5555 tag",
9416 "--em optional - specify writing to EM4305/4469 tag",
9417 "--bin <bin> Binary string i.e 0001001001"
9418 ],
9419 "usage": "lf hid clone [-h] [-w <format>] [--fc <dec>] [--cn <dec>] [-i <dec>] [-o <dec>] [-r <hex>] [--q5] [--em] [--bin <bin>]"
9420 },
9421 "lf hid help": {
9422 "command": "lf hid help",
9423 "description": "help this help demod demodulate HID Prox tag from the GraphBuffer --------------------------------------------------------------------------------------- lf hid demod available offline: yes Try to find HID Prox preamble, if found decode / descramble data",
9424 "notes": [
9425 "lf hid demod"
9426 ],
9427 "offline": true,
9428 "options": [
9429 "-h, --help This help"
9430 ],
9431 "usage": "lf hid demod [-h]"
9432 },
9433 "lf hid reader": {
9434 "command": "lf hid reader",
9435 "description": "read a HID Prox tag",
9436 "notes": [
9437 "lf hid reader -@ -> continuous reader mode"
9438 ],
9439 "offline": false,
9440 "options": [
9441 "-h, --help This help",
9442 "-@ optional - continuous reader mode"
9443 ],
9444 "usage": "lf hid reader [-h@]"
9445 },
9446 "lf hid sim": {
9447 "command": "lf hid sim",
9448 "description": "Enables simulation of HID card with card number. Simulation runs until the button is pressed or another USB command is issued.",
9449 "notes": [
9450 "lf hid sim -r 2006ec0c86 -> HID 10301 26 bit",
9451 "lf hid sim -r 2e0ec00c87 -> HID Corporate 35 bit",
9452 "lf hid sim -r 01f0760643c3 -> HID P10001 40 bit",
9453 "lf hid sim -r 01400076000c86 -> HID Corporate 48 bit",
9454 "lf hid sim -w H10301 --fc 118 --cn 1603 -> HID 10301 26 bit"
9455 ],
9456 "offline": false,
9457 "options": [
9458 "-h, --help This help",
9459 "-w, --wiegand <format> see `wiegand list` for available formats",
9460 "--fc <dec> facility code",
9461 "--cn <dec> card number",
9462 "-i <dec> issue level",
9463 "-o, --oem <dec> OEM code",
9464 "-r, --raw <hex> raw bytes"
9465 ],
9466 "usage": "lf hid sim [-h] [-w <format>] [--fc <dec>] [--cn <dec>] [-i <dec>] [-o <dec>] [-r <hex>]"
9467 },
9468 "lf hid watch": {
9469 "command": "lf hid watch",
9470 "description": "Enables HID compatible reader mode printing details. By default, values are printed and logged until the button is pressed or another USB command is issued.",
9471 "notes": [
9472 "lf hid watch"
9473 ],
9474 "offline": false,
9475 "options": [
9476 "-h, --help This help"
9477 ],
9478 "usage": "lf hid watch [-h]"
9479 },
9480 "lf hitag cc": {
9481 "command": "lf hitag cc",
9482 "description": "Check challenges, load a file with saved hitag crypto challenges and test them all. The file should be 8 * 60 bytes long, the file extension defaults to `.cc`",
9483 "notes": [
9484 "lf hitag cc -f my_hitag_challenges"
9485 ],
9486 "offline": false,
9487 "options": [
9488 "-h, --help This help",
9489 "-f, --file <fn> filename to load ( w/o ext )"
9490 ],
9491 "usage": "lf hitag cc [-h] -f <fn>"
9492 },
9493 "lf hitag chk": {
9494 "command": "lf hitag chk",
9495 "description": "Run dictionary key or password recovery against Hitag card.",
9496 "notes": [
9497 "lf hitag chk",
9498 "-> checks for both pwd / crypto keyslf hitag chk --crypto -> use def dictionary",
9499 "lf hitag chk --pwd -f my.dic -> pwd mode, custom dictionary"
9500 ],
9501 "offline": false,
9502 "options": [
9503 "-h, --help This help",
9504 "-f, --file <fn> specify dictionary filename",
9505 "--pwd password mode",
9506 "--crypto crypto mode"
9507 ],
9508 "usage": "lf hitag chk [-h] [-f <fn>] [--pwd] [--crypto]"
9509 },
9510 "lf hitag crack2": {
9511 "command": "lf hitag crack2",
9512 "description": "This command tries to recover 2048 bits of Hitag2 crypto stream data.",
9513 "notes": [
9514 "lf hitag crack2 --nrar 73AA5A62EAB8529C"
9515 ],
9516 "offline": false,
9517 "options": [
9518 "-h, --help This help",
9519 "--nrar <hex> specify nonce / answer as 8 hex bytes"
9520 ],
9521 "usage": "lf hitag lookup [-h] [--nrar <hex>]"
9522 },
9523 "lf hitag dump": {
9524 "command": "lf hitag dump",
9525 "description": "Read all Hitag 2 card memory and save to file Crypto mode key format: ISK high + ISK low, 4F4E4D494B52 (ONMIKR) Password mode, default key 4D494B52 (MIKR)",
9526 "notes": [
9527 "lf hitag dump --pwd -> use def pwd",
9528 "lf hitag dump -k 4D494B52 -> pwd mode",
9529 "lf hitag dump --crypto -> use def crypto",
9530 "lf hitag dump -k 4F4E4D494B52 -> crypto mode",
9531 "lf hitag dump --nrar 0102030411223344"
9532 ],
9533 "offline": false,
9534 "options": [
9535 "-h, --help This help",
9536 "--pwd password mode",
9537 "--nrar <hex> nonce / answer reader, 8 hex bytes",
9538 "--crypto crypto mode",
9539 "-k, --key <hex> key, 4 or 6 hex bytes",
9540 "-f, --file <fn> specify file name",
9541 "--ns no save to file"
9542 ],
9543 "usage": "lf hitag dump [-h] [--pwd] [--nrar <hex>] [--crypto] [-k <hex>] [-f <fn>] [--ns]"
9544 },
9545 "lf hitag eload": {
9546 "command": "lf hitag eload",
9547 "description": "Loads hitag tag dump into emulator memory on device",
9548 "notes": [
9549 "lf hitag eload -2 -f lf-hitag-11223344-dump.bin"
9550 ],
9551 "offline": false,
9552 "options": [
9553 "-h, --help This help",
9554 "-f, --file <fn> Specify dump filename",
9555 "-1, --ht1 Card type Hitag 1",
9556 "-2, --ht2 Card type Hitag 2",
9557 "-s, --hts Card type Hitag S",
9558 "-m, --htm Card type Hitag \u03bc"
9559 ],
9560 "usage": "lf hitag eload [-h12sm] -f <fn>"
9561 },
9562 "lf hitag eview": {
9563 "command": "lf hitag eview",
9564 "description": "It displays emulator memory",
9565 "notes": [
9566 "lf hitag eview"
9567 ],
9568 "offline": false,
9569 "options": [
9570 "-h, --help This help",
9571 "-v, --verbose Verbose output"
9572 ],
9573 "usage": "lf hitag eview [-hv]"
9574 },
9575 "lf hitag help": {
9576 "command": "lf hitag help",
9577 "description": "help This help list List Hitag trace history test Perform self tests view Display content from tag dump file lookup Uses authentication trace to check for key in dictionary file --------------------------------------------------------------------------------------- lf hitag list available offline: yes Alias of `trace list -t hitag2` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
9578 "notes": [
9579 "lf hitag list --frame -> show frame delay times",
9580 "lf hitag list -1 -> use trace buffer"
9581 ],
9582 "offline": true,
9583 "options": [
9584 "-h, --help This help",
9585 "-1, --buffer use data from trace buffer",
9586 "--frame show frame delay times",
9587 "-c mark CRC bytes",
9588 "-r show relative times (gap and duration)",
9589 "-u display times in microseconds instead of clock cycles",
9590 "-x show hexdump to convert to pcap(ng)",
9591 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
9592 "-f, --file <fn> filename of dictionary"
9593 ],
9594 "usage": "lf hitag list [-h1crux] [--frame] [-f <fn>]"
9595 },
9596 "lf hitag info": {
9597 "command": "lf hitag info",
9598 "description": "Hitag2 tag information",
9599 "notes": [
9600 "lf hitag info"
9601 ],
9602 "offline": false,
9603 "options": [
9604 "-h, --help This help"
9605 ],
9606 "usage": "lf hitag info [-h]"
9607 },
9608 "lf hitag lookup": {
9609 "command": "lf hitag lookup",
9610 "description": "This command take sniffed trace data and try to recovery a Hitag2 crypto key. You can either - verify that NR/AR matches a known crypto key - verify if NR/AR matches a known 6 byte crypto key in a dictionary",
9611 "notes": [
9612 "lf hitag lookup --uid 11223344 --nr 73AA5A62 --ar EAB8529C -k 010203040506 -> check key",
9613 "lf hitag lookup --uid 11223344 --nr 73AA5A62 --ar EAB8529C -> use def dictionary",
9614 "lf hitag lookup --uid 11223344 --nr 73AA5A62 --ar EAB8529C -f my.dic -> use custom dictionary",
9615 "lf hitag lookup --uid 11223344 --nrar 73AA5A62EAB8529C"
9616 ],
9617 "offline": true,
9618 "options": [
9619 "-h, --help This help",
9620 "-f, --file <fn> specify dictionary filename",
9621 "-k, --key <hex> specify known cryptokey as 6 bytes",
9622 "-u, --uid <hex> specify UID as 4 hex bytes",
9623 "--nr <hex> specify nonce as 4 hex bytes",
9624 "--ar <hex> specify answer as 4 hex bytes",
9625 "--nrar <hex> specify nonce / answer as 8 hex bytes"
9626 ],
9627 "usage": "lf hitag lookup [-h] [-f <fn>] [-k <hex>] -u <hex> [--nr <hex>] [--ar <hex>] [--nrar <hex>]"
9628 },
9629 "lf hitag read": {
9630 "command": "lf hitag read",
9631 "description": "Read Hitag memory. It support HitagS and Hitag 2 Password mode: - default key 4D494B52 (MIKR) Crypto mode: - key format ISK high + ISK low - default key 4F4E4D494B52 (ONMIKR)",
9632 "notes": [
9633 "lf hitag read --hts -> HitagS, plain mode",
9634 "lf hitag read --hts --nrar 0102030411223344 -> HitagS, challenge mode",
9635 "lf hitag read --hts --crypto -> HitagS, crypto mode, def key",
9636 "lf hitag read --hts -k 4F4E4D494B52 -> HitagS, crypto mode",
9637 "",
9638 "lf hitag read --ht2 --pwd -> Hitag 2, pwd mode, def key",
9639 "lf hitag read --ht2 -k 4D494B52 -> Hitag 2, pwd mode",
9640 "lf hitag read --ht2 --nrar 0102030411223344 -> Hitag 2, challenge mode",
9641 "lf hitag read --ht2 --crypto -> Hitag 2, crypto mode, def key",
9642 "lf hitag read --ht2 -k 4F4E4D494B52 -> Hitag 2, crypto mode"
9643 ],
9644 "offline": false,
9645 "options": [
9646 "-h, --help This help",
9647 "-s, --hts Hitag S",
9648 "-2, --ht2 Hitag 2",
9649 "--pwd password mode",
9650 "--nrar <hex> nonce / answer writer, 8 hex bytes",
9651 "--crypto crypto mode",
9652 "-k, --key <hex> key, 4 or 6 hex bytes"
9653 ],
9654 "usage": "lf hitag read [-hs2] [--pwd] [--nrar <hex>] [--crypto] [-k <hex>]"
9655 },
9656 "lf hitag sim": {
9657 "command": "lf hitag sim",
9658 "description": "Simulate Hitag transponder You need to `lf hitag eload` first",
9659 "notes": [
9660 "lf hitag sim -2"
9661 ],
9662 "offline": false,
9663 "options": [
9664 "-h, --help This help",
9665 "-1, --ht1 simulate Hitag 1",
9666 "-2, --ht2 simulate Hitag 2",
9667 "-s, --hts simulate Hitag S"
9668 ],
9669 "usage": "lf hitag sim [-h12s]"
9670 },
9671 "lf hitag sniff": {
9672 "command": "lf hitag sniff",
9673 "description": "Sniff the communication between reader and tag. Use `lf hitag list` to view collected data.",
9674 "notes": [
9675 "lf hitag sniff"
9676 ],
9677 "offline": false,
9678 "options": [
9679 "-h, --help This help"
9680 ],
9681 "usage": "lf hitag sniff [-h]"
9682 },
9683 "lf hitag test": {
9684 "command": "lf hitag test",
9685 "description": "Perform self tests of Hitag crypto engine",
9686 "notes": [
9687 "lf hitag test"
9688 ],
9689 "offline": true,
9690 "options": [
9691 "-h, --help This help"
9692 ],
9693 "usage": "lf hitag test [-h]"
9694 },
9695 "lf hitag view": {
9696 "command": "lf hitag view",
9697 "description": "Print a HITAG dump file (bin/eml/json)",
9698 "notes": [
9699 "lf hitag view -f lf-hitag-01020304-dump.bin"
9700 ],
9701 "offline": true,
9702 "options": [
9703 "-h, --help This help",
9704 "-f, --file <fn> Specify a filename for dump file",
9705 "-v, --verbose Verbose output"
9706 ],
9707 "usage": "lf hitag view [-hv] -f <fn>"
9708 },
9709 "lf hitag wrbl": {
9710 "command": "lf hitag wrbl",
9711 "description": "Write a page in Hitag memory. It support HitagS and Hitag 2 Password mode: - default key 4D494B52 (MIKR) Crypto mode: - key format ISK high + ISK low - default key 4F4E4D494B52 (ONMIKR)",
9712 "notes": [
9713 "lf hitag wrbl --hts -p 6 -d 01020304 -> HitagS, plain mode",
9714 "lf hitag wrbl --hts -p 6 -d 01020304 --nrar 0102030411223344 -> HitagS, challenge mode",
9715 "lf hitag wrbl --hts -p 6 -d 01020304 --crypto -> HitagS, crypto mode, def key",
9716 "lf hitag wrbl --hts -p 6 -d 01020304 -k 4F4E4D494B52 -> HitagS, crypto mode",
9717 "",
9718 "lf hitag wrbl --ht2 -p 6 -d 01020304 --pwd -> Hitag 2, pwd mode, def key",
9719 "lf hitag wrbl --ht2 -p 6 -d 01020304 -k 4D494B52 -> Hitag 2, pwd mode",
9720 "lf hitag wrbl --ht2 -p 6 -d 01020304 --nrar 0102030411223344 -> Hitag 2, challenge mode",
9721 "lf hitag wrbl --ht2 -p 6 -d 01020304 --crypto -> Hitag 2, crypto mode, def key",
9722 "lf hitag wrbl --ht2 -p 6 -d 01020304 -k 4F4E4D494B52 -> Hitag 2, crypto mode"
9723 ],
9724 "offline": false,
9725 "options": [
9726 "-h, --help This help",
9727 "-s, --hts Hitag S",
9728 "-2, --ht2 Hitag 2",
9729 "--pwd password mode",
9730 "--nrar <hex> nonce / answer writer, 8 hex bytes",
9731 "--crypto crypto mode",
9732 "-k, --key <hex> key, 4 or 6 hex bytes",
9733 "-p, --page <dec> page address to write to",
9734 "-d, --data <hex> data, 4 hex bytes"
9735 ],
9736 "usage": "lf hitag wrbl [-hs2] [--pwd] [--nrar <hex>] [--crypto] [-k <hex>] -p <dec> -d <hex>"
9737 },
9738 "lf idteck clone": {
9739 "command": "lf idteck clone",
9740 "description": "clone a Idteck tag to T55x7 or Q5/T5555 tag Tag must be on the antenna when issuing this command.",
9741 "notes": [
9742 "lf idteck clone --raw 4944544B351FBE4B"
9743 ],
9744 "offline": false,
9745 "options": [
9746 "-h, --help This help",
9747 "-r, --raw <hex> raw bytes",
9748 "--q5 optional - specify writing to Q5/T5555 tag",
9749 "--em optional - specify writing to EM4305/4469 tag"
9750 ],
9751 "usage": "lf idteck clone [-h] -r <hex> [--q5] [--em]"
9752 },
9753 "lf idteck help": {
9754 "command": "lf idteck help",
9755 "description": "help This help demod demodulate an Idteck tag from the GraphBuffer --------------------------------------------------------------------------------------- lf idteck demod available offline: yes Try to find Idteck preamble, if found decode / descramble data",
9756 "notes": [
9757 "lf idteck demod",
9758 "lf idteck demod --raw 4944544B351FBE4B"
9759 ],
9760 "offline": true,
9761 "options": [
9762 "-h, --help This help",
9763 "-r, --raw <hex> raw bytes"
9764 ],
9765 "usage": "lf idteck demod [-h] [-r <hex>]"
9766 },
9767 "lf idteck reader": {
9768 "command": "lf idteck reader",
9769 "description": "read a Idteck tag",
9770 "notes": [
9771 "lf idteck reader -@ -> continuous reader mode"
9772 ],
9773 "offline": false,
9774 "options": [
9775 "-h, --help This help",
9776 "-@ optional - continuous reader mode"
9777 ],
9778 "usage": "lf idteck reader [-h@]"
9779 },
9780 "lf idteck sim": {
9781 "command": "lf idteck sim",
9782 "description": "Enables simulation of Idteck card. Simulation runs until the button is pressed or another USB command is issued.",
9783 "notes": [
9784 "lf idteck sim --raw 4944544B351FBE4B"
9785 ],
9786 "offline": false,
9787 "options": [
9788 "-h, --help This help",
9789 "-r, --raw <hex> raw bytes"
9790 ],
9791 "usage": "lf idteck sim [-h] -r <hex>"
9792 },
9793 "lf indala altdemod": {
9794 "command": "lf indala altdemod",
9795 "description": "Tries to PSK demodulate the graphbuffer as Indala This is uses a alternative way to demodulate and was used from the beginning in the Pm3 client. It's now considered obsolete but remains because it has sometimes its advantages.",
9796 "notes": [
9797 "lf indala altdemod",
9798 "lf indala altdemod --long -> demod a Indala tag from the GraphBuffer as 224 bit long format"
9799 ],
9800 "offline": true,
9801 "options": [
9802 "-h, --help This help",
9803 "-l, --long optional - demod as 224b long format"
9804 ],
9805 "usage": "lf indala altdemod [-hl]"
9806 },
9807 "lf indala clone": {
9808 "command": "lf indala clone",
9809 "description": "clone Indala UID to T55x7 or Q5/T5555 tag using different known formats Warning, encoding with FC/CN doesn't always work",
9810 "notes": [
9811 "lf indala clone --heden 888",
9812 "lf indala clone --fc 123 --cn 1337",
9813 "lf indala clone --fc 123 --cn 1337 --4041x",
9814 "lf indala clone -r a0000000a0002021",
9815 "lf indala clone -r 80000001b23523a6c2e31eba3cbee4afb3c6ad1fcf649393928c14e5"
9816 ],
9817 "offline": false,
9818 "options": [
9819 "-h, --help This help",
9820 "-r, --raw <hex> raw bytes",
9821 "--heden <decimal> Card number for Heden 2L format",
9822 "--fc <decimal> Facility code (26 bit H10301 format)",
9823 "--cn <decimal> Card number (26 bit H10301 format)",
9824 "--q5 Optional - specify writing to Q5/T5555 tag",
9825 "--em Optional - specify writing to EM4305/4469 tag",
9826 "--4041x Optional - specify Indala 4041X format, must use with fc and cn"
9827 ],
9828 "usage": "lf indala clone [-h] [-r <hex>] [--heden <decimal>] [--fc <decimal>] [--cn <decimal>] [--q5] [--em] [--4041x]"
9829 },
9830 "lf indala demod": {
9831 "command": "lf indala demod",
9832 "description": "Tries to PSK demodulate the graphbuffer as Indala",
9833 "notes": [
9834 "lf indala demod",
9835 "lf indala demod --clock 32 -> demod a Indala tag from the GraphBuffer using a clock of RF/32",
9836 "lf indala demod --clock 32 -i -> demod a Indala tag from the GraphBuffer using a clock of RF/32 and inverting data",
9837 "lf indala demod --clock 64 -i --maxerror 0 -> demod a Indala tag from the GraphBuffer using a clock of RF/64, inverting data and allowing 0 demod errors"
9838 ],
9839 "offline": true,
9840 "options": [
9841 "-h, --help This help",
9842 "--clock <dec> optional - set clock (as integer), if not set, autodetect.",
9843 "--maxerr <dec> optional - set maximum allowed errors, default = 100",
9844 "-i, --invert optional - invert output"
9845 ],
9846 "usage": "lf indala demod [-hi] [--clock <dec>] [--maxerr <dec>]"
9847 },
9848 "lf indala help": {
9849 "command": "lf indala help",
9850 "description": "help This help demod Demodulate an Indala tag (PSK1) from the GraphBuffer altdemod Alternative method to demodulate samples for Indala 64 bit UID (option '224' for 224 bit) --------------------------------------------------------------------------------------- lf indala brute available offline: no Enables bruteforce of INDALA readers with specified facility code. This is a attack against reader. if cardnumber is given, it starts with it and goes up / down one step if cardnumber is not given, it starts with 1 and goes up to 65535",
9851 "notes": [
9852 "lf indala brute --fc 224",
9853 "lf indala brute --fc 21 -d 2000",
9854 "lf indala brute -v --fc 21 --cn 200 -d 2000",
9855 "lf indala brute -v --fc 21 --cn 200 -d 2000 --up"
9856 ],
9857 "offline": true,
9858 "options": [
9859 "-h, --help This help",
9860 "-v, --verbose verbose output",
9861 "--fc <dec> facility code",
9862 "--cn <dec> card number to start with",
9863 "-d, --delay <dec> delay betweens attempts in ms. Default 1000ms",
9864 "--up direction to increment card number. (default is both directions)",
9865 "--down direction to decrement card number. (default is both directions)",
9866 "--4041x specify Indala 4041X format"
9867 ],
9868 "usage": "lf indala brute [-hv] [--fc <dec>] [--cn <dec>] [-d <dec>] [--up] [--down] [--4041x]"
9869 },
9870 "lf indala reader": {
9871 "command": "lf indala reader",
9872 "description": "read a Indala tag",
9873 "notes": [
9874 "lf indala reader -@ -> continuous reader mode"
9875 ],
9876 "offline": false,
9877 "options": [
9878 "-h, --help This help",
9879 "--clock <dec> optional - set clock (as integer), if not set, autodetect.",
9880 "--maxerr <dec> optional - set maximum allowed errors, default = 100",
9881 "-i, --invert optional - invert output",
9882 "-@ optional - continuous reader mode"
9883 ],
9884 "usage": "lf indala reader [-hi@] [--clock <dec>] [--maxerr <dec>]"
9885 },
9886 "lf indala sim": {
9887 "command": "lf indala sim",
9888 "description": "Enables simulation of Indala card with specified facility code and card number. Simulation runs until the button is pressed or another USB command is issued.",
9889 "notes": [
9890 "lf indala sim --heden 888",
9891 "lf indala sim --fc 123 --cn 1337",
9892 "lf indala sim --fc 123 --cn 1337 --4041x",
9893 "lf indala sim --raw a0000000a0002021",
9894 "lf indala sim --raw 80000001b23523a6c2e31eba3cbee4afb3c6ad1fcf649393928c14e5"
9895 ],
9896 "offline": false,
9897 "options": [
9898 "-h, --help This help",
9899 "-r, --raw <hex> raw bytes",
9900 "--heden <decimal> Cardnumber for Heden 2L format",
9901 "--fc <decimal> Facility code (26 bit H10301 format)",
9902 "--cn <decimal> Card number (26 bit H10301 format)",
9903 "--4041x Optional - specify Indala 4041X format, must use with fc and cn"
9904 ],
9905 "usage": "lf indala sim [-h] [-r <hex>] [--heden <decimal>] [--fc <decimal>] [--cn <decimal>] [--4041x]"
9906 },
9907 "lf io clone": {
9908 "command": "lf io clone",
9909 "description": "clone a ioProx card with specified facility-code and card number to a T55x7, Q5/T5555 or EM4305/4469 tag. Tag must be on the antenna when issuing this command.",
9910 "notes": [
9911 "lf io clone --vn 1 --fc 101 --cn 1337"
9912 ],
9913 "offline": false,
9914 "options": [
9915 "-h, --help This help",
9916 "--vn <dec> 8bit version",
9917 "--fc <dec> 8bit facility code",
9918 "--cn <dec> 16bit card number",
9919 "--q5 optional - specify writing to Q5/T5555 tag",
9920 "--em optional - specify writing to EM4305/4469 tag"
9921 ],
9922 "usage": "lf io clone [-h] --vn <dec> --fc <dec> --cn <dec> [--q5] [--em]"
9923 },
9924 "lf io help": {
9925 "command": "lf io help",
9926 "description": "help this help demod demodulate an ioProx tag from the GraphBuffer --------------------------------------------------------------------------------------- lf io demod available offline: yes Try to find ioProx preamble, if found decode / descramble data",
9927 "notes": [
9928 "lf io demod"
9929 ],
9930 "offline": true,
9931 "options": [
9932 "-h, --help This help"
9933 ],
9934 "usage": "lf io demod [-h]"
9935 },
9936 "lf io reader": {
9937 "command": "lf io reader",
9938 "description": "read a ioProx tag",
9939 "notes": [
9940 "lf io reader -@ -> continuous reader mode"
9941 ],
9942 "offline": false,
9943 "options": [
9944 "-h, --help This help",
9945 "-@ optional - continuous reader mode"
9946 ],
9947 "usage": "lf io reader [-h@]"
9948 },
9949 "lf io sim": {
9950 "command": "lf io sim",
9951 "description": "Enables simulation of ioProx card with specified facility-code and card number. Simulation runs until the button is pressed or another USB command is issued.",
9952 "notes": [
9953 "lf io sim --vn 1 --fc 101 --cn 1337"
9954 ],
9955 "offline": false,
9956 "options": [
9957 "-h, --help This help",
9958 "--vn <dec> 8bit version",
9959 "--fc <dec> 8bit facility code",
9960 "--cn <dec> 16bit card number"
9961 ],
9962 "usage": "lf io sim [-h] --vn <dec> --fc <dec> --cn <dec>"
9963 },
9964 "lf io watch": {
9965 "command": "lf io watch",
9966 "description": "Enables ioProx compatible reader mode printing details. By default, values are printed and logged until the button is pressed or another USB command is issued.",
9967 "notes": [
9968 "lf io watch"
9969 ],
9970 "offline": false,
9971 "options": [
9972 "-h, --help This help"
9973 ],
9974 "usage": "lf io watch [-h]"
9975 },
9976 "lf jablotron clone": {
9977 "command": "lf jablotron clone",
9978 "description": "clone a Jablotron tag to a T55x7, Q5/T5555 or EM4305/4469 tag. Tag must be on the antenna when issuing this command.",
9979 "notes": [
9980 "lf jablotron clone --cn 01b669 -> encode for T55x7 tag",
9981 "lf jablotron clone --cn 01b669 --q5 -> encode for Q5/T5555 tag",
9982 "lf jablotron clone --cn 01b669 --em -> encode for EM4305/4469"
9983 ],
9984 "offline": false,
9985 "options": [
9986 "-h, --help This help",
9987 "--cn <hex> Jablotron card ID - 5 bytes max",
9988 "--q5 optional - specify writing to Q5/T5555 tag",
9989 "--em optional - specify writing to EM4305/4469 tag"
9990 ],
9991 "usage": "lf jablotron clone [-h] --cn <hex> [--q5] [--em]"
9992 },
9993 "lf jablotron help": {
9994 "command": "lf jablotron help",
9995 "description": "help This help demod demodulate an Jablotron tag from the GraphBuffer --------------------------------------------------------------------------------------- lf jablotron demod available offline: yes Try to find Jablotron preamble, if found decode / descramble data",
9996 "notes": [
9997 "lf jablotron demod"
9998 ],
9999 "offline": true,
10000 "options": [
10001 "-h, --help This help"
10002 ],
10003 "usage": "lf jablotron demod [-h]"
10004 },
10005 "lf jablotron reader": {
10006 "command": "lf jablotron reader",
10007 "description": "read a jablotron tag",
10008 "notes": [
10009 "lf jablotron reader -@ -> continuous reader mode"
10010 ],
10011 "offline": false,
10012 "options": [
10013 "-h, --help This help",
10014 "-@ optional - continuous reader mode"
10015 ],
10016 "usage": "lf jablotron reader [-h@]"
10017 },
10018 "lf jablotron sim": {
10019 "command": "lf jablotron sim",
10020 "description": "Enables simulation of jablotron card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10021 "notes": [
10022 "lf jablotron sim --cn 01b669"
10023 ],
10024 "offline": false,
10025 "options": [
10026 "-h, --help This help",
10027 "--cn <hex> Jablotron card ID - 5 bytes max"
10028 ],
10029 "usage": "lf jablotron sim [-h] --cn <hex>"
10030 },
10031 "lf keri clone": {
10032 "command": "lf keri clone",
10033 "description": "clone a KERI tag to a T55x7, Q5/T5555 or EM4305/4469 tag",
10034 "notes": [
10035 "lf keri clone -t i --cn 12345 -> Internal ID",
10036 "lf keri clone -t m --fc 6 --cn 12345 -> MS ID"
10037 ],
10038 "offline": false,
10039 "options": [
10040 "-h, --help This help",
10041 "-t, --type <m|i> Type m - MS, i - Internal ID",
10042 "--fc <dec> Facility Code",
10043 "--cn <dec> KERI card ID",
10044 "--q5 specify writing to Q5/T5555 tag",
10045 "--em specify writing to EM4305/4469 tag"
10046 ],
10047 "usage": "lf keri clone [-h] [-t <m|i>] [--fc <dec>] --cn <dec> [--q5] [--em]"
10048 },
10049 "lf keri help": {
10050 "command": "lf keri help",
10051 "description": "help This help demod demodulate an KERI tag from the GraphBuffer --------------------------------------------------------------------------------------- lf keri demod available offline: yes Try to find KERI preamble, if found decode / descramble data",
10052 "notes": [
10053 "lf keri demod"
10054 ],
10055 "offline": true,
10056 "options": [
10057 "-h, --help This help"
10058 ],
10059 "usage": "lf keri demod [-h]"
10060 },
10061 "lf keri reader": {
10062 "command": "lf keri reader",
10063 "description": "read a keri tag",
10064 "notes": [
10065 "lf keri reader -@ -> continuous reader mode"
10066 ],
10067 "offline": false,
10068 "options": [
10069 "-h, --help This help",
10070 "-@ optional - continuous reader mode"
10071 ],
10072 "usage": "lf keri reader [-h@]"
10073 },
10074 "lf keri sim": {
10075 "command": "lf keri sim",
10076 "description": "Enables simulation of KERI card with internal ID. You supply a KERI card id and it will converted to a KERI internal ID.",
10077 "notes": [
10078 "lf keri sim --cn 112233"
10079 ],
10080 "offline": false,
10081 "options": [
10082 "-h, --help This help",
10083 "--id <dec> KERI card ID"
10084 ],
10085 "usage": "lf keri sim [-h] --id <dec>"
10086 },
10087 "lf motorola clone": {
10088 "command": "lf motorola clone",
10089 "description": "clone Motorola UID to a T55x7, Q5/T5555 or EM4305/4469 tag. defaults to 64 bit format",
10090 "notes": [
10091 "lf motorola clone --raw a0000000a0002021 -> encode for T55x7 tag",
10092 "lf motorola clone --raw a0000000a0002021 --q5 -> encode for Q5/T5555 tag",
10093 "lf motorola clone --raw a0000000a0002021 --em -> encode for EM4305/4469"
10094 ],
10095 "offline": false,
10096 "options": [
10097 "-h, --help This help",
10098 "-r, --raw <hex> raw hex bytes. 8 bytes",
10099 "--q5 optional - specify writing to Q5/T5555 tag",
10100 "--em optional - specify writing to EM4305/4469 tag"
10101 ],
10102 "usage": "lf motorola clone [-h] -r <hex> [--q5] [--em]"
10103 },
10104 "lf motorola help": {
10105 "command": "lf motorola help",
10106 "description": "help This help demod demodulate an MOTOROLA tag from the GraphBuffer --------------------------------------------------------------------------------------- lf motorola demod available offline: yes Try to find Motorola Flexpass preamble, if found decode / descramble data",
10107 "notes": [
10108 "lf motorola demod"
10109 ],
10110 "offline": true,
10111 "options": [
10112 "-h, --help This help"
10113 ],
10114 "usage": "lf motorola demod [-h]"
10115 },
10116 "lf motorola reader": {
10117 "command": "lf motorola reader",
10118 "description": "read a Motorola Flexpass tag",
10119 "notes": [
10120 "lf motorola reader -@ -> continuous reader mode"
10121 ],
10122 "offline": false,
10123 "options": [
10124 "-h, --help This help",
10125 "-@ optional - continuous reader mode"
10126 ],
10127 "usage": "lf motorola reader [-h@]"
10128 },
10129 "lf motorola sim": {
10130 "command": "lf motorola sim",
10131 "description": "Enables simulation of Motorola card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10132 "notes": [
10133 "lf motorola sim"
10134 ],
10135 "offline": false,
10136 "options": [
10137 "-h, --help This help"
10138 ],
10139 "usage": "lf motorola sim [-h]"
10140 },
10141 "lf nedap clone": {
10142 "command": "lf nedap clone",
10143 "description": "clone a Nedap tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10144 "notes": [
10145 "lf nedap clone --st 1 --cc 101 --id 1337"
10146 ],
10147 "offline": false,
10148 "options": [
10149 "-h, --help This help",
10150 "--st <dec> optional - sub type (default 5)",
10151 "--cc <dec> customer code (0-4095)",
10152 "--id <dec> ID (0-99999)",
10153 "-l, --long optional - long (128), default to short (64)",
10154 "--q5 optional - specify writing to Q5/T5555 tag",
10155 "--em optional - specify writing to EM4305/4469 tag"
10156 ],
10157 "usage": "lf nedap clone [-hl] [--st <dec>] --cc <dec> --id <dec> [--q5] [--em]"
10158 },
10159 "lf nedap help": {
10160 "command": "lf nedap help",
10161 "description": "help This help demod demodulate Nedap tag from the GraphBuffer --------------------------------------------------------------------------------------- lf nedap demod available offline: yes Try to find Nedap preamble, if found decode / descramble data",
10162 "notes": [
10163 "lf nedap demod"
10164 ],
10165 "offline": true,
10166 "options": [
10167 "-h, --help This help"
10168 ],
10169 "usage": "lf nedap demod [-h]"
10170 },
10171 "lf nedap reader": {
10172 "command": "lf nedap reader",
10173 "description": "read a Nedap tag",
10174 "notes": [
10175 "lf nedap reader -@ -> continuous reader mode"
10176 ],
10177 "offline": false,
10178 "options": [
10179 "-h, --help This help",
10180 "-@ optional - continuous reader mode"
10181 ],
10182 "usage": "lf nedap reader [-h@]"
10183 },
10184 "lf nedap sim": {
10185 "command": "lf nedap sim",
10186 "description": "Enables simulation of NEDAP card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10187 "notes": [
10188 "lf nedap sim --st 1 --cc 101 --id 1337"
10189 ],
10190 "offline": false,
10191 "options": [
10192 "-h, --help This help",
10193 "--st <dec> optional - sub type (default 5)",
10194 "--cc <dec> customer code (0-4095)",
10195 "--id <dec> ID (0-99999)",
10196 "-l, --long optional - long (128), default to short (64)"
10197 ],
10198 "usage": "lf nedap sim [-hl] [--st <dec>] --cc <dec> --id <dec>"
10199 },
10200 "lf nexwatch clone": {
10201 "command": "lf nexwatch clone",
10202 "description": "clone a Nexwatch tag to a T55x7, Q5/T5555 or EM4305/4469 tag. You can use raw hex values or create a credential based on id, mode and type of credential (Nexkey / Quadrakey / Russian)",
10203 "notes": [
10204 "lf nexwatch clone --raw 5600000000213C9F8F150C00",
10205 "lf nexwatch clone --cn 521512301 -m 1 --nc -> Nexkey credential",
10206 "lf nexwatch clone --cn 521512301 -m 1 --qc -> Quadrakey credential",
10207 "lf nexwatch clone --cn 521512301 -m 1 --hc -> Honeywell credential"
10208 ],
10209 "offline": false,
10210 "options": [
10211 "-h, --help This help",
10212 "-r, --raw <hex> raw hex data. 12 bytes",
10213 "--cn <dec> card id",
10214 "-m, --mode <dec> mode (decimal) (0-15, defaults to 1)",
10215 "--nc Nexkey credential",
10216 "--qc Quadrakey credential",
10217 "--hc Honeywell credential",
10218 "--q5 optional - specify writing to Q5/T5555 tag",
10219 "--em optional - specify writing to EM4305/4469 tag",
10220 "--magic <hex> optional - magic hex data. 1 byte",
10221 "--psk2 optional - specify writing a tag in psk2 modulation"
10222 ],
10223 "usage": "lf nexwatch clone [-h] [-r <hex>] [--cn <dec>] [-m <dec>] [--nc] [--qc] [--hc] [--q5] [--em] [--magic <hex>] [--psk2]"
10224 },
10225 "lf nexwatch help": {
10226 "command": "lf nexwatch help",
10227 "description": "help This help demod demodulate a NexWatch tag (nexkey, quadrakey) from the GraphBuffer --------------------------------------------------------------------------------------- lf nexwatch demod available offline: yes Try to find Nexwatch preamble, if found decode / descramble data",
10228 "notes": [
10229 "lf nexwatch demod"
10230 ],
10231 "offline": true,
10232 "options": [
10233 "-h, --help This help"
10234 ],
10235 "usage": "lf nexwatch demod [-h]"
10236 },
10237 "lf nexwatch reader": {
10238 "command": "lf nexwatch reader",
10239 "description": "read a Nexwatch tag",
10240 "notes": [
10241 "lf nexwatch reader -@ -> continuous reader mode"
10242 ],
10243 "offline": false,
10244 "options": [
10245 "-h, --help This help",
10246 "-@ optional - continuous reader mode"
10247 ],
10248 "usage": "lf nexwatch reader [-h@]"
10249 },
10250 "lf nexwatch sim": {
10251 "command": "lf nexwatch sim",
10252 "description": "Enables simulation of secura card with specified card number. Simulation runs until the button is pressed or another USB command is issued. You can use raw hex values or create a credential based on id, mode and type of credential (Nexkey/Quadrakey)",
10253 "notes": [
10254 "lf nexwatch sim --raw 5600000000213C9F8F150C00",
10255 "lf nexwatch sim --cn 521512301 -m 1 --nc -> Nexkey credential",
10256 "lf nexwatch sim --cn 521512301 -m 1 --qc -> Quadrakey credential",
10257 "lf nexwatch sim --cn 521512301 -m 1 --hc -> Honeywell credential"
10258 ],
10259 "offline": false,
10260 "options": [
10261 "-h, --help This help",
10262 "-r, --raw <hex> raw hex data. 12 bytes",
10263 "--cn <dec> card id",
10264 "-m, --mode <dec> mode (decimal) (0-15, defaults to 1)",
10265 "--nc Nexkey credential",
10266 "--qc Quadrakey credential",
10267 "--hc Honeywell credential",
10268 "--magic <hex> optional - magic hex data. 1 byte",
10269 "--psk2 optional - specify writing a tag in psk2 modulation"
10270 ],
10271 "usage": "lf nexwatch sim [-h] [-r <hex>] [--cn <dec>] [-m <dec>] [--nc] [--qc] [--hc] [--magic <hex>] [--psk2]"
10272 },
10273 "lf noralsy clone": {
10274 "command": "lf noralsy clone",
10275 "description": "clone a Noralsy tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10276 "notes": [
10277 "lf noralsy clone --cn 112233 -> encode for T55x7 tag",
10278 "lf noralsy clone --cn 112233 --q5 -> encode for Q5/T5555 tag",
10279 "lf noralsy clone --cn 112233 --em -> encode for EM4305/4469"
10280 ],
10281 "offline": false,
10282 "options": [
10283 "-h, --help This help",
10284 "--cn <dec> Noralsy card ID",
10285 "-y, --year <dec> tag allocation year",
10286 "--q5 optional - specify writing to Q5/T5555 tag",
10287 "--em optional - specify writing to EM4305/4469 tag"
10288 ],
10289 "usage": "lf noralsy clone [-h] --cn <dec> [-y <dec>] [--q5] [--em]"
10290 },
10291 "lf noralsy help": {
10292 "command": "lf noralsy help",
10293 "description": "help This help demod demodulate an Noralsy tag from the GraphBuffer --------------------------------------------------------------------------------------- lf noralsy demod available offline: yes Try to find Noralsy preamble, if found decode / descramble data",
10294 "notes": [
10295 "lf noralsy demod"
10296 ],
10297 "offline": true,
10298 "options": [
10299 "-h, --help This help"
10300 ],
10301 "usage": "lf noralsy demod [-h]"
10302 },
10303 "lf noralsy reader": {
10304 "command": "lf noralsy reader",
10305 "description": "read a Noralsy tag",
10306 "notes": [
10307 "lf noralsy reader -@ -> continuous reader mode"
10308 ],
10309 "offline": false,
10310 "options": [
10311 "-h, --help This help",
10312 "-@ optional - continuous reader mode"
10313 ],
10314 "usage": "lf noralsy reader [-h@]"
10315 },
10316 "lf noralsy sim": {
10317 "command": "lf noralsy sim",
10318 "description": "Enables simulation of Noralsy card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10319 "notes": [
10320 "lf noralsy sim --cn 1337",
10321 "lf noralsy sim --cn 1337 --year 2010"
10322 ],
10323 "offline": false,
10324 "options": [
10325 "-h, --help This help",
10326 "--cn <dec> Noralsy card ID",
10327 "-y, --year <dec> tag allocation year"
10328 ],
10329 "usage": "lf noralsy sim [-h] --cn <dec> [-y <dec>]"
10330 },
10331 "lf pac clone": {
10332 "command": "lf pac clone",
10333 "description": "clone a PAC/Stanley tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10334 "notes": [
10335 "lf pac clone --cn CD4F5552 -> encode for T55x7 tag",
10336 "lf pac clone --cn CD4F5552 --q5 -> encode for Q5/T5555 tag",
10337 "lf pac clone --cn CD4F5552 --em -> encode for EM4305/4469",
10338 "lf pac clone --raw FF2049906D8511C593155B56D5B2649F -> encode for T55x7 tag, raw mode"
10339 ],
10340 "offline": false,
10341 "options": [
10342 "-h, --help This help",
10343 "--cn <dec> 8 byte PAC/Stanley card ID",
10344 "-r, --raw <hex> raw hex data. 16 bytes max",
10345 "--q5 optional - specify writing to Q5/T5555 tag",
10346 "--em optional - specify writing to EM4305/4469 tag"
10347 ],
10348 "usage": "lf pac clone [-h] [--cn <dec>] [-r <hex>] [--q5] [--em]"
10349 },
10350 "lf pac help": {
10351 "command": "lf pac help",
10352 "description": "help This help demod demodulate a PAC tag from the GraphBuffer --------------------------------------------------------------------------------------- lf pac demod available offline: yes Try to find PAC/Stanley preamble, if found decode / descramble data",
10353 "notes": [
10354 "lf pac demod"
10355 ],
10356 "offline": true,
10357 "options": [
10358 "-h, --help This help"
10359 ],
10360 "usage": "lf pac demod [-h]"
10361 },
10362 "lf pac reader": {
10363 "command": "lf pac reader",
10364 "description": "read a PAC/Stanley tag",
10365 "notes": [
10366 "lf pac reader -@ -> continuous reader mode"
10367 ],
10368 "offline": false,
10369 "options": [
10370 "-h, --help This help",
10371 "-@ optional - continuous reader mode"
10372 ],
10373 "usage": "lf pac reader [-h@]"
10374 },
10375 "lf pac sim": {
10376 "command": "lf pac sim",
10377 "description": "Enables simulation of PAC/Stanley card with specified card number. Simulation runs until the button is pressed or another USB command is issued. The card ID is 8 byte number. Larger values are truncated.",
10378 "notes": [
10379 "lf pac sim --cn CD4F5552",
10380 "lf pac sim --raw FF2049906D8511C593155B56D5B2649F"
10381 ],
10382 "offline": false,
10383 "options": [
10384 "-h, --help This help",
10385 "--cn <dec> 8 byte PAC/Stanley card ID",
10386 "-r, --raw <hex> raw hex data. 16 bytes max"
10387 ],
10388 "usage": "lf pac sim [-h] [--cn <dec>] [-r <hex>]"
10389 },
10390 "lf paradox clone": {
10391 "command": "lf paradox clone",
10392 "description": "clone a paradox tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10393 "notes": [
10394 "lf paradox clone --fc 96 --cn 40426 -> encode for T55x7 tag with fc and cn",
10395 "lf paradox clone --raw 0f55555695596a6a9999a59a -> encode for T55x7 tag",
10396 "lf paradox clone --raw 0f55555695596a6a9999a59a --q5 -> encode for Q5/T5555 tag",
10397 "lf paradox clone --raw 0f55555695596a6a9999a59a --em -> encode for EM4305/4469"
10398 ],
10399 "offline": false,
10400 "options": [
10401 "-h, --help This help",
10402 "-r, --raw <hex> raw hex data. 12 bytes max",
10403 "--fc <dec> facility code",
10404 "--cn <dec> card number",
10405 "--q5 optional - specify writing to Q5/T5555 tag",
10406 "--em optional - specify writing to EM4305/4469 tag"
10407 ],
10408 "usage": "lf paradox clone [-h] [-r <hex>] [--fc <dec>] [--cn <dec>] [--q5] [--em]"
10409 },
10410 "lf paradox help": {
10411 "command": "lf paradox help",
10412 "description": "help This help demod demodulate a Paradox FSK tag from the GraphBuffer --------------------------------------------------------------------------------------- lf paradox demod available offline: yes Try to find Paradox preamble, if found decode / descramble data",
10413 "notes": [
10414 "lf paradox demod --old -> Display previous checksum version"
10415 ],
10416 "offline": true,
10417 "options": [
10418 "-h, --help This help",
10419 "--old optional - Display previous checksum version"
10420 ],
10421 "usage": "lf paradox demod [-h] [--old]"
10422 },
10423 "lf paradox reader": {
10424 "command": "lf paradox reader",
10425 "description": "read a Paradox tag",
10426 "notes": [
10427 "lf paradox reader -@ -> continuous reader mode",
10428 "lf paradox reader --old -> Display previous checksum version"
10429 ],
10430 "offline": false,
10431 "options": [
10432 "-h, --help This help",
10433 "-@ optional - continuous reader mode",
10434 "--old optional - Display previous checksum version"
10435 ],
10436 "usage": "lf paradox reader [-h@] [--old]"
10437 },
10438 "lf paradox sim": {
10439 "command": "lf paradox sim",
10440 "description": "Enables simulation of paradox card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10441 "notes": [
10442 "lf paradox sim --raw 0f55555695596a6a9999a59a -> simulate tag",
10443 "lf paradox sim --fc 96 --cn 40426 -> simulate tag with fc and cn"
10444 ],
10445 "offline": false,
10446 "options": [
10447 "-h, --help This help",
10448 "-r, --raw <hex> raw hex data. 12 bytes",
10449 "--fc <dec> facility code",
10450 "--cn <dec> card number"
10451 ],
10452 "usage": "lf paradox sim [-h] [-r <hex>] [--fc <dec>] [--cn <dec>]"
10453 },
10454 "lf pcf7931 config": {
10455 "command": "lf pcf7931 config",
10456 "description": "This command tries to set the configuration used with PCF7931 commands The time offsets could be useful to correct slew rate generated by the antenna Caling without some parameter will print the current configuration.",
10457 "notes": [
10458 "lf pcf7931 config --reset",
10459 "lf pcf7931 config --pwd 11223344556677 -d 20000",
10460 "lf pcf7931 config --pwd 11223344556677 -d 17500 --lw -10 --lp 30"
10461 ],
10462 "offline": true,
10463 "options": [
10464 "-h, --help This help",
10465 "-r, --reset Reset configuration to default values",
10466 "-p, --pwd <hex> Password, 7bytes, LSB-order",
10467 "-d, --delay <dec> Tag initialization delay (in us)",
10468 "--lw <dec> offset, low pulses width (in us)",
10469 "--lp <dec> offset, low pulses position (in us)"
10470 ],
10471 "usage": "lf pcf7931 config [-hr] [-p <hex>] [-d <dec>] [--lw <dec>] [--lp <dec>]"
10472 },
10473 "lf pcf7931 help": {
10474 "command": "lf pcf7931 help",
10475 "description": "help This help config Configure the password, the tags initialization delay and time offsets (optional) --------------------------------------------------------------------------------------- lf pcf7931 reader available offline: no read a PCF7931 tag",
10476 "notes": [
10477 "lf pcf7931 reader -@ -> continuous reader mode"
10478 ],
10479 "offline": true,
10480 "options": [
10481 "-h, --help This help",
10482 "-@ optional - continuous reader mode"
10483 ],
10484 "usage": "lf pcf7931 reader [-h@]"
10485 },
10486 "lf pcf7931 write": {
10487 "command": "lf pcf7931 write",
10488 "description": "This command tries to write a PCF7931 tag.",
10489 "notes": [
10490 "lf pcf7931 write --blk 2 --idx 1 -d FF -> Write 0xFF to block 2, index 1"
10491 ],
10492 "offline": false,
10493 "options": [
10494 "-h, --help This help",
10495 "-b, --blk <dec> [0-7] block number",
10496 "-i, --idx <dec> [0-15] index of byte inside block",
10497 "-d, --data <hex> one byte to be written"
10498 ],
10499 "usage": "lf pcf7931 write [-h] -b <dec> -i <dec> -d <hex>"
10500 },
10501 "lf presco clone": {
10502 "command": "lf presco clone",
10503 "description": "clone a presco tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10504 "notes": [
10505 "lf presco clone -d 018363467 -> encode for T55x7 tag",
10506 "lf presco clone -d 018363467 --q5 -> encode for Q5/T5555 tag",
10507 "lf presco clone -d 018363467 --em -> encode for EM4305/4469"
10508 ],
10509 "offline": false,
10510 "options": [
10511 "-h, --help This help",
10512 "-c <hex> 8 digit hex card number",
10513 "-d <digits> 9 digit presco card ID",
10514 "--q5 optional - specify writing to Q5/T5555 tag",
10515 "--em optional - specify writing to EM4305/4469 tag"
10516 ],
10517 "usage": "lf presco clone [-h] [-c <hex>] [-d <digits>] [--q5] [--em]"
10518 },
10519 "lf presco help": {
10520 "command": "lf presco help",
10521 "description": "help This help demod demodulate Presco tag from the GraphBuffer --------------------------------------------------------------------------------------- lf presco demod available offline: yes Try to find presco preamble, if found decode / descramble data",
10522 "notes": [
10523 "lf presco demod"
10524 ],
10525 "offline": true,
10526 "options": [
10527 "-h, --help This help"
10528 ],
10529 "usage": "lf presco demod [-h]"
10530 },
10531 "lf presco reader": {
10532 "command": "lf presco reader",
10533 "description": "read a presco tag",
10534 "notes": [
10535 "lf presco reader -@ -> continuous reader mode"
10536 ],
10537 "offline": false,
10538 "options": [
10539 "-h, --help This help",
10540 "-@ optional - continuous reader mode"
10541 ],
10542 "usage": "lf presco reader [-h@]"
10543 },
10544 "lf presco sim": {
10545 "command": "lf presco sim",
10546 "description": "Enables simulation of presco card with specified card number. Simulation runs until the button is pressed or another USB command is issued. Per presco format, the card number is 9 digit number and can contain *# chars. Larger values are truncated.",
10547 "notes": [
10548 "lf presco sim -d 018363467"
10549 ],
10550 "offline": false,
10551 "options": [
10552 "-h, --help This help",
10553 "-c <hex> 8 digit hex card number",
10554 "-d <digits> 9 digit presco card ID"
10555 ],
10556 "usage": "lf presco sim [-h] [-c <hex>] [-d <digits>]"
10557 },
10558 "lf pyramid clone": {
10559 "command": "lf pyramid clone",
10560 "description": "clone a Farpointe/Pyramid tag to a T55x7, Q5/T5555 or EM4305/4469 tag. The facility-code is 8-bit and the card number is 16-bit. Larger values are truncated. Currently only works on 26bit",
10561 "notes": [
10562 "lf pyramid clone --fc 123 --cn 11223 -> encode for T55x7 tag",
10563 "lf pyramid clone --raw 0001010101010101010440013223921c -> idem, raw mode",
10564 "lf pyramid clone --fc 123 --cn 11223 --q5 -> encode for Q5/T5555 tag",
10565 "lf pyramid clone --fc 123 --cn 11223 --em -> encode for EM4305/4469"
10566 ],
10567 "offline": false,
10568 "options": [
10569 "-h, --help This help",
10570 "--fc <dec> 8-bit value facility code",
10571 "--cn <dec> 16-bit value card number",
10572 "--q5 optional - specify writing to Q5/T5555 tag",
10573 "--em optional - specify writing to EM4305/4469 tag",
10574 "-r, --raw <hex> raw hex data. 16 bytes"
10575 ],
10576 "usage": "lf pyramid clone [-h] [--fc <dec>] [--cn <dec>] [--q5] [--em] [-r <hex>]"
10577 },
10578 "lf pyramid help": {
10579 "command": "lf pyramid help",
10580 "description": "help this help demod demodulate a Pyramid FSK tag from the GraphBuffer --------------------------------------------------------------------------------------- lf pyramid demod available offline: yes Try to find Farpoint/Pyramid preamble, if found decode / descramble data",
10581 "notes": [
10582 "lf pyramid demod"
10583 ],
10584 "offline": true,
10585 "options": [
10586 "-h, --help This help"
10587 ],
10588 "usage": "lf pyramid demod [-h]"
10589 },
10590 "lf pyramid reader": {
10591 "command": "lf pyramid reader",
10592 "description": "read a Farpointe/Pyramid tag",
10593 "notes": [
10594 "lf pyramid reader -@ -> continuous reader mode"
10595 ],
10596 "offline": false,
10597 "options": [
10598 "-h, --help This help",
10599 "-@ optional - continuous reader mode"
10600 ],
10601 "usage": "lf pyramid reader [-h@]"
10602 },
10603 "lf pyramid sim": {
10604 "command": "lf pyramid sim",
10605 "description": "Enables simulation of Farpointe/Pyramid card with specified card number. Simulation runs until the button is pressed or another USB command is issued. The facility-code is 8-bit and the card number is 16-bit. Larger values are truncated. Currently work only on 26bit",
10606 "notes": [
10607 "lf pyramid sim --fc 123 --cn 1337",
10608 "lf pyramid sim --raw 0001010101010101010440013223921c"
10609 ],
10610 "offline": false,
10611 "options": [
10612 "-h, --help This help",
10613 "--fc <dec> 8-bit value facility code",
10614 "--cn <dec> 16-bit value card number",
10615 "-r, --raw <hex> raw hex data. 16 bytes"
10616 ],
10617 "usage": "lf pyramid sim [-h] [--fc <dec>] [--cn <dec>] [-r <hex>]"
10618 },
10619 "lf read": {
10620 "command": "lf read",
10621 "description": "Sniff low frequency signal. - use `lf config` to set parameters. - use `data plot` to look at it. If the number of samples is more than the device memory limit (40000 now), it will try to use the real-time sampling mode.",
10622 "notes": [
10623 "lf read -v -s 12000 -> collect 12000 samples",
10624 "lf read -s 3000 -@ -> oscilloscope style"
10625 ],
10626 "offline": false,
10627 "options": [
10628 "-h, --help This help",
10629 "-s, --samples <dec> number of samples to collect",
10630 "-v, --verbose verbose output",
10631 "-@ continuous reading mode"
10632 ],
10633 "usage": "lf read [-hv@] [-s <dec>]"
10634 },
10635 "lf search": {
10636 "command": "lf search",
10637 "description": "Read and search for valid known tag. For offline mode, you can `data load` first then search.",
10638 "notes": [
10639 "lf search -> try reading data from tag & search for known tag",
10640 "lf search -u -> try reading data from tag & search for known and unknown tag",
10641 "lf search -1 -> use data from the GraphBuffer & search for known tag",
10642 "lf search -1uc -> use data from the GraphBuffer & search for known and unknown tag"
10643 ],
10644 "offline": true,
10645 "options": [
10646 "-h, --help This help",
10647 "-1 Use data from Graphbuffer to search (offline mode)",
10648 "-c Continue searching after successful match",
10649 "-u Search for unknown tags"
10650 ],
10651 "usage": "lf search [-h1cu]"
10652 },
10653 "lf securakey clone": {
10654 "command": "lf securakey clone",
10655 "description": "clone a Securakey tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
10656 "notes": [
10657 "lf securakey clone --raw 7FCB400001ADEA5344300000 -> encode for T55x7 tag",
10658 "lf securakey clone --raw 7FCB400001ADEA5344300000 --q5 -> encode for Q5/T5555 tag",
10659 "lf securakey clone --raw 7FCB400001ADEA5344300000 --em -> encode for EM4305/4469"
10660 ],
10661 "offline": false,
10662 "options": [
10663 "-h, --help This help",
10664 "-r, --raw <hex> raw hex data. 12 bytes",
10665 "--q5 optional - specify writing to Q5/T5555 tag",
10666 "--em optional - specify writing to EM4305/4469 tag"
10667 ],
10668 "usage": "lf securakey clone [-h] -r <hex> [--q5] [--em]"
10669 },
10670 "lf securakey help": {
10671 "command": "lf securakey help",
10672 "description": "help This help demod demodulate an Securakey tag from the GraphBuffer --------------------------------------------------------------------------------------- lf securakey demod available offline: yes Try to find Securakey preamble, if found decode / descramble data",
10673 "notes": [
10674 "lf securakey demod"
10675 ],
10676 "offline": true,
10677 "options": [
10678 "-h, --help This help"
10679 ],
10680 "usage": "lf securakey demod [-h]"
10681 },
10682 "lf securakey reader": {
10683 "command": "lf securakey reader",
10684 "description": "read a Securakey tag",
10685 "notes": [
10686 "lf securakey reader -@ -> continuous reader mode"
10687 ],
10688 "offline": false,
10689 "options": [
10690 "-h, --help This help",
10691 "-@ optional - continuous reader mode"
10692 ],
10693 "usage": "lf securakey reader [-h@]"
10694 },
10695 "lf securakey sim": {
10696 "command": "lf securakey sim",
10697 "description": "Enables simulation of secura card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
10698 "notes": [
10699 "lf securakey sim --raw 7FCB400001ADEA5344300000"
10700 ],
10701 "offline": false,
10702 "options": [
10703 "-h, --help This help",
10704 "-r, --raw <hex> raw hex data. 12 bytes"
10705 ],
10706 "usage": "lf securakey sim [-h] [-r <hex>]"
10707 },
10708 "lf sim": {
10709 "command": "lf sim",
10710 "description": "Simulate low frequency tag from graphbuffer Use `lf config` to set parameters",
10711 "notes": [
10712 "lf sim",
10713 "lf sim --gap 240 -> start simulating with 240ms gap"
10714 ],
10715 "offline": false,
10716 "options": [
10717 "-h, --help This help",
10718 "-g, --gap <ms> start gap in microseconds"
10719 ],
10720 "usage": "lf sim [-h] [-g <ms>]"
10721 },
10722 "lf simask": {
10723 "command": "lf simask",
10724 "description": "Simulate ASK tag from DemodBuffer or input",
10725 "notes": [
10726 "lf simask --clk 32 --am -d 0102030405 -> simulate ASK/MAN rf/32",
10727 "lf simask --clk 32 --bi -d 0102030405 -> simulate ASK/BIPHASE rf/32",
10728 "",
10729 "lf simask --clk 64 --am -d ffbd8001686f1924 -> simulate a EM410x tag",
10730 "lf simask --clk 64 --am --stt -d 5649533200003F340000001B -> simulate a VISA2K tag"
10731 ],
10732 "offline": false,
10733 "options": [
10734 "-h, --help This help",
10735 "-i, --inv invert data",
10736 "-c, --clk <dec> manually set clock - can autodetect if using DemodBuffer (default 64)",
10737 "--bi ask/biphase encoding",
10738 "--am ask/manchester encoding (default)",
10739 "--ar ask/raw encoding",
10740 "--stt add t55xx Sequence Terminator gap - default: no gaps (only manchester)",
10741 "-d, --data <hex> data to sim - omit to use DemodBuffer",
10742 "-v, --verbose verbose output"
10743 ],
10744 "usage": "lf simask [-hiv] [-c <dec>] [--bi] [--am] [--ar] [--stt] [-d <hex>]"
10745 },
10746 "lf simbidir": {
10747 "command": "lf simbidir",
10748 "description": "Simulate LF tag with bidirectional data transmission between reader and tag",
10749 "notes": [
10750 "lf simbidir"
10751 ],
10752 "offline": false,
10753 "options": [
10754 "-h, --help This help"
10755 ],
10756 "usage": "lf simbidir [-h]"
10757 },
10758 "lf simfsk": {
10759 "command": "lf simfsk",
10760 "description": "Simulate FSK tag from DemodBuffer or input. There are about four FSK modulations to know of. FSK1 - where fc/8 = high and fc/5 = low FSK1a - is inverted FSK1, ie: fc/5 = high and fc/8 = low FSK2 - where fc/10 = high and fc/8 = low FSK2a - is inverted FSK2, ie: fc/10 = high and fc/8 = low NOTE: if you set one clock manually set them all manually",
10761 "notes": [
10762 "lf simfsk -c 40 --high 8 --low 5 -d 010203 -> FSK1 rf/40 data 010203",
10763 "lf simfsk -c 40 --high 5 --low 8 -d 010203 -> FSK1a rf/40 data 010203",
10764 "lf simfsk -c 64 --high 10 --low 8 -d 010203 -> FSK2 rf/64 data 010203",
10765 "lf simfsk -c 64 --high 8 --low 10 -d 010203 -> FSK2a rf/64 data 010203",
10766 "",
10767 "lf simfsk -c 50 --high 10 --low 8 -d 1D5559555569A9A555A59569 -> simulate HID Prox tag manually",
10768 "lf simfsk -c 50 --high 10 --low 8 --stt -d 011DB2487E8D811111111111 -> simulate AWID tag manually"
10769 ],
10770 "offline": false,
10771 "options": [
10772 "-h, --help This help",
10773 "-c, --clk <dec> manually set clock - can autodetect if using DemodBuffer (default 64)",
10774 "--low <dec> manually set larger Field Clock",
10775 "--high <dec> manually set smaller Field Clock",
10776 "--stt TBD! - STT to enable a gap between playback repetitions (default: no gap)",
10777 "-d, --data <hex> data to sim - omit to use DemodBuffer",
10778 "-v, --verbose verbose output"
10779 ],
10780 "usage": "lf simfsk [-hv] [-c <dec>] [--low <dec>] [--high <dec>] [--stt] [-d <hex>]"
10781 },
10782 "lf simpsk": {
10783 "command": "lf simpsk",
10784 "description": "Simulate PSK tag from DemodBuffer or input",
10785 "notes": [
10786 "lf simpsk -1 --clk 40 --fc 4 -d 01020304 -> simulate PSK1 rf/40 psksub fc/4, data 01020304",
10787 "",
10788 "lf simpsk -1 --clk 32 --fc 2 -d a0000000bd989a11 -> simulate a indala tag manually"
10789 ],
10790 "offline": false,
10791 "options": [
10792 "-h, --help This help",
10793 "-1, --psk1 set PSK1 (default)",
10794 "-2, --psk2 set PSK2",
10795 "-3, --psk3 set PSK3",
10796 "-i, --inv invert data",
10797 "-c, --clk <dec> manually set clock - can autodetect if using DemodBuffer (default 32)",
10798 "--fc <dec> 2|4|8 are valid carriers (default 2)",
10799 "-d, --data <hex> data to sim - omit to use DemodBuffer",
10800 "-v, --verbose verbose output"
10801 ],
10802 "usage": "lf simpsk [-h123iv] [-c <dec>] [--fc <dec>] [-d <hex>]"
10803 },
10804 "lf sniff": {
10805 "command": "lf sniff",
10806 "description": "Sniff low frequency signal. You need to configure the LF part on the Proxmark3 device manually. Usually a trigger and skip samples is a good thing to set before doing a low frequency sniff. - use `lf config` to set parameters. - use `data plot` to look at sniff signal. - use `lf search -1` to see if signal can be automatic decoded. If the number of samples is more than the device memory limit (40000 now), it will try to use the real-time sampling mode.",
10807 "notes": [
10808 "lf sniff -v",
10809 "lf sniff -s 3000 -@ -> oscilloscope style"
10810 ],
10811 "offline": false,
10812 "options": [
10813 "-h, --help This help",
10814 "-s, --samples <dec> number of samples to collect",
10815 "-v, --verbose verbose output",
10816 "-@ continuous sniffing mode"
10817 ],
10818 "usage": "lf sniff [-hv@] [-s <dec>]"
10819 },
10820 "lf t55xx bruteforce": {
10821 "command": "lf t55xx bruteforce",
10822 "description": "This command uses bruteforce to scan a number range. Try reading Page 0, block 7 before. WARNING this may brick non-password protected chips!",
10823 "notes": [
10824 "lf t55xx bruteforce --r2 -s aaaaaa77 -e aaaaaa99"
10825 ],
10826 "offline": false,
10827 "options": [
10828 "-h, --help This help",
10829 "-s, --start <hex> search start password (4 hex bytes)",
10830 "-e, --end <hex> search end password (4 hex bytes)",
10831 "--r0 downlink - fixed bit length",
10832 "--r1 downlink - long leading reference",
10833 "--r2 downlink - leading zero",
10834 "--r3 downlink - 1 of 4 coding reference",
10835 "--all try all downlink modes (def)"
10836 ],
10837 "usage": "lf t55xx bruteforce [-h] -s <hex> -e <hex> [--r0] [--r1] [--r2] [--r3] [--all]"
10838 },
10839 "lf t55xx chk": {
10840 "command": "lf t55xx chk",
10841 "description": "This command uses a dictionary attack. For some cloners, try '--em' for known pwdgen algo. Try to reading Page 0 block 7 before. WARNING: this may brick non-password protected chips!",
10842 "notes": [
10843 "lf t55xx chk -m -> use dictionary from flash memory (RDV4)",
10844 "lf t55xx chk -f my_dictionary_pwds -> loads a default keys dictionary file",
10845 "lf t55xx chk --em aa11223344 -> try known pwdgen algo from some cloners based on EM4100 ID"
10846 ],
10847 "offline": false,
10848 "options": [
10849 "-h, --help This help",
10850 "-m, --fm use dictionary from flash memory (RDV4)",
10851 "-f, --file <fn> file name",
10852 "--em <hex> EM4100 ID (5 hex bytes)",
10853 "--r0 downlink - fixed bit length",
10854 "--r1 downlink - long leading reference",
10855 "--r2 downlink - leading zero",
10856 "--r3 downlink - 1 of 4 coding reference",
10857 "--all try all downlink modes (def)"
10858 ],
10859 "usage": "lf t55xx chk [-hm] [-f <fn>] [--em <hex>] [--r0] [--r1] [--r2] [--r3] [--all]"
10860 },
10861 "lf t55xx config": {
10862 "command": "lf t55xx config",
10863 "description": "Set/Get T55XX configuration of the pm3 client. Like modulation, inverted, offset, rate etc. Offset is start position to decode data.",
10864 "notes": [
10865 "lf t55xx config --FSK -> FSK demodulation",
10866 "lf t55xx config --FSK -i -> FSK demodulation, inverse data",
10867 "lf t55xx config --FSK -i -o 3 -> FSK demodulation, inverse data, offset 3"
10868 ],
10869 "offline": true,
10870 "options": [
10871 "-h, --help This help",
10872 "--FSK set demodulation FSK",
10873 "--FSK1 set demodulation FSK 1",
10874 "--FSK1A set demodulation FSK 1a (inv)",
10875 "--FSK2 set demodulation FSK 2",
10876 "--FSK2A set demodulation FSK 2a (inv)",
10877 "--ASK set demodulation ASK",
10878 "--PSK1 set demodulation PSK 1",
10879 "--PSK2 set demodulation PSK 2",
10880 "--PSK3 set demodulation PSK 3",
10881 "--NRZ set demodulation NRZ",
10882 "--BI set demodulation Biphase",
10883 "--BIA set demodulation Diphase (inverted biphase)",
10884 "-i, --inv set/reset data signal inversion",
10885 "--q5 set/reset as Q5/T5555 chip instead of T55x7",
10886 "--st set/reset Sequence Terminator on",
10887 "--rate <dec> set bitrate <8|16|32|40|50|64|100|128>",
10888 "-c, --blk0 <hex> set configuration from a block0 (4 hex bytes)",
10889 "-o, --offset <0-255> set offset, where data should start decode in bitstream",
10890 "--r0 downlink - fixed bit length (detected def)",
10891 "--r1 downlink - long leading reference",
10892 "--r2 downlink - leading zero",
10893 "--r3 downlink - 1 of 4 coding reference"
10894 ],
10895 "usage": "lf t55xx config [-hi] [--FSK] [--FSK1] [--FSK1A] [--FSK2] [--FSK2A] [--ASK] [--PSK1] [--PSK2] [--PSK3] [--NRZ] [--BI] [--BIA] [--q5] [--st] [--rate <dec>] [-c <hex>] [-o <0-255>] [--r0] [--r1] [--r2] [--r3]"
10896 },
10897 "lf t55xx dangerraw": {
10898 "command": "lf t55xx dangerraw",
10899 "description": "This command allows to emit arbitrary raw commands on T5577 and cut the field after arbitrary duration. Uncontrolled usage can easily write an invalid configuration, activate lock bits, OTP bit, password protection bit, deactivate test-mode, lock your card forever. WARNING: this may lock definitively the tag in an unusable state!",
10900 "notes": [
10901 "lf t55xx dangerraw -d 01000000000000010000100000000100000000 -t 3200"
10902 ],
10903 "offline": false,
10904 "options": [
10905 "-h, --help This help",
10906 "-d, --data <string> raw bit string",
10907 "-t, --time <us> <0 - 200000> time in microseconds before dropping the field"
10908 ],
10909 "usage": "lf t55xx dangerraw [-h] -d <string> -t <us>"
10910 },
10911 "lf t55xx detect": {
10912 "command": "lf t55xx detect",
10913 "description": "Try detecting the tag modulation from reading the configuration block",
10914 "notes": [
10915 "lf t55xx detect",
10916 "lf t55xx detect -1",
10917 "lf t55xx detect -p 11223344"
10918 ],
10919 "offline": true,
10920 "options": [
10921 "-h, --help This help",
10922 "-1 extract using data from graphbuffer",
10923 "-p, --pwd <hex> password (4 hex bytes)",
10924 "--r0 downlink - fixed bit length (detected def)",
10925 "--r1 downlink - long leading reference",
10926 "--r2 downlink - leading zero",
10927 "--r3 downlink - 1 of 4 coding reference",
10928 "--all try all downlink modes"
10929 ],
10930 "usage": "lf t55xx detect [-h1] [-p <hex>] [--r0] [--r1] [--r2] [--r3] [--all]"
10931 },
10932 "lf t55xx deviceconfig": {
10933 "command": "lf t55xx deviceconfig",
10934 "description": "Sets t55x7 timings for direct commands. The timings are set here in Field Clocks (FC) which is converted to (US) on device.",
10935 "notes": [
10936 "lf t55xx deviceconfig -a 29 -b 17 -c 15 -d 47 -e 15 -> default T55XX",
10937 "lf t55xx deviceconfig -a 55 -b 14 -c 21 -d 30 -> default EM4305"
10938 ],
10939 "offline": false,
10940 "options": [
10941 "-h, --help This help",
10942 "-a <8..255> Set start gap",
10943 "-b <8..255> Set write gap",
10944 "-c <8..255> Set write ZERO gap",
10945 "-d <8..255> Set write ONE gap",
10946 "-e <8..255> Set read gap",
10947 "-f <8..255> Set write TWO gap (1 of 4 only)",
10948 "-g <8..255> Set write THREE gap (1 of 4 only)",
10949 "-p, --persist persist to flash memory (RDV4)",
10950 "-z Set default t55x7 timings (use `-p` to save if required)",
10951 "--r0 downlink - fixed bit length (detected def)",
10952 "--r1 downlink - long leading reference",
10953 "--r2 downlink - leading zero",
10954 "--r3 downlink - 1 of 4 coding reference"
10955 ],
10956 "usage": "lf t55xx deviceconfig [-hpz] [-a <8..255>] [-b <8..255>] [-c <8..255>] [-d <8..255>] [-e <8..255>] [-f <8..255>] [-g <8..255>] [--r0] [--r1] [--r2] [--r3]"
10957 },
10958 "lf t55xx dump": {
10959 "command": "lf t55xx dump",
10960 "description": "This command dumps a T55xx card Page 0 block 0-7. It will create two files (bin/json)",
10961 "notes": [
10962 "lf t55xx dump",
10963 "lf t55xx dump -p aabbccdd --override",
10964 "lf t55xx dump -f my_lf_dump"
10965 ],
10966 "offline": false,
10967 "options": [
10968 "-h, --help This help",
10969 "-f, --file <fn> filename (default is generated on blk 0)",
10970 "-o, --override override, force pwd read despite danger to card",
10971 "-p, --pwd <hex> password (4 hex bytes)",
10972 "--ns no save",
10973 "--r0 downlink - fixed bit length",
10974 "--r1 downlink - long leading reference",
10975 "--r2 downlink - leading zero",
10976 "--r3 downlink - 1 of 4 coding reference"
10977 ],
10978 "usage": "lf t55xx dump [-ho] [-f <fn>] [-p <hex>] [--ns] [--r0] [--r1] [--r2] [--r3]"
10979 },
10980 "lf t55xx help": {
10981 "command": "lf t55xx help",
10982 "description": "----------- ---------------------------- notice ----------------------------- Remember to run `lf t55xx detect` first whenever a new card is placed on the Proxmark3 or the config block changed. help This help ----------- --------------------- operations --------------------- config Set/Get T55XX configuration (modulation, inverted, offset, rate) detect Try detecting the tag modulation from reading the configuration block info Show T55x7 configuration data (page 0/ blk 0) trace Show T55x7 traceability data (page 1/ blk 0-1) ----------- --------------------- recovery --------------------- sniff Attempt to recover T55xx commands from sample buffer --------------------------------------------------------------------------------------- lf t55xx clonehelp available offline: no Display a list of available commands for cloning specific techs on T5xx tags",
10983 "notes": [
10984 "lf t55xx clonehelp"
10985 ],
10986 "offline": true,
10987 "options": [
10988 "-h, --help This help"
10989 ],
10990 "usage": "lf t55xx clonehelp [-h]"
10991 },
10992 "lf t55xx info": {
10993 "command": "lf t55xx info",
10994 "description": "Show T55x7 configuration data (page 0/ blk 0) from reading the configuration block from tag. Use `-c` to specify a config block data to be used instead of reading tag.",
10995 "notes": [
10996 "lf t55xx info",
10997 "lf t55xx info -1",
10998 "lf t55xx info -p 11223344",
10999 "lf t55xx info -c 00083040",
11000 "lf t55xx info -c 6001805A --q5"
11001 ],
11002 "offline": true,
11003 "options": [
11004 "-h, --help This help",
11005 "-1 extract using data from graphbuffer",
11006 "-p, --pwd <hex> password (4 hex bytes)",
11007 "-c, --blk0 <hex> use these data instead (4 hex bytes)",
11008 "--q5 interprete provided data as T5555/Q5 config",
11009 "--r0 downlink - fixed bit length (detected def)",
11010 "--r1 downlink - long leading reference",
11011 "--r2 downlink - leading zero",
11012 "--r3 downlink - 1 of 4 coding reference"
11013 ],
11014 "usage": "lf t55xx info [-h1] [-p <hex>] [-c <hex>] [--q5] [--r0] [--r1] [--r2] [--r3]"
11015 },
11016 "lf t55xx p1detect": {
11017 "command": "lf t55xx p1detect",
11018 "description": "Detect Page 1 of a T55xx chip",
11019 "notes": [
11020 "lf t55xx p1detect",
11021 "lf t55xx p1detect -1",
11022 "lf t55xx p1detect -p 11223344 --r3"
11023 ],
11024 "offline": false,
11025 "options": [
11026 "-h, --help This help",
11027 "-1 extract using data from graphbuffer",
11028 "-p, --pwd <hex> password (4 hex bytes)",
11029 "--r0 downlink - fixed bit length (detected def)",
11030 "--r1 downlink - long leading reference",
11031 "--r2 downlink - leading zero",
11032 "--r3 downlink - 1 of 4 coding reference"
11033 ],
11034 "usage": "lf t55xx p1detect [-h1] [-p <hex>] [--r0] [--r1] [--r2] [--r3]"
11035 },
11036 "lf t55xx protect": {
11037 "command": "lf t55xx protect",
11038 "description": "This command sets the pwd bit on T5577. WARNING this locks the tag!",
11039 "notes": [
11040 "lf t55xx protect -n 01020304 -> sets new pwd 01020304",
11041 "lf t55xx protect -p 11223344 -n 00000000 -> use pwd 11223344, sets new pwd 00000000"
11042 ],
11043 "offline": false,
11044 "options": [
11045 "-h, --help This help",
11046 "-o, --override override safety check",
11047 "-p, --pwd <hex> password (4 hex bytes)",
11048 "-n, --new <hex> new password (4 hex bytes)",
11049 "--r0 downlink - fixed bit length (detected def)",
11050 "--r1 downlink - long leading reference",
11051 "--r2 downlink - leading zero",
11052 "--r3 downlink - 1 of 4 coding reference"
11053 ],
11054 "usage": "lf t55xx protect [-ho] [-p <hex>] -n <hex> [--r0] [--r1] [--r2] [--r3]"
11055 },
11056 "lf t55xx read": {
11057 "command": "lf t55xx read",
11058 "description": "Read T55xx block data. This commands defaults to page 0. * * * WARNING * * * Use of read with password on a tag not configured for a password can damage the tag * * * * * * * * * *",
11059 "notes": [
11060 "lf t55xx read -b 0 -> read data from block 0",
11061 "lf t55xx read -b 0 --pwd 01020304 -> read data from block 0, pwd 01020304",
11062 "lf t55xx read -b 0 --pwd 01020304 -o -> read data from block 0, pwd 01020304, override"
11063 ],
11064 "offline": false,
11065 "options": [
11066 "-h, --help This help",
11067 "-b, --blk <0-7> block number to read",
11068 "-p, --pwd <hex> password (4 hex bytes)",
11069 "-o, --override override safety check",
11070 "--pg1 read page 1",
11071 "--r0 downlink - fixed bit length (detected def)",
11072 "--r1 downlink - long leading reference",
11073 "--r2 downlink - leading zero",
11074 "--r3 downlink - 1 of 4 coding reference"
11075 ],
11076 "usage": "lf t55xx read [-ho] -b <0-7> [-p <hex>] [--pg1] [--r0] [--r1] [--r2] [--r3]"
11077 },
11078 "lf t55xx recoverpw": {
11079 "command": "lf t55xx recoverpw",
11080 "description": "This command uses a few tricks to try to recover mangled password. Try reading Page 0, block 7 before. WARNING this may brick non-password protected chips!",
11081 "notes": [
11082 "lf t55xx recoverpw",
11083 "lf t55xx recoverpw -p 11223344",
11084 "lf t55xx recoverpw -p 11223344 --r3"
11085 ],
11086 "offline": false,
11087 "options": [
11088 "-h, --help This help",
11089 "-p, --pwd <hex> password (4 hex bytes)",
11090 "--r0 downlink - fixed bit length",
11091 "--r1 downlink - long leading reference",
11092 "--r2 downlink - leading zero",
11093 "--r3 downlink - 1 of 4 coding reference",
11094 "--all try all downlink modes (def)"
11095 ],
11096 "usage": "lf t55xx recoverpw [-h] [-p <hex>] [--r0] [--r1] [--r2] [--r3] [--all]"
11097 },
11098 "lf t55xx resetread": {
11099 "command": "lf t55xx resetread",
11100 "description": "Send Reset Cmd then `lf read` the stream to attempt to identify the start of it (needs a demod and/or plot after)",
11101 "notes": [
11102 "lf t55xx resetread"
11103 ],
11104 "offline": false,
11105 "options": [
11106 "-h, --help This help",
11107 "-1 extract using data from graphbuffer",
11108 "--r0 downlink - fixed bit length (detected def)",
11109 "--r1 downlink - long leading reference",
11110 "--r2 downlink - leading zero",
11111 "--r3 downlink - 1 of 4 coding reference"
11112 ],
11113 "usage": "lf t55xx resetread [-h1] [--r0] [--r1] [--r2] [--r3]"
11114 },
11115 "lf t55xx restore": {
11116 "command": "lf t55xx restore",
11117 "description": "Restore T55xx card page 0/1 n blocks from (bin/eml/json) dump file",
11118 "notes": [
11119 "lf t55xx restore -f lf-t55xx-00148040-dump.bin"
11120 ],
11121 "offline": false,
11122 "options": [
11123 "-h, --help This help",
11124 "-f, --file <fn> Specify a filename for dump file",
11125 "-p, --pwd <hex> password if target card has password set (4 hex bytes)"
11126 ],
11127 "usage": "lf t55xx restore [-h] [-f <fn>] [-p <hex>]"
11128 },
11129 "lf t55xx sniff": {
11130 "command": "lf t55xx sniff",
11131 "description": "Sniff LF t55xx based trafic and decode possible cmd / blocks. Lower tolerance means tighter pulses.",
11132 "notes": [
11133 "lf t55xx sniff",
11134 "lf t55xx sniff -1 -t 2 -> use buffer with tolerance of 2",
11135 "lf t55xx sniff -1 --zero 7 --one 14 -> use buffer, zero pulse width 7, one pulse width 15"
11136 ],
11137 "offline": true,
11138 "options": [
11139 "-h, --help This help",
11140 "-1 extract using data from graphbuffer",
11141 "-t, --tol <dec> set tolerance level (default 5)",
11142 "-o, --one <dec> set samples width for ONE pulse (default auto)",
11143 "-z, --zero <dec> set samples width for ZERO pulse (default auto)"
11144 ],
11145 "usage": "lf t55xx sniff [-h1] [-t <dec>] [-o <dec>] [-z <dec>]"
11146 },
11147 "lf t55xx special": {
11148 "command": "lf t55xx special",
11149 "description": "Show block changes with 64 different offsets, data taken from DemodBuffer.",
11150 "notes": [
11151 "lf t55xx special"
11152 ],
11153 "offline": false,
11154 "options": [
11155 "-h, --help This help"
11156 ],
11157 "usage": "lf t55xx special [-h]"
11158 },
11159 "lf t55xx trace": {
11160 "command": "lf t55xx trace",
11161 "description": "Show T55x7 configuration data (page 0/ blk 0) from reading the configuration block",
11162 "notes": [
11163 "lf t55xx trace",
11164 "lf t55xx trace -1"
11165 ],
11166 "offline": true,
11167 "options": [
11168 "-h, --help This help",
11169 "-1 extract using data from graphbuffer",
11170 "--r0 downlink - fixed bit length (detected def)",
11171 "--r1 downlink - long leading reference",
11172 "--r2 downlink - leading zero",
11173 "--r3 downlink - 1 of 4 coding reference"
11174 ],
11175 "usage": "lf t55xx trace [-h1] [--r0] [--r1] [--r2] [--r3]"
11176 },
11177 "lf t55xx wakeup": {
11178 "command": "lf t55xx wakeup",
11179 "description": "This commands sends the Answer-On-Request command and leaves the readerfield ON afterwards",
11180 "notes": [
11181 "lf t55xx wakeup -p 11223344 -> send wakeup with password"
11182 ],
11183 "offline": false,
11184 "options": [
11185 "-h, --help This help",
11186 "-p, --pwd <hex> password (4 hex bytes)",
11187 "-v, --verbose verbose output",
11188 "--r0 downlink - fixed bit length (detected def)",
11189 "--r1 downlink - long leading reference",
11190 "--r2 downlink - leading zero",
11191 "--r3 downlink - 1 of 4 coding reference"
11192 ],
11193 "usage": "lf t55xx wakeup [-hv] [-p <hex>] [--r0] [--r1] [--r2] [--r3]"
11194 },
11195 "lf t55xx wipe": {
11196 "command": "lf t55xx wipe",
11197 "description": "This commands wipes a tag, fills blocks 1-7 with zeros and a default configuration block",
11198 "notes": [
11199 "lf t55xx wipe -> wipes a T55x7 tag, config block 0x000880E0",
11200 "lf t55xx wipe --q5 -> wipes a Q5/T5555 tag, config block 0x6001F004",
11201 "lf t55xx wipe -p 11223344 -> wipes a T55x7 tag, config block 0x000880E0, using pwd"
11202 ],
11203 "offline": false,
11204 "options": [
11205 "-h, --help This help",
11206 "-c, --cfg <hex> configuration block0 (4 hex bytes)",
11207 "-p, --pwd <hex> password (4 hex bytes)",
11208 "--q5 specify writing to Q5/T5555 tag using dedicated config block",
11209 "--r0 downlink - fixed bit length (detected def)",
11210 "--r1 downlink - long leading reference",
11211 "--r2 downlink - leading zero",
11212 "--r3 downlink - 1 of 4 coding reference"
11213 ],
11214 "usage": "lf t55xx wipe [-h] [-c <hex>] [-p <hex>] [--q5] [--r0] [--r1] [--r2] [--r3]"
11215 },
11216 "lf t55xx write": {
11217 "command": "lf t55xx write",
11218 "description": "Write T55xx block data",
11219 "notes": [
11220 "lf t55xx write -b 3 -d 11223344 -> write 11223344 to block 3",
11221 "lf t55xx write -b 3 -d 11223344 --pwd 01020304 -> write 11223344 to block 3, pwd 01020304",
11222 "lf t55xx write -b 3 -d 11223344 --pwd 01020304 --verify -> write 11223344 to block 3 and try validating write"
11223 ],
11224 "offline": false,
11225 "options": [
11226 "-h, --help This help",
11227 "-b, --blk <0-7> block number to write",
11228 "-d, --data <hex> data to write (4 hex bytes)",
11229 "-p, --pwd <hex> password (4 hex bytes)",
11230 "-t, --tm test mode write ( danger )",
11231 "--pg1 write page 1",
11232 "--verify try validate data afterward",
11233 "--r0 downlink - fixed bit length (detected def)",
11234 "--r1 downlink - long leading reference",
11235 "--r2 downlink - leading zero",
11236 "--r3 downlink - 1 of 4 coding reference"
11237 ],
11238 "usage": "lf t55xx write [-ht] -b <0-7> [-d <hex>] [-p <hex>] [--pg1] [--verify] [--r0] [--r1] [--r2] [--r3]"
11239 },
11240 "lf ti help": {
11241 "command": "lf ti help",
11242 "description": "help This help demod Demodulate raw bits for TI LF tag from the GraphBuffer --------------------------------------------------------------------------------------- lf ti demod available offline: yes Try to find TI preamble, if found decode / descramble data",
11243 "notes": [
11244 "lf ti demod"
11245 ],
11246 "offline": true,
11247 "options": [
11248 "-h, --help This help"
11249 ],
11250 "usage": "lf ti demod [-h]"
11251 },
11252 "lf ti reader": {
11253 "command": "lf ti reader",
11254 "description": "read a TI tag",
11255 "notes": [
11256 "lf ti reader -@ -> continuous reader mode"
11257 ],
11258 "offline": false,
11259 "options": [
11260 "-h, --help This help",
11261 "-@ optional - continuous reader mode"
11262 ],
11263 "usage": "lf ti reader [-h@]"
11264 },
11265 "lf ti write": {
11266 "command": "lf ti write",
11267 "description": "write to a r/w TI tag.",
11268 "notes": [
11269 "lf ti write --raw 1122334455667788",
11270 "lf ti write --raw 1122334455667788 --crc 1122"
11271 ],
11272 "offline": false,
11273 "options": [
11274 "-h, --help This help",
11275 "-r, --raw <hex> raw hex data. 8 bytes max",
11276 "--crc <hex> optional - crc"
11277 ],
11278 "usage": "lf ti write [-h] -r <hex> [--crc <hex>]"
11279 },
11280 "lf tune": {
11281 "command": "lf tune",
11282 "description": "Continuously measure LF antenna tuning. Press button or <Enter> to interrupt.",
11283 "notes": [
11284 "lf tune",
11285 "lf tune --mix"
11286 ],
11287 "offline": false,
11288 "options": [
11289 "-h, --help This help",
11290 "-n, --iter <dec> number of iterations (default: 0=infinite)",
11291 "-q, --divisor <dec> Frequency divisor. 88 -> 134 kHz, 95 -> 125 kHz",
11292 "-f, --freq <float> Frequency in kHz",
11293 "--bar bar style",
11294 "--mix mixed style",
11295 "--value values style",
11296 "-v, --verbose verbose output"
11297 ],
11298 "usage": "lf tune [-hv] [-n <dec>] [-q <dec>] [-f <float>] [--bar] [--mix] [--value]"
11299 },
11300 "lf viking clone": {
11301 "command": "lf viking clone",
11302 "description": "clone a Viking AM tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
11303 "notes": [
11304 "lf viking clone --cn 01A337 -> encode for T55x7 tag",
11305 "lf viking clone --cn 01A337 --q5 -> encode for Q5/T5555 tag",
11306 "lf viking clone --cn 112233 --em -> encode for EM4305/4469"
11307 ],
11308 "offline": false,
11309 "options": [
11310 "-h, --help This help",
11311 "--cn <hex> 8 digit hex viking card number",
11312 "--q5 optional - specify writing to Q5/T5555 tag",
11313 "--em optional - specify writing to EM4305/4469 tag"
11314 ],
11315 "usage": "lf viking clone [-h] --cn <hex> [--q5] [--em]"
11316 },
11317 "lf viking help": {
11318 "command": "lf viking help",
11319 "description": "help This help demod demodulate a Viking tag from the GraphBuffer --------------------------------------------------------------------------------------- lf viking demod available offline: yes Try to find Viking AM preamble, if found decode / descramble data",
11320 "notes": [
11321 "lf viking demod"
11322 ],
11323 "offline": true,
11324 "options": [
11325 "-h, --help This help"
11326 ],
11327 "usage": "lf viking demod [-h]"
11328 },
11329 "lf viking reader": {
11330 "command": "lf viking reader",
11331 "description": "read a Viking AM tag",
11332 "notes": [
11333 "lf viking reader -@ -> continuous reader mode"
11334 ],
11335 "offline": false,
11336 "options": [
11337 "-h, --help This help",
11338 "-@ optional - continuous reader mode"
11339 ],
11340 "usage": "lf viking reader [-h@]"
11341 },
11342 "lf viking sim": {
11343 "command": "lf viking sim",
11344 "description": "Enables simulation of viking card with specified card number. Simulation runs until the button is pressed or another USB command is issued. Per viking format, the card number is 8 digit hex number. Larger values are truncated.",
11345 "notes": [
11346 "lf viking sim --cn 01A337"
11347 ],
11348 "offline": false,
11349 "options": [
11350 "-h, --help This help",
11351 "--cn <hex> 8 digit hex viking card number"
11352 ],
11353 "usage": "lf viking sim [-h] --cn <hex>"
11354 },
11355 "lf visa2000 clone": {
11356 "command": "lf visa2000 clone",
11357 "description": "clone a Visa2000 tag to a T55x7, Q5/T5555 or EM4305/4469 tag.",
11358 "notes": [
11359 "lf visa2000 clone --cn 112233 -> encode for T55x7 tag",
11360 "lf visa2000 clone --cn 112233 --q5 -> encode for Q5/T5555 tag",
11361 "lf visa2000 clone --cn 112233 --em -> encode for EM4305/4469"
11362 ],
11363 "offline": false,
11364 "options": [
11365 "-h, --help This help",
11366 "--cn <dec> Visa2k card ID",
11367 "--q5 optional - specify writing to Q5/T5555 tag",
11368 "--em optional - specify writing to EM4305/4469 tag"
11369 ],
11370 "usage": "lf visa2000 clone [-h] --cn <dec> [--q5] [--em]"
11371 },
11372 "lf visa2000 help": {
11373 "command": "lf visa2000 help",
11374 "description": "help This help demod demodulate an VISA2000 tag from the GraphBuffer --------------------------------------------------------------------------------------- lf visa2000 demod available offline: yes Try to find visa2000 preamble, if found decode / descramble data",
11375 "notes": [
11376 "lf visa2000 demod"
11377 ],
11378 "offline": true,
11379 "options": [
11380 "-h, --help This help"
11381 ],
11382 "usage": "lf visa2000 demod [-h]"
11383 },
11384 "lf visa2000 reader": {
11385 "command": "lf visa2000 reader",
11386 "description": "read a visa2000 tag",
11387 "notes": [
11388 "lf visa2000 reader -@ -> continuous reader mode"
11389 ],
11390 "offline": false,
11391 "options": [
11392 "-h, --help This help",
11393 "-@ optional - continuous reader mode"
11394 ],
11395 "usage": "lf visa2000 reader [-h@]"
11396 },
11397 "lf visa2000 sim": {
11398 "command": "lf visa2000 sim",
11399 "description": "Enables simulation of visa2k card with specified card number. Simulation runs until the button is pressed or another USB command is issued.",
11400 "notes": [
11401 "lf visa2000 sim --cn 1337"
11402 ],
11403 "offline": false,
11404 "options": [
11405 "-h, --help This help",
11406 "--cn <dec> Visa2k card ID"
11407 ],
11408 "usage": "lf visa2000 sim [-h] --cn <dec>"
11409 },
11410 "mem dump": {
11411 "command": "mem dump",
11412 "description": "Dumps flash memory on device into a file or view in console",
11413 "notes": [
11414 "mem dump -f myfile -> download all flashmem to file",
11415 "mem dump --view -o 262015 --len 128 -> display 128 bytes from offset 262015 (RSA sig)",
11416 "mem dump --view -f myfile -o 241664 --len 58 -> display 58 bytes from offset 241664 and save to file"
11417 ],
11418 "offline": false,
11419 "options": [
11420 "-h, --help This help",
11421 "-o, --offset <dec> offset in memory",
11422 "-l, --len <dec> length",
11423 "-v, --view view dump",
11424 "-f, --file <fn> save filename",
11425 "-c, --cols <dec> column breaks (def 32)"
11426 ],
11427 "usage": "mem dump [-hv] [-o <dec>] [-l <dec>] [-f <fn>] [-c <dec>]"
11428 },
11429 "mem help": {
11430 "command": "mem help",
11431 "description": "help This help --------------------------------------------------------------------------------------- mem baudrate available offline: no Set the baudrate for the SPI flash memory communications. Reading Flash ID will virtually always fail under 48MHz setting. Unless you know what you are doing, please stay at 24MHz. If >= 24MHz, FASTREADS instead of READS instruction will be used.",
11432 "notes": [
11433 "mem baudrate --mhz 48"
11434 ],
11435 "offline": true,
11436 "options": [
11437 "-h, --help This help",
11438 "--mhz <24|48> SPI baudrate in MHz"
11439 ],
11440 "usage": "mem baudrate [-h] --mhz <24|48>"
11441 },
11442 "mem info": {
11443 "command": "mem info",
11444 "description": "Collect signature and verify it from flash memory",
11445 "notes": [
11446 "mem info"
11447 ],
11448 "offline": false,
11449 "options": [
11450 "-h, --help This help",
11451 "-s, --sign create a signature",
11452 "-d <hex> flash memory id, 8 hex bytes",
11453 "-p, --pem <fn> key in PEM format",
11454 "-v, --verbose verbose output"
11455 ],
11456 "usage": "mem info [-hsv] [-d <hex>] [-p <fn>]"
11457 },
11458 "mem load": {
11459 "command": "mem load",
11460 "description": "Loads binary file into flash memory on device Warning: mem area to be written must have been wiped first ( this is already taken care when loading dictionaries )",
11461 "notes": [
11462 "mem load -f myfile -> upload file myfile values at default offset 0",
11463 "mem load -f myfile -o 1024 -> upload file myfile values at offset 1024",
11464 "mem load -f mfc_default_keys -m -> upload MFC keys",
11465 "mem load -f t55xx_default_pwds -t -> upload T55XX passwords",
11466 "mem load -f iclass_default_keys -i -> upload iCLASS keys"
11467 ],
11468 "offline": false,
11469 "options": [
11470 "-h, --help This help",
11471 "-o, --offset <dec> offset in memory",
11472 "-m, --mifare, --mfc upload 6 bytes keys (mifare key dictionary)",
11473 "-i, --iclass upload 8 bytes keys (iClass key dictionary)",
11474 "-t, --t55xx upload 4 bytes keys (password dictionary)",
11475 "-f, --file <fn> file name"
11476 ],
11477 "usage": "mem load [-hmit] [-o <dec>] -f <fn>"
11478 },
11479 "mem spiffs check": {
11480 "command": "mem spiffs check",
11481 "description": "Check/try to defrag faulty/fragmented SPIFFS file system",
11482 "notes": [
11483 "mem spiffs check"
11484 ],
11485 "offline": false,
11486 "options": [
11487 "-h, --help This help"
11488 ],
11489 "usage": "mem spiffs check [-h]"
11490 },
11491 "mem spiffs dump": {
11492 "command": "mem spiffs dump",
11493 "description": "Dumps device SPIFFS file to a local file Size is handled by first sending a STAT command against file to verify existence",
11494 "notes": [
11495 "mem spiffs dump -s tag.bin -> download binary file from device, saved as `tag.bin`",
11496 "mem spiffs dump -s tag.bin -d a001 -> download tag.bin, save as `a001.bin`",
11497 "mem spiffs dump -s tag.bin -t -> download tag.bin into trace buffer"
11498 ],
11499 "offline": false,
11500 "options": [
11501 "-h, --help This help",
11502 "-s, --src <fn> SPIFFS file to save",
11503 "-d, --dest <fn> file name to save to <w/o .bin>",
11504 "-t, --trace download into trace buffer"
11505 ],
11506 "usage": "mem spiffs dump [-ht] -s <fn> [-d <fn>]"
11507 },
11508 "mem spiffs help": {
11509 "command": "mem spiffs help",
11510 "description": "help This help --------------------------------------------------------------------------------------- mem spiffs copy available offline: no Copy a file to another (destructively) in SPIFFS file system",
11511 "notes": [
11512 "mem spiffs copy -s aaa.bin -d aaa_cpy.bin"
11513 ],
11514 "offline": true,
11515 "options": [
11516 "-h, --help This help",
11517 "-s, --src <fn> source file name",
11518 "-d, --dest <fn> destination file name"
11519 ],
11520 "usage": "mem spiffs copy [-h] -s <fn> -d <fn>"
11521 },
11522 "mem spiffs info": {
11523 "command": "mem spiffs info",
11524 "description": "Print file system info and usage statistics",
11525 "notes": [
11526 "mem spiffs info"
11527 ],
11528 "offline": false,
11529 "options": [
11530 "-h, --help This help"
11531 ],
11532 "usage": "mem spiffs info [-h]"
11533 },
11534 "mem spiffs mount": {
11535 "command": "mem spiffs mount",
11536 "description": "Mount the SPIFFS file system if not already mounted",
11537 "notes": [
11538 "mem spiffs mount"
11539 ],
11540 "offline": false,
11541 "options": [
11542 "-h, --help This help"
11543 ],
11544 "usage": "mem spiffs mount [-h]"
11545 },
11546 "mem spiffs remove": {
11547 "command": "mem spiffs remove",
11548 "description": "Remove a file from SPIFFS filesystem",
11549 "notes": [
11550 "mem spiffs remove -f lasttag.bin"
11551 ],
11552 "offline": false,
11553 "options": [
11554 "-h, --help This help",
11555 "-f, --file <fn> file to remove"
11556 ],
11557 "usage": "mem spiffs remove [-h] -f <fn>"
11558 },
11559 "mem spiffs rename": {
11560 "command": "mem spiffs rename",
11561 "description": "Rename/move a file from SPIFFS filesystem.",
11562 "notes": [
11563 "mem spiffs rename -s aaa.bin -d bbb.bin"
11564 ],
11565 "offline": false,
11566 "options": [
11567 "-h, --help This help",
11568 "-s, --src <fn> source file name",
11569 "-d, --dest <fn> destination file name"
11570 ],
11571 "usage": "mem spiffs rename [-h] -s <fn> -d <fn>"
11572 },
11573 "mem spiffs test": {
11574 "command": "mem spiffs test",
11575 "description": "Test SPIFFS Operations, require wiping pages 0 and 1",
11576 "notes": [
11577 "mem spiffs test"
11578 ],
11579 "offline": false,
11580 "options": [
11581 "-h, --help This help"
11582 ],
11583 "usage": "mem spiffs test [-h]"
11584 },
11585 "mem spiffs tree": {
11586 "command": "mem spiffs tree",
11587 "description": "Print the Flash memory file system tree",
11588 "notes": [
11589 "mem spiffs tree"
11590 ],
11591 "offline": false,
11592 "options": [
11593 "-h, --help This help"
11594 ],
11595 "usage": "mem spiffs tree [-h]"
11596 },
11597 "mem spiffs unmount": {
11598 "command": "mem spiffs unmount",
11599 "description": "Un-mount the SPIFFS file system",
11600 "notes": [
11601 "mem spiffs unmount"
11602 ],
11603 "offline": false,
11604 "options": [
11605 "-h, --help This help"
11606 ],
11607 "usage": "mem spiffs unmount [-h]"
11608 },
11609 "mem spiffs upload": {
11610 "command": "mem spiffs upload",
11611 "description": "Uploads binary-wise file into device file system Warning: mem area to be written must have been wiped first. This is already taken care when loading dictionaries. File names can only be 32 bytes long on device SPIFFS",
11612 "notes": [
11613 "mem spiffs upload -s local.bin -d dest.bin"
11614 ],
11615 "offline": false,
11616 "options": [
11617 "-h, --help This help",
11618 "-s, --src <fn> source file name",
11619 "-d, --dest <fn> destination file name"
11620 ],
11621 "usage": "mem spiffs upload [-h] -s <fn> -d <fn>"
11622 },
11623 "mem spiffs view": {
11624 "command": "mem spiffs view",
11625 "description": "View a file on flash memory on device in console",
11626 "notes": [
11627 "mem spiffs view -f tag.bin"
11628 ],
11629 "offline": false,
11630 "options": [
11631 "-h, --help This help",
11632 "-f, --file <fn> SPIFFS file to view",
11633 "-c, --cols <dec> column breaks (def 16)"
11634 ],
11635 "usage": "mem spiffs view [-h] -f <fn> [-c <dec>]"
11636 },
11637 "mem spiffs wipe": {
11638 "command": "mem spiffs wipe",
11639 "description": "* * * Warning * * * This command wipes all files on the device SPIFFS file system",
11640 "notes": [
11641 "mem spiffs wipe"
11642 ],
11643 "offline": false,
11644 "options": [
11645 "-h, --help This help"
11646 ],
11647 "usage": "mem spiffs wipe [-h]"
11648 },
11649 "mem wipe": {
11650 "command": "mem wipe",
11651 "description": "Wipe flash memory on device, which fills it with 0xFF [ !!! OBS ] use with caution",
11652 "notes": [
11653 "mem wipe -p 0 -> wipes first page"
11654 ],
11655 "offline": false,
11656 "options": [
11657 "-h, --help This help",
11658 "-p <dec> 0,1,2 page memory"
11659 ],
11660 "usage": "mem wipe [-h] [-p <dec>]"
11661 },
11662 "msleep": {
11663 "command": "msleep",
11664 "description": "Sleep for given amount of milliseconds",
11665 "notes": [
11666 "msleep -t 100"
11667 ],
11668 "offline": true,
11669 "options": [
11670 "-h, --help This help",
11671 "-t, --ms <ms> time in milliseconds"
11672 ],
11673 "usage": "msleep [-h] [-t <ms>]"
11674 },
11675 "nfc barcode help": {
11676 "command": "nfc barcode help",
11677 "description": "-------- ------------------ NFC Barcode -------------------- -------- --------------------- General --------------------- help This help ======================================================================================= piv { PIV commands... } --------------------------------------------------------------------------------------- piv help available offline: yes help This help list List ISO7816 history --------------------------------------------------------------------------------------- piv select available offline: no Executes select applet command",
11678 "notes": [
11679 "piv select -s -> select card, select applet",
11680 "piv select -st --aid a00000030800001000 -> select card, select applet a00000030800001000, show result in TLV"
11681 ],
11682 "offline": true,
11683 "options": [
11684 "-h, --help This help",
11685 "-s, -S, --select Activate field and select applet",
11686 "-k, -K, --keep Keep field for next command",
11687 "-a, -A, --apdu Show APDU requests and responses",
11688 "-t, -T, --tlv TLV decode results",
11689 "-w, -W, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
11690 "--aid <hex> Applet ID to select. By default A0000003080000100 will be used"
11691 ],
11692 "usage": "piv select [-hskatw] [--aid <hex>]"
11693 },
11694 "nfc barcode sim": {
11695 "command": "nfc barcode sim",
11696 "description": "Simulate Thinfilm tag",
11697 "notes": [
11698 "hf thinfilm sim -d B70470726f786d61726b2e636f6d"
11699 ],
11700 "offline": false,
11701 "options": [
11702 "-h, --help This help",
11703 "-d, --data <hex> bytes to send",
11704 "--raw raw, provided bytes should include CRC"
11705 ],
11706 "usage": "hf thinfilm sim [-h] -d <hex> [--raw]"
11707 },
11708 "nfc help": {
11709 "command": "nfc help",
11710 "description": "-------- --------------------- NFC Tags -------------------- type1 { NFC Forum Tag Type 1... } type2 { NFC Forum Tag Type 2... } type4a { NFC Forum Tag Type 4 ISO14443A... } type4b { NFC Forum Tag Type 4 ISO14443B... } mf { NFC Type MIFARE Classic/Plus Tag... } barcode { NFC Barcode Tag... } -------- --------------------- General --------------------- help This help decode Decode NDEF records --------------------------------------------------------------------------------------- nfc decode available offline: yes Decode and print NFC Data Exchange Format (NDEF) You must provide either data in hex or a filename, but not both",
11711 "notes": [
11712 "nfc decode -d 9101085402656e48656c6c6f5101085402656e576f726c64",
11713 "nfc decode -d 0103d020240203e02c040300fe",
11714 "nfc decode -f myfilename"
11715 ],
11716 "offline": true,
11717 "options": [
11718 "-h, --help This help",
11719 "-d, --data <hex> NDEF data to decode",
11720 "-f, --file <fn> file to load",
11721 "-v, --verbose verbose output"
11722 ],
11723 "usage": "nfc decode [-hv] [-d <hex>] [-f <fn>]"
11724 },
11725 "nfc mf cread": {
11726 "command": "nfc mf cread",
11727 "description": "Prints NFC Data Exchange Format (NDEF)",
11728 "notes": [
11729 "hf mf ndefread -> shows NDEF parsed data",
11730 "hf mf ndefread -vv -> shows NDEF parsed and raw data",
11731 "hf mf ndefread --aid e103 -k ffffffffffff -b -> shows NDEF data with custom AID, key and with key B",
11732 "hf mf ndefread -f myfilename -> save raw NDEF to file"
11733 ],
11734 "offline": false,
11735 "options": [
11736 "-h, --help This help",
11737 "-v, --verbose Verbose output",
11738 "--aid <aid> replace default aid for NDEF",
11739 "-k, --key <key> replace default key for NDEF",
11740 "-b, --keyb use key B for access sectors (by default: key A)",
11741 "-f, --file <fn> save raw NDEF to file"
11742 ],
11743 "usage": "hf mf ndefread [-hvb] [--aid <aid>] [-k <key>] [-f <fn>]"
11744 },
11745 "nfc mf cwrite": {
11746 "command": "nfc mf cwrite",
11747 "description": "Write raw NDEF hex bytes to tag. This commands assumes tag already been NFC/NDEF formatted.",
11748 "notes": [
11749 "hf mf ndefwrite -d 0300FE -> write empty record to tag",
11750 "hf mf ndefwrite -f myfilename",
11751 "hf mf ndefwrite -d 033fd1023a53709101195405656e2d55534963656d616e2054776974746572206c696e6b5101195502747769747465722e636f6d2f686572726d616e6e31303031"
11752 ],
11753 "offline": false,
11754 "options": [
11755 "-h, --help This help",
11756 "-d <hex> raw NDEF hex bytes",
11757 "-f, --file <fn> write raw NDEF file to tag",
11758 "-p fix NDEF record headers / terminator block if missing",
11759 "--mini MIFARE Classic Mini / S20",
11760 "--1k MIFARE Classic 1k / S50 (def)",
11761 "--2k MIFARE Classic/Plus 2k",
11762 "--4k MIFARE Classic 4k / S70",
11763 "-v, --verbose verbose output"
11764 ],
11765 "usage": "hf mf ndefwrite [-hpv] [-d <hex>] [-f <fn>] [--mini] [--1k] [--2k] [--4k]"
11766 },
11767 "nfc mf help": {
11768 "command": "nfc mf help",
11769 "description": "-------- --------- NFC Type MIFARE Classic/Plus Tag -------- -------- --------------------- General --------------------- help This help ======================================================================================= nfc barcode { NFC Barcode Tag... } --------------------------------------------------------------------------------------- nfc barcode read available offline: no Get info from Thinfilm tags",
11770 "notes": [
11771 "hf thinfilm info"
11772 ],
11773 "offline": true,
11774 "options": [
11775 "-h, --help This help"
11776 ],
11777 "usage": "hf thinfilm info [-h]"
11778 },
11779 "nfc mf pread": {
11780 "command": "nfc mf pread",
11781 "description": "Prints NFC Data Exchange Format (NDEF)",
11782 "notes": [
11783 "hf mfp ndefread",
11784 "hf mfp ndefread -vv -> shows NDEF parsed and raw data",
11785 "hf mfp ndefread --aid e103 -k d3f7d3f7d3f7d3f7d3f7d3f7d3f7d3f7 -> shows NDEF data with custom AID and key",
11786 "hf mfp ndefread -f myfilename -> save raw NDEF to file"
11787 ],
11788 "offline": false,
11789 "options": [
11790 "-h, --help This help",
11791 "-v, --verbose verbose output",
11792 "--aid <aid> replace default aid for NDEF",
11793 "-k, --key <key> replace default key for NDEF",
11794 "-b, --keyb use key B for access sectors (by default: key A)",
11795 "-f, --file <fn> save raw NDEF to file"
11796 ],
11797 "usage": "hf mfp ndefread [-hvb] [--aid <aid>] [-k <key>] [-f <fn>]"
11798 },
11799 "nfc type1 help": {
11800 "command": "nfc type1 help",
11801 "description": "-------- -------------- NFC Forum Tag Type 1 --------------- -------- --------------------- General --------------------- help This help ======================================================================================= nfc type2 { NFC Forum Tag Type 2... } --------------------------------------------------------------------------------------- nfc type2 read available offline: no Prints NFC Data Exchange Format (NDEF)",
11802 "notes": [
11803 "hf mfu ndefread -> shows NDEF data",
11804 "hf mfu ndefread -k ffffffff -> shows NDEF data with key",
11805 "hf mfu ndefread -f myfilename -> save raw NDEF to file"
11806 ],
11807 "offline": true,
11808 "options": [
11809 "-h, --help This help",
11810 "-l Swap entered key's endianness",
11811 "-f, --file <fn> Save raw NDEF to file",
11812 "-v, --verbose Verbose output"
11813 ],
11814 "usage": "hf mfu ndefread [-hlv] [-k Replace default key for NDEF] [-f <fn>]"
11815 },
11816 "nfc type1 read": {
11817 "command": "nfc type1 read",
11818 "description": "Get info from Topaz tags",
11819 "notes": [
11820 "hf topaz info",
11821 "hf topaz info -f myfilename -> save raw NDEF to file"
11822 ],
11823 "offline": false,
11824 "options": [
11825 "-h, --help This help",
11826 "-f, --file <fn> save raw NDEF to file",
11827 "-v, --verbose verbose output"
11828 ],
11829 "usage": "hf topaz info [-hv] [-f <fn>]"
11830 },
11831 "nfc type2 help": {
11832 "command": "nfc type2 help",
11833 "description": "-------- -------------- NFC Forum Tag Type 2 --------------- -------- --------------------- General --------------------- help This help ======================================================================================= nfc type4a { NFC Forum Tag Type 4 ISO14443A... } --------------------------------------------------------------------------------------- nfc type4a format available offline: no Format ISO14443-a Tag as a NFC tag with Data Exchange Format (NDEF)",
11834 "notes": [
11835 "hf 14a ndefformat"
11836 ],
11837 "offline": true,
11838 "options": [
11839 "-h, --help This help",
11840 "-v, --verbose verbose output"
11841 ],
11842 "usage": "hf 14a ndefformat [-hv]"
11843 },
11844 "nfc type4a help": {
11845 "command": "nfc type4a help",
11846 "description": "-------- --------- NFC Forum Tag Type 4 ISO14443A ---------- -------- --------------------- General --------------------- help This help ======================================================================================= nfc type4b { NFC Forum Tag Type 4 ISO14443B... } --------------------------------------------------------------------------------------- nfc type4b read available offline: no Print NFC Data Exchange Format (NDEF)",
11847 "notes": [
11848 "hf 14b ndefread",
11849 "hf 14b ndefread -f myfilename -> save raw NDEF to file"
11850 ],
11851 "offline": true,
11852 "options": [
11853 "-h, --help This help",
11854 "-f, --file <fn> Save raw NDEF to file",
11855 "-v, --verbose Verbose output"
11856 ],
11857 "usage": "hf 14b ndefread [-hv] [-f <fn>]"
11858 },
11859 "nfc type4a read": {
11860 "command": "nfc type4a read",
11861 "description": "Read NFC Data Exchange Format (NDEF) file on Type 4 NDEF tag",
11862 "notes": [
11863 "hf 14a ndefread",
11864 "hf 14a ndefread -f myfilename -> save raw NDEF to file"
11865 ],
11866 "offline": false,
11867 "options": [
11868 "-h, --help This help",
11869 "-f, --file <fn> save raw NDEF to file",
11870 "-v, --verbose verbose output"
11871 ],
11872 "usage": "hf 14a ndefread [-hv] [-f <fn>]"
11873 },
11874 "nfc type4a st25taread": {
11875 "command": "nfc type4a st25taread",
11876 "description": "Read NFC Data Exchange Format (NDEF) file on ST25TA",
11877 "notes": [
11878 "hf st25ta ndefread -p 82E80053D4CA5C0B656D852CC696C8A1",
11879 "hf st25ta ndefread -f myfilename -> save raw NDEF to file"
11880 ],
11881 "offline": false,
11882 "options": [
11883 "-h, --help This help",
11884 "-p, --pwd <hex> 16 byte read password",
11885 "-f, --file <fn> save raw NDEF to file",
11886 "-v, --verbose verbose output"
11887 ],
11888 "usage": "hf st25ta ndefread [-hv] [-p <hex>] [-f <fn>]"
11889 },
11890 "nfc type4a write": {
11891 "command": "nfc type4a write",
11892 "description": "Write raw NDEF hex bytes to tag. This commands assumes tag already been NFC/NDEF formatted.",
11893 "notes": [
11894 "hf 14a ndefwrite -d 0300FE -> write empty record to tag",
11895 "hf 14a ndefwrite -f myfilename",
11896 "hf 14a ndefwrite -d 003fd1023a53709101195405656e2d55534963656d616e2054776974746572206c696e6b5101195502747769747465722e636f6d2f686572726d616e6e31303031"
11897 ],
11898 "offline": false,
11899 "options": [
11900 "-h, --help This help",
11901 "-d <hex> raw NDEF hex bytes",
11902 "-f, --file <fn> write raw NDEF file to tag",
11903 "-p fix NDEF record headers / terminator block if missing",
11904 "-v, --verbose verbose output"
11905 ],
11906 "usage": "hf 14a ndefwrite [-hpv] [-d <hex>] [-f <fn>]"
11907 },
11908 "nfc type4b help": {
11909 "command": "nfc type4b help",
11910 "description": "-------- --------- NFC Forum Tag Type 4 ISO14443B ------------- -------- --------------------- General --------------------- help This help ======================================================================================= nfc mf { NFC Type MIFARE Classic/Plus Tag... } --------------------------------------------------------------------------------------- nfc mf cformat available offline: no format MIFARE Classic Tag as a NFC tag with Data Exchange Format (NDEF) If no <name> given, UID will be used as filename. It will try default keys and MAD keys to detect if tag is already formatted in order to write. If not, it will try finding a key file based on your UID. ie, if you ran autopwn before",
11911 "notes": [
11912 "hf mf ndefformat",
11913 "hf mf ndefformat --1k -> MIFARE Classic 1k",
11914 "hf mf ndefformat --keys hf-mf-01020304-key.bin -> MIFARE 1k with keys from specified file"
11915 ],
11916 "offline": true,
11917 "options": [
11918 "-h, --help This help",
11919 "-k, --keys <fn> filename of keys",
11920 "--mini MIFARE Classic Mini / S20",
11921 "--1k MIFARE Classic 1k / S50 (def)",
11922 "--2k MIFARE Classic/Plus 2k",
11923 "--4k MIFARE Classic 4k / S70"
11924 ],
11925 "usage": "hf mf ndefformat [-h] [-k <fn>] [--mini] [--1k] [--2k] [--4k]"
11926 },
11927 "piv authsign": {
11928 "command": "piv authsign",
11929 "description": "Send a nonce and ask the PIV card to sign it",
11930 "notes": [
11931 "piv sign -sk -> select card, select applet, sign a NULL nonce"
11932 ],
11933 "offline": false,
11934 "options": [
11935 "-h, --help This help",
11936 "-s, -S, --select Activate field and select applet",
11937 "-k, -K, --keep Keep field for next command",
11938 "-a, -A, --apdu Show APDU requests and responses",
11939 "-t, -T, --tlv TLV decode results",
11940 "-w, -W, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
11941 "--aid <hex> Applet ID to select. By default A0000003080000100 will be used",
11942 "--nonce <hex> Nonce to sign.",
11943 "--slot <dec id> Slot number. Default will be 0x9E (card auth cert).",
11944 "--alg <dec> Algorithm to use to sign. Example values: 06=RSA-1024, 07=RSA-2048, 11=ECC-P256 (default), 14=ECC-P384"
11945 ],
11946 "usage": "piv sign [-hskatw] [--aid <hex>] --nonce <hex> [--slot <dec id>] [--alg <dec>]"
11947 },
11948 "piv getdata": {
11949 "command": "piv getdata",
11950 "description": "Get a data container of a given tag",
11951 "notes": [
11952 "piv getdata -s 5fc102 -> select card, select applet, get card holder unique identifer",
11953 "piv getdata -st 5fc102 -> select card, select applet, get card holder unique identifer, show result in TLV"
11954 ],
11955 "offline": false,
11956 "options": [
11957 "-h, --help This help",
11958 "-s, -S, --select Activate field and select applet",
11959 "-k, -K, --keep Keep field for next command",
11960 "-a, -A, --apdu Show APDU requests and responses",
11961 "-t, -T, --tlv TLV decode results",
11962 "-w, -W, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
11963 "--aid <hex> Applet ID to select. By default A0000003080000100 will be used",
11964 "<hex> Tag ID to read, between 1 and 3 bytes."
11965 ],
11966 "usage": "piv getdata [-hskatw] [--aid <hex>] <hex>"
11967 },
11968 "piv list": {
11969 "command": "piv list",
11970 "description": "Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
11971 "notes": [
11972 "piv list --frame -> show frame delay times",
11973 "piv list -1 -> use trace buffer"
11974 ],
11975 "offline": true,
11976 "options": [
11977 "-h, --help This help",
11978 "-1, --buffer use data from trace buffer",
11979 "--frame show frame delay times",
11980 "-c mark CRC bytes",
11981 "-r show relative times (gap and duration)",
11982 "-u display times in microseconds instead of clock cycles",
11983 "-x show hexdump to convert to pcap(ng)",
11984 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
11985 "-f, --file <fn> filename of dictionary"
11986 ],
11987 "usage": "piv list [-h1crux] [--frame] [-f <fn>]"
11988 },
11989 "piv scan": {
11990 "command": "piv scan",
11991 "description": "Scan a PIV card for known containers",
11992 "notes": [
11993 "piv scan -s -> select card, select applet and run scan",
11994 "piv scan -st --aid a00000030800001000 -> select card, select applet a00000030800001000, show result of the scan in TLV"
11995 ],
11996 "offline": false,
11997 "options": [
11998 "-h, --help This help",
11999 "-s, -S, --select Activate field and select applet",
12000 "-k, -K, --keep Keep field for next command",
12001 "-a, -A, --apdu Show APDU requests and responses",
12002 "-t, -T, --tlv TLV decode results",
12003 "-w, -W, --wired Send data via contact (iso7816) interface. (def: Contactless interface)",
12004 "--aid <hex> Applet ID to select. By default A0000003080000100 will be used"
12005 ],
12006 "usage": "piv scan [-hskatw] [--aid <hex>]"
12007 },
12008 "prefs get barmode": {
12009 "command": "prefs get barmode",
12010 "description": "Get preference of HF/LF tune command styled output in the client",
12011 "notes": [
12012 "prefs get barmode"
12013 ],
12014 "offline": true,
12015 "options": [
12016 "-h, --help This help"
12017 ],
12018 "usage": "prefs get barmode [-h]"
12019 },
12020 "prefs get client.debug": {
12021 "command": "prefs get client.debug",
12022 "description": "Get preference of using clientside debug level",
12023 "notes": [
12024 "prefs get client.debug"
12025 ],
12026 "offline": true,
12027 "options": [
12028 "-h, --help This help"
12029 ],
12030 "usage": "prefs get client.debug [-h]"
12031 },
12032 "prefs get client.delay": {
12033 "command": "prefs get client.delay",
12034 "description": "Get preference of delay time before execution of a command in the client",
12035 "notes": [
12036 "prefs get client.delay"
12037 ],
12038 "offline": true,
12039 "options": [
12040 "-h, --help This help"
12041 ],
12042 "usage": "prefs get client.delay [-h]"
12043 },
12044 "prefs get client.timeout": {
12045 "command": "prefs get client.timeout",
12046 "description": "Get preference of delay time before execution of a command in the client",
12047 "notes": [
12048 "prefs get client.timeout"
12049 ],
12050 "offline": true,
12051 "options": [
12052 "-h, --help This help"
12053 ],
12054 "usage": "prefs get client.timeout [-h]"
12055 },
12056 "prefs get color": {
12057 "command": "prefs get color",
12058 "description": "Get preference of using colors in the client",
12059 "notes": [
12060 "prefs get color"
12061 ],
12062 "offline": true,
12063 "options": [
12064 "-h, --help This help"
12065 ],
12066 "usage": "prefs get color [-h]"
12067 },
12068 "prefs get emoji": {
12069 "command": "prefs get emoji",
12070 "description": "Get preference of using emojis in the client",
12071 "notes": [
12072 "prefs get emoji"
12073 ],
12074 "offline": true,
12075 "options": [
12076 "-h, --help This help"
12077 ],
12078 "usage": "prefs get emoji [-h]"
12079 },
12080 "prefs get hints": {
12081 "command": "prefs get hints",
12082 "description": "Get preference of showing hint messages in the client",
12083 "notes": [
12084 "prefs get hints"
12085 ],
12086 "offline": true,
12087 "options": [
12088 "-h, --help This help"
12089 ],
12090 "usage": "prefs get hints [-h]"
12091 },
12092 "prefs get output": {
12093 "command": "prefs get output",
12094 "description": "Get preference of dump output style",
12095 "notes": [
12096 "prefs get output"
12097 ],
12098 "offline": true,
12099 "options": [
12100 "-h, --help This help"
12101 ],
12102 "usage": "prefs get output [-h]"
12103 },
12104 "prefs get plotsliders": {
12105 "command": "prefs get plotsliders",
12106 "description": "Get preference of showing the plotslider control in the client",
12107 "notes": [
12108 "prefs get plotsliders"
12109 ],
12110 "offline": true,
12111 "options": [
12112 "-h, --help This help"
12113 ],
12114 "usage": "prefs get plotsliders [-h]"
12115 },
12116 "prefs get savepaths": {
12117 "command": "prefs get savepaths",
12118 "description": "Get preference of file paths in the client",
12119 "notes": [
12120 "prefs get savepaths"
12121 ],
12122 "offline": true,
12123 "options": [
12124 "-h, --help This help"
12125 ],
12126 "usage": "prefs get savepaths [-h]"
12127 },
12128 "prefs help": {
12129 "command": "prefs help",
12130 "description": "help This help get { Get a preference } set { Set a preference } show Show all preferences --------------------------------------------------------------------------------------- prefs show available offline: yes Show all persistent preferences",
12131 "notes": [
12132 "prefs show"
12133 ],
12134 "offline": true,
12135 "options": [
12136 "-h, --help This help"
12137 ],
12138 "usage": "prefs show [-h]"
12139 },
12140 "prefs set client.debug": {
12141 "command": "prefs set client.debug",
12142 "description": "Set persistent preference of using clientside debug level",
12143 "notes": [
12144 "prefs set client.debug --simple"
12145 ],
12146 "offline": true,
12147 "options": [
12148 "-h, --help This help",
12149 "--off no debug messages",
12150 "--simple simple debug messages",
12151 "--full full debug messages"
12152 ],
12153 "usage": "prefs set client.debug [-h] [--off] [--simple] [--full]"
12154 },
12155 "prefs set client.delay": {
12156 "command": "prefs set client.delay",
12157 "description": "Set persistent preference of delay before executing a command in the client",
12158 "notes": [
12159 "prefs set client.delay --ms 0 -> unsets any delay",
12160 "prefs set client.delay --ms 1000 -> sets 1000ms delay"
12161 ],
12162 "offline": true,
12163 "options": [
12164 "-h, --help This help",
12165 "--ms <ms> delay in micro seconds"
12166 ],
12167 "usage": "prefs set client.delay [-h] [--ms <ms>]"
12168 },
12169 "prefs set client.timeout": {
12170 "command": "prefs set client.timeout",
12171 "description": "Set persistent preference of client communication timeout",
12172 "notes": [
12173 "prefs set client.timeout --ms 0 -> unsets any timeout",
12174 "prefs set client.timeout -m 20 -> Set the timeout to 20ms",
12175 "prefs set client.timeout --ms 500 -> Set the timeout to 500ms"
12176 ],
12177 "offline": true,
12178 "options": [
12179 "-h, --help This help",
12180 "-m, --ms <ms> timeout in micro seconds"
12181 ],
12182 "usage": "prefs set client.timeout [-h] [-m <ms>]"
12183 },
12184 "prefs set color": {
12185 "command": "prefs set color",
12186 "description": "Set persistent preference of using colors in the client",
12187 "notes": [
12188 "prefs set color --ansi"
12189 ],
12190 "offline": true,
12191 "options": [
12192 "-h, --help This help",
12193 "--ansi use ANSI colors",
12194 "--off don't use colors"
12195 ],
12196 "usage": "prefs set color [-h] [--ansi] [--off]"
12197 },
12198 "prefs set emoji": {
12199 "command": "prefs set emoji",
12200 "description": "Set persistent preference of using emojis in the client",
12201 "notes": [
12202 "prefs set emoji --alias"
12203 ],
12204 "offline": true,
12205 "options": [
12206 "-h, --help This help",
12207 "--alias show alias for emoji",
12208 "--emoji show emoji",
12209 "--alttext show alt text for emoji",
12210 "--none don't show emoji or text"
12211 ],
12212 "usage": "prefs set emoji [-h] [--alias] [--emoji] [--alttext] [--none]"
12213 },
12214 "prefs set help": {
12215 "command": "prefs set help",
12216 "description": "help This help barmode Set bar mode client.debug Set client debug level client.delay Set client execution delay client.timeout Set client communication timeout color Set color support emoji Set emoji display hints Set hint display savepaths ... to be adjusted next ... output Set dump output style plotsliders Set plot slider display --------------------------------------------------------------------------------------- prefs set barmode available offline: yes Set persistent preference of HF/LF tune command styled output in the client",
12217 "notes": [
12218 "prefs set barmode --mix"
12219 ],
12220 "offline": true,
12221 "options": [
12222 "-h, --help This help",
12223 "--bar measured values as bar only",
12224 "--mix measured values as numbers and bar",
12225 "--val measured values only"
12226 ],
12227 "usage": "prefs set barmode [-h] [--bar] [--mix] [--val]"
12228 },
12229 "prefs set hints": {
12230 "command": "prefs set hints",
12231 "description": "Set persistent preference of showing hint messages in the client",
12232 "notes": [
12233 "prefs set hints --on"
12234 ],
12235 "offline": true,
12236 "options": [
12237 "-h, --help This help",
12238 "--off hide hints",
12239 "--on show hints"
12240 ],
12241 "usage": "prefs set hints [-h] [--off] [--on]"
12242 },
12243 "prefs set output": {
12244 "command": "prefs set output",
12245 "description": "Set dump output style to condense consecutive repeated data",
12246 "notes": [
12247 "prefs set output --normal -> sets the output style to normal",
12248 "prefs set output --dense -> sets the output style to dense"
12249 ],
12250 "offline": true,
12251 "options": [
12252 "-h, --help This help",
12253 "--normal normal output",
12254 "--dense dense output"
12255 ],
12256 "usage": "prefs set output [-h] [--normal] [--dense]"
12257 },
12258 "prefs set plotsliders": {
12259 "command": "prefs set plotsliders",
12260 "description": "Set persistent preference of showing the plotslider control in the client",
12261 "notes": [
12262 "prefs set plotsliders --on"
12263 ],
12264 "offline": true,
12265 "options": [
12266 "-h, --help This help",
12267 "--off hide plot slider controls",
12268 "--on show plot slider controls"
12269 ],
12270 "usage": "prefs set plotsliders [-h] [--off] [--on]"
12271 },
12272 "prefs set savepaths": {
12273 "command": "prefs set savepaths",
12274 "description": "Set persistent preference of file paths in the client",
12275 "notes": [
12276 "prefs set savepaths --dump /home/mydumpfolder -> all dump files will be saved into this folder",
12277 "prefs set savepaths --def /home/myfolder -c -> create if needed, all files will be saved into this folder"
12278 ],
12279 "offline": true,
12280 "options": [
12281 "-h, --help This help",
12282 "-c, --create create directory if it does not exist",
12283 "--def <path> default path",
12284 "--dump <path> dump file path",
12285 "--trace <path> trace path"
12286 ],
12287 "usage": "prefs set savepaths [-hc] [--def <path>] [--dump <path>] [--trace <path>]"
12288 },
12289 "quit": {
12290 "command": "quit",
12291 "description": "Quit the Proxmark3 client terminal",
12292 "notes": [
12293 "quit"
12294 ],
12295 "offline": true,
12296 "options": [
12297 "-h, --help This help"
12298 ],
12299 "usage": "quit [-h]"
12300 },
12301 "rem": {
12302 "command": "rem",
12303 "description": "Add a text line in log file",
12304 "notes": [
12305 "rem my message -> adds a timestamp with `my message`"
12306 ],
12307 "offline": true,
12308 "options": [
12309 "-h, --help This help",
12310 "<string> message line you want inserted"
12311 ],
12312 "usage": "rem [-h] <string> [<string>]..."
12313 },
12314 "script list": {
12315 "command": "script list",
12316 "description": "List available Lua, Cmd and Python scripts",
12317 "notes": [
12318 "script list"
12319 ],
12320 "offline": true,
12321 "options": [
12322 "-h, --help This help"
12323 ],
12324 "usage": "script list [-h]"
12325 },
12326 "script run": {
12327 "command": "script run",
12328 "description": "Run a Lua, Cmd or Python script. If no extension it will search for lua/cmd/py extensions Use `script list` to see available scripts",
12329 "notes": [
12330 "script run my_script -h"
12331 ],
12332 "offline": true,
12333 "options": [
12334 "-h, --help This help",
12335 "<filename> name of script to run",
12336 "<params> script parameters"
12337 ],
12338 "usage": "script run [-h] <filename> [<params>]..."
12339 },
12340 "smart brute": {
12341 "command": "smart brute",
12342 "description": "Tries to bruteforce SFI, using a known list of AID's",
12343 "notes": [
12344 "smart brute -t"
12345 ],
12346 "offline": false,
12347 "options": [
12348 "-h, --help This help",
12349 "-t, --tlv executes TLV decoder if it possible"
12350 ],
12351 "usage": "smart brute [-ht]"
12352 },
12353 "smart help": {
12354 "command": "smart help",
12355 "description": "help This help list List ISO 7816 history pcsc Turn pm3 into pcsc reader and relay to host OS via vpcd upgrade Upgrade sim module firmware --------------------------------------------------------------------------------------- smart list available offline: yes Alias of `trace list -t 7816` with selected protocol data to annotate trace buffer You can load a trace from file (see `trace load -h`) or it be downloaded from device by default It accepts all other arguments of `trace list`. Note that some might not be relevant for this specific protocol",
12356 "notes": [
12357 "smart list --frame -> show frame delay times",
12358 "smart list -1 -> use trace buffer"
12359 ],
12360 "offline": true,
12361 "options": [
12362 "-h, --help This help",
12363 "-1, --buffer use data from trace buffer",
12364 "--frame show frame delay times",
12365 "-c mark CRC bytes",
12366 "-r show relative times (gap and duration)",
12367 "-u display times in microseconds instead of clock cycles",
12368 "-x show hexdump to convert to pcap(ng)",
12369 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
12370 "-f, --file <fn> filename of dictionary"
12371 ],
12372 "usage": "smart list [-h1crux] [--frame] [-f <fn>]"
12373 },
12374 "smart info": {
12375 "command": "smart info",
12376 "description": "Extract more detailed information from smart card.",
12377 "notes": [
12378 "smart info -v"
12379 ],
12380 "offline": false,
12381 "options": [
12382 "-h, --help This help",
12383 "-v, --verbose verbose output"
12384 ],
12385 "usage": "smart info [-hv]"
12386 },
12387 "smart pcsc": {
12388 "command": "smart pcsc",
12389 "description": "Make pm3 available to host OS smartcard driver via vpcd to enable use with other software such as GlobalPlatform Pro",
12390 "notes": [
12391 "Requires the virtual smartcard daemon to be installed and running",
12392 "see https://frankmorgner.github.io/vsmartcard/virtualsmartcard/README.html",
12393 "note:",
12394 "`-v` shows APDU transactions between OS and card"
12395 ],
12396 "offline": true,
12397 "options": [
12398 "-h, --help This help",
12399 "--host <str> vpcd socket host (default: localhost)",
12400 "-p, --port <int> vpcd socket port (default: 35963)",
12401 "-v, --verbose display APDU transactions between OS and card",
12402 "-a use ISO 14443A contactless interface",
12403 "-b use ISO 14443B contactless interface",
12404 "-c use ISO 7816 contact interface"
12405 ],
12406 "usage": "smart pcsc [-hvabc] [--host <str>] [-p <int>]"
12407 },
12408 "smart raw": {
12409 "command": "smart raw",
12410 "description": "Sends raw bytes to card",
12411 "notes": [
12412 "smart raw -s -0 -d 00a404000e315041592e5359532e4444463031 -> `1PAY.SYS.DDF01` PPSE directory with get ATR",
12413 "smart raw -0 -d 00a404000e325041592e5359532e4444463031 -> `2PAY.SYS.DDF01` PPSE directory",
12414 "smart raw -0 -t -d 00a4040007a0000000041010 -> Mastercard",
12415 "smart raw -0 -t -d 00a4040007a0000000031010 -> Visa"
12416 ],
12417 "offline": false,
12418 "options": [
12419 "-h, --help This help",
12420 "-r do not read response",
12421 "-a active smartcard without select (reset sc module)",
12422 "-s active smartcard with select (get ATR)",
12423 "-t, --tlv executes TLV decoder if it possible",
12424 "-0 use protocol T=0",
12425 "--timeout <ms> Timeout in MS waiting for SIM to respond. (def 337ms)",
12426 "-d, --data <hex> bytes to send"
12427 ],
12428 "usage": "smart raw [-hrast0] [--timeout <ms>] -d <hex>"
12429 },
12430 "smart reader": {
12431 "command": "smart reader",
12432 "description": "Act as a smart card reader.",
12433 "notes": [
12434 "smart reader"
12435 ],
12436 "offline": false,
12437 "options": [
12438 "-h, --help This help",
12439 "-v, --verbose verbose output"
12440 ],
12441 "usage": "smart reader [-hv]"
12442 },
12443 "smart setclock": {
12444 "command": "smart setclock",
12445 "description": "Set clock speed for smart card interface.",
12446 "notes": [
12447 "smart setclock --4mhz",
12448 "smart setclock --16mhz"
12449 ],
12450 "offline": false,
12451 "options": [
12452 "-h, --help This help",
12453 "--16mhz 16 MHz clock speed",
12454 "--8mhz 8 MHz clock speed",
12455 "--4mhz 4 MHz clock speed"
12456 ],
12457 "usage": "smart setclock [-h] [--16mhz] [--8mhz] [--4mhz]"
12458 },
12459 "trace help": {
12460 "command": "trace help",
12461 "description": "help This help extract Extract authentication challenges found in trace list List protocol data in trace buffer load Load trace from file save Save trace buffer to file --------------------------------------------------------------------------------------- trace extract available offline: yes Extracts protocol authentication challenges from trace buffer",
12462 "notes": [
12463 "trace extract",
12464 "trace extract -1"
12465 ],
12466 "offline": true,
12467 "options": [
12468 "-h, --help This help",
12469 "-1, --buffer use data from trace buffer"
12470 ],
12471 "usage": "trace extract [-h1]"
12472 },
12473 "trace list": {
12474 "command": "trace list",
12475 "description": "Annotate trace buffer with selected protocol data You can load a trace from file (see `trace load -h`) or it be downloaded from device by default",
12476 "notes": [
12477 "trace list -t raw -> just show raw data without annotations",
12478 "",
12479 "trace list -t 14a -> interpret as ISO14443-A",
12480 "trace list -t 14b -> interpret as ISO14443-B",
12481 "trace list -t 15 -> interpret as ISO15693",
12482 "trace list -t 7816 -> interpret as ISO7816-4",
12483 "trace list -t cryptorf -> interpret as CryptoRF",
12484 "",
12485 "trace list -t des -> interpret as MIFARE DESFire",
12486 "trace list -t felica -> interpret as ISO18092 / FeliCa",
12487 "trace list -t hitag1 -> interpret as Hitag1",
12488 "trace list -t hitag2 -> interpret as Hitag2",
12489 "trace list -t hitags -> interpret as HitagS",
12490 "trace list -t iclass -> interpret as iCLASS",
12491 "trace list -t legic -> interpret as LEGIC",
12492 "trace list -t lto -> interpret as LTO-CM",
12493 "trace list -t mf -> interpret as MIFARE Classic and decrypt crypto1 stream",
12494 "trace list -t seos -> interpret as SEOS",
12495 "trace list -t thinfilm -> interpret as Thinfilm",
12496 "trace list -t topaz -> interpret as Topaz",
12497 "trace list -t mfp -> interpret as MIFARE Plus",
12498 "",
12499 "trace list -t mf -f mfc_default_keys.dic -> use default dictionary file",
12500 "trace list -t 14a --frame -> show frame delay times",
12501 "trace list -t 14a -1 -> use trace buffer"
12502 ],
12503 "offline": true,
12504 "options": [
12505 "-h, --help This help",
12506 "-1, --buffer use data from trace buffer",
12507 "--frame show frame delay times",
12508 "-c mark CRC bytes",
12509 "-r show relative times (gap and duration)",
12510 "-u display times in microseconds instead of clock cycles",
12511 "-x show hexdump to convert to pcap(ng)",
12512 "or to import into Wireshark using encapsulation type \"ISO 14443\"",
12513 "-t, --type <string> protocol to annotate the trace",
12514 "-f, --file <fn> filename of dictionary"
12515 ],
12516 "usage": "trace list [-h1crux] [--frame] [-t <string>] [-f <fn>]"
12517 },
12518 "trace load": {
12519 "command": "trace load",
12520 "description": "Load protocol data from binary file to trace buffer File extension is <.trace>",
12521 "notes": [
12522 "trace load -f mytracefile -> w/o file extension"
12523 ],
12524 "offline": true,
12525 "options": [
12526 "-h, --help This help",
12527 "-f, --file <fn> Specify trace file to load"
12528 ],
12529 "usage": "trace load [-h] -f <fn>"
12530 },
12531 "trace save": {
12532 "command": "trace save",
12533 "description": "Save protocol data from trace buffer to binary file File extension is <.trace>",
12534 "notes": [
12535 "trace save -f mytracefile -> w/o file extension"
12536 ],
12537 "offline": true,
12538 "options": [
12539 "-h, --help This help",
12540 "-f, --file <fn> Specify trace file to save"
12541 ],
12542 "usage": "trace save [-h] -f <fn>"
12543 },
12544 "usart btfactory": {
12545 "command": "usart btfactory",
12546 "description": "Reset BT add-on to factory settings This requires 1) BTpower to be turned ON 2) BT add-on to NOT be connected => the add-on blue LED must blink WARNING: process only if strictly needed!",
12547 "notes": [
12548 "usart btfactory"
12549 ],
12550 "offline": false,
12551 "options": [
12552 "-h, --help This help"
12553 ],
12554 "usage": "usart btfactory [-h]"
12555 },
12556 "usart config": {
12557 "command": "usart config",
12558 "description": "Configure USART. WARNING: it will have side-effects if used in USART HOST mode! The changes are not permanent, restart Proxmark3 to get default settings back.",
12559 "notes": [
12560 "usart config -b 9600",
12561 "usart config -b 9600 --none",
12562 "usart config -E"
12563 ],
12564 "offline": false,
12565 "options": [
12566 "-h, --help This help",
12567 "-b, --baud <dec> baudrate",
12568 "-N, --none mone parity",
12569 "-E, --even even parity",
12570 "-O, --odd odd parity"
12571 ],
12572 "usage": "usart config [-hNEO] [-b <dec>]"
12573 },
12574 "usart help": {
12575 "command": "usart help",
12576 "description": "help This help --------------------------------------------------------------------------------------- usart btpin available offline: no Change BT add-on PIN. WARNING: this requires 1) BTpower to be turned ON 2) BT add-on to NOT be connected => the add-on blue LED must blink",
12577 "notes": [
12578 "usart btpin -p 1234"
12579 ],
12580 "offline": true,
12581 "options": [
12582 "-h, --help This help",
12583 "-p, --pin <dec> Desired PIN number (4 digits)"
12584 ],
12585 "usage": "usart btpin [-h] -p <dec>"
12586 },
12587 "usart rx": {
12588 "command": "usart rx",
12589 "description": "Receive string over USART. WARNING: it will have side-effects if used in USART HOST mode!",
12590 "notes": [
12591 "usart rx -t 2000 -> 2 second timeout"
12592 ],
12593 "offline": false,
12594 "options": [
12595 "-h, --help This help",
12596 "-t, --timeout <dec> timeout in ms, default is 0ms"
12597 ],
12598 "usage": "usart rx [-h] [-t <dec>]"
12599 },
12600 "usart rxhex": {
12601 "command": "usart rxhex",
12602 "description": "Receive bytes over USART. WARNING: it will have side-effects if used in USART HOST mode!",
12603 "notes": [
12604 "usart rxhex -t 2000 -> 2 second timeout"
12605 ],
12606 "offline": false,
12607 "options": [
12608 "-h, --help This help",
12609 "-t, --timeout <dec> timeout in ms, default is 0ms"
12610 ],
12611 "usage": "usart rxhex [-h] [-t <dec>]"
12612 },
12613 "usart tx": {
12614 "command": "usart tx",
12615 "description": "Send string over USART. WARNING: it will have side-effects if used in USART HOST mode!",
12616 "notes": [
12617 "usart tx -d \"AT+VERSION\"",
12618 "usart tx -d \"AT+VERSION\\r\\n\""
12619 ],
12620 "offline": false,
12621 "options": [
12622 "-h, --help This help",
12623 "-d, --data <string> string to send"
12624 ],
12625 "usage": "usart tx [-h] -d <string>"
12626 },
12627 "usart txhex": {
12628 "command": "usart txhex",
12629 "description": "Send bytes over USART. WARNING: it will have side-effects if used in USART HOST mode!",
12630 "notes": [
12631 "usart txhex -d 504d33620a80000000010100f09f988ef09fa5b36233"
12632 ],
12633 "offline": false,
12634 "options": [
12635 "-h, --help This help",
12636 "-d, --data <hex> bytes to send"
12637 ],
12638 "usage": "usart txhex [-h] -d <hex>"
12639 },
12640 "usart txrx": {
12641 "command": "usart txrx",
12642 "description": "Send string over USART and wait for response. WARNING: if used in USART HOST mode, you can only send AT commands to add-on when BT connection is not established (LED needs to be blinking) Any other usage in USART HOST mode will have side-effects!",
12643 "notes": [
12644 "usart txrx -d \"AT+VERSION\" -> Talking to BT add-on (when no connection)",
12645 "usart txrx -t 2000 -d \"AT+SOMESTUFF\\r\\n\" -> Talking to a target requiring longer time and end-of-line chars"
12646 ],
12647 "offline": false,
12648 "options": [
12649 "-h, --help This help",
12650 "-t, --timeout <dec> timeout in ms, default is 1000 ms",
12651 "-d, --data <string> string to send"
12652 ],
12653 "usage": "usart txrx [-h] [-t <dec>] -d <string>"
12654 },
12655 "wiegand decode": {
12656 "command": "wiegand decode",
12657 "description": "Decode raw hex or binary to wiegand format",
12658 "notes": [
12659 "wiegand decode --raw 2006f623ae"
12660 ],
12661 "offline": true,
12662 "options": [
12663 "-h, --help This help",
12664 "-r, --raw <hex> raw hex to be decoded",
12665 "-b, --bin <bin> binary string to be decoded"
12666 ],
12667 "usage": "wiegand decode [-h] [-r <hex>] [-b <bin>]"
12668 },
12669 "wiegand encode": {
12670 "command": "wiegand encode",
12671 "description": "Encode wiegand formatted number to raw hex",
12672 "notes": [
12673 "wiegand encode --fc 101 --cn 1337 -> show all formats",
12674 "wiegand encode -w H10301 --fc 101 --cn 1337 -> H10301 format"
12675 ],
12676 "offline": true,
12677 "options": [
12678 "-h, --help This help",
12679 "--fc <dec> facility number",
12680 "--cn <dec> card number",
12681 "--issue <dec> issue level",
12682 "--oem <dec> OEM code",
12683 "-w, --wiegand <format> see `wiegand list` for available formats",
12684 "--pre add HID ProxII preamble to wiegand output"
12685 ],
12686 "usage": "wiegand encode [-h] [--fc <dec>] --cn <dec> [--issue <dec>] [--oem <dec>] [-w <format>] [--pre]"
12687 },
12688 "wiegand help": {
12689 "command": "wiegand help",
12690 "description": "help This help list List available wiegand formats encode Encode to wiegand raw hex (currently for HID Prox) decode Convert raw hex to decoded wiegand format (currently for HID Prox) --------------------------------------------------------------------------------------- wiegand list available offline: yes List available wiegand formats",
12691 "notes": [
12692 "wiegand list"
12693 ],
12694 "offline": true,
12695 "options": [
12696 "-h, --help This help"
12697 ],
12698 "usage": "wiegand info [-h]"
12699 }
12700 },
12701 "metadata": {
12702 "commands_extracted": 735,
12703 "extracted_by": "PM3Help2JSON v1.00",
12704 "extracted_on": "2024-05-14T08:02:41"
12705 }
12706 }