diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2010-03-27 17:39:56 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2010-03-27 17:39:56 +0000 |
| commit | f09332e9d6f8ab1f4297a8fe8cef2fb42f7d6137 (patch) | |
| tree | dbd75cce878a996b6968613a437f4da68b89539e /lasso/id-ff/login.c | |
| parent | 584fe403533bc6afcfe29eb122508c22e400c4c7 (diff) | |
| download | lasso-f09332e9d6f8ab1f4297a8fe8cef2fb42f7d6137.tar.gz lasso-f09332e9d6f8ab1f4297a8fe8cef2fb42f7d6137.tar.xz lasso-f09332e9d6f8ab1f4297a8fe8cef2fb42f7d6137.zip | |
ID-FF&SAML2: complete documentation of lasso_login_build_assertion
Diffstat (limited to 'lasso/id-ff/login.c')
| -rw-r--r-- | lasso/id-ff/login.c | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index 8940b46b..a154b90d 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -246,8 +246,6 @@ static void lasso_login_build_assertion_artifact(LassoLogin *login); /* static methods/functions */ /*****************************************************************************/ - - /** * lasso_login_build_assertion: * @login: a #LassoLogin @@ -261,10 +259,34 @@ static void lasso_login_build_assertion_artifact(LassoLogin *login); * @notOnOrAfter may be NULL. If @authenticationInstant is NULL, the current * time will be used. Time values must be encoded in UTC. * + * Construct the authentication assertion for the response. It must be called after validating the + * request using lasso_login_validate_request_msg(). The created assertion is accessed using + * lasso_login_get_assertion(). + * * Return value: 0 on success; or - * LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object, - * LASSO_PROFILE_ERROR_IDENTITY_NOT_FOUND if no identity object was found in the login profile - * object. + * <itemizedlist> + * <listitem><para> + * #LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object, + * </para></listitem> + * <listitem><para> + * #LASSO_PROFILE_ERROR_IDENTITY_NOT_FOUND if no identity object was found in the login profile object. + * </para></listitem> + * <listitem><para> + * #LASSO_PROFILE_ERROR_MISSING_RESPONSE if no response object is present ( it is normally initialized + * </para></listitem> + * <listitem><para> + * by lasso_login_process_authn_request_msg() ) + * </para></listitem> + * <listitem><para> + * #LASSO_PROFILE_ERROR_FEDERATION_NOT_FOUND if a #LASSO_SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT or #LASSO_SAML2_NAME_IDENTIFIER_FORMAT_ENCRYPTED NameID format is asked and no corresponding federation was found in the #LassoIdentity object, + * </para></listitem> + * <listitem><para> + * #LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if encryption is needed and the request issuing provider is unknown (it as not been registered in the #LassoServer object), + * </para></listitem> + * <listitem><para> + * #LASSO_DS_ERROR_ENCRYPTION_FAILED if encryption is needed but it failed, + * </para></listitem> + * </itemizedlist> * **/ int |