blob: 2a2a9ff533c04e07d4a3e9cbad146868c500409d [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/*
3 * Copyright (c) 2017-2021, 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
24#include "detail/ca-profile.hpp"
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080025#include "name-assignment/assignment-func.hpp"
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080026
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080027namespace ndncert {
28namespace ca {
29
30/**
31 * @brief CA's configuration on NDNCERT.
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080032 *
33 * The format of CA configuration in JSON
34 * {
35 * "ca-prefix": "",
36 * "ca-info": "",
37 * "max-validity-period": "",
38 * "max-suffix-length": "",
39 * "probe-parameters":
40 * [
41 * {"probe-parameter-key": ""},
42 * {"probe-parameter-key": ""}
43 * ]
44 * "supported-challenges":
45 * [
46 * {"challenge": ""},
47 * {"challenge": ""}
48 * ]
49 * }
50 */
51class CaConfig
52{
53public:
54 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080055 * @brief Load CA configuration from the file.
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080056 * @throw std::runtime_error when config file cannot be correctly parsed.
57 */
58 void
59 load(const std::string& fileName);
60
61public:
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080062 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080063 * @brief the CA's profile
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080064 */
tylerliuf2e6bb52020-12-13 13:23:05 -080065 CaProfile caProfile;
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080066 /**
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080067 * @brief Used for CA redirection
68 */
Davide Pesavento0dc02012021-11-23 22:55:03 -050069 std::vector<std::shared_ptr<Certificate>> redirection;
Zhiyi Zhang1e418f22020-11-19 19:49:32 -080070 /**
71 * @brief Name Assignment Functions
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080072 */
tylerliuf2e6bb52020-12-13 13:23:05 -080073 std::vector<std::unique_ptr<NameAssignmentFunc>> nameAssignmentFuncs;
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080074};
75
76} // namespace ca
77} // namespace ndncert
Zhiyi Zhang3f20f952020-11-19 19:26:43 -080078
79#endif // NDNCERT_DETAIL_CA_CONFIGURATION_HPP