

|
keys
Synopsis
typedef xmlSecKeyUsage;
#define xmlSecKeyUsageSign
#define xmlSecKeyUsageVerify
#define xmlSecKeyUsageEncrypt
#define xmlSecKeyUsageDecrypt
#define xmlSecKeyUsageAny
struct xmlSecKeyReq;
int xmlSecKeyReqInitialize (xmlSecKeyReqPtr keyReq);
void xmlSecKeyReqFinalize (xmlSecKeyReqPtr keyReq);
void xmlSecKeyReqReset (xmlSecKeyReqPtr keyReq);
int xmlSecKeyReqCopy (xmlSecKeyReqPtr dst,
xmlSecKeyReqPtr src);
int xmlSecKeyReqMatchKey (xmlSecKeyReqPtr keyReq,
xmlSecKeyPtr key);
int xmlSecKeyReqMatchKeyValue (xmlSecKeyReqPtr keyReq,
xmlSecKeyDataPtr value);
struct xmlSecKey;
xmlSecKeyPtr xmlSecKeyCreate (void);
void xmlSecKeyDestroy (xmlSecKeyPtr key);
void xmlSecKeyEmpty (xmlSecKeyPtr key);
xmlSecKeyPtr xmlSecKeyDuplicate (xmlSecKeyPtr key);
int xmlSecKeyCopy (xmlSecKeyPtr keyDst,
xmlSecKeyPtr keySrc);
const xmlChar* xmlSecKeyGetName (xmlSecKeyPtr key);
int xmlSecKeySetName (xmlSecKeyPtr key,
const xmlChar *name);
xmlSecKeyDataType xmlSecKeyGetType (xmlSecKeyPtr key);
xmlSecKeyDataPtr xmlSecKeyGetValue (xmlSecKeyPtr key);
int xmlSecKeySetValue (xmlSecKeyPtr key,
xmlSecKeyDataPtr value);
xmlSecKeyDataPtr xmlSecKeyGetData (xmlSecKeyPtr key,
xmlSecKeyDataId dataId);
xmlSecKeyDataPtr xmlSecKeyEnsureData (xmlSecKeyPtr key,
xmlSecKeyDataId dataId);
int xmlSecKeyAdoptData (xmlSecKeyPtr key,
xmlSecKeyDataPtr data);
void xmlSecKeyDebugDump (xmlSecKeyPtr key,
FILE *output);
void xmlSecKeyDebugXmlDump (xmlSecKeyPtr key,
FILE *output);
xmlSecKeyPtr xmlSecKeyGenerate (const xmlChar *klass,
const xmlChar *name,
size_t sizeBits,
xmlSecKeyDataType type);
int xmlSecKeyMatch (xmlSecKeyPtr key,
const xmlChar *name,
xmlSecKeyReqPtr keyReq);
#define xmlSecKeyIsValid (key)
#define xmlSecKeyCheckId (key, keyId)
#define xmlSecKeyPtrListId
xmlSecPtrListId xmlSecKeyPtrListGetKlass (void); |
Details
xmlSecKeyUsage
typedef unsigned int xmlSecKeyUsage; |
The key usage.
xmlSecKeyUsageSign
#define xmlSecKeyUsageSign 0x0001 |
Key can be used in any way.
xmlSecKeyUsageVerify
#define xmlSecKeyUsageVerify 0x0002 |
Key for signing.
xmlSecKeyUsageEncrypt
#define xmlSecKeyUsageEncrypt 0x0004 |
Key for signature verification.
xmlSecKeyUsageDecrypt
#define xmlSecKeyUsageDecrypt 0x0008 |
An encryption key.
xmlSecKeyUsageAny
#define xmlSecKeyUsageAny 0xFFFF |
A decryption key.
struct xmlSecKeyReq
struct xmlSecKeyReq {
xmlSecKeyDataId keyId;
xmlSecKeyDataType keyType;
xmlSecKeyUsage keyUsage;
size_t keyBitsSize;
}; |
The key requirements information.
xmlSecKeyReqInitialize ()
int xmlSecKeyReqInitialize (xmlSecKeyReqPtr keyReq); |
xmlSecKeyReqFinalize ()
void xmlSecKeyReqFinalize (xmlSecKeyReqPtr keyReq); |
xmlSecKeyReqReset ()
void xmlSecKeyReqReset (xmlSecKeyReqPtr keyReq); |
xmlSecKeyReqCopy ()
int xmlSecKeyReqCopy (xmlSecKeyReqPtr dst,
xmlSecKeyReqPtr src); |
xmlSecKeyReqMatchKey ()
int xmlSecKeyReqMatchKey (xmlSecKeyReqPtr keyReq,
xmlSecKeyPtr key); |
xmlSecKeyReqMatchKeyValue ()
int xmlSecKeyReqMatchKeyValue (xmlSecKeyReqPtr keyReq,
xmlSecKeyDataPtr value); |
struct xmlSecKey
struct xmlSecKey {
xmlChar* name;
xmlSecKeyDataPtr value;
xmlSecPtrListPtr dataList;
xmlSecKeyUsage usage;
/* for the future */
void* reserved0;
void* reserved1;
}; |
The key.
xmlSecKeyCreate ()
xmlSecKeyPtr xmlSecKeyCreate (void); |
Creates new key of the specified type id.
xmlSecKeyDestroy ()
void xmlSecKeyDestroy (xmlSecKeyPtr key); |
Destroys the key and frees all allocated memory.
xmlSecKeyEmpty ()
void xmlSecKeyEmpty (xmlSecKeyPtr key); |
xmlSecKeyDuplicate ()
xmlSecKeyPtr xmlSecKeyDuplicate (xmlSecKeyPtr key); |
Creates a duplicate of the given key.
xmlSecKeyCopy ()
int xmlSecKeyCopy (xmlSecKeyPtr keyDst,
xmlSecKeyPtr keySrc); |
xmlSecKeyGetName ()
const xmlChar* xmlSecKeyGetName (xmlSecKeyPtr key); |
xmlSecKeySetName ()
int xmlSecKeySetName (xmlSecKeyPtr key,
const xmlChar *name); |
xmlSecKeyGetValue ()
xmlSecKeyDataPtr xmlSecKeyGetValue (xmlSecKeyPtr key); |
xmlSecKeySetValue ()
int xmlSecKeySetValue (xmlSecKeyPtr key,
xmlSecKeyDataPtr value); |
xmlSecKeyGetData ()
xmlSecKeyDataPtr xmlSecKeyGetData (xmlSecKeyPtr key,
xmlSecKeyDataId dataId); |
xmlSecKeyEnsureData ()
xmlSecKeyDataPtr xmlSecKeyEnsureData (xmlSecKeyPtr key,
xmlSecKeyDataId dataId); |
xmlSecKeyAdoptData ()
int xmlSecKeyAdoptData (xmlSecKeyPtr key,
xmlSecKeyDataPtr data); |
xmlSecKeyDebugDump ()
void xmlSecKeyDebugDump (xmlSecKeyPtr key,
FILE *output); |
Prints the information about the key to the output.
xmlSecKeyDebugXmlDump ()
void xmlSecKeyDebugXmlDump (xmlSecKeyPtr key,
FILE *output); |
Prints the information about the key to the output in XML format.
xmlSecKeyGenerate ()
xmlSecKeyPtr xmlSecKeyGenerate (const xmlChar *klass,
const xmlChar *name,
size_t sizeBits,
xmlSecKeyDataType type); |
xmlSecKeyMatch ()
int xmlSecKeyMatch (xmlSecKeyPtr key,
const xmlChar *name,
xmlSecKeyReqPtr keyReq); |
Checks whether the key matches the given criteria
(key name is equal to name, key id is equal to id,
key type is type).
xmlSecKeyIsValid()
#define xmlSecKeyIsValid(key) |
Macro. Returns 1 if key is not NULL and key->id is not NULL
or 0 otherwise.
xmlSecKeyCheckId()
#define xmlSecKeyCheckId(key, keyId) |
Macro. Returns 1 if key is valid and key's id is equal to keyId.
xmlSecKeyPtrListId
#define xmlSecKeyPtrListId xmlSecKeyPtrListGetKlass() |
The keys list klass.
xmlSecKeyPtrListGetKlass ()
xmlSecPtrListId xmlSecKeyPtrListGetKlass (void); |
|
Aleksey Sanin
|
|