| Top |  |  |  |  | 
| typedef | xmlSecKeyUsage | 
| #define | xmlSecKeyUsageSign | 
| #define | xmlSecKeyUsageVerify | 
| #define | xmlSecKeyUsageEncrypt | 
| #define | xmlSecKeyUsageDecrypt | 
| #define | xmlSecKeyUsageKeyExchange | 
| #define | xmlSecKeyUsageKeyDerive | 
| #define | xmlSecKeyUsageKeyAgreement | 
| #define | xmlSecKeyUsageAny | 
| struct | xmlSecKeyUseWith | 
| #define | xmlSecKeyUseWithPtrListId | 
| struct | xmlSecKeyReq | 
| struct | xmlSecKey | 
| #define | xmlSecKeyPtrListId | 
int
xmlSecKeyUseWithInitialize (xmlSecKeyUseWithPtr keyUseWith);
Initializes keyUseWith
 object.
void
xmlSecKeyUseWithFinalize (xmlSecKeyUseWithPtr keyUseWith);
Finalizes keyUseWith
 object.
void
xmlSecKeyUseWithReset (xmlSecKeyUseWithPtr keyUseWith);
Resets the keyUseWith
 to its state after initialization.
int xmlSecKeyUseWithCopy (xmlSecKeyUseWithPtr dst,xmlSecKeyUseWithPtr src);
Copies information from dst
 to src
.
xmlSecKeyUseWithPtr xmlSecKeyUseWithCreate (const xmlChar *application,const xmlChar *identifier);
Creates new xmlSecKeyUseWith object. The caller is responsible for destroying
returned object with xmlSecKeyUseWithDestroy
 function.
xmlSecKeyUseWithPtr
xmlSecKeyUseWithDuplicate (xmlSecKeyUseWithPtr keyUseWith);
Duplicates keyUseWith
 object. The caller is responsible for destroying
returned object with xmlSecKeyUseWithDestroy
 function.
void
xmlSecKeyUseWithDestroy (xmlSecKeyUseWithPtr keyUseWith);
Destroys keyUseWith
 created with xmlSecKeyUseWithCreate
 or xmlSecKeyUseWithDuplicate
functions.
int xmlSecKeyUseWithSet (xmlSecKeyUseWithPtr keyUseWith,const xmlChar *application,const xmlChar *identifier);
Sets application
 and identifier
 in the keyUseWith
.
void xmlSecKeyUseWithDebugDump (xmlSecKeyUseWithPtr keyUseWith,FILE *output);
Prints xmlSecKeyUseWith debug information to a file output
.
void xmlSecKeyUseWithDebugXmlDump (xmlSecKeyUseWithPtr keyUseWith,FILE *output);
Prints xmlSecKeyUseWith debug information to a file output
 in XML format.
xmlSecPtrListId
xmlSecKeyUseWithPtrListGetKlass (void);
The key data list klass.
int
xmlSecKeyReqInitialize (xmlSecKeyReqPtr keyReq);
Initialize key requirements object. Caller is responsible for cleaning it with xmlSecKeyReqFinalize function.
void
xmlSecKeyReqFinalize (xmlSecKeyReqPtr keyReq);
Cleans the key requirements object initialized with xmlSecKeyReqInitialize function.
void
xmlSecKeyReqReset (xmlSecKeyReqPtr keyReq);
Resets key requirements object for new key search.
int xmlSecKeyReqCopy (xmlSecKeyReqPtr dst,xmlSecKeyReqPtr src);
Copies key requirements from src
 object to dst
 object.
int xmlSecKeyReqMatchKey (xmlSecKeyReqPtr keyReq,xmlSecKeyPtr key);
Checks whether key
 matches key requirements keyReq
.
int xmlSecKeyReqMatchKeyValue (xmlSecKeyReqPtr keyReq,xmlSecKeyDataPtr value);
Checks whether keyValue
 matches key requirements keyReq
.
void xmlSecKeyReqDebugDump (xmlSecKeyReqPtr keyReq,FILE *output);
Prints debug information about keyReq
 into output
.
void xmlSecKeyReqDebugXmlDump (xmlSecKeyReqPtr keyReq,FILE *output);
Prints debug information about keyReq
 into output
 in XML format.
xmlSecKeyPtr
xmlSecKeyCreate (void);
Allocates and initializes new key. Caller is responsible for freeing returned object with xmlSecKeyDestroy function.
void
xmlSecKeyDestroy (xmlSecKeyPtr key);
Destroys the key created using xmlSecKeyCreate function.
xmlSecKeyPtr
xmlSecKeyDuplicate (xmlSecKeyPtr key);
Creates a duplicate of the given key
.
int xmlSecKeyCopy (xmlSecKeyPtr keyDst,xmlSecKeyPtr keySrc);
Copies key data from keySrc
 to keyDst
.
int xmlSecKeySwap (xmlSecKeyPtr key1,xmlSecKeyPtr key2);
Swaps key data for key1
 andkey2
const xmlChar *
xmlSecKeyGetName (xmlSecKeyPtr key);
Gets key name (see also xmlSecKeySetName function).
int xmlSecKeySetName (xmlSecKeyPtr key,const xmlChar *name);
Sets key name (see also xmlSecKeyGetName function).
int xmlSecKeySetNameEx (xmlSecKeyPtr key,const xmlChar *name,xmlSecSize nameSize);
Sets key name (see also xmlSecKeyGetName function).
xmlSecKeyDataPtr
xmlSecKeyGetValue (xmlSecKeyPtr key);
Gets key value (see also xmlSecKeySetValue function).
int xmlSecKeySetValue (xmlSecKeyPtr key,xmlSecKeyDataPtr value);
Sets key value (see also xmlSecKeyGetValue function).
xmlSecSize
xmlSecKeyGetSize (xmlSecKeyPtr key);
Gets key size (in bits). Also see xmlSecKeyDataGetSize function.
xmlSecKeyDataPtr xmlSecKeyGetData (xmlSecKeyPtr key,xmlSecKeyDataId dataId);
Gets key's data.
xmlSecKeyDataPtr xmlSecKeyEnsureData (xmlSecKeyPtr key,xmlSecKeyDataId dataId);
If necessary, creates key data of dataId
 klass and adds to key
.
int xmlSecKeyAdoptData (xmlSecKeyPtr key,xmlSecKeyDataPtr data);
Adds data
 to the key
. The data
 object will be destroyed
by key
.
void xmlSecKeyDebugDump (xmlSecKeyPtr key,FILE *output);
Prints the information about the key
 to the output
.
void xmlSecKeyDebugXmlDump (xmlSecKeyPtr key,FILE *output);
Prints the information about the key
 to the output
 in XML format.
xmlSecKeyPtr xmlSecKeyGenerate (xmlSecKeyDataId dataId,xmlSecSize sizeBits,xmlSecKeyDataType type);
Generates new key of requested klass dataId
 and type
.
xmlSecKeyPtr xmlSecKeyGenerateByName (const xmlChar *name,xmlSecSize sizeBits,xmlSecKeyDataType type);
Generates new key of requested klass
 and type
.
int xmlSecKeyMatch (xmlSecKeyPtr key,const xmlChar *name,xmlSecKeyReqPtr keyReq);
Checks whether the key
 matches the given criteria.
xmlSecKeyPtr xmlSecKeyReadBuffer (xmlSecKeyDataId dataId,xmlSecBuffer *buffer);
Reads the key value of klass dataId
 from a buffer.
xmlSecKeyPtr xmlSecKeyReadBinaryFile (xmlSecKeyDataId dataId,const char *filename);
Reads the key value of klass dataId
 from a binary file filename
.
xmlSecKeyPtr xmlSecKeyReadMemory (xmlSecKeyDataId dataId,const xmlSecByte *data,xmlSecSize dataSize);
Reads the key value of klass dataId
 from a memory block data
.
#define xmlSecKeyIsValid(key)
Macro. Returns 1 if key
 is not NULL and key->id
 is not NULL
or 0 otherwise.
#define xmlSecKeyCheckId(key, keyId)
Macro. Returns 1 if key
 is valid and key
's id is equal to keyId
.
#define xmlSecKeyUsageKeyExchange 0x00000010
Deprecated. The key is used for key exchange.
#define xmlSecKeyUsageKeyDerive 0x00000020
The key is used for key derivation.
#define xmlSecKeyUsageKeyAgreement 0x00000040
The key is used for key agreement.
struct xmlSecKeyUseWith {
    xmlChar*                    application;
    xmlChar*                    identifier;
    void*                       reserved1;
    void*                       reserved2;
};
Information about application and user of the key.
#define xmlSecKeyUseWithPtrListId xmlSecKeyUseWithPtrListGetKlass()
The keys list klass.
struct xmlSecKeyReq {
    xmlSecKeyDataId             keyId;
    xmlSecKeyDataType           keyType;
    xmlSecKeyUsage              keyUsage;
    xmlSecSize                  keyBitsSize;
    xmlSecPtrList               keyUseWithList;
    void*                       reserved1;
    void*                       reserved2;
};
The key requirements information.
| the desired key value klass. | ||
| xmlSecKeyDataType  | the desired key type. | |
| xmlSecKeyUsage  | the desired key usage. | |
| xmlSecSize  | the desired key size (in bits!). | |
| xmlSecPtrList  | the desired key use with application/identifier information. | |
| reserved for future use. | ||
| reserved for future use. | 
struct xmlSecKey {
    xmlChar*                            name;
    xmlSecKeyDataPtr                    value;
    xmlSecPtrListPtr                    dataList;
    xmlSecKeyUsage                      usage;
    time_t                              notValidBefore;
    time_t                              notValidAfter;
};
The key.
| the key name. | ||
| xmlSecKeyDataPtr  | the key value. | |
| xmlSecPtrListPtr  | the key data list. | |
| xmlSecKeyUsage  | the key usage. | |
| the start key validity interval. | ||
| the end key validity interval. |