aboutsummaryrefslogtreecommitdiffstats
path: root/src/cert/x509/x509_obj.h
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-21 21:48:31 +0000
committerlloyd <[email protected]>2010-06-21 21:48:31 +0000
commit851b9bb998632713d68ea0639394f7e84b48f0e3 (patch)
tree1329c5452b23d7330d8f1c4c7465b0f31ac4823a /src/cert/x509/x509_obj.h
parent6d9ea2cb9a2e7f4fdbb7de0e19446cdd5264be3d (diff)
Doxygen
Diffstat (limited to 'src/cert/x509/x509_obj.h')
-rw-r--r--src/cert/x509/x509_obj.h36
1 files changed, 34 insertions, 2 deletions
diff --git a/src/cert/x509/x509_obj.h b/src/cert/x509/x509_obj.h
index 52b76d218..28ee95073 100644
--- a/src/cert/x509/x509_obj.h
+++ b/src/cert/x509/x509_obj.h
@@ -23,8 +23,21 @@ namespace Botan {
class BOTAN_DLL X509_Object
{
public:
+
+ /**
+ * The underlying data that is to be or was signed
+ * @return data that is or was signed
+ */
SecureVector<byte> tbs_data() const;
+
+ /**
+ * @return signature on tbs_data()
+ */
SecureVector<byte> signature() const;
+
+ /**
+ * @return signature algorithm that was used to generate signature
+ */
AlgorithmIdentifier signature_algorithm() const;
/**
@@ -40,10 +53,29 @@ class BOTAN_DLL X509_Object
const AlgorithmIdentifier& alg_id,
const MemoryRegion<byte>& tbs);
- bool check_signature(class Public_Key&) const;
+ /**
+ * Check the signature on this data
+ * @param key the public key purportedly used to sign this data
+ * @return true if the signature is valid, otherwise false
+ */
+ bool check_signature(class Public_Key& key) const;
- void encode(Pipe&, X509_Encoding = PEM) const;
+ /**
+ * Encode this to a pipe
+ * @deprecated use BER_encode or PEM_encode instead
+ * @param out the pipe to write to
+ * @param encoding the encoding to use
+ */
+ void encode(Pipe& out, X509_Encoding encoding = PEM) const;
+
+ /**
+ * @return BER encoding of this
+ */
SecureVector<byte> BER_encode() const;
+
+ /**
+ * @return PEM encoding of this
+ */
std::string PEM_encode() const;
X509_Object(DataSource&, const std::string&);