summaryrefslogtreecommitdiffstats
path: root/docs/reference
diff options
context:
space:
mode:
authorFrederic Peters <fpeters@entrouvert.com>2005-01-18 20:49:40 +0000
committerFrederic Peters <fpeters@entrouvert.com>2005-01-18 20:49:40 +0000
commit8564291ec3ef1e7fbf0022420a9701316d6d2cbe (patch)
treefd41f27a0a84edbc374f3a1c516e72242026e185 /docs/reference
parentc6dc916163497ac24431fb45c11921a12d353433 (diff)
downloadlasso-8564291ec3ef1e7fbf0022420a9701316d6d2cbe.tar.gz
lasso-8564291ec3ef1e7fbf0022420a9701316d6d2cbe.tar.xz
lasso-8564291ec3ef1e7fbf0022420a9701316d6d2cbe.zip
documented a few things
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/lasso-sections.txt2
-rw-r--r--docs/reference/tmpl/login.sgml7
-rw-r--r--docs/reference/tmpl/node.sgml177
-rw-r--r--docs/reference/tmpl/provider.sgml2
-rw-r--r--docs/reference/tmpl/saml_name_identifier.sgml2
-rw-r--r--docs/reference/tmpl/strings.sgml96
6 files changed, 282 insertions, 4 deletions
diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt
index 55dbda90..5123144e 100644
--- a/docs/reference/lasso-sections.txt
+++ b/docs/reference/lasso-sections.txt
@@ -679,7 +679,6 @@ LASSO_SAMLP_STATUS_CODE_GET_CLASS
<FILE>node</FILE>
<TITLE>LassoNode</TITLE>
LassoNode
-LassoMessageFormat
LassoSignatureType
LassoSignatureMethod
lasso_node_new
@@ -693,6 +692,7 @@ lasso_node_export_to_query
lasso_node_export_to_soap
lasso_node_get_xmlNode
lasso_node_init_from_message
+LassoMessageFormat
lasso_node_init_from_query
lasso_node_init_from_xml
<SUBSECTION Standard>
diff --git a/docs/reference/tmpl/login.sgml b/docs/reference/tmpl/login.sgml
index 28c8dcd5..0479dd48 100644
--- a/docs/reference/tmpl/login.sgml
+++ b/docs/reference/tmpl/login.sgml
@@ -131,7 +131,10 @@ printf("Location: /\n\nRedirected to site root\n");
<!-- ##### STRUCT LassoLogin ##### -->
<para>
-
+Single sign-on profile for the current transaction; possibly an
+assertionArtifact to be used by the service provider in its
+"assertionConsumerServiceURL" and the assertion created or received for the
+principal.
</para>
@protocolProfile:
@@ -140,7 +143,7 @@ printf("Location: /\n\nRedirected to site root\n");
<!-- ##### ENUM LassoLoginProtocolProfile ##### -->
<para>
-
+Identifies the two possible profiles for Single Sign-On and Federation.
</para>
@LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_ART:
diff --git a/docs/reference/tmpl/node.sgml b/docs/reference/tmpl/node.sgml
new file mode 100644
index 00000000..454a8785
--- /dev/null
+++ b/docs/reference/tmpl/node.sgml
@@ -0,0 +1,177 @@
+<!-- ##### SECTION Title ##### -->
+LassoNode
+
+<!-- ##### SECTION Short_Description ##### -->
+Base class for all Lasso objects
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#LassoNode is the base class for Lasso objects; just a step over GObject as
+defined in glib.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT LassoNode ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM LassoSignatureType ##### -->
+<para>
+
+</para>
+
+@LASSO_SIGNATURE_TYPE_NONE:
+@LASSO_SIGNATURE_TYPE_SIMPLE:
+@LASSO_SIGNATURE_TYPE_WITHX509:
+
+<!-- ##### ENUM LassoSignatureMethod ##### -->
+<para>
+
+</para>
+
+@LASSO_SIGNATURE_METHOD_RSA_SHA1:
+@LASSO_SIGNATURE_METHOD_DSA_SHA1:
+
+<!-- ##### FUNCTION lasso_node_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_new_from_dump ##### -->
+<para>
+
+</para>
+
+@dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_new_from_xmlNode ##### -->
+<para>
+
+</para>
+
+@node:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_new_from_soap ##### -->
+<para>
+
+</para>
+
+@soap:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_destroy ##### -->
+<para>
+
+</para>
+
+@node:
+
+
+<!-- ##### FUNCTION lasso_node_dump ##### -->
+<para>
+
+</para>
+
+@node:
+@Returns:
+<!-- # Unused Parameters # -->
+@encoding:
+@format:
+
+
+<!-- ##### FUNCTION lasso_node_export_to_base64 ##### -->
+<para>
+
+</para>
+
+@node:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_export_to_query ##### -->
+<para>
+
+</para>
+
+@node:
+@sign_method:
+@private_key_file:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_export_to_soap ##### -->
+<para>
+
+</para>
+
+@node:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_get_xmlNode ##### -->
+<para>
+
+</para>
+
+@node:
+@lasso_dump:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_init_from_message ##### -->
+<para>
+
+</para>
+
+@node:
+@message:
+@Returns:
+
+
+<!-- ##### ENUM LassoMessageFormat ##### -->
+<para>
+Return code for lasso_node_init_from_message; it describes the type of the
+message that was passed to that function.
+</para>
+
+@LASSO_MESSAGE_FORMAT_ERROR:
+@LASSO_MESSAGE_FORMAT_UNKNOWN:
+@LASSO_MESSAGE_FORMAT_XML:
+@LASSO_MESSAGE_FORMAT_BASE64:
+@LASSO_MESSAGE_FORMAT_QUERY:
+@LASSO_MESSAGE_FORMAT_SOAP:
+
+<!-- ##### FUNCTION lasso_node_init_from_query ##### -->
+<para>
+
+</para>
+
+@node:
+@query:
+@Returns:
+
+
+<!-- ##### FUNCTION lasso_node_init_from_xml ##### -->
+<para>
+
+</para>
+
+@node:
+@xmlnode:
+@Returns:
+
+
diff --git a/docs/reference/tmpl/provider.sgml b/docs/reference/tmpl/provider.sgml
index 4134c876..158fe9c8 100644
--- a/docs/reference/tmpl/provider.sgml
+++ b/docs/reference/tmpl/provider.sgml
@@ -2,7 +2,7 @@
LassoProvider
<!-- ##### SECTION Short_Description ##### -->
-Representation of a provider
+Service or identity provider
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/tmpl/saml_name_identifier.sgml b/docs/reference/tmpl/saml_name_identifier.sgml
index 6141e740..497522c0 100644
--- a/docs/reference/tmpl/saml_name_identifier.sgml
+++ b/docs/reference/tmpl/saml_name_identifier.sgml
@@ -30,6 +30,8 @@ identifiers) and
#LASSO_LIB_NAME_IDENTIFIER_FORMAT_ENTITYID.
</para>
+@NameQualifier:
+@Format:
@content:
<!-- ##### FUNCTION lasso_saml_name_identifier_new ##### -->
diff --git a/docs/reference/tmpl/strings.sgml b/docs/reference/tmpl/strings.sgml
new file mode 100644
index 00000000..332c5ed9
--- /dev/null
+++ b/docs/reference/tmpl/strings.sgml
@@ -0,0 +1,96 @@
+<!-- ##### SECTION Title ##### -->
+strings
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### MACRO LASSO_LIB_NAME_IDENTIFIER_FORMAT_FEDERATED ##### -->
+<para>
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAME_IDENTIFIER_FORMAT_ONE_TIME ##### -->
+<para>
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAME_IDENTIFIER_FORMAT_ENCRYPTED ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAME_IDENTIFIER_FORMAT_ENTITYID ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAMEID_POLICY_TYPE_NONE ##### -->
+<para>
+<emphasis>None</emphasis> policy for use in #LassoLibAuthnRequest. It means an
+existing federation must be used and an error should be produced if none
+existed beforehand.
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAMEID_POLICY_TYPE_ONE_TIME ##### -->
+<para>
+<emphasis>Onetime</emphasis> policy for use in #LassoLibAuthnRequest. It means
+a federation must not be created between identity and service provider. A
+temporary name identifier should be used instead.
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAMEID_POLICY_TYPE_FEDERATED ##### -->
+<para>
+<emphasis>Federated</emphasis> policy for use in #LassoLibAuthnRequest. It
+means a federation may be created between identity and service provider (if it
+didn't exist before).
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_NAMEID_POLICY_TYPE_ANY ##### -->
+<para>
+<emphasis>Any</emphasis> policy for use in #LassoLibAuthnRequest. It means a
+federation may be created if the principal agrees and it can fall back to
+<emphasis>onetime</emphasis> if he does not.
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_PROTOCOL_PROFILE_BRWS_ART ##### -->
+<para>
+Identifies the Single Sign-On "Artifact" profile; where an artifact is passed
+from identity provider to service provider and back to get the
+#LassoLibAssertion.
+</para>
+
+
+
+<!-- ##### MACRO LASSO_LIB_PROTOCOL_PROFILE_BRWS_POST ##### -->
+<para>
+Identifies the Single Sign-On "POST" profile; where the #LassoLibAssertion is
+sent directly from the identity provider to the service provider in an HTML
+form submission message.
+</para>
+
+
+