blob: 0350bac043b97668f3fb277a02dc2deb5f4cd98a [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shi476200b2017-10-05 12:16:27 +00002/*
Davide Pesavento25d9c9f2024-06-23 15:10:05 -04003 * Copyright (c) 2013-2024 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 Pesavento97ee8112020-08-11 21:38:34 -040025#include "ndn-cxx/util/scope.hpp"
Davide Pesaventob310efb2019-04-11 22:10:24 -040026
Davide Pesavento80d671f2022-06-08 04:04:52 -040027#include <openssl/crypto.h>
28
Davide Pesavento47ce2ee2023-05-09 01:33:33 -040029namespace ndn::ndnsec {
Alexander Afanasyev82c359c2017-01-04 14:48:07 -080030
Yingdi Yub61f5402014-02-26 17:46:11 -080031int
Yingdi Yu8d7468f2014-02-21 14:49:45 -080032ndnsec_export(int argc, char** argv)
33{
Yingdi Yu8d7468f2014-02-21 14:49:45 -080034 namespace po = boost::program_options;
35
Junxiao Shibc2e78e2020-05-20 15:01:08 -060036 Name name;
37 bool isIdentityName = false;
38 bool isKeyName = false;
39 bool isCertName = false;
Yingdi Yu8d7468f2014-02-21 14:49:45 -080040 std::string output;
Davide Pesaventob310efb2019-04-11 22:10:24 -040041 std::string password;
Yingdi Yu8d7468f2014-02-21 14:49:45 -080042
Davide Pesavento97ee8112020-08-11 21:38:34 -040043 auto guard = make_scope_exit([&password] {
Davide Pesaventob310efb2019-04-11 22:10:24 -040044 OPENSSL_cleanse(&password.front(), password.size());
Davide Pesavento97ee8112020-08-11 21:38:34 -040045 });
Davide Pesaventob310efb2019-04-11 22:10:24 -040046
Junxiao Shibc2e78e2020-05-20 15:01:08 -060047 po::options_description visibleOptDesc(
48 "Usage: ndnsec export [-h] [-o FILE] [-P PASSPHRASE] [-i|-k|-c] NAME\n"
Davide Pesaventob310efb2019-04-11 22:10:24 -040049 "\n"
Davide Pesavento25d9c9f2024-06-23 15:10:05 -040050 "Export a private key and its certificate in SafeBag format.\n"
51 "\n"
Davide Pesaventob310efb2019-04-11 22:10:24 -040052 "Options");
Junxiao Shibc2e78e2020-05-20 15:01:08 -060053 visibleOptDesc.add_options()
Davide Pesaventob310efb2019-04-11 22:10:24 -040054 ("help,h", "produce help message")
Junxiao Shibc2e78e2020-05-20 15:01:08 -060055 ("identity,i", po::bool_switch(&isIdentityName),
56 "treat the NAME argument as an identity name (e.g., /ndn/edu/ucla/alice)")
57 ("key,k", po::bool_switch(&isKeyName),
58 "treat the NAME argument as a key name (e.g., /ndn/edu/ucla/alice/KEY/1%5D%A7g%90%B2%CF%AA)")
59 ("cert,c", po::bool_switch(&isCertName),
60 "treat the NAME argument as a certificate name "
61 "(e.g., /ndn/edu/ucla/alice/KEY/1%5D%A7g%90%B2%CF%AA/self/%FD%00%00%01r-%D3%DC%2A)")
Davide Pesaventob310efb2019-04-11 22:10:24 -040062 ("output,o", po::value<std::string>(&output)->default_value("-"),
63 "output file, '-' for stdout (the default)")
64 ("password,P", po::value<std::string>(&password),
65 "passphrase, will prompt if empty or not specified")
Yingdi Yu8d7468f2014-02-21 14:49:45 -080066 ;
67
Junxiao Shibc2e78e2020-05-20 15:01:08 -060068 po::options_description hiddenOptDesc;
69 hiddenOptDesc.add_options()
70 ("name", po::value<Name>(&name));
71
72 po::options_description optDesc;
73 optDesc.add(visibleOptDesc).add(hiddenOptDesc);
74
75 po::positional_options_description optPos;
76 optPos.add("name", 1);
Yingdi Yu8d7468f2014-02-21 14:49:45 -080077
78 po::variables_map vm;
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070079 try {
Junxiao Shibc2e78e2020-05-20 15:01:08 -060080 po::store(po::command_line_parser(argc, argv).options(optDesc).positional(optPos).run(), vm);
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070081 po::notify(vm);
82 }
83 catch (const std::exception& e) {
Davide Pesaventob310efb2019-04-11 22:10:24 -040084 std::cerr << "ERROR: " << e.what() << "\n\n"
Junxiao Shibc2e78e2020-05-20 15:01:08 -060085 << visibleOptDesc << std::endl;
Davide Pesaventob310efb2019-04-11 22:10:24 -040086 return 2;
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070087 }
Yingdi Yu8d7468f2014-02-21 14:49:45 -080088
Davide Pesaventob310efb2019-04-11 22:10:24 -040089 if (vm.count("help") > 0) {
Junxiao Shibc2e78e2020-05-20 15:01:08 -060090 std::cout << visibleOptDesc << std::endl;
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070091 return 0;
92 }
Yingdi Yu8d7468f2014-02-21 14:49:45 -080093
Junxiao Shibc2e78e2020-05-20 15:01:08 -060094 if (vm.count("name") == 0) {
95 std::cerr << "ERROR: you must specify a name" << std::endl;
Davide Pesaventob310efb2019-04-11 22:10:24 -040096 return 2;
Alexander Afanasyev2fa59392016-07-29 17:24:23 -070097 }
Yingdi Yu64c3fb42014-02-26 17:30:04 -080098
Junxiao Shibc2e78e2020-05-20 15:01:08 -060099 int nIsNameOptions = isIdentityName + isKeyName + isCertName;
100 if (nIsNameOptions > 1) {
101 std::cerr << "ERROR: at most one of '--identity', '--key', "
102 "or '--cert' may be specified" << std::endl;
103 return 2;
104 }
105 else if (nIsNameOptions == 0) {
106 isIdentityName = true;
107 }
Yingdi Yu8d7468f2014-02-21 14:49:45 -0800108
Davide Pesaventof2cae612021-03-24 18:47:05 -0400109 KeyChain keyChain;
110
Junxiao Shibc2e78e2020-05-20 15:01:08 -0600111 auto cert = getCertificateFromPib(keyChain.getPib(), name,
112 isIdentityName, isKeyName, isCertName);
Davide Pesaventob310efb2019-04-11 22:10:24 -0400113
114 if (password.empty()) {
115 int count = 3;
116 while (!getPassword(password, "Passphrase for the private key: ")) {
117 count--;
118 if (count <= 0) {
119 std::cerr << "ERROR: invalid password" << std::endl;
120 return 1;
Alexander Afanasyev35109a12017-01-04 15:39:06 -0800121 }
122 }
Alexander Afanasyev2fa59392016-07-29 17:24:23 -0700123 }
Davide Pesaventob310efb2019-04-11 22:10:24 -0400124
Junxiao Shibc2e78e2020-05-20 15:01:08 -0600125 auto safeBag = keyChain.exportSafeBag(cert, password.data(), password.size());
Davide Pesaventob310efb2019-04-11 22:10:24 -0400126
127 if (output == "-")
128 io::save(*safeBag, std::cout);
129 else
130 io::save(*safeBag, output);
131
132 return 0;
Yingdi Yu8d7468f2014-02-21 14:49:45 -0800133}
134
Davide Pesavento47ce2ee2023-05-09 01:33:33 -0400135} // namespace ndn::ndnsec