From 493236dc228d267296978fda743246cb5dc3c8b9 Mon Sep 17 00:00:00 2001 From: Frederic Peters Date: Wed, 22 Dec 2004 21:38:06 +0000 Subject: documenting #LassoIdentity and #LassoFederation --- docs/reference/lasso-sections.txt | 252 +++++++++------------------------- docs/reference/lasso.sgml | 2 +- docs/reference/tmpl/defederation.sgml | 4 +- docs/reference/tmpl/federation.sgml | 83 +++++++++++ docs/reference/tmpl/identity.sgml | 97 +++++++++++++ docs/reference/tmpl/session.sgml | 123 +++++++++++++++++ 6 files changed, 375 insertions(+), 186 deletions(-) create mode 100644 docs/reference/tmpl/federation.sgml create mode 100644 docs/reference/tmpl/identity.sgml create mode 100644 docs/reference/tmpl/session.sgml (limited to 'docs/reference') diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index f4dac8e7..776e9402 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -50,6 +50,73 @@ LASSO_IS_SERVER_CLASS LASSO_SERVER_GET_CLASS +
+identity +LassoIdentity +LassoIdentity +LassoIdentityClass +lasso_identity_new +lasso_identity_new_from_dump +lasso_identity_destroy +lasso_identity_dump +lasso_identity_add_federation +lasso_identity_get_federation +lasso_identity_remove_federation + +LASSO_IDENTITY +LASSO_IS_IDENTITY +LASSO_TYPE_IDENTITY +lasso_identity_get_type +LASSO_IDENTITY_CLASS +LASSO_IS_IDENTITY_CLASS +LASSO_IDENTITY_GET_CLASS +
+ +
+session +LassoSession +LassoSession +LassoSessionClass +lasso_session_new +lasso_session_new_from_dump +lasso_session_add_assertion +lasso_session_destroy +lasso_session_dump +lasso_session_get_assertion +lasso_session_get_authentication_method +lasso_session_get_first_providerID +lasso_session_get_provider_index +lasso_session_remove_assertion + +LASSO_SESSION +LASSO_IS_SESSION +LASSO_TYPE_SESSION +lasso_session_get_type +LASSO_SESSION_CLASS +LASSO_IS_SESSION_CLASS +LASSO_SESSION_GET_CLASS +
+ +
+federation +LassoFederation +LassoFederation +lasso_federation_new +lasso_federation_destroy +lasso_federation_build_local_name_identifier +lasso_federation_set_local_name_identifier +lasso_federation_set_remote_name_identifier +lasso_federation_verify_name_identifier + +LASSO_FEDERATION +LASSO_IS_FEDERATION +LASSO_TYPE_FEDERATION +lasso_federation_get_type +LASSO_FEDERATION_CLASS +LASSO_IS_FEDERATION_CLASS +LASSO_FEDERATION_GET_CLASS +
+
profile LassoProfile @@ -743,9 +810,8 @@ LASSO_SAMLP_STATUS_CODE_GET_CLASS
-xml +node lassoNodeExportType -LassoNodePrivate LassoNode lassoSignatureMethod LassoNode @@ -823,22 +889,6 @@ LASSO_IS_LIB_FEDERATION_TERMINATION_NOTIFICATION_CLASS LASSO_LIB_FEDERATION_TERMINATION_NOTIFICATION_GET_CLASS
-
-lib_idp_provided_name_identifier -LassoLibIDPProvidedNameIdentifier -LassoLibIDPProvidedNameIdentifier -LassoLibIDPProvidedNameIdentifierClass -lasso_lib_idp_provided_name_identifier_new - -LASSO_LIB_IDP_PROVIDED_NAME_IDENTIFIER -LASSO_IS_LIB_IDP_PROVIDED_NAME_IDENTIFIER -LASSO_TYPE_LIB_IDP_PROVIDED_NAME_IDENTIFIER -lasso_lib_idp_provided_name_identifier_get_type -LASSO_LIB_IDP_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_IS_LIB_IDP_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_LIB_IDP_PROVIDED_NAME_IDENTIFIER_GET_CLASS -
-
lib_logout_response LassoLibLogoutResponse @@ -893,22 +943,6 @@ LASSO_IS_LIB_NAME_IDENTIFIER_MAPPING_RESPONSE_CLASS LASSO_LIB_NAME_IDENTIFIER_MAPPING_RESPONSE_GET_CLASS
-
-lib_old_provided_name_identifier -LassoLibOLDProvidedNameIdentifier -LassoLibOLDProvidedNameIdentifier -LassoLibOLDProvidedNameIdentifierClass -lasso_lib_old_provided_name_identifier_new - -LASSO_LIB_OLD_PROVIDED_NAME_IDENTIFIER -LASSO_IS_LIB_OLD_PROVIDED_NAME_IDENTIFIER -LASSO_TYPE_LIB_OLD_PROVIDED_NAME_IDENTIFIER -lasso_lib_old_provided_name_identifier_get_type -LASSO_LIB_OLD_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_IS_LIB_OLD_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_LIB_OLD_PROVIDED_NAME_IDENTIFIER_GET_CLASS -
-
lib_register_name_identifier_request LassoLibRegisterNameIdentifierRequest @@ -946,22 +980,6 @@ LASSO_IS_LIB_REGISTER_NAME_IDENTIFIER_RESPONSE_CLASS LASSO_LIB_REGISTER_NAME_IDENTIFIER_RESPONSE_GET_CLASS
-
-lib_sp_provided_name_identifier -LassoLibSPProvidedNameIdentifier -LassoLibSPProvidedNameIdentifier -LassoLibSPProvidedNameIdentifierClass -lasso_lib_sp_provided_name_identifier_new - -LASSO_LIB_SP_PROVIDED_NAME_IDENTIFIER -LASSO_IS_LIB_SP_PROVIDED_NAME_IDENTIFIER -LASSO_TYPE_LIB_SP_PROVIDED_NAME_IDENTIFIER -lasso_lib_sp_provided_name_identifier_get_type -LASSO_LIB_SP_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_IS_LIB_SP_PROVIDED_NAME_IDENTIFIER_CLASS -LASSO_LIB_SP_PROVIDED_NAME_IDENTIFIER_GET_CLASS -
-
lib_status_response LassoLibStatusResponse @@ -1052,40 +1070,6 @@ LASSO_IS_LIB_AUTHENTICATION_STATEMENT_CLASS LASSO_LIB_AUTHENTICATION_STATEMENT_GET_CLASS
-
-soap-env_body -LassoSoapEnvBody -LassoSoapEnvBody -LassoSoapEnvBodyClass -lasso_soap_env_body_new -lasso_soap_env_body_add_child - -LASSO_SOAP_ENV_BODY -LASSO_IS_SOAP_ENV_BODY -LASSO_TYPE_SOAP_ENV_BODY -lasso_soap_env_body_get_type -LASSO_SOAP_ENV_BODY_CLASS -LASSO_IS_SOAP_ENV_BODY_CLASS -LASSO_SOAP_ENV_BODY_GET_CLASS -
- -
-soap-env_envelope -LassoSoapEnvEnvelope -LassoSoapEnvEnvelope -LassoSoapEnvEnvelopeClass -lasso_soap_env_envelope_new -lasso_soap_env_envelope_set_body - -LASSO_SOAP_ENV_ENVELOPE -LASSO_IS_SOAP_ENV_ENVELOPE -LASSO_TYPE_SOAP_ENV_ENVELOPE -lasso_soap_env_envelope_get_type -LASSO_SOAP_ENV_ENVELOPE_CLASS -LASSO_IS_SOAP_ENV_ENVELOPE_CLASS -LASSO_SOAP_ENV_ENVELOPE_GET_CLASS -
-
lasso lasso_init @@ -1105,54 +1089,6 @@ LASSO_VERSION_SUBMINOR LASSO_VERSION_INFO
-
-federation_termination_notification -LassoFederationTerminationNotification -LassoFederationTerminationNotification -LassoFederationTerminationNotificationClass -lasso_federation_termination_notification_new -lasso_federation_termination_notification_new_from_export - -LASSO_FEDERATION_TERMINATION_NOTIFICATION -LASSO_IS_FEDERATION_TERMINATION_NOTIFICATION -LASSO_TYPE_FEDERATION_TERMINATION_NOTIFICATION -lasso_federation_termination_notification_get_type -LASSO_FEDERATION_TERMINATION_NOTIFICATION_CLASS -LASSO_IS_FEDERATION_TERMINATION_NOTIFICATION_CLASS -LASSO_FEDERATION_TERMINATION_NOTIFICATION_GET_CLASS -
- -
-federation -LASSO_FEDERATION_NODE -LASSO_FEDERATION_REMOTE_PROVIDERID_NODE -LASSO_FEDERATION_LOCAL_NAME_IDENTIFIER_NODE -LASSO_FEDERATION_REMOTE_NAME_IDENTIFIER_NODE -LassoFederation -LassoFederation -LassoFederationClass -lasso_federation_new -lasso_federation_new_from_dump -lasso_federation_copy -lasso_federation_destroy -lasso_federation_dump -lasso_federation_get_remote_nameIdentifier -lasso_federation_get_local_nameIdentifier -lasso_federation_remove_local_nameIdentifier -lasso_federation_remove_remote_nameIdentifier -lasso_federation_set_local_nameIdentifier -lasso_federation_set_remote_nameIdentifier -lasso_federation_verify_nameIdentifier - -LASSO_FEDERATION -LASSO_IS_FEDERATION -LASSO_TYPE_FEDERATION -lasso_federation_get_type -LASSO_FEDERATION_CLASS -LASSO_IS_FEDERATION_CLASS -LASSO_FEDERATION_GET_CLASS -
-
lecp LassoLecp @@ -1178,58 +1114,6 @@ LASSO_IS_LECP_CLASS LASSO_LECP_GET_CLASS
-
-identity -LassoIdentityPrivate -LassoIdentity -LassoIdentity -LassoIdentityClass -lasso_identity_new -lasso_identity_new_from_dump -lasso_identity_add_federation -lasso_identity_copy -lasso_identity_destroy -lasso_identity_dump -lasso_identity_get_federation -lasso_identity_get_first_providerID -lasso_identity_get_next_federation_remote_providerID -lasso_identity_remove_federation - -LASSO_IDENTITY -LASSO_IS_IDENTITY -LASSO_TYPE_IDENTITY -lasso_identity_get_type -LASSO_IDENTITY_CLASS -LASSO_IS_IDENTITY_CLASS -LASSO_IDENTITY_GET_CLASS -
- -
-session -LassoSessionPrivate -LassoSession -LassoSession -LassoSessionClass -lasso_session_new -lasso_session_new_from_dump -lasso_session_add_assertion -lasso_session_copy -lasso_session_destroy -lasso_session_dump -lasso_session_get_assertion -lasso_session_get_authentication_method -lasso_session_get_first_providerID -lasso_session_get_provider_index -lasso_session_remove_assertion - -LASSO_SESSION -LASSO_IS_SESSION -LASSO_TYPE_SESSION -lasso_session_get_type -LASSO_SESSION_CLASS -LASSO_IS_SESSION_CLASS -LASSO_SESSION_GET_CLASS -
strings diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml index cf83dc91..2045557d 100644 --- a/docs/reference/lasso.sgml +++ b/docs/reference/lasso.sgml @@ -29,7 +29,7 @@ - + diff --git a/docs/reference/tmpl/defederation.sgml b/docs/reference/tmpl/defederation.sgml index 5415770c..e5e89751 100644 --- a/docs/reference/tmpl/defederation.sgml +++ b/docs/reference/tmpl/defederation.sgml @@ -53,8 +53,10 @@ Federation Termination Notification Profile @defederation: @remote_providerID: -@notification_method: +@http_method: @Returns: + +@notification_method: diff --git a/docs/reference/tmpl/federation.sgml b/docs/reference/tmpl/federation.sgml new file mode 100644 index 00000000..d207b08e --- /dev/null +++ b/docs/reference/tmpl/federation.sgml @@ -0,0 +1,83 @@ + +LassoFederation + + +Principal federation between two providers + + + + + + + + + + + + + + + + +@remote_providerID: +@local_nameIdentifier: +@remote_nameIdentifier: + + + + + + +@remote_providerID: +@Returns: + + + + + + + +@federation: + + + + + + + +@federation: +@nameQualifier: +@format: +@content: + + + + + + + +@federation: +@name_identifier: + + + + + + + +@federation: +@name_identifier: + + + + + + + +@federation: +@name_identifier: +@Returns: + +@nameIdentifier: + + diff --git a/docs/reference/tmpl/identity.sgml b/docs/reference/tmpl/identity.sgml new file mode 100644 index 00000000..7b76ace9 --- /dev/null +++ b/docs/reference/tmpl/identity.sgml @@ -0,0 +1,97 @@ + +LassoIdentity + + +Principal Identity + + + + + + + + + + + + + + + + +@federations: +@is_dirty: + + + + + + +@parent: + + + + + + +@Returns: + + + + + + + +@dump: +@Returns: + + + + + + + +@identity: + + + + + + + +@identity: +@Returns: + + + + + + + +@identity: +@federation: +@Returns: + + + + + + + +@identity: +@providerID: +@Returns: + + + + + + + +@identity: +@providerID: +@Returns: + +@remote_providerID: + + diff --git a/docs/reference/tmpl/session.sgml b/docs/reference/tmpl/session.sgml new file mode 100644 index 00000000..a02a0043 --- /dev/null +++ b/docs/reference/tmpl/session.sgml @@ -0,0 +1,123 @@ + +LassoSession + + +Principal Session + + + + + + + + + + + + + + + + + + + + + + +@parent: + + + + + + +@Returns: + + + + + + + +@dump: +@Returns: + + + + + + + +@session: +@providerID: +@assertion: +@Returns: + + + + + + + +@session: + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@providerID: +@Returns: + + + + + + + +@session: +@providerID: +@Returns: + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@index: +@Returns: + + + + + + + +@session: +@providerID: +@Returns: + + -- cgit