|
keysdata
Synopsis
typedef xmlSecKeyDataUsage;
#define xmlSecKeyDataUsageUnknown
#define xmlSecKeyDataUsageKeyInfoNodeRead
#define xmlSecKeyDataUsageKeyInfoNodeWrite
#define xmlSecKeyDataUsageKeyValueNodeRead
#define xmlSecKeyDataUsageKeyValueNodeWrite
#define xmlSecKeyDataUsageRetrievalMethodNodeXml
#define xmlSecKeyDataUsageRetrievalMethodNodeBin
#define xmlSecKeyDataUsageAny
#define xmlSecKeyDataUsageKeyInfoNode
#define xmlSecKeyDataUsageKeyValueNode
#define xmlSecKeyDataUsageRetrievalMethodNode
typedef xmlSecKeyDataType;
#define xmlSecKeyDataTypeUnknown
#define xmlSecKeyDataTypeNone
#define xmlSecKeyDataTypePublic
#define xmlSecKeyDataTypePrivate
#define xmlSecKeyDataTypeSymmetric
#define xmlSecKeyDataTypeSession
#define xmlSecKeyDataTypePermanent
#define xmlSecKeyDataTypeTrusted
#define xmlSecKeyDataTypeAny
enum xmlSecKeyDataFormat;
xmlSecPtrListPtr xmlSecKeyDataIdsGet (void);
int xmlSecKeyDataIdsInit (void);
void xmlSecKeyDataIdsShutdown (void);
int xmlSecKeyDataIdsRegisterDefault (void);
int xmlSecKeyDataIdsRegister (xmlSecKeyDataId id);
struct xmlSecKeyData;
xmlSecKeyDataPtr xmlSecKeyDataCreate (xmlSecKeyDataId id);
xmlSecKeyDataPtr xmlSecKeyDataDuplicate (xmlSecKeyDataPtr data);
void xmlSecKeyDataDestroy (xmlSecKeyDataPtr data);
int xmlSecKeyDataGenerate (xmlSecKeyDataPtr data,
xmlSecSize sizeBits,
xmlSecKeyDataType type);
xmlSecKeyDataType xmlSecKeyDataGetType (xmlSecKeyDataPtr data);
xmlSecSize xmlSecKeyDataGetSize (xmlSecKeyDataPtr data);
const xmlChar* xmlSecKeyDataGetIdentifier (xmlSecKeyDataPtr data);
void xmlSecKeyDataDebugDump (xmlSecKeyDataPtr data,
FILE *output);
void xmlSecKeyDataDebugXmlDump (xmlSecKeyDataPtr data,
FILE *output);
int xmlSecKeyDataXmlRead (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataXmlWrite (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataBinRead (xmlSecKeyDataId id,
xmlSecKeyPtr key,
const xmlSecByte *buf,
xmlSecSize bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataBinWrite (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlSecByte **buf,
xmlSecSize *bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
#define xmlSecKeyDataGetName (data)
#define xmlSecKeyDataIsValid (data)
#define xmlSecKeyDataCheckId (data, dataId)
#define xmlSecKeyDataCheckUsage (data, usg)
#define xmlSecKeyDataCheckSize (data, size)
#define xmlSecKeyDataIdUnknown
int (*xmlSecKeyDataInitMethod) (xmlSecKeyDataPtr data);
int (*xmlSecKeyDataDuplicateMethod) (xmlSecKeyDataPtr dst,
xmlSecKeyDataPtr src);
void (*xmlSecKeyDataFinalizeMethod) (xmlSecKeyDataPtr data);
int (*xmlSecKeyDataXmlReadMethod) (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int (*xmlSecKeyDataXmlWriteMethod) (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int (*xmlSecKeyDataBinReadMethod) (xmlSecKeyDataId id,
xmlSecKeyPtr key,
const xmlSecByte *buf,
xmlSecSize bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int (*xmlSecKeyDataBinWriteMethod) (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlSecByte **buf,
xmlSecSize *bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int (*xmlSecKeyDataGenerateMethod) (xmlSecKeyDataPtr data,
xmlSecSize sizeBits,
xmlSecKeyDataType type);
xmlSecKeyDataType (*xmlSecKeyDataGetTypeMethod)
(xmlSecKeyDataPtr data);
xmlSecSize (*xmlSecKeyDataGetSizeMethod) (xmlSecKeyDataPtr data);
const xmlChar* (*xmlSecKeyDataGetIdentifierMethod)
(xmlSecKeyDataPtr data);
void (*xmlSecKeyDataDebugDumpMethod) (xmlSecKeyDataPtr data,
FILE *output);
struct xmlSecKeyDataKlass;
#define xmlSecKeyDataKlassGetName (klass)
#define xmlSecKeyDataListId
xmlSecPtrListId xmlSecKeyDataListGetKlass (void);
#define xmlSecKeyDataIdListId
xmlSecPtrListId xmlSecKeyDataIdListGetKlass (void);
int xmlSecKeyDataIdListFind (xmlSecPtrListPtr list,
xmlSecKeyDataId dataId);
xmlSecKeyDataId xmlSecKeyDataIdListFindByNode
(xmlSecPtrListPtr list,
const xmlChar *nodeName,
const xmlChar *nodeNs,
xmlSecKeyDataUsage usage);
xmlSecKeyDataId xmlSecKeyDataIdListFindByHref
(xmlSecPtrListPtr list,
const xmlChar *href,
xmlSecKeyDataUsage usage);
xmlSecKeyDataId xmlSecKeyDataIdListFindByName
(xmlSecPtrListPtr list,
const xmlChar *name,
xmlSecKeyDataUsage usage);
void xmlSecKeyDataIdListDebugDump (xmlSecPtrListPtr list,
FILE *output);
void xmlSecKeyDataIdListDebugXmlDump (xmlSecPtrListPtr list,
FILE *output);
#define xmlSecKeyDataBinarySize
int xmlSecKeyDataBinaryValueInitialize
(xmlSecKeyDataPtr data);
int xmlSecKeyDataBinaryValueDuplicate
(xmlSecKeyDataPtr dst,
xmlSecKeyDataPtr src);
void xmlSecKeyDataBinaryValueFinalize
(xmlSecKeyDataPtr data);
int xmlSecKeyDataBinaryValueXmlRead (xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataBinaryValueXmlWrite
(xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlNodePtr node,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataBinaryValueBinRead (xmlSecKeyDataId id,
xmlSecKeyPtr key,
const xmlSecByte *buf,
xmlSecSize bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
int xmlSecKeyDataBinaryValueBinWrite
(xmlSecKeyDataId id,
xmlSecKeyPtr key,
xmlSecByte **buf,
xmlSecSize *bufSize,
xmlSecKeyInfoCtxPtr keyInfoCtx);
void xmlSecKeyDataBinaryValueDebugDump
(xmlSecKeyDataPtr data,
FILE *output);
void xmlSecKeyDataBinaryValueDebugXmlDump
(xmlSecKeyDataPtr data,
FILE *output);
xmlSecSize xmlSecKeyDataBinaryValueGetSize (xmlSecKeyDataPtr data);
xmlSecBufferPtr xmlSecKeyDataBinaryValueGetBuffer
(xmlSecKeyDataPtr data);
int xmlSecKeyDataBinaryValueSetBuffer
(xmlSecKeyDataPtr data,
const xmlSecByte *buf,
xmlSecSize bufSize);
struct xmlSecKeyDataStore;
xmlSecKeyDataStorePtr xmlSecKeyDataStoreCreate
(xmlSecKeyDataStoreId id);
void xmlSecKeyDataStoreDestroy (xmlSecKeyDataStorePtr store);
#define xmlSecKeyDataStoreGetName (store)
#define xmlSecKeyDataStoreIsValid (store)
#define xmlSecKeyDataStoreCheckId (store, storeId)
#define xmlSecKeyDataStoreCheckSize (store, size)
#define xmlSecKeyDataStoreIdUnknown
int (*xmlSecKeyDataStoreInitializeMethod)
(xmlSecKeyDataStorePtr store);
void (*xmlSecKeyDataStoreFinalizeMethod)
(xmlSecKeyDataStorePtr store);
struct xmlSecKeyDataStoreKlass;
#define xmlSecKeyDataStoreKlassGetName (klass)
#define xmlSecKeyDataStorePtrListId
xmlSecPtrListId xmlSecKeyDataStorePtrListGetKlass
(void); |
Details
xmlSecKeyDataUsage
typedef unsigned int xmlSecKeyDataUsage; |
The bits mask that determines possible keys data usage.
xmlSecKeyDataUsageUnknown
#define xmlSecKeyDataUsageUnknown 0x00000 |
The key data usage is unknown.
xmlSecKeyDataUsageKeyInfoNodeRead
#define xmlSecKeyDataUsageKeyInfoNodeRead 0x00001 |
The key data could be read from a <dsig:KeyInfo/> child.
xmlSecKeyDataUsageKeyInfoNodeWrite
#define xmlSecKeyDataUsageKeyInfoNodeWrite 0x00002 |
The key data could be written to a <dsig:KeyInfo /> child.
xmlSecKeyDataUsageKeyValueNodeRead
#define xmlSecKeyDataUsageKeyValueNodeRead 0x00004 |
The key data could be read from a <dsig:KeyValue /> child.
xmlSecKeyDataUsageKeyValueNodeWrite
#define xmlSecKeyDataUsageKeyValueNodeWrite 0x00008 |
The key data could be written to a <dsig:KeyValue /> child.
xmlSecKeyDataUsageRetrievalMethodNodeXml
#define xmlSecKeyDataUsageRetrievalMethodNodeXml 0x00010 |
The key data could be retrieved using <dsig:RetrievalMethod /> node
in XML format.
xmlSecKeyDataUsageRetrievalMethodNodeBin
#define xmlSecKeyDataUsageRetrievalMethodNodeBin 0x00020 |
The key data could be retrieved using <dsig:RetrievalMethod /> node
in binary format.
xmlSecKeyDataUsageAny
#define xmlSecKeyDataUsageAny 0xFFFFF |
Any key data usage.
xmlSecKeyDataUsageKeyInfoNode
#define xmlSecKeyDataUsageKeyInfoNode |
The key data could be read and written from/to a <dsig:KeyInfo /> child.
xmlSecKeyDataUsageKeyValueNode
#define xmlSecKeyDataUsageKeyValueNode |
The key data could be read and written from/to a <dsig:KeyValue /> child.
xmlSecKeyDataUsageRetrievalMethodNode
#define xmlSecKeyDataUsageRetrievalMethodNode |
The key data could be retrieved using <dsig:RetrievalMethod /> node
in any format.
xmlSecKeyDataType
typedef unsigned int xmlSecKeyDataType; |
The key data type (public/private, session/permanet, etc.).
xmlSecKeyDataTypeUnknown
#define xmlSecKeyDataTypeUnknown 0x0000 |
The key data type is unknown (same as xmlSecKeyDataTypeNone).
xmlSecKeyDataTypeNone
#define xmlSecKeyDataTypeNone xmlSecKeyDataTypeUnknown |
The key data type is unknown (same as xmlSecKeyDataTypeUnknown).
xmlSecKeyDataTypePublic
#define xmlSecKeyDataTypePublic 0x0001 |
The key data contain a public key.
xmlSecKeyDataTypePrivate
#define xmlSecKeyDataTypePrivate 0x0002 |
The key data contain a private key.
xmlSecKeyDataTypeSymmetric
#define xmlSecKeyDataTypeSymmetric 0x0004 |
The key data contain a symmetric key.
xmlSecKeyDataTypeSession
#define xmlSecKeyDataTypeSession 0x0008 |
The key data contain session key (one time key, not stored in keys manager).
xmlSecKeyDataTypePermanent
#define xmlSecKeyDataTypePermanent 0x0010 |
The key data contain permanent key (stored in keys manager).
xmlSecKeyDataTypeTrusted
#define xmlSecKeyDataTypeTrusted 0x0100 |
The key data is trusted.
xmlSecKeyDataTypeAny
#define xmlSecKeyDataTypeAny 0xFFFF |
Any key data.
enum xmlSecKeyDataFormat
typedef enum {
xmlSecKeyDataFormatUnknown = 0,
xmlSecKeyDataFormatBinary,
xmlSecKeyDataFormatPem,
xmlSecKeyDataFormatDer
} xmlSecKeyDataFormat; |
The key data format (binary, der, pem, etc.).
xmlSecKeyDataIdsGet ()
Gets global registered key data klasses list.
Returns : |
the pointer to list of all registered key data klasses. |
xmlSecKeyDataIdsInit ()
int xmlSecKeyDataIdsInit (void); |
Initializes the key data klasses. This function is called from the
xmlSecInit function and the application should not call it directly.
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataIdsShutdown ()
void xmlSecKeyDataIdsShutdown (void); |
Shuts down the keys data klasses. This function is called from the
xmlSecShutdown function and the application should not call it directly.
xmlSecKeyDataIdsRegisterDefault ()
int xmlSecKeyDataIdsRegisterDefault (void); |
Registers default (implemented by XML Security Library)
key data klasses: <dsig:KeyName/> element processing klass,
<dsig:KeyValue/> element processing klass, ...
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataIdsRegister ()
int xmlSecKeyDataIdsRegister (xmlSecKeyDataId id); |
Registers id in the global list of key data klasses.
id : |
the key data klass. |
Returns : |
0 on success or a negative value if an error occurs. |
struct xmlSecKeyData
struct xmlSecKeyData {
xmlSecKeyDataId id;
void* reserved0;
void* reserved1;
}; |
The key data: key value (crypto material), x509 data, pgp data, etc.
xmlSecKeyDataCreate ()
Allocates and initializes new key data of the specified type id.
Caller is responsible for destroing returend object with
xmlSecKeyDataDestroy function.
id : |
the data id. |
Returns : |
the pointer to newly allocated key data structure
or NULL if an error occurs. |
xmlSecKeyDataDuplicate ()
Creates a duplicate of the given data. Caller is responsible for
destroing returend object with xmlSecKeyDataDestroy function.
data : |
the pointer to the key data. |
Returns : |
the pointer to newly allocated key data structure
or NULL if an error occurs. |
xmlSecKeyDataDestroy ()
Destroys the data and frees all allocated memory.
data : |
the pointer to the key data. |
xmlSecKeyDataGenerate ()
Generates new key data of given size and type.
data : |
the pointer to key data. |
sizeBits : |
the desired key data size (in bits). |
type : |
the desired key data type. |
Returns : |
0 on success or a negative value otherwise. |
xmlSecKeyDataGetType ()
Gets key data type.
xmlSecKeyDataGetSize ()
Gets key data size.
xmlSecKeyDataGetIdentifier ()
Gets key data identifier string.
xmlSecKeyDataDebugDump ()
Prints key data debug info.
xmlSecKeyDataDebugXmlDump ()
Prints key data debug info in XML format.
xmlSecKeyDataXmlRead ()
Reads the key data of klass id from XML node and adds them to key.
xmlSecKeyDataXmlWrite ()
Writes the key data of klass id from key to an XML node.
xmlSecKeyDataBinRead ()
Reads the key data of klass id from binary buffer buf to key.
xmlSecKeyDataBinWrite ()
Writes the key data of klass id from the key to a binary buffer buf.
xmlSecKeyDataGetName()
#define xmlSecKeyDataGetName(data) |
Macro. Returns the key data name.
data : |
the pointer to key data. |
xmlSecKeyDataIsValid()
#define xmlSecKeyDataIsValid(data) |
Macro. Returns 1 if data is not NULL and data->id is not NULL
or 0 otherwise.
xmlSecKeyDataCheckId()
#define xmlSecKeyDataCheckId(data, dataId) |
Macro. Returns 1 if data is valid and data's id is equal to dataId.
xmlSecKeyDataCheckUsage()
#define xmlSecKeyDataCheckUsage(data, usg) |
Macro. Returns 1 if data is valid and could be used for usg.
xmlSecKeyDataCheckSize()
#define xmlSecKeyDataCheckSize(data, size) |
Macro. Returns 1 if data is valid and data's object has at least size bytes.
xmlSecKeyDataIdUnknown
#define xmlSecKeyDataIdUnknown NULL |
The "unknown" id.
xmlSecKeyDataInitMethod ()
Key data specific initialization method.
data : |
the pointer to key data. |
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataDuplicateMethod ()
Key data specific duplication (copy) method.
dst : |
the pointer to destination key data. |
src : |
the poiniter to source key data. |
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataFinalizeMethod ()
Key data specific finalization method. All the objects and resources allocated
by the key data object must be freed inside this method.
xmlSecKeyDataXmlReadMethod ()
Key data specific method for reading XML node.
xmlSecKeyDataXmlWriteMethod ()
Key data specific method for writing XML node.
id : |
the data id. |
key : |
the key. |
node : |
the pointer to data's value XML node. |
keyInfoCtx : |
the <dsig:KeyInfo> node processing context. |
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataBinReadMethod ()
Key data specific method for reading binary buffer.
xmlSecKeyDataBinWriteMethod ()
Key data specific method for reading binary buffer.
xmlSecKeyDataGenerateMethod ()
Key data specific method for generating new key data.
data : |
the pointer to key data. |
sizeBits : |
the key data specific size. |
type : |
the required key type (session/permanent, etc.) |
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataGetTypeMethod ()
Key data specific method to get the key type.
xmlSecKeyDataGetSizeMethod ()
Key data specific method to get the key size.
xmlSecKeyDataGetIdentifierMethod ()
Key data specific method to get the key data identifier string (for example,
X509 data identifier is the subject of the verified cert).
data : |
the pointer to key data. |
Returns : |
the identifier string or NULL if an error occurs. |
xmlSecKeyDataDebugDumpMethod ()
Key data specific method for printing debug info.
data : |
the data. |
output : |
the FILE to print debug info (should be open for writing). |
struct xmlSecKeyDataKlass
struct xmlSecKeyDataKlass {
xmlSecSize klassSize;
xmlSecSize objSize;
/* data */
const xmlChar* name;
xmlSecKeyDataUsage usage;
const xmlChar* href;
const xmlChar* dataNodeName;
const xmlChar* dataNodeNs;
/* constructors/destructor */
xmlSecKeyDataInitMethod initialize;
xmlSecKeyDataDuplicateMethod duplicate;
xmlSecKeyDataFinalizeMethod finalize;
xmlSecKeyDataGenerateMethod generate;
/* get info */
xmlSecKeyDataGetTypeMethod getType;
xmlSecKeyDataGetSizeMethod getSize;
xmlSecKeyDataGetIdentifierMethod getIdentifier;
/* read/write */
xmlSecKeyDataXmlReadMethod xmlRead;
xmlSecKeyDataXmlWriteMethod xmlWrite;
xmlSecKeyDataBinReadMethod binRead;
xmlSecKeyDataBinWriteMethod binWrite;
/* debug */
xmlSecKeyDataDebugDumpMethod debugDump;
xmlSecKeyDataDebugDumpMethod debugXmlDump;
/* for the future */
void* reserved0;
void* reserved1;
}; |
The data id (klass).
xmlSecKeyDataKlassGetName()
#define xmlSecKeyDataKlassGetName(klass) |
Macro. Returns data klass name.
xmlSecKeyDataListId
#define xmlSecKeyDataListId xmlSecKeyDataListGetKlass() |
The key data klasses list klass id.
xmlSecKeyDataListGetKlass ()
xmlSecPtrListId xmlSecKeyDataListGetKlass (void); |
The key data list klass.
Returns : |
pointer to the key data list klass. |
xmlSecKeyDataIdListId
#define xmlSecKeyDataIdListId xmlSecKeyDataIdListGetKlass() |
The key data list klass id.
xmlSecKeyDataIdListGetKlass ()
xmlSecPtrListId xmlSecKeyDataIdListGetKlass (void); |
The key data id list klass.
Returns : |
pointer to the key data id list klass. |
xmlSecKeyDataIdListFind ()
Lookups dataId in list.
list : |
the pointer to key data ids list. |
dataId : |
the key data klass. |
Returns : |
1 if dataId is found in the list, 0 if not and a negative
value if an error occurs. |
xmlSecKeyDataIdListFindByNode ()
Lookups data klass in the list with given nodeName, nodeNs and
usage in the list.
list : |
the pointer to key data ids list. |
nodeName : |
the desired key data klass XML node name. |
nodeNs : |
the desired key data klass XML node namespace. |
usage : |
the desired key data usage. |
Returns : |
key data klass is found and NULL otherwise. |
xmlSecKeyDataIdListFindByHref ()
Lookups data klass in the list with given href and usage in list.
list : |
the pointer to key data ids list. |
href : |
the desired key data klass href. |
usage : |
the desired key data usage. |
Returns : |
key data klass is found and NULL otherwise. |
xmlSecKeyDataIdListFindByName ()
Lookups data klass in the list with given name and usage in list.
list : |
the pointer to key data ids list. |
name : |
the desired key data klass name. |
usage : |
the desired key data usage. |
Returns : |
key data klass is found and NULL otherwise. |
xmlSecKeyDataIdListDebugDump ()
Prints binary key data debug information to output.
list : |
the pointer to key data ids list. |
output : |
the pointer to output FILE. |
xmlSecKeyDataIdListDebugXmlDump ()
Prints binary key data debug information to output in XML format.
list : |
the pointer to key data ids list. |
output : |
the pointer to output FILE. |
xmlSecKeyDataBinarySize
#define xmlSecKeyDataBinarySize |
The binary key data object size.
xmlSecKeyDataBinaryValueInitialize ()
Initializes key data.
data : |
the pointer to binary key data. |
Returns : |
0 on success or a negative value otherwise. |
xmlSecKeyDataBinaryValueDuplicate ()
Copies binary key data from src to dst.
dst : |
the pointer to destination binary key data. |
src : |
the pointer to source binary key data. |
Returns : |
0 on success or a negative value otherwise. |
xmlSecKeyDataBinaryValueFinalize ()
Cleans up binary key data.
data : |
the pointer to binary key data. |
xmlSecKeyDataBinaryValueXmlRead ()
Reads binary key data from node to the key by base64 decoding the node content.
xmlSecKeyDataBinaryValueXmlWrite ()
Base64 encodes binary key data of klass id from the key and
sets to the node content.
xmlSecKeyDataBinaryValueBinRead ()
Reads binary key data of the klass id from buf to the key.
xmlSecKeyDataBinaryValueBinWrite ()
Writes binary key data of klass id from the key to buf.
xmlSecKeyDataBinaryValueDebugDump ()
Prints binary key data debug information to output.
data : |
the pointer to binary key data. |
output : |
the pointer to output FILE. |
xmlSecKeyDataBinaryValueDebugXmlDump ()
void xmlSecKeyDataBinaryValueDebugXmlDump
(xmlSecKeyDataPtr data,
FILE *output); |
Prints binary key data debug information to output in XML format.
data : |
the pointer to binary key data. |
output : |
the pointer to output FILE. |
xmlSecKeyDataBinaryValueGetSize ()
Gets the binary key data size.
data : |
the pointer to binary key data. |
Returns : |
binary key data size in bits. |
xmlSecKeyDataBinaryValueGetBuffer ()
Gets the binary key data buffer.
data : |
the pointer to binary key data. |
Returns : |
pointer to binary key data buffer. |
xmlSecKeyDataBinaryValueSetBuffer ()
Sets the value of data to buf.
data : |
the pointer to binary key data. |
buf : |
the pointer to binary buffer. |
bufSize : |
the binary buffer size. |
Returns : |
0 on success or a negative value otherwise. |
struct xmlSecKeyDataStore
struct xmlSecKeyDataStore {
xmlSecKeyDataStoreId id;
/* for the future */
void* reserved0;
void* reserved1;
}; |
The key data store. Key data store holds common key data specific information
required for key data processing. For example, X509 data store may hold
information about trusted (root) certificates.
xmlSecKeyDataStoreCreate ()
Creates new key data store of the specified klass id. Caller is responsible
for freeng returned object with xmlSecKeyDataStoreDestroy function.
id : |
the store id. |
Returns : |
the pointer to newly allocated key data store structure
or NULL if an error occurs. |
xmlSecKeyDataStoreGetName()
#define xmlSecKeyDataStoreGetName(store) |
Macro. Returns key data store name.
xmlSecKeyDataStoreIsValid()
#define xmlSecKeyDataStoreIsValid(store) |
Macro. Returns 1 if store is not NULL and store->id is not NULL
or 0 otherwise.
xmlSecKeyDataStoreCheckId()
#define xmlSecKeyDataStoreCheckId(store, storeId) |
Macro. Returns 1 if store is valid and store's id is equal to storeId.
xmlSecKeyDataStoreCheckSize()
#define xmlSecKeyDataStoreCheckSize(store, size) |
Macro. Returns 1 if data is valid and stores's object has at least size bytes.
xmlSecKeyDataStoreIdUnknown
#define xmlSecKeyDataStoreIdUnknown NULL |
The "unknown" id.
xmlSecKeyDataStoreInitializeMethod ()
Key data store specific initialization method.
store : |
the data store. |
Returns : |
0 on success or a negative value if an error occurs. |
xmlSecKeyDataStoreFinalizeMethod ()
Key data store specific finalization (destroy) method.
struct xmlSecKeyDataStoreKlass
struct xmlSecKeyDataStoreKlass {
xmlSecSize klassSize;
xmlSecSize objSize;
/* data */
const xmlChar* name;
/* constructors/destructor */
xmlSecKeyDataStoreInitializeMethod initialize;
xmlSecKeyDataStoreFinalizeMethod finalize;
/* for the future */
void* reserved0;
void* reserved1;
}; |
The data store id (klass).
xmlSecKeyDataStoreKlassGetName()
#define xmlSecKeyDataStoreKlassGetName(klass) |
Macro. Returns store klass name.
klass : |
the pointer to store klass. |
xmlSecKeyDataStorePtrListId
#define xmlSecKeyDataStorePtrListId xmlSecKeyDataStorePtrListGetKlass() |
The data store list id (klass).
xmlSecKeyDataStorePtrListGetKlass ()
xmlSecPtrListId xmlSecKeyDataStorePtrListGetKlass
(void); |
Key data stores list.
|
Aleksey Sanin
|
|