From dfe6311bcb2bc68c91ae7e34025f197b77f3658b Mon Sep 17 00:00:00 2001 From: Frederic Peters Date: Wed, 22 Dec 2004 10:48:31 +0000 Subject: Started organizing Lasso Reference Manual; documenting LassoProvider. --- docs/reference/Makefile.am | 5 +- docs/reference/lasso-sections.txt | 75 +++++++---------- docs/reference/lasso.sgml | 63 ++++++++++---- docs/reference/tmpl/provider.sgml | 170 ++++++++++++++++++++++++++++++++++++++ docs/reference/version.xml.in | 1 + 5 files changed, 252 insertions(+), 62 deletions(-) create mode 100644 docs/reference/tmpl/provider.sgml create mode 100644 docs/reference/version.xml.in (limited to 'docs/reference') diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 4cc87582..c78cd5ea 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,7 +1,8 @@ EXTRA_DIST = \ lasso-sections.txt \ lasso.sgml \ - lasso.types + lasso.types \ + version.xml.in # We need to pre-process original source files # because gtkdoc does not understand some C features @@ -36,7 +37,7 @@ sgml: templates --tmpl-dir=../tmpl/ \ --source-dir=../$(DOC_SOURCE_DIR)/lasso \ --output-dir=../sgml/ - cp $(srcdir)/lasso.sgml build/ + cp $(srcdir)/*.sgml $(srcdir)/version.xml build/ (for i in `find sgml -name "*.sgml" -print` ; do \ cat $$i | \ sed 's!\(<dsig:\)\([^/]*\)\(\/>\)!\1\2\3!g' | \ diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index 75c819b1..1e0c8bd7 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -1,3 +1,34 @@ +lasso/lasso.h + +
+provider +LassoProvider +LassoProvider +LassoProviderRole +lassoHttpMethod +lassoMdProtocolType +lasso_provider_new +lasso_provider_get_metadata_one +lasso_provider_get_metadata_list +lasso_provider_load_metadata +lasso_provider_new_from_dump +lasso_provider_verify_signature +lasso_provider_get_first_http_method +lasso_provider_accept_http_method +lasso_provider_has_protocol_profile +lasso_provider_get_base64_succint_id + +LASSO_PROVIDER +LASSO_IS_PROVIDER +LASSO_TYPE_PROVIDER +lasso_provider_get_type +LASSO_PROVIDER_CLASS +LASSO_IS_PROVIDER_CLASS +LASSO_PROVIDER_GET_CLASS +
+ + +
lib_assertion LassoLibAssertion @@ -1186,49 +1217,6 @@ LASSO_IS_NAME_IDENTIFIER_MAPPING_RESPONSE_CLASS LASSO_NAME_IDENTIFIER_MAPPING_RESPONSE_GET_CLASS
-
-provider -LASSO_PROVIDER_NODE -LASSO_PROVIDER_PUBLIC_KEY_NODE -LASSO_PROVIDER_CA_CERTIFICATE_NODE -LassoProviderPrivate -LassoProvider -LassoProvider -LassoProviderClass -lasso_provider_new -lasso_provider_new_from_metadata_node -lasso_provider_new_metadata_filename -lasso_provider_copy -lasso_provider_destroy -lasso_provider_dump -lasso_provider_get_assertionConsumerServiceURL -lasso_provider_get_authnRequestsSigned -lasso_provider_get_federationTerminationNotificationProtocolProfile -lasso_provider_get_federationTerminationServiceReturnURL -lasso_provider_get_federationTerminationServiceURL -lasso_provider_get_nameIdentifierMappingProtocolProfile -lasso_provider_get_providerID -lasso_provider_get_registerNameIdentifierProtocolProfile -lasso_provider_get_registerNameIdentifierServiceURL -lasso_provider_get_registerNameIdentifierServiceReturnURL -lasso_provider_get_singleSignOnProtocolProfile -lasso_provider_get_singleSignOnServiceURL -lasso_provider_get_singleLogoutProtocolProfile -lasso_provider_get_singleLogoutServiceURL -lasso_provider_get_singleLogoutServiceReturnURL -lasso_provider_get_soapEndpoint -lasso_provider_set_public_key -lasso_provider_set_ca_certificate - -LASSO_PROVIDER -LASSO_IS_PROVIDER -LASSO_TYPE_PROVIDER -lasso_provider_get_type -LASSO_PROVIDER_CLASS -LASSO_IS_PROVIDER_CLASS -LASSO_PROVIDER_GET_CLASS -
-
register_name_identifier_request LassoRegisterNameIdentifierRequest @@ -1407,7 +1395,6 @@ LASSO_LOGOUT_GET_CLASS
profile LassoProfilePrivate -lassoHttpMethod lassoProviderType lassoMessageType lasso_profile_get_request_type_from_soap_msg diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml index 6e8569ef..042189a2 100644 --- a/docs/reference/lasso.sgml +++ b/docs/reference/lasso.sgml @@ -53,15 +53,58 @@ - + + + ]> - Lasso API Reference + Lasso Reference Manual + for Lasso &version; - - Lasso + + Lasso Overview + +Lasso is a library which provides all the necessary functions for sites to +implement Liberty Alliance specifications. + + + + + + + Lasso Architecture + &LassoProvider; + &LassoServer; + &LassoIdentity; + &LassoSession; + + + + Identity Federation Framework + + &LassoProfile; + &LassoLogin; + &LassoFederation; + &LassoLecp; + &LassoLogout; + &LassoDefederation; + + + + + Identity Web Services Framework + + + + + + + + Schemas + + &LassoNode; &LassoLibAssertion; &LassoLibAuthnRequest; &lasso-LassoLibAuthnRequestEnvelope; @@ -90,7 +133,6 @@ &LassoSamlpResponseAbstract; &LassoSamlpStatus; &LassoSamlpStatusCode; - &LassoNode; &LassoLibLogoutRequest; &LassoLibFederationTerminationNotification; &LassoLibLogoutResponse; @@ -106,16 +148,5 @@ &lasso-export; &lasso-lasso; &lasso-version; - &LassoFederation; - &LassoLecp; - &LassoProvider; - &LassoDefederation; - &LassoIdentity; - &LassoLogin; - &LassoLogout; - &LassoProfile; - &LassoServer; - &LassoSession; - &lasso-tools; 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 @@ + +LassoProvider + + +Representation of a provider + + + + + + + + + + + + + + + + +@ProviderID: +@role: +@public_key: +@ca_cert_chain: + + + + + + +@LASSO_PROVIDER_ROLE_NONE: +@LASSO_PROVIDER_ROLE_SP: Acts as service provider +@LASSO_PROVIDER_ROLE_IDP: Acts as identity provider + + + + + + +@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 + + + + + + +@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 + + + + + + +@role: +@metadata: +@public_key: +@ca_cert_chain: +@Returns: + + + + + + + +@provider: +@name: +@Returns: + + + + + + + +@provider: +@name: +@Returns: + + + + + + + +@provider: +@metadata: +@Returns: + + + + + + + +@dump: +@Returns: + + + + + + + +@provider: +@message: +@id_attr_name: +@format: +@Returns: + + + + + + + +@provider: +@remote_provider: +@protocol_type: +@Returns: + + + + + + + +@provider: +@remote_provider: +@protocol_type: +@http_method: +@initiate_profile: +@Returns: + + + + + + + +@provider: +@protocol_type: +@protocol_profile: +@Returns: + + + + + + + +@provider: +@Returns: + + diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in new file mode 100644 index 00000000..d78bda93 --- /dev/null +++ b/docs/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ -- cgit