From f46dbaadb7fec17f9bce034cd7352b700068de98 Mon Sep 17 00:00:00 2001 From: Frederic Peters Date: Wed, 22 Dec 2004 12:48:05 +0000 Subject: Minimal documentation for #LassoProfile and #LassoLogin --- docs/reference/lasso-sections.txt | 178 ++++++++++++++--------------- docs/reference/tmpl/login.sgml | 230 ++++++++++++++++++++++++++++++++++++++ docs/reference/tmpl/profile.sgml | 152 +++++++++++++++++++++++++ 3 files changed, 469 insertions(+), 91 deletions(-) create mode 100644 docs/reference/tmpl/login.sgml create mode 100644 docs/reference/tmpl/profile.sgml (limited to 'docs') diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index 0d526f75..afdd4c7d 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -50,6 +50,93 @@ LASSO_IS_SERVER_CLASS LASSO_SERVER_GET_CLASS +
+profile +LassoProfile +lassoMessageType +lassoRequestType +LassoProfile +lasso_profile_get_identity +lasso_profile_get_session +lasso_profile_is_identity_dirty +lasso_profile_is_session_dirty +lasso_profile_set_identity_from_dump +lasso_profile_set_response_status +lasso_profile_set_session_from_dump +lasso_profile_get_request_type_from_soap_msg +lasso_profile_is_liberty_query + +LASSO_PROFILE +LASSO_IS_PROFILE +LASSO_TYPE_PROFILE +lasso_profile_get_type +LASSO_PROFILE_CLASS +LASSO_IS_PROFILE_CLASS +LASSO_PROFILE_GET_CLASS +
+ +
+login +LassoLogin +LassoLogin +lassoLoginProtocolProfile +lasso_login_new +lasso_login_destroy +lasso_login_dump +lasso_login_new_from_dump +lasso_login_accept_sso +lasso_login_build_artifact_msg +lasso_login_build_assertion +lasso_login_build_authn_request_msg +lasso_login_build_authn_response_msg +lasso_login_build_request_msg +lasso_login_build_response_msg +lasso_login_init_authn_request +lasso_login_init_request +lasso_login_must_ask_for_consent +lasso_login_must_authenticate +lasso_login_process_authn_request_msg +lasso_login_process_authn_response_msg +lasso_login_process_request_msg +lasso_login_process_response_msg +lasso_login_validate_request_msg + +LASSO_LOGIN +LASSO_IS_LOGIN +LASSO_TYPE_LOGIN +lasso_login_get_type +LASSO_LOGIN_CLASS +LASSO_IS_LOGIN_CLASS +LASSO_LOGIN_GET_CLASS +
+ +
+logout +LassoLogout +LassoLogout +LassoLogoutClass +lasso_logout_new +lasso_logout_new_from_dump +lasso_logout_build_request_msg +lasso_logout_build_response_msg +lasso_logout_destroy +lasso_logout_dump +lasso_logout_get_next_providerID +lasso_logout_init_request +lasso_logout_process_request_msg +lasso_logout_process_response_msg +lasso_logout_reset_providerID_index +lasso_logout_validate_request + +LASSO_LOGOUT +LASSO_IS_LOGOUT +LASSO_TYPE_LOGOUT +lasso_logout_get_type +LASSO_LOGOUT_CLASS +LASSO_IS_LOGOUT_CLASS +LASSO_LOGOUT_GET_CLASS +
+
lib_assertion LassoLibAssertion @@ -1072,97 +1159,6 @@ LASSO_IS_IDENTITY_CLASS LASSO_IDENTITY_GET_CLASS
-
-login -lassoLoginProtocolProfile -LassoLogin -LassoLogin -LassoLoginClass -lasso_login_new -lasso_login_new_from_dump -lasso_login_accept_sso -lasso_login_build_artifact_msg -lasso_login_build_authn_request_msg -lasso_login_build_authn_response_msg -lasso_login_build_request_msg -lasso_login_build_response_msg -lasso_login_destroy -lasso_login_dump -lasso_login_init_authn_request -lasso_login_init_request -lasso_login_must_authenticate -lasso_login_process_authn_request_msg -lasso_login_process_authn_response_msg -lasso_login_process_request_msg -lasso_login_process_response_msg - -LASSO_LOGIN -LASSO_IS_LOGIN -LASSO_TYPE_LOGIN -lasso_login_get_type -LASSO_LOGIN_CLASS -LASSO_IS_LOGIN_CLASS -LASSO_LOGIN_GET_CLASS -
- -
-logout -LassoLogout -LassoLogout -LassoLogoutClass -lasso_logout_new -lasso_logout_new_from_dump -lasso_logout_build_request_msg -lasso_logout_build_response_msg -lasso_logout_destroy -lasso_logout_dump -lasso_logout_get_next_providerID -lasso_logout_init_request -lasso_logout_process_request_msg -lasso_logout_process_response_msg -lasso_logout_reset_providerID_index -lasso_logout_validate_request - -LASSO_LOGOUT -LASSO_IS_LOGOUT -LASSO_TYPE_LOGOUT -lasso_logout_get_type -LASSO_LOGOUT_CLASS -LASSO_IS_LOGOUT_CLASS -LASSO_LOGOUT_GET_CLASS -
- -
-profile -LassoProfilePrivate -lassoProviderType -lassoMessageType -lasso_profile_get_request_type_from_soap_msg -LassoProfile -LassoProfile -LassoProfileClass -lasso_profile_new -lasso_profile_dump -lasso_profile_get_identity -lasso_profile_get_session -lasso_profile_is_identity_dirty -lasso_profile_is_session_dirty -lasso_profile_set_identity -lasso_profile_set_identity_from_dump -lasso_profile_set_session -lasso_profile_set_session_from_dump -lasso_profile_set_remote_providerID -lasso_profile_set_response_status - -LASSO_PROFILE -LASSO_IS_PROFILE -LASSO_TYPE_PROFILE -lasso_profile_get_type -LASSO_PROFILE_CLASS -LASSO_IS_PROFILE_CLASS -LASSO_PROFILE_GET_CLASS -
-
session LassoSessionPrivate 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 @@ + +LassoLogin + + +Single Sign-On and Federation Profile + + + + + + + + + + + + + + + + +@protocolProfile: +@assertionArtifact: +@assertion: + + + + + + +@LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_ART: +@LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_POST: + + + + + + +@server: +@Returns: + + + + + + + +@login: + + + + + + + +@login: +@Returns: + + + + + + + +@server: +@dump: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@http_method: +@Returns: + + + + + + + +@login: +@authenticationMethod: +@authenticationInstant: +@reauthenticateOnOrAfter: +@notBefore: +@notOnOrAfter: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@remote_providerID: +@Returns: + + + + + + + +@login: +@remote_providerID: +@http_method: +@Returns: + + + + + + + +@login: +@response_msg: +@response_http_method: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@Returns: + + + + + + + +@login: +@authn_request_msg: +@Returns: + + + + + + + +@login: +@authn_response_msg: +@Returns: + + + + + + + +@login: +@request_msg: +@Returns: + + + + + + + +@login: +@response_msg: +@Returns: + + + + + + + +@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 @@ + +LassoProfile + + +Base class for all ID-FF profiles + + + + + + + + + + + + + + + + +@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: + + + + + + +@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: + + + + + + +@server: +@request: +@response: +@nameIdentifier: +@remote_providerID: +@msg_url: +@msg_body: +@msg_relayState: + + + + + + +@profile: +@Returns: + +@ctx: + + + + + + + +@profile: +@Returns: + +@ctx: + + + + + + + +@profile: +@Returns: + +@ctx: + + + + + + + +@profile: +@Returns: + +@ctx: + + + + + + + +@profile: +@dump: +@Returns: + +@ctx: + + + + + + + +@profile: +@statusCodeValue: + +@ctx: + + + + + + + +@profile: +@dump: +@Returns: + +@ctx: + + + + + + + +@soap: +@Returns: + + + + + + + +@query: +@Returns: + + -- cgit