blob: 1eb0ed8e346c58d89394b3fa5b26805af518a3ca [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 -04004:program:`ndnsec` is a command-line toolkit to perform various NDN security
5management operations.
Alexander Afanasyev151a8552014-04-11 00:54:43 -07006
Davide Pesaventofa995ac2019-03-27 23:44:46 -04007Synopsis
8--------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07009
Davide Pesaventofa995ac2019-03-27 23:44:46 -040010**ndnsec** *command* [*argument*]...
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070011
Davide Pesaventofa995ac2019-03-27 23:44:46 -040012**ndnsec-**\ *command* [*argument*]...
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070013
Alexander Afanasyev151a8552014-04-11 00:54:43 -070014Description
15-----------
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070016
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 Pesaventofa995ac2019-03-27 23:44:46 -040024list_
25 List all known identities/keys/certificates.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070026
Davide Pesaventofa995ac2019-03-27 23:44:46 -040027get-default_
28 Show the default identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070029
Davide Pesaventofa995ac2019-03-27 23:44:46 -040030set-default_
31 Change the default identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070032
Davide Pesaventofa995ac2019-03-27 23:44:46 -040033delete_
34 Delete an identity/key/certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070035
Davide Pesaventofa995ac2019-03-27 23:44:46 -040036key-gen_
37 Generate a key for an identity.
Alexander Afanasyevace74452014-11-30 22:28:24 -080038
Davide Pesaventofa995ac2019-03-27 23:44:46 -040039sign-req_
Alexander Afanasyev151a8552014-04-11 00:54:43 -070040 Generate a certificate signing request.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070041
Davide Pesaventofa995ac2019-03-27 23:44:46 -040042cert-gen_
43 Create a certificate for an identity.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070044
Davide Pesaventofa995ac2019-03-27 23:44:46 -040045cert-dump_
46 Export a certificate.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070047
Davide Pesaventofa995ac2019-03-27 23:44:46 -040048cert-install_
49 Import a certificate from a file.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070050
Davide Pesaventofa995ac2019-03-27 23:44:46 -040051export_
52 Export an identity as a SafeBag.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070053
Davide Pesaventofa995ac2019-03-27 23:44:46 -040054import_
55 Import an identity from a SafeBag.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070056
Davide Pesaventofa995ac2019-03-27 23:44:46 -040057unlock-tpm_
58 Unlock the TPM.
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070059
Davide Pesaventofa995ac2019-03-27 23:44:46 -040060.. _list: ndnsec-list.html
61.. _get-default: ndnsec-get-default.html
62.. _set-default: ndnsec-set-default.html
63.. _delete: ndnsec-delete.html
64.. _key-gen: ndnsec-key-gen.html
65.. _sign-req: ndnsec-sign-req.html
66.. _cert-gen: ndnsec-cert-gen.html
67.. _cert-dump: ndnsec-cert-dump.html
68.. _cert-install: ndnsec-cert-install.html
69.. _export: ndnsec-export.html
70.. _import: ndnsec-import.html
71.. _unlock-tpm: ndnsec-unlock-tpm.html