diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:06 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:06 +0000 |
| commit | c56ba110ea8f65165423bb343f202e9f7ef44bcd (patch) | |
| tree | ea774afb6b636e83fdf18826c757edfd3b6f5d26 | |
| parent | 77495e50d3fe477290dbb2aa16b3694d23f310f1 (diff) | |
| download | lasso-c56ba110ea8f65165423bb343f202e9f7ef44bcd.tar.gz lasso-c56ba110ea8f65165423bb343f202e9f7ef44bcd.tar.xz lasso-c56ba110ea8f65165423bb343f202e9f7ef44bcd.zip | |
Complete documentation for lasso_login_build_artifact_msg
* lasso/id-ff/login.c:
add all possible return codes with meaning.
| -rw-r--r-- | lasso/id-ff/login.c | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index 5e94d2af..6bd8cb97 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -793,7 +793,17 @@ lasso_login_build_assertion_artifact(LassoLogin *login) * the artifact are stored in @msg_url (REDIRECT) or @msg_url, @msg_body and * @msg_relayState (POST). * - * Return value: 0 on success; or a negative value otherwise. + * Return value: 0 on success; or + * LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object, + * LASSO_PROFILE_ERROR_MISSING_REMOTE_PROVIDERID if no remote provider ID was setup in the login + * profile object, it's usually done by lasso_login_process_authn_request_msg, + * LASSO_PROFILE_ERROR_INVALID_HTTP_METHOD if the HTTP method is neither LASSO_HTTP_METHOD_REDIRECT + * or LASSO_HTTP_METHOD_POST (ID-FF 1.2 case) or neither LASSO_HTTP_METHOD_ARTIFACT_GET or + * LASSO_HTTP_METHOD_ARTIFACT_POST (SAML 2.0 case) for SAML 2.0), + * LASSO_PROFILE_ERROR_INVALID_PROTOCOLPROFILE if the current protocolProfile is not + * LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_ART (only for ID-FF 1.2), + * LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the remote provider is not known to our server object. + * **/ gint lasso_login_build_artifact_msg(LassoLogin *login, LassoHttpMethod http_method) |