| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 1 | ndnsec |
| 2 | ====== |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 3 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 4 | :program:`ndnsec` is a command-line toolkit to perform various NDN security |
| 5 | management operations. |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 6 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 7 | Synopsis |
| 8 | -------- |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 9 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 10 | **ndnsec** *command* [*argument*]... |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 11 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 12 | **ndnsec-**\ *command* [*argument*]... |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 13 | |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 14 | Description |
| 15 | ----------- |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 16 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 17 | The NDN security data are stored in two places: **Public Information Base** |
| 18 | (PIB) and **Trusted Platform Module** (TPM). The :program:`ndnsec` toolkit |
| 19 | provides a command-line interface for managing and using the NDN security data. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 20 | |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 21 | Commands |
| 22 | -------- |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 23 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 24 | The following commands are understood: |
| 25 | |
| 26 | :doc:`list <ndnsec-list>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 27 | List all known identities/keys/certificates. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 28 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 29 | :doc:`get-default <ndnsec-get-default>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 30 | Show the default identity/key/certificate. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 31 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 32 | :doc:`set-default <ndnsec-set-default>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 33 | Change the default identity/key/certificate. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 34 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 35 | :doc:`delete <ndnsec-delete>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 36 | Delete an identity/key/certificate. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 37 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 38 | :doc:`key-gen <ndnsec-key-gen>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 39 | Generate a key for an identity. |
| Alexander Afanasyev | ace7445 | 2014-11-30 22:28:24 -0800 | [diff] [blame] | 40 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 41 | :doc:`sign-req <ndnsec-sign-req>` |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 42 | Generate a certificate signing request. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 43 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 44 | :doc:`cert-gen <ndnsec-cert-gen>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 45 | Create a certificate for an identity. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 46 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 47 | :doc:`cert-dump <ndnsec-cert-dump>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 48 | Export a certificate. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 49 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 50 | :doc:`cert-install <ndnsec-cert-install>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 51 | Import a certificate from a file. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 52 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 53 | :doc:`export <ndnsec-export>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 54 | Export an identity as a SafeBag. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 55 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 56 | :doc:`import <ndnsec-import>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 57 | Import an identity from a SafeBag. |
| Alexander Afanasyev | 7c6aeb0 | 2014-04-10 19:59:19 -0700 | [diff] [blame] | 58 | |
| Davide Pesavento | 01cea50 | 2021-07-31 19:25:42 -0400 | [diff] [blame] | 59 | :doc:`unlock-tpm <ndnsec-unlock-tpm>` |
| Davide Pesavento | fa995ac | 2019-03-27 23:44:46 -0400 | [diff] [blame] | 60 | Unlock the TPM. |