| -rw-r--r-- | include/opkele/extension.h | 49 |
1 files changed, 22 insertions, 27 deletions
diff --git a/include/opkele/extension.h b/include/opkele/extension.h index 3ee25ee..37bcb90 100644 --- a/include/opkele/extension.h +++ b/include/opkele/extension.h | |||
| @@ -6,6 +6,7 @@ | |||
| 6 | * @brief extensions framework basics | 6 | * @brief extensions framework basics |
| 7 | */ | 7 | */ |
| 8 | 8 | ||
| 9 | #include <opkele/opkele-config.h> | ||
| 9 | #include <opkele/types.h> | 10 | #include <opkele/types.h> |
| 10 | 11 | ||
| 11 | namespace opkele { | 12 | namespace opkele { |
| @@ -19,39 +20,33 @@ namespace opkele { | |||
| 19 | virtual ~extension_t() { } | 20 | virtual ~extension_t() { } |
| 20 | 21 | ||
| 21 | /** | 22 | /** |
| 22 | * hook called by consumer before submitting data to OpenID server. | 23 | * hook called by RP before submitting the message to OP. |
| 23 | * It is supposed to manipulate parameters list. | 24 | * @param om openid message to be submit |
| 24 | * @param p parameters about to be submitted to server | ||
| 25 | * @param identity identity being verified. It may differ from the | ||
| 26 | * one available in parameters list in case of delegation | ||
| 27 | * @see consumer_t::checkid_ | ||
| 28 | * @see consumer_t::checkid_immediate | ||
| 29 | * @see consumer_t::checkid_setup | ||
| 30 | */ | 25 | */ |
| 31 | virtual void checkid_hook(basic_openid_message& om); | 26 | virtual void rp_checkid_hook(basic_openid_message& om); |
| 27 | |||
| 32 | /** | 28 | /** |
| 33 | * hook called by consumer after identity information received from | 29 | * hook called by RP after verifying information received from OP. |
| 34 | * OpenID server is verified. | 30 | * @param om openid message received |
| 35 | * @param p parameters received from server | 31 | * @param sp signed part of the message |
| 36 | * @param sp signed parameters received from server with 'openid.' | ||
| 37 | * leader stripped | ||
| 38 | * @param identity identity confirmed. May differ from the one | ||
| 39 | * available in parameters list in case of delegation. May also be | ||
| 40 | * empty which means - extract one from parameters | ||
| 41 | * @see consumer_t::id_res | ||
| 42 | */ | 32 | */ |
| 43 | virtual void id_res_hook(const basic_openid_message& om,const basic_openid_message& sp); | 33 | virtual void rp_id_res_hook(const basic_openid_message& om, |
| 34 | const basic_openid_message& sp); | ||
| 44 | 35 | ||
| 45 | /** | 36 | /** |
| 46 | * hook called by server before returning information to consumer. | 37 | * hook called by OP after parsing incoming message |
| 47 | * The hook may manipulate output parameters. It is important to | 38 | * @param inm message received from RP |
| 48 | * note that modified pout["signed"] is used for signing response. | 39 | */ |
| 49 | * @param pin request parameters list with "openid." prefix | 40 | virtual void op_checkid_hook(const basic_openid_message& inm); |
| 50 | * @param pout response parameters list without "openid." prefix | 41 | /** |
| 51 | * @see server_t::checkid_ | 42 | * hook called by OP before signing the reply to RP |
| 52 | * @see server_t::checkid_immediate | 43 | * @param oum message to be sent to RP |
| 53 | * @see server_t::checkid_setup | ||
| 54 | */ | 44 | */ |
| 45 | virtual void op_id_res_hook(basic_openid_message& oum); | ||
| 46 | |||
| 47 | virtual void checkid_hook(basic_openid_message& om) OPKELE_DEPRECATE; | ||
| 48 | virtual void id_res_hook(const basic_openid_message& om, | ||
| 49 | const basic_openid_message& sp) OPKELE_DEPRECATE; | ||
| 55 | virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum); | 50 | virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum); |
| 56 | 51 | ||
| 57 | /** | 52 | /** |