diff options
Diffstat (limited to 'docs/api/tmpl/base')
26 files changed, 9251 insertions, 0 deletions
diff --git a/docs/api/tmpl/base/app.sgml b/docs/api/tmpl/base/app.sgml new file mode 100644 index 00000000..b725a3b7 --- /dev/null +++ b/docs/api/tmpl/base/app.sgml @@ -0,0 +1,1112 @@ +<!-- ##### SECTION Title ##### --> +app + +<!-- ##### SECTION Short_Description ##### --> +Crypto-engine independent application support function. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Crypto-engine application support function used by xmlsec command line utility. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecCryptoInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoKeysMngrInit ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataAesId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataAesGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataDesId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataDesGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataDsaId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataDsaGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataEcdsaId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataEcdsaGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataGost2001Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataGost2001GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataGostR3410_2012_256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataGostR3410_2012_256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataGostR3410_2012_512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataGostR3410_2012_512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataHmacId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataHmacGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataRsaId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataRsaGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataX509Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataX509GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataRawX509CertId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataRawX509CertGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecX509StoreId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecX509StoreGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformAes128CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformAes128CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformAes192CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformAes192CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformAes256CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformAes256CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformKWAes128Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformKWAes128GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformKWAes192Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformKWAes192GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformKWAes256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformKWAes256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformDes3CbcId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformDes3CbcGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformKWDes3Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformKWDes3GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformDsaSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformDsaSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformDsaSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformDsaSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformEcdsaSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformEcdsaSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformEcdsaSha224Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformEcdsaSha224GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformEcdsaSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformEcdsaSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformEcdsaSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformEcdsaSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformEcdsaSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformEcdsaSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGost2001GostR3411_94Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGost2001GostR3411_94GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGostR3410_2012GostR3411_2012_256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGostR3410_2012GostR3411_2012_256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGostR3410_2012GostR3411_2012_512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGostR3410_2012GostR3411_2012_512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacRipemd160Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacRipemd160GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacSha224Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacSha224GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformHmacSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformHmacSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRipemd160Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRipemd160GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaMd5Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaMd5GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaRipemd160Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaRipemd160GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaSha224Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaSha224GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaPkcs1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaPkcs1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformRsaOaepId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformRsaOaepGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGostR3411_94Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGostR3411_94GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGostR3411_2012_256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGostR3411_2012_256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformGostR3411_2012_512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformGostR3411_2012_512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformSha1Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformSha1GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformSha224Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformSha224GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformSha256Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformSha256GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformSha384Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformSha384GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecTransformSha512Id ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformSha512GetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppInit ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppDefaultKeysMngrInit ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppDefaultKeysMngrAdoptKey ##### --> +<para> + +</para> + +@mngr: +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppDefaultKeysMngrLoad ##### --> +<para> + +</para> + +@mngr: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppDefaultKeysMngrSave ##### --> +<para> + +</para> + +@mngr: +@filename: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeysMngrCertLoad ##### --> +<para> + +</para> + +@mngr: +@filename: +@format: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeysMngrCertLoadMemory ##### --> +<para> + +</para> + +@mngr: +@data: +@dataSize: +@format: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeyLoad ##### --> +<para> + +</para> + +@filename: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeyLoadMemory ##### --> +<para> + +</para> + +@data: +@dataSize: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppPkcs12Load ##### --> +<para> + +</para> + +@filename: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppPkcs12LoadMemory ##### --> +<para> + +</para> + +@data: +@dataSize: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeyCertLoad ##### --> +<para> + +</para> + +@key: +@filename: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppKeyCertLoadMemory ##### --> +<para> + +</para> + +@key: +@data: +@dataSize: +@format: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoAppGetDefaultPwdCallback ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/base64.sgml b/docs/api/tmpl/base/base64.sgml new file mode 100644 index 00000000..a6d4ebfa --- /dev/null +++ b/docs/api/tmpl/base/base64.sgml @@ -0,0 +1,129 @@ +<!-- ##### SECTION Title ##### --> +base64 + +<!-- ##### SECTION Short_Description ##### --> +Base64 encoding/decoding functions. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Base64 encoding/decoding functions. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO XMLSEC_BASE64_LINESIZE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecBase64GetDefaultLineSize ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64SetDefaultLineSize ##### --> +<para> + +</para> + +@columns: + + +<!-- ##### FUNCTION xmlSecBase64CtxCreate ##### --> +<para> + +</para> + +@encode: +@columns: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64CtxDestroy ##### --> +<para> + +</para> + +@ctx: + + +<!-- ##### FUNCTION xmlSecBase64CtxInitialize ##### --> +<para> + +</para> + +@ctx: +@encode: +@columns: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64CtxFinalize ##### --> +<para> + +</para> + +@ctx: + + +<!-- ##### FUNCTION xmlSecBase64CtxUpdate ##### --> +<para> + +</para> + +@ctx: +@in: +@inSize: +@out: +@outSize: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64CtxFinal ##### --> +<para> + +</para> + +@ctx: +@out: +@outSize: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64Encode ##### --> +<para> + +</para> + +@buf: +@len: +@columns: +@Returns: + + +<!-- ##### FUNCTION xmlSecBase64Decode ##### --> +<para> + +</para> + +@str: +@buf: +@len: +@Returns: + + diff --git a/docs/api/tmpl/base/bn.sgml b/docs/api/tmpl/base/bn.sgml new file mode 100644 index 00000000..8b000f2b --- /dev/null +++ b/docs/api/tmpl/base/bn.sgml @@ -0,0 +1,263 @@ +<!-- ##### SECTION Title ##### --> +bn + +<!-- ##### SECTION Short_Description ##### --> +Big numbers support functions. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Big numbers support functions. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM xmlSecBnFormat ##### --> +<para> + +</para> + +@xmlSecBnBase64: +@xmlSecBnHex: +@xmlSecBnDec: + +<!-- ##### FUNCTION xmlSecBnCreate ##### --> +<para> + +</para> + +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnDestroy ##### --> +<para> + +</para> + +@bn: + + +<!-- ##### FUNCTION xmlSecBnInitialize ##### --> +<para> + +</para> + +@bn: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnFinalize ##### --> +<para> + +</para> + +@bn: + + +<!-- ##### FUNCTION xmlSecBnGetData ##### --> +<para> + +</para> + +@bn: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnSetData ##### --> +<para> + +</para> + +@bn: +@data: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnGetSize ##### --> +<para> + +</para> + +@bn: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnZero ##### --> +<para> + +</para> + +@bn: + + +<!-- ##### FUNCTION xmlSecBnFromString ##### --> +<para> + +</para> + +@bn: +@str: +@base: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnToString ##### --> +<para> + +</para> + +@bn: +@base: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnFromHexString ##### --> +<para> + +</para> + +@bn: +@str: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnToHexString ##### --> +<para> + +</para> + +@bn: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnFromDecString ##### --> +<para> + +</para> + +@bn: +@str: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnToDecString ##### --> +<para> + +</para> + +@bn: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnMul ##### --> +<para> + +</para> + +@bn: +@multiplier: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnDiv ##### --> +<para> + +</para> + +@bn: +@divider: +@mod: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnAdd ##### --> +<para> + +</para> + +@bn: +@delta: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnReverse ##### --> +<para> + +</para> + +@bn: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnCompare ##### --> +<para> + +</para> + +@bn: +@data: +@dataSize: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnCompareReverse ##### --> +<para> + +</para> + +@bn: +@data: +@dataSize: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnGetNodeValue ##### --> +<para> + +</para> + +@bn: +@cur: +@format: +@reverse: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnSetNodeValue ##### --> +<para> + +</para> + +@bn: +@cur: +@format: +@reverse: +@addLineBreaks: +@Returns: + + +<!-- ##### FUNCTION xmlSecBnBlobSetNodeValue ##### --> +<para> + +</para> + +@data: +@dataSize: +@cur: +@format: +@reverse: +@addLineBreaks: +@Returns: + + diff --git a/docs/api/tmpl/base/buffer.sgml b/docs/api/tmpl/base/buffer.sgml new file mode 100644 index 00000000..33a89bdb --- /dev/null +++ b/docs/api/tmpl/base/buffer.sgml @@ -0,0 +1,232 @@ +<!-- ##### SECTION Title ##### --> +buffer + +<!-- ##### SECTION Short_Description ##### --> +Binary buffer implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Binary buffer implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM xmlSecAllocMode ##### --> +<para> + +</para> + +@xmlSecAllocModeExact: +@xmlSecAllocModeDouble: + +<!-- ##### STRUCT xmlSecBuffer ##### --> +<para> + +</para> + +@data: +@size: +@maxSize: +@allocMode: + +<!-- ##### FUNCTION xmlSecBufferSetDefaultAllocMode ##### --> +<para> + +</para> + +@defAllocMode: +@defInitialSize: + + +<!-- ##### FUNCTION xmlSecBufferCreate ##### --> +<para> + +</para> + +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferDestroy ##### --> +<para> + +</para> + +@buf: + + +<!-- ##### FUNCTION xmlSecBufferInitialize ##### --> +<para> + +</para> + +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferFinalize ##### --> +<para> + +</para> + +@buf: + + +<!-- ##### FUNCTION xmlSecBufferGetData ##### --> +<para> + +</para> + +@buf: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferSetData ##### --> +<para> + +</para> + +@buf: +@data: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferGetSize ##### --> +<para> + +</para> + +@buf: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferSetSize ##### --> +<para> + +</para> + +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferGetMaxSize ##### --> +<para> + +</para> + +@buf: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferSetMaxSize ##### --> +<para> + +</para> + +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferEmpty ##### --> +<para> + +</para> + +@buf: + + +<!-- ##### FUNCTION xmlSecBufferAppend ##### --> +<para> + +</para> + +@buf: +@data: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferPrepend ##### --> +<para> + +</para> + +@buf: +@data: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferRemoveHead ##### --> +<para> + +</para> + +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferRemoveTail ##### --> +<para> + +</para> + +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferReadFile ##### --> +<para> + +</para> + +@buf: +@filename: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferBase64NodeContentRead ##### --> +<para> + +</para> + +@buf: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferBase64NodeContentWrite ##### --> +<para> + +</para> + +@buf: +@node: +@columns: +@Returns: + + +<!-- ##### FUNCTION xmlSecBufferCreateOutputBuffer ##### --> +<para> + +</para> + +@buf: +@Returns: + + diff --git a/docs/api/tmpl/base/dl.sgml b/docs/api/tmpl/base/dl.sgml new file mode 100644 index 00000000..88ca8203 --- /dev/null +++ b/docs/api/tmpl/base/dl.sgml @@ -0,0 +1,94 @@ +<!-- ##### SECTION Title ##### --> +dl + +<!-- ##### SECTION Short_Description ##### --> +Dynamic crypto-engine library loading support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Dynamic crypto-engine library loading support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms ##### --> +<para> + +</para> + +@functions: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLLoadLibrary ##### --> +<para> + +</para> + +@crypto: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLGetLibraryFunctions ##### --> +<para> + +</para> + +@crypto: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLUnloadLibrary ##### --> +<para> + +</para> + +@crypto: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLSetFunctions ##### --> +<para> + +</para> + +@functions: +@Returns: + + +<!-- ##### FUNCTION xmlSecCryptoDLGetFunctions ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/errors.sgml b/docs/api/tmpl/base/errors.sgml new file mode 100644 index 00000000..185ae22a --- /dev/null +++ b/docs/api/tmpl/base/errors.sgml @@ -0,0 +1,490 @@ +<!-- ##### SECTION Title ##### --> +errors + +<!-- ##### SECTION Short_Description ##### --> +Error/log messages support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Error/log messages support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO XMLSEC_ERRORS_R_XMLSEC_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_MALLOC_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_STRDUP_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CRYPTO_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_XML_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_XSLT_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_IO_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_DISABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_NOT_IMPLEMENTED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_RESULT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_OPERATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_STATUS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_FORMAT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_DATA_NOT_MATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_NODE_CONTENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_NODE_ATTRIBUTE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_MISSING_NODE_ATTRIBUTE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_NODE_ALREADY_PRESENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_UNEXPECTED_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_NODE_NOT_FOUND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_TRANSFORM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_TRANSFORM_KEY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_URI_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_TRANSFORM_SAME_DOCUMENT_REQUIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_TRANSFORM_DISABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_KEY_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_KEY_DATA_NOT_FOUND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_KEY_DATA_ALREADY_EXIST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_INVALID_KEY_DATA_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_KEY_NOT_FOUND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_KEYDATA_DISABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_MAX_RETRIEVALS_LEVEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_MAX_RETRIEVAL_TYPE_MISMATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_MAX_ENCKEY_LEVEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_VERIFY_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_NOT_FOUND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_REVOKED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_ISSUER_FAILED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_NOT_YET_VALID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_CERT_HAS_EXPIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_DSIG_NO_REFERENCES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_DSIG_INVALID_REFERENCE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_R_ASSERTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_ERRORS_MAX_NUMBER ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION xmlSecErrorsCallback ##### --> +<para> + +</para> + +@file: +@line: +@func: +@errorObject: +@errorSubject: +@reason: +@msg: + + +<!-- ##### FUNCTION xmlSecErrorsInit ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION xmlSecErrorsShutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION xmlSecErrorsSetCallback ##### --> +<para> + +</para> + +@callback: + + +<!-- ##### FUNCTION xmlSecErrorsDefaultCallback ##### --> +<para> + +</para> + +@file: +@line: +@func: +@errorObject: +@errorSubject: +@reason: +@msg: + + +<!-- ##### FUNCTION xmlSecErrorsDefaultCallbackEnableOutput ##### --> +<para> + +</para> + +@enabled: + + +<!-- ##### FUNCTION xmlSecErrorsGetCode ##### --> +<para> + +</para> + +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecErrorsGetMsg ##### --> +<para> + +</para> + +@pos: +@Returns: + + +<!-- ##### MACRO XMLSEC_ERRORS_HERE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecErrorsSafeString ##### --> +<para> + +</para> + +@str: + + +<!-- ##### MACRO XMLSEC_ERRORS_NO_MESSAGE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecError ##### --> +<para> + +</para> + +@file: +@line: +@func: +@errorObject: +@errorSubject: +@reason: +@msg: +@...: + + +<!-- ##### MACRO xmlSecAssert ##### --> +<para> + +</para> + +@p: + + +<!-- ##### MACRO xmlSecAssert2 ##### --> +<para> + +</para> + +@p: +@ret: + + diff --git a/docs/api/tmpl/base/exports.sgml b/docs/api/tmpl/base/exports.sgml new file mode 100644 index 00000000..f4d396d5 --- /dev/null +++ b/docs/api/tmpl/base/exports.sgml @@ -0,0 +1,29 @@ +<!-- ##### SECTION Title ##### --> +exports + +<!-- ##### SECTION Short_Description ##### --> +Black magic to export functions on Windows. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Black magic to export functions on Windows. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO extern ##### --> +<para> + +</para> + + + diff --git a/docs/api/tmpl/base/io.sgml b/docs/api/tmpl/base/io.sgml new file mode 100644 index 00000000..494ae00d --- /dev/null +++ b/docs/api/tmpl/base/io.sgml @@ -0,0 +1,103 @@ +<!-- ##### SECTION Title ##### --> +io + +<!-- ##### SECTION Short_Description ##### --> +Input/output support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Input/output support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecIOInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecIOShutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION xmlSecIOCleanupCallbacks ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION xmlSecIORegisterDefaultCallbacks ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecIORegisterCallbacks ##### --> +<para> + +</para> + +@matchFunc: +@openFunc: +@readFunc: +@closeFunc: +@Returns: + + +<!-- ##### MACRO xmlSecTransformInputURIId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformInputURIGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecTransformInputURIOpen ##### --> +<para> + +</para> + +@transform: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecTransformInputURIClose ##### --> +<para> + +</para> + +@transform: +@Returns: + + diff --git a/docs/api/tmpl/base/keyinfo.sgml b/docs/api/tmpl/base/keyinfo.sgml new file mode 100644 index 00000000..e6ea3916 --- /dev/null +++ b/docs/api/tmpl/base/keyinfo.sgml @@ -0,0 +1,312 @@ +<!-- ##### SECTION Title ##### --> +keyinfo + +<!-- ##### SECTION Short_Description ##### --> +<dsig:KeyInfo/> node parser. + +<!-- ##### SECTION Long_Description ##### --> +<para> +<dsig:KeyInfo/> node parser. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecKeyInfoNodeRead ##### --> +<para> + +</para> + +@keyInfoNode: +@key: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyInfoNodeWrite ##### --> +<para> + +</para> + +@keyInfoNode: +@key: +@keyInfoCtx: +@Returns: + + +<!-- ##### ENUM xmlSecKeyInfoMode ##### --> +<para> + +</para> + +@xmlSecKeyInfoModeRead: +@xmlSecKeyInfoModeWrite: + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_DONT_STOP_ON_KEY_FOUND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_STOP_ON_UNKNOWN_CHILD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_KEYNAME_STOP_ON_UNKNOWN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_KEYVALUE_STOP_ON_UNKNOWN_CHILD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_RETRMETHOD_STOP_ON_UNKNOWN_HREF ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_RETRMETHOD_STOP_ON_MISMATCH_HREF ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_X509DATA_STOP_ON_UNKNOWN_CHILD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_X509DATA_DONT_VERIFY_CERTS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_X509DATA_STOP_ON_UNKNOWN_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_X509DATA_STOP_ON_INVALID_CERT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_ENCKEY_DONT_STOP_ON_FAILED_DECRYPTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_STOP_ON_EMPTY_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_KEYINFO_FLAGS_X509DATA_SKIP_STRICT_CHECKS ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT xmlSecKeyInfoCtx ##### --> +<para> + +</para> + +@userData: +@flags: +@flags2: +@keysMngr: +@mode: +@enabledKeyData: +@base64LineSize: +@retrievalMethodCtx: +@maxRetrievalMethodLevel: +@encCtx: +@maxEncryptedKeyLevel: +@certsVerificationTime: +@certsVerificationDepth: +@pgpReserved: +@curRetrievalMethodLevel: +@curEncryptedKeyLevel: +@keyReq: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecKeyInfoCtxCreate ##### --> +<para> + +</para> + +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxDestroy ##### --> +<para> + +</para> + +@keyInfoCtx: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxInitialize ##### --> +<para> + +</para> + +@keyInfoCtx: +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxFinalize ##### --> +<para> + +</para> + +@keyInfoCtx: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxReset ##### --> +<para> + +</para> + +@keyInfoCtx: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxCopyUserPref ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxCreateEncCtx ##### --> +<para> + +</para> + +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxDebugDump ##### --> +<para> + +</para> + +@keyInfoCtx: +@output: + + +<!-- ##### FUNCTION xmlSecKeyInfoCtxDebugXmlDump ##### --> +<para> + +</para> + +@keyInfoCtx: +@output: + + +<!-- ##### MACRO xmlSecKeyDataNameId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataNameGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataValueId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataValueGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataRetrievalMethodId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataRetrievalMethodGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataEncryptedKeyId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataEncryptedKeyGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/keys.sgml b/docs/api/tmpl/base/keys.sgml new file mode 100644 index 00000000..7bd74cfa --- /dev/null +++ b/docs/api/tmpl/base/keys.sgml @@ -0,0 +1,521 @@ +<!-- ##### SECTION Title ##### --> +keys + +<!-- ##### SECTION Short_Description ##### --> +Crypto key object definition. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Crypto key object definition. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF xmlSecKeyUsage ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecKeyUsageSign ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyUsageVerify ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyUsageEncrypt ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyUsageDecrypt ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyUsageKeyExchange ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyUsageAny ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyUseWithInitialize ##### --> +<para> + +</para> + +@keyUseWith: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyUseWithFinalize ##### --> +<para> + +</para> + +@keyUseWith: + + +<!-- ##### FUNCTION xmlSecKeyUseWithReset ##### --> +<para> + +</para> + +@keyUseWith: + + +<!-- ##### FUNCTION xmlSecKeyUseWithCopy ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyUseWithCreate ##### --> +<para> + +</para> + +@application: +@identifier: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyUseWithDuplicate ##### --> +<para> + +</para> + +@keyUseWith: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyUseWithDestroy ##### --> +<para> + +</para> + +@keyUseWith: + + +<!-- ##### FUNCTION xmlSecKeyUseWithSet ##### --> +<para> + +</para> + +@keyUseWith: +@application: +@identifier: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyUseWithDebugDump ##### --> +<para> + +</para> + +@keyUseWith: +@output: + + +<!-- ##### FUNCTION xmlSecKeyUseWithDebugXmlDump ##### --> +<para> + +</para> + +@keyUseWith: +@output: + + +<!-- ##### STRUCT xmlSecKeyUseWith ##### --> +<para> + +</para> + +@application: +@identifier: +@reserved1: +@reserved2: + +<!-- ##### MACRO xmlSecKeyUseWithPtrListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyUseWithPtrListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### STRUCT xmlSecKeyReq ##### --> +<para> + +</para> + +@keyId: +@keyType: +@keyUsage: +@keyBitsSize: +@keyUseWithList: +@reserved1: +@reserved2: + +<!-- ##### FUNCTION xmlSecKeyReqInitialize ##### --> +<para> + +</para> + +@keyReq: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReqFinalize ##### --> +<para> + +</para> + +@keyReq: + + +<!-- ##### FUNCTION xmlSecKeyReqReset ##### --> +<para> + +</para> + +@keyReq: + + +<!-- ##### FUNCTION xmlSecKeyReqCopy ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReqMatchKey ##### --> +<para> + +</para> + +@keyReq: +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReqMatchKeyValue ##### --> +<para> + +</para> + +@keyReq: +@value: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReqDebugDump ##### --> +<para> + +</para> + +@keyReq: +@output: + + +<!-- ##### FUNCTION xmlSecKeyReqDebugXmlDump ##### --> +<para> + +</para> + +@keyReq: +@output: + + +<!-- ##### STRUCT xmlSecKey ##### --> +<para> + +</para> + +@name: +@value: +@dataList: +@usage: +@notValidBefore: +@notValidAfter: + +<!-- ##### FUNCTION xmlSecKeyCreate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDestroy ##### --> +<para> + +</para> + +@key: + + +<!-- ##### FUNCTION xmlSecKeyEmpty ##### --> +<para> + +</para> + +@key: + + +<!-- ##### FUNCTION xmlSecKeyDuplicate ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyCopy ##### --> +<para> + +</para> + +@keyDst: +@keySrc: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyGetName ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeySetName ##### --> +<para> + +</para> + +@key: +@name: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyGetType ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyGetValue ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeySetValue ##### --> +<para> + +</para> + +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyGetData ##### --> +<para> + +</para> + +@key: +@dataId: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyEnsureData ##### --> +<para> + +</para> + +@key: +@dataId: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyAdoptData ##### --> +<para> + +</para> + +@key: +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDebugDump ##### --> +<para> + +</para> + +@key: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDebugXmlDump ##### --> +<para> + +</para> + +@key: +@output: + + +<!-- ##### FUNCTION xmlSecKeyGenerate ##### --> +<para> + +</para> + +@dataId: +@sizeBits: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyGenerateByName ##### --> +<para> + +</para> + +@name: +@sizeBits: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyMatch ##### --> +<para> + +</para> + +@key: +@name: +@keyReq: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReadBuffer ##### --> +<para> + +</para> + +@dataId: +@buffer: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReadBinaryFile ##### --> +<para> + +</para> + +@dataId: +@filename: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyReadMemory ##### --> +<para> + +</para> + +@dataId: +@data: +@dataSize: +@Returns: + + +<!-- ##### MACRO xmlSecKeyIsValid ##### --> +<para> + +</para> + +@key: + + +<!-- ##### MACRO xmlSecKeyCheckId ##### --> +<para> + +</para> + +@key: +@keyId: + + +<!-- ##### MACRO xmlSecKeyPtrListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyPtrListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/keysdata.sgml b/docs/api/tmpl/base/keysdata.sgml new file mode 100644 index 00000000..32605213 --- /dev/null +++ b/docs/api/tmpl/base/keysdata.sgml @@ -0,0 +1,930 @@ +<!-- ##### SECTION Title ##### --> +keysdata + +<!-- ##### SECTION Short_Description ##### --> +Crypto key data object definition. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Crypto key data object definition. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF xmlSecKeyDataUsage ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecKeyDataUsageUnknown ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyInfoNodeRead ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyInfoNodeWrite ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyValueNodeRead ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyValueNodeWrite ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageRetrievalMethodNodeXml ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageRetrievalMethodNodeBin ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageAny ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyInfoNode ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageKeyValueNode ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataUsageRetrievalMethodNode ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF xmlSecKeyDataType ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecKeyDataTypeUnknown ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypeNone ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypePublic ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypePrivate ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypeSymmetric ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypeSession ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypePermanent ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypeTrusted ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecKeyDataTypeAny ##### --> +<para> + +</para> + + + +<!-- ##### ENUM xmlSecKeyDataFormat ##### --> +<para> + +</para> + +@xmlSecKeyDataFormatUnknown: +@xmlSecKeyDataFormatBinary: +@xmlSecKeyDataFormatPem: +@xmlSecKeyDataFormatDer: +@xmlSecKeyDataFormatPkcs8Pem: +@xmlSecKeyDataFormatPkcs8Der: +@xmlSecKeyDataFormatPkcs12: +@xmlSecKeyDataFormatCertPem: +@xmlSecKeyDataFormatCertDer: + +<!-- ##### FUNCTION xmlSecKeyDataIdsGet ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdsInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdsShutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION xmlSecKeyDataIdsRegisterDefault ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdsRegister ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### STRUCT xmlSecKeyData ##### --> +<para> + +</para> + +@id: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecKeyDataCreate ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataDuplicate ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataDestroy ##### --> +<para> + +</para> + +@data: + + +<!-- ##### FUNCTION xmlSecKeyDataGenerate ##### --> +<para> + +</para> + +@data: +@sizeBits: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataGetType ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataGetSize ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataGetIdentifier ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataDebugDump ##### --> +<para> + +</para> + +@data: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDataDebugXmlDump ##### --> +<para> + +</para> + +@data: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDataXmlRead ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataXmlWrite ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinRead ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinWrite ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataGetName ##### --> +<para> + +</para> + +@data: + + +<!-- ##### MACRO xmlSecKeyDataIsValid ##### --> +<para> + +</para> + +@data: + + +<!-- ##### MACRO xmlSecKeyDataCheckId ##### --> +<para> + +</para> + +@data: +@dataId: + + +<!-- ##### MACRO xmlSecKeyDataCheckUsage ##### --> +<para> + +</para> + +@data: +@usg: + + +<!-- ##### MACRO xmlSecKeyDataCheckSize ##### --> +<para> + +</para> + +@data: +@size: + + +<!-- ##### MACRO xmlSecKeyDataIdUnknown ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION xmlSecKeyDataInitMethod ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataDuplicateMethod ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataFinalizeMethod ##### --> +<para> + +</para> + +@data: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataXmlReadMethod ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataXmlWriteMethod ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataBinReadMethod ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataBinWriteMethod ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataGenerateMethod ##### --> +<para> + +</para> + +@data: +@sizeBits: +@type: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataGetTypeMethod ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataGetSizeMethod ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataGetIdentifierMethod ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataDebugDumpMethod ##### --> +<para> + +</para> + +@data: +@output: + + +<!-- ##### STRUCT xmlSecKeyDataKlass ##### --> +<para> + +</para> + +@klassSize: +@objSize: +@name: +@usage: +@href: +@dataNodeName: +@dataNodeNs: +@initialize: +@duplicate: +@finalize: +@generate: +@getType: +@getSize: +@getIdentifier: +@xmlRead: +@xmlWrite: +@binRead: +@binWrite: +@debugDump: +@debugXmlDump: +@reserved0: +@reserved1: + +<!-- ##### MACRO xmlSecKeyDataKlassGetName ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO xmlSecKeyDataListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecKeyDataIdListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataIdListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListFind ##### --> +<para> + +</para> + +@list: +@dataId: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListFindByNode ##### --> +<para> + +</para> + +@list: +@nodeName: +@nodeNs: +@usage: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListFindByHref ##### --> +<para> + +</para> + +@list: +@href: +@usage: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListFindByName ##### --> +<para> + +</para> + +@list: +@name: +@usage: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListDebugDump ##### --> +<para> + +</para> + +@list: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDataIdListDebugXmlDump ##### --> +<para> + +</para> + +@list: +@output: + + +<!-- ##### MACRO xmlSecKeyDataBinarySize ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueInitialize ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueDuplicate ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueFinalize ##### --> +<para> + +</para> + +@data: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueXmlRead ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueXmlWrite ##### --> +<para> + +</para> + +@id: +@key: +@node: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueBinRead ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueBinWrite ##### --> +<para> + +</para> + +@id: +@key: +@buf: +@bufSize: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueDebugDump ##### --> +<para> + +</para> + +@data: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueDebugXmlDump ##### --> +<para> + +</para> + +@data: +@output: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueGetSize ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueGetBuffer ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataBinaryValueSetBuffer ##### --> +<para> + +</para> + +@data: +@buf: +@bufSize: +@Returns: + + +<!-- ##### STRUCT xmlSecKeyDataStore ##### --> +<para> + +</para> + +@id: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecKeyDataStoreCreate ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyDataStoreDestroy ##### --> +<para> + +</para> + +@store: + + +<!-- ##### MACRO xmlSecKeyDataStoreGetName ##### --> +<para> + +</para> + +@store: + + +<!-- ##### MACRO xmlSecKeyDataStoreIsValid ##### --> +<para> + +</para> + +@store: + + +<!-- ##### MACRO xmlSecKeyDataStoreCheckId ##### --> +<para> + +</para> + +@store: +@storeId: + + +<!-- ##### MACRO xmlSecKeyDataStoreCheckSize ##### --> +<para> + +</para> + +@store: +@size: + + +<!-- ##### MACRO xmlSecKeyDataStoreIdUnknown ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION xmlSecKeyDataStoreInitializeMethod ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyDataStoreFinalizeMethod ##### --> +<para> + +</para> + +@store: + + +<!-- ##### STRUCT xmlSecKeyDataStoreKlass ##### --> +<para> + +</para> + +@klassSize: +@objSize: +@name: +@initialize: +@finalize: +@reserved0: +@reserved1: + +<!-- ##### MACRO xmlSecKeyDataStoreKlassGetName ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO xmlSecKeyDataStorePtrListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecKeyDataStorePtrListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/keysmngr.sgml b/docs/api/tmpl/base/keysmngr.sgml new file mode 100644 index 00000000..6f55ffa9 --- /dev/null +++ b/docs/api/tmpl/base/keysmngr.sgml @@ -0,0 +1,303 @@ +<!-- ##### SECTION Title ##### --> +keysmngr + +<!-- ##### SECTION Short_Description ##### --> +Keys manager object support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Keys manager object support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecKeysMngrCreate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeysMngrDestroy ##### --> +<para> + +</para> + +@mngr: + + +<!-- ##### FUNCTION xmlSecKeysMngrFindKey ##### --> +<para> + +</para> + +@mngr: +@name: +@keyInfoCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeysMngrAdoptKeysStore ##### --> +<para> + +</para> + +@mngr: +@store: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeysMngrGetKeysStore ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeysMngrAdoptDataStore ##### --> +<para> + +</para> + +@mngr: +@store: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeysMngrGetDataStore ##### --> +<para> + +</para> + +@mngr: +@id: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecGetKeyCallback ##### --> +<para> + +</para> + +@keyInfoNode: +@keyInfoCtx: +@Returns: + + +<!-- ##### STRUCT xmlSecKeysMngr ##### --> +<para> + +</para> + +@keysStore: +@storesList: +@getKey: + +<!-- ##### FUNCTION xmlSecKeysMngrGetKey ##### --> +<para> + +</para> + +@keyInfoNode: +@keyInfoCtx: +@Returns: + + +<!-- ##### STRUCT xmlSecKeyStore ##### --> +<para> + +</para> + +@id: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecKeyStoreCreate ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecKeyStoreDestroy ##### --> +<para> + +</para> + +@store: + + +<!-- ##### FUNCTION xmlSecKeyStoreFindKey ##### --> +<para> + +</para> + +@store: +@name: +@keyInfoCtx: +@Returns: + + +<!-- ##### MACRO xmlSecKeyStoreGetName ##### --> +<para> + +</para> + +@store: + + +<!-- ##### MACRO xmlSecKeyStoreIsValid ##### --> +<para> + +</para> + +@store: + + +<!-- ##### MACRO xmlSecKeyStoreCheckId ##### --> +<para> + +</para> + +@store: +@storeId: + + +<!-- ##### MACRO xmlSecKeyStoreCheckSize ##### --> +<para> + +</para> + +@store: +@size: + + +<!-- ##### MACRO xmlSecKeyStoreIdUnknown ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION xmlSecKeyStoreInitializeMethod ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecKeyStoreFinalizeMethod ##### --> +<para> + +</para> + +@store: + + +<!-- ##### USER_FUNCTION xmlSecKeyStoreFindKeyMethod ##### --> +<para> + +</para> + +@store: +@name: +@keyInfoCtx: +@Returns: + + +<!-- ##### STRUCT xmlSecKeyStoreKlass ##### --> +<para> + +</para> + +@klassSize: +@objSize: +@name: +@initialize: +@finalize: +@findKey: +@reserved0: +@reserved1: + +<!-- ##### MACRO xmlSecKeyStoreKlassGetName ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO xmlSecSimpleKeysStoreId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecSimpleKeysStoreGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecSimpleKeysStoreAdoptKey ##### --> +<para> + +</para> + +@store: +@key: +@Returns: + + +<!-- ##### FUNCTION xmlSecSimpleKeysStoreLoad ##### --> +<para> + +</para> + +@store: +@uri: +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecSimpleKeysStoreSave ##### --> +<para> + +</para> + +@store: +@filename: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecSimpleKeysStoreGetKeys ##### --> +<para> + +</para> + +@store: +@Returns: + + diff --git a/docs/api/tmpl/base/list.sgml b/docs/api/tmpl/base/list.sgml new file mode 100644 index 00000000..3d62e65a --- /dev/null +++ b/docs/api/tmpl/base/list.sgml @@ -0,0 +1,275 @@ +<!-- ##### SECTION Title ##### --> +list + +<!-- ##### SECTION Short_Description ##### --> +Generic list structure implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Generic list structure implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT xmlSecPtrList ##### --> +<para> + +</para> + +@id: +@data: +@use: +@max: +@allocMode: + +<!-- ##### FUNCTION xmlSecPtrListSetDefaultAllocMode ##### --> +<para> + +</para> + +@defAllocMode: +@defInitialSize: + + +<!-- ##### FUNCTION xmlSecPtrListInitialize ##### --> +<para> + +</para> + +@list: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListFinalize ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION xmlSecPtrListCreate ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListDestroy ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION xmlSecPtrListEmpty ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION xmlSecPtrListCopy ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListDuplicate ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListGetSize ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListGetItem ##### --> +<para> + +</para> + +@list: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListAdd ##### --> +<para> + +</para> + +@list: +@item: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListSet ##### --> +<para> + +</para> + +@list: +@item: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListRemove ##### --> +<para> + +</para> + +@list: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListRemoveAndReturn ##### --> +<para> + +</para> + +@list: +@pos: +@Returns: + + +<!-- ##### FUNCTION xmlSecPtrListDebugDump ##### --> +<para> + +</para> + +@list: +@output: + + +<!-- ##### FUNCTION xmlSecPtrListDebugXmlDump ##### --> +<para> + +</para> + +@list: +@output: + + +<!-- ##### MACRO xmlSecPtrListGetName ##### --> +<para> + +</para> + +@list: + + +<!-- ##### MACRO xmlSecPtrListIsValid ##### --> +<para> + +</para> + +@list: + + +<!-- ##### MACRO xmlSecPtrListCheckId ##### --> +<para> + +</para> + +@list: +@dataId: + + +<!-- ##### MACRO xmlSecPtrListIdUnknown ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION xmlSecPtrDuplicateItemMethod ##### --> +<para> + +</para> + +@ptr: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecPtrDestroyItemMethod ##### --> +<para> + +</para> + +@ptr: + + +<!-- ##### USER_FUNCTION xmlSecPtrDebugDumpItemMethod ##### --> +<para> + +</para> + +@ptr: +@output: + + +<!-- ##### STRUCT xmlSecPtrListKlass ##### --> +<para> + +</para> + +@name: +@duplicateItem: +@destroyItem: +@debugDumpItem: +@debugXmlDumpItem: + +<!-- ##### MACRO xmlSecPtrListKlassGetName ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO xmlSecStringListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecStringListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/membuf.sgml b/docs/api/tmpl/base/membuf.sgml new file mode 100644 index 00000000..873eb5a7 --- /dev/null +++ b/docs/api/tmpl/base/membuf.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +membuf + +<!-- ##### SECTION Short_Description ##### --> +Memory buffer transform implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Memory buffer transform implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO xmlSecTransformMemBufId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformMemBufGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecTransformMemBufGetBuffer ##### --> +<para> + +</para> + +@transform: +@Returns: + + diff --git a/docs/api/tmpl/base/nodeset.sgml b/docs/api/tmpl/base/nodeset.sgml new file mode 100644 index 00000000..c31c4ffd --- /dev/null +++ b/docs/api/tmpl/base/nodeset.sgml @@ -0,0 +1,172 @@ +<!-- ##### SECTION Title ##### --> +nodeset + +<!-- ##### SECTION Short_Description ##### --> +Nodeset object implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Nodeset object implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM xmlSecNodeSetType ##### --> +<para> + +</para> + +@xmlSecNodeSetNormal: +@xmlSecNodeSetInvert: +@xmlSecNodeSetTree: +@xmlSecNodeSetTreeWithoutComments: +@xmlSecNodeSetTreeInvert: +@xmlSecNodeSetTreeWithoutCommentsInvert: +@xmlSecNodeSetList: + +<!-- ##### ENUM xmlSecNodeSetOp ##### --> +<para> + +</para> + +@xmlSecNodeSetIntersection: +@xmlSecNodeSetSubtraction: +@xmlSecNodeSetUnion: + +<!-- ##### STRUCT xmlSecNodeSet ##### --> +<para> + +</para> + +@nodes: +@doc: +@destroyDoc: +@type: +@op: +@next: +@prev: +@children: + +<!-- ##### USER_FUNCTION xmlSecNodeSetWalkCallback ##### --> +<para> + +</para> + +@nset: +@cur: +@parent: +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetCreate ##### --> +<para> + +</para> + +@doc: +@nodes: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetDestroy ##### --> +<para> + +</para> + +@nset: + + +<!-- ##### FUNCTION xmlSecNodeSetDocDestroy ##### --> +<para> + +</para> + +@nset: + + +<!-- ##### FUNCTION xmlSecNodeSetContains ##### --> +<para> + +</para> + +@nset: +@node: +@parent: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetAdd ##### --> +<para> + +</para> + +@nset: +@newNSet: +@op: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetAddList ##### --> +<para> + +</para> + +@nset: +@newNSet: +@op: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetGetChildren ##### --> +<para> + +</para> + +@doc: +@parent: +@withComments: +@invert: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetWalk ##### --> +<para> + +</para> + +@nset: +@walkFunc: +@data: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetDumpTextNodes ##### --> +<para> + +</para> + +@nset: +@out: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeSetDebugDump ##### --> +<para> + +</para> + +@nset: +@output: + + diff --git a/docs/api/tmpl/base/parser.sgml b/docs/api/tmpl/base/parser.sgml new file mode 100644 index 00000000..dd783cde --- /dev/null +++ b/docs/api/tmpl/base/parser.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +parser + +<!-- ##### SECTION Short_Description ##### --> +Parser transform implementation. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Parser transform implementation. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecParseFile ##### --> +<para> + +</para> + +@filename: +@Returns: + + +<!-- ##### FUNCTION xmlSecParseMemory ##### --> +<para> + +</para> + +@buffer: +@size: +@recovery: +@Returns: + + +<!-- ##### FUNCTION xmlSecParseMemoryExt ##### --> +<para> + +</para> + +@prefix: +@prefixSize: +@buffer: +@bufferSize: +@postfix: +@postfixSize: +@Returns: + + +<!-- ##### MACRO xmlSecTransformXmlParserId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecTransformXmlParserGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/private.sgml b/docs/api/tmpl/base/private.sgml new file mode 100644 index 00000000..3ffde0a6 --- /dev/null +++ b/docs/api/tmpl/base/private.sgml @@ -0,0 +1,288 @@ +<!-- ##### SECTION Title ##### --> +private + +<!-- ##### SECTION Short_Description ##### --> +Private header for building xmlsec-crypto-engine libraries. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Private header for building xmlsec-crypto-engine libraries. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION xmlSecCryptoInitMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoShutdownMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoKeysMngrInitMethod ##### --> +<para> + +</para> + +@mngr: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoKeyDataGetKlassMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoKeyDataStoreGetKlassMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoTransformGetKlassMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppInitMethod ##### --> +<para> + +</para> + +@config: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppShutdownMethod ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeysMngrCertLoadMethod ##### --> +<para> + +</para> + +@mngr: +@filename: +@format: +@type: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeysMngrCertLoadMemoryMethod ##### --> +<para> + +</para> + +@mngr: +@data: +@dataSize: +@format: +@type: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeyLoadMethod ##### --> +<para> + +</para> + +@filename: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeyLoadMemoryMethod ##### --> +<para> + +</para> + +@data: +@dataSize: +@format: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppPkcs12LoadMethod ##### --> +<para> + +</para> + +@filename: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppPkcs12LoadMemoryMethod ##### --> +<para> + +</para> + +@data: +@dataSize: +@pwd: +@pwdCallback: +@pwdCallbackCtx: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeyCertLoadMethod ##### --> +<para> + +</para> + +@key: +@filename: +@format: +@Returns: + + +<!-- ##### USER_FUNCTION xmlSecCryptoAppKeyCertLoadMemoryMethod ##### --> +<para> + +</para> + +@key: +@data: +@dataSize: +@format: +@Returns: + + +<!-- ##### STRUCT xmlSecCryptoDLFunctions ##### --> +<para> + +</para> + +@cryptoInit: +@cryptoShutdown: +@cryptoKeysMngrInit: +@keyDataAesGetKlass: +@keyDataDesGetKlass: +@keyDataDsaGetKlass: +@keyDataEcdsaGetKlass: +@keyDataGost2001GetKlass: +@keyDataGostR3410_2012_256GetKlass: +@keyDataGostR3410_2012_512GetKlass: +@keyDataHmacGetKlass: +@keyDataRsaGetKlass: +@keyDataX509GetKlass: +@keyDataRawX509CertGetKlass: +@x509StoreGetKlass: +@transformAes128CbcGetKlass: +@transformAes192CbcGetKlass: +@transformAes256CbcGetKlass: +@transformKWAes128GetKlass: +@transformKWAes192GetKlass: +@transformKWAes256GetKlass: +@transformDes3CbcGetKlass: +@transformKWDes3GetKlass: +@transformDsaSha1GetKlass: +@transformDsaSha256GetKlass: +@transformEcdsaSha1GetKlass: +@transformEcdsaSha224GetKlass: +@transformEcdsaSha256GetKlass: +@transformEcdsaSha384GetKlass: +@transformEcdsaSha512GetKlass: +@transformGost2001GostR3411_94GetKlass: +@transformGostR3410_2012GostR3411_2012_256GetKlass: +@transformGostR3410_2012GostR3411_2012_512GetKlass: +@transformHmacMd5GetKlass: +@transformHmacRipemd160GetKlass: +@transformHmacSha1GetKlass: +@transformHmacSha224GetKlass: +@transformHmacSha256GetKlass: +@transformHmacSha384GetKlass: +@transformHmacSha512GetKlass: +@transformMd5GetKlass: +@transformRipemd160GetKlass: +@transformRsaMd5GetKlass: +@transformRsaRipemd160GetKlass: +@transformRsaSha1GetKlass: +@transformRsaSha224GetKlass: +@transformRsaSha256GetKlass: +@transformRsaSha384GetKlass: +@transformRsaSha512GetKlass: +@transformRsaPkcs1GetKlass: +@transformRsaOaepGetKlass: +@transformGostR3411_94GetKlass: +@transformGostR3411_2012_256GetKlass: +@transformGostR3411_2012_512GetKlass: +@transformSha1GetKlass: +@transformSha224GetKlass: +@transformSha256GetKlass: +@transformSha384GetKlass: +@transformSha512GetKlass: +@cryptoAppInit: +@cryptoAppShutdown: +@cryptoAppDefaultKeysMngrInit: +@cryptoAppDefaultKeysMngrAdoptKey: +@cryptoAppDefaultKeysMngrLoad: +@cryptoAppDefaultKeysMngrSave: +@cryptoAppKeysMngrCertLoad: +@cryptoAppKeysMngrCertLoadMemory: +@cryptoAppKeyLoad: +@cryptoAppKeyLoadMemory: +@cryptoAppPkcs12Load: +@cryptoAppPkcs12LoadMemory: +@cryptoAppKeyCertLoad: +@cryptoAppKeyCertLoadMemory: +@cryptoAppDefaultPwdCallback: + +<!-- ##### MACRO xmlSecStrPrintf ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecStrVPrintf ##### --> +<para> + +</para> + + + diff --git a/docs/api/tmpl/base/templates.sgml b/docs/api/tmpl/base/templates.sgml new file mode 100644 index 00000000..861ec8e5 --- /dev/null +++ b/docs/api/tmpl/base/templates.sgml @@ -0,0 +1,449 @@ +<!-- ##### SECTION Title ##### --> +templates + +<!-- ##### SECTION Short_Description ##### --> +Dynamic templates creation functions. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Dynamic templates creation functions. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION xmlSecTmplSignatureCreate ##### --> +<para> + +</para> + +@doc: +@c14nMethodId: +@signMethodId: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureCreateNsPref ##### --> +<para> + +</para> + +@doc: +@c14nMethodId: +@signMethodId: +@id: +@nsPrefix: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureEnsureKeyInfo ##### --> +<para> + +</para> + +@signNode: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureAddReference ##### --> +<para> + +</para> + +@signNode: +@digestMethodId: +@id: +@uri: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureAddObject ##### --> +<para> + +</para> + +@signNode: +@id: +@mimeType: +@encoding: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureGetSignMethodNode ##### --> +<para> + +</para> + +@signNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplSignatureGetC14NMethodNode ##### --> +<para> + +</para> + +@signNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplReferenceAddTransform ##### --> +<para> + +</para> + +@referenceNode: +@transformId: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplObjectAddSignProperties ##### --> +<para> + +</para> + +@objectNode: +@id: +@target: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplObjectAddManifest ##### --> +<para> + +</para> + +@objectNode: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplManifestAddReference ##### --> +<para> + +</para> + +@manifestNode: +@digestMethodId: +@id: +@uri: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataCreate ##### --> +<para> + +</para> + +@doc: +@encMethodId: +@id: +@type: +@mimeType: +@encoding: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataEnsureKeyInfo ##### --> +<para> + +</para> + +@encNode: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataEnsureEncProperties ##### --> +<para> + +</para> + +@encNode: +@id: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataAddEncProperty ##### --> +<para> + +</para> + +@encNode: +@id: +@target: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataEnsureCipherValue ##### --> +<para> + +</para> + +@encNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataEnsureCipherReference ##### --> +<para> + +</para> + +@encNode: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplEncDataGetEncMethodNode ##### --> +<para> + +</para> + +@encNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplCipherReferenceAddTransform ##### --> +<para> + +</para> + +@cipherReferenceNode: +@transformId: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplReferenceListAddDataReference ##### --> +<para> + +</para> + +@encNode: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplReferenceListAddKeyReference ##### --> +<para> + +</para> + +@encNode: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplKeyInfoAddKeyName ##### --> +<para> + +</para> + +@keyInfoNode: +@name: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplKeyInfoAddKeyValue ##### --> +<para> + +</para> + +@keyInfoNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplKeyInfoAddX509Data ##### --> +<para> + +</para> + +@keyInfoNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplKeyInfoAddRetrievalMethod ##### --> +<para> + +</para> + +@keyInfoNode: +@uri: +@type: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplRetrievalMethodAddTransform ##### --> +<para> + +</para> + +@retrMethodNode: +@transformId: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplKeyInfoAddEncryptedKey ##### --> +<para> + +</para> + +@keyInfoNode: +@encMethodId: +@id: +@type: +@recipient: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509DataAddIssuerSerial ##### --> +<para> + +</para> + +@x509DataNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509IssuerSerialAddIssuerName ##### --> +<para> + +</para> + +@x509IssuerSerialNode: +@issuerName: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509IssuerSerialAddSerialNumber ##### --> +<para> + +</para> + +@x509IssuerSerialNode: +@serial: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509DataAddSubjectName ##### --> +<para> + +</para> + +@x509DataNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509DataAddSKI ##### --> +<para> + +</para> + +@x509DataNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509DataAddCertificate ##### --> +<para> + +</para> + +@x509DataNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplX509DataAddCRL ##### --> +<para> + +</para> + +@x509DataNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddHmacOutputLength ##### --> +<para> + +</para> + +@transformNode: +@bitsLen: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddRsaOaepParam ##### --> +<para> + +</para> + +@transformNode: +@buf: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddXsltStylesheet ##### --> +<para> + +</para> + +@transformNode: +@xslt: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddC14NInclNamespaces ##### --> +<para> + +</para> + +@transformNode: +@prefixList: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddXPath ##### --> +<para> + +</para> + +@transformNode: +@expression: +@nsList: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddXPath2 ##### --> +<para> + +</para> + +@transformNode: +@type: +@expression: +@nsList: +@Returns: + + +<!-- ##### FUNCTION xmlSecTmplTransformAddXPointer ##### --> +<para> + +</para> + +@transformNode: +@expression: +@nsList: +@Returns: + + 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: + + diff --git a/docs/api/tmpl/base/version.sgml b/docs/api/tmpl/base/version.sgml new file mode 100644 index 00000000..a154ef85 --- /dev/null +++ b/docs/api/tmpl/base/version.sgml @@ -0,0 +1,57 @@ +<!-- ##### SECTION Title ##### --> +version + +<!-- ##### SECTION Short_Description ##### --> +Version macros. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Version macros. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO XMLSEC_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_VERSION_MAJOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_VERSION_MINOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_VERSION_SUBMINOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_VERSION_INFO ##### --> +<para> + +</para> + + + diff --git a/docs/api/tmpl/base/x509.sgml b/docs/api/tmpl/base/x509.sgml new file mode 100644 index 00000000..737fb086 --- /dev/null +++ b/docs/api/tmpl/base/x509.sgml @@ -0,0 +1,75 @@ +<!-- ##### SECTION Title ##### --> +x509 + +<!-- ##### SECTION Short_Description ##### --> +<dsig:X509Certificate/> node parser. + +<!-- ##### SECTION Long_Description ##### --> +<para> +<dsig:X509Certificate/> node parser. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO XMLSEC_X509DATA_CERTIFICATE_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_X509DATA_SUBJECTNAME_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_X509DATA_ISSUERSERIAL_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_X509DATA_SKI_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_X509DATA_CRL_NODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_X509DATA_DEFAULT ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecX509DataGetNodeContent ##### --> +<para> + +</para> + +@node: +@deleteChildren: +@keyInfoCtx: +@Returns: + + diff --git a/docs/api/tmpl/base/xmldsig.sgml b/docs/api/tmpl/base/xmldsig.sgml new file mode 100644 index 00000000..e6d0a6d4 --- /dev/null +++ b/docs/api/tmpl/base/xmldsig.sgml @@ -0,0 +1,316 @@ +<!-- ##### SECTION Title ##### --> +xmldsig + +<!-- ##### SECTION Short_Description ##### --> +XML Digital Signature support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +XML Digital Signature support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM xmlSecDSigStatus ##### --> +<para> + +</para> + +@xmlSecDSigStatusUnknown: +@xmlSecDSigStatusSucceeded: +@xmlSecDSigStatusInvalid: + +<!-- ##### MACRO XMLSEC_DSIG_FLAGS_IGNORE_MANIFESTS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_DSIG_FLAGS_STORE_SIGNEDINFO_REFERENCES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_DSIG_FLAGS_STORE_MANIFEST_REFERENCES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_DSIG_FLAGS_STORE_SIGNATURE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_DSIG_FLAGS_USE_VISA3D_HACK ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT xmlSecDSigCtx ##### --> +<para> + +</para> + +@userData: +@flags: +@flags2: +@keyInfoReadCtx: +@keyInfoWriteCtx: +@transformCtx: +@enabledReferenceUris: +@enabledReferenceTransforms: +@referencePreExecuteCallback: +@defSignMethodId: +@defC14NMethodId: +@defDigestMethodId: +@signKey: +@operation: +@result: +@status: +@signMethod: +@c14nMethod: +@preSignMemBufMethod: +@signValueNode: +@id: +@signedInfoReferences: +@manifestReferences: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecDSigCtxCreate ##### --> +<para> + +</para> + +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxDestroy ##### --> +<para> + +</para> + +@dsigCtx: + + +<!-- ##### FUNCTION xmlSecDSigCtxInitialize ##### --> +<para> + +</para> + +@dsigCtx: +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxFinalize ##### --> +<para> + +</para> + +@dsigCtx: + + +<!-- ##### FUNCTION xmlSecDSigCtxSign ##### --> +<para> + +</para> + +@dsigCtx: +@tmpl: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxVerify ##### --> +<para> + +</para> + +@dsigCtx: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxEnableReferenceTransform ##### --> +<para> + +</para> + +@dsigCtx: +@transformId: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxEnableSignatureTransform ##### --> +<para> + +</para> + +@dsigCtx: +@transformId: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxGetPreSignBuffer ##### --> +<para> + +</para> + +@dsigCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigCtxDebugDump ##### --> +<para> + +</para> + +@dsigCtx: +@output: + + +<!-- ##### FUNCTION xmlSecDSigCtxDebugXmlDump ##### --> +<para> + +</para> + +@dsigCtx: +@output: + + +<!-- ##### ENUM xmlSecDSigReferenceOrigin ##### --> +<para> + +</para> + +@xmlSecDSigReferenceOriginSignedInfo: +@xmlSecDSigReferenceOriginManifest: + +<!-- ##### STRUCT xmlSecDSigReferenceCtx ##### --> +<para> + +</para> + +@userData: +@dsigCtx: +@origin: +@transformCtx: +@digestMethod: +@result: +@status: +@preDigestMemBufMethod: +@id: +@uri: +@type: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxCreate ##### --> +<para> + +</para> + +@dsigCtx: +@origin: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxDestroy ##### --> +<para> + +</para> + +@dsigRefCtx: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxInitialize ##### --> +<para> + +</para> + +@dsigRefCtx: +@dsigCtx: +@origin: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxFinalize ##### --> +<para> + +</para> + +@dsigRefCtx: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxProcessNode ##### --> +<para> + +</para> + +@dsigRefCtx: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxGetPreDigestBuffer ##### --> +<para> + +</para> + +@dsigRefCtx: +@Returns: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxDebugDump ##### --> +<para> + +</para> + +@dsigRefCtx: +@output: + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxDebugXmlDump ##### --> +<para> + +</para> + +@dsigRefCtx: +@output: + + +<!-- ##### MACRO xmlSecDSigReferenceCtxListId ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecDSigReferenceCtxListGetKlass ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/api/tmpl/base/xmlenc.sgml b/docs/api/tmpl/base/xmlenc.sgml new file mode 100644 index 00000000..f10b113e --- /dev/null +++ b/docs/api/tmpl/base/xmlenc.sgml @@ -0,0 +1,194 @@ +<!-- ##### SECTION Title ##### --> +xmlenc + +<!-- ##### SECTION Short_Description ##### --> +XML Encryption support. + +<!-- ##### SECTION Long_Description ##### --> +<para> +XML Encryption support. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM xmlEncCtxMode ##### --> +<para> + +</para> + +@xmlEncCtxModeEncryptedData: +@xmlEncCtxModeEncryptedKey: + +<!-- ##### MACRO XMLSEC_ENC_RETURN_REPLACED_NODE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT xmlSecEncCtx ##### --> +<para> + +</para> + +@userData: +@flags: +@flags2: +@mode: +@keyInfoReadCtx: +@keyInfoWriteCtx: +@transformCtx: +@defEncMethodId: +@encKey: +@operation: +@result: +@resultBase64Encoded: +@resultReplaced: +@encMethod: +@id: +@type: +@mimeType: +@encoding: +@recipient: +@carriedKeyName: +@encDataNode: +@encMethodNode: +@keyInfoNode: +@cipherValueNode: +@replacedNodeList: +@reserved1: + +<!-- ##### FUNCTION xmlSecEncCtxCreate ##### --> +<para> + +</para> + +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxDestroy ##### --> +<para> + +</para> + +@encCtx: + + +<!-- ##### FUNCTION xmlSecEncCtxInitialize ##### --> +<para> + +</para> + +@encCtx: +@keysMngr: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxFinalize ##### --> +<para> + +</para> + +@encCtx: + + +<!-- ##### FUNCTION xmlSecEncCtxCopyUserPref ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxReset ##### --> +<para> + +</para> + +@encCtx: + + +<!-- ##### FUNCTION xmlSecEncCtxBinaryEncrypt ##### --> +<para> + +</para> + +@encCtx: +@tmpl: +@data: +@dataSize: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxXmlEncrypt ##### --> +<para> + +</para> + +@encCtx: +@tmpl: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxUriEncrypt ##### --> +<para> + +</para> + +@encCtx: +@tmpl: +@uri: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxDecrypt ##### --> +<para> + +</para> + +@encCtx: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxDecryptToBuffer ##### --> +<para> + +</para> + +@encCtx: +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecEncCtxDebugDump ##### --> +<para> + +</para> + +@encCtx: +@output: + + +<!-- ##### FUNCTION xmlSecEncCtxDebugXmlDump ##### --> +<para> + +</para> + +@encCtx: +@output: + + diff --git a/docs/api/tmpl/base/xmlsec-unused.sgml b/docs/api/tmpl/base/xmlsec-unused.sgml new file mode 100644 index 00000000..e35eac26 --- /dev/null +++ b/docs/api/tmpl/base/xmlsec-unused.sgml @@ -0,0 +1,794 @@ +<!-- ##### SECTION ./tmpl/base/xmlsec-unused.sgml:Image ##### --> + + + +<!-- ##### SECTION ./tmpl/xkms.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/xkms.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/xkms.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/xkms.sgml:Title ##### --> +xkms + + +<!-- ##### SECTION ./tmpl/xmlsec-unused.sgml:Image ##### --> + + + +<!-- ##### MACRO XMLSEC_XKMS_KEY_BINDING_REASON_MASK_ISSUER_TRAST ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_KEY_BINDING_REASON_MASK_REVOCATION_STATUS ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_KEY_BINDING_REASON_MASK_SIGNATURE ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_KEY_BINDING_REASON_MASK_VALIDITY_INTERVAL ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_NO_RESPONSE_LIMIT ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_RESPONSE_MECHANISM_MASK_PENDING ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_RESPONSE_MECHANISM_MASK_REPRESENT ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_RESPONSE_MECHANISM_MASK_REQUEST_SIGNATURE_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_SERVER_FLAGS_STOP_ON_UNKNOWN_KEY_USAGE ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_SERVER_FLAGS_STOP_ON_UNKNOWN_RESPOND_WITH ##### --> +<para> + +</para> + + +<!-- ##### MACRO XMLSEC_XKMS_SERVER_FLAGS_STOP_ON_UNKNOWN_RESPONSE_MECHANISM ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecTransformCheckType ##### --> +<para> + +</para> + +@transform: +@t: + +<!-- ##### ENUM xmlSecXkmsKeyBindingStatus ##### --> +<para> + +</para> + +@xmlSecXkmsKeyBindingStatusNone: +@xmlSecXkmsKeyBindingStatusValid: +@xmlSecXkmsKeyBindingStatusInvalid: +@xmlSecXkmsKeyBindingStatusIndeterminate: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithDebugDump ##### --> +<para> + +</para> + +@id: +@output: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithDebugXmlDump ##### --> +<para> + +</para> + +@id: +@output: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithDefaultNodeRead ##### --> +<para> + +</para> + +@id: +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithDefaultNodeWrite ##### --> +<para> + +</para> + +@id: +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdListFind ##### --> +<para> + +</para> + +@list: +@id: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdListFindByNodeValue ##### --> +<para> + +</para> + +@list: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdListGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithIdListId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdListWrite ##### --> +<para> + +</para> + +@list: +@ctx: +@node: +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithIdUnknown ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdsGet ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdsInit ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdsRegister ##### --> +<para> + +</para> + +@id: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdsRegisterDefault ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithIdsShutdown ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithKeyNameGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithKeyNameId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithKeyValueGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithKeyValueId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithNodeRead ##### --> +<para> + +</para> + +@id: +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithNodeWrite ##### --> +<para> + +</para> + +@id: +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsRespondWithPGPGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithPGPId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithPrivateKeyGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithPrivateKeyId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithRetrievalMethodGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithRetrievalMethodId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithSPKIGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithSPKIId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithX509CRLGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithX509CRLId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithX509CertGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithX509CertId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsRespondWithX509ChainGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsRespondWithX509ChainId ##### --> +<para> + +</para> + + +<!-- ##### ENUM xmlSecXkmsResultMajor ##### --> +<para> + +</para> + +@xmlSecXkmsResultMajorSuccess: +@xmlSecXkmsResultMajorVersionMismatch: +@xmlSecXkmsResultMajorSender: +@xmlSecXkmsResultMajorReceiver: +@xmlSecXkmsResultMajorRepresent: +@xmlSecXkmsResultMajorPending: + +<!-- ##### ENUM xmlSecXkmsResultMinor ##### --> +<para> + +</para> + +@xmlSecXkmsResultMinorNone: +@xmlSecXkmsResultMinorNoMatch: +@xmlSecXkmsResultMinorTooManyResponses: +@xmlSecXkmsResultMinorIncomplete: +@xmlSecXkmsResultMinorFailure: +@xmlSecXkmsResultMinorRefused: +@xmlSecXkmsResultMinorNoAuthentication: +@xmlSecXkmsResultMinorMessageNotSupported: +@xmlSecXkmsResultMinorUnknownResponseId: +@xmlSecXkmsResultMinorSynchronous: + +<!-- ##### STRUCT xmlSecXkmsServerCtx ##### --> +<para> + +</para> + +@userData: +@flags: +@flags2: +@keyInfoReadCtx: +@keyInfoWriteCtx: +@enabledRespondWithIds: +@enabledServerRequestIds: +@expectedService: +@idPrefix: +@idLen: +@keys: +@resultMajor: +@resultMinor: +@requestId: +@id: +@service: +@nonce: +@originalRequestId: +@pendingNotificationMechanism: +@pendingNotificationIdentifier: +@responseLimit: +@responseMechanismMask: +@compoundRequestContexts: +@requestNode: +@opaqueClientDataNode: +@firtsMsgExtNode: +@keyInfoNode: +@respWithList: +@reserved0: +@reserved1: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxCopyUserPref ##### --> +<para> + +</para> + +@dst: +@src: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxCreate ##### --> +<para> + +</para> + +@keysMngr: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxDebugDump ##### --> +<para> + +</para> + +@ctx: +@output: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxDebugXmlDump ##### --> +<para> + +</para> + +@ctx: +@output: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxDestroy ##### --> +<para> + +</para> + +@ctx: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxFatalErrorResponseCreate ##### --> +<para> + +</para> + +@ctx: +@format: +@doc: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxFinalize ##### --> +<para> + +</para> + +@ctx: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxInitialize ##### --> +<para> + +</para> + +@ctx: +@keysMngr: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxProcess ##### --> +<para> + +</para> + +@ctx: +@node: +@format: +@doc: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxPtrListGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerCtxPtrListId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerCtxRequestRead ##### --> +<para> + +</para> + +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxRequestUnwrap ##### --> +<para> + +</para> + +@ctx: +@node: +@format: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxReset ##### --> +<para> + +</para> + +@ctx: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxResponseWrap ##### --> +<para> + +</para> + +@ctx: +@node: +@format: +@doc: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxResponseWrite ##### --> +<para> + +</para> + +@ctx: +@doc: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerCtxSetResult ##### --> +<para> + +</para> + +@ctx: +@resultMajor: +@resultMinor: + +<!-- ##### ENUM xmlSecXkmsServerFormat ##### --> +<para> + +</para> + +@xmlSecXkmsServerFormatUnknown: +@xmlSecXkmsServerFormatPlain: +@xmlSecXkmsServerFormatSoap11: +@xmlSecXkmsServerFormatSoap12: + +<!-- ##### FUNCTION xmlSecXkmsServerFormatFromString ##### --> +<para> + +</para> + +@str: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerFormatToString ##### --> +<para> + +</para> + +@format: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestCompoundGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestCompoundId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestDebugDump ##### --> +<para> + +</para> + +@id: +@output: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestDebugXmlDump ##### --> +<para> + +</para> + +@id: +@output: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestExecute ##### --> +<para> + +</para> + +@id: +@ctx: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdListFind ##### --> +<para> + +</para> + +@list: +@id: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdListFindByName ##### --> +<para> + +</para> + +@list: +@name: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdListFindByNode ##### --> +<para> + +</para> + +@list: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdListGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestIdListId ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecXkmsServerRequestIdUnknown ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdsGet ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdsInit ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdsRegister ##### --> +<para> + +</para> + +@id: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdsRegisterDefault ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestIdsShutdown ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestLocateGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestLocateId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestNodeRead ##### --> +<para> + +</para> + +@id: +@ctx: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestNodeWrite ##### --> +<para> + +</para> + +@id: +@ctx: +@doc: +@node: +@Returns: + +<!-- ##### FUNCTION xmlSecXkmsServerRequestResultGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestResultId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestStatusGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestStatusId ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecXkmsServerRequestValidateGetKlass ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### MACRO xmlSecXkmsServerRequestValidateId ##### --> +<para> + +</para> + + diff --git a/docs/api/tmpl/base/xmlsec.sgml b/docs/api/tmpl/base/xmlsec.sgml new file mode 100644 index 00000000..848cf2a9 --- /dev/null +++ b/docs/api/tmpl/base/xmlsec.sgml @@ -0,0 +1,135 @@ +<!-- ##### SECTION Title ##### --> +xmlsec + +<!-- ##### SECTION Short_Description ##### --> +Utility functions. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Utility functions. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### TYPEDEF xmlSecPtr ##### --> +<para> + +</para> + + +<!-- ##### MACRO xmlSecSize ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_SIZE_BAD_CAST ##### --> +<para> + +</para> + +@val: + + +<!-- ##### MACRO xmlSecByte ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION xmlSecInit ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION xmlSecShutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO xmlSecCheckVersionExact ##### --> +<para> + +</para> + + + +<!-- ##### MACRO xmlSecCheckVersion ##### --> +<para> + +</para> + + + +<!-- ##### ENUM xmlSecCheckVersionMode ##### --> +<para> + +</para> + +@xmlSecCheckVersionExactMatch: +@xmlSecCheckVersionABICompatible: + +<!-- ##### FUNCTION xmlSecCheckVersionExt ##### --> +<para> + +</para> + +@major: +@minor: +@subminor: +@mode: +@Returns: + + +<!-- ##### MACRO ATTRIBUTE_UNUSED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO XMLSEC_PTR_TO_FUNC_IMPL ##### --> +<para> + +</para> + +@func_type: + + +<!-- ##### MACRO XMLSEC_PTR_TO_FUNC ##### --> +<para> + +</para> + +@func_type: +@ptr: + + +<!-- ##### MACRO XMLSEC_FUNC_TO_PTR ##### --> +<para> + +</para> + +@func_type: +@func: + + diff --git a/docs/api/tmpl/base/xmltree.sgml b/docs/api/tmpl/base/xmltree.sgml new file mode 100644 index 00000000..c590fd9e --- /dev/null +++ b/docs/api/tmpl/base/xmltree.sgml @@ -0,0 +1,552 @@ +<!-- ##### SECTION Title ##### --> +xmltree + +<!-- ##### SECTION Short_Description ##### --> +XML tree operations. + +<!-- ##### SECTION Long_Description ##### --> +<para> +XML tree operations. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO xmlSecNodeGetName ##### --> +<para> + +</para> + +@node: + + +<!-- ##### FUNCTION xmlSecGetNodeNsHref ##### --> +<para> + +</para> + +@cur: +@Returns: + + +<!-- ##### FUNCTION xmlSecCheckNodeName ##### --> +<para> + +</para> + +@cur: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecGetNextElementNode ##### --> +<para> + +</para> + +@cur: +@Returns: + + +<!-- ##### FUNCTION xmlSecFindChild ##### --> +<para> + +</para> + +@parent: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecFindParent ##### --> +<para> + +</para> + +@cur: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecFindNode ##### --> +<para> + +</para> + +@parent: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecAddChild ##### --> +<para> + +</para> + +@parent: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecAddChildNode ##### --> +<para> + +</para> + +@parent: +@child: +@Returns: + + +<!-- ##### FUNCTION xmlSecAddNextSibling ##### --> +<para> + +</para> + +@node: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecAddPrevSibling ##### --> +<para> + +</para> + +@node: +@name: +@ns: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceNode ##### --> +<para> + +</para> + +@node: +@newNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceNodeAndReturn ##### --> +<para> + +</para> + +@node: +@newNode: +@replaced: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceContent ##### --> +<para> + +</para> + +@node: +@newNode: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceContentAndReturn ##### --> +<para> + +</para> + +@node: +@newNode: +@replaced: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceNodeBuffer ##### --> +<para> + +</para> + +@node: +@buffer: +@size: +@Returns: + + +<!-- ##### FUNCTION xmlSecReplaceNodeBufferAndReturn ##### --> +<para> + +</para> + +@node: +@buffer: +@size: +@replaced: +@Returns: + + +<!-- ##### FUNCTION xmlSecNodeEncodeAndSetContent ##### --> +<para> + +</para> + +@node: +@buffer: +@Returns: + + +<!-- ##### FUNCTION xmlSecAddIDs ##### --> +<para> + +</para> + +@doc: +@cur: +@ids: + + +<!-- ##### FUNCTION xmlSecGenerateAndAddID ##### --> +<para> + +</para> + +@node: +@attrName: +@prefix: +@len: +@Returns: + + +<!-- ##### FUNCTION xmlSecGenerateID ##### --> +<para> + +</para> + +@prefix: +@len: +@Returns: + + +<!-- ##### FUNCTION xmlSecCreateTree ##### --> +<para> + +</para> + +@rootNodeName: +@rootNodeNs: +@Returns: + + +<!-- ##### FUNCTION xmlSecIsEmptyNode ##### --> +<para> + +</para> + +@node: +@Returns: + + +<!-- ##### FUNCTION xmlSecIsEmptyString ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION xmlSecGetQName ##### --> +<para> + +</para> + +@node: +@href: +@local: +@Returns: + + +<!-- ##### FUNCTION xmlSecPrintXmlString ##### --> +<para> + +</para> + +@fd: +@str: +@Returns: + + +<!-- ##### MACRO xmlSecIsHex ##### --> +<para> + +</para> + +@c: + + +<!-- ##### MACRO xmlSecGetHex ##### --> +<para> + +</para> + +@c: + + +<!-- ##### STRUCT xmlSecQName2IntegerInfo ##### --> +<para> + +</para> + +@qnameHref: +@qnameLocalPart: +@intValue: + +<!-- ##### TYPEDEF xmlSecQName2IntegerInfoConstPtr ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecQName2IntegerGetInfo ##### --> +<para> + +</para> + +@info: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerGetInteger ##### --> +<para> + +</para> + +@info: +@qnameHref: +@qnameLocalPart: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerGetIntegerFromString ##### --> +<para> + +</para> + +@info: +@node: +@qname: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerGetStringFromInteger ##### --> +<para> + +</para> + +@info: +@node: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerNodeRead ##### --> +<para> + +</para> + +@info: +@node: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerNodeWrite ##### --> +<para> + +</para> + +@info: +@node: +@nodeName: +@nodeNs: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerAttributeRead ##### --> +<para> + +</para> + +@info: +@node: +@attrName: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerAttributeWrite ##### --> +<para> + +</para> + +@info: +@node: +@attrName: +@intValue: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2IntegerDebugDump ##### --> +<para> + +</para> + +@info: +@intValue: +@name: +@output: + + +<!-- ##### FUNCTION xmlSecQName2IntegerDebugXmlDump ##### --> +<para> + +</para> + +@info: +@intValue: +@name: +@output: + + +<!-- ##### TYPEDEF xmlSecBitMask ##### --> +<para> + +</para> + + +<!-- ##### STRUCT xmlSecQName2BitMaskInfo ##### --> +<para> + +</para> + +@qnameHref: +@qnameLocalPart: +@mask: + +<!-- ##### TYPEDEF xmlSecQName2BitMaskInfoConstPtr ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION xmlSecQName2BitMaskGetInfo ##### --> +<para> + +</para> + +@info: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskGetBitMask ##### --> +<para> + +</para> + +@info: +@qnameLocalPart: +@qnameHref: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskNodesRead ##### --> +<para> + +</para> + +@info: +@node: +@nodeName: +@nodeNs: +@stopOnUnknown: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskGetBitMaskFromString ##### --> +<para> + +</para> + +@info: +@node: +@qname: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskGetStringFromBitMask ##### --> +<para> + +</para> + +@info: +@node: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskNodesWrite ##### --> +<para> + +</para> + +@info: +@node: +@nodeName: +@nodeNs: +@mask: +@Returns: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskDebugDump ##### --> +<para> + +</para> + +@info: +@mask: +@name: +@output: + + +<!-- ##### FUNCTION xmlSecQName2BitMaskDebugXmlDump ##### --> +<para> + +</para> + +@info: +@mask: +@name: +@output: + + |