From 23b4a410c6b5d981fc51bc6c3d274a632471ef5e Mon Sep 17 00:00:00 2001 From: Frederic Peters Date: Wed, 22 Dec 2004 11:44:13 +0000 Subject: documented #LassoServer --- docs/reference/lasso-sections.txt | 367 +++----------------------------------- docs/reference/lasso.sgml | 41 +++-- docs/reference/tmpl/provider.sgml | 50 +++--- docs/reference/tmpl/server.sgml | 120 +++++++++++++ 4 files changed, 195 insertions(+), 383 deletions(-) create mode 100644 docs/reference/tmpl/server.sgml (limited to 'docs/reference') diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index 1e0c8bd7..0d526f75 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -8,15 +8,15 @@ 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_get_first_http_method +lasso_provider_get_metadata_list +lasso_provider_get_metadata_one +lasso_provider_has_protocol_profile +lasso_provider_load_metadata +lasso_provider_verify_signature LASSO_PROVIDER LASSO_IS_PROVIDER @@ -27,7 +27,28 @@ LASSO_IS_PROVIDER_CLASS LASSO_PROVIDER_GET_CLASS - +
+server +LassoServer +LassoServer +lasso_server_new +lasso_server_new_from_dump +lasso_server_add_provider +lasso_server_add_service +lasso_server_destroy +lasso_server_dump +lasso_server_get_first_providerID +lasso_server_get_provider +lasso_server_get_providerID_from_hash + +LASSO_SERVER +LASSO_IS_SERVER +LASSO_TYPE_SERVER +lasso_server_get_type +LASSO_SERVER_CLASS +LASSO_IS_SERVER_CLASS +LASSO_SERVER_GET_CLASS +
lib_assertion @@ -913,11 +934,6 @@ LASSO_IS_SOAP_ENV_ENVELOPE_CLASS LASSO_SOAP_ENV_ENVELOPE_GET_CLASS
-
-export -extern -
-
lasso lasso_init @@ -937,140 +953,6 @@ LASSO_VERSION_SUBMINOR LASSO_VERSION_INFO
-
-protocols -
- -
-artifact -LassoArtifact -LassoArtifact -LassoArtifactClass -lasso_artifact_new -lasso_artifact_new_from_query -lasso_artifact_new_from_lares -lasso_artifact_get_assertionHandle -lasso_artifact_get_byteCode -lasso_artifact_get_b64IdentityProviderSuccinctID -lasso_artifact_get_relayState -lasso_artifact_get_samlArt - -LASSO_ARTIFACT -LASSO_IS_ARTIFACT -LASSO_TYPE_ARTIFACT -lasso_artifact_get_type -LASSO_ARTIFACT_CLASS -LASSO_IS_ARTIFACT_CLASS -LASSO_ARTIFACT_GET_CLASS -
- -
-assertion -LassoAssertion -LassoAssertion -LassoAssertionClass -lasso_assertion_new - -LASSO_ASSERTION -LASSO_IS_ASSERTION -LASSO_TYPE_ASSERTION -lasso_assertion_get_type -LASSO_ASSERTION_CLASS -LASSO_IS_ASSERTION_CLASS -LASSO_ASSERTION_GET_CLASS -
- -
-authentication_statement -LassoAuthenticationStatement -LassoAuthenticationStatement -LassoAuthenticationStatementClass -lasso_authentication_statement_new - -LASSO_AUTHENTICATION_STATEMENT -LASSO_IS_AUTHENTICATION_STATEMENT -LASSO_TYPE_AUTHENTICATION_STATEMENT -lasso_authentication_statement_get_type -LASSO_AUTHENTICATION_STATEMENT_CLASS -LASSO_IS_AUTHENTICATION_STATEMENT_CLASS -LASSO_AUTHENTICATION_STATEMENT_GET_CLASS -
- -
-authn_request -LassoAuthnRequest -LassoAuthnRequest -LassoAuthnRequestClass -lasso_authn_request_get_protocolProfile -lasso_authn_request_new -lasso_authn_request_new_from_export -lasso_authn_request_set_requestAuthnContext -lasso_authn_request_set_scoping - -LASSO_AUTHN_REQUEST -LASSO_IS_AUTHN_REQUEST -LASSO_TYPE_AUTHN_REQUEST -lasso_authn_request_get_type -LASSO_AUTHN_REQUEST_CLASS -LASSO_IS_AUTHN_REQUEST_CLASS -LASSO_AUTHN_REQUEST_GET_CLASS -
- -
-authn_request_envelope -LassoAuthnRequestEnvelope -LassoAuthnRequestEnvelope -LassoAuthnRequestEnvelopeClass -lasso_authn_request_envelope_new -lasso_authn_request_envelope_get_authnRequest -lasso_authn_request_envelope_new_from_export - -LASSO_AUTHN_REQUEST_ENVELOPE -LASSO_IS_AUTHN_REQUEST_ENVELOPE -LASSO_TYPE_AUTHN_REQUEST_ENVELOPE -lasso_authn_request_envelope_get_type -LASSO_AUTHN_REQUEST_ENVELOPE_CLASS -LASSO_IS_AUTHN_REQUEST_ENVELOPE_CLASS -LASSO_AUTHN_REQUEST_ENVELOPE_GET_CLASS -
- -
-authn_response -LassoAuthnResponse -LassoAuthnResponse -LassoAuthnResponseClass -lasso_authn_response_new -lasso_authn_response_new_from_export -lasso_authn_response_get_status - -LASSO_AUTHN_RESPONSE -LASSO_IS_AUTHN_RESPONSE -LASSO_TYPE_AUTHN_RESPONSE -lasso_authn_response_get_type -LASSO_AUTHN_RESPONSE_CLASS -LASSO_IS_AUTHN_RESPONSE_CLASS -LASSO_AUTHN_RESPONSE_GET_CLASS -
- -
-authn_response_envelope -LassoAuthnResponseEnvelope -LassoAuthnResponseEnvelope -LassoAuthnResponseEnvelopeClass -lasso_authn_response_envelope_new -lasso_authn_response_envelope_get_assertionConsumerServiceURL -lasso_authn_response_envelope_get_authnResponse -lasso_authn_response_envelope_new_from_export - -LASSO_AUTHN_RESPONSE_ENVELOPE -LASSO_IS_AUTHN_RESPONSE_ENVELOPE -LASSO_TYPE_AUTHN_RESPONSE_ENVELOPE -lasso_authn_response_envelope_get_type -LASSO_AUTHN_RESPONSE_ENVELOPE_CLASS -LASSO_IS_AUTHN_RESPONSE_ENVELOPE_CLASS -LASSO_AUTHN_RESPONSE_ENVELOPE_GET_CLASS -
-
federation_termination_notification LassoFederationTerminationNotification @@ -1144,148 +1026,6 @@ LASSO_IS_LECP_CLASS LASSO_LECP_GET_CLASS
-
-logout_request -LassoLogoutRequest -LassoLogoutRequest -LassoLogoutRequestClass -lasso_logout_request_new -lasso_logout_request_new_from_export - -LASSO_LOGOUT_REQUEST -LASSO_IS_LOGOUT_REQUEST -LASSO_TYPE_LOGOUT_REQUEST -lasso_logout_request_get_type -LASSO_LOGOUT_REQUEST_CLASS -LASSO_IS_LOGOUT_REQUEST_CLASS -LASSO_LOGOUT_REQUEST_GET_CLASS -
- -
-logout_response -LassoLogoutResponse -LassoLogoutResponse -LassoLogoutResponseClass -lasso_logout_response_new -lasso_logout_response_new_from_export - -LASSO_LOGOUT_RESPONSE -LASSO_IS_LOGOUT_RESPONSE -LASSO_TYPE_LOGOUT_RESPONSE -lasso_logout_response_get_type -LASSO_LOGOUT_RESPONSE_CLASS -LASSO_IS_LOGOUT_RESPONSE_CLASS -LASSO_LOGOUT_RESPONSE_GET_CLASS -
- -
-name_identifier_mapping_request -LassoNameIdentifierMappingRequest -LassoNameIdentifierMappingRequest -LassoNameIdentifierMappingRequestClass -lasso_name_identifier_mapping_request_new -lasso_name_identifier_mapping_request_new_from_query -lasso_name_identifier_mapping_request_new_from_soap - -LASSO_NAME_IDENTIFIER_MAPPING_REQUEST -LASSO_IS_NAME_IDENTIFIER_MAPPING_REQUEST -LASSO_TYPE_NAME_IDENTIFIER_MAPPING_REQUEST -lasso_name_identifier_mapping_request_get_type -LASSO_NAME_IDENTIFIER_MAPPING_REQUEST_CLASS -LASSO_IS_NAME_IDENTIFIER_MAPPING_REQUEST_CLASS -LASSO_NAME_IDENTIFIER_MAPPING_REQUEST_GET_CLASS -
- -
-name_identifier_mapping_response -LassoNameIdentifierMappingResponse -LassoNameIdentifierMappingResponse -LassoNameIdentifierMappingResponseClass -lasso_name_identifier_mapping_response_new -lasso_name_identifier_mapping_response_new_from_dump -lasso_name_identifier_mapping_response_new_from_query -lasso_name_identifier_mapping_response_new_from_request_soap -lasso_name_identifier_mapping_response_new_from_soap -lasso_name_identifier_mapping_response_new_from_request_query - -LASSO_NAME_IDENTIFIER_MAPPING_RESPONSE -LASSO_IS_NAME_IDENTIFIER_MAPPING_RESPONSE -LASSO_TYPE_NAME_IDENTIFIER_MAPPING_RESPONSE -lasso_name_identifier_mapping_response_get_type -LASSO_NAME_IDENTIFIER_MAPPING_RESPONSE_CLASS -LASSO_IS_NAME_IDENTIFIER_MAPPING_RESPONSE_CLASS -LASSO_NAME_IDENTIFIER_MAPPING_RESPONSE_GET_CLASS -
- -
-register_name_identifier_request -LassoRegisterNameIdentifierRequest -LassoRegisterNameIdentifierRequest -LassoRegisterNameIdentifierRequestClass -lasso_register_name_identifier_request_new -lasso_register_name_identifier_request_new_from_export - -LASSO_REGISTER_NAME_IDENTIFIER_REQUEST -LASSO_IS_REGISTER_NAME_IDENTIFIER_REQUEST -LASSO_TYPE_REGISTER_NAME_IDENTIFIER_REQUEST -lasso_register_name_identifier_request_get_type -LASSO_REGISTER_NAME_IDENTIFIER_REQUEST_CLASS -LASSO_IS_REGISTER_NAME_IDENTIFIER_REQUEST_CLASS -LASSO_REGISTER_NAME_IDENTIFIER_REQUEST_GET_CLASS -
- -
-register_name_identifier_response -LassoRegisterNameIdentifierResponse -LassoRegisterNameIdentifierResponse -LassoRegisterNameIdentifierResponseClass -lasso_register_name_identifier_response_new -lasso_register_name_identifier_response_new_from_export - -LASSO_REGISTER_NAME_IDENTIFIER_RESPONSE -LASSO_IS_REGISTER_NAME_IDENTIFIER_RESPONSE -LASSO_TYPE_REGISTER_NAME_IDENTIFIER_RESPONSE -lasso_register_name_identifier_response_get_type -LASSO_REGISTER_NAME_IDENTIFIER_RESPONSE_CLASS -LASSO_IS_REGISTER_NAME_IDENTIFIER_RESPONSE_CLASS -LASSO_REGISTER_NAME_IDENTIFIER_RESPONSE_GET_CLASS -
- -
-request -LassoRequest -LassoRequest -LassoRequestClass -lasso_request_new -lasso_request_new_from_export - -LASSO_REQUEST -LASSO_IS_REQUEST -LASSO_TYPE_REQUEST -lasso_request_get_type -LASSO_REQUEST_CLASS -LASSO_IS_REQUEST_CLASS -LASSO_REQUEST_GET_CLASS -
- -
-response -LassoResponse -LassoResponse -LassoResponseClass -lasso_response_new -lasso_response_new_from_export - -LASSO_RESPONSE -LASSO_IS_RESPONSE -LASSO_TYPE_RESPONSE -lasso_response_get_type -LASSO_RESPONSE_CLASS -LASSO_IS_RESPONSE_CLASS -LASSO_RESPONSE_GET_CLASS -
- -
defederation LassoDefederation @@ -1423,31 +1163,6 @@ LASSO_IS_PROFILE_CLASS LASSO_PROFILE_GET_CLASS
-
-server -LassoServer -LassoServer -LassoServerClass -lasso_server_new -lasso_server_new_from_dump -lasso_server_add_provider -lasso_server_copy -lasso_server_dump -lasso_server_destroy -lasso_server_get_first_providerID -lasso_server_get_provider -lasso_server_get_provider_ref -lasso_server_get_providerID_from_hash - -LASSO_SERVER -LASSO_IS_SERVER -LASSO_TYPE_SERVER -lasso_server_get_type -LASSO_SERVER_CLASS -LASSO_IS_SERVER_CLASS -LASSO_SERVER_GET_CLASS -
-
session LassoSessionPrivate @@ -1475,33 +1190,7 @@ LASSO_IS_SESSION_CLASS LASSO_SESSION_GET_CLASS
- -
-saml -
- -
-lib -
-
strings
-
-tools -lasso_build_random_sequence -lasso_build_unique_id -lasso_doc_get_node_content -lasso_g_ptr_array_index -lasso_get_current_time -lasso_get_pem_file_type -lasso_get_public_key_from_pem_cert_file -lasso_query_get_value -lasso_query_to_dict -lasso_query_verify_signature -lasso_sha1 -lasso_str_escape -lasso_str_sign -lasso_str_unescape -
diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml index 042189a2..d6b3dad8 100644 --- a/docs/reference/lasso.sgml +++ b/docs/reference/lasso.sgml @@ -40,7 +40,6 @@ - @@ -106,15 +105,26 @@ implement Liberty Alliance specifications. &LassoNode; &LassoLibAssertion; + &LassoLibAuthenticationStatement; + &LassoLibAuthnContext; &LassoLibAuthnRequest; &lasso-LassoLibAuthnRequestEnvelope; &LassoLibAuthnResponse; &lasso-LassoLibAuthnResponseEnvelope; + &LassoLibFederationTerminationNotification; &LassoLibIDPEntries; &LassoLibIDPEntry; &LassoLibIDPList; + &LassoLibLogoutRequest; + &LassoLibLogoutResponse; + &LassoLibNameIdentifierMappingRequest; + &LassoLibNameIdentifierMappingResponse; + &LassoLibRegisterNameIdentifierRequest; + &LassoLibRegisterNameIdentifierResponse; &LassoLibRequestAuthnContext; &LassoLibScoping; + &LassoLibStatusResponse; + &LassoLibSubject; &LassoSamlAdvice; &LassoSamlAssertion; &LassoSamlAudienceRestrictionCondition; @@ -123,29 +133,22 @@ implement Liberty Alliance specifications. &LassoSamlConditionAbstract; &LassoSamlConditions; &LassoSamlNameIdentifier; - &LassoSamlStatementAbstract; - &LassoSamlSubject; - &LassoSamlSubjectConfirmation; - &LassoSamlSubjectLocality; - &LassoSamlSubjectStatementAbstract; + &LassoSamlpRequest; &LassoSamlpRequestAbstract; &LassoSamlpResponse; &LassoSamlpResponseAbstract; &LassoSamlpStatus; &LassoSamlpStatusCode; - &LassoLibLogoutRequest; - &LassoLibFederationTerminationNotification; - &LassoLibLogoutResponse; - &LassoLibNameIdentifierMappingRequest; - &LassoLibNameIdentifierMappingResponse; - &LassoLibRegisterNameIdentifierRequest; - &LassoLibRegisterNameIdentifierResponse; - &LassoLibStatusResponse; - &LassoLibSubject; - &LassoSamlpRequest; - &LassoLibAuthnContext; - &LassoLibAuthenticationStatement; - &lasso-export; + &LassoSamlStatementAbstract; + &LassoSamlSubject; + &LassoSamlSubjectConfirmation; + &LassoSamlSubjectLocality; + &LassoSamlSubjectStatementAbstract; + + + + Misc + &lasso-lasso; &lasso-version; 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 - +It holds all the data about a provider. @@ -73,98 +73,98 @@ Representation of a provider @Returns: - + -@provider: -@name: +@dump: @Returns: - + @provider: -@name: +@remote_provider: +@protocol_type: +@http_method: +@initiate_profile: @Returns: - + @provider: -@metadata: @Returns: - + -@dump: +@provider: +@remote_provider: +@protocol_type: @Returns: - + @provider: -@message: -@id_attr_name: -@format: +@name: @Returns: - + @provider: -@remote_provider: -@protocol_type: +@name: @Returns: - + @provider: -@remote_provider: @protocol_type: -@http_method: -@initiate_profile: +@protocol_profile: @Returns: - + @provider: -@protocol_type: -@protocol_profile: +@metadata: @Returns: - + @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 @@ + +LassoServer + + +Representation of the current server + + + +It holds the data about a provider, other providers it knows, which +certificates to use, etc. + + + + + + + + + + + + +@providers: +@services: +@private_key: +@secret_key: +@certificate: +@signature_method: + + + + + + +@metadata: +@private_key: +@secret_key: +@certificate: +@Returns: + + + + + + + +@dump: +@Returns: + + + + + + + +@server: +@role: +@metadata: +@public_key: +@ca_cert_chain: +@Returns: + + + + + + + +@server: +@service_type: +@service_endpoint: +@Returns: + + + + + + + +@server: + + + + + + + +@server: +@Returns: + + + + + + + +@server: +@Returns: + + + + + + + +@server: +@providerID: +@Returns: + + + + + + + +@server: +@b64_hash: +@Returns: + + -- cgit