blob: 502885e8e9a77b83fd4e8e5ef5ebe9f4beb541fd [file] [log] [blame]
Zhiyi Zhangdefa9592017-02-21 10:56:22 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Zhiyi Zhang74c61142020-10-07 21:00:49 -07003 * Copyright (c) 2017-2020, Regents of the University of California.
Zhiyi Zhangdefa9592017-02-21 10:56:22 -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-email.hpp"
Zhiyi Zhang523f0c22020-09-29 14:19:20 -070022#include <regex>
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080023
24namespace ndn {
25namespace ndncert {
26
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070027NDN_LOG_INIT(ndncert.challenge.email);
Zhiyi Zhang36706832019-07-04 21:33:03 -070028NDNCERT_REGISTER_CHALLENGE(ChallengeEmail, "email");
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080029
30const std::string ChallengeEmail::NEED_CODE = "need-code";
31const std::string ChallengeEmail::WRONG_CODE = "wrong-code";
Zhiyi Zhangead9f002020-10-03 15:42:52 -070032const std::string ChallengeEmail::INVALID_EMAIL = "invalid-email";
Zhiyi Zhang46049832020-09-28 17:08:12 -070033const std::string ChallengeEmail::PARAMETER_KEY_EMAIL = "email";
34const std::string ChallengeEmail::PARAMETER_KEY_CODE = "code";
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080035
36ChallengeEmail::ChallengeEmail(const std::string& scriptPath,
37 const size_t& maxAttemptTimes,
38 const time::seconds secretLifetime)
Zhiyi Zhangead9f002020-10-03 15:42:52 -070039 : ChallengeModule("email", maxAttemptTimes, secretLifetime)
Zhiyi Zhang46049832020-09-28 17:08:12 -070040 , m_sendEmailScript(scriptPath)
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080041{
42}
43
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070044// For CA
Zhiyi Zhangaafc55e2020-09-28 17:54:48 -070045std::tuple<ErrorCode, std::string>
Zhiyi Zhang32d4b4e2020-10-28 22:10:49 -070046ChallengeEmail::handleChallengeRequest(const Block& params, ca::RequestState& request)
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080047{
Suyong Won44d0cce2020-05-10 04:07:43 -070048 params.parse();
Zhiyi Zhang8da54d62019-11-21 00:03:05 -080049 auto currentTime = time::system_clock::now();
Zhiyi Zhang46049832020-09-28 17:08:12 -070050 if (request.m_status == Status::BEFORE_CHALLENGE) {
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070051 // for the first time, init the challenge
tylerliu50d679e2020-10-14 14:08:39 -070052 std::string emailAddress = readString(params.get(tlv::ParameterValue));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070053 if (!isValidEmailAddress(emailAddress)) {
Zhiyi Zhangead9f002020-10-03 15:42:52 -070054 return returnWithNewChallengeStatus(request, INVALID_EMAIL, JsonSection(), m_maxAttemptTimes - 1, m_secretLifetime);
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070055 }
Zhiyi Zhang46049832020-09-28 17:08:12 -070056 auto lastComponentRequested = readString(request.m_cert.getIdentity().get(-1));
57 if (lastComponentRequested != emailAddress) {
tylerliu6563f932020-10-30 11:13:38 -070058 NDN_LOG_TRACE("Email and requested name do not match. Email " << emailAddress << "requested last component "
59 << lastComponentRequested);
Zhiyi Zhang5f749a22019-06-12 17:02:33 -070060 }
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070061 std::string emailCode = generateSecretCode();
62 JsonSection secretJson;
Zhiyi Zhang46049832020-09-28 17:08:12 -070063 secretJson.add(PARAMETER_KEY_CODE, emailCode);
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -070064 // send out the email
65 sendEmail(emailAddress, emailCode, request);
Zhiyi Zhang8fdb36b2020-10-18 11:58:51 -070066 NDN_LOG_TRACE("Secret for request " << toHex(request.m_requestId.data(), request.m_requestId.size()) << " : " << emailCode);
Zhiyi Zhanga749f442020-09-29 17:19:51 -070067 return returnWithNewChallengeStatus(request, NEED_CODE, std::move(secretJson), m_maxAttemptTimes, m_secretLifetime);
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080068 }
Zhiyi Zhanga749f442020-09-29 17:19:51 -070069 if (request.m_challengeState) {
70 if (request.m_challengeState->m_challengeStatus == NEED_CODE ||
71 request.m_challengeState->m_challengeStatus == WRONG_CODE) {
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070072 NDN_LOG_TRACE("Challenge Interest arrives. Challenge Status: " << request.m_challengeState->m_challengeStatus);
Zhiyi Zhanga749f442020-09-29 17:19:51 -070073 // the incoming interest should bring the pin code
tylerliu50d679e2020-10-14 14:08:39 -070074 std::string givenCode = readString(params.get(tlv::ParameterValue));
Zhiyi Zhanga749f442020-09-29 17:19:51 -070075 auto secret = request.m_challengeState->m_secrets;
76 // check if run out of time
77 if (currentTime - request.m_challengeState->m_timestamp >= m_secretLifetime) {
78 return returnWithError(request, ErrorCode::OUT_OF_TIME, "Secret expired.");
79 }
80 // check if provided secret is correct
81 if (givenCode == secret.get<std::string>(PARAMETER_KEY_CODE)) {
82 // the code is correct
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070083 NDN_LOG_TRACE("Correct secret code. Challenge succeeded.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070084 return returnWithSuccess(request);
85 }
86 // otherwise, check remaining attempt times
87 if (request.m_challengeState->m_remainingTries > 1) {
88 auto remainTime = m_secretLifetime - (currentTime - request.m_challengeState->m_timestamp);
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070089 NDN_LOG_TRACE("Wrong secret code provided. Remaining Tries - 1.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070090 return returnWithNewChallengeStatus(request, WRONG_CODE, std::move(secret),
91 request.m_challengeState->m_remainingTries - 1,
92 time::duration_cast<time::seconds>(remainTime));
93 }
94 else {
95 // run out times
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -070096 NDN_LOG_TRACE("Wrong secret code provided. Ran out tires. Challenge failed.");
Zhiyi Zhanga749f442020-09-29 17:19:51 -070097 return returnWithError(request, ErrorCode::OUT_OF_TRIES, "Ran out tires.");
98 }
Zhiyi Zhangdefa9592017-02-21 10:56:22 -080099 }
100 }
Zhiyi Zhangaafc55e2020-09-28 17:54:48 -0700101 return returnWithError(request, ErrorCode::INVALID_PARAMETER, "Unexpected status or challenge status");
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700102}
103
104// For Client
Zhiyi Zhang46049832020-09-28 17:08:12 -0700105std::vector<std::tuple<std::string, std::string>>
106ChallengeEmail::getRequestedParameterList(Status status, const std::string& challengeStatus)
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700107{
Zhiyi Zhang46049832020-09-28 17:08:12 -0700108 std::vector<std::tuple<std::string, std::string>> result;
Zhiyi Zhang48f23782020-09-28 12:11:24 -0700109 if (status == Status::BEFORE_CHALLENGE && challengeStatus == "") {
Zhiyi Zhang46049832020-09-28 17:08:12 -0700110 result.push_back(std::make_tuple(PARAMETER_KEY_EMAIL, "Please input your email address"));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700111 }
Zhiyi Zhang48f23782020-09-28 12:11:24 -0700112 else if (status == Status::CHALLENGE && challengeStatus == NEED_CODE) {
Zhiyi Zhang46049832020-09-28 17:08:12 -0700113 result.push_back(std::make_tuple(PARAMETER_KEY_CODE, "Please input your verification code"));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700114 }
Zhiyi Zhang48f23782020-09-28 12:11:24 -0700115 else if (status == Status::CHALLENGE && challengeStatus == WRONG_CODE) {
Zhiyi Zhang46049832020-09-28 17:08:12 -0700116 result.push_back(std::make_tuple(PARAMETER_KEY_CODE, "Incorrect code, please try again"));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700117 }
118 else {
tylerliu41c11532020-10-10 16:14:45 -0700119 NDN_THROW(std::runtime_error("Unexpected status or challenge status."));
Zhiyi Zhangaf7c2902019-03-14 22:13:21 -0700120 }
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800121 return result;
122}
123
Suyong Won19fba4d2020-05-09 13:39:46 -0700124Block
Zhiyi Zhang46049832020-09-28 17:08:12 -0700125ChallengeEmail::genChallengeRequestTLV(Status status, const std::string& challengeStatus, std::vector<std::tuple<std::string, std::string>>&& params)
Suyong Won19fba4d2020-05-09 13:39:46 -0700126{
tylerliu50d679e2020-10-14 14:08:39 -0700127 Block request = makeEmptyBlock(tlv::EncryptedPayload);
Zhiyi Zhang46049832020-09-28 17:08:12 -0700128 if (status == Status::BEFORE_CHALLENGE) {
129 if (params.size() != 1 || std::get<0>(params[0]) != PARAMETER_KEY_EMAIL) {
tylerliu41c11532020-10-10 16:14:45 -0700130 NDN_THROW(std::runtime_error("Wrong parameter provided."));
Zhiyi Zhang46049832020-09-28 17:08:12 -0700131 }
tylerliu50d679e2020-10-14 14:08:39 -0700132 request.push_back(makeStringBlock(tlv::SelectedChallenge, CHALLENGE_TYPE));
133 request.push_back(makeStringBlock(tlv::ParameterKey, PARAMETER_KEY_EMAIL));
134 request.push_back(makeStringBlock(tlv::ParameterValue, std::get<1>(params[0])));
Suyong Won19fba4d2020-05-09 13:39:46 -0700135 }
Zhiyi Zhang46049832020-09-28 17:08:12 -0700136 else if (status == Status::CHALLENGE && (challengeStatus == NEED_CODE || challengeStatus == WRONG_CODE)) {
137 if (params.size() != 1 || std::get<0>(params[0]) != PARAMETER_KEY_CODE) {
tylerliu41c11532020-10-10 16:14:45 -0700138 NDN_THROW(std::runtime_error("Wrong parameter provided."));
Zhiyi Zhang46049832020-09-28 17:08:12 -0700139 }
tylerliu50d679e2020-10-14 14:08:39 -0700140 request.push_back(makeStringBlock(tlv::SelectedChallenge, CHALLENGE_TYPE));
141 request.push_back(makeStringBlock(tlv::ParameterKey, PARAMETER_KEY_CODE));
142 request.push_back(makeStringBlock(tlv::ParameterValue, std::get<1>(params[0])));
Suyong Won19fba4d2020-05-09 13:39:46 -0700143 }
144 else {
tylerliu41c11532020-10-10 16:14:45 -0700145 NDN_THROW(std::runtime_error("Unexpected status or challenge status."));
Suyong Won19fba4d2020-05-09 13:39:46 -0700146 }
Suyong Won44d0cce2020-05-10 04:07:43 -0700147 request.encode();
Suyong Won19fba4d2020-05-09 13:39:46 -0700148 return request;
149}
150
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800151bool
152ChallengeEmail::isValidEmailAddress(const std::string& emailAddress)
153{
Zhiyi Zhang8ce677b2018-07-13 14:44:06 -0700154 const std::string pattern = R"_REGEX_((^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9\-\.]+$))_REGEX_";
155 static const std::regex emailPattern(pattern);
156 return std::regex_match(emailAddress, emailPattern);
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800157}
158
159void
Zhiyi Zhang576aad12017-10-03 15:41:53 -0700160ChallengeEmail::sendEmail(const std::string& emailAddress, const std::string& secret,
Zhiyi Zhang32d4b4e2020-10-28 22:10:49 -0700161 const ca::RequestState& request) const
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800162{
Zhiyi Zhang576aad12017-10-03 15:41:53 -0700163 std::string command = m_sendEmailScript;
Zhiyi Zhang46049832020-09-28 17:08:12 -0700164 command += " \"" + emailAddress + "\" \"" + secret + "\" \"" + request.m_caPrefix.toUri() + "\" \"" + request.m_cert.getName().toUri() + "\"";
Zhiyi Zhang576aad12017-10-03 15:41:53 -0700165 int result = system(command.c_str());
166 if (result == -1) {
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -0700167 NDN_LOG_TRACE("EmailSending Script " + m_sendEmailScript + " fails.");
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800168 }
Zhiyi Zhangd61b4a82020-10-10 15:18:43 -0700169 NDN_LOG_TRACE("EmailSending Script " + m_sendEmailScript +
Zhiyi Zhang576aad12017-10-03 15:41:53 -0700170 " was executed successfully with return value" + std::to_string(result) + ".");
Zhiyi Zhangdefa9592017-02-21 10:56:22 -0800171 return;
172}
173
Zhiyi Zhange4891b72020-10-10 15:11:57 -0700174} // namespace ndncert
175} // namespace ndn