summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Dauvergne <bdauvergne@entrouvert.com>2010-01-04 09:14:03 +0000
committerBenjamin Dauvergne <bdauvergne@entrouvert.com>2010-01-04 09:14:03 +0000
commit255962cc351c73230e29946c830e2b5ccb04aa36 (patch)
treefee3d4c24f5cca12717ce231c488742c73f3dba4
parente76546078f8aaba9586dd674650ad4436408186e (diff)
Core: in tools.c, complete documentation of lasso_verify_signature
-rw-r--r--lasso/xml/tools.c12
1 files changed, 10 insertions, 2 deletions
diff --git a/lasso/xml/tools.c b/lasso/xml/tools.c
index 1c18c751..4bb84312 100644
--- a/lasso/xml/tools.c
+++ b/lasso/xml/tools.c
@@ -1100,15 +1100,23 @@ lasso_saml_constrain_dsigctxt(xmlSecDSigCtxPtr dsigCtx) {
/**
* lasso_verify_signature:
* @signed_node: an #xmlNode containing an enveloped xmlDSig signature
+ * @doc: (allow-none): the eventual #xmlDoc from which the node is extracted, if none is given then it will be
+ * created
* @id_attr_name: the id attribune name for this node
- * @keys_manager: an #xmlSecKeysMnr containing the CA cert chain, to validate the key in the
+ * @keys_manager: (allow-none): an #xmlSecKeysMnr containing the CA cert chain, to validate the key in the
* signature if there is one.
- * @public_key: a public key to validate the signature, if present the function ignore the key
+ * @public_key: (allow-none): a public key to validate the signature, if present the function ignore the key
* contained in the signature.
+ * @signature_verification_option: flag to specify option about signature validation, see
+ * #SignatureVerificationOption.
+ * @uri_references: if the signature references multiple nodes, return them as a list of node IDs.
*
* This function validate a signature on an xmlNode following the instructions given in the document
* Assertions and Protocol or the OASIS Security Markup Language (SAML) V1.1.
*
+ * The only kind of references that are accepted in thoses signatures are node ID references,
+ * looking like &#35;xxx;.
+ *
* Beware that it does not validate every needed properties for a SAML assertion, request or
* response to be acceptable.
*