| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 1 | ndnsec-delete |
| 2 | ============= |
| 3 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 4 | Synopsis |
| 5 | -------- |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 6 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 7 | **ndnsec-delete** [**-h**] [**-k**\|\ **-c**] *name* |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 8 | |
| 9 | Description |
| 10 | ----------- |
| 11 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 12 | :program:`ndnsec-delete` allows to delete security data from both the |
| 13 | **Public Info Base (PIB)** and the **Trusted Platform Module (TPM)**. |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 14 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 15 | By default, :program:`ndnsec-delete` will interpret *name* as an identity name. |
| 16 | If an identity is deleted, all keys and certificates belonging to that identity |
| 17 | will be deleted as well. If a key is deleted, all certificates associated with |
| 18 | that key will be deleted as well. |
| Yingdi Yu | 6147ef4 | 2014-12-08 17:48:32 -0800 | [diff] [blame] | 19 | |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 20 | Options |
| 21 | ------- |
| 22 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 23 | .. option:: -k, --delete-key |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 24 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 25 | Interpret *name* as a key name and delete the key and its associated data. |
| 26 | |
| 27 | .. option:: -c, --delete-cert |
| 28 | |
| 29 | Interpret *name* as a certificate name and delete the certificate. |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 30 | |
| Yingdi Yu | 6147ef4 | 2014-12-08 17:48:32 -0800 | [diff] [blame] | 31 | Exit Status |
| 32 | ----------- |
| 33 | |
| 34 | Normally, the exit status is 0 if the requested entity is deleted successfully. |
| 35 | If the entity to be deleted does not exist, the exit status is 1. |
| 36 | For other errors, the exit status is 2. |
| 37 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 38 | Example |
| 39 | ------- |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 40 | |
| Davide Pesavento | b310efb | 2019-04-11 22:10:24 -0400 | [diff] [blame] | 41 | Delete all data related to an identity:: |
| Alexander Afanasyev | 151a855 | 2014-04-11 00:54:43 -0700 | [diff] [blame] | 42 | |
| 43 | $ ndnsec-delete /ndn/test/david |