Module xmlsec :: Class DSigCtx
[frames | no frames]

Class DSigCtx


Method Summary
  __init__(self, keysMngr, _obj)
Creates <dsig:Signature/> element processing context.
  __getattr__(self, name)
  __setattr__(self, name, value)
  debugDump(self, output)
Prints the debug information about dsigCtx to output.
  debugXmlDump(self, output)
Prints the debug information about dsigCtx to output file in XML format.
  destroy(self)
Destroys context object (<dsig:Signature/> element processing context).
  enableReferenceTransform(self, transformId)
Enables transformId for <dsig:Reference/> elements processing.
  enableSignatureTransform(self, transformId)
Enables transformId for <dsig:SignedInfo/> element processing.
  finalize(self)
Cleans up DSigCtx object.
  getPreSignBuffer(self)
Gets the buffer with serialized <dsig:SignedInfo/> element just before signature calculation (valid if and only if DSIG_FLAGS_STORE_SIGNATURE context flag is set).
  initialize(self, mngr)
Initializes <dsig:Signature/> element processing context.
  sign(self, tmpl)
Signs the data as described in tmpl node.
  verify(self, node)
Validates signature in the node.

Method Details

__init__(self, keysMngr=None, _obj=None)
(Constructor)

Creates <dsig:Signature/> element processing context. The caller is
responsible for destroying returned object by calling destroy method.
keysMngr : the keys manager.
Returns  : newly context object or None if an error occurs.

debugDump(self, output)

Prints the debug information about dsigCtx to output.
output : the output file.

debugXmlDump(self, output)

Prints the debug information about dsigCtx to output file in XML format.
output : the output file.

destroy(self)

Destroys context object (<dsig:Signature/> element processing context).

enableReferenceTransform(self, transformId)

Enables transformId for <dsig:Reference/> elements processing.
transformId : the transform Id klass.
Returns     : 0 on success or a negative value if an error occurs.

enableSignatureTransform(self, transformId)

Enables transformId for <dsig:SignedInfo/> element processing.
transformId : the transform Id klass.
Returns     : 0 on success or a negative value if an error occurs.

finalize(self)

Cleans up DSigCtx object.

getPreSignBuffer(self)

Gets the buffer with serialized <dsig:SignedInfo/> element just before
signature calculation (valid if and only if
DSIG_FLAGS_STORE_SIGNATURE context flag is set).
Returns : 0 on success or a negative value if an error occurs.

initialize(self, mngr)

Initializes <dsig:Signature/> element processing context. The caller is
responsible for cleaing up returned object by calling finalize method.
keysMngr : the keys manager.
Returns  : 0 on success or a negative value if an error occurs.

sign(self, tmpl)

Signs the data as described in tmpl node.
tmpl : the <dsig:Signature/> node with signature template.

verify(self, node)

Validates signature in the node. The verification result is returned
in status member of the dsigCtx object.
node    : the <dsig:Signature/> node.
Returns : 0 on success (check status member of dsigCtx to get signature
verification result) or a negative value if an error occurs.

Generated by Epydoc 2.1 on Mon Jan 31 14:03:13 2005 http://epydoc.sf.net