summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2007-01-11 00:57:06 (UTC)
committer Michael Krelin <hacker@klever.net>2007-01-11 00:57:06 (UTC)
commit06eaf00c48fc563245b85c2be4b8b5a03ef2cfe9 (patch) (side-by-side diff)
treeef978c5d86188d2fc4c7e98a921804d7bfeb5557 /include
parent100199abfdf7a353f9ba2aa9618e0711213290d3 (diff)
downloadlibopkele-06eaf00c48fc563245b85c2be4b8b5a03ef2cfe9.zip
libopkele-06eaf00c48fc563245b85c2be4b8b5a03ef2cfe9.tar.gz
libopkele-06eaf00c48fc563245b85c2be4b8b5a03ef2cfe9.tar.bz2
introduced extension hooks framework
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/Makefile.am3
-rw-r--r--include/opkele/consumer.h25
-rw-r--r--include/opkele/exception.h10
-rw-r--r--include/opkele/extension.h59
-rw-r--r--include/opkele/server.h10
5 files changed, 92 insertions, 15 deletions
diff --git a/include/Makefile.am b/include/Makefile.am
index b014752..72931eb 100644
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -6,5 +6,6 @@ nobase_include_HEADERS = \
opkele/exception.h \
opkele/server.h \
- opkele/consumer.h
+ opkele/consumer.h \
+ opkele/extension.h
EXTRA_DIST = \
opkele/data.h \
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index 9932315..f9939cf 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -3,4 +3,5 @@
#include <opkele/types.h>
+#include <opkele/extension.h>
/**
@@ -83,8 +84,9 @@ namespace opkele {
* @param return_to the return_to url to pass with the request
* @param trust_root the trust root to advertise with the request
+ * @param ext pointer to an extension(s) hooks object
* @return the location string
* @throw exception in case of error
*/
- string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="");
+ string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
/**
* prepare the parameters for the checkid_setup
@@ -93,8 +95,9 @@ namespace opkele {
* @param return_to the return_to url to pass with the request
* @param trust_root the trust root to advertise with the request
+ * @param ext pointer to an extension(s) hooks object
* @return the location string
* @throw exception in case of error
*/
- string checkid_setup(const string& identity,const string& return_to,const string& trust_root="");
+ string checkid_setup(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
/**
* the actual implementation behind checkid_immediate() and
@@ -104,22 +107,22 @@ namespace opkele {
* @param return_to the return_to url to pass with the request
* @param trust_root the trust root to advertise with the request
+ * @param ext pointer to an extension(s) hooks object
* @return the location string
* @throw exception in case of error
*/
- string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="");
+ string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
/**
* verify the id_res response
* @param pin the response parameters
- * @param identity the identity being checked (if not specified, extracted
- * from the openid.identity parameter
- * @throw id_res_mismatch in case of signature
- * mismatch
- * @throw id_res_setup in case of
- * openid.user_setup_url failure (supposedly
- * checkid_immediate only)
+ * @param identity the identity being checked (if not specified,
+ * @param ext pointer to an extension(s) hooks object
+ * extracted from the openid.identity parameter
+ * @throw id_res_mismatch in case of signature mismatch
+ * @throw id_res_setup in case of openid.user_setup_url failure
+ * (supposedly checkid_immediate only)
* @throw id_res_failed in case of failure
* @throw exception in case of other failures
*/
- void id_res(const params_t& pin,const string& identity="");
+ void id_res(const params_t& pin,const string& identity="",extension_t *ext=0);
/**
* perform a check_authentication request.
diff --git a/include/opkele/exception.h b/include/opkele/exception.h
index c5f5811..9fc9bd3 100644
--- a/include/opkele/exception.h
+++ b/include/opkele/exception.h
@@ -206,4 +206,14 @@ namespace opkele {
};
+ /**
+ * not implemented (think pure virtual) member function executed, signfies
+ * programmer error
+ */
+ class not_implemented : public exception {
+ public:
+ not_implemented(OPKELE_E_PARS)
+ : exception(OPKELE_E_CONS) { }
+ };
+
}
diff --git a/include/opkele/extension.h b/include/opkele/extension.h
new file mode 100644
index 0000000..3fb5f6e
--- a/dev/null
+++ b/include/opkele/extension.h
@@ -0,0 +1,59 @@
+#ifndef __OPKELE_EXTENSIONS_H
+#define __OPKELE_EXTENSIONS_H
+
+/**
+ * @file
+ * @brief extensions framework basics
+ */
+
+#include <opkele/types.h>
+
+/**
+ * @brief the main opkele namespace
+ */
+namespace opkele {
+
+ /**
+ * OpenID consumer 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
+ */
+ virtual void checkid_hook(params_t& p,const string& identity);
+ /**
+ * hook called by consumer after identity information received from
+ * OpenID server is verified.
+ * @param p parameters received from server
+ * @param sp signed parameters received from server with 'openid.'
+ * leader stripped
+ * @param identity identity confirmed. May differ from the one
+ * available in parameters list in case of delegation. May also be
+ * empty which means - extract one from parameters
+ */
+ virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity);
+
+ /**
+ * hook called by server before returning information to consumer.
+ * The hook may manipulate output parameters. It is important to
+ * note that modified pout["signed"] is used for signing response.
+ * @param pin request parameters list
+ * @param put response parameters list
+ */
+ virtual void checkid_hook(const params_t& pin,params_t& pout);
+
+ /**
+ * Casts the object to pointer to itself. For convenient passing
+ * of pointer.
+ */
+ operator extension_t*(void) { return this; }
+ };
+
+}
+
+#endif /* __OPKELE_EXTENSIONS_H */
diff --git a/include/opkele/server.h b/include/opkele/server.h
index fe07448..bf131d8 100644
--- a/include/opkele/server.h
+++ b/include/opkele/server.h
@@ -8,4 +8,5 @@
#include <opkele/types.h>
+#include <opkele/extension.h>
/**
@@ -61,7 +62,8 @@ namespace opkele {
* @param return_to reference to the object to store return_to url to
* @param pout the response parameters
+ * @param ext pointer to the extension hooks object
* @throw exception in case of errors or negative reply
*/
- void checkid_immediate(const params_t& pin,string& return_to,params_t& pout);
+ void checkid_immediate(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0);
/**
* process the checkid_setup request.
@@ -69,7 +71,8 @@ namespace opkele {
* @param return_to reference to the object to store return_to url to
* @param pout the response parameters
+ * @param ext pointer to the extension hooks object
* @throw exception in case of errors or negative reply
*/
- void checkid_setup(const params_t& pin,string& return_to,params_t& pout);
+ void checkid_setup(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0);
/**
* the actual functionality behind checkid_immediate() and
@@ -80,7 +83,8 @@ namespace opkele {
* @param return_to reference to the object to store return_to url to
* @param pout the response parameters
+ * @param ext pointer to the extension hooks object
* @throw exception in case of errors or negative reply
*/
- void checkid_(mode_t mode,const params_t& pin,string& return_to,params_t& pout);
+ void checkid_(mode_t mode,const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0);
/**
* process the check_authentication request.