diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:20 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:20 +0000 |
| commit | aec28fdac6fd87cb486e732fe5254b8affc687ed (patch) | |
| tree | 663d8e1c59443774ead95842ebdc617d5e208518 | |
| parent | c7ec6c1ed9fccd50ffa206d3dfa9a36fc9c9acf4 (diff) | |
| download | lasso-aec28fdac6fd87cb486e732fe5254b8affc687ed.tar.gz lasso-aec28fdac6fd87cb486e732fe5254b8affc687ed.tar.xz lasso-aec28fdac6fd87cb486e732fe5254b8affc687ed.zip | |
Complete documentation of lasso_login_init_request
* lasso/id-ff/login.c:
add precision on usage. add all possible return codes with meanings.
| -rw-r--r-- | lasso/id-ff/login.c | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index dbc065a2..ed33c65a 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -1435,10 +1435,26 @@ lasso_login_init_authn_request(LassoLogin *login, const gchar *remote_providerID * @response_http_method: the method used to receive the authentication * response * - * Initializes an artifact request. @response_msg is either the query string + * Initializes an artifact request. @response_msg is either the query string * (in redirect mode) or the form LAREQ field (in browser-post mode). + * It should only be used if you received an artifact message, @response_msg must be content of the + * artifact field for the POST artifact binding of the query string for the REDIRECT artifact + * binding. You must set the @response_http_method argument according to the way you received the + * artifact message. + * + * Return value: 0 on success; or a + * LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object, + * LASSO_PARAM_ERROR_INVALID_VALUE if @response_msg is NULL, + * LASSO_PROFILE_ERROR_INVALID_HTTP_METHOD if the HTTP method is neither LASSO_HTTP_METHOD_REDIRECT + * or LASSO_HTTP_METHOD_POST (in the ID-FF 1.2 case) or neither LASSO_HTTP_METHOD_ARTIFACT_GET or + * LASSO_HTTP_METHOD_ARTIFACT_POST (in the SAML 2.0 case), + * LASSO_PROFILE_ERROR_MISSING_ARTIFACT if no artifact field was found in the query string (only + * possible for the LASSO_HTTP_METHOD_REDIRECT case), + * LASSO_PROFILE_ERROR_INVALID_ARTIFACT if decoding of the artifact failed -- whether because + * the base64 encoding is invalid or because the type code is wrong --, + * LASSO_PROFILE_ERROR_MISSING_REMOTE_PROVIDERID if no provider ID could be found corresponding to + * the hash contained in the artifact. * - * Return value: 0 on success; or a negative value otherwise. **/ gint lasso_login_init_request(LassoLogin *login, gchar *response_msg, |