blob: 0a02777c09cf5b846223620569d8005944d12b48 [file] [log] [blame]
Zhiyi Zhang3f20f952020-11-19 19:26:43 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento0dc02012021-11-23 22:55:03 -05002/*
Tianyuan Yu13aac732022-03-03 20:59:54 -08003 * Copyright (c) 2017-2022, Regents of the University of California.
Zhiyi Zhang3f20f952020-11-19 19:26:43 -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#ifndef NDNCERT_DETAIL_CA_CONFIGURATION_HPP
22#define NDNCERT_DETAIL_CA_CONFIGURATION_HPP
23
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080024#include "name-assignment/assignment-func.hpp"
Tianyuan Yu13aac732022-03-03 20:59:54 -080025#include "redirection/redirection-policy.hpp"
26#include "ca-profile.hpp"
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080027
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080028namespace ndncert {
29namespace ca {
30
31/**
32 * @brief CA's configuration on NDNCERT.
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080033 *
34 * The format of CA configuration in JSON
35 * {
36 * "ca-prefix": "",
37 * "ca-info": "",
38 * "max-validity-period": "",
39 * "max-suffix-length": "",
40 * "probe-parameters":
41 * [
42 * {"probe-parameter-key": ""},
43 * {"probe-parameter-key": ""}
44 * ]
45 * "supported-challenges":
46 * [
47 * {"challenge": ""},
48 * {"challenge": ""}
49 * ]
50 * }
51 */
52class CaConfig
53{
54public:
55 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080056 * @brief Load CA configuration from the file.
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080057 * @throw std::runtime_error when config file cannot be correctly parsed.
58 */
59 void
60 load(const std::string& fileName);
61
62public:
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080063 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080064 * @brief the CA's profile
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080065 */
tylerliuf2e6bb52020-12-13 13:23:05 -080066 CaProfile caProfile;
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080067 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080068 * @brief Used for CA redirection
69 */
Tianyuan Yu13aac732022-03-03 20:59:54 -080070 std::vector<std::pair<std::shared_ptr<Certificate>, std::unique_ptr<RedirectionPolicy>>> redirection;
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080071 /**
72 * @brief Name Assignment Functions
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080073 */
tylerliuf2e6bb52020-12-13 13:23:05 -080074 std::vector<std::unique_ptr<NameAssignmentFunc>> nameAssignmentFuncs;
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080075};
76
77} // namespace ca
78} // namespace ndncert
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080079
80#endif // NDNCERT_DETAIL_CA_CONFIGURATION_HPP