| -rw-r--r-- | Doxyfile.in | 4 | ||||
| -rw-r--r-- | include/opkele/association.h | 21 | ||||
| -rw-r--r-- | include/opkele/consumer.h | 3 | ||||
| -rw-r--r-- | include/opkele/data.h | 6 | ||||
| -rw-r--r-- | include/opkele/exception.h | 3 | ||||
| -rw-r--r-- | include/opkele/extension.h | 3 | ||||
| -rw-r--r-- | include/opkele/extension_chain.h | 12 | ||||
| -rw-r--r-- | include/opkele/server.h | 3 | ||||
| -rw-r--r-- | include/opkele/sreg.h | 3 | ||||
| -rw-r--r-- | include/opkele/types.h | 3 | ||||
| -rw-r--r-- | include/opkele/util.h | 3 | ||||
| -rw-r--r-- | include/opkele/xconsumer.h | 3 | ||||
| -rw-r--r-- | include/opkele/xserver.h | 3 |
13 files changed, 11 insertions, 59 deletions
diff --git a/Doxyfile.in b/Doxyfile.in index adb2aa3..ce2fb20 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -25,34 +25,34 @@ INHERIT_DOCS = YES DISTRIBUTE_GROUP_DOC = NO TAB_SIZE = 8 ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO SUBGROUPING = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = NO INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO SORT_BY_SCOPE_NAME = YES GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 diff --git a/include/opkele/association.h b/include/opkele/association.h index ef0df42..a8f3915 100644 --- a/include/opkele/association.h +++ b/include/opkele/association.h @@ -1,30 +1,27 @@ #ifndef __OPKELE_ASSOCIATION_H #define __OPKELE_ASSOCIATION_H #include <time.h> #include <opkele/types.h> /** * @file * @brief reference implementation of association_t */ -/** - * @brief the main opkele namespace - */ namespace opkele { /** * reference implementation of association_t class. */ class association : public association_t { public: /** * OpenID server name */ string _server; /** * association handle */ string _handle; /** @@ -45,45 +42,27 @@ namespace opkele { bool _stateless; /** * @param __server the server name * @param __handle association handle * @param __assoc_type association type * @param __secret the secret * @param __expires expiration time * @param __stateless statelessness of the assoc_handle */ association(const string& __server, const string& __handle, const string& __assoc_type, const secret_t& __secret, time_t __expires, bool __stateless) : _server(__server), _handle(__handle), _assoc_type(__assoc_type), _secret(__secret), _expires(__expires), _stateless(__stateless) { } - /** - * @overload association_t::server() - */ virtual string server() const { return _server; } - /** - * @overload association_t::handle() - */ virtual string handle() const { return _handle; } - /** - * @overload association_t::assoc_type() - */ virtual string assoc_type() const { return _assoc_type; } - /** - * @overload association_t::secret() - */ virtual secret_t secret() const { return _secret; } - /** - * @overload association_t::expires_in() - */ virtual int expires_in() const { return _expires-time(0); } - /** - * @overload association_t::stateless() - */ virtual bool stateless() const { return _stateless; } }; } #endif /* __OPKELE_ASSOCIATION_H */ diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h index f32509e..fdb6119 100644 --- a/include/opkele/consumer.h +++ b/include/opkele/consumer.h @@ -1,30 +1,27 @@ #ifndef __OPKELE_CONSUMER_H #define __OPKELE_CONSUMER_H #include <opkele/types.h> #include <opkele/extension.h> /** * @file * @brief OpenID consumer-side functionality */ -/** - * @brief the main opkele namespace - */ namespace opkele { /** * implementation of basic consumer functionality */ class consumer_t { public: /** * store association. The function should be overridden in the real * implementation to provide persistent associations store. * @param server the OpenID server * @param handle association handle * @param secret the secret associated with the server and handle * @param expires_in the number of seconds until the handle is expired * @return the auto_ptr<> for the newly allocated association_t object diff --git a/include/opkele/data.h b/include/opkele/data.h index 7fc635b..d0b0516 100644 --- a/include/opkele/data.h +++ b/include/opkele/data.h @@ -1,12 +1,18 @@ #ifndef __OPKELE_DATA_H #define __OPKELE_DATA_H +/** + * @brief the main opkele namespace + */ namespace opkele { + /** + * @brief internal data opkele namespace + */ namespace data { extern const char *_default_p; extern const char *_default_g; } } #endif /* __OPKELE_DATA_H */ diff --git a/include/opkele/exception.h b/include/opkele/exception.h index 9fc9bd3..0150e6b 100644 --- a/include/opkele/exception.h +++ b/include/opkele/exception.h @@ -40,35 +40,32 @@ */ # define OPKELE_E_CONS_ /** * the dummy placeholder for konforka exception codepoint specification */ # define OPKELE_CP_ /** * the dummy define for the konforka-based rethrow of exception */ # define OPKELE_RETHROW #endif /* OPKELE_HAVE_KONFORKA */ /** * the exception parameters list to pass to constructor */ # define OPKELE_E_CONS OPKELE_E_CONS_ w -/* - * @brief the main opkele namespace - */ namespace opkele { using std::string; /** * the base opkele exception class */ class exception : public # ifdef OPKELE_HAVE_KONFORKA konforka::exception # else std::exception # endif { public: # ifdef OPKELE_HAVE_KONFORKA explicit diff --git a/include/opkele/extension.h b/include/opkele/extension.h index f547555..ea0c74c 100644 --- a/include/opkele/extension.h +++ b/include/opkele/extension.h @@ -1,29 +1,26 @@ #ifndef __OPKELE_EXTENSION_H #define __OPKELE_EXTENSION_H /** * @file * @brief extensions framework basics */ #include <opkele/types.h> -/** - * @brief the main opkele namespace - */ namespace opkele { /** * OpenID extension hooks base class */ class extension_t { public: /** * hook called by consumer before submitting data to OpenID server. * It is supposed to manipulate parameters list. * @param p parameters about to be submitted to server * @param identity identity being verified. It may differ from the * one available in parameters list in case of delegation * @see consumer_t::checkid_ * @see consumer_t::checkid_immediate * @see consumer_t::checkid_setup diff --git a/include/opkele/extension_chain.h b/include/opkele/extension_chain.h index 955f4d5..f0eea94 100644 --- a/include/opkele/extension_chain.h +++ b/include/opkele/extension_chain.h @@ -1,50 +1,38 @@ #ifndef __OPKELE_EXTENSION_CHAIN_H #define __OPKELE_EXTENSION_CHAIN_H /** * @file * @brief extension chain extension */ #include <list> #include <opkele/extension.h> -/** - * @brief the main opkele namespace - */ namespace opkele { using std::list; /** * OpenID extensions chain used to combine extensions, it is actually an * stl list of pointers to extensions. */ class extension_chain_t : public extension_t, public list<extension_t*> { public: /** * Default constructor creates an empty chain */ extension_chain_t() { } /** * Create extension chain with a single extension in it */ extension_chain_t(extension_t *e) { push_back(e); } - /** - * Implementation of consumer's checkid hook - */ virtual void checkid_hook(params_t& p,const string& identity); - /** - * Implementation of consumer's id_res hook - */ virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity); - /** - * Implementation of server's checkid_hook - */ virtual void checkid_hook(const params_t& pin,params_t& pout); }; } #endif /* __OPKELE_EXTENSION_CHAIN_H */ diff --git a/include/opkele/server.h b/include/opkele/server.h index 598eb47..e7e5bb3 100644 --- a/include/opkele/server.h +++ b/include/opkele/server.h @@ -1,30 +1,27 @@ #ifndef __OPKELE_SERVER_H #define __OPKELE_SERVER_H /** * @file * @brief OpenID server-side functionality */ #include <opkele/types.h> #include <opkele/extension.h> -/** - * @brief the main opkele namespace - */ namespace opkele { /** * implementation of basic server functionality */ class server_t { public: /** * allocate the new association. The function should be overridden * in the real implementation to provide persistent assocations * store. * @param mode the mode of request being processed to base the * statelessness of the association upon * @return the auto_ptr<> for the newly allocated association_t object */ diff --git a/include/opkele/sreg.h b/include/opkele/sreg.h index 6713ef7..df37a86 100644 --- a/include/opkele/sreg.h +++ b/include/opkele/sreg.h @@ -1,29 +1,26 @@ #ifndef __OPKELE_SREG_H #define __OPKELE_SREG_H /** * @file * @brief Simple registration extension */ #include <opkele/extension.h> -/** - * @brief the main opkele namespace - */ namespace opkele { using std::map; /** * OpenID simple registration extension implementation * http://openid.net/specs/openid-simple-registration-extension-1_0.html */ class sreg_t : public extension_t { public: /** * sreg fields enumeration */ enum fieldbit_t { /** * Any UTF-8 string that the End User wants to use as a nickname. */ diff --git a/include/opkele/types.h b/include/opkele/types.h index ba06776..757c0af 100644 --- a/include/opkele/types.h +++ b/include/opkele/types.h @@ -1,33 +1,30 @@ #ifndef __OPKELE_TYPES_H #define __OPKELE_TYPES_H /** * @file * @brief various types declarations */ #include <ostream> #include <vector> #include <string> #include <map> #include <memory> -/** - * @brief the main opkele namespace - */ namespace opkele { using std::vector; using std::string; using std::map; using std::ostream; using std::auto_ptr; /** * the OpenID operation mode */ typedef enum _mode_t { mode_associate, mode_checkid_immediate, mode_checkid_setup, mode_check_association } mode_t; diff --git a/include/opkele/util.h b/include/opkele/util.h index 2a7a859..edc1859 100644 --- a/include/opkele/util.h +++ b/include/opkele/util.h @@ -1,29 +1,32 @@ #ifndef __OPKELE_UTIL_H #define __OPKELE_UTIL_H #include <time.h> #include <string> #include <vector> #include <openssl/bn.h> #include <openssl/dh.h> namespace opkele { using std::string; using std::vector; + /** + * @brief opkele utils namespace + */ namespace util { /** * Convenience class encapsulating SSL BIGNUM object for the purpose of * automatical freeing. */ class bignum_t { public: BIGNUM *_bn; bignum_t() : _bn(0) { } bignum_t(BIGNUM *bn) : _bn(bn) { } ~bignum_t() throw() { if(_bn) BN_free(_bn); } bignum_t& operator=(BIGNUM *bn) { if(_bn) BN_free(_bn); _bn = bn; return *this; } diff --git a/include/opkele/xconsumer.h b/include/opkele/xconsumer.h index 14a8aaa..42796c0 100644 --- a/include/opkele/xconsumer.h +++ b/include/opkele/xconsumer.h @@ -1,30 +1,27 @@ #ifndef __OPKELE_XCONSUMER_H #define __OPKELE_XCONSUMER_H /** * @file * @brief OpenID consumer with built-in extension chain */ #include <opkele/extension_chain.h> #include <opkele/consumer.h> -/** - * @brief the main opkele namespace - */ namespace opkele { /** * Extended OpenID consumer implementation with built in * extensions chain. */ class xconsumer_t : public consumer_t, public extension_chain_t { public: string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0) { return consumer_t::checkid_immediate(identity,return_to,trust_root,this); } string chekid_setup(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0) { return consumer_t::checkid_setup(identity,return_to,trust_root,this); } string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0) { diff --git a/include/opkele/xserver.h b/include/opkele/xserver.h index e29bfe6..c645d56 100644 --- a/include/opkele/xserver.h +++ b/include/opkele/xserver.h @@ -1,30 +1,27 @@ #ifndef __OPKELE_XSERVER_H #define __OPKELE_XSERVER_H /** * @file * @brief OpenID server with built-in extension chain */ #include <opkele/extension_chain.h> #include <opkele/server.h> -/** - * @brief the main opkele namespace - */ namespace opkele { /** * Extended OpenID server implementationwith built in * extensions chain. */ class xserver_t : public server_t, public extension_chain_t { public: void checkid_immediate(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0) { server_t::checkid_immediate(pin,return_to,pout,this); } void checkid_setup(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0) { server_t::checkid_setup(pin,return_to,pout,this); } void checkid_(mode_t mode,const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0) { |