summaryrefslogtreecommitdiffstats
path: root/docs/reference/tmpl
diff options
context:
space:
mode:
authorFrederic Peters <fpeters@entrouvert.com>2004-12-22 11:44:13 +0000
committerFrederic Peters <fpeters@entrouvert.com>2004-12-22 11:44:13 +0000
commit23b4a410c6b5d981fc51bc6c3d274a632471ef5e (patch)
tree84f829575e0655eb8ff24a79e74de6417ed11d64 /docs/reference/tmpl
parentdfe6311bcb2bc68c91ae7e34025f197b77f3658b (diff)
downloadlasso-23b4a410c6b5d981fc51bc6c3d274a632471ef5e.tar.gz
lasso-23b4a410c6b5d981fc51bc6c3d274a632471ef5e.tar.xz
lasso-23b4a410c6b5d981fc51bc6c3d274a632471ef5e.zip
documented #LassoServer
Diffstat (limited to 'docs/reference/tmpl')
-rw-r--r--docs/reference/tmpl/provider.sgml50
-rw-r--r--docs/reference/tmpl/server.sgml120
2 files changed, 145 insertions, 25 deletions
diff --git a/docs/reference/tmpl/provider.sgml b/docs/reference/tmpl/provider.sgml
index 647442ec..ec78bfad 100644
--- a/docs/reference/tmpl/provider.sgml
+++ b/docs/reference/tmpl/provider.sgml
@@ -6,7 +6,7 @@ Representation of a provider
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+It holds all the data about a provider.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -73,98 +73,98 @@ Representation of a provider
@Returns:
-<!-- ##### FUNCTION lasso_provider_get_metadata_one ##### -->
+<!-- ##### FUNCTION lasso_provider_new_from_dump ##### -->
<para>
</para>
-@provider:
-@name:
+@dump:
@Returns:
-<!-- ##### FUNCTION lasso_provider_get_metadata_list ##### -->
+<!-- ##### FUNCTION lasso_provider_accept_http_method ##### -->
<para>
</para>
@provider:
-@name:
+@remote_provider:
+@protocol_type:
+@http_method:
+@initiate_profile:
@Returns:
-<!-- ##### FUNCTION lasso_provider_load_metadata ##### -->
+<!-- ##### FUNCTION lasso_provider_get_base64_succint_id ##### -->
<para>
</para>
@provider:
-@metadata:
@Returns:
-<!-- ##### FUNCTION lasso_provider_new_from_dump ##### -->
+<!-- ##### FUNCTION lasso_provider_get_first_http_method ##### -->
<para>
</para>
-@dump:
+@provider:
+@remote_provider:
+@protocol_type:
@Returns:
-<!-- ##### FUNCTION lasso_provider_verify_signature ##### -->
+<!-- ##### FUNCTION lasso_provider_get_metadata_list ##### -->
<para>
</para>
@provider:
-@message:
-@id_attr_name:
-@format:
+@name:
@Returns:
-<!-- ##### FUNCTION lasso_provider_get_first_http_method ##### -->
+<!-- ##### FUNCTION lasso_provider_get_metadata_one ##### -->
<para>
</para>
@provider:
-@remote_provider:
-@protocol_type:
+@name:
@Returns:
-<!-- ##### FUNCTION lasso_provider_accept_http_method ##### -->
+<!-- ##### FUNCTION lasso_provider_has_protocol_profile ##### -->
<para>
</para>
@provider:
-@remote_provider:
@protocol_type:
-@http_method:
-@initiate_profile:
+@protocol_profile:
@Returns:
-<!-- ##### FUNCTION lasso_provider_has_protocol_profile ##### -->
+<!-- ##### FUNCTION lasso_provider_load_metadata ##### -->
<para>
</para>
@provider:
-@protocol_type:
-@protocol_profile:
+@metadata:
@Returns:
-<!-- ##### FUNCTION lasso_provider_get_base64_succint_id ##### -->
+<!-- ##### FUNCTION lasso_provider_verify_signature ##### -->
<para>
</para>
@provider:
+@message:
+@id_attr_name:
+@format:
@Returns:
diff --git a/docs/reference/tmpl/server.sgml b/docs/reference/tmpl/server.sgml
new file mode 100644
index 00000000..b0635af1
--- /dev/null
+++ b/docs/reference/tmpl/server.sgml
@@ -0,0 +1,120 @@
+<!-- ##### SECTION Title ##### -->
+LassoServer
+
+<!-- ##### SECTION Short_Description ##### -->
+Representation of the current server
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+It holds the data about a provider, other providers it knows, which
+certificates to use, etc.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoServer ##### -->
+<para>
+
+</para>
+
+@providers:
+@services:
+@private_key:
+@secret_key:
+@certificate:
+@signature_method:
+
+<!-- ##### FUNCTION lasso_server_new ##### -->
+<para>
+
+</para>
+
+@metadata:
+@private_key:
+@secret_key:
+@certificate:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_new_from_dump ##### -->
+<para>
+
+</para>
+
+@dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_add_provider ##### -->
+<para>
+
+</para>
+
+@server:
+@role:
+@metadata:
+@public_key:
+@ca_cert_chain:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_add_service ##### -->
+<para>
+
+</para>
+
+@server:
+@service_type:
+@service_endpoint:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_destroy ##### -->
+<para>
+
+</para>
+
+@server:
+
+
+<!-- ##### FUNCTION lasso_server_dump ##### -->
+<para>
+
+</para>
+
+@server:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_get_first_providerID ##### -->
+<para>
+
+</para>
+
+@server:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_get_provider ##### -->
+<para>
+
+</para>
+
+@server:
+@providerID:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_server_get_providerID_from_hash ##### -->
+<para>
+
+</para>
+
+@server:
+@b64_hash:
+@Returns:
+
+