diff options
Diffstat (limited to 'docs/api/tmpl/base/keysdata.sgml')
-rw-r--r-- | docs/api/tmpl/base/keysdata.sgml | 930 |
1 files changed, 930 insertions, 0 deletions
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: + + |