summaryrefslogtreecommitdiff
path: root/docs/api/tmpl/base/transforms.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/tmpl/base/transforms.sgml')
-rw-r--r--docs/api/tmpl/base/transforms.sgml1307
1 files changed, 1307 insertions, 0 deletions
diff --git a/docs/api/tmpl/base/transforms.sgml b/docs/api/tmpl/base/transforms.sgml
new file mode 100644
index 00000000..f2c89156
--- /dev/null
+++ b/docs/api/tmpl/base/transforms.sgml
@@ -0,0 +1,1307 @@
+<!-- ##### SECTION Title ##### -->
+transforms
+
+<!-- ##### SECTION Short_Description ##### -->
+Transform object definition.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Transform object definition.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### MACRO XMLSEC_TRANSFORM_BINARY_CHUNK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformIdsGet ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdsInit ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdsShutdown ##### -->
+<para>
+
+</para>
+
+@void:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdsRegisterDefault ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdsRegister ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### ENUM xmlSecTransformStatus ##### -->
+<para>
+
+</para>
+
+@xmlSecTransformStatusNone:
+@xmlSecTransformStatusWorking:
+@xmlSecTransformStatusFinished:
+@xmlSecTransformStatusOk:
+@xmlSecTransformStatusFail:
+
+<!-- ##### ENUM xmlSecTransformMode ##### -->
+<para>
+
+</para>
+
+@xmlSecTransformModeNone:
+@xmlSecTransformModePush:
+@xmlSecTransformModePop:
+
+<!-- ##### ENUM xmlSecTransformOperation ##### -->
+<para>
+
+</para>
+
+@xmlSecTransformOperationNone:
+@xmlSecTransformOperationEncode:
+@xmlSecTransformOperationDecode:
+@xmlSecTransformOperationSign:
+@xmlSecTransformOperationVerify:
+@xmlSecTransformOperationEncrypt:
+@xmlSecTransformOperationDecrypt:
+
+<!-- ##### TYPEDEF xmlSecTransformUriType ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeNone ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeEmpty ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeSameDocument ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeLocal ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeRemote ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUriTypeAny ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformUriTypeCheck ##### -->
+<para>
+
+</para>
+
+@type:
+@uri:
+@Returns:
+
+
+<!-- ##### TYPEDEF xmlSecTransformDataType ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO xmlSecTransformDataTypeUnknown ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformDataTypeBin ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformDataTypeXml ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### TYPEDEF xmlSecTransformUsage ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO xmlSecTransformUsageUnknown ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageDSigTransform ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageC14NMethod ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageDigestMethod ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageSignatureMethod ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageEncryptionMethod ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformUsageAny ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformCtxPreExecuteCallback ##### -->
+<para>
+
+</para>
+
+@transformCtx:
+@Returns:
+
+
+<!-- ##### MACRO XMLSEC_TRANSFORMCTX_FLAGS_USE_VISA3D_HACK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### STRUCT xmlSecTransformCtx ##### -->
+<para>
+
+</para>
+
+@userData:
+@flags:
+@flags2:
+@enabledUris:
+@enabledTransforms:
+@preExecCallback:
+@result:
+@status:
+@uri:
+@xptrExpr:
+@first:
+@last:
+@reserved0:
+@reserved1:
+
+<!-- ##### FUNCTION xmlSecTransformCtxCreate ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxDestroy ##### -->
+<para>
+
+</para>
+
+@ctx:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxInitialize ##### -->
+<para>
+
+</para>
+
+@ctx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxFinalize ##### -->
+<para>
+
+</para>
+
+@ctx:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxReset ##### -->
+<para>
+
+</para>
+
+@ctx:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxCopyUserPref ##### -->
+<para>
+
+</para>
+
+@dst:
+@src:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxSetUri ##### -->
+<para>
+
+</para>
+
+@ctx:
+@uri:
+@hereNode:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxAppend ##### -->
+<para>
+
+</para>
+
+@ctx:
+@transform:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxPrepend ##### -->
+<para>
+
+</para>
+
+@ctx:
+@transform:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxCreateAndAppend ##### -->
+<para>
+
+</para>
+
+@ctx:
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxCreateAndPrepend ##### -->
+<para>
+
+</para>
+
+@ctx:
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxNodeRead ##### -->
+<para>
+
+</para>
+
+@ctx:
+@node:
+@usage:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxNodesListRead ##### -->
+<para>
+
+</para>
+
+@ctx:
+@node:
+@usage:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxPrepare ##### -->
+<para>
+
+</para>
+
+@ctx:
+@inputDataType:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxBinaryExecute ##### -->
+<para>
+
+</para>
+
+@ctx:
+@data:
+@dataSize:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxUriExecute ##### -->
+<para>
+
+</para>
+
+@ctx:
+@uri:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxXmlExecute ##### -->
+<para>
+
+</para>
+
+@ctx:
+@nodes:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxExecute ##### -->
+<para>
+
+</para>
+
+@ctx:
+@doc:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxDebugDump ##### -->
+<para>
+
+</para>
+
+@ctx:
+@output:
+
+
+<!-- ##### FUNCTION xmlSecTransformCtxDebugXmlDump ##### -->
+<para>
+
+</para>
+
+@ctx:
+@output:
+
+
+<!-- ##### STRUCT xmlSecTransform ##### -->
+<para>
+
+</para>
+
+@id:
+@operation:
+@status:
+@hereNode:
+@next:
+@prev:
+@inBuf:
+@outBuf:
+@inNodes:
+@outNodes:
+@reserved0:
+@reserved1:
+
+<!-- ##### FUNCTION xmlSecTransformCreate ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDestroy ##### -->
+<para>
+
+</para>
+
+@transform:
+
+
+<!-- ##### FUNCTION xmlSecTransformNodeRead ##### -->
+<para>
+
+</para>
+
+@node:
+@usage:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformPump ##### -->
+<para>
+
+</para>
+
+@left:
+@right:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformSetKey ##### -->
+<para>
+
+</para>
+
+@transform:
+@key:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformSetKeyReq ##### -->
+<para>
+
+</para>
+
+@transform:
+@keyReq:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformVerify ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@dataSize:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformVerifyNodeContent ##### -->
+<para>
+
+</para>
+
+@transform:
+@node:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformGetDataType ##### -->
+<para>
+
+</para>
+
+@transform:
+@mode:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformPushBin ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@dataSize:
+@final:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformPopBin ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@maxDataSize:
+@dataSize:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformPushXml ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformPopXml ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformExecute ##### -->
+<para>
+
+</para>
+
+@transform:
+@last:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDebugDump ##### -->
+<para>
+
+</para>
+
+@transform:
+@output:
+
+
+<!-- ##### FUNCTION xmlSecTransformDebugXmlDump ##### -->
+<para>
+
+</para>
+
+@transform:
+@output:
+
+
+<!-- ##### MACRO xmlSecTransformGetName ##### -->
+<para>
+
+</para>
+
+@transform:
+
+
+<!-- ##### MACRO xmlSecTransformIsValid ##### -->
+<para>
+
+</para>
+
+@transform:
+
+
+<!-- ##### MACRO xmlSecTransformCheckId ##### -->
+<para>
+
+</para>
+
+@transform:
+@i:
+
+
+<!-- ##### MACRO xmlSecTransformCheckSize ##### -->
+<para>
+
+</para>
+
+@transform:
+@size:
+
+
+<!-- ##### FUNCTION xmlSecTransformConnect ##### -->
+<para>
+
+</para>
+
+@left:
+@right:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformRemove ##### -->
+<para>
+
+</para>
+
+@transform:
+
+
+<!-- ##### FUNCTION xmlSecTransformDefaultGetDataType ##### -->
+<para>
+
+</para>
+
+@transform:
+@mode:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDefaultPushBin ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@dataSize:
+@final:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDefaultPopBin ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@maxDataSize:
+@dataSize:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDefaultPushXml ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformDefaultPopXml ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCreateOutputBuffer ##### -->
+<para>
+
+</para>
+
+@transform:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformCreateInputBuffer ##### -->
+<para>
+
+</para>
+
+@transform:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformInitializeMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformFinalizeMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformGetDataTypeMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@mode:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformNodeReadMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@node:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformNodeWriteMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@node:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformSetKeyRequirementsMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@keyReq:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformSetKeyMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@key:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformVerifyMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@dataSize:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformPushBinMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@dataSize:
+@final:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformPopBinMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@data:
+@maxDataSize:
+@dataSize:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformPushXmlMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformPopXmlMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@nodes:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION xmlSecTransformExecuteMethod ##### -->
+<para>
+
+</para>
+
+@transform:
+@last:
+@transformCtx:
+@Returns:
+
+
+<!-- ##### STRUCT xmlSecTransformKlass ##### -->
+<para>
+
+</para>
+
+@klassSize:
+@objSize:
+@name:
+@href:
+@usage:
+@initialize:
+@finalize:
+@readNode:
+@writeNode:
+@setKeyReq:
+@setKey:
+@verify:
+@getDataType:
+@pushBin:
+@popBin:
+@pushXml:
+@popXml:
+@execute:
+@reserved0:
+@reserved1:
+
+<!-- ##### MACRO xmlSecTransformKlassGetName ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO xmlSecTransformIdListId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListFind ##### -->
+<para>
+
+</para>
+
+@list:
+@transformId:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListFindByHref ##### -->
+<para>
+
+</para>
+
+@list:
+@href:
+@usage:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListFindByName ##### -->
+<para>
+
+</para>
+
+@list:
+@name:
+@usage:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListDebugDump ##### -->
+<para>
+
+</para>
+
+@list:
+@output:
+
+
+<!-- ##### FUNCTION xmlSecTransformIdListDebugXmlDump ##### -->
+<para>
+
+</para>
+
+@list:
+@output:
+
+
+<!-- ##### MACRO xmlSecTransformIdUnknown ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO xmlSecTransformBase64Id ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformBase64GetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformBase64SetLineSize ##### -->
+<para>
+
+</para>
+
+@transform:
+@lineSize:
+
+
+<!-- ##### MACRO xmlSecTransformInclC14NId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformInclC14NGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformInclC14NWithCommentsId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformInclC14NWithCommentsGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformInclC14N11Id ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformInclC14N11GetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformInclC14N11WithCommentsId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformInclC14N11WithCommentsGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformExclC14NId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformExclC14NGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformExclC14NWithCommentsId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformExclC14NWithCommentsGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformEnvelopedId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformEnvelopedGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformXPathId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformXPathGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformXPath2Id ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformXPath2GetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformXPointerId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformXPointerGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformXPointerSetExpr ##### -->
+<para>
+
+</para>
+
+@transform:
+@expr:
+@nodeSetType:
+@hereNode:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformXsltId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformXsltGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformXsltSetDefaultSecurityPrefs ##### -->
+<para>
+
+</para>
+
+@sec:
+
+
+<!-- ##### MACRO xmlSecTransformRemoveXmlTagsC14NId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformRemoveXmlTagsC14NGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO xmlSecTransformVisa3DHackId ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION xmlSecTransformVisa3DHackGetKlass ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### FUNCTION xmlSecTransformVisa3DHackSetID ##### -->
+<para>
+
+</para>
+
+@transform:
+@id:
+@Returns:
+
+