blob: c63fb3724010ab6722ca9bbfcfaebc9a7772e47f [file] [log] [blame]
Mickey Sweatt11314b72015-06-10 17:20:19 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2015 Regents of the University of California.
4 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library 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 Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#ifndef NDN_SECURITTY_PIB_SQLITE3_HPP
23#define NDN_SECURITTY_PIB_SQLITE3_HPP
24
25#include "pib-impl.hpp"
26
27struct sqlite3;
28
29namespace ndn {
30namespace security {
31
32/**
33 * @brief Pib backend implementation based on SQLite3 database
34 *
35 * All the contents in Pib are stored in a SQLite3 database file.
36 * This backend provides more persistent storage than PibMemory.
37 */
38class PibSqlite3 : public PibImpl
39{
40public:
41 /**
42 * @brief Constructor of PibSqlite3
43 *
44 * This method will create a SQLite3 database file under the directory @p dir.
45 * If the directory does not exist, it will be created automatically.
46 * It assumes that the directory does not contain a PIB database of an older version,
47 * It is user's responsibility to update the older version database or remove the database.
48 *
49 * @param dir The directory where the database file is located. By default, it points to the
50 * $HOME/.ndn directory.
51 * @throws PibImpl::Error when initialization fails.
52 */
53 explicit
54 PibSqlite3(const std::string& dir = "");
55
56 /**
57 * @brief Destruct and cleanup internal state
58 */
59 ~PibSqlite3();
60
61public: // TpmLocator management
62
Mickey Sweatt11314b72015-06-10 17:20:19 -070063 virtual void
64 setTpmLocator(const std::string& tpmLocator) NDN_CXX_DECL_FINAL;
65
Mickey Sweatt11314b72015-06-10 17:20:19 -070066 virtual std::string
67 getTpmLocator() const NDN_CXX_DECL_FINAL;
68
69public: // Identity management
70
Mickey Sweatt11314b72015-06-10 17:20:19 -070071 virtual bool
72 hasIdentity(const Name& identity) const NDN_CXX_DECL_FINAL;
73
Mickey Sweatt11314b72015-06-10 17:20:19 -070074 virtual void
75 addIdentity(const Name& identity) NDN_CXX_DECL_FINAL;
76
Mickey Sweatt11314b72015-06-10 17:20:19 -070077 virtual void
78 removeIdentity(const Name& identity) NDN_CXX_DECL_FINAL;
79
Mickey Sweatt11314b72015-06-10 17:20:19 -070080 virtual std::set<Name>
81 getIdentities() const NDN_CXX_DECL_FINAL;
82
Mickey Sweatt11314b72015-06-10 17:20:19 -070083 virtual void
84 setDefaultIdentity(const Name& identityName) NDN_CXX_DECL_FINAL;
85
Mickey Sweatt11314b72015-06-10 17:20:19 -070086 virtual Name
87 getDefaultIdentity() const NDN_CXX_DECL_FINAL;
88
89public: // Key management
90
Mickey Sweatt11314b72015-06-10 17:20:19 -070091 virtual bool
92 hasKey(const Name& identity, const name::Component& keyId) const NDN_CXX_DECL_FINAL;
93
Mickey Sweatt11314b72015-06-10 17:20:19 -070094 virtual void
95 addKey(const Name& identity, const name::Component& keyId, const PublicKey& publicKey) NDN_CXX_DECL_FINAL;
96
Mickey Sweatt11314b72015-06-10 17:20:19 -070097 virtual void
98 removeKey(const Name& identity, const name::Component& keyId) NDN_CXX_DECL_FINAL;
99
Mickey Sweatt11314b72015-06-10 17:20:19 -0700100 virtual PublicKey
101 getKeyBits(const Name& identity, const name::Component& keyId) const NDN_CXX_DECL_FINAL;
102
Mickey Sweatt11314b72015-06-10 17:20:19 -0700103 virtual std::set<name::Component>
104 getKeysOfIdentity(const Name& identity) const NDN_CXX_DECL_FINAL;
105
Mickey Sweatt11314b72015-06-10 17:20:19 -0700106 virtual void
107 setDefaultKeyOfIdentity(const Name& identity, const name::Component& keyId) NDN_CXX_DECL_FINAL;
108
Mickey Sweatt11314b72015-06-10 17:20:19 -0700109 virtual name::Component
110 getDefaultKeyOfIdentity(const Name& identity) const NDN_CXX_DECL_FINAL;
111
112public: // Certificate Management
113
Mickey Sweatt11314b72015-06-10 17:20:19 -0700114 virtual bool
115 hasCertificate(const Name& certName) const NDN_CXX_DECL_FINAL;
116
Mickey Sweatt11314b72015-06-10 17:20:19 -0700117 virtual void
118 addCertificate(const IdentityCertificate& certificate) NDN_CXX_DECL_FINAL;
119
Mickey Sweatt11314b72015-06-10 17:20:19 -0700120 virtual void
121 removeCertificate(const Name& certName) NDN_CXX_DECL_FINAL;
122
Mickey Sweatt11314b72015-06-10 17:20:19 -0700123 virtual IdentityCertificate
124 getCertificate(const Name& certName) const NDN_CXX_DECL_FINAL;
125
Mickey Sweatt11314b72015-06-10 17:20:19 -0700126 virtual std::set<Name>
127 getCertificatesOfKey(const Name& identity, const name::Component& keyId) const NDN_CXX_DECL_FINAL;
128
Mickey Sweatt11314b72015-06-10 17:20:19 -0700129 virtual void
130 setDefaultCertificateOfKey(const Name& identity, const name::Component& keyId,
131 const Name& certName) NDN_CXX_DECL_FINAL;
132
Mickey Sweatt11314b72015-06-10 17:20:19 -0700133 virtual IdentityCertificate
134 getDefaultCertificateOfKey(const Name& identity, const name::Component& keyId) const NDN_CXX_DECL_FINAL;
135
136private:
137 sqlite3* m_database;
138};
139
140} // namespace security
141} // namespace ndn
142
143#endif // NDN_SECURITTY_PIB_SQLITE3_HPP