Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / ace744559263c9b92f657b18909a8ae841c144eb / . / docs / manpages / ndnsec.rst
blob: 8641d01924b6728df42e475ad3800c50c862e655 [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]1ndnsec
2======
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]3
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]4``ndnsec`` is a command-line toolkit to perform various NDN security management
5operation.
6
7Usage
8-----
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]9
10::
11
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]12 $ ndnsec <command> [<args>]
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]13
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]14or alternatively
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]15
16::
17
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]18 $ ndnsec-command [<args>]
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]19
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]20Description
21-----------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]22
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]23The NDN security data are stored and managed in two places: **Public Information Base** and
24**Trusted Platform Module**. ``ndnsec`` toolkit provides a command-line interface of managing and
25using the NDN security data.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]26
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]27ndnsec commands
28---------------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]29
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]30ndnsec-list_
31 Display information in PublicInfo.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]32
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]33ndnsec-get-default_
34 Get default setting info.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]35
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]36ndnsec-set-default_
37 Configure default setting.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]38
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]39ndnsec-key-gen_
40 Generate a Key-Signing-Key for an identity.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]41
Alexander Afanasyevace74452014-11-30 22:28:24 -0800[diff] [blame^]42ndnsec-dsk-gen_
43 Generate a Data-Signing-Key (DSK) for an identity and sign the DSK using the corresponding KSK.
44
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]45ndnsec-sign-req_
46 Generate a certificate signing request.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]47
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]48ndnsec-cert-gen_
49 Generate an identity certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]50
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]51ndnsec-cert-dump_
52 Dump a certificate from PublicInfo.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]53
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]54ndnsec-cert-install_
55 Install a certificate into PublicInfo.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]56
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]57ndnsec-delete_
58 Delete identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]59
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]60ndnsec-export_
61 Export an identity package.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]62
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]63ndnsec-import_
64 Import an identity package.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]65
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]66ndnsec-set-acl_
67 Configure ACL of a private key.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]68
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]69ndnsec-unlock-tpm_
70 Unlock Tpm.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]71
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]72ndnsec-op-tool_
73 Operator tool.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700[diff] [blame]74
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]75.. _ndnsec-list: ndnsec-list.html
76.. _ndnsec-get-default: ndnsec-get-default.html
77.. _ndnsec-set-default: ndnsec-set-default.html
78.. _ndnsec-key-gen: ndnsec-key-gen.html
Alexander Afanasyevace74452014-11-30 22:28:24 -0800[diff] [blame^]79.. _ndnsec-dsk-gen: ndnsec-dsk-gen.html
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]80.. _ndnsec-sign-req: ndnsec-sign-req.html
81.. _ndnsec-cert-gen: ndnsec-cert-gen.html
82.. _ndnsec-cert-dump: ndnsec-cert-dump.html
83.. _ndnsec-cert-install: ndnsec-cert-install.html
84.. _ndnsec-delete: ndnsec-delete.html
85.. _ndnsec-export: ndnsec-export.html
86.. _ndnsec-import: ndnsec-import.html
87.. _ndnsec-set-acl: ndnsec-set-acl.html
88.. _ndnsec-unlock-tpm: ndnsec-unlock-tpm.html
89.. _ndnsec-op-tool: ndnsec-op-tool.html