blob: 253073b8473458aa72cef6bb02bc95dc81d353fb [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -07001ndnsec-key-gen
2==============
3
Yingdi Yu7d8644a2014-12-01 22:55:49 -08004``ndnsec-key-gen`` is tool to generate a pair of key.
Alexander Afanasyev151a8552014-04-11 00:54:43 -07005
6Usage
7-----
8
9::
10
Yingdi Yu7d8644a2014-12-01 22:55:49 -080011 $ ndnsec-key-gen [-h] [-n] [-d] [-t keyType] identity
Alexander Afanasyev151a8552014-04-11 00:54:43 -070012
13Description
14-----------
15
Yingdi Yu7d8644a2014-12-01 22:55:49 -080016``ndnsec-key-gen`` creates a key pair for the specified ``identity`` and sets the key as the
Alexander Afanasyev151a8552014-04-11 00:54:43 -070017identity's default key. ``ndnsec-key-gen`` will also create a signing request for the generated key.
18The signing request will be written to standard output in base64 encoding.
19
20By default, it will also set the identity as the system default identity.
21
22Options
23-------
24
25``-n``
26 Do not set the identity as the system default identity.
27
Alexander Afanasyev35109a12017-01-04 15:39:06 -080028 Note that if it is the first identity/key/certificate, then it will be
29 set as default regardless of ``-n`` flag.
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080030
Yingdi Yu7d8644a2014-12-01 22:55:49 -080031``-t keyType``
32 Specify the key type. ``r`` (default) for RSA key. ``e`` for ECDSA key.
33
Alexander Afanasyev151a8552014-04-11 00:54:43 -070034Examples
35--------
36
37::
38
39 $ ndnsec-key-gen /ndn/test/david
40 Bv0DAAc9CANuZG4IBHRlc3QIBWRhdmlkCANLRVkIEWtzay0xMzk2OTEzMDU4MTk2
41 CAdJRC1DRVJUCAgAAAFFPoG0ohQDGAECFf0BeDCCAXQwIhgPMjAxNDA0MDcyMzI0
42 MThaGA8yMDM0MDQwMjIzMjQxOFowKjAoBgNVBCkTIS9uZG4vdGVzdC9kYXZpZC9r
43 c2stMTM5NjkxMzA1ODE5NjCCASAwDQYJKoZIhvcNAQEBBQADggENADCCAQgCggEB
44 ALS6udLacpydecxMRIfZeo74fxzpsITqaa/4UxD2FJ9lU4dtfiSSIOaRwAB/w0K/
45 AauQRq3Q1AiEocUsW2h8LmtcuF4Cj9TGAUD/1s3CISMwf9zwQ3ZhNIzN0IOsrpPA
46 TsHrbdwtOxrcFvXX4GnMLWgtvcSB52Cn68h/4AUiA1CG9/DOyCyA4EHiIkHBxh6B
47 TvAmw7SmNjr1ZBTYMaMAEV5/oLZCHzHRO+2fKdEttaWH3bz7iKVVS8u5ZxXcBs8g
48 ot55m7Xf6/TUk3qQXM1kM8wW04U+8n3jch1i7tD2T3c/OFKTT7AWndwcfbU99Z6C
49 FZ7fMsgRHxFNY8hCFZJvFFUCAREWOhsBARw1BzMIA25kbggEdGVzdAgFZGF2aWQI
50 A0tFWQgRa3NrLTEzOTY5MTMwNTgxOTYIB0lELUNFUlQX/QEAW2yfF8JTgu5okR+n
51 dRlXc3UR/b1REegrpQb3xVzs7fYiiHwFYzQE9RzOuGh/9GSMvQcfejsPw021tJnj
52 oxNx6spGTOK5Bc0QZGeC6YyNoVSaJr9Obc5Uh8eRqxw76r0pCUHP+l38UgUGeBg/
53 aHurtcu5zK0zFYX++SAfUGLUZlG4CqKBUNZC+6w9OGUXlcW411zMzfqQ7V9Gxg+p
54 1IMNJQ6trTFdIwT/4YWHsxR+16r2TRWCNHtJey2GEG84YoqRh8y37jnu7oPhAtTN
55 TgG9O7O39dZLiFg+UP3LpW1LY64fJXsNfZQmnZWcNo5lX6MXfeiPxWFjOQqnno82
56 1hgqgA==