aboutsummaryrefslogtreecommitdiffstats
path: root/src/cert/cvc/cvc_key.h
diff options
context:
space:
mode:
authorlloyd <[email protected]>2008-10-13 18:48:43 +0000
committerlloyd <[email protected]>2008-10-13 18:48:43 +0000
commit15f33368219371fc3430d77bd3a58ac83ab79ce2 (patch)
tree46084cefc403cabb301f2d39da8af355a8d11cf4 /src/cert/cvc/cvc_key.h
parent756299fa8784e6bf4d2218603b2e2bcb18827f37 (diff)
More Doxygen comments
Diffstat (limited to 'src/cert/cvc/cvc_key.h')
-rw-r--r--src/cert/cvc/cvc_key.h51
1 files changed, 33 insertions, 18 deletions
diff --git a/src/cert/cvc/cvc_key.h b/src/cert/cvc/cvc_key.h
index 1867f04f4..e24c42e41 100644
--- a/src/cert/cvc/cvc_key.h
+++ b/src/cert/cvc/cvc_key.h
@@ -14,24 +14,39 @@
namespace Botan {
-/*************************************************
- * EAC CVC Public Key Encoder *
-*************************************************/
- class EAC1_1_CVC_Encoder
- {
- public:
- virtual MemoryVector<byte> public_key(AlgorithmIdentifier const&) const = 0;
- virtual ~EAC1_1_CVC_Encoder() {}
- };
+/**
+* This class represents EAC 1.1 CVC public key encoders.
+*/
+class BOTAN_DLL EAC1_1_CVC_Encoder
+ {
+ public:
+ /**
+ * Get the DER encoded CVC public key.
+ * @param alg_id the algorithm identifier to use in the encoding
+ * @return the DER encoded public key
+ */
+ virtual MemoryVector<byte>
+ public_key(const AlgorithmIdentifier& enc) const = 0;
-/*************************************************
- * EAC CVC Public Key Decoder *
-*************************************************/
- class EAC1_1_CVC_Decoder
- {
- public:
- virtual AlgorithmIdentifier const public_key(const MemoryRegion<byte>&) = 0;
- virtual ~EAC1_1_CVC_Decoder() {}
- };
+ virtual ~EAC1_1_CVC_Encoder() {}
+ };
+
+/**
+* This class represents EAC 1.1 CVC public key decoders.
+*/
+class BOTAN_DLL EAC1_1_CVC_Decoder
+ {
+ public:
+ /**
+ * Decode a CVC public key.
+ * @param enc the DER encoded public key to decode
+ * @return the algorithm identifier found in the encoded public key
+ */
+ virtual AlgorithmIdentifier const
+ public_key(const MemoryRegion<byte>& enc) = 0;
+
+ virtual ~EAC1_1_CVC_Decoder() {}
+ };
}
+
#endif