FBReaderJ/jni/NativeFormats/fbreader/src/formats/oeb/OEBEncryptionReader.cpp

/*
 * Copyright (C) 2004-2015 FBReader.ORG Limited <contact@fbreader.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#include <algorithm>

#include <ZLDir.h>
#include <ZLXMLNamespace.h>
#include <ZLXMLReader.h>
#include <FileEncryptionInfo.h>

#include "../FormatPlugin.h"
#include "OEBEncryptionReader.h"
#include "OEBSimpleIdReader.h"

class EpubRightsFileReader : public ZLXMLReader {

public:
	EpubRightsFileReader();
	std::string method() const;

private:
	void startElementHandler(const char *tag, const char **attributes);
	bool processNamespaces() const;

private:
	std::string myMethod;
};

class EpubEncryptionFileReader : public ZLXMLReader {

public:
	EpubEncryptionFileReader(const ZLFile &opfFile);
	void addKnownMethod(const std::string &method);
	const std::vector<shared_ptr<FileEncryptionInfo> > &infos() const;

private:
	void startElementHandler(const char *tag, const char **attributes);
	void endElementHandler(const char *tag);
	void characterDataHandler(const char *text, std::size_t len);
	bool processNamespaces() const;

	std::string publicationId();

private:
	enum State {
		READ_SUCCESS,
		READ_NONE,
		READ_ENCRYPTION,
		READ_ENCRYPTED_DATA,
		READ_KEY_INFO,
		READ_KEY_NAME,
		READ_CIPHER_DATA
	};

private:
	const ZLFile &myOpfFile;
	std::string myPublicationId;
	bool myPublicationIdFlag;
	std::vector<std::string> myKnownMethods;
	std::vector<shared_ptr<FileEncryptionInfo> > myInfos;

	State myState;
	std::string myAlgorithm;
	std::string myKeyName;
	std::string myUri;
};

static const std::string EMBEDDING_ALGORITHM = "http://www.idpf.org/2008/embedding";

std::vector<shared_ptr<FileEncryptionInfo> > OEBEncryptionReader::readEncryptionInfos(const ZLFile &epubFile, const ZLFile &opfFile) {
	shared_ptr<ZLDir> epubDir = epubFile.directory();
	if (epubDir.isNull()) {
		return std::vector<shared_ptr<FileEncryptionInfo> >();
	}

	const ZLFile rightsFile(epubDir->itemPath("META-INF/rights.xml"));
	const ZLFile encryptionFile(epubDir->itemPath("META-INF/encryption.xml"));

	if (!encryptionFile.exists()) {
		return std::vector<shared_ptr<FileEncryptionInfo> >();
	}

	EpubEncryptionFileReader reader = EpubEncryptionFileReader(opfFile);

	if (rightsFile.exists()) {
		EpubRightsFileReader rightsReader;
		rightsReader.readDocument(rightsFile);
		reader.addKnownMethod(rightsReader.method());
	}

	reader.readDocument(encryptionFile);
	return reader.infos();
}

EpubRightsFileReader::EpubRightsFileReader() : myMethod(EncryptionMethod::UNSUPPORTED) {
}

std::string EpubRightsFileReader::method() const {
	return myMethod;
}

void EpubRightsFileReader::startElementHandler(const char *tag, const char **attributes) {
	if (testTag(ZLXMLNamespace::MarlinEpub, "Marlin", tag)) {
		myMethod = EncryptionMethod::MARLIN;
	}
	interrupt();
}

bool EpubRightsFileReader::processNamespaces() const {
	return true;
}

EpubEncryptionFileReader::EpubEncryptionFileReader(const ZLFile &opfFile) : myOpfFile(opfFile), myPublicationIdFlag(false), myState(READ_NONE) {
}

void EpubEncryptionFileReader::addKnownMethod(const std::string &method) {
	myKnownMethods.push_back(method);
}

const std::vector<shared_ptr<FileEncryptionInfo> > &EpubEncryptionFileReader::infos() const {
	return myInfos;
}

void EpubEncryptionFileReader::startElementHandler(const char *tag, const char **attributes) {
	switch (myState) {
		case READ_SUCCESS:
			break;
		case READ_NONE:
			if (testTag(ZLXMLNamespace::EpubContainer, "encryption", tag)) {
				myState = READ_ENCRYPTION;
			} else {
				interrupt();
			}
			break;
		case READ_ENCRYPTION:
			if (testTag(ZLXMLNamespace::XMLEncryption, "EncryptedData", tag)) {
				myState = READ_ENCRYPTED_DATA;
			} else {
				interrupt();
			}
			break;
		case READ_ENCRYPTED_DATA:
			if (testTag(ZLXMLNamespace::XMLEncryption, "EncryptionMethod", tag)) {
				const char *algorithm = attributeValue(attributes, "Algorithm");
				if (algorithm != 0) {
					myAlgorithm = algorithm;
				} else {
					interrupt();
				}
			} else if (testTag(ZLXMLNamespace::XMLDigitalSignature, "KeyInfo", tag)) {
				myState = READ_KEY_INFO;
			} else if (testTag(ZLXMLNamespace::XMLEncryption, "CipherData", tag)) {
				myState = READ_CIPHER_DATA;
			} else {
				interrupt();
			}
			break;
		case READ_KEY_INFO:
			if (testTag(ZLXMLNamespace::XMLDigitalSignature, "KeyName", tag)) {
				myState = READ_KEY_NAME;
				myKeyName.clear();
			} else {
				interrupt();
			}
			break;
		case READ_KEY_NAME:
			interrupt();
			break;
		case READ_CIPHER_DATA:
			if (testTag(ZLXMLNamespace::XMLEncryption, "CipherReference", tag)) {
				const char *uri = attributeValue(attributes, "URI");
				if (uri != 0) {
					myUri = uri;
				} else {
					interrupt();
				}
			} else {
				interrupt();
			}
			break;
	}
}

void EpubEncryptionFileReader::endElementHandler(const char *tag) {
	switch (myState) {
		case READ_NONE:
		case READ_SUCCESS:
			break;
		case READ_ENCRYPTION:
			if (testTag(ZLXMLNamespace::EpubContainer, "encryption", tag)) {
				myState = READ_SUCCESS;
			}
			break;
		case READ_ENCRYPTED_DATA:
			if (testTag(ZLXMLNamespace::XMLEncryption, "EncryptedData", tag)) {
				if (EMBEDDING_ALGORITHM == myAlgorithm) {
					myInfos.push_back(new FileEncryptionInfo(
						myUri, EncryptionMethod::EMBEDDING, myAlgorithm, publicationId()
					));
				} else {
					std::vector<std::string>::const_iterator it =
						std::find(myKnownMethods.begin(), myKnownMethods.end(), EncryptionMethod::MARLIN);
					if (it != myKnownMethods.end()) {
						myInfos.push_back(new FileEncryptionInfo(
							myUri, EncryptionMethod::MARLIN, myAlgorithm, myKeyName
						));
					}
				}
				myState = READ_ENCRYPTION;
			}
			break;
		case READ_KEY_INFO:
			if (testTag(ZLXMLNamespace::XMLDigitalSignature, "KeyInfo", tag)) {
				myState = READ_ENCRYPTED_DATA;
			}
			break;
		case READ_KEY_NAME:
			if (testTag(ZLXMLNamespace::XMLDigitalSignature, "KeyName", tag)) {
				myState = READ_KEY_INFO;
			}
			break;
		case READ_CIPHER_DATA:
			if (testTag(ZLXMLNamespace::XMLEncryption, "CipherData", tag)) {
				myState = READ_ENCRYPTED_DATA;
			}
			break;
	}
}

void EpubEncryptionFileReader::characterDataHandler(const char *text, std::size_t len) {
	if (myState == READ_KEY_NAME) {
		myKeyName.append(text, len);
	}
}

bool EpubEncryptionFileReader::processNamespaces() const {
	return true;
}

std::string EpubEncryptionFileReader::publicationId() {
	if (!myPublicationIdFlag) {
		myPublicationId = OEBSimpleIdReader().readId(myOpfFile);
		myPublicationIdFlag = true;
	}
	return myPublicationId;
}