summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2008-05-17 22:09:26 (UTC)
committer Michael Krelin <hacker@klever.net>2008-05-17 22:09:26 (UTC)
commit42a7c6597dab9147e47d25470b5218ae4c072eaf (patch) (side-by-side diff)
tree8904f265fb2e84f6553696dea6371c532f57cd3e /include
parent7f314eb6b8cb6db5076ee785f59c5c52f224a897 (diff)
downloadlibopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.zip
libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.gz
libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.bz2
doxygen fixes
Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/basic_op.h1
-rw-r--r--include/opkele/basic_rp.h2
2 files changed, 1 insertions, 2 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h
index 12306dd..e4bbfa7 100644
--- a/include/opkele/basic_op.h
+++ b/include/opkele/basic_op.h
@@ -119,134 +119,133 @@ namespace opkele {
/**
* Establish association with RP
* @param oum reply message
* @param inm request message
*/
basic_openid_message& associate(
basic_openid_message& oum,
const basic_openid_message& inm);
/**
* Parse the checkid_* request. The function parses input message,
* retrieves the information needed for further processing,
* verifies what can be verified at this stage.
* @param inm incoming OpenID message
* @param ext extension/chain of extensions supported
*/
void checkid_(const basic_openid_message& inm,extension_t *ext=0);
/**
* Build and sign a positive assertion message
* @param om outpu OpenID message
* @param ext extension/chain of extensions supported
* @return reference to om
*/
basic_openid_message& id_res(basic_openid_message& om,
extension_t *ext=0);
/**
* Build a 'cancel' negative assertion
* @param om output OpenID message
* @return reference to om
*/
basic_openid_message& cancel(basic_openid_message& om);
/**
* Build an 'error' reply
* @param om output OpenID message
* @param error a human-readable message indicating the cause
* @param contact contact address for the server administrator (can be empty)
* @param reference a reference token (can be empty)
* @return reference to om
*/
basic_openid_message& error(basic_openid_message& om,
const string& error,const string& contact,
const string& reference );
/**
* Build a setup_needed reply to checkid_immediate request
* @param oum output OpenID message
* @param inm incoming OpenID request being processed
* @return reference to oum
*/
basic_openid_message& setup_needed(
basic_openid_message& oum,const basic_openid_message& inm);
/**
* Process check_authentication request
* @param oum output OpenID message
* @param inm incoming request
* @return reference to oum
*/
basic_openid_message& check_authentication(
basic_openid_message& oum,const basic_openid_message& inm);
/**
* @}
*/
/**
* Verify return_to url. The default implementation checks whether
* return_to URI matches the realm
* @throw bad_realm in case of invalid realm
* @throw bad_return_to if return_to doesn't match the realm
* @see verify_OP::verify_return_to()
*/
virtual void verify_return_to();
/**
* @name Global persistent store API
* These functions are related to the associations with RPs storage
* and retrieval and nonce management.
* @{
*/
/**
* Allocate association.
* @param type association type
* @param kl association key length
* @param sl true if the association is stateless
* @return association object
*/
virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0;
/**
* Retrieve valid unexpired association
* @param handle association handle
* @return association object
*/
virtual assoc_t retrieve_assoc(const string& handle) = 0;
/**
* Allocate nonce.
* @param nonce input-output parameter containing timestamp part of
* the nonce on input
- * @param sl true if the nonce is
* @return reference to nonce
* @throw failed_lookup if no such valid unexpired association
* could be retrieved
*/
virtual string& alloc_nonce(string& nonce) = 0;
/**
* Check nonce validity
* @param nonce nonce to check
* @return true if nonce found and isn't yet invalidated
*/
virtual bool check_nonce(const string& nonce) = 0;
/**
* Invalidate nonce
* @param nonce nonce to check
*/
virtual void invalidate_nonce(const string& nonce) = 0;
/**
* @}
*/
/**
* @name Site particulars API
* @{
*/
/**
* Query the absolute URL of the op endpoint
* @return fully qualified url of the OP endpoint
*/
virtual const string get_op_endpoint() const = 0;
/**
* @}
*/
};
}
#endif /* __OPKELE_BASIC_OP_H */
diff --git a/include/opkele/basic_rp.h b/include/opkele/basic_rp.h
index d096e0a..ea00677 100644
--- a/include/opkele/basic_rp.h
+++ b/include/opkele/basic_rp.h
@@ -1,164 +1,164 @@
#ifndef __OPKELE_BASIC_RP_H
#define __OPKELE_BASIC_RP_H
#include <string>
#include <opkele/types.h>
#include <opkele/extension.h>
namespace opkele {
using std::string;
class basic_RP {
public:
/**
* Claimed identifier from a parsed id_res message.
*/
string claimed_id;
/**
* OP-Local identifier from a parsed id_res message.
*/
string identity;
virtual ~basic_RP() { }
void reset_vars();
/**
* @name Assertion information retrieval
* Retrieval of the information passed with openid message
* @{
*/
/**
* Find out if the assertion is about identity
* @return true if so
*/
bool has_identity() const;
/**
* Get claimed identifier supplied with the request
* @return claimed identifier
* @throw non_identity if request is not about identity
*/
const string& get_claimed_id() const;
/**
* Get the identity (OP-Local identifier) confirmed
* @return identity
* @throw non_identity if request is not about identity
*/
const string& get_identity() const;
/**
* @}
*/
/**
* @name Global persistent store API
* These are functions related to the associations with OP storage
* and retrieval and nonce records. They provide an interface to
* the persistent storage which is shared by all sessions. If the
* implementor prefers the dumb mode instead, the function should
* throw dumb_RP exception instead.
* @see opkele::dumb_RP
* @{
*/
/**
* Store association and return allocated association object.
* @param OP OP endpoint
* @param handle association handle
* @param type association type
* @param secret association secret
- * @params expires_in the number of seconds association expires in
+ * @param expires_in the number of seconds association expires in
* @return the association object
* @throw dumb_RP for dumb RP
*/
virtual assoc_t store_assoc(
const string& OP,const string& handle,
const string& type,const secret_t& secret,
int expires_in) = 0;
/**
* Find valid unexpired association with an OP.
* @param OP OP endpoint URL
* @return association found
* @throw failed_lookup if no association found
* @throw dumb_RP for dumb RP
*/
virtual assoc_t find_assoc(
const string& OP) = 0;
/**
* Retrieve valid association handle for an OP by handle.
* @param OP OP endpoint URL
* @param handle association handle
* @return association found
* @throw failed_lookup if no association found
* @throw dumb_RP for dumb RP
*/
virtual assoc_t retrieve_assoc(
const string& OP,const string& handle) = 0;
/**
* Invalidate association with OP
* @param OP OP endpoint URL
* @param handle association handle
* @throw dumb_RP for dumb RP
*/
virtual void invalidate_assoc(const string& OP,const string& handle) = 0;
/**
* Check the nonce validity. That is, check that we haven't
* accepted request with this nonce from this OP, yet. May involve
* cutting off by the timestamp and checking the rest against the
* store of seen nonces.
* @param OP OP endpoint URL
* @param nonce nonce value
* @throw id_res_bad_nonce if the nonce is not to be accepted, i.e.
* either too old or seen.
*/
virtual void check_nonce(const string& OP,const string& nonce) = 0;
/**
* @}
*/
/**
* @name Session persistent store API
* @{
*/
/**
* Retrieve OpenID endpoint being currently used for
* authentication. If there is no endpoint available, throw a
* no_endpoint exception.
* @return reference to the service endpoint object
* @see next_endpoint
* @throw no_endpoint if no endpoint available
*/
virtual const openid_endpoint_t& get_endpoint() const = 0;
/**
* Advance to the next endpoint to try.
* @see get_endpoint()
* @throw no_endpoint if there are no more endpoints
*/
virtual void next_endpoint() = 0;
/**
* @}
*/
/**
* @name Site particulars API
* @{
*/
/**
* Return an absolute URL of the page being processed, includining
* query parameters. It is used to validate return_to URL on
* positive assertions.
* @return fully qualified url of the page being processed.
*/
virtual const string get_this_url() const = 0;
/**
* @}
*/
/**
* @name OpenID actions
* @{
*/
/**
* Initiates authentication session, doing discovery, normalization
* and whatever implementor wants to do at this point.
* @param usi User-supplied identity
*/