author | Michael Krelin <hacker@klever.net> | 2008-05-17 22:09:26 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2008-05-17 22:09:26 (UTC) |
commit | 42a7c6597dab9147e47d25470b5218ae4c072eaf (patch) (unidiff) | |
tree | 8904f265fb2e84f6553696dea6371c532f57cd3e /include/opkele | |
parent | 7f314eb6b8cb6db5076ee785f59c5c52f224a897 (diff) | |
download | libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.zip libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.gz libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.bz2 |
doxygen fixes
Signed-off-by: Michael Krelin <hacker@klever.net>
-rw-r--r-- | include/opkele/basic_op.h | 1 | ||||
-rw-r--r-- | include/opkele/basic_rp.h | 2 |
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 | |||
@@ -167,86 +167,85 @@ namespace opkele { | |||
167 | basic_openid_message& setup_needed( | 167 | basic_openid_message& setup_needed( |
168 | basic_openid_message& oum,const basic_openid_message& inm); | 168 | basic_openid_message& oum,const basic_openid_message& inm); |
169 | 169 | ||
170 | /** | 170 | /** |
171 | * Process check_authentication request | 171 | * Process check_authentication request |
172 | * @param oum output OpenID message | 172 | * @param oum output OpenID message |
173 | * @param inm incoming request | 173 | * @param inm incoming request |
174 | * @return reference to oum | 174 | * @return reference to oum |
175 | */ | 175 | */ |
176 | basic_openid_message& check_authentication( | 176 | basic_openid_message& check_authentication( |
177 | basic_openid_message& oum,const basic_openid_message& inm); | 177 | basic_openid_message& oum,const basic_openid_message& inm); |
178 | /** | 178 | /** |
179 | * @} | 179 | * @} |
180 | */ | 180 | */ |
181 | 181 | ||
182 | /** | 182 | /** |
183 | * Verify return_to url. The default implementation checks whether | 183 | * Verify return_to url. The default implementation checks whether |
184 | * return_to URI matches the realm | 184 | * return_to URI matches the realm |
185 | * @throw bad_realm in case of invalid realm | 185 | * @throw bad_realm in case of invalid realm |
186 | * @throw bad_return_to if return_to doesn't match the realm | 186 | * @throw bad_return_to if return_to doesn't match the realm |
187 | * @see verify_OP::verify_return_to() | 187 | * @see verify_OP::verify_return_to() |
188 | */ | 188 | */ |
189 | virtual void verify_return_to(); | 189 | virtual void verify_return_to(); |
190 | 190 | ||
191 | /** | 191 | /** |
192 | * @name Global persistent store API | 192 | * @name Global persistent store API |
193 | * These functions are related to the associations with RPs storage | 193 | * These functions are related to the associations with RPs storage |
194 | * and retrieval and nonce management. | 194 | * and retrieval and nonce management. |
195 | * @{ | 195 | * @{ |
196 | */ | 196 | */ |
197 | /** | 197 | /** |
198 | * Allocate association. | 198 | * Allocate association. |
199 | * @param type association type | 199 | * @param type association type |
200 | * @param kl association key length | 200 | * @param kl association key length |
201 | * @param sl true if the association is stateless | 201 | * @param sl true if the association is stateless |
202 | * @return association object | 202 | * @return association object |
203 | */ | 203 | */ |
204 | virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0; | 204 | virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0; |
205 | /** | 205 | /** |
206 | * Retrieve valid unexpired association | 206 | * Retrieve valid unexpired association |
207 | * @param handle association handle | 207 | * @param handle association handle |
208 | * @return association object | 208 | * @return association object |
209 | */ | 209 | */ |
210 | virtual assoc_t retrieve_assoc(const string& handle) = 0; | 210 | virtual assoc_t retrieve_assoc(const string& handle) = 0; |
211 | /** | 211 | /** |
212 | * Allocate nonce. | 212 | * Allocate nonce. |
213 | * @param nonce input-output parameter containing timestamp part of | 213 | * @param nonce input-output parameter containing timestamp part of |
214 | * the nonce on input | 214 | * the nonce on input |
215 | * @param sl true if the nonce is | ||
216 | * @return reference to nonce | 215 | * @return reference to nonce |
217 | * @throw failed_lookup if no such valid unexpired association | 216 | * @throw failed_lookup if no such valid unexpired association |
218 | * could be retrieved | 217 | * could be retrieved |
219 | */ | 218 | */ |
220 | virtual string& alloc_nonce(string& nonce) = 0; | 219 | virtual string& alloc_nonce(string& nonce) = 0; |
221 | /** | 220 | /** |
222 | * Check nonce validity | 221 | * Check nonce validity |
223 | * @param nonce nonce to check | 222 | * @param nonce nonce to check |
224 | * @return true if nonce found and isn't yet invalidated | 223 | * @return true if nonce found and isn't yet invalidated |
225 | */ | 224 | */ |
226 | virtual bool check_nonce(const string& nonce) = 0; | 225 | virtual bool check_nonce(const string& nonce) = 0; |
227 | /** | 226 | /** |
228 | * Invalidate nonce | 227 | * Invalidate nonce |
229 | * @param nonce nonce to check | 228 | * @param nonce nonce to check |
230 | */ | 229 | */ |
231 | virtual void invalidate_nonce(const string& nonce) = 0; | 230 | virtual void invalidate_nonce(const string& nonce) = 0; |
232 | /** | 231 | /** |
233 | * @} | 232 | * @} |
234 | */ | 233 | */ |
235 | 234 | ||
236 | /** | 235 | /** |
237 | * @name Site particulars API | 236 | * @name Site particulars API |
238 | * @{ | 237 | * @{ |
239 | */ | 238 | */ |
240 | /** | 239 | /** |
241 | * Query the absolute URL of the op endpoint | 240 | * Query the absolute URL of the op endpoint |
242 | * @return fully qualified url of the OP endpoint | 241 | * @return fully qualified url of the OP endpoint |
243 | */ | 242 | */ |
244 | virtual const string get_op_endpoint() const = 0; | 243 | virtual const string get_op_endpoint() const = 0; |
245 | /** | 244 | /** |
246 | * @} | 245 | * @} |
247 | */ | 246 | */ |
248 | 247 | ||
249 | }; | 248 | }; |
250 | } | 249 | } |
251 | 250 | ||
252 | #endif /* __OPKELE_BASIC_OP_H */ | 251 | #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 | |||
@@ -20,97 +20,97 @@ namespace opkele { | |||
20 | string identity; | 20 | string identity; |
21 | 21 | ||
22 | virtual ~basic_RP() { } | 22 | virtual ~basic_RP() { } |
23 | 23 | ||
24 | void reset_vars(); | 24 | void reset_vars(); |
25 | 25 | ||
26 | /** | 26 | /** |
27 | * @name Assertion information retrieval | 27 | * @name Assertion information retrieval |
28 | * Retrieval of the information passed with openid message | 28 | * Retrieval of the information passed with openid message |
29 | * @{ | 29 | * @{ |
30 | */ | 30 | */ |
31 | /** | 31 | /** |
32 | * Find out if the assertion is about identity | 32 | * Find out if the assertion is about identity |
33 | * @return true if so | 33 | * @return true if so |
34 | */ | 34 | */ |
35 | bool has_identity() const; | 35 | bool has_identity() const; |
36 | /** | 36 | /** |
37 | * Get claimed identifier supplied with the request | 37 | * Get claimed identifier supplied with the request |
38 | * @return claimed identifier | 38 | * @return claimed identifier |
39 | * @throw non_identity if request is not about identity | 39 | * @throw non_identity if request is not about identity |
40 | */ | 40 | */ |
41 | const string& get_claimed_id() const; | 41 | const string& get_claimed_id() const; |
42 | /** | 42 | /** |
43 | * Get the identity (OP-Local identifier) confirmed | 43 | * Get the identity (OP-Local identifier) confirmed |
44 | * @return identity | 44 | * @return identity |
45 | * @throw non_identity if request is not about identity | 45 | * @throw non_identity if request is not about identity |
46 | */ | 46 | */ |
47 | const string& get_identity() const; | 47 | const string& get_identity() const; |
48 | /** | 48 | /** |
49 | * @} | 49 | * @} |
50 | */ | 50 | */ |
51 | 51 | ||
52 | /** | 52 | /** |
53 | * @name Global persistent store API | 53 | * @name Global persistent store API |
54 | * These are functions related to the associations with OP storage | 54 | * These are functions related to the associations with OP storage |
55 | * and retrieval and nonce records. They provide an interface to | 55 | * and retrieval and nonce records. They provide an interface to |
56 | * the persistent storage which is shared by all sessions. If the | 56 | * the persistent storage which is shared by all sessions. If the |
57 | * implementor prefers the dumb mode instead, the function should | 57 | * implementor prefers the dumb mode instead, the function should |
58 | * throw dumb_RP exception instead. | 58 | * throw dumb_RP exception instead. |
59 | * @see opkele::dumb_RP | 59 | * @see opkele::dumb_RP |
60 | * @{ | 60 | * @{ |
61 | */ | 61 | */ |
62 | /** | 62 | /** |
63 | * Store association and return allocated association object. | 63 | * Store association and return allocated association object. |
64 | * @param OP OP endpoint | 64 | * @param OP OP endpoint |
65 | * @param handle association handle | 65 | * @param handle association handle |
66 | * @param type association type | 66 | * @param type association type |
67 | * @param secret association secret | 67 | * @param secret association secret |
68 | * @params expires_in the number of seconds association expires in | 68 | * @param expires_in the number of seconds association expires in |
69 | * @return the association object | 69 | * @return the association object |
70 | * @throw dumb_RP for dumb RP | 70 | * @throw dumb_RP for dumb RP |
71 | */ | 71 | */ |
72 | virtual assoc_t store_assoc( | 72 | virtual assoc_t store_assoc( |
73 | const string& OP,const string& handle, | 73 | const string& OP,const string& handle, |
74 | const string& type,const secret_t& secret, | 74 | const string& type,const secret_t& secret, |
75 | int expires_in) = 0; | 75 | int expires_in) = 0; |
76 | /** | 76 | /** |
77 | * Find valid unexpired association with an OP. | 77 | * Find valid unexpired association with an OP. |
78 | * @param OP OP endpoint URL | 78 | * @param OP OP endpoint URL |
79 | * @return association found | 79 | * @return association found |
80 | * @throw failed_lookup if no association found | 80 | * @throw failed_lookup if no association found |
81 | * @throw dumb_RP for dumb RP | 81 | * @throw dumb_RP for dumb RP |
82 | */ | 82 | */ |
83 | virtual assoc_t find_assoc( | 83 | virtual assoc_t find_assoc( |
84 | const string& OP) = 0; | 84 | const string& OP) = 0; |
85 | /** | 85 | /** |
86 | * Retrieve valid association handle for an OP by handle. | 86 | * Retrieve valid association handle for an OP by handle. |
87 | * @param OP OP endpoint URL | 87 | * @param OP OP endpoint URL |
88 | * @param handle association handle | 88 | * @param handle association handle |
89 | * @return association found | 89 | * @return association found |
90 | * @throw failed_lookup if no association found | 90 | * @throw failed_lookup if no association found |
91 | * @throw dumb_RP for dumb RP | 91 | * @throw dumb_RP for dumb RP |
92 | */ | 92 | */ |
93 | virtual assoc_t retrieve_assoc( | 93 | virtual assoc_t retrieve_assoc( |
94 | const string& OP,const string& handle) = 0; | 94 | const string& OP,const string& handle) = 0; |
95 | /** | 95 | /** |
96 | * Invalidate association with OP | 96 | * Invalidate association with OP |
97 | * @param OP OP endpoint URL | 97 | * @param OP OP endpoint URL |
98 | * @param handle association handle | 98 | * @param handle association handle |
99 | * @throw dumb_RP for dumb RP | 99 | * @throw dumb_RP for dumb RP |
100 | */ | 100 | */ |
101 | virtual void invalidate_assoc(const string& OP,const string& handle) = 0; | 101 | virtual void invalidate_assoc(const string& OP,const string& handle) = 0; |
102 | 102 | ||
103 | /** | 103 | /** |
104 | * Check the nonce validity. That is, check that we haven't | 104 | * Check the nonce validity. That is, check that we haven't |
105 | * accepted request with this nonce from this OP, yet. May involve | 105 | * accepted request with this nonce from this OP, yet. May involve |
106 | * cutting off by the timestamp and checking the rest against the | 106 | * cutting off by the timestamp and checking the rest against the |
107 | * store of seen nonces. | 107 | * store of seen nonces. |
108 | * @param OP OP endpoint URL | 108 | * @param OP OP endpoint URL |
109 | * @param nonce nonce value | 109 | * @param nonce nonce value |
110 | * @throw id_res_bad_nonce if the nonce is not to be accepted, i.e. | 110 | * @throw id_res_bad_nonce if the nonce is not to be accepted, i.e. |
111 | * either too old or seen. | 111 | * either too old or seen. |
112 | */ | 112 | */ |
113 | virtual void check_nonce(const string& OP,const string& nonce) = 0; | 113 | virtual void check_nonce(const string& OP,const string& nonce) = 0; |
114 | /** | 114 | /** |
115 | * @} | 115 | * @} |
116 | */ | 116 | */ |