summaryrefslogtreecommitdiffstats
path: root/docs/reference
diff options
context:
space:
mode:
authorFrederic Peters <fpeters@entrouvert.com>2004-12-22 21:38:06 +0000
committerFrederic Peters <fpeters@entrouvert.com>2004-12-22 21:38:06 +0000
commit493236dc228d267296978fda743246cb5dc3c8b9 (patch)
tree1cfdb88d97f0fa3d67d99f8e34dede2e7e1685d2 /docs/reference
parent1c4c99693d98183c1a0191040dc39553a780c1bd (diff)
downloadlasso-493236dc228d267296978fda743246cb5dc3c8b9.tar.gz
lasso-493236dc228d267296978fda743246cb5dc3c8b9.tar.xz
lasso-493236dc228d267296978fda743246cb5dc3c8b9.zip
documenting #LassoIdentity and #LassoFederation
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/lasso-sections.txt252
-rw-r--r--docs/reference/lasso.sgml2
-rw-r--r--docs/reference/tmpl/defederation.sgml4
-rw-r--r--docs/reference/tmpl/federation.sgml83
-rw-r--r--docs/reference/tmpl/identity.sgml97
-rw-r--r--docs/reference/tmpl/session.sgml123
6 files changed, 375 insertions, 186 deletions
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
@@ -51,6 +51,73 @@ LASSO_SERVER_GET_CLASS
</SECTION>
<SECTION>
+<FILE>identity</FILE>
+<TITLE>LassoIdentity</TITLE>
+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
+<SUBSECTION Standard>
+LASSO_IDENTITY
+LASSO_IS_IDENTITY
+LASSO_TYPE_IDENTITY
+lasso_identity_get_type
+LASSO_IDENTITY_CLASS
+LASSO_IS_IDENTITY_CLASS
+LASSO_IDENTITY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>session</FILE>
+<TITLE>LassoSession</TITLE>
+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
+<SUBSECTION Standard>
+LASSO_SESSION
+LASSO_IS_SESSION
+LASSO_TYPE_SESSION
+lasso_session_get_type
+LASSO_SESSION_CLASS
+LASSO_IS_SESSION_CLASS
+LASSO_SESSION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>federation</FILE>
+<TITLE>LassoFederation</TITLE>
+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
+<SUBSECTION Standard>
+LASSO_FEDERATION
+LASSO_IS_FEDERATION
+LASSO_TYPE_FEDERATION
+lasso_federation_get_type
+LASSO_FEDERATION_CLASS
+LASSO_IS_FEDERATION_CLASS
+LASSO_FEDERATION_GET_CLASS
+</SECTION>
+
+<SECTION>
<FILE>profile</FILE>
<TITLE>LassoProfile</TITLE>
lassoMessageType
@@ -743,9 +810,8 @@ LASSO_SAMLP_STATUS_CODE_GET_CLASS
</SECTION>
<SECTION>
-<FILE>xml</FILE>
+<FILE>node</FILE>
lassoNodeExportType
-LassoNodePrivate
<TITLE>LassoNode</TITLE>
lassoSignatureMethod
LassoNode
@@ -824,22 +890,6 @@ LASSO_LIB_FEDERATION_TERMINATION_NOTIFICATION_GET_CLASS
</SECTION>
<SECTION>
-<FILE>lib_idp_provided_name_identifier</FILE>
-<TITLE>LassoLibIDPProvidedNameIdentifier</TITLE>
-LassoLibIDPProvidedNameIdentifier
-LassoLibIDPProvidedNameIdentifierClass
-lasso_lib_idp_provided_name_identifier_new
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
<FILE>lib_logout_response</FILE>
<TITLE>LassoLibLogoutResponse</TITLE>
LassoLibLogoutResponse
@@ -894,22 +944,6 @@ LASSO_LIB_NAME_IDENTIFIER_MAPPING_RESPONSE_GET_CLASS
</SECTION>
<SECTION>
-<FILE>lib_old_provided_name_identifier</FILE>
-<TITLE>LassoLibOLDProvidedNameIdentifier</TITLE>
-LassoLibOLDProvidedNameIdentifier
-LassoLibOLDProvidedNameIdentifierClass
-lasso_lib_old_provided_name_identifier_new
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
<FILE>lib_register_name_identifier_request</FILE>
<TITLE>LassoLibRegisterNameIdentifierRequest</TITLE>
LassoLibRegisterNameIdentifierRequest
@@ -947,22 +981,6 @@ LASSO_LIB_REGISTER_NAME_IDENTIFIER_RESPONSE_GET_CLASS
</SECTION>
<SECTION>
-<FILE>lib_sp_provided_name_identifier</FILE>
-<TITLE>LassoLibSPProvidedNameIdentifier</TITLE>
-LassoLibSPProvidedNameIdentifier
-LassoLibSPProvidedNameIdentifierClass
-lasso_lib_sp_provided_name_identifier_new
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
<FILE>lib_status_response</FILE>
<TITLE>LassoLibStatusResponse</TITLE>
LassoLibStatusResponse
@@ -1053,40 +1071,6 @@ LASSO_LIB_AUTHENTICATION_STATEMENT_GET_CLASS
</SECTION>
<SECTION>
-<FILE>soap-env_body</FILE>
-<TITLE>LassoSoapEnvBody</TITLE>
-LassoSoapEnvBody
-LassoSoapEnvBodyClass
-lasso_soap_env_body_new
-lasso_soap_env_body_add_child
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
-<FILE>soap-env_envelope</FILE>
-<TITLE>LassoSoapEnvEnvelope</TITLE>
-LassoSoapEnvEnvelope
-LassoSoapEnvEnvelopeClass
-lasso_soap_env_envelope_new
-lasso_soap_env_envelope_set_body
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
<FILE>lasso</FILE>
lasso_init
lasso_shutdown
@@ -1106,54 +1090,6 @@ LASSO_VERSION_INFO
</SECTION>
<SECTION>
-<FILE>federation_termination_notification</FILE>
-<TITLE>LassoFederationTerminationNotification</TITLE>
-LassoFederationTerminationNotification
-LassoFederationTerminationNotificationClass
-lasso_federation_termination_notification_new
-lasso_federation_termination_notification_new_from_export
-<SUBSECTION Standard>
-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
-</SECTION>
-
-<SECTION>
-<FILE>federation</FILE>
-LASSO_FEDERATION_NODE
-LASSO_FEDERATION_REMOTE_PROVIDERID_NODE
-LASSO_FEDERATION_LOCAL_NAME_IDENTIFIER_NODE
-LASSO_FEDERATION_REMOTE_NAME_IDENTIFIER_NODE
-<TITLE>LassoFederation</TITLE>
-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
-<SUBSECTION Standard>
-LASSO_FEDERATION
-LASSO_IS_FEDERATION
-LASSO_TYPE_FEDERATION
-lasso_federation_get_type
-LASSO_FEDERATION_CLASS
-LASSO_IS_FEDERATION_CLASS
-LASSO_FEDERATION_GET_CLASS
-</SECTION>
-
-<SECTION>
<FILE>lecp</FILE>
<TITLE>LassoLecp</TITLE>
LassoLecp
@@ -1178,58 +1114,6 @@ LASSO_IS_LECP_CLASS
LASSO_LECP_GET_CLASS
</SECTION>
-<SECTION>
-<FILE>identity</FILE>
-LassoIdentityPrivate
-<TITLE>LassoIdentity</TITLE>
-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
-<SUBSECTION Standard>
-LASSO_IDENTITY
-LASSO_IS_IDENTITY
-LASSO_TYPE_IDENTITY
-lasso_identity_get_type
-LASSO_IDENTITY_CLASS
-LASSO_IS_IDENTITY_CLASS
-LASSO_IDENTITY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>session</FILE>
-LassoSessionPrivate
-<TITLE>LassoSession</TITLE>
-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
-<SUBSECTION Standard>
-LASSO_SESSION
-LASSO_IS_SESSION
-LASSO_TYPE_SESSION
-lasso_session_get_type
-LASSO_SESSION_CLASS
-LASSO_IS_SESSION_CLASS
-LASSO_SESSION_GET_CLASS
-</SECTION>
<SECTION>
<FILE>strings</FILE>
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 @@
<!ENTITY LassoSamlpResponseAbstract SYSTEM "sgml/samlp_response_abstract.xml">
<!ENTITY LassoSamlpStatus SYSTEM "sgml/samlp_status.xml">
<!ENTITY LassoSamlpStatusCode SYSTEM "sgml/samlp_status_code.xml">
-<!ENTITY LassoNode SYSTEM "sgml/xml.xml">
+<!ENTITY LassoNode SYSTEM "sgml/node.xml">
<!ENTITY LassoLibLogoutRequest SYSTEM "sgml/lib_logout_request.xml">
<!ENTITY LassoLibFederationTerminationNotification SYSTEM "sgml/lib_federation_termination_notification.xml">
<!ENTITY LassoLibLogoutResponse SYSTEM "sgml/lib_logout_response.xml">
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:
+<!-- # Unused Parameters # -->
+@notification_method:
<!-- ##### FUNCTION lasso_defederation_process_notification_msg ##### -->
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 @@
+<!-- ##### SECTION Title ##### -->
+LassoFederation
+
+<!-- ##### SECTION Short_Description ##### -->
+Principal federation between two providers
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoFederation ##### -->
+<para>
+
+</para>
+
+@remote_providerID:
+@local_nameIdentifier:
+@remote_nameIdentifier:
+
+<!-- ##### FUNCTION lasso_federation_new ##### -->
+<para>
+
+</para>
+
+@remote_providerID:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_federation_destroy ##### -->
+<para>
+
+</para>
+
+@federation:
+
+
+<!-- ##### FUNCTION lasso_federation_build_local_name_identifier ##### -->
+<para>
+
+</para>
+
+@federation:
+@nameQualifier:
+@format:
+@content:
+
+
+<!-- ##### FUNCTION lasso_federation_set_local_name_identifier ##### -->
+<para>
+
+</para>
+
+@federation:
+@name_identifier:
+
+
+<!-- ##### FUNCTION lasso_federation_set_remote_name_identifier ##### -->
+<para>
+
+</para>
+
+@federation:
+@name_identifier:
+
+
+<!-- ##### FUNCTION lasso_federation_verify_name_identifier ##### -->
+<para>
+
+</para>
+
+@federation:
+@name_identifier:
+@Returns:
+<!-- # Unused Parameters # -->
+@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 @@
+<!-- ##### SECTION Title ##### -->
+LassoIdentity
+
+<!-- ##### SECTION Short_Description ##### -->
+Principal Identity
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoIdentity ##### -->
+<para>
+
+</para>
+
+@federations:
+@is_dirty:
+
+<!-- ##### STRUCT LassoIdentityClass ##### -->
+<para>
+
+</para>
+
+@parent:
+
+<!-- ##### FUNCTION lasso_identity_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_identity_new_from_dump ##### -->
+<para>
+
+</para>
+
+@dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_identity_destroy ##### -->
+<para>
+
+</para>
+
+@identity:
+
+
+<!-- ##### FUNCTION lasso_identity_dump ##### -->
+<para>
+
+</para>
+
+@identity:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_identity_add_federation ##### -->
+<para>
+
+</para>
+
+@identity:
+@federation:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_identity_get_federation ##### -->
+<para>
+
+</para>
+
+@identity:
+@providerID:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_identity_remove_federation ##### -->
+<para>
+
+</para>
+
+@identity:
+@providerID:
+@Returns:
+<!-- # Unused Parameters # -->
+@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 @@
+<!-- ##### SECTION Title ##### -->
+LassoSession
+
+<!-- ##### SECTION Short_Description ##### -->
+Principal Session
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoSession ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT LassoSessionClass ##### -->
+<para>
+
+</para>
+
+@parent:
+
+<!-- ##### FUNCTION lasso_session_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_new_from_dump ##### -->
+<para>
+
+</para>
+
+@dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_add_assertion ##### -->
+<para>
+
+</para>
+
+@session:
+@providerID:
+@assertion:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_destroy ##### -->
+<para>
+
+</para>
+
+@session:
+
+
+<!-- ##### FUNCTION lasso_session_dump ##### -->
+<para>
+
+</para>
+
+@session:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_get_assertion ##### -->
+<para>
+
+</para>
+
+@session:
+@providerID:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_get_authentication_method ##### -->
+<para>
+
+</para>
+
+@session:
+@providerID:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_get_first_providerID ##### -->
+<para>
+
+</para>
+
+@session:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_get_provider_index ##### -->
+<para>
+
+</para>
+
+@session:
+@index:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_session_remove_assertion ##### -->
+<para>
+
+</para>
+
+@session:
+@providerID:
+@Returns:
+
+