blob: 97c282bc1bd8219db81b10dad5b4669916f061c1 [file] [log] [blame]
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2017, Regents of the University of California.
4 *
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_CLIENT_CONFIG_HPP
22#define NDNCERT_CLIENT_CONFIG_HPP
23
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080024#include "certificate-request.hpp"
25#include <ndn-cxx/security/v2/certificate.hpp>
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -080026
27namespace ndn {
28namespace ndncert {
29
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080030/**
31 * @brief The configuration for a trusted CA from a requester's perspective
32 */
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080033class ClientCaItem
34{
35public:
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080036 // The identity name of the CA. Extracted from config field "ca-prefix"
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080037 Name m_caName;
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080038
39 // TODO: remove the caInfo, probe, and targetedList. Put them into the cert
40 // A brief introduction to the CA. Extracted from config field "ca-info"
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080041 std::string m_caInfo;
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080042 // An instruction for requesters to use _PROBE. Extracted from config field "probe"
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080043 std::string m_probe;
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080044 // An instruction for requesters to get a recommended CA. Extracted from config field "target-list"
45 std::string m_targetedList;
46
47 // CA's certificate
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080048 security::v2::Certificate m_anchor;
49};
50
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080051/**
52 * @brief Represents Client configuration
53 *
54 * For Client configuration format, please refer to:
55 * https://github.com/named-data/ndncert/wiki/Client-Configuration-Sample
56 */
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -080057class ClientConfig
58{
59public:
60 class Error : public std::runtime_error
61 {
62 public:
63 using std::runtime_error::runtime_error;
64 };
65
66public:
67 void
68 load(const std::string& fileName);
69
70 void
Zhiyi Zhange4ee8222017-12-08 22:43:04 -080071 load(const JsonSection& configSection);
72
73 void
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080074 addNewCaItem(const ClientCaItem& item);
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -080075
76 void
77 removeCaItem(const Name& caName);
78
Zhiyi Zhang1c0bd372017-12-18 18:32:55 +080079 static ClientCaItem
80 extractCaItem(const JsonSection& configSection);
81
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -080082public:
Zhiyi Zhang5ebeb692017-03-10 14:13:01 -080083 std::list<ClientCaItem> m_caItems;
Zhiyi Zhang1c0bd372017-12-18 18:32:55 +080084 std::string m_localNdncertAnchor;
Zhiyi Zhang32dbb9f2017-02-16 15:15:10 -080085};
86
87} // namespace ndncert
88} // namespace ndn
89
90#endif // NDNCERT_CLIENT_CONFIG_HPP