aboutsummaryrefslogtreecommitdiff
path: root/cc/keyset_reader.h
diff options
context:
space:
mode:
authorBartosz Przydatek <przydatek@google.com>2018-06-01 01:23:07 -0700
committerTink Team <noreply@google.com>2018-06-06 10:24:39 -0700
commit85ca63f84e539ec80723b88bd4ac9a54b4bc28e6 (patch)
treeffe31db9ee268713e062cc994b09aadc36e3fcfc /cc/keyset_reader.h
parentd0b23679e3bc8e857f7bcda846bf7de617e19830 (diff)
downloadtink-85ca63f84e539ec80723b88bd4ac9a54b4bc28e6.tar.gz
Minor fixes to C++ documentation.
PiperOrigin-RevId: 198841818 GitOrigin-RevId: 9d6b3859e704b9b781b6312f30c900e8c98ffcda
Diffstat (limited to 'cc/keyset_reader.h')
-rw-r--r--cc/keyset_reader.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/cc/keyset_reader.h b/cc/keyset_reader.h
index 795d0e3bf..037697bb5 100644
--- a/cc/keyset_reader.h
+++ b/cc/keyset_reader.h
@@ -23,13 +23,16 @@
namespace crypto {
namespace tink {
-// KeysetReader
+// KeysetReader knows how to read a Keyset or an EncryptedKeyset
+// from some source.
class KeysetReader {
public:
+ // Reads and returns a (cleartext) Keyset object from the underlying source.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<google::crypto::tink::Keyset>>
Read() = 0;
+ // Reads and returns an EncryptedKeyset object from the underlying source.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<google::crypto::tink::EncryptedKeyset>>
ReadEncrypted() = 0;