blob: 46f65fd2e3b9cc04c131c3b68ce40c8fb37b0874 [file] [log] [blame]
Zhiyi Zhang65ba9322017-01-19 14:15:03 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento0dc02012021-11-23 22:55:03 -05002/*
Davide Pesavento6f1a2ab2022-03-17 03:57:21 -04003 * Copyright (c) 2017-2022, Regents of the University of California.
Zhiyi Zhang65ba9322017-01-19 14:15:03 -08004 *
5 * This file is part of ndncert, a certificate management system based on NDN.
6 *
7 * ndncert is free software: you can redistribute it and/or modify it under the terms
8 * of the GNU General Public License as published by the Free Software Foundation, either
9 * version 3 of the License, or (at your option) any later version.
10 *
11 * ndncert 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 General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License along with
16 * ndncert, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
17 *
18 * See AUTHORS.md for complete list of ndncert authors and contributors.
19 */
20
21#include "challenge-pin.hpp"
Davide Pesavento0dc02012021-11-23 22:55:03 -050022
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080023#include <ndn-cxx/util/random.hpp>
24
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080025namespace ndncert {
26
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070027NDN_LOG_INIT(ndncert.challenge.pin);
Zhiyi Zhang36706832019-07-04 21:33:03 -070028NDNCERT_REGISTER_CHALLENGE(ChallengePin, "pin");
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080029
30const std::string ChallengePin::NEED_CODE = "need-code";
31const std::string ChallengePin::WRONG_CODE = "wrong-code";
Zhiyi Zhangead9f002020-10-03 15:42:52 -070032const std::string ChallengePin::PARAMETER_KEY_CODE = "code";
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080033
34ChallengePin::ChallengePin(const size_t& maxAttemptTimes, const time::seconds& secretLifetime)
Davide Pesavento0dc02012021-11-23 22:55:03 -050035 : ChallengeModule("pin", maxAttemptTimes, secretLifetime)
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080036{
37}
38
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070039// For CA
Zhiyi Zhangaafc55e2020-09-28 17:54:48 -070040std::tuple<ErrorCode, std::string>
Zhiyi Zhang32d4b4e2020-10-28 22:10:49 -070041ChallengePin::handleChallengeRequest(const Block& params, ca::RequestState& request)
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080042{
Suyong Won44d0cce2020-05-10 04:07:43 -070043 params.parse();
Zhiyi Zhang8da54d62019-11-21 00:03:05 -080044 auto currentTime = time::system_clock::now();
tylerliu7b9185c2020-11-24 12:15:18 -080045 if (request.status == Status::BEFORE_CHALLENGE) {
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070046 NDN_LOG_TRACE("Challenge Interest arrives. Init the challenge");
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070047 // for the first time, init the challenge
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070048 std::string secretCode = generateSecretCode();
49 JsonSection secretJson;
Zhiyi Zhang46049832020-09-28 17:08:12 -070050 secretJson.add(PARAMETER_KEY_CODE, secretCode);
Davide Pesavento6f1a2ab2022-03-17 03:57:21 -040051 NDN_LOG_TRACE("Secret for request " << ndn::toHex(request.requestId)
Davide Pesavento0dc02012021-11-23 22:55:03 -050052 << " : " << secretCode);
53 return returnWithNewChallengeStatus(request, NEED_CODE, std::move(secretJson), m_maxAttemptTimes,
54 m_secretLifetime);
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080055 }
tylerliu7b9185c2020-11-24 12:15:18 -080056 if (request.challengeState) {
57 if (request.challengeState->challengeStatus == NEED_CODE ||
58 request.challengeState->challengeStatus == WRONG_CODE) {
59 NDN_LOG_TRACE("Challenge Interest arrives. Challenge Status: " << request.challengeState->challengeStatus);
Zhiyi Zhanga749f442020-09-29 17:19:51 -070060 // the incoming interest should bring the pin code
tylerliu50d679e2020-10-14 14:08:39 -070061 std::string givenCode = readString(params.get(tlv::ParameterValue));
tylerliu7b9185c2020-11-24 12:15:18 -080062 auto secret = request.challengeState->secrets;
63 if (currentTime - request.challengeState->timestamp >= m_secretLifetime) {
Zhiyi Zhanga749f442020-09-29 17:19:51 -070064 return returnWithError(request, ErrorCode::OUT_OF_TIME, "Secret expired.");
65 }
66 if (givenCode == secret.get<std::string>(PARAMETER_KEY_CODE)) {
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070067 NDN_LOG_TRACE("Correct PIN code. Challenge succeeded.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070068 return returnWithSuccess(request);
69 }
70 // check rest attempt times
tylerliu7b9185c2020-11-24 12:15:18 -080071 if (request.challengeState->remainingTries > 1) {
72 auto remainTime = m_secretLifetime - (currentTime - request.challengeState->timestamp);
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070073 NDN_LOG_TRACE("Wrong PIN code provided. Remaining Tries - 1.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070074 return returnWithNewChallengeStatus(request, WRONG_CODE, std::move(secret),
tylerliu7b9185c2020-11-24 12:15:18 -080075 request.challengeState->remainingTries - 1,
Zhiyi Zhanga749f442020-09-29 17:19:51 -070076 time::duration_cast<time::seconds>(remainTime));
77 }
78 else {
79 // run out times
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070080 NDN_LOG_TRACE("Wrong PIN code provided. Ran out tires. Challenge failed.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070081 return returnWithError(request, ErrorCode::OUT_OF_TRIES, "Ran out tires.");
82 }
Zhiyi Zhang65ba9322017-01-19 14:15:03 -080083 }
84 }
Zhiyi Zhangaafc55e2020-09-28 17:54:48 -070085 return returnWithError(request, ErrorCode::INVALID_PARAMETER, "Unexpected status or challenge status");
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070086}
87
88// For Client
tylerliu40226332020-11-11 15:37:16 -080089std::multimap<std::string, std::string>
Zhiyi Zhang46049832020-09-28 17:08:12 -070090ChallengePin::getRequestedParameterList(Status status, const std::string& challengeStatus)
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070091{
tylerliu40226332020-11-11 15:37:16 -080092 std::multimap<std::string, std::string> result;
Zhiyi Zhang46049832020-09-28 17:08:12 -070093 if (status == Status::BEFORE_CHALLENGE) {
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070094 // do nothing
95 }
Zhiyi Zhang48f23782020-09-28 12:11:24 -070096 else if (status == Status::CHALLENGE && challengeStatus == NEED_CODE) {
tylerliu40226332020-11-11 15:37:16 -080097 result.emplace(PARAMETER_KEY_CODE, "Please input your PIN code");
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070098 }
Zhiyi Zhang48f23782020-09-28 12:11:24 -070099 else if (status == Status::CHALLENGE && challengeStatus == WRONG_CODE) {
tylerliu40226332020-11-11 15:37:16 -0800100 result.emplace(PARAMETER_KEY_CODE, "Incorrect PIN code, please try again");
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700101 }
102 else {
tylerliu41c11532020-10-10 16:14:45 -0700103 NDN_THROW(std::runtime_error("Unexpected status or challenge status."));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700104 }
Zhiyi Zhangf72c0542017-03-16 14:45:30 -0700105 return result;
106}
107
Suyong Won19fba4d2020-05-09 13:39:46 -0700108Block
tylerliu6563f932020-10-30 11:13:38 -0700109ChallengePin::genChallengeRequestTLV(Status status, const std::string& challengeStatus,
tylerliuf2e6bb52020-12-13 13:23:05 -0800110 const std::multimap<std::string, std::string>& params)
Suyong Won19fba4d2020-05-09 13:39:46 -0700111{
tylerliu1f480be2020-11-10 13:02:53 -0800112 Block request(tlv::EncryptedPayload);
Zhiyi Zhang46049832020-09-28 17:08:12 -0700113 if (status == Status::BEFORE_CHALLENGE) {
Davide Pesavento0dc02012021-11-23 22:55:03 -0500114 request.push_back(ndn::makeStringBlock(tlv::SelectedChallenge, CHALLENGE_TYPE));
Suyong Won19fba4d2020-05-09 13:39:46 -0700115 }
Zhiyi Zhang46049832020-09-28 17:08:12 -0700116 else if (status == Status::CHALLENGE && (challengeStatus == NEED_CODE || challengeStatus == WRONG_CODE)) {
tylerliu40226332020-11-11 15:37:16 -0800117 if (params.size() != 1 || params.find(PARAMETER_KEY_CODE) == params.end()) {
tylerliu41c11532020-10-10 16:14:45 -0700118 NDN_THROW(std::runtime_error("Wrong parameter provided."));
Zhiyi Zhang46049832020-09-28 17:08:12 -0700119 }
Davide Pesavento0dc02012021-11-23 22:55:03 -0500120 request.push_back(ndn::makeStringBlock(tlv::SelectedChallenge, CHALLENGE_TYPE));
121 request.push_back(ndn::makeStringBlock(tlv::ParameterKey, PARAMETER_KEY_CODE));
122 request.push_back(ndn::makeStringBlock(tlv::ParameterValue, params.find(PARAMETER_KEY_CODE)->second));
Suyong Won19fba4d2020-05-09 13:39:46 -0700123 }
124 else {
tylerliu41c11532020-10-10 16:14:45 -0700125 NDN_THROW(std::runtime_error("Unexpected status or challenge status."));
Suyong Won19fba4d2020-05-09 13:39:46 -0700126 }
Suyong Won44d0cce2020-05-10 04:07:43 -0700127 request.encode();
Suyong Won19fba4d2020-05-09 13:39:46 -0700128 return request;
129}
Davide Pesavento0dc02012021-11-23 22:55:03 -0500130
Zhiyi Zhange4891b72020-10-10 15:11:57 -0700131} // namespace ndncert