keyinfo.h

Name

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

Synopsis



xmlSecKeyPtr xmlSecKeyInfoNodeRead          (xmlNodePtr keyInfoNode,
                                             xmlSecKeysMngrPtr keysMngr,
                                             void *context,
                                             xmlSecKeyId keyId,
                                             xmlSecKeyType keyType,
                                             xmlSecKeyUsage keyUsage);
int         xmlSecKeyInfoNodeWrite          (xmlNodePtr keyInfoNode,
                                             xmlSecKeysMngrPtr keysMngr,
                                             void *context,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyType type);
xmlNodePtr  xmlSecKeyInfoAddKeyName         (xmlNodePtr keyInfoNode);
xmlNodePtr  xmlSecKeyInfoAddKeyValue        (xmlNodePtr keyInfoNode);
xmlNodePtr  xmlSecKeyInfoAddX509Data        (xmlNodePtr keyInfoNode);
xmlNodePtr  xmlSecKeyInfoAddRetrievalMethod (xmlNodePtr keyInfoNode,
                                             const xmlChar *uri,
                                             const xmlChar *type);
xmlNodePtr  xmlSecRetrievalMethodAddTransform
                                            (xmlNodePtr retrMethod,
                                             xmlSecTransformId transform);
xmlNodePtr  xmlSecKeyInfoAddEncryptedKey    (xmlNodePtr keyInfoNode,
                                             const xmlChar *id,
                                             const xmlChar *type,
                                             const xmlChar *recipient);

Description

Details

xmlSecKeyInfoNodeRead ()

xmlSecKeyPtr xmlSecKeyInfoNodeRead          (xmlNodePtr keyInfoNode,
                                             xmlSecKeysMngrPtr keysMngr,
                                             void *context,
                                             xmlSecKeyId keyId,
                                             xmlSecKeyType keyType,
                                             xmlSecKeyUsage keyUsage);

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


xmlSecKeyInfoNodeWrite ()

int         xmlSecKeyInfoNodeWrite          (xmlNodePtr keyInfoNode,
                                             xmlSecKeysMngrPtr keysMngr,
                                             void *context,
                                             xmlSecKeyPtr key,
                                             xmlSecKeyType type);

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


xmlSecKeyInfoAddKeyName ()

xmlNodePtr  xmlSecKeyInfoAddKeyName         (xmlNodePtr keyInfoNode);

Adds <dsig:KeyName> node to the <dsig:KeyInfo> node keyInfoNode.


xmlSecKeyInfoAddKeyValue ()

xmlNodePtr  xmlSecKeyInfoAddKeyValue        (xmlNodePtr keyInfoNode);

Adds <dsig:KeyValue> node to the <dsig:KeyInfo> node keyInfoNode.


xmlSecKeyInfoAddX509Data ()

xmlNodePtr  xmlSecKeyInfoAddX509Data        (xmlNodePtr keyInfoNode);

Adds <dsig:X509Data> node to the <dsig:KeyInfo> node keyInfoNode.


xmlSecKeyInfoAddRetrievalMethod ()

xmlNodePtr  xmlSecKeyInfoAddRetrievalMethod (xmlNodePtr keyInfoNode,
                                             const xmlChar *uri,
                                             const xmlChar *type);

Adds <dsig:RetrievalMethod> node to the <dsig:KeyInfo> node keyInfoNode.


xmlSecRetrievalMethodAddTransform ()

xmlNodePtr  xmlSecRetrievalMethodAddTransform
                                            (xmlNodePtr retrMethod,
                                             xmlSecTransformId transform);

Adds <dsig:Transform> node (and the parent <dsig:Transforms> node if required) to the <dsig:RetrievalMethod> node retrMethod.


xmlSecKeyInfoAddEncryptedKey ()

xmlNodePtr  xmlSecKeyInfoAddEncryptedKey    (xmlNodePtr keyInfoNode,
                                             const xmlChar *id,
                                             const xmlChar *type,
                                             const xmlChar *recipient);

Adds <enc:EncryptedKey> node with given attributes to the <dsig:KeyInfo> node keyInfoNode.