From a45b383cd0f6d406f06c6b0b0ce99bdb75e27f99 Mon Sep 17 00:00:00 2001 From: Benjamin Dauvergne Date: Mon, 1 Feb 2010 19:50:03 +0000 Subject: Core: document return values of lasso_login_validate_request_msg --- lasso/id-ff/login.c | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index 67d6b4c3..a8037fe0 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -2199,7 +2199,23 @@ lasso_login_dump(LassoLogin *login) * * Initializes a response to the authentication request received. * - * 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_LOGIN_ERROR_REQUEST_DENIED if @authentication_result if FALSE, + * #LASSO_LOGIN_ERROR_INVALID_SIGNATURE if signature validation of the request + * failed, + * #LASSO_LOGIN_ERROR_UNSIGNED_AUTHN_REQUEST if no signature was present on the + * request, + * #LASSO_LOGIN_ERROR_FEDERATION_NOT_FOUND if federation policy is + * #LASSO_LIB_NAMEID_POLICY_TYPE_NONE and no federation was found in the #LassoIdentity object + * (ID-FF 1.2 case) + * #LASSO_LOGIN_ERROR_INVALID_NAMEIDPOLICY if request policy is not one of + * #LASSO_LIB_NAMEID_POLICY_TYPE_FEDERATED or #LASSO_LIB_NAMEID_POLICY_TYPE_ANY (ID-FF 1.2 case) or if no NameID policy was defined or the AllowCreate request flag is FALSE (SAML 2.0 case), + * #LASSO_LOGIN_ERROR_CONSENT_NOT_OBTAINED if @is_consent_obtained is FALSE and + * conssent was necessary (for example if the request does not communicate that consent was already + * obtained from the user), + * #LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the requesting provider is unknown, + * **/ int lasso_login_validate_request_msg(LassoLogin *login, gboolean authentication_result, -- cgit