summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2007-08-09 11:23:36 (UTC)
committer Michael Krelin <hacker@klever.net>2007-08-09 11:23:36 (UTC)
commit65bab7c9f984d6fe45ce72e7db014c40eba4d240 (patch) (unidiff)
tree28c4791aea6b7dc404ad0d27050c34f447a84314 /include
parent1f347795ef5eba50892fd777c173a2a6db1755f2 (diff)
downloadlibopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.zip
libopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.tar.gz
libopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.tar.bz2
associations robustness improvements and documentation updates
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/association.h2
-rw-r--r--include/opkele/consumer.h19
2 files changed, 20 insertions, 1 deletions
diff --git a/include/opkele/association.h b/include/opkele/association.h
index a8f3915..72eff5b 100644
--- a/include/opkele/association.h
+++ b/include/opkele/association.h
@@ -40,29 +40,31 @@ namespace opkele {
40 * statelessness of the assoc_handle 40 * statelessness of the assoc_handle
41 */ 41 */
42 bool _stateless; 42 bool _stateless;
43 43
44 /** 44 /**
45 * @param __server the server name 45 * @param __server the server name
46 * @param __handle association handle 46 * @param __handle association handle
47 * @param __assoc_type association type 47 * @param __assoc_type association type
48 * @param __secret the secret 48 * @param __secret the secret
49 * @param __expires expiration time 49 * @param __expires expiration time
50 * @param __stateless statelessness of the assoc_handle 50 * @param __stateless statelessness of the assoc_handle
51 */ 51 */
52 association(const string& __server, const string& __handle, 52 association(const string& __server, const string& __handle,
53 const string& __assoc_type, const secret_t& __secret, 53 const string& __assoc_type, const secret_t& __secret,
54 time_t __expires, bool __stateless) 54 time_t __expires, bool __stateless)
55 : _server(__server), _handle(__handle), _assoc_type(__assoc_type), 55 : _server(__server), _handle(__handle), _assoc_type(__assoc_type),
56 _secret(__secret), _expires(__expires), _stateless(__stateless) { } 56 _secret(__secret), _expires(__expires), _stateless(__stateless) { }
57 57
58 virtual string server() const { return _server; } 58 virtual string server() const { return _server; }
59 virtual string handle() const { return _handle; } 59 virtual string handle() const { return _handle; }
60 virtual string assoc_type() const { return _assoc_type; } 60 virtual string assoc_type() const { return _assoc_type; }
61 virtual secret_t secret() const { return _secret; } 61 virtual secret_t secret() const { return _secret; }
62 virtual int expires_in() const { return _expires-time(0); } 62 virtual int expires_in() const { return _expires-time(0); }
63 virtual bool stateless() const { return _stateless; } 63 virtual bool stateless() const { return _stateless; }
64
65 virtual bool is_expired() const { return _expires<time(0); }
64 }; 66 };
65 67
66} 68}
67 69
68#endif /* __OPKELE_ASSOCIATION_H */ 70#endif /* __OPKELE_ASSOCIATION_H */
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index 042e2d1..b9d1e54 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -1,74 +1,91 @@
1#ifndef __OPKELE_CONSUMER_H 1#ifndef __OPKELE_CONSUMER_H
2#define __OPKELE_CONSUMER_H 2#define __OPKELE_CONSUMER_H
3 3
4#include <opkele/types.h> 4#include <opkele/types.h>
5#include <opkele/extension.h> 5#include <opkele/extension.h>
6 6
7/** 7/**
8 * @file 8 * @file
9 * @brief OpenID consumer-side functionality 9 * @brief OpenID consumer-side functionality
10 */ 10 */
11 11
12namespace opkele { 12namespace opkele {
13 13
14 /** 14 /**
15 * implementation of basic consumer functionality 15 * implementation of basic consumer functionality
16 *
17 * @note
18 * The consumer uses libcurl internally, which means that if you're using
19 * libopkele in multithreaded environment you should call curl_global_init
20 * yourself before spawning any threads.
16 */ 21 */
17 class consumer_t { 22 class consumer_t {
18 public: 23 public:
19 24
20 /** 25 /**
21 * store association. The function should be overridden in the real 26 * store association. The function should be overridden in the real
22 * implementation to provide persistent associations store. 27 * implementation to provide persistent associations store.
23 * @param server the OpenID server 28 * @param server the OpenID server
24 * @param handle association handle 29 * @param handle association handle
25 * @param secret the secret associated with the server and handle 30 * @param secret the secret associated with the server and handle
26 * @param expires_in the number of seconds until the handle is expired 31 * @param expires_in the number of seconds until the handle is expired
27 * @return the auto_ptr<> for the newly allocated association_t object 32 * @return the auto_ptr<> for the newly allocated association_t object
28 */ 33 */
29 virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; 34 virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0;
30 /** 35 /**
31 * retrieve stored association. The function should be overridden 36 * retrieve stored association. The function should be overridden
32 * in the real implementation to provide persistent assocations 37 * in the real implementation to provide persistent assocations
33 * store. 38 * store.
39 *
40 * @note
41 * The user is responsible for handling associations expiry and
42 * this function should never return an expired or invalidated
43 * association.
44 *
34 * @param server the OpenID server 45 * @param server the OpenID server
35 * @param handle association handle 46 * @param handle association handle
36 * @return the autho_ptr<> for the newly allocated association_t object 47 * @return the autho_ptr<> for the newly allocated association_t object
37 * @throw failed_lookup in case of error 48 * @throw failed_lookup if no unexpired association found
38 */ 49 */
39 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0; 50 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0;
40 /** 51 /**
41 * invalidate stored association. The function should be overridden 52 * invalidate stored association. The function should be overridden
42 * in the real implementation of the consumer. 53 * in the real implementation of the consumer.
43 * @param server the OpenID server 54 * @param server the OpenID server
44 * @param handle association handle 55 * @param handle association handle
45 */ 56 */
46 virtual void invalidate_assoc(const string& server,const string& handle) = 0; 57 virtual void invalidate_assoc(const string& server,const string& handle) = 0;
47 /** 58 /**
48 * retrieve any unexpired association for the server. If the 59 * retrieve any unexpired association for the server. If the
49 * function is not overridden in the real implementation, the new 60 * function is not overridden in the real implementation, the new
50 * association will be established for each request. 61 * association will be established for each request.
62 *
63 * @note
64 * The user is responsible for handling associations and this
65 * function should never return an expired or invalidated
66 * association.
67 *
51 * @param server the OpenID server 68 * @param server the OpenID server
52 * @return the auto_ptr<> for the newly allocated association_t object 69 * @return the auto_ptr<> for the newly allocated association_t object
53 * @throw failed_lookup in case of absence of the handle 70 * @throw failed_lookup in case of absence of the handle
54 */ 71 */
55 virtual assoc_t find_assoc(const string& server); 72 virtual assoc_t find_assoc(const string& server);
56 73
57 /** 74 /**
58 * retrieve the metainformation contained in link tags from the 75 * retrieve the metainformation contained in link tags from the
59 * page pointed by url. the function may implement caching of the 76 * page pointed by url. the function may implement caching of the
60 * information. 77 * information.
61 * @param url url to harvest for link tags 78 * @param url url to harvest for link tags
62 * @param server reference to the string object where to put 79 * @param server reference to the string object where to put
63 * openid.server value 80 * openid.server value
64 * @param delegate reference to the string object where to put the 81 * @param delegate reference to the string object where to put the
65 * openid.delegate value (if any) 82 * openid.delegate value (if any)
66 */ 83 */
67 virtual void retrieve_links(const string& url,string& server,string& delegate); 84 virtual void retrieve_links(const string& url,string& server,string& delegate);
68 85
69 /** 86 /**
70 * perform the associate request to OpenID server. 87 * perform the associate request to OpenID server.
71 * @param server the OpenID server 88 * @param server the OpenID server
72 * @return the auto_ptr<> for the newly allocated association_t 89 * @return the auto_ptr<> for the newly allocated association_t
73 * object, representing established association 90 * object, representing established association
74 * @throw exception in case of error 91 * @throw exception in case of error