keysmngr.h

Name

keysmngr.h -- The simple keys manager implementation.

Synopsis



xmlSecKeysMngrPtr xmlSecSimpleKeysMngrCreate
                                            (void);
void        xmlSecSimpleKeysMngrDestroy     (xmlSecKeysMngrPtr mngr);
xmlSecKeyPtr xmlSecSimpleKeysMngrFindKey    (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             const xmlChar *name,
                                             xmlSecKeyId id,
                                             xmlSecKeyType type,
                                             xmlSecKeyUsage usage);
int         xmlSecSimpleKeysMngrAddKey      (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyPtr key);
int         xmlSecSimpleKeysMngrLoad        (xmlSecKeysMngrPtr mngr,
                                             const char *uri,
                                             int strict);
int         xmlSecSimpleKeysMngrSave        (const xmlSecKeysMngrPtr mngr,
                                             const char *filename,
                                             xmlSecKeyType type);
xmlSecKeyPtr xmlSecSimpleKeysMngrLoadPemKey (xmlSecKeysMngrPtr mngr,
                                             const char *keyfile,
                                             const char *keyPwd,
                                             pem_password_cb *keyPwdCallback,
                                             int privateKey);
xmlSecX509DataPtr xmlSecSimpleKeysMngrX509Find
                                            (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             xmlChar *subjectName,
                                             xmlChar *issuerName,
                                             xmlChar *issuerSerial,
                                             xmlChar *ski,
                                             xmlSecX509DataPtr cert);
int         xmlSecSimpleKeysMngrX509Verify  (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             xmlSecX509DataPtr cert);
int         xmlSecSimpleKeysMngrLoadPemCert (xmlSecKeysMngrPtr mngr,
                                             const char *filename,
                                             int trusted);
int         xmlSecSimpleKeysMngrAddCertsDir (xmlSecKeysMngrPtr mngr,
                                             const char *path);
int         xmlSecSimpleKeysMngrLoadPkcs12  (xmlSecKeysMngrPtr mngr,
                                             const char *name,
                                             const char *filename,
                                             const char *pwd);

Description

Details

xmlSecSimpleKeysMngrCreate ()

xmlSecKeysMngrPtr xmlSecSimpleKeysMngrCreate
                                            (void);

Creates new simple keys manager.


xmlSecSimpleKeysMngrDestroy ()

void        xmlSecSimpleKeysMngrDestroy     (xmlSecKeysMngrPtr mngr);

Destroys the simple keys manager.


xmlSecSimpleKeysMngrFindKey ()

xmlSecKeyPtr xmlSecSimpleKeysMngrFindKey    (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             const xmlChar *name,
                                             xmlSecKeyId id,
                                             xmlSecKeyType type,
                                             xmlSecKeyUsage usage);

Searches the simple keys manager for specified key. This is an implementation of the xmlSecFindKeyCallback for the simple keys manager.


xmlSecSimpleKeysMngrAddKey ()

int         xmlSecSimpleKeysMngrAddKey      (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyPtr key);

Adds new key to the key manager


xmlSecSimpleKeysMngrLoad ()

int         xmlSecSimpleKeysMngrLoad        (xmlSecKeysMngrPtr mngr,
                                             const char *uri,
                                             int strict);

Reads the XML keys files into simple keys manager.


xmlSecSimpleKeysMngrSave ()

int         xmlSecSimpleKeysMngrSave        (const xmlSecKeysMngrPtr mngr,
                                             const char *filename,
                                             xmlSecKeyType type);

Writes all the keys from the simple keys manager to an XML file filename.


xmlSecSimpleKeysMngrLoadPemKey ()

xmlSecKeyPtr xmlSecSimpleKeysMngrLoadPemKey (xmlSecKeysMngrPtr mngr,
                                             const char *keyfile,
                                             const char *keyPwd,
                                             pem_password_cb *keyPwdCallback,
                                             int privateKey);

Reads the key from a PEM file keyfile.


xmlSecSimpleKeysMngrX509Find ()

xmlSecX509DataPtr xmlSecSimpleKeysMngrX509Find
                                            (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             xmlChar *subjectName,
                                             xmlChar *issuerName,
                                             xmlChar *issuerSerial,
                                             xmlChar *ski,
                                             xmlSecX509DataPtr cert);

Searches for matching certificate in the keys manager. This is the implementation of the xmlSecX509FindCallback for the simple keys manager.


xmlSecSimpleKeysMngrX509Verify ()

int         xmlSecSimpleKeysMngrX509Verify  (xmlSecKeysMngrPtr mngr,
                                             void *context,
                                             xmlSecX509DataPtr cert);

Validates certificate. This is the implementation of the xmlSecX509VerifyCallback callback for the simple keys manager.


xmlSecSimpleKeysMngrLoadPemCert ()

int         xmlSecSimpleKeysMngrLoadPemCert (xmlSecKeysMngrPtr mngr,
                                             const char *filename,
                                             int trusted);

Reads PEM certificate from the file filename and adds to the keys manager mngr.


xmlSecSimpleKeysMngrAddCertsDir ()

int         xmlSecSimpleKeysMngrAddCertsDir (xmlSecKeysMngrPtr mngr,
                                             const char *path);

Adds the certificates from the folder path to the list of trusted certificates.


xmlSecSimpleKeysMngrLoadPkcs12 ()

int         xmlSecSimpleKeysMngrLoadPkcs12  (xmlSecKeysMngrPtr mngr,
                                             const char *name,
                                             const char *filename,
                                             const char *pwd);

Reads the key from pkcs12 file filename (along with all certs) and adds to the simple keys manager mngr.