summaryrefslogtreecommitdiffabout
path: root/include/opkele/consumer.h
Unidiff
Diffstat (limited to 'include/opkele/consumer.h') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/consumer.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index fdb6119..042e2d1 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -68,75 +68,82 @@ namespace opkele {
68 68
69 /** 69 /**
70 * perform the associate request to OpenID server. 70 * perform the associate request to OpenID server.
71 * @param server the OpenID server 71 * @param server the OpenID server
72 * @return the auto_ptr<> for the newly allocated association_t 72 * @return the auto_ptr<> for the newly allocated association_t
73 * object, representing established association 73 * object, representing established association
74 * @throw exception in case of error 74 * @throw exception in case of error
75 */ 75 */
76 assoc_t associate(const string& server); 76 assoc_t associate(const string& server);
77 /** 77 /**
78 * prepare the parameters for the checkid_immediate 78 * prepare the parameters for the checkid_immediate
79 * request. 79 * request.
80 * @param identity the identity to verify 80 * @param identity the identity to verify
81 * @param return_to the return_to url to pass with the request 81 * @param return_to the return_to url to pass with the request
82 * @param trust_root the trust root to advertise with the request 82 * @param trust_root the trust root to advertise with the request
83 * @param ext pointer to an extension(s) hooks object 83 * @param ext pointer to an extension(s) hooks object
84 * @return the location string 84 * @return the location string
85 * @throw exception in case of error 85 * @throw exception in case of error
86 */ 86 */
87 virtual string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0); 87 virtual string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
88 /** 88 /**
89 * prepare the parameters for the checkid_setup 89 * prepare the parameters for the checkid_setup
90 * request. 90 * request.
91 * @param identity the identity to verify 91 * @param identity the identity to verify
92 * @param return_to the return_to url to pass with the request 92 * @param return_to the return_to url to pass with the request
93 * @param trust_root the trust root to advertise with the request 93 * @param trust_root the trust root to advertise with the request
94 * @param ext pointer to an extension(s) hooks object 94 * @param ext pointer to an extension(s) hooks object
95 * @return the location string 95 * @return the location string
96 * @throw exception in case of error 96 * @throw exception in case of error
97 */ 97 */
98 virtual string checkid_setup(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0); 98 virtual string checkid_setup(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
99 /** 99 /**
100 * the actual implementation behind checkid_immediate() and 100 * the actual implementation behind checkid_immediate() and
101 * checkid_setup() functions. 101 * checkid_setup() functions.
102 * @param mode checkid_* mode - either mode_checkid_immediate or mode_checkid_setup 102 * @param mode checkid_* mode - either mode_checkid_immediate or mode_checkid_setup
103 * @param identity the identity to verify 103 * @param identity the identity to verify
104 * @param return_to the return_to url to pass with the request 104 * @param return_to the return_to url to pass with the request
105 * @param trust_root the trust root to advertise with the request 105 * @param trust_root the trust root to advertise with the request
106 * @param ext pointer to an extension(s) hooks object 106 * @param ext pointer to an extension(s) hooks object
107 * @return the location string 107 * @return the location string
108 * @throw exception in case of error 108 * @throw exception in case of error
109 */ 109 */
110 virtual string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0); 110 virtual string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0);
111 /** 111 /**
112 * verify the id_res response 112 * verify the id_res response
113 * @param pin the response parameters 113 * @param pin the response parameters
114 * @param identity the identity being checked (if not specified, 114 * @param identity the identity being checked (if not specified,
115 * @param ext pointer to an extension(s) hooks object 115 * @param ext pointer to an extension(s) hooks object
116 * extracted from the openid.identity parameter 116 * extracted from the openid.identity parameter
117 * @throw id_res_mismatch in case of signature mismatch 117 * @throw id_res_mismatch in case of signature mismatch
118 * @throw id_res_setup in case of openid.user_setup_url failure 118 * @throw id_res_setup in case of openid.user_setup_url failure
119 * (supposedly checkid_immediate only) 119 * (supposedly checkid_immediate only)
120 * @throw id_res_failed in case of failure 120 * @throw id_res_failed in case of failure
121 * @throw exception in case of other failures 121 * @throw exception in case of other failures
122 */ 122 */
123 virtual void id_res(const params_t& pin,const string& identity="",extension_t *ext=0); 123 virtual void id_res(const params_t& pin,const string& identity="",extension_t *ext=0);
124 /** 124 /**
125 * perform a check_authentication request. 125 * perform a check_authentication request.
126 * @param server the OpenID server 126 * @param server the OpenID server
127 * @param p request parameters 127 * @param p request parameters
128 */ 128 */
129 void check_authentication(const string& server,const params_t& p); 129 void check_authentication(const string& server,const params_t& p);
130 130
131 /** 131 /**
132 * make URL canonical, by adding http:// and trailing slash, if needed. 132 * normalize URL by adding http:// and trailing slash if needed.
133 * @param url
134 * @return normalized url
135 */
136 static string normalize(const string& url);
137
138 /**
139 * Canonicalize URL, by normalizing its appearance and following redirects.
133 * @param url 140 * @param url
134 * @return canonicalized url 141 * @return canonicalized url
135 */ 142 */
136 static string canonicalize(const string& url); 143 virtual string canonicalize(const string& url);
137 144
138 }; 145 };
139 146
140} 147}
141 148
142#endif /* __OPKELE_CONSUMER_H */ 149#endif /* __OPKELE_CONSUMER_H */