Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/docs/pskc2csv.rst
blob: 4602121a1830ef3f525316c988e64c9dc6f97a29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
:orphan:

pskc2csv
========

Synopsis
--------

**pskc2csv** [*options*] <*FILE*>

Description
-----------

:program:`pskc2csv` reads a PSKC file, optionally decrypts any encrypted key
material and outputs a CSV file with information from the PSKC file.

Options
-------

.. program:: pskc2csv

.. option:: -h, --help

   Display usage summary.

.. option:: -V, --version

   Display version information.

.. option:: -o FILE, --output FILE

   By default :program:`pskc2csv` writes a CSV file to stdout. This option
   can be used to save the CSV to a file instead.

.. option:: -c COL:LABEL,COL,.., --columns COL:LABEL,COL,..

   Specify the columns that should be written to the CSV file. Any
   property of :class:`~pskc.key.Key` instances can be used as well
   as :class:`~pskc.policy.Policy` properties via ``policy``.

   For example: ``serial``, ``secret``, ``counter``, ``time_offset``,
   ``time_interval``, ``interval``, ``time_drift``, ``issuer``,
   ``manufacturer``, ``response_length``, ``policy.pin_min_length``.

   By default ``serial,secret,algorithm,response_length,time_interval`` is
   used.

   The column can be followed by an optional label to use in the CSV file in
   place of the column specification.

.. option:: -p PASS/FILE, --password PASS/FILE, --passwd PASS/FILE

   The password to use for decryption. If the argument refers to a file the
   password is read from the file instead.

.. option:: -s KEY/FILE, --secret KEY/FILE

   A hex encoded encryption key or a file containing the binary (raw data,
   not encoded) key.

.. option:: -e ENCODING, --secret-encoding ENCODING

   Specify the encoding to use for writing key material to the CSV file. By
   default HEX encoding is used. Valid encodings are: ``base32``, ``base64``
   or ``hex``.