libDwmCredence-0.1.32
DwmCredenceKeyStash.hh
Go to the documentation of this file.
1//===========================================================================
2// @(#) $DwmPath$
3//===========================================================================
4// Copyright (c) Daniel W. McRobb 2022
5// All rights reserved.
6//
7// Redistribution and use in source and binary forms, with or without
8// modification, are permitted provided that the following conditions
9// are met:
10//
11// 1. Redistributions of source code must retain the above copyright
12// notice, this list of conditions and the following disclaimer.
13// 2. Redistributions in binary form must reproduce the above copyright
14// notice, this list of conditions and the following disclaimer in the
15// documentation and/or other materials provided with the distribution.
16// 3. The names of the authors and copyright holders may not be used to
17// endorse or promote products derived from this software without
18// specific prior written permission.
19//
20// IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
21// DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
22// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
23// EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
24// DAMAGE.
25//
26// THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
27// DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
28// UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
29// REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
30// IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
31// WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
32// OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
33// TRADEMARK OR OTHER RIGHTS.
34//===========================================================================
35
36//---------------------------------------------------------------------------
40//---------------------------------------------------------------------------
41
42#ifndef _DWMCREDENCEKEYSTASH_HH_
43#define _DWMCREDENCEKEYSTASH_HH_
44
46
47namespace Dwm {
48
49 namespace Credence {
50
51 //------------------------------------------------------------------------
54 //------------------------------------------------------------------------
56 {
57 public:
58 //----------------------------------------------------------------------
61 //----------------------------------------------------------------------
62 KeyStash(const std::string & dirName = "~/.credence");
63
64 //----------------------------------------------------------------------
66 //----------------------------------------------------------------------
67 const std::string & DirName() const;
68
69 //----------------------------------------------------------------------
72 //----------------------------------------------------------------------
73 bool Save(const Ed25519KeyPair & edkp) const;
74
75 //----------------------------------------------------------------------
78 //----------------------------------------------------------------------
79 bool Get(Ed25519KeyPair & edkp) const;
80
81 //----------------------------------------------------------------------
86 //----------------------------------------------------------------------
87 bool IsValid() const;
88
89 private:
90 std::string _dirName;
91
92 bool SavePublicKey(const Ed25519KeyPair & edkp) const;
93 bool SaveSecretKey(const Ed25519KeyPair & edkp) const;
94 bool GetPublicKey(Ed25519KeyPair & edkp) const;
95 bool GetSecretKey(Ed25519KeyPair & edkp) const;
96 bool MakeStashDir() const;
97 };
98
99 } // namespace Credence
100
101} // namespace Dwm
102
103#endif // _DWMCREDENCEKEYSTASH_HH_
Dwm::Credence::Ed25519KeyPair class declaration.
Encapsulates an Ed25519 key pair.
Definition DwmCredenceEd25519KeyPair.hh:64
Encapsulates storage of an Ed25519KeyPair in a filesystem.
Definition DwmCredenceKeyStash.hh:56
bool Get(Ed25519KeyPair &edkp) const
Fetches the keypair from the key stash and stores it in edkp.
bool Save(const Ed25519KeyPair &edkp) const
Saves the given keypair.
const std::string & DirName() const
Returns the directory where the keys are stored.
KeyStash(const std::string &dirName="~/.credence")
Construct from the given dirName, which is the directory where the keys will be stored.
bool IsValid() const
Returns true if the key stash is valid, i.e.