keysmngr.h

Name

keysmngr.h -- The simple keys manager implementation.

Synopsis



#define     xmlSecSimpleKeysStoreId
xmlSecKeyDataStoreId xmlSecSimpleKeysStoreGetKlass
                                            (void);
int         xmlSecSimpleKeysStoreAdoptKey   (xmlSecKeyDataStorePtr store,
                                             xmlSecKeyPtr key);
xmlSecKeyPtr xmlSecSimpleKeysStoreFindKey   (xmlSecKeyDataStorePtr store,
                                             const xmlChar *name,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
int         xmlSecSimpleKeysStoreLoad       (xmlSecKeyDataStorePtr store,
                                             const char *uri);
int         xmlSecSimpleKeysStoreSave       (xmlSecKeyDataStorePtr store,
                                             const char *filename,
                                             xmlSecKeyDataType type);
xmlSecKeysMngrPtr xmlSecKeysMngrCreate      (void);
void        xmlSecKeysMngrDestroy           (xmlSecKeysMngrPtr mngr);
int         xmlSecKeysMngrFindKey           (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyPtr key,
                                             const xmlChar *name,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
int         xmlSecKeysMngrFindKeyData       (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStoreId storeId,
                                             xmlSecKeyPtr key,
                                             const xmlChar **params,
                                             size_t paramsSize,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
int         xmlSecKeysMngrAdoptKeysStore    (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStorePtr store);
xmlSecKeyDataStorePtr xmlSecKeysMngrGetKeysStore
                                            (xmlSecKeysMngrPtr mngr);
int         xmlSecKeysMngrAdoptDataStore    (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStorePtr store);
xmlSecKeyDataStorePtr xmlSecKeysMngrGetDataStore
                                            (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStoreId id);
xmlSecKeyPtr (*xmlSecGetKeyCallback)        (xmlNodePtr keyInfoNode,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);
struct      xmlSecKeysMngr;
xmlSecKeyPtr xmlSecKeysMngrGetKey           (xmlNodePtr keyInfoNode,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

Description

Details

xmlSecSimpleKeysStoreId

#define xmlSecSimpleKeysStoreId		xmlSecSimpleKeysStoreGetKlass()


xmlSecSimpleKeysStoreGetKlass ()

xmlSecKeyDataStoreId xmlSecSimpleKeysStoreGetKlass
                                            (void);

Returns : 


xmlSecSimpleKeysStoreAdoptKey ()

int         xmlSecSimpleKeysStoreAdoptKey   (xmlSecKeyDataStorePtr store,
                                             xmlSecKeyPtr key);

store : 
key : 
Returns : 


xmlSecSimpleKeysStoreFindKey ()

xmlSecKeyPtr xmlSecSimpleKeysStoreFindKey   (xmlSecKeyDataStorePtr store,
                                             const xmlChar *name,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

store : 
name : 
keyInfoCtx : 
Returns : 


xmlSecSimpleKeysStoreLoad ()

int         xmlSecSimpleKeysStoreLoad       (xmlSecKeyDataStorePtr store,
                                             const char *uri);

store : 
uri : 
Returns : 


xmlSecSimpleKeysStoreSave ()

int         xmlSecSimpleKeysStoreSave       (xmlSecKeyDataStorePtr store,
                                             const char *filename,
                                             xmlSecKeyDataType type);

store : 
filename : 
type : 
Returns : 


xmlSecKeysMngrCreate ()

xmlSecKeysMngrPtr xmlSecKeysMngrCreate      (void);

Returns : 


xmlSecKeysMngrDestroy ()

void        xmlSecKeysMngrDestroy           (xmlSecKeysMngrPtr mngr);

mngr : 


xmlSecKeysMngrFindKey ()

int         xmlSecKeysMngrFindKey           (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyPtr key,
                                             const xmlChar *name,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

mngr : 
key : 
name : 
keyInfoCtx : 
Returns : 


xmlSecKeysMngrFindKeyData ()

int         xmlSecKeysMngrFindKeyData       (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStoreId storeId,
                                             xmlSecKeyPtr key,
                                             const xmlChar **params,
                                             size_t paramsSize,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

mngr : 
storeId : 
key : 
params : 
paramsSize : 
keyInfoCtx : 
Returns : 


xmlSecKeysMngrAdoptKeysStore ()

int         xmlSecKeysMngrAdoptKeysStore    (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStorePtr store);

mngr : 
store : 
Returns : 


xmlSecKeysMngrGetKeysStore ()

xmlSecKeyDataStorePtr xmlSecKeysMngrGetKeysStore
                                            (xmlSecKeysMngrPtr mngr);

mngr : 
Returns : 


xmlSecKeysMngrAdoptDataStore ()

int         xmlSecKeysMngrAdoptDataStore    (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStorePtr store);

mngr : 
store : 
Returns : 


xmlSecKeysMngrGetDataStore ()

xmlSecKeyDataStorePtr xmlSecKeysMngrGetDataStore
                                            (xmlSecKeysMngrPtr mngr,
                                             xmlSecKeyDataStoreId id);

mngr : 
id : 
Returns : 


xmlSecGetKeyCallback ()

xmlSecKeyPtr (*xmlSecGetKeyCallback)        (xmlNodePtr keyInfoNode,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

Reads the <dsig:KeyInfo> node keyInfoNode and extracts the key.

keyInfoNode : the pointer to <dsig:KeyInfo> node.
keyInfoCtx : 
Returns :the pointer to key or NULL if the key is not found or an error occurs.


struct xmlSecKeysMngr

struct xmlSecKeysMngr {	
    xmlSecKeyDataStorePtr		keysStore;
    xmlSecPtrListPtr			storesList;



    xmlSecGetKeyCallback		getKey;

    xmlSecKeyOrigin 			allowedOrigins;
    int 				maxRetrievalsLevel;
    int					maxEncKeysLevel; 
    /* x509 certs */    
    int					failIfCertNotFound; 
};

The keys manager structure.

xmlSecKeyDataStorePtr keysStore 
xmlSecPtrListPtr storesList 
xmlSecGetKeyCallback getKey the callback used to read <dsig:KeyInfo> node.
xmlSecKeyOrigin allowedOrigins the allowed origins bits mask.
int maxRetrievalsLevel the max allowed <dsig:RetrievalMethod> level to prevent DOS attack.
int maxEncKeysLevel the max allowed <enc:EncryptedKey> level to prevent DOS attack.
int failIfCertNotFound the flag.


xmlSecKeysMngrGetKey ()

xmlSecKeyPtr xmlSecKeysMngrGetKey           (xmlNodePtr keyInfoNode,
                                             xmlSecKeyInfoCtxPtr keyInfoCtx);

Reads the <dsig:KeyInfo> node keyInfoNode and extracts the key.

keyInfoNode : the pointer to <dsig:KeyInfo> node.
keyInfoCtx : 
Returns :the pointer to key or NULL if the key is not found or an error occurs.