summaryrefslogtreecommitdiffstats
path: root/docs/reference/tmpl
diff options
context:
space:
mode:
authorFrederic Peters <fpeters@entrouvert.com>2004-12-22 10:48:31 +0000
committerFrederic Peters <fpeters@entrouvert.com>2004-12-22 10:48:31 +0000
commitdfe6311bcb2bc68c91ae7e34025f197b77f3658b (patch)
tree76405341d44bf46a3f4ff29659575fa141beb68d /docs/reference/tmpl
parent09eb4fb227ae44c82ffb33bf188dab7f1370a511 (diff)
downloadlasso-dfe6311bcb2bc68c91ae7e34025f197b77f3658b.tar.gz
lasso-dfe6311bcb2bc68c91ae7e34025f197b77f3658b.tar.xz
lasso-dfe6311bcb2bc68c91ae7e34025f197b77f3658b.zip
Started organizing Lasso Reference Manual; documenting LassoProvider.
Diffstat (limited to 'docs/reference/tmpl')
-rw-r--r--docs/reference/tmpl/provider.sgml170
1 files changed, 170 insertions, 0 deletions
diff --git a/docs/reference/tmpl/provider.sgml b/docs/reference/tmpl/provider.sgml
new file mode 100644
index 00000000..647442ec
--- /dev/null
+++ b/docs/reference/tmpl/provider.sgml
@@ -0,0 +1,170 @@
+<!-- ##### SECTION Title ##### -->
+LassoProvider
+
+<!-- ##### SECTION Short_Description ##### -->
+Representation of a provider
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoProvider ##### -->
+<para>
+
+</para>
+
+@ProviderID:
+@role:
+@public_key:
+@ca_cert_chain:
+
+<!-- ##### ENUM LassoProviderRole ##### -->
+<para>
+
+</para>
+
+@LASSO_PROVIDER_ROLE_NONE:
+@LASSO_PROVIDER_ROLE_SP: Acts as service provider
+@LASSO_PROVIDER_ROLE_IDP: Acts as identity provider
+
+<!-- ##### ENUM lassoHttpMethod ##### -->
+<para>
+
+</para>
+
+@LASSO_HTTP_METHOD_NONE:
+@LASSO_HTTP_METHOD_ANY: Any method will do, select one automatically
+@LASSO_HTTP_METHOD_IDP_INITIATED:
+@LASSO_HTTP_METHOD_GET: HTTP-GET implementation (for image tags in Single Logout)
+@LASSO_HTTP_METHOD_POST: use an HTML form to post message between service and
+ identity providers
+@LASSO_HTTP_METHOD_REDIRECT: use HTTP 302 redirects to post message between
+ service and identity providers
+@LASSO_HTTP_METHOD_SOAP: use a SOAP call to post message between service and
+ identity providers
+
+<!-- ##### ENUM lassoMdProtocolType ##### -->
+<para>
+
+</para>
+
+@LASSO_MD_PROTOCOL_TYPE_FEDERATION_TERMINATION: Federation Termination
+ Notification
+@LASSO_MD_PROTOCOL_TYPE_NAME_IDENTIFIER_MAPPING: Name Identifier Mapping
+@LASSO_MD_PROTOCOL_TYPE_REGISTER_NAME_IDENTIFIER: Name Registration
+@LASSO_MD_PROTOCOL_TYPE_SINGLE_LOGOUT: Single Logout
+@LASSO_MD_PROTOCOL_TYPE_SINGLE_SIGN_ON: Single Sign-On and Federation
+
+<!-- ##### FUNCTION lasso_provider_new ##### -->
+<para>
+
+</para>
+
+@role:
+@metadata:
+@public_key:
+@ca_cert_chain:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_get_metadata_one ##### -->
+<para>
+
+</para>
+
+@provider:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_get_metadata_list ##### -->
+<para>
+
+</para>
+
+@provider:
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_load_metadata ##### -->
+<para>
+
+</para>
+
+@provider:
+@metadata:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_new_from_dump ##### -->
+<para>
+
+</para>
+
+@dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_verify_signature ##### -->
+<para>
+
+</para>
+
+@provider:
+@message:
+@id_attr_name:
+@format:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_get_first_http_method ##### -->
+<para>
+
+</para>
+
+@provider:
+@remote_provider:
+@protocol_type:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_accept_http_method ##### -->
+<para>
+
+</para>
+
+@provider:
+@remote_provider:
+@protocol_type:
+@http_method:
+@initiate_profile:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_has_protocol_profile ##### -->
+<para>
+
+</para>
+
+@provider:
+@protocol_type:
+@protocol_profile:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_provider_get_base64_succint_id ##### -->
+<para>
+
+</para>
+
+@provider:
+@Returns:
+
+