From 8564291ec3ef1e7fbf0022420a9701316d6d2cbe Mon Sep 17 00:00:00 2001 From: Frederic Peters Date: Tue, 18 Jan 2005 20:49:40 +0000 Subject: documented a few things --- docs/reference/lasso-sections.txt | 2 +- docs/reference/tmpl/login.sgml | 7 +- docs/reference/tmpl/node.sgml | 177 ++++++++++++++++++++++++++ docs/reference/tmpl/provider.sgml | 2 +- docs/reference/tmpl/saml_name_identifier.sgml | 2 + docs/reference/tmpl/strings.sgml | 96 ++++++++++++++ 6 files changed, 282 insertions(+), 4 deletions(-) create mode 100644 docs/reference/tmpl/node.sgml create mode 100644 docs/reference/tmpl/strings.sgml (limited to 'docs/reference') 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 node LassoNode 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 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"); - +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. @protocolProfile: @@ -140,7 +143,7 @@ printf("Location: /\n\nRedirected to site root\n"); - +Identifies the two possible profiles for Single Sign-On and Federation. @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 @@ + +LassoNode + + +Base class for all Lasso objects + + + +#LassoNode is the base class for Lasso objects; just a step over GObject as +defined in glib. + + + + + + + + + + + + + + + + + + +@LASSO_SIGNATURE_TYPE_NONE: +@LASSO_SIGNATURE_TYPE_SIMPLE: +@LASSO_SIGNATURE_TYPE_WITHX509: + + + + + + +@LASSO_SIGNATURE_METHOD_RSA_SHA1: +@LASSO_SIGNATURE_METHOD_DSA_SHA1: + + + + + + +@Returns: + + + + + + + +@dump: +@Returns: + + + + + + + +@node: +@Returns: + + + + + + + +@soap: +@Returns: + + + + + + + +@node: + + + + + + + +@node: +@Returns: + +@encoding: +@format: + + + + + + + +@node: +@Returns: + + + + + + + +@node: +@sign_method: +@private_key_file: +@Returns: + + + + + + + +@node: +@Returns: + + + + + + + +@node: +@lasso_dump: +@Returns: + + + + + + + +@node: +@message: +@Returns: + + + + +Return code for lasso_node_init_from_message; it describes the type of the +message that was passed to that function. + + +@LASSO_MESSAGE_FORMAT_ERROR: +@LASSO_MESSAGE_FORMAT_UNKNOWN: +@LASSO_MESSAGE_FORMAT_XML: +@LASSO_MESSAGE_FORMAT_BASE64: +@LASSO_MESSAGE_FORMAT_QUERY: +@LASSO_MESSAGE_FORMAT_SOAP: + + + + + + +@node: +@query: +@Returns: + + + + + + + +@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 -Representation of a provider +Service or identity provider 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. +@NameQualifier: +@Format: @content: 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 @@ + +strings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +None policy for use in #LassoLibAuthnRequest. It means an +existing federation must be used and an error should be produced if none +existed beforehand. + + + + + + +Onetime 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. + + + + + + +Federated policy for use in #LassoLibAuthnRequest. It +means a federation may be created between identity and service provider (if it +didn't exist before). + + + + + + +Any policy for use in #LassoLibAuthnRequest. It means a +federation may be created if the principal agrees and it can fall back to +onetime if he does not. + + + + + + +Identifies the Single Sign-On "Artifact" profile; where an artifact is passed +from identity provider to service provider and back to get the +#LassoLibAssertion. + + + + + + +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. + + + + -- cgit