keyinfo.h

Name

keyinfo.h -- The <dsig:KeyInfo> element manipulation functions.

Synopsis



int         xmlSecKeyInfoNodeRead           (xmlNodePtr keyInfoNode,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
int         xmlSecKeyInfoNodeWrite          (xmlNodePtr keyInfoNode,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
#define     xmlSecKeyDataNameId
xmlSecKeyDataId xmlSecKeyDataNameGetKlass   (void);
#define     xmlSecKeyDataValueId
xmlSecKeyDataId xmlSecKeyDataValueGetKlass  (void);
#define     xmlSecKeyDataRetrievalMethodId
xmlSecKeyDataId xmlSecKeyDataRetrievalMethodGetKlass
                                            (void);
#define     xmlSecKeyDataEncryptedKeyId
xmlSecKeyDataId xmlSecKeyDataEncryptedKeyGetKlass
                                            (void);
struct      xmlSecKeyInfoCtx;
#define     xmlSecKeyInfoNodeCheckOrigin    (status, origin)
#define     xmlSecKeyInfoNodeCheckRetrievalsLevel(status)
#define     xmlSecKeyInfoNodeCheckEncKeysLevel(status)

Description

Details

xmlSecKeyInfoNodeRead ()

int         xmlSecKeyInfoNodeRead           (xmlNodePtr keyInfoNode,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

Parses the <dsig:KeyInfo> element and extracts the key (with required id, type and usage).

keyInfoNode : the pointer to <dsig:KeyInfo> node.
key : 
keyInfoCtx : the pointer to xmlSecKeyInfoCtx structure.
Returns :0 on success or -1 if an error occurs.


xmlSecKeyInfoNodeWrite ()

int         xmlSecKeyInfoNodeWrite          (xmlNodePtr keyInfoNode,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

Writes the key into the <dsig:KeyInfo> template keyInfoNode.

keyInfoNode : the pointer to <dsig:KeyInfo> node.
key : the key.
keyInfoCtx : the pointer to xmlSecKeyInfoCtx structure.
Returns :0 on success or -1 if an error occurs.


xmlSecKeyDataNameId

#define xmlSecKeyDataNameId	xmlSecKeyDataNameGetKlass()

The <dsig:KeyName> processing class.


xmlSecKeyDataNameGetKlass ()

xmlSecKeyDataId xmlSecKeyDataNameGetKlass   (void);

Returns : 


xmlSecKeyDataValueId

#define xmlSecKeyDataValueId	xmlSecKeyDataValueGetKlass()

The <dsig:KeyValue> processing class.


xmlSecKeyDataValueGetKlass ()

xmlSecKeyDataId xmlSecKeyDataValueGetKlass  (void);

Returns : 


xmlSecKeyDataRetrievalMethodId

#define xmlSecKeyDataRetrievalMethodId	xmlSecKeyDataRetrievalMethodGetKlass()

The <dsig:RetrievalMethod> processing class.


xmlSecKeyDataRetrievalMethodGetKlass ()

xmlSecKeyDataId xmlSecKeyDataRetrievalMethodGetKlass
                                            (void);

Returns : 


xmlSecKeyDataEncryptedKeyId

#define xmlSecKeyDataEncryptedKeyId	xmlSecKeyDataEncryptedKeyGetKlass()

The <enc:EncryptedKey> processing class.


xmlSecKeyDataEncryptedKeyGetKlass ()

xmlSecKeyDataId xmlSecKeyDataEncryptedKeyGetKlass
                                            (void);

Returns : 


struct xmlSecKeyInfoCtx

struct xmlSecKeyInfoCtx {
    xmlSecKeysMngrPtr			keysMngr;
    void				*context;
    
    xmlSecKeyReq			keyReq;

    int					base64LineSize;
    int 				retrievalsLevel;
    int					encKeysLevel;                

    /* x509 certificate */
    int					failIfCertNotFound;
    time_t				certsVerificationTime;
    int					certsVerificationDepth;
};


xmlSecKeyInfoNodeCheckOrigin()

#define     xmlSecKeyInfoNodeCheckOrigin(status, origin)

status : 
origin : 


xmlSecKeyInfoNodeCheckRetrievalsLevel()

#define     xmlSecKeyInfoNodeCheckRetrievalsLevel(status)

status : 


xmlSecKeyInfoNodeCheckEncKeysLevel()

#define     xmlSecKeyInfoNodeCheckEncKeysLevel(status)

status :