blob: 1352f6a87e6ef5109f3d9a71f2070fcfbf487a70 [file] [log] [blame]
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* XSEC
*
* XKMSMessageAbstractTypeImpl := Implementation class for base XKMS messages
*
* $Id$
*
*/
#include <xsec/dsig/DSIGSignature.hpp>
#include <xsec/dsig/DSIGReference.hpp>
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/framework/XSECEnv.hpp>
#include <xsec/framework/XSECError.hpp>
#ifdef XSEC_XKMS_ENABLED
#include "../../utils/XSECDOMUtils.hpp"
#include "XKMSMessageAbstractTypeImpl.hpp"
#include <xsec/xkms/XKMSConstants.hpp>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/util/XMLUniDefs.hpp>
#include <xercesc/util/Janitor.hpp>
XERCES_CPP_NAMESPACE_USE
// --------------------------------------------------------------------------------
// Construct/Destruct
// --------------------------------------------------------------------------------
XKMSMessageAbstractTypeImpl::XKMSMessageAbstractTypeImpl(
const XSECEnv * env) :
mp_env(env),
mp_messageAbstractTypeElement(NULL),
mp_idAttr(NULL),
mp_serviceAttr(NULL),
mp_nonceAttr(NULL),
mp_signatureElement(NULL),
mp_opaqueClientDataElement(NULL),
mp_signature(NULL) {
m_opaqueClientDataSize = 0;
}
XKMSMessageAbstractTypeImpl::XKMSMessageAbstractTypeImpl(
const XSECEnv * env,
XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * node) :
mp_env(env),
mp_messageAbstractTypeElement(node),
mp_idAttr(NULL),
mp_serviceAttr(NULL),
mp_nonceAttr(NULL),
mp_signatureElement(NULL),
mp_opaqueClientDataElement(NULL),
mp_signature(NULL) {
m_opaqueClientDataSize = 0;
}
XKMSMessageAbstractTypeImpl::~XKMSMessageAbstractTypeImpl() {
// We own the environment, so we delete it.
delete mp_env;
}
// --------------------------------------------------------------------------------
// Load
// --------------------------------------------------------------------------------
void XKMSMessageAbstractTypeImpl::load(void) {
if (mp_messageAbstractTypeElement == NULL) {
// Attempt to load an empty element
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::load - called on empty DOM");
}
// Id
mp_idAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagId);
// Service
mp_serviceAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagService);
// Nonce
mp_nonceAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagNonce);
// Id and Service MUST be set for a message to be OK
if (mp_idAttr == NULL) {
throw XSECException(XSECException::ExpectedXKMSChildNotFound,
"XKMSMessageAbstractType::load - Id attribute not found");
}
if (mp_serviceAttr == NULL) {
throw XSECException(XSECException::ExpectedXKMSChildNotFound,
"XKMSMessageAbstractType::load - Service attribute not found");
}
// Check for <Signature> node
mp_signatureElement = (DOMElement *) findFirstChildOfType(mp_messageAbstractTypeElement, DOMNode::ELEMENT_NODE);
while (mp_signatureElement != NULL &&
!strEquals(getDSIGLocalName(mp_signatureElement), XKMSConstants::s_tagSignature)) {
mp_signatureElement = findNextElementChild(mp_signatureElement);
}
// The provider will take care of cleaning this up later.
if (mp_signatureElement != NULL) {
mp_signature = m_prov.newSignatureFromDOM(mp_signatureElement->getOwnerDocument(),
mp_signatureElement);
mp_signature->load();
}
// Cheque for OpaqueClientData
mp_opaqueClientDataElement = (DOMElement *) findFirstChildOfType(mp_messageAbstractTypeElement, DOMNode::ELEMENT_NODE);
while (mp_opaqueClientDataElement != NULL &&
!strEquals(getXKMSLocalName(mp_opaqueClientDataElement), XKMSConstants::s_tagOpaqueClientData)) {
mp_opaqueClientDataElement = findNextElementChild(mp_opaqueClientDataElement);
}
if (mp_opaqueClientDataElement != NULL) {
DOMElement * c = findFirstElementChild(mp_opaqueClientDataElement);
while (c != NULL) {
if (!strEquals(getXKMSLocalName(c), XKMSConstants::s_tagOpaqueData)) {
throw XSECException(XSECException::ExpectedXKMSChildNotFound,
"XKMSMessageAbstractType::load - Only <OpaqueData> children allowed for <OpaqueClientData>");
}
if (findFirstChildOfType(c, DOMNode::TEXT_NODE) == NULL) {
throw XSECException(XSECException::ExpectedXKMSChildNotFound,
"XKMSMessageAbstractType::load - OpaqueData elements require a text child containing Base64 data");
}
++m_opaqueClientDataSize;
c = findNextElementChild(c);
}
}
}
// --------------------------------------------------------------------------------
// Create blank
// --------------------------------------------------------------------------------
DOMElement * XKMSMessageAbstractTypeImpl::createBlankMessageAbstractType(
const XMLCh * tag,
const XMLCh * service,
const XMLCh * id) {
// Get some setup values
safeBuffer str;
DOMDocument *doc = mp_env->getParentDocument();
const XMLCh * prefix = mp_env->getXKMSNSPrefix();
makeQName(str, prefix, tag);
mp_messageAbstractTypeElement = doc->createElementNS(XKMSConstants::s_unicodeStrURIXKMS,
str.rawXMLChBuffer());
// Set namespace
if (prefix[0] == chNull) {
str.sbTranscodeIn("xmlns");
}
else {
str.sbTranscodeIn("xmlns:");
str.sbXMLChCat(prefix);
}
mp_messageAbstractTypeElement->setAttributeNS(DSIGConstants::s_unicodeStrURIXMLNS,
str.rawXMLChBuffer(),
XKMSConstants::s_unicodeStrURIXKMS);
mp_env->doPrettyPrint(mp_messageAbstractTypeElement);
// Setup the service URI
mp_messageAbstractTypeElement->setAttributeNS(NULL,
XKMSConstants::s_tagService,
service);
mp_serviceAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagService);
// Setup the id
XMLCh * myId;
if (id == NULL)
myId = generateId();
mp_messageAbstractTypeElement->setAttributeNS(NULL, XKMSConstants::s_tagId, id ? id : myId);
if (id == NULL)
XSEC_RELEASE_XMLCH(myId);
mp_messageAbstractTypeElement->setIdAttributeNS(NULL, XKMSConstants::s_tagId, true);
mp_idAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagId);
// Nonce is blank at start
mp_nonceAttr = NULL;
return mp_messageAbstractTypeElement;
}
// --------------------------------------------------------------------------------
// Getter interfaces
// --------------------------------------------------------------------------------
bool XKMSMessageAbstractTypeImpl::isSigned(void) const {
return mp_signature != NULL;
}
DSIGSignature * XKMSMessageAbstractTypeImpl::getSignature(void) const {
return mp_signature;
}
DOMElement * XKMSMessageAbstractTypeImpl::getElement(void) const {
return mp_messageAbstractTypeElement;
}
const XMLCh * XKMSMessageAbstractTypeImpl::getId(void) const {
return (mp_idAttr != NULL ? mp_idAttr->getNodeValue() : NULL);
}
const XMLCh * XKMSMessageAbstractTypeImpl::getService(void) const {
return (mp_serviceAttr != NULL ? mp_serviceAttr->getNodeValue() : NULL);
}
const XMLCh * XKMSMessageAbstractTypeImpl::getNonce(void) const {
return (mp_nonceAttr != NULL ? mp_nonceAttr->getNodeValue() : NULL);
}
// --------------------------------------------------------------------------------
// Setter Interfaces
// --------------------------------------------------------------------------------
void XKMSMessageAbstractTypeImpl::setId(const XMLCh * id) {
if (mp_messageAbstractTypeElement == NULL) {
// Attempt update when not initialised
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::setId - called on non-initialised structure");
}
mp_messageAbstractTypeElement->setAttributeNS(NULL, XKMSConstants::s_tagId, id);
mp_messageAbstractTypeElement->setIdAttributeNS(NULL, XKMSConstants::s_tagId, true);
mp_idAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagId);
}
void XKMSMessageAbstractTypeImpl::setService(const XMLCh * service) {
if (mp_messageAbstractTypeElement == NULL) {
// Attempt update when not initialised
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::setService - called on non-initialised structure");
}
mp_messageAbstractTypeElement->setAttributeNS(NULL, XKMSConstants::s_tagService, service);
mp_serviceAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagService);
}
void XKMSMessageAbstractTypeImpl::setNonce(const XMLCh * uri) {
if (mp_messageAbstractTypeElement == NULL) {
// Attempt update when not initialised
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::setNonce - called on non-initialised structure");
}
mp_messageAbstractTypeElement->setAttributeNS(NULL, XKMSConstants::s_tagNonce, uri);
mp_nonceAttr =
mp_messageAbstractTypeElement->getAttributeNodeNS(NULL, XKMSConstants::s_tagNonce);
}
DSIGSignature * XKMSMessageAbstractTypeImpl::addSignature(
const XMLCh* c14nAlgorithm,
const XMLCh* signatureAlgorithm,
const XMLCh* hashAlgorithm) {
DSIGSignature * ret = m_prov.newSignature();
DOMElement * elt = ret->createBlankSignature(mp_env->getParentDocument(), c14nAlgorithm, signatureAlgorithm);
/* Create the enveloping reference */
safeBuffer sb;
sb.sbXMLChIn(DSIGConstants::s_unicodeStrEmpty);
sb.sbXMLChAppendCh(chPound);
sb.sbXMLChCat(getId());
DSIGReference *ref = ret->createReference(sb.rawXMLChBuffer(), hashAlgorithm);
ref->appendEnvelopedSignatureTransform();
ref->appendCanonicalizationTransform(DSIGConstants::s_unicodeStrURIEXC_C14N_COM);
/* Embed the signature in the document */
DOMNode * c = mp_messageAbstractTypeElement->getFirstChild();
if (c != NULL) {
if (mp_env->getPrettyPrintFlag() == true) {
mp_messageAbstractTypeElement->insertBefore(
mp_env->getParentDocument()->createTextNode(DSIGConstants::s_unicodeStrNL),
c);
}
mp_messageAbstractTypeElement->insertBefore(elt, c);
}
else
mp_messageAbstractTypeElement->appendChild(elt);
mp_signature = ret;
return ret;
}
// --------------------------------------------------------------------------------
// Opaque Client Data interface
// --------------------------------------------------------------------------------
int XKMSMessageAbstractTypeImpl::getOpaqueClientDataSize(void) {
return m_opaqueClientDataSize;
}
const XMLCh * XKMSMessageAbstractTypeImpl::getOpaqueClientDataItemStr(int item) {
if (item < 0 || item > m_opaqueClientDataSize) {
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::getOpaqueClientDataItemStr - index out of range");
}
DOMElement * c = findFirstElementChild(mp_opaqueClientDataElement);
int i = 0;
while (i < item) {
c = findNextElementChild(c);
if (c == NULL) {
throw XSECException(XSECException::MessageAbstractTypeError,
"XKMSMessageAbstractType::getOpaqueClientDataItemStr - index unexpectedly out of range");
}
++i;
}
return findFirstChildOfType(c, DOMNode::TEXT_NODE)->getNodeValue();
}
void XKMSMessageAbstractTypeImpl::appendOpaqueClientDataItem(const XMLCh * item) {
safeBuffer str;
DOMDocument *doc = mp_env->getParentDocument();
const XMLCh * prefix = mp_env->getXKMSNSPrefix();
if (mp_opaqueClientDataElement == NULL) {
makeQName(str, prefix, XKMSConstants::s_tagOpaqueClientData);
mp_opaqueClientDataElement = doc->createElementNS(XKMSConstants::s_unicodeStrURIXKMS,
str.rawXMLChBuffer());
mp_env->doPrettyPrint(mp_opaqueClientDataElement);
/* Have to insert before anything else in the message */
DOMElement * te;
te = findFirstElementChild(mp_messageAbstractTypeElement);
while (te != NULL &&
strEquals(getXKMSLocalName(te), XKMSConstants::s_tagSignature))
te = findNextElementChild(te);
if (te == NULL) {
mp_messageAbstractTypeElement->appendChild(mp_opaqueClientDataElement);
mp_env->doPrettyPrint(mp_messageAbstractTypeElement);
}
else {
mp_messageAbstractTypeElement->insertBefore(mp_opaqueClientDataElement, te);
if (mp_env->getPrettyPrintFlag()) {
mp_messageAbstractTypeElement->insertBefore(
mp_env->getParentDocument()->createTextNode(DSIGConstants::s_unicodeStrNL), te);
}
}
}
makeQName(str, prefix, XKMSConstants::s_tagOpaqueData);
DOMElement * e = doc->createElementNS(XKMSConstants::s_unicodeStrURIXKMS,
str.rawXMLChBuffer());
e->appendChild(doc->createTextNode(item));
mp_opaqueClientDataElement->appendChild(e);
mp_env->doPrettyPrint(mp_opaqueClientDataElement);
m_opaqueClientDataSize++;
}
#endif /* XSEC_XKMS_ENABLED */