/** 

 * XML Security Library (http://www.aleksey.com/xmlsec).

 *

 * Keys Manager

 * 

 * This is free software; see Copyright file in the source

 * distribution for preciese wording.

 * 

 * Copyright (C) 2002-2003 Aleksey Sanin <aleksey@aleksey.com>

 * Portion Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 

 */

#include "xmlsec_globals.h"

#include <stdlib.h>

#include <stdio.h>

#include <string.h>

#include <errno.h>

#include "xmlsec_xmlsec.h"

#include "xmlsec_xmltree.h"

#include "xmlsec_list.h"

#include "xmlsec_keys.h"

#include "xmlsec_transforms.h"

#include "xmlsec_keysmngr.h"

#include "xmlsec_errors.h"

/****************************************************************************

 *

 * Keys Manager

 *

 ***************************************************************************/

/** 

 * xmlSecKeysMngrCreate:

 * 

 * Creates new keys manager. Caller is responsible for freeing it with 

 * #xmlSecKeysMngrDestroy function.

 * 

 * Returns the pointer to newly allocated keys manager or NULL if 

 * an error occurs.

 */

EXPORT_C

xmlSecKeysMngrPtr 

xmlSecKeysMngrCreate(void) {

    xmlSecKeysMngrPtr mngr;

    int ret;

    /* Allocate a new xmlSecKeysMngr and fill the fields. */

    mngr = (xmlSecKeysMngrPtr)xmlMalloc(sizeof(xmlSecKeysMngr));

    if(mngr == NULL) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    NULL,

		    NULL,

		    XMLSEC_ERRORS_R_MALLOC_FAILED,

		    "sizeof(xmlSecKeysMngr)=%d", 

		    sizeof(xmlSecKeysMngr));

	return(NULL);

    }

    memset(mngr, 0, sizeof(xmlSecKeysMngr));    

    ret = xmlSecPtrListInitialize(&(mngr->storesList), xmlSecKeyDataStorePtrListId);

    if(ret < 0) 

        {

        xmlSecError(XMLSEC_ERRORS_HERE,

		    NULL,

		    "xmlSecPtrListInitialize",

		    XMLSEC_ERRORS_R_XMLSEC_FAILED,

		    "xmlSecKeyDataStorePtrListId");

        xmlFree(mngr);  

        return(NULL);

        }

    return(mngr);    

}

/** 

 * xmlSecKeysMngrDestroy:

 * @mngr:		the pointer to keys manager.

 *

 * Destroys keys manager created with #xmlSecKeysMngrCreate function.

 */

EXPORT_C

void

xmlSecKeysMngrDestroy(xmlSecKeysMngrPtr mngr) {

    xmlSecAssert(mngr != NULL);

    /* destroy keys store */

    if(mngr->keysStore != NULL) {

	xmlSecKeyStoreDestroy(mngr->keysStore);

    }

    /* destroy other data stores */

    xmlSecPtrListFinalize(&(mngr->storesList));

    memset(mngr, 0, sizeof(xmlSecKeysMngr));    

    xmlFree(mngr);    

}

/**

 * xmlSecKeysMngrFindKey:

 * @mngr:		the pointer to keys manager.

 * @name:		the desired key name.

 * @keyInfoCtx:		the pointer to <dsig:KeyInfo/> node processing context.

 *

 * Lookups key in the keys manager keys store. The caller is responsible 

 * for destroying the returned key using #xmlSecKeyDestroy method.

 *

 * Returns the pointer to a key or NULL if key is not found or an error occurs.

 */

EXPORT_C

xmlSecKeyPtr

xmlSecKeysMngrFindKey(xmlSecKeysMngrPtr mngr, const xmlChar* name, xmlSecKeyInfoCtxPtr keyInfoCtx) {

    xmlSecKeyStorePtr store;

    xmlSecAssert2(mngr != NULL, NULL);

    xmlSecAssert2(keyInfoCtx != NULL, NULL);

    store = xmlSecKeysMngrGetKeysStore(mngr);

    if(store == NULL) {

	return(NULL);

    }

    return(xmlSecKeyStoreFindKey(store, name, keyInfoCtx));

}

/**

 * xmlSecKeysMngrAdoptKeysStore:

 * @mngr:		the pointer to keys manager.

 * @store:		the pointer to keys store.

 *

 * Adopts keys store in the keys manager @mngr.

 *

 * Returns 0 on success or a negative value if an error occurs.

 */

EXPORT_C

int

xmlSecKeysMngrAdoptKeysStore(xmlSecKeysMngrPtr mngr, xmlSecKeyStorePtr store) {

    xmlSecAssert2(mngr != NULL, -1);

    xmlSecAssert2(xmlSecKeyStoreIsValid(store), -1);

    if(mngr->keysStore != NULL) {

	xmlSecKeyStoreDestroy(mngr->keysStore);

    }

    mngr->keysStore = store;

    return(0);

}

/**

 * xmlSecKeysMngrGetKeysStore:

 * @mngr:		the pointer to keys manager.

 *

 * Gets the keys store.

 *

 * Returns the keys store in the keys manager @mngr or NULL if 

 * there is no store or an error occurs.

 */

EXPORT_C

xmlSecKeyStorePtr

xmlSecKeysMngrGetKeysStore(xmlSecKeysMngrPtr mngr) {

    xmlSecAssert2(mngr != NULL, NULL);

    return(mngr->keysStore);

}

/**

 * xmlSecKeysMngrAdoptDataStore:

 * @mngr:		the pointer to keys manager.

 * @store:		the pointer to data store.

 *

 * Adopts data store in the keys manager.

 *

 * Returns 0 on success or a negative value if an error occurs.

 */

EXPORT_C

int

xmlSecKeysMngrAdoptDataStore(xmlSecKeysMngrPtr mngr, xmlSecKeyDataStorePtr store) {

    xmlSecKeyDataStorePtr tmp;

    xmlSecSize pos, size;

    xmlSecAssert2(mngr != NULL, -1);

    xmlSecAssert2(xmlSecKeyDataStoreIsValid(store), -1);

    size = xmlSecPtrListGetSize(&(mngr->storesList));

    for(pos = 0; pos < size; ++pos) {

	tmp = (xmlSecKeyDataStorePtr)xmlSecPtrListGetItem(&(mngr->storesList), pos);

	if((tmp != NULL) && (tmp->id == store->id)) {	

	    return(xmlSecPtrListSet(&(mngr->storesList), store, pos));

	}

    }

    return(xmlSecPtrListAdd(&(mngr->storesList), store));

}

/**

 * xmlSecKeysMngrGetDataStore:

 * @mngr:		the pointer to keys manager.

 * @id:			the desired data store klass.

 *

 * Lookups the data store of given klass @id in the keys manager.

 *

 * Returns pointer to data store or NULL if it is not found or an error

 * occurs.

 */

EXPORT_C

xmlSecKeyDataStorePtr 

xmlSecKeysMngrGetDataStore(xmlSecKeysMngrPtr mngr, xmlSecKeyDataStoreId id) {

    xmlSecKeyDataStorePtr tmp;

    xmlSecSize pos, size;

    xmlSecAssert2(mngr != NULL, NULL);

    xmlSecAssert2(id != xmlSecKeyDataStoreIdUnknown, NULL);

    size = xmlSecPtrListGetSize(&(mngr->storesList));

    for(pos = 0; pos < size; ++pos) {

	tmp = (xmlSecKeyDataStorePtr)xmlSecPtrListGetItem(&(mngr->storesList), pos);

	if((tmp != NULL) && (tmp->id == id)) {	

	    return(tmp);

	}

    }

    return(NULL);

}

/**************************************************************************

 *

 * xmlSecKeyStore functions

 *

 *************************************************************************/

/**

 * xmlSecKeyStoreCreate:

 * @id: 		the key store klass.

 *

 * Creates new store of the specified klass @klass. Caller is responsible

 * for freeing the returned store by calling #xmlSecKeyStoreDestroy function.

 *

 * Returns the pointer to newly allocated keys store or NULL if an error occurs.

 */

EXPORT_C

xmlSecKeyStorePtr	

xmlSecKeyStoreCreate(xmlSecKeyStoreId id)  {

    xmlSecKeyStorePtr store;

    int ret;

    xmlSecAssert2(id != NULL, NULL);

    xmlSecAssert2(id->objSize > 0, NULL);

    /* Allocate a new xmlSecKeyStore and fill the fields. */

    store = (xmlSecKeyStorePtr)xmlMalloc(id->objSize);

    if(store == NULL) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    xmlSecErrorsSafeString(xmlSecKeyStoreKlassGetName(id)),

		    NULL,

		    XMLSEC_ERRORS_R_MALLOC_FAILED,

		    "size=%d", id->objSize); 

	return(NULL);

    }

    memset(store, 0, id->objSize);    

    store->id = id;

    if(id->initialize != NULL) {

	ret = (id->initialize)(store);

        if(ret < 0) {

	    xmlSecError(XMLSEC_ERRORS_HERE,

			xmlSecErrorsSafeString(xmlSecKeyStoreKlassGetName(id)),

			"id->initialize",

			XMLSEC_ERRORS_R_XMLSEC_FAILED,

			XMLSEC_ERRORS_NO_MESSAGE);

	    xmlSecKeyStoreDestroy(store);

	    return(NULL);

	}

    }

    return(store);

}

/**

 * xmlSecKeyStoreDestroy:

 * @store: 		the pointer to keys store. 

 *

 * Destroys the store created with #xmlSecKeyStoreCreate function.

 */

EXPORT_C

void

xmlSecKeyStoreDestroy(xmlSecKeyStorePtr store) {

    xmlSecAssert(xmlSecKeyStoreIsValid(store));    

    xmlSecAssert(store->id->objSize > 0);

    if(store->id->finalize != NULL) {  

        (store->id->finalize)(store);

    }

    memset(store, 0, store->id->objSize);

    xmlFree(store);

}

/**

 * xmlSecKeyStoreFindKey:

 * @store:		the pointer to keys store.

 * @name:		the desired key name.

 * @keyInfoCtx:		the pointer to <dsig:KeyInfo/> node processing context.

 *

 * Lookups key in the store. The caller is responsible for destroying 

 * the returned key using #xmlSecKeyDestroy method.

 *

 * Returns the pointer to a key or NULL if key is not found or an error occurs.

 */

EXPORT_C

xmlSecKeyPtr

xmlSecKeyStoreFindKey(xmlSecKeyStorePtr store, const xmlChar* name, xmlSecKeyInfoCtxPtr keyInfoCtx) {

    xmlSecAssert2(xmlSecKeyStoreIsValid(store), NULL);    

    xmlSecAssert2(store->id->findKey != NULL, NULL);

    xmlSecAssert2(keyInfoCtx != NULL, NULL);

    return(store->id->findKey(store, name, keyInfoCtx));

}

/****************************************************************************

 *

 * Simple Keys Store

 * 

 * keys list (xmlSecPtrList) is located after xmlSecKeyStore

 *

 ***************************************************************************/

#define xmlSecSimpleKeysStoreSize \

	(sizeof(xmlSecKeyStore) + sizeof(xmlSecPtrList))

#define xmlSecSimpleKeysStoreGetList(store) \

    ((xmlSecKeyStoreCheckSize((store), xmlSecSimpleKeysStoreSize)) ? \

	(xmlSecPtrListPtr)(((xmlSecByte*)(store)) + sizeof(xmlSecKeyStore)) : \

	(xmlSecPtrListPtr)NULL)

static int			xmlSecSimpleKeysStoreInitialize	(xmlSecKeyStorePtr store);

static void			xmlSecSimpleKeysStoreFinalize	(xmlSecKeyStorePtr store);

static xmlSecKeyPtr 		xmlSecSimpleKeysStoreFindKey	(xmlSecKeyStorePtr store, 

								 const xmlChar* name, 

								 xmlSecKeyInfoCtxPtr keyInfoCtx);

static xmlSecKeyStoreKlass xmlSecSimpleKeysStoreKlass = {

    sizeof(xmlSecKeyStoreKlass),

    xmlSecSimpleKeysStoreSize,

    /* data */

    BAD_CAST "simple-keys-store",		/* const xmlChar* name; */ 

    /* constructors/destructor */

    xmlSecSimpleKeysStoreInitialize,		/* xmlSecKeyStoreInitializeMethod initialize; */

    xmlSecSimpleKeysStoreFinalize,		/* xmlSecKeyStoreFinalizeMethod finalize; */

    xmlSecSimpleKeysStoreFindKey,		/* xmlSecKeyStoreFindKeyMethod findKey; */

    /* reserved for the future */

    NULL,					/* void* reserved0; */

    NULL,					/* void* reserved1; */

};

/**

 * xmlSecSimpleKeysStoreGetKlass:

 * 

 * The simple list based keys store klass.

 *

 * Returns simple list based keys store klass.

 */

EXPORT_C

xmlSecKeyStoreId 

xmlSecSimpleKeysStoreGetKlass(void) {

    return(&xmlSecSimpleKeysStoreKlass);

}

/**

 * xmlSecSimpleKeysStoreAdoptKey:

 * @store:		the pointer to simple keys store.

 * @key:		the pointer to key.

 * 

 * Adds @key to the @store. 

 *

 * Returns 0 on success or a negative value if an error occurs.

 */

EXPORT_C

int 

xmlSecSimpleKeysStoreAdoptKey(xmlSecKeyStorePtr store, xmlSecKeyPtr key) {

    xmlSecPtrListPtr list;

    int ret;

    xmlSecAssert2(xmlSecKeyStoreCheckId(store, xmlSecSimpleKeysStoreId), -1);

    xmlSecAssert2(key != NULL, -1);

    list = xmlSecSimpleKeysStoreGetList(store);

    xmlSecAssert2(xmlSecPtrListCheckId(list, xmlSecKeyPtrListId), -1);

    ret = xmlSecPtrListAdd(list, key);

    if(ret < 0) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

		    "xmlSecPtrListAdd",

		    XMLSEC_ERRORS_R_XMLSEC_FAILED,

		    XMLSEC_ERRORS_NO_MESSAGE);

	return(-1);

    }

    return(0);

}

/** 

 * xmlSecSimpleKeysStoreLoad:

 * @store:		the pointer to simple keys store.

 * @uri:		the filename.

 * @keysMngr:		the pointer to associated keys manager. 

 * 

 * Reads keys from an XML file.

 *

 * Returns 0 on success or a negative value if an error occurs.

 */

EXPORT_C

int

xmlSecSimpleKeysStoreLoad(xmlSecKeyStorePtr store, const char *uri, 

			    xmlSecKeysMngrPtr keysMngr) {

    xmlDocPtr doc;

    xmlNodePtr root;

    xmlNodePtr cur;

    xmlSecKeyPtr key;

    xmlSecKeyInfoCtx keyInfoCtx;

    int ret;

    xmlSecAssert2(xmlSecKeyStoreCheckId(store, xmlSecSimpleKeysStoreId), -1);

    xmlSecAssert2(uri != NULL, -1);    

    doc = xmlParseFile(uri);

    if(doc == NULL) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

		    "xmlParseFile",

		    XMLSEC_ERRORS_R_XML_FAILED,

		    "uri=%s", 

		    xmlSecErrorsSafeString(uri));

	return(-1);

    }

    root = xmlDocGetRootElement(doc);

    if(!xmlSecCheckNodeName(root, BAD_CAST "Keys", xmlSecNs)) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

		    xmlSecErrorsSafeString(xmlSecNodeGetName(root)),

		    XMLSEC_ERRORS_R_INVALID_NODE,

		    "expected-node=<xmlsec:Keys>");

	xmlFreeDoc(doc);

	return(-1);

    }

    cur = xmlSecGetNextElementNode(root->children);

    while((cur != NULL) && xmlSecCheckNodeName(cur, xmlSecNodeKeyInfo, xmlSecDSigNs)) {  

	key = xmlSecKeyCreate();

	if(key == NULL) {

	    xmlSecError(XMLSEC_ERRORS_HERE,

			xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

			xmlSecErrorsSafeString(xmlSecNodeGetName(cur)),

			XMLSEC_ERRORS_R_INVALID_NODE,

			"expected-node=%s",

			xmlSecErrorsSafeString(xmlSecNodeKeyInfo));

	    xmlFreeDoc(doc);

	    return(-1);

	}

	ret = xmlSecKeyInfoCtxInitialize(&keyInfoCtx, NULL);

	if(ret < 0) {

	    xmlSecError(XMLSEC_ERRORS_HERE,

		        xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

			"xmlSecKeyInfoCtxInitialize",

			XMLSEC_ERRORS_R_XMLSEC_FAILED,

			XMLSEC_ERRORS_NO_MESSAGE);

	    xmlSecKeyDestroy(key);

	    xmlFreeDoc(doc);

	    return(-1);

	}

	keyInfoCtx.mode 	  = xmlSecKeyInfoModeRead;

	keyInfoCtx.keysMngr	  = keysMngr;

	keyInfoCtx.flags 	  = XMLSEC_KEYINFO_FLAGS_DONT_STOP_ON_KEY_FOUND |

				    XMLSEC_KEYINFO_FLAGS_X509DATA_DONT_VERIFY_CERTS;

        keyInfoCtx.keyReq.keyId	  = xmlSecKeyDataIdUnknown;

	keyInfoCtx.keyReq.keyType = xmlSecKeyDataTypeAny;

	keyInfoCtx.keyReq.keyUsage= xmlSecKeyDataUsageAny;

	ret = xmlSecKeyInfoNodeRead(cur, key, &keyInfoCtx);

	if(ret < 0) {

	    xmlSecError(XMLSEC_ERRORS_HERE,

			xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

			"xmlSecKeyInfoNodeRead",

			XMLSEC_ERRORS_R_XMLSEC_FAILED,

			XMLSEC_ERRORS_NO_MESSAGE);

	    xmlSecKeyInfoCtxFinalize(&keyInfoCtx);

	    xmlSecKeyDestroy(key);

	    xmlFreeDoc(doc);

	    return(-1);

	}

	xmlSecKeyInfoCtxFinalize(&keyInfoCtx);

	if(xmlSecKeyIsValid(key)) {

    	    ret = xmlSecSimpleKeysStoreAdoptKey(store, key);

	    if(ret < 0) {

		xmlSecError(XMLSEC_ERRORS_HERE,

			    xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

			    "xmlSecSimpleKeysStoreAdoptKey",

			    XMLSEC_ERRORS_R_XMLSEC_FAILED,

			    XMLSEC_ERRORS_NO_MESSAGE);

		xmlSecKeyDestroy(key);

		xmlFreeDoc(doc);

		return(-1);

	    }

	} else {

	    /* we have an unknown key in our file, just ignore it */

	    xmlSecKeyDestroy(key);

	}

        cur = xmlSecGetNextElementNode(cur->next);

    }

    if(cur != NULL) {

	xmlSecError(XMLSEC_ERRORS_HERE,

		    xmlSecErrorsSafeString(xmlSecKeyStoreGetName(store)),

		    xmlSecErrorsSafeString(xmlSecNodeGetName(cur)),

		    XMLSEC_ERRORS_R_UNEXPECTED_NODE,

		    XMLSEC_ERRORS_NO_MESSAGE);

	xmlFreeDoc(doc);

	return(-1);	    

    }