diff options
| author | Frederic Peters <fpeters@entrouvert.com> | 2004-12-22 12:48:05 +0000 |
|---|---|---|
| committer | Frederic Peters <fpeters@entrouvert.com> | 2004-12-22 12:48:05 +0000 |
| commit | f46dbaadb7fec17f9bce034cd7352b700068de98 (patch) | |
| tree | 8d86f21ca7bff449fb97708044553464d5bc237e /docs/reference/tmpl | |
| parent | 23b4a410c6b5d981fc51bc6c3d274a632471ef5e (diff) | |
| download | lasso-f46dbaadb7fec17f9bce034cd7352b700068de98.tar.gz lasso-f46dbaadb7fec17f9bce034cd7352b700068de98.tar.xz lasso-f46dbaadb7fec17f9bce034cd7352b700068de98.zip | |
Minimal documentation for #LassoProfile and #LassoLogin
Diffstat (limited to 'docs/reference/tmpl')
| -rw-r--r-- | docs/reference/tmpl/login.sgml | 230 | ||||
| -rw-r--r-- | docs/reference/tmpl/profile.sgml | 152 |
2 files changed, 382 insertions, 0 deletions
diff --git a/docs/reference/tmpl/login.sgml b/docs/reference/tmpl/login.sgml new file mode 100644 index 00000000..6305d091 --- /dev/null +++ b/docs/reference/tmpl/login.sgml @@ -0,0 +1,230 @@ +<!-- ##### SECTION Title ##### --> +LassoLogin + +<!-- ##### SECTION Short_Description ##### --> +Single Sign-On and Federation Profile + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT LassoLogin ##### --> +<para> + +</para> + +@protocolProfile: +@assertionArtifact: +@assertion: + +<!-- ##### ENUM lassoLoginProtocolProfile ##### --> +<para> + +</para> + +@LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_ART: +@LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_POST: + +<!-- ##### FUNCTION lasso_login_new ##### --> +<para> + +</para> + +@server: +@Returns: + + +<!-- ##### FUNCTION lasso_login_destroy ##### --> +<para> + +</para> + +@login: + + +<!-- ##### FUNCTION lasso_login_dump ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_new_from_dump ##### --> +<para> + +</para> + +@server: +@dump: +@Returns: + + +<!-- ##### FUNCTION lasso_login_accept_sso ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_artifact_msg ##### --> +<para> + +</para> + +@login: +@http_method: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_assertion ##### --> +<para> + +</para> + +@login: +@authenticationMethod: +@authenticationInstant: +@reauthenticateOnOrAfter: +@notBefore: +@notOnOrAfter: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_authn_request_msg ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_authn_response_msg ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_request_msg ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_build_response_msg ##### --> +<para> + +</para> + +@login: +@remote_providerID: +@Returns: + + +<!-- ##### FUNCTION lasso_login_init_authn_request ##### --> +<para> + +</para> + +@login: +@remote_providerID: +@http_method: +@Returns: + + +<!-- ##### FUNCTION lasso_login_init_request ##### --> +<para> + +</para> + +@login: +@response_msg: +@response_http_method: +@Returns: + + +<!-- ##### FUNCTION lasso_login_must_ask_for_consent ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_must_authenticate ##### --> +<para> + +</para> + +@login: +@Returns: + + +<!-- ##### FUNCTION lasso_login_process_authn_request_msg ##### --> +<para> + +</para> + +@login: +@authn_request_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_login_process_authn_response_msg ##### --> +<para> + +</para> + +@login: +@authn_response_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_login_process_request_msg ##### --> +<para> + +</para> + +@login: +@request_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_login_process_response_msg ##### --> +<para> + +</para> + +@login: +@response_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_login_validate_request_msg ##### --> +<para> + +</para> + +@login: +@authentication_result: +@is_consent_obtained: +@Returns: + + diff --git a/docs/reference/tmpl/profile.sgml b/docs/reference/tmpl/profile.sgml new file mode 100644 index 00000000..6ab97988 --- /dev/null +++ b/docs/reference/tmpl/profile.sgml @@ -0,0 +1,152 @@ +<!-- ##### SECTION Title ##### --> +LassoProfile + +<!-- ##### SECTION Short_Description ##### --> +Base class for all ID-FF profiles + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM lassoMessageType ##### --> +<para> + +</para> + +@LASSO_MESSAGE_TYPE_NONE: +@LASSO_MESSAGE_TYPE_AUTHN_REQUEST: +@LASSO_MESSAGE_TYPE_AUTHN_RESPONSE: +@LASSO_MESSAGE_TYPE_REQUEST: +@LASSO_MESSAGE_TYPE_RESPONSE: +@LASSO_MESSAGE_TYPE_ARTIFACT: + +<!-- ##### ENUM lassoRequestType ##### --> +<para> + +</para> + +@LASSO_REQUEST_TYPE_INVALID: +@LASSO_REQUEST_TYPE_LOGIN: +@LASSO_REQUEST_TYPE_LOGOUT: +@LASSO_REQUEST_TYPE_DEFEDERATION: +@LASSO_REQUEST_TYPE_NAME_REGISTRATION: +@LASSO_REQUEST_TYPE_NAME_IDENTIFIER_MAPPING: +@LASSO_REQUEST_TYPE_LECP: + +<!-- ##### STRUCT LassoProfile ##### --> +<para> + +</para> + +@server: +@request: +@response: +@nameIdentifier: +@remote_providerID: +@msg_url: +@msg_body: +@msg_relayState: + +<!-- ##### FUNCTION lasso_profile_get_identity ##### --> +<para> + +</para> + +@profile: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_get_session ##### --> +<para> + +</para> + +@profile: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_is_identity_dirty ##### --> +<para> + +</para> + +@profile: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_is_session_dirty ##### --> +<para> + +</para> + +@profile: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_set_identity_from_dump ##### --> +<para> + +</para> + +@profile: +@dump: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_set_response_status ##### --> +<para> + +</para> + +@profile: +@statusCodeValue: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_set_session_from_dump ##### --> +<para> + +</para> + +@profile: +@dump: +@Returns: +<!-- # Unused Parameters # --> +@ctx: + + +<!-- ##### FUNCTION lasso_profile_get_request_type_from_soap_msg ##### --> +<para> + +</para> + +@soap: +@Returns: + + +<!-- ##### FUNCTION lasso_profile_is_liberty_query ##### --> +<para> + +</para> + +@query: +@Returns: + + |
