Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / f3e84874e5e04bdccebfd90b58eef6e9feb5e98d / . / docs / manpages / ndnsec-list.rst
blob: e0fde91f0ccd74d8ea66250886fdb18e9c308e3f [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]1ndnsec-list
2===========
3
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]4Synopsis
5--------
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]6
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]7**ndnsec-list** [**-h**] [**-k**\|\ **-c**]
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]8
9Description
10-----------
11
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]12:program:`ndnsec-list` prints the names of all the entities stored in the
13**Public Information Base (PIB)**, such as identities, keys, and certificates,
14up to the given granularity level. By default, only the identity names are
15shown. The default entities will be marked with a "*" in front of their names.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]16
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]17For example::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]18
19 $ ndnsec list
20 * /ndn/edu/ucla/cs/yingdi
21 /ndn/test/cathy
22 /ndn/test/bob
23 /ndn/test/alice
24
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]25Options
26-------
27
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]28.. option:: -k, --key
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]29
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]30 Display key names for each identity. The key name with a "*" in front is
31 the default key name of the corresponding identity.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]32
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]33.. option:: -c, --cert
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]34
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]35 Display certificate names for each key. The certificate name with a "*"
36 in front is the default certificate name of the corresponding key.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]37
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]38Example
39-------
40
41Display all the key names in PIB::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]42
43 $ ndnsec-list -k
44 * /ndn/edu/ucla/cs/yingdi
45 +->* /ndn/edu/ucla/cs/yingdi/ksk-1397247318867
46 +-> /ndn/edu/ucla/cs/yingdi/ksk-1393811874052
47
48 /ndn/test/cathy
49 +->* /ndn/test/cathy/ksk-1394129695418
50
51 /ndn/test/bob
52 +->* /ndn/test/bob/ksk-1394129695308
53
54 /ndn/test/alice
55 +->* /ndn/test/alice/ksk-1394129695025
56
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]57Display all the certificate names in PIB::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]58
59 $ ndnsec-list -c
60 * /ndn/edu/ucla/cs/yingdi
61 +->* /ndn/edu/ucla/cs/yingdi/ksk-1397247318867
62 +->* /ndn/edu/ucla/cs/yingdi/KEY/ksk-1397247318867/ID-CERT/%00%00%01ERn%1B%BE
63 +-> /ndn/edu/ucla/cs/yingdi/ksk-1393811874052
64 +->* /ndn/edu/ucla/cs/yingdi/KEY/ksk-1393811874052/ID-CERT/%FD%01D%85%A9a%DD
65
66 /ndn/test/cathy
67 +->* /ndn/test/cathy/ksk-1394129695418
68 +->* /ndn/test/KEY/cathy/ksk-1394129695418/ID-CERT/%FD%01D%98%9A%F3J
69
70 /ndn/test/bob
71 +->* /ndn/test/bob/ksk-1394129695308
72 +->* /ndn/test/KEY/bob/ksk-1394129695308/ID-CERT/%FD%01D%98%9A%F2%AE
73
74 /ndn/test/alice
75 +->* /ndn/test/alice/ksk-1394129695025
76 +->* /ndn/test/KEY/alice/ksk-1394129695025/ID-CERT/%FD%01D%98%9A%F2%3F