diff options
author | Frederic Peters <fpeters@entrouvert.com> | 2007-01-08 13:11:11 +0000 |
---|---|---|
committer | Frederic Peters <fpeters@entrouvert.com> | 2007-01-08 13:11:11 +0000 |
commit | ad3e57fa1dea889373b86798ea36b1324f760738 (patch) | |
tree | 42c2668081b02b6cce51b98c52f9a373942dde99 /docs | |
parent | db403fb6b7a8a099154bfb79027009554a4709e1 (diff) | |
download | lasso-ad3e57fa1dea889373b86798ea36b1324f760738.tar.gz lasso-ad3e57fa1dea889373b86798ea36b1324f760738.tar.xz lasso-ad3e57fa1dea889373b86798ea36b1324f760738.zip |
added documentation about SAMLv2 Name Id Management profile; and by the same
time updated all tmpl/ files with a newer gtk-doc
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/lasso-sections.txt | 23 | ||||
-rw-r--r-- | docs/reference/lasso.sgml | 6 | ||||
-rw-r--r-- | docs/reference/lasso.types.in | 1 | ||||
-rw-r--r-- | docs/reference/tmpl/defederation.sgml | 4 | ||||
-rw-r--r-- | docs/reference/tmpl/discovery.sgml | 6 | ||||
-rw-r--r-- | docs/reference/tmpl/federation.sgml | 2 | ||||
-rw-r--r-- | docs/reference/tmpl/login.sgml | 2 | ||||
-rw-r--r-- | docs/reference/tmpl/name_id_management.sgml | 111 | ||||
-rw-r--r-- | docs/reference/tmpl/name_identifier_mapping.sgml | 2 | ||||
-rw-r--r-- | docs/reference/tmpl/name_registration.sgml | 2 | ||||
-rw-r--r-- | docs/reference/tmpl/node.sgml | 3 | ||||
-rw-r--r-- | docs/reference/tmpl/profile.sgml | 15 | ||||
-rw-r--r-- | docs/reference/tmpl/server.sgml | 5 |
13 files changed, 144 insertions, 38 deletions
diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index 62254c24..dacd045c 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -261,6 +261,29 @@ LASSO_NAME_IDENTIFIER_MAPPING_GET_CLASS </SECTION> <SECTION> +<FILE>name_id_management</FILE> +<TITLE>LassoNameIdManagement</TITLE> +LassoNameIdManagement +lasso_name_id_management_new +lasso_name_id_management_destroy +lasso_name_id_management_new_from_dump +lasso_name_id_management_build_request_msg +lasso_name_id_management_build_response_msg +lasso_name_id_management_init_request +lasso_name_id_management_process_request_msg +lasso_name_id_management_process_response_msg +lasso_name_id_management_validate_request +<SUBSECTION Standard> +LASSO_NAME_ID_MANAGEMENT +LASSO_IS_NAME_ID_MANAGEMENT +LASSO_TYPE_NAME_ID_MANAGEMENT +lasso_name_id_management_get_type +LASSO_NAME_ID_MANAGEMENT_CLASS +LASSO_IS_NAME_ID_MANAGEMENT_CLASS +LASSO_NAME_ID_MANAGEMENT_GET_CLASS +</SECTION> + +<SECTION> <FILE>lib_assertion</FILE> <TITLE>LassoLibAssertion</TITLE> LassoLibAssertion diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml index d5f41961..f752ffc3 100644 --- a/docs/reference/lasso.sgml +++ b/docs/reference/lasso.sgml @@ -49,6 +49,7 @@ <!ENTITY LassoDefederation SYSTEM "sgml/defederation.xml"> <!ENTITY LassoNameRegistration SYSTEM "sgml/name_registration.xml"> <!ENTITY LassoNameIdentifierMapping SYSTEM "sgml/name_identifier_mapping.xml"> +<!ENTITY LassoNameIdManagement SYSTEM "sgml/name_id_management.xml"> <!ENTITY LassoIdentity SYSTEM "sgml/identity.xml"> <!ENTITY LassoLogin SYSTEM "sgml/login.xml"> <!ENTITY LassoLogout SYSTEM "sgml/logout.xml"> @@ -76,7 +77,7 @@ </legalnotice> <copyright> - <year>2004, 2005</year> + <year>2004, 2005, 2006, 2007</year> <holder>Entr'ouvert</holder> </copyright> @@ -155,7 +156,7 @@ development, without calling into question its architecture. Lasso is a library written in C Language. </para> -<para> + <para> Lasso is built on top of <ulink url="http://www.xmlsoft.org">libxml2</ulink>, <ulink url="http://www.aleksey.com/xmlsec/">XMLSec</ulink> and <ulink url="http://www.openssl.org">OpenSSL</ulink> and is licensed under @@ -185,6 +186,7 @@ the <ulink url="http://lasso.entrouvert.org/license">GNU General Public License< &LassoDefederation; &LassoNameRegistration; &LassoNameIdentifierMapping; + &LassoNameIdManagement; </chapter> diff --git a/docs/reference/lasso.types.in b/docs/reference/lasso.types.in index 8575bed4..fe2ea63d 100644 --- a/docs/reference/lasso.types.in +++ b/docs/reference/lasso.types.in @@ -52,6 +52,7 @@ lasso_identity_get_type lasso_session_get_type lasso_name_registration_get_type lasso_name_identifier_mapping_get_type +lasso_name_id_management_get_type #WSF# lasso_discovery_get_type #WSF# lasso_data_service_get_type diff --git a/docs/reference/tmpl/defederation.sgml b/docs/reference/tmpl/defederation.sgml index 42feedff..6404fd48 100644 --- a/docs/reference/tmpl/defederation.sgml +++ b/docs/reference/tmpl/defederation.sgml @@ -2,7 +2,7 @@ LassoDefederation <!-- ##### SECTION Short_Description ##### --> -Federation Termination Notification Profile +Federation Termination Notification Profile (ID-FF) <!-- ##### SECTION Long_Description ##### --> <para> @@ -58,8 +58,6 @@ Federation Termination Notification Profile @remote_providerID: @http_method: @Returns: -<!-- # Unused Parameters # --> -@notification_method: <!-- ##### FUNCTION lasso_defederation_process_notification_msg ##### --> diff --git a/docs/reference/tmpl/discovery.sgml b/docs/reference/tmpl/discovery.sgml index 1acb441a..71f9b30f 100644 --- a/docs/reference/tmpl/discovery.sgml +++ b/docs/reference/tmpl/discovery.sgml @@ -85,9 +85,6 @@ service = lasso_discovery_get_service(discovery); @service_type: @option: @Returns: -<!-- # Unused Parameters # --> -@serviceType: -@options: <!-- ##### FUNCTION lasso_discovery_build_modify_response_msg ##### --> @@ -136,9 +133,6 @@ service = lasso_discovery_get_service(discovery); @new_offering: @security_mech_id: @Returns: -<!-- # Unused Parameters # --> -@resource_offering: -@resourceOffering: <!-- ##### FUNCTION lasso_discovery_init_query ##### --> diff --git a/docs/reference/tmpl/federation.sgml b/docs/reference/tmpl/federation.sgml index ce462599..a854e893 100644 --- a/docs/reference/tmpl/federation.sgml +++ b/docs/reference/tmpl/federation.sgml @@ -62,7 +62,5 @@ Principal federation between two providers @federation: @name_identifier: @Returns: -<!-- # Unused Parameters # --> -@nameIdentifier: diff --git a/docs/reference/tmpl/login.sgml b/docs/reference/tmpl/login.sgml index f2aca3c0..a288e325 100644 --- a/docs/reference/tmpl/login.sgml +++ b/docs/reference/tmpl/login.sgml @@ -378,7 +378,5 @@ Identifies the two possible profiles for Single Sign-On and Federation. @login: @content: @Returns: -<!-- # Unused Parameters # --> -@resourceId: diff --git a/docs/reference/tmpl/name_id_management.sgml b/docs/reference/tmpl/name_id_management.sgml new file mode 100644 index 00000000..dcfb70f1 --- /dev/null +++ b/docs/reference/tmpl/name_id_management.sgml @@ -0,0 +1,111 @@ +<!-- ##### SECTION Title ##### --> +LassoNameIdManagement + +<!-- ##### SECTION Short_Description ##### --> +Name Id Management Profile (SAMLv2) + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoNameIdManagement ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION lasso_name_id_management_new ##### --> +<para> + +</para> + +@server: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_destroy ##### --> +<para> + +</para> + +@name_id_management: + + +<!-- ##### FUNCTION lasso_name_id_management_new_from_dump ##### --> +<para> + +</para> + +@server: +@dump: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_build_request_msg ##### --> +<para> + +</para> + +@name_id_management: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_build_response_msg ##### --> +<para> + +</para> + +@name_id_management: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_init_request ##### --> +<para> + +</para> + +@name_id_management: +@remote_provider_id: +@new_name_id: +@http_method: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_process_request_msg ##### --> +<para> + +</para> + +@name_id_management: +@request_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_process_response_msg ##### --> +<para> + +</para> + +@name_id_management: +@response_msg: +@Returns: + + +<!-- ##### FUNCTION lasso_name_id_management_validate_request ##### --> +<para> + +</para> + +@name_id_management: +@Returns: + + diff --git a/docs/reference/tmpl/name_identifier_mapping.sgml b/docs/reference/tmpl/name_identifier_mapping.sgml index b4835d89..aab28dab 100644 --- a/docs/reference/tmpl/name_identifier_mapping.sgml +++ b/docs/reference/tmpl/name_identifier_mapping.sgml @@ -2,7 +2,7 @@ LassoNameIdentifierMapping <!-- ##### SECTION Short_Description ##### --> -Name Identifier Mapping +Name Identifier Mapping Profile (ID-FF) <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/reference/tmpl/name_registration.sgml b/docs/reference/tmpl/name_registration.sgml index cfa58971..b3983610 100644 --- a/docs/reference/tmpl/name_registration.sgml +++ b/docs/reference/tmpl/name_registration.sgml @@ -2,7 +2,7 @@ LassoNameRegistration <!-- ##### SECTION Short_Description ##### --> -Name Registration +Name Registration Profile (ID-FF) <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/docs/reference/tmpl/node.sgml b/docs/reference/tmpl/node.sgml index aa7f2947..b8e34413 100644 --- a/docs/reference/tmpl/node.sgml +++ b/docs/reference/tmpl/node.sgml @@ -91,9 +91,6 @@ defined in glib. @node: @Returns: -<!-- # Unused Parameters # --> -@encoding: -@format: <!-- ##### FUNCTION lasso_node_export_to_base64 ##### --> diff --git a/docs/reference/tmpl/profile.sgml b/docs/reference/tmpl/profile.sgml index 7438d608..bb46c6bd 100644 --- a/docs/reference/tmpl/profile.sgml +++ b/docs/reference/tmpl/profile.sgml @@ -2,7 +2,7 @@ LassoProfile <!-- ##### SECTION Short_Description ##### --> -Base class for all ID-FF profiles +Base class for all identity profiles <!-- ##### SECTION Long_Description ##### --> <para> @@ -34,6 +34,7 @@ Base class for all ID-FF profiles @LASSO_REQUEST_TYPE_DST_QUERY: @LASSO_REQUEST_TYPE_DST_MODIFY: @LASSO_REQUEST_TYPE_SASL_REQUEST: +@LASSO_REQUEST_TYPE_NAME_ID_MANAGEMENT: <!-- ##### STRUCT LassoProfile ##### --> <para> @@ -56,8 +57,6 @@ Base class for all ID-FF profiles @profile: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_get_session ##### --> @@ -67,8 +66,6 @@ Base class for all ID-FF profiles @profile: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_is_identity_dirty ##### --> @@ -78,8 +75,6 @@ Base class for all ID-FF profiles @profile: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_is_session_dirty ##### --> @@ -89,8 +84,6 @@ Base class for all ID-FF profiles @profile: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_set_identity_from_dump ##### --> @@ -101,8 +94,6 @@ Base class for all ID-FF profiles @profile: @dump: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_set_session_from_dump ##### --> @@ -113,8 +104,6 @@ Base class for all ID-FF profiles @profile: @dump: @Returns: -<!-- # Unused Parameters # --> -@ctx: <!-- ##### FUNCTION lasso_profile_get_request_type_from_soap_msg ##### --> diff --git a/docs/reference/tmpl/server.sgml b/docs/reference/tmpl/server.sgml index bf444c29..d33c5668 100644 --- a/docs/reference/tmpl/server.sgml +++ b/docs/reference/tmpl/server.sgml @@ -40,8 +40,6 @@ certificates to use, etc. @private_key_password: @certificate: @Returns: -<!-- # Unused Parameters # --> -@secret_key: <!-- ##### FUNCTION lasso_server_new_from_dump ##### --> @@ -74,9 +72,6 @@ certificates to use, etc. @server: @service: @Returns: -<!-- # Unused Parameters # --> -@service_type: -@service_endpoint: <!-- ##### FUNCTION lasso_server_destroy ##### --> |