aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlloyd <lloyd@randombit.net>2008-10-13 20:24:23 +0000
committerlloyd <lloyd@randombit.net>2008-10-13 20:24:23 +0000
commit52c675d7caa8ba0cb4aa85510a1b1bf48984a250 (patch)
treeef471fe7611b898b98a27771e56fbbd3aa68d1e7
parent9a669d9c4de4122d459d9785ae8645bdaf6bade2 (diff)
Add some Doxygen comments from InSiTo written for config.h (now gone/split up)
-rw-r--r--src/cert/x509/x509_ca.h14
-rw-r--r--src/core/libstate/libstate.h68
2 files changed, 69 insertions, 13 deletions
diff --git a/src/cert/x509/x509_ca.h b/src/cert/x509/x509_ca.h
index 9f7cb9515..1aba381bc 100644
--- a/src/cert/x509/x509_ca.h
+++ b/src/cert/x509/x509_ca.h
@@ -90,11 +90,15 @@ class BOTAN_DLL X509_CA
PK_Signer* signer;
};
-/*************************************************
-* Choose a signing format for the key *
-*************************************************/
-BOTAN_DLL PK_Signer* choose_sig_format(const Private_Key&,
- AlgorithmIdentifier&);
+/**
+* Choose the default signature format for a certain public key signature
+* scheme.
+* @param key will be the key to choose a padding scheme for
+* @param alg_id will be set to the chosen scheme
+* @returns A PK_Signer object for generating signatures
+*/
+BOTAN_DLL PK_Signer* choose_sig_format(const Private_Key& key,
+ AlgorithmIdentifier& alg_id);
}
diff --git a/src/core/libstate/libstate.h b/src/core/libstate/libstate.h
index 4b1221c84..74d3d8ef3 100644
--- a/src/core/libstate/libstate.h
+++ b/src/core/libstate/libstate.h
@@ -44,15 +44,67 @@ class BOTAN_DLL Library_State
void add_allocator(Allocator*);
void set_default_allocator(const std::string&);
- std::string get(const std::string&, const std::string&) const;
- bool is_set(const std::string&, const std::string&) const;
- void set(const std::string&, const std::string&,
- const std::string&, bool = true);
-
- std::string option(const std::string&) const;
- void set_option(const std::string, const std::string&);
-
+ /**
+ * Get a parameter value as std::string.
+ * @param section the section of the desired key
+ * @param key the desired keys name
+ * @result the value of the parameter
+ */
+ std::string get(const std::string& section,
+ const std::string& key) const;
+
+ /**
+ * Check whether a certain parameter is set
+ * or not.
+ * @param section the section of the desired key
+ * @param key the desired keys name
+ * @result true if the parameters value is set,
+ * false otherwise
+ */
+ bool is_set(const std::string& section, const std::string& key) const;
+
+ /**
+ * Set a configuration parameter.
+ * @param section the section of the desired key
+ * @param key the desired keys name
+ * @param overwrite if set to true, the parameters value
+ * will be overwritten even if it is already set, otherwise
+ * no existing values will be overwritten.
+ */
+ void set(const std::string& section, const std::string& key,
+ const std::string& value, bool overwrite = true);
+
+ /**
+ * Get a parameters value out of the "conf" section (
+ * referred to as option).
+ * @param key the desired keys name
+ */
+ std::string option(const std::string& key) const;
+
+ /**
+ * Set an option.
+ * @param key the key of the option to set
+ * @param value the value to set
+ */
+ /**
+ * Set an option.
+ * @param key the key of the option to set
+ * @param value the value to set
+ */
+ void set_option(const std::string key, const std::string& value);
+
+ /**
+ * Add a parameter value to the "alias" section.
+ * @param key the name of the parameter which shall have a new alias
+ * @param value the new alias
+ */
void add_alias(const std::string&, const std::string&);
+
+ /**
+ * Resolve an alias.
+ * @param alias the alias to resolve.
+ * @return what the alias stands for
+ */
std::string deref_alias(const std::string&) const;
class Mutex* get_mutex() const;