blob: edf948afcb858326cddbf9bb1ec16d2e54b18305 [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -07001ndnsec
2======
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07003
Davide Pesaventofa995ac2019-03-27 23:44:46 -04004Synopsis
5--------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07006
Davide Pesaventofa995ac2019-03-27 23:44:46 -04007**ndnsec** *command* [*argument*]...
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07008
Davide Pesaventofa995ac2019-03-27 23:44:46 -04009**ndnsec-**\ *command* [*argument*]...
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070010
Alexander Afanasyev151a8552014-04-11 00:54:43 -070011Description
12-----------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070013
Davide Pesavento102f0572024-06-22 15:00:06 -040014:program:`ndnsec` is a command-line toolkit to perform various NDN security
15management operations.
16
Davide Pesaventofa995ac2019-03-27 23:44:46 -040017The NDN security data are stored in two places: **Public Information Base**
18(PIB) and **Trusted Platform Module** (TPM). The :program:`ndnsec` toolkit
19provides a command-line interface for managing and using the NDN security data.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070020
Davide Pesaventofa995ac2019-03-27 23:44:46 -040021Commands
22--------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070023
Davide Pesavento01cea502021-07-31 19:25:42 -040024The following commands are understood:
25
26:doc:`list <ndnsec-list>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040027 List all known identities/keys/certificates.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070028
Davide Pesavento01cea502021-07-31 19:25:42 -040029:doc:`get-default <ndnsec-get-default>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040030 Show the default identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070031
Davide Pesavento01cea502021-07-31 19:25:42 -040032:doc:`set-default <ndnsec-set-default>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040033 Change the default identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070034
Davide Pesavento01cea502021-07-31 19:25:42 -040035:doc:`delete <ndnsec-delete>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040036 Delete an identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070037
Davide Pesavento01cea502021-07-31 19:25:42 -040038:doc:`key-gen <ndnsec-key-gen>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040039 Generate a key for an identity.
Alexander Afanasyevace74452014-11-30 22:28:24 -080040
Davide Pesavento01cea502021-07-31 19:25:42 -040041:doc:`sign-req <ndnsec-sign-req>`
Alexander Afanasyev151a8552014-04-11 00:54:43 -070042 Generate a certificate signing request.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070043
Davide Pesavento01cea502021-07-31 19:25:42 -040044:doc:`cert-gen <ndnsec-cert-gen>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040045 Create a certificate for an identity.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070046
Davide Pesavento01cea502021-07-31 19:25:42 -040047:doc:`cert-dump <ndnsec-cert-dump>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040048 Export a certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070049
Davide Pesavento01cea502021-07-31 19:25:42 -040050:doc:`cert-install <ndnsec-cert-install>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040051 Import a certificate from a file.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070052
Davide Pesavento01cea502021-07-31 19:25:42 -040053:doc:`export <ndnsec-export>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040054 Export an identity as a SafeBag.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070055
Davide Pesavento01cea502021-07-31 19:25:42 -040056:doc:`import <ndnsec-import>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040057 Import an identity from a SafeBag.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070058
Davide Pesavento01cea502021-07-31 19:25:42 -040059:doc:`unlock-tpm <ndnsec-unlock-tpm>`
Davide Pesaventofa995ac2019-03-27 23:44:46 -040060 Unlock the TPM.
Davide Pesavento102f0572024-06-22 15:00:06 -040061
62Exit Status
63-----------
64
65Generally, :program:`ndnsec` commands exit with status 0 if the requested
66operation was completed successfully. On error, a nonzero status is returned.
67Individual commands may use certain nonzero exit codes to indicate that a
68more specific error has occurred. Please consult the respective man pages
69for more information.