lib3mf/Source/Model/Reader/NMR_KeyStoreOpcPackageReader.cpp

/*++

Copyright (C) 2019 3MF Consortium

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Abstract:

NMR_KeyStoreOpcPackageReader.cpp defines an OPC Package reader in a portable way.

--*/

#include "Model/Reader/NMR_KeyStoreOpcPackageReader.h"

#include "Common/NMR_Types.h"
#include "Common/NMR_Local.h"
#include "Common/NMR_SecureContentTypes.h"
#include "Common/NMR_SecureContext.h"
#include "Common/Platform/NMR_Platform.h"
#include "Common/Platform/NMR_ImportStream.h"
#include "Common/Platform/NMR_ImportStream_Compressed.h"
#include "Common/Platform/NMR_ImportStream_Encrypted.h"
#include "Common/OPC/NMR_OpcPackageReader.h"
#include "Common/OPC/NMR_OpcPackagePart.h"
#include "Model/Classes/NMR_ModelContext.h"
#include "Model/Classes/NMR_KeyStoreFactory.h"
#include "Model/Classes/NMR_ModelConstants.h"
#include "Model/Classes/NMR_KeyStore.h"
#include "Model/Classes/NMR_KeyStoreResourceData.h"
#include "Model/Classes/NMR_KeyStoreResourceDataGroup.h"
#include "Model/Reader/NMR_ModelReader_InstructionElement.h"
#include "Model/Reader/SecureContent101/NMR_ModelReaderNode_KeyStore.h"
#include <cstring>

namespace NMR {
	CKeyStoreOpcPackageReader::CKeyStoreOpcPackageReader(PImportStream pImportStream, CModelContext const & context)
		:m_pContext(context)
	{
		if (!context.isComplete())
			throw CNMRException(NMR_ERROR_INVALIDPOINTER);
		m_pPackageReader = std::make_shared<COpcPackageReader>(pImportStream, context.warnings(), context.monitor());

		PImportStream keyStoreStream = findKeyStoreStream();
		if (nullptr != keyStoreStream) {
			parseKeyStore(keyStoreStream);

			if (!context.keyStore()->empty()) {
				openAllResourceDataGroups();
			}
		}
	}

	COpcPackageRelationship * CKeyStoreOpcPackageReader::findRootRelation(std::string sRelationType, nfBool bMustBeUnique) {
		return m_pPackageReader->findRootRelation(sRelationType, bMustBeUnique);
	}

	POpcPackagePart CKeyStoreOpcPackageReader::createPart(std::string sPath) {
		auto pPart = m_pPackageReader->createPart(sPath);
		auto keyStore = m_pContext.keyStore();
		auto secureContext = m_pContext.secureContext();
		if (secureContext->hasDekCtx()) {
			NMR::PKeyStoreResourceDataGroup rdg = keyStore->findResourceDataGroupByResourceDataPath(sPath);
			if (nullptr != rdg) {
				auto pIt = m_encryptedParts.find(pPart->getURI());
				if (pIt != m_encryptedParts.end()) {
					return pIt->second;
				}
				NMR::PKeyStoreResourceData rd = keyStore->findResourceData(sPath);
				PKeyStoreContentEncryptionParams params = CKeyStoreFactory::makeContentEncryptionParams(rd, rdg);

				ContentEncryptionDescriptor p = secureContext->getDekCtx();
				p.m_sDekDecryptData.m_sParams = params;

				PImportStream stream;
				PImportStream decryptStream = std::make_shared<CImportStream_Encrypted>(pPart->getImportStream(), p);
				if (params->isCompressed()) {
					PImportStream decompressStream = std::make_shared<CImportStream_Compressed>(decryptStream);
					stream = decompressStream;
				}
				else {
					stream = decryptStream;
				}
				auto encryptedPart = std::make_shared<COpcPackagePart>(*pPart, stream);
				m_encryptedParts[pPart->getURI()] = encryptedPart;
				return encryptedPart;
			}
		}
		return pPart;
	}

	nfUint64 CKeyStoreOpcPackageReader::getPartSize(std::string sPath) {
		return m_pPackageReader->getPartSize(sPath);
	}

	void CKeyStoreOpcPackageReader::close() {
		checkAuthenticatedTags();
	}

	NMR::PImportStream CKeyStoreOpcPackageReader::findKeyStoreStream() {
		COpcPackageRelationship * pKeyStoreRelation = m_pPackageReader->findRootRelation(PACKAGE_KEYSTORE_RELATIONSHIP_TYPE, true);
		if (pKeyStoreRelation != nullptr) {
			std::string sTargetPartURI = pKeyStoreRelation->getTargetPartURI();
			POpcPackagePart pKeystorePart = m_pPackageReader->createPart(sTargetPartURI);
			if (pKeystorePart == nullptr)
				throw CNMRException(NMR_ERROR_KEYSTOREOPCCOULDNOTGETSTREAM);
			return pKeystorePart->getImportStream();
		}
		return nullptr;
	}

	void CKeyStoreOpcPackageReader::parseKeyStore(NMR::PImportStream keyStoreStream) {

		PXmlReader pXMLReader = fnCreateXMLReaderInstance(keyStoreStream, m_pContext.monitor());
		nfBool bHasModel = false;
		eXmlReaderNodeType NodeType;
		// Read all XML Root Nodes
		while (!pXMLReader->IsEOF()) {
			if (!pXMLReader->Read(NodeType))
				break;

			// Get Node Name
			LPCSTR pszLocalName = nullptr;
			pXMLReader->GetLocalName(&pszLocalName, nullptr);
			if (!pszLocalName)
				throw CNMRException(NMR_ERROR_COULDNOTGETLOCALXMLNAME);

			if (strcmp(pszLocalName, XML_3MF_ATTRIBUTE_PREFIX_XML) == 0) {
				PModelReader_InstructionElement pXMLNode = std::make_shared<CModelReader_InstructionElement>(m_pContext.warnings());
				pXMLNode->parseXML(pXMLReader.get());
			}

			// Compare with Keystore Node Name
			if (strcmp(pszLocalName, XML_3MF_ELEMENT_KEYSTORE) == 0) {
				if (bHasModel)
					throw CNMRException(NMR_ERROR_DUPLICATEMODELNODE);
				bHasModel = true;

				PModelReaderNode_KeyStore pXMLNode = std::make_shared<CModelReaderNode_KeyStore>(m_pContext.model().get(), m_pContext.keyStore().get(), m_pContext.warnings());
				pXMLNode->parseXML(pXMLReader.get());
			}
		}
	}

	void CKeyStoreOpcPackageReader::openAllResourceDataGroups() {
		auto keyStore = m_pContext.keyStore();
		auto secureContext = m_pContext.secureContext();

		for (nfUint64 i = 0; i < keyStore->getResourceDataGroupCount() && !secureContext->emptyKekCtx(); ++i) {
			PKeyStoreResourceDataGroup rdg = keyStore->getResourceDataGroup(i);
			for (auto it = secureContext->kekCtxBegin(); it != secureContext->kekCtxEnd(); ++it) {
				PKeyStoreConsumer consumer = keyStore->findConsumerById((*it).first);
				if (consumer) {
					PKeyStoreAccessRight accessRight = rdg->findAccessRightByConsumerID(consumer->getConsumerID());
					if (accessRight) {
						KeyWrappingDescriptor ctx = (*it).second;
						ctx.m_sKekDecryptData.m_pAccessRight = accessRight;
						std::vector<nfByte> const & closedKey = accessRight->getCipherValue();
						std::vector<nfByte> openedKey;
						size_t decrypted = ctx.m_fnWrap(closedKey, openedKey, ctx.m_sKekDecryptData);
						if (decrypted) {
							rdg->setKey(openedKey);
							break;
						}
					}
				}
			}
		}
	}
	void CKeyStoreOpcPackageReader::checkAuthenticatedTags() {
		auto secureContext = m_pContext.secureContext();
		auto keyStore = m_pContext.keyStore();
		if (secureContext->hasDekCtx()) {
			for (nfUint64 i = 0; i < m_pContext.keyStore()->getResourceDataCount(); ++i) {
				NMR::PKeyStoreResourceData rd = keyStore->getResourceData(i);
				NMR::PKeyStoreResourceDataGroup rdg = keyStore->findResourceDataGroupByResourceDataPath(rd->packagePath());
				PKeyStoreContentEncryptionParams params = CKeyStoreFactory::makeContentEncryptionParams(rd, rdg);
				ContentEncryptionDescriptor descriptor = secureContext->getDekCtx();
				descriptor.m_sDekDecryptData.m_sParams= params;
				descriptor.m_fnCrypt(0, nullptr, nullptr, descriptor.m_sDekDecryptData);
			}
		}
	}
}