diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/lasso-sections.txt | 178 | ||||
| -rw-r--r-- | docs/reference/tmpl/login.sgml | 230 | ||||
| -rw-r--r-- | docs/reference/tmpl/profile.sgml | 152 |
3 files changed, 469 insertions, 91 deletions
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 @@ -51,6 +51,93 @@ LASSO_SERVER_GET_CLASS </SECTION> <SECTION> +<FILE>profile</FILE> +<TITLE>LassoProfile</TITLE> +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 +<SUBSECTION Standard> +LASSO_PROFILE +LASSO_IS_PROFILE +LASSO_TYPE_PROFILE +lasso_profile_get_type +LASSO_PROFILE_CLASS +LASSO_IS_PROFILE_CLASS +LASSO_PROFILE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>login</FILE> +<TITLE>LassoLogin</TITLE> +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 +<SUBSECTION Standard> +LASSO_LOGIN +LASSO_IS_LOGIN +LASSO_TYPE_LOGIN +lasso_login_get_type +LASSO_LOGIN_CLASS +LASSO_IS_LOGIN_CLASS +LASSO_LOGIN_GET_CLASS +</SECTION> + +<SECTION> +<FILE>logout</FILE> +<TITLE>LassoLogout</TITLE> +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 +<SUBSECTION Standard> +LASSO_LOGOUT +LASSO_IS_LOGOUT +LASSO_TYPE_LOGOUT +lasso_logout_get_type +LASSO_LOGOUT_CLASS +LASSO_IS_LOGOUT_CLASS +LASSO_LOGOUT_GET_CLASS +</SECTION> + +<SECTION> <FILE>lib_assertion</FILE> <TITLE>LassoLibAssertion</TITLE> LassoLibAssertion @@ -1073,97 +1160,6 @@ LASSO_IDENTITY_GET_CLASS </SECTION> <SECTION> -<FILE>login</FILE> -lassoLoginProtocolProfile -<TITLE>LassoLogin</TITLE> -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 -<SUBSECTION Standard> -LASSO_LOGIN -LASSO_IS_LOGIN -LASSO_TYPE_LOGIN -lasso_login_get_type -LASSO_LOGIN_CLASS -LASSO_IS_LOGIN_CLASS -LASSO_LOGIN_GET_CLASS -</SECTION> - -<SECTION> -<FILE>logout</FILE> -<TITLE>LassoLogout</TITLE> -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 -<SUBSECTION Standard> -LASSO_LOGOUT -LASSO_IS_LOGOUT -LASSO_TYPE_LOGOUT -lasso_logout_get_type -LASSO_LOGOUT_CLASS -LASSO_IS_LOGOUT_CLASS -LASSO_LOGOUT_GET_CLASS -</SECTION> - -<SECTION> -<FILE>profile</FILE> -LassoProfilePrivate -lassoProviderType -lassoMessageType -lasso_profile_get_request_type_from_soap_msg -<TITLE>LassoProfile</TITLE> -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 -<SUBSECTION Standard> -LASSO_PROFILE -LASSO_IS_PROFILE -LASSO_TYPE_PROFILE -lasso_profile_get_type -LASSO_PROFILE_CLASS -LASSO_IS_PROFILE_CLASS -LASSO_PROFILE_GET_CLASS -</SECTION> - -<SECTION> <FILE>session</FILE> LassoSessionPrivate <TITLE>LassoSession</TITLE> 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: + + |