-rw-r--r-- | include/opkele/basic_op.h | 2 | ||||
-rw-r--r-- | include/opkele/verify_op.h | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h index 0e3231d..0326508 100644 --- a/include/opkele/basic_op.h +++ b/include/opkele/basic_op.h | |||
@@ -137,97 +137,97 @@ namespace opkele { | |||
137 | * @param ext extension/chain of extensions supported | 137 | * @param ext extension/chain of extensions supported |
138 | * @return reference to om | 138 | * @return reference to om |
139 | */ | 139 | */ |
140 | basic_openid_message& id_res(basic_openid_message& om, | 140 | basic_openid_message& id_res(basic_openid_message& om, |
141 | extension_t *ext=0); | 141 | extension_t *ext=0); |
142 | /** | 142 | /** |
143 | * Build a 'cancel' negative assertion | 143 | * Build a 'cancel' negative assertion |
144 | * @param om output OpenID message | 144 | * @param om output OpenID message |
145 | * @return reference to om | 145 | * @return reference to om |
146 | */ | 146 | */ |
147 | basic_openid_message& cancel(basic_openid_message& om); | 147 | basic_openid_message& cancel(basic_openid_message& om); |
148 | /** | 148 | /** |
149 | * Build an 'error' reply | 149 | * Build an 'error' reply |
150 | * @param om output OpenID message | 150 | * @param om output OpenID message |
151 | * @param error a human-readable message indicating the cause | 151 | * @param error a human-readable message indicating the cause |
152 | * @param contact contact address for the server administrator (can be empty) | 152 | * @param contact contact address for the server administrator (can be empty) |
153 | * @param reference a reference token (can be empty) | 153 | * @param reference a reference token (can be empty) |
154 | * @return reference to om | 154 | * @return reference to om |
155 | */ | 155 | */ |
156 | basic_openid_message& error(basic_openid_message& om, | 156 | basic_openid_message& error(basic_openid_message& om, |
157 | const string& error,const string& contact, | 157 | const string& error,const string& contact, |
158 | const string& reference ); | 158 | const string& reference ); |
159 | /** | 159 | /** |
160 | * Build a setup_needed reply to checkid_immediate request | 160 | * Build a setup_needed reply to checkid_immediate request |
161 | * @param oum output OpenID message | 161 | * @param oum output OpenID message |
162 | * @param inm incoming OpenID request being processed | 162 | * @param inm incoming OpenID request being processed |
163 | * @return reference to oum | 163 | * @return reference to oum |
164 | */ | 164 | */ |
165 | basic_openid_message& setup_needed( | 165 | basic_openid_message& setup_needed( |
166 | basic_openid_message& oum,const basic_openid_message& inm); | 166 | basic_openid_message& oum,const basic_openid_message& inm); |
167 | 167 | ||
168 | /** | 168 | /** |
169 | * Process check_authentication request | 169 | * Process check_authentication request |
170 | * @param oum output OpenID message | 170 | * @param oum output OpenID message |
171 | * @param inm incoming request | 171 | * @param inm incoming request |
172 | * @return reference to oum | 172 | * @return reference to oum |
173 | */ | 173 | */ |
174 | basic_openid_message& check_authentication( | 174 | basic_openid_message& check_authentication( |
175 | basic_openid_message& oum,const basic_openid_message& inm); | 175 | basic_openid_message& oum,const basic_openid_message& inm); |
176 | /** | 176 | /** |
177 | * @} | 177 | * @} |
178 | */ | 178 | */ |
179 | 179 | ||
180 | /** | 180 | /** |
181 | * Verify return_to url. The default implementation checks whether | 181 | * Verify return_to url. The default implementation checks whether |
182 | * return_to URI matches the realm | 182 | * return_to URI matches the realm |
183 | * @throw bad_realm in case of invalid realm | 183 | * @throw bad_realm in case of invalid realm |
184 | * @throw bad_return_to if return_to doesn't match the realm | 184 | * @throw bad_return_to if return_to doesn't match the realm |
185 | * @see verify_op::verify_return_to() | 185 | * @see verify_OP::verify_return_to() |
186 | */ | 186 | */ |
187 | virtual void verify_return_to(); | 187 | virtual void verify_return_to(); |
188 | 188 | ||
189 | /** | 189 | /** |
190 | * @name Global persistent store API | 190 | * @name Global persistent store API |
191 | * These functions are related to the associations with RPs storage | 191 | * These functions are related to the associations with RPs storage |
192 | * and retrieval and nonce management. | 192 | * and retrieval and nonce management. |
193 | * @{ | 193 | * @{ |
194 | */ | 194 | */ |
195 | /** | 195 | /** |
196 | * Allocate association. | 196 | * Allocate association. |
197 | * @param type association type | 197 | * @param type association type |
198 | * @param kl association key length | 198 | * @param kl association key length |
199 | * @param sl true if the association is stateless | 199 | * @param sl true if the association is stateless |
200 | * @return association object | 200 | * @return association object |
201 | */ | 201 | */ |
202 | virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0; | 202 | virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0; |
203 | /** | 203 | /** |
204 | * Retrieve valid unexpired association | 204 | * Retrieve valid unexpired association |
205 | * @param handle association handle | 205 | * @param handle association handle |
206 | * @return association object | 206 | * @return association object |
207 | */ | 207 | */ |
208 | virtual assoc_t retrieve_assoc(const string& handle) = 0; | 208 | virtual assoc_t retrieve_assoc(const string& handle) = 0; |
209 | /** | 209 | /** |
210 | * Allocate nonce. | 210 | * Allocate nonce. |
211 | * @param nonce input-output parameter containing timestamp part of | 211 | * @param nonce input-output parameter containing timestamp part of |
212 | * the nonce on input | 212 | * the nonce on input |
213 | * @param sl true if the nonce is | 213 | * @param sl true if the nonce is |
214 | * @return reference to nonce | 214 | * @return reference to nonce |
215 | * @throw failed_lookup if no such valid unexpired association | 215 | * @throw failed_lookup if no such valid unexpired association |
216 | * could be retrieved | 216 | * could be retrieved |
217 | */ | 217 | */ |
218 | virtual string& alloc_nonce(string& nonce) = 0; | 218 | virtual string& alloc_nonce(string& nonce) = 0; |
219 | /** | 219 | /** |
220 | * Check nonce validity | 220 | * Check nonce validity |
221 | * @param nonce nonce to check | 221 | * @param nonce nonce to check |
222 | * @return true if nonce found and isn't yet invalidated | 222 | * @return true if nonce found and isn't yet invalidated |
223 | */ | 223 | */ |
224 | virtual bool check_nonce(const string& nonce) = 0; | 224 | virtual bool check_nonce(const string& nonce) = 0; |
225 | /** | 225 | /** |
226 | * Invalidate nonce | 226 | * Invalidate nonce |
227 | * @param nonce nonce to check | 227 | * @param nonce nonce to check |
228 | */ | 228 | */ |
229 | virtual void invalidate_nonce(const string& nonce) = 0; | 229 | virtual void invalidate_nonce(const string& nonce) = 0; |
230 | /** | 230 | /** |
231 | * @} | 231 | * @} |
232 | */ | 232 | */ |
233 | 233 | ||
diff --git a/include/opkele/verify_op.h b/include/opkele/verify_op.h index 6b94240..9e29bac 100644 --- a/include/opkele/verify_op.h +++ b/include/opkele/verify_op.h | |||
@@ -1,26 +1,26 @@ | |||
1 | #ifndef __OPKELE_VERIFY_OP_H | 1 | #ifndef __OPKELE_VERIFY_OP_H |
2 | #define __OPKELE_VERIFY_OP_H | 2 | #define __OPKELE_VERIFY_OP_H |
3 | 3 | ||
4 | #include <opkele/basic_op.h> | 4 | #include <opkele/basic_op.h> |
5 | 5 | ||
6 | namespace opkele { | 6 | namespace opkele { |
7 | 7 | ||
8 | /** | 8 | /** |
9 | * The OP implementation that does discovery verification on RP | 9 | * The OP implementation that does discovery verification on RP |
10 | */ | 10 | */ |
11 | class verify_op : public basic_OP { | 11 | class verify_OP : public basic_OP { |
12 | public: | 12 | public: |
13 | 13 | ||
14 | /** | 14 | /** |
15 | * In addition to basic_OP::verify_return_to() functionality this | 15 | * In addition to basic_OP::verify_return_to() functionality this |
16 | * implementation does the discovery on RP to see if return_to matches | 16 | * implementation does the discovery on RP to see if return_to matches |
17 | * the realm | 17 | * the realm |
18 | * @throw bad_return_to in case we fail to discover corresponding | 18 | * @throw bad_return_to in case we fail to discover corresponding |
19 | * service endpoint | 19 | * service endpoint |
20 | */ | 20 | */ |
21 | void verify_return_to(); | 21 | void verify_return_to(); |
22 | }; | 22 | }; |
23 | 23 | ||
24 | } | 24 | } |
25 | 25 | ||
26 | #endif /* __OPKELE_VERIFY_OP_H */ | 26 | #endif /* __OPKELE_VERIFY_OP_H */ |