blob: a045cd6efd340adb334e327734707ce9098e2e4d [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Zhiyi Zhang457f09a2018-01-05 13:45:38 -08002/*
Davide Pesavento47ce2ee2023-05-09 01:33:33 -04003 * Copyright (c) 2013-2023 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
Yingdi Yu8d7468f2014-02-21 14:49:45 -080020 */
21
Alexander Afanasyev82c359c2017-01-04 14:48:07 -080022#include "ndnsec.hpp"
Alexander Afanasyevd7db8bf2015-01-04 15:31:02 -080023#include "util.hpp"
Yingdi Yu8d7468f2014-02-21 14:49:45 -080024
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040025namespace ndn::ndnsec {
Alexander Afanasyev82c359c2017-01-04 14:48:07 -080026
Yingdi Yub61f5402014-02-26 17:46:11 -080027int
28ndnsec_key_gen(int argc, char** argv)
Yingdi Yu8d7468f2014-02-21 14:49:45 -080029{
Yingdi Yu8d7468f2014-02-21 14:49:45 -080030 namespace po = boost::program_options;
31
Alexander Afanasyev35109a12017-01-04 15:39:06 -080032 Name identityName;
Davide Pesaventob310efb2019-04-11 22:10:24 -040033 bool wantNotDefault = false;
34 char keyTypeChoice;
35 char keyIdTypeChoice;
36 std::string userKeyId;
Yingdi Yu8d7468f2014-02-21 14:49:45 -080037
Davide Pesaventob310efb2019-04-11 22:10:24 -040038 po::options_description description(
Zhiyi Zhang4c68b6e2020-04-20 16:13:21 -070039 "Usage: ndnsec key-gen [-h] [-n] [-t TYPE] [-k KEYIDTYPE|--keyid KEYID] [-i] IDENTITY\n"
Davide Pesaventob310efb2019-04-11 22:10:24 -040040 "\n"
41 "Options");
Yingdi Yub61f5402014-02-26 17:46:11 -080042 description.add_options()
Yingdi Yu8d7468f2014-02-21 14:49:45 -080043 ("help,h", "produce help message")
Davide Pesaventob310efb2019-04-11 22:10:24 -040044 ("identity,i", po::value<Name>(&identityName), "identity name, e.g., /ndn/edu/ucla/alice")
45 ("not-default,n", po::bool_switch(&wantNotDefault), "do not set the identity as default")
Davide Pesavento702467b2020-04-22 21:41:23 -040046 ("type,t", po::value<char>(&keyTypeChoice)->default_value('e'),
Zhiyi Zhang4c68b6e2020-04-20 16:13:21 -070047 "key type: 'r' for RSA, 'e' for ECDSA")
48 ("keyid-type,k", po::value<char>(&keyIdTypeChoice),
Davide Pesavento58de07a2022-06-08 00:02:02 -040049 "key ID type: 'h' for the SHA-256 of the public key, 'r' for a 64-bit "
Zhiyi Zhang4c68b6e2020-04-20 16:13:21 -070050 "random number (the default unless --keyid is specified)")
Davide Pesavento58de07a2022-06-08 00:02:02 -040051 ("keyid", po::value<std::string>(&userKeyId),
52 "user-specified key ID, interpreted as a name component in URI format")
Yingdi Yu8d7468f2014-02-21 14:49:45 -080053 ;
54
55 po::positional_options_description p;
56 p.add("identity", 1);
Yingdi Yu8d7468f2014-02-21 14:49:45 -080057
Yingdi Yub61f5402014-02-26 17:46:11 -080058 po::variables_map vm;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080059 try {
Alexander Afanasyev82c359c2017-01-04 14:48:07 -080060 po::store(po::command_line_parser(argc, argv).options(description).positional(p).run(), vm);
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080061 po::notify(vm);
62 }
63 catch (const std::exception& e) {
Davide Pesaventob310efb2019-04-11 22:10:24 -040064 std::cerr << "ERROR: " << e.what() << "\n\n"
65 << description << std::endl;
66 return 2;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080067 }
Yingdi Yub61f5402014-02-26 17:46:11 -080068
Davide Pesaventob310efb2019-04-11 22:10:24 -040069 if (vm.count("help") > 0) {
70 std::cout << description << std::endl;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080071 return 0;
72 }
Yingdi Yu8d7468f2014-02-21 14:49:45 -080073
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080074 if (vm.count("identity") == 0) {
Davide Pesaventob310efb2019-04-11 22:10:24 -040075 std::cerr << "ERROR: you must specify an identity" << std::endl;
76 return 2;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080077 }
Yingdi Yu8d7468f2014-02-21 14:49:45 -080078
Davide Pesaventob310efb2019-04-11 22:10:24 -040079 KeyIdType keyIdType = KeyIdType::RANDOM;
80 Name::Component userKeyIdComponent;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -080081
Davide Pesaventob310efb2019-04-11 22:10:24 -040082 if (vm.count("keyid") > 0) {
Zhiyi Zhang4c68b6e2020-04-20 16:13:21 -070083 if (vm.count("keyid-type") > 0) {
84 std::cerr << "ERROR: cannot specify both '--keyid' and '--keyid-type'" << std::endl;
85 return 2;
86 }
87
Davide Pesaventob310efb2019-04-11 22:10:24 -040088 keyIdType = KeyIdType::USER_SPECIFIED;
89 userKeyIdComponent = name::Component::fromEscapedString(userKeyId);
Davide Pesavento58de07a2022-06-08 00:02:02 -040090 if (userKeyIdComponent.empty() ||
91 userKeyIdComponent.isImplicitSha256Digest() ||
92 userKeyIdComponent.isParametersSha256Digest() ||
93 userKeyIdComponent.isKeyword()) {
94 std::cerr << "ERROR: '" << userKeyIdComponent << "' cannot be used as key ID" << std::endl;
Davide Pesaventob310efb2019-04-11 22:10:24 -040095 return 2;
96 }
97 }
98
99 if (vm.count("keyid-type") > 0) {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400100 switch (keyIdTypeChoice) {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400101 case 'h':
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800102 keyIdType = KeyIdType::SHA256;
Davide Pesaventob310efb2019-04-11 22:10:24 -0400103 break;
Zhiyi Zhang4c68b6e2020-04-20 16:13:21 -0700104 case 'r':
105 // KeyIdType::RANDOM is the default
106 break;
Davide Pesaventob310efb2019-04-11 22:10:24 -0400107 default:
Davide Pesavento58de07a2022-06-08 00:02:02 -0400108 std::cerr << "ERROR: unrecognized key ID type '" << keyIdTypeChoice << "'" << std::endl;
Davide Pesaventob310efb2019-04-11 22:10:24 -0400109 return 2;
110 }
111 }
112
113 unique_ptr<KeyParams> params;
114 switch (keyTypeChoice) {
115 case 'r':
116 if (keyIdType == KeyIdType::USER_SPECIFIED) {
117 params = make_unique<RsaKeyParams>(userKeyIdComponent);
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800118 }
119 else {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400120 params = make_unique<RsaKeyParams>(detail::RsaKeyParamsInfo::getDefaultSize(), keyIdType);
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800121 }
Davide Pesaventob310efb2019-04-11 22:10:24 -0400122 break;
123 case 'e':
124 if (keyIdType == KeyIdType::USER_SPECIFIED) {
125 params = make_unique<EcKeyParams>(userKeyIdComponent);
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800126 }
Davide Pesaventob310efb2019-04-11 22:10:24 -0400127 else {
128 params = make_unique<EcKeyParams>(detail::EcKeyParamsInfo::getDefaultSize(), keyIdType);
129 }
130 break;
131 default:
132 std::cerr << "ERROR: unrecognized key type '" << keyTypeChoice << "'" << std::endl;
133 return 2;
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800134 }
135
Davide Pesaventof2cae612021-03-24 18:47:05 -0400136 KeyChain keyChain;
Zhiyi Zhang457f09a2018-01-05 13:45:38 -0800137
Davide Pesaventob310efb2019-04-11 22:10:24 -0400138 security::Identity identity;
139 security::Key key;
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -0800140 try {
Davide Pesaventob310efb2019-04-11 22:10:24 -0400141 identity = keyChain.getPib().getIdentity(identityName);
142 key = keyChain.createKey(identity, *params);
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -0800143 }
Davide Pesaventob310efb2019-04-11 22:10:24 -0400144 catch (const security::Pib::Error&) {
145 // identity doesn't exist, so create it and generate key
146 identity = keyChain.createIdentity(identityName, *params);
147 key = identity.getDefaultKey();
Alexander Afanasyev2a047eb2014-11-30 22:45:02 -0800148 }
Davide Pesaventob310efb2019-04-11 22:10:24 -0400149
150 if (!wantNotDefault) {
151 keyChain.setDefaultKey(identity, key);
152 keyChain.setDefaultIdentity(identity);
153 }
154
155 io::save(key.getDefaultCertificate(), std::cout);
156
Yingdi Yu8d7468f2014-02-21 14:49:45 -0800157 return 0;
158}
159
Davide Pesavento47ce2ee2023-05-09 01:33:33 -0400160} // namespace ndn::ndnsec