libDwmAuth-0.3.6
DwmAuthPublicKeysFile.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $Name:$
3 // @(#) $Id: DwmAuthPublicKeysFile.hh 10617 2020-05-02 21:18:04Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2017, 2018, 2020
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
33 // OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMAUTHPUBLICKEYSFILE_HH_
43 #define _DWMAUTHPUBLICKEYSFILE_HH_
44 
45 #include <map>
46 #include <string>
47 
48 #include "DwmAuthEd25519Keys.hh"
49 
50 namespace Dwm {
51 
52  namespace Auth {
53 
54  //------------------------------------------------------------------------
57  //------------------------------------------------------------------------
59  {
60  public:
61  typedef std::map<std::string,Ed25519::PublicKey> Map;
62 
63  //----------------------------------------------------------------------
65  //----------------------------------------------------------------------
67 
68  //----------------------------------------------------------------------
70  //----------------------------------------------------------------------
71  PublicKeysFile(const PublicKeysFile & pkf) = default;
72 
73  //----------------------------------------------------------------------
76  //----------------------------------------------------------------------
77  bool Load(const std::string & fileName);
78 
79  //----------------------------------------------------------------------
83  //----------------------------------------------------------------------
84  bool AddKey(const std::string & name, const Ed25519::PublicKey & key);
85 
86  //----------------------------------------------------------------------
88  //----------------------------------------------------------------------
89  bool AddKey(const std::string & name, const std::string & base64str);
90 
91  //----------------------------------------------------------------------
95  //----------------------------------------------------------------------
96  bool RemoveKey(const std::string & name);
97 
98  //----------------------------------------------------------------------
102  //----------------------------------------------------------------------
103  bool Save(const std::string & fileName, int perms = 0644) const;
104 
105  //----------------------------------------------------------------------
108  //----------------------------------------------------------------------
109  bool Find(const std::string & name,
110  Ed25519::PublicKey & key) const;
111 
112  //----------------------------------------------------------------------
114  //----------------------------------------------------------------------
115  const Map & Keys() const;
116 
117  private:
118  std::map<std::string,Ed25519::PublicKey> _keys;
119  };
120 
121  } // namespace Auth
122 
123 } // namespace Dwm
124 
125 #endif // _DWMAUTHPUBLICKEYSFILE_HH_
const Map & Keys() const
Returns a const reference to the contained public keys.
NOT YET DOCUMENTED.
PublicKeysFile()
Constructor.
bool RemoveKey(const std::string &name)
Removes the key with the given name from the contained map of keys.
bool Save(const std::string &fileName, int perms=0644) const
Saves the contained map of keys to the file with the given fileName with permissions @perms.
bool AddKey(const std::string &name, const Ed25519::PublicKey &key)
Adds a key with the given name to the contained map of keys.
Encapsulates a file containing public keys in a format similar to (but not the same as) an ssh author...
Definition: DwmAuthPublicKeysFile.hh:58
bool Find(const std::string &name, Ed25519::PublicKey &key) const
Searches the keys for the one with the given name.
bool Load(const std::string &fileName)
Loads the public keys from the file at the given path fileName.