xmltooling/encryption/impl/EncryptionSchemaValidators.cpp

   1 /*
   2 *  Copyright 2001-2007 Internet2
   3  *
   4 * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * EncryptionSchemaValidators.cpp
  19  *
  20  * Schema validators for XML Encryption schema
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "encryption/Encryption.h"
  26 #include "validation/ValidatorSuite.h"
  27
  28 using namespace xmlencryption;
  29 using namespace xmltooling;
  30 using namespace std;
  31 using xmlconstants::XMLENC_NS;
  32
  33 namespace xmlencryption {
  34
  35     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,CarriedKeyName);
  36     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,CipherValue);
  37     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,KeySize);
  38     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,OAEPparams);
  39
  40     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,EncryptionMethod);
  41         XMLOBJECTVALIDATOR_REQUIRE(EncryptionMethod,Algorithm);
  42     END_XMLOBJECTVALIDATOR;
  43
  44     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transforms);
  45         XMLOBJECTVALIDATOR_NONEMPTY(Transforms,Transform);
  46     END_XMLOBJECTVALIDATOR;
  47
  48     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,CipherReference);
  49         XMLOBJECTVALIDATOR_REQUIRE(CipherReference,URI);
  50     END_XMLOBJECTVALIDATOR;
  51
  52     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,CipherData);
  53         XMLOBJECTVALIDATOR_ONLYONEOF(CipherData,CipherValue,CipherReference);
  54     END_XMLOBJECTVALIDATOR;
  55
  56     class XMLTOOL_DLLLOCAL checkWildcardNS {
  57     public:
  58         void operator()(const XMLObject* xmlObject) const {
  59             const XMLCh* ns=xmlObject->getElementQName().getNamespaceURI();
  60             if (XMLString::equals(ns,XMLENC_NS) || !ns || !*ns) {
  61                 throw ValidationException(
  62                     "Object contains an illegal extension child element ($1).",
  63                     params(1,xmlObject->getElementQName().toString().c_str())
  64                     );
  65             }
  66         }
  67     };
  68
  69     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,EncryptionProperty);
  70         if (!ptr->hasChildren())
  71             throw ValidationException("EncryptionProperty must have at least one child element.");
  72         const vector<XMLObject*>& anys=ptr->getUnknownXMLObjects();
  73         for_each(anys.begin(),anys.end(),checkWildcardNS());
  74     END_XMLOBJECTVALIDATOR;
  75
  76     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,EncryptionProperties);
  77         XMLOBJECTVALIDATOR_NONEMPTY(EncryptionProperties,EncryptionProperty);
  78     END_XMLOBJECTVALIDATOR;
  79
  80     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,ReferenceType);
  81         XMLOBJECTVALIDATOR_REQUIRE(DataReference,URI);
  82         const vector<XMLObject*>& anys=ptr->getUnknownXMLObjects();
  83         for_each(anys.begin(),anys.end(),checkWildcardNS());
  84     END_XMLOBJECTVALIDATOR;
  85
  86     BEGIN_XMLOBJECTVALIDATOR_SUB(XMLTOOL_DLLLOCAL,DataReference,ReferenceType);
  87         ReferenceTypeSchemaValidator::validate(xmlObject);
  88     END_XMLOBJECTVALIDATOR;
  89
  90     BEGIN_XMLOBJECTVALIDATOR_SUB(XMLTOOL_DLLLOCAL,KeyReference,ReferenceType);
  91         ReferenceTypeSchemaValidator::validate(xmlObject);
  92     END_XMLOBJECTVALIDATOR;
  93
  94     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,ReferenceList);
  95         if (!ptr->hasChildren())
  96             throw ValidationException("ReferenceList must have at least one child element.");
  97     END_XMLOBJECTVALIDATOR;
  98
  99     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,EncryptedType);
 100         XMLOBJECTVALIDATOR_REQUIRE(EncryptedType,CipherData);
 101     END_XMLOBJECTVALIDATOR;
 102
 103     BEGIN_XMLOBJECTVALIDATOR_SUB(XMLTOOL_DLLLOCAL,EncryptedData,EncryptedType);
 104         EncryptedTypeSchemaValidator::validate(xmlObject);
 105     END_XMLOBJECTVALIDATOR;
 106
 107     BEGIN_XMLOBJECTVALIDATOR_SUB(XMLTOOL_DLLLOCAL,EncryptedKey,EncryptedType);
 108         EncryptedTypeSchemaValidator::validate(xmlObject);
 109     END_XMLOBJECTVALIDATOR;
 110
 111 };
 112
 113 #define REGISTER_ELEMENT(namespaceURI,cname) \
 114     q=QName(namespaceURI,cname::LOCAL_NAME); \
 115     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
 116     SchemaValidators.registerValidator(q,new cname##SchemaValidator())
 117
 118 #define REGISTER_TYPE(namespaceURI,cname) \
 119     q=QName(namespaceURI,cname::TYPE_NAME); \
 120     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
 121     SchemaValidators.registerValidator(q,new cname##SchemaValidator())
 122
 123 void xmlencryption::registerEncryptionClasses()
 124 {
 125     QName q;
 126     REGISTER_ELEMENT(XMLENC_NS,CarriedKeyName);
 127     REGISTER_ELEMENT(XMLENC_NS,CipherData);
 128     REGISTER_ELEMENT(XMLENC_NS,CipherReference);
 129     REGISTER_ELEMENT(XMLENC_NS,CipherValue);
 130     REGISTER_ELEMENT(XMLENC_NS,DataReference);
 131     REGISTER_ELEMENT(XMLENC_NS,EncryptedData);
 132     REGISTER_ELEMENT(XMLENC_NS,EncryptedKey);
 133     REGISTER_ELEMENT(XMLENC_NS,EncryptionMethod);
 134     REGISTER_ELEMENT(XMLENC_NS,EncryptionProperties);
 135     REGISTER_ELEMENT(XMLENC_NS,EncryptionProperty);
 136     REGISTER_ELEMENT(XMLENC_NS,KeyReference);
 137     REGISTER_ELEMENT(XMLENC_NS,KeySize);
 138     REGISTER_ELEMENT(XMLENC_NS,OAEPparams);
 139     REGISTER_ELEMENT(XMLENC_NS,ReferenceList);
 140     REGISTER_ELEMENT(XMLENC_NS,Transforms);
 141     REGISTER_TYPE(XMLENC_NS,CipherData);
 142     REGISTER_TYPE(XMLENC_NS,CipherReference);
 143     REGISTER_TYPE(XMLENC_NS,EncryptionMethod);
 144     REGISTER_TYPE(XMLENC_NS,EncryptionProperties);
 145     REGISTER_TYPE(XMLENC_NS,EncryptionProperty);
 146     REGISTER_TYPE(XMLENC_NS,Transforms);
 147 }