xmltooling/signature/impl/KeyInfoSchemaValidators.cpp

   1 /*
   2 *  Copyright 2001-2009 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  * KeyInfoSchemaValidators.cpp
  19  *
  20  * Schema validators for KeyInfo schema
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "signature/KeyInfo.h"
  26 #include "validation/Validator.h"
  27 #include "validation/ValidatorSuite.h"
  28
  29 using namespace xmlsignature;
  30 using namespace xmltooling;
  31 using namespace std;
  32 using xmlconstants::XMLSIG_NS;
  33
  34 namespace xmlsignature {
  35
  36     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,KeyName);
  37     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,MgmtData);
  38     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Modulus);
  39     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Exponent);
  40     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Seed);
  41     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PgenCounter);
  42     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,P);
  43     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Q);
  44     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,G);
  45     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Y);
  46     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,J);
  47     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,XPath);
  48     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509IssuerName);
  49     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SerialNumber);
  50     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SKI);
  51     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SubjectName);
  52     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509Certificate);
  53     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509CRL);
  54     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,SPKISexp);
  55     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyID);
  56     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyPacket);
  57
  58     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RSAKeyValue);
  59         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Modulus);
  60         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Exponent);
  61     END_XMLOBJECTVALIDATOR;
  62
  63     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,DSAKeyValue);
  64         XMLOBJECTVALIDATOR_REQUIRE(DSAKeyValue,Y);
  65         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,P,Q);
  66         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,Seed,PgenCounter);
  67     END_XMLOBJECTVALIDATOR;
  68
  69     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyValue);
  70         XMLOBJECTVALIDATOR_ONLYONEOF3(KeyValue,DSAKeyValue,RSAKeyValue,UnknownXMLObject);
  71     END_XMLOBJECTVALIDATOR;
  72
  73     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transform);
  74         XMLOBJECTVALIDATOR_REQUIRE(Transform,Algorithm);
  75     END_XMLOBJECTVALIDATOR;
  76
  77     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transforms);
  78         XMLOBJECTVALIDATOR_NONEMPTY(Transforms,Transform);
  79     END_XMLOBJECTVALIDATOR;
  80
  81     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RetrievalMethod);
  82         XMLOBJECTVALIDATOR_REQUIRE(RetrievalMethod,URI);
  83     END_XMLOBJECTVALIDATOR;
  84
  85     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509IssuerSerial);
  86         XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509IssuerName);
  87         XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509SerialNumber);
  88     END_XMLOBJECTVALIDATOR;
  89
  90     class XMLTOOL_DLLLOCAL checkWildcardNS {
  91     public:
  92         void operator()(const XMLObject* xmlObject) const {
  93             const XMLCh* ns=xmlObject->getElementQName().getNamespaceURI();
  94             if (XMLString::equals(ns,XMLSIG_NS) || !ns || !*ns) {
  95                 throw ValidationException(
  96                     "Object contains an illegal extension child element ($1).",
  97                     params(1,xmlObject->getElementQName().toString().c_str())
  98                     );
  99             }
 100         }
 101     };
 102
 103     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509Data);
 104         if (!ptr->hasChildren())
 105             throw ValidationException("X509Data must have at least one child element.");
 106         const vector<XMLObject*>& anys=ptr->getUnknownXMLObjects();
 107         for_each(anys.begin(),anys.end(),checkWildcardNS());
 108     END_XMLOBJECTVALIDATOR;
 109
 110     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,SPKIData);
 111         XMLOBJECTVALIDATOR_NONEMPTY(SPKIData,SPKISexp);
 112     END_XMLOBJECTVALIDATOR;
 113
 114     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,PGPData);
 115         XMLOBJECTVALIDATOR_ONEOF(PGPData,PGPKeyID,PGPKeyPacket);
 116     END_XMLOBJECTVALIDATOR;
 117
 118     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyInfo);
 119         if (!ptr->hasChildren())
 120             throw ValidationException("KeyInfo must have at least one child element.");
 121         const vector<XMLObject*>& anys=ptr->getUnknownXMLObjects();
 122         for_each(anys.begin(),anys.end(),checkWildcardNS());
 123     END_XMLOBJECTVALIDATOR;
 124
 125 };
 126
 127 #define REGISTER_ELEMENT(namespaceURI,cname) \
 128     q=QName(namespaceURI,cname::LOCAL_NAME); \
 129     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
 130     SchemaValidators.registerValidator(q,new cname##SchemaValidator())
 131
 132 #define REGISTER_TYPE(namespaceURI,cname) \
 133     q=QName(namespaceURI,cname::TYPE_NAME); \
 134     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
 135     SchemaValidators.registerValidator(q,new cname##SchemaValidator())
 136
 137 void xmlsignature::registerKeyInfoClasses()
 138 {
 139     QName q;
 140     REGISTER_ELEMENT(XMLSIG_NS,KeyInfo);
 141     REGISTER_ELEMENT(XMLSIG_NS,KeyName);
 142     REGISTER_ELEMENT(XMLSIG_NS,KeyValue);
 143     REGISTER_ELEMENT(XMLSIG_NS,MgmtData);
 144     REGISTER_ELEMENT(XMLSIG_NS,DSAKeyValue);
 145     REGISTER_ELEMENT(XMLSIG_NS,RSAKeyValue);
 146     REGISTER_ELEMENT(XMLSIG_NS,Exponent);
 147     REGISTER_ELEMENT(XMLSIG_NS,Modulus);
 148     REGISTER_ELEMENT(XMLSIG_NS,P);
 149     REGISTER_ELEMENT(XMLSIG_NS,Q);
 150     REGISTER_ELEMENT(XMLSIG_NS,G);
 151     REGISTER_ELEMENT(XMLSIG_NS,Y);
 152     REGISTER_ELEMENT(XMLSIG_NS,J);
 153     REGISTER_ELEMENT(XMLSIG_NS,Seed);
 154     REGISTER_ELEMENT(XMLSIG_NS,PgenCounter);
 155     REGISTER_ELEMENT(XMLSIG_NS,XPath);
 156     REGISTER_ELEMENT(XMLSIG_NS,Transform);
 157     REGISTER_ELEMENT(XMLSIG_NS,Transforms);
 158     REGISTER_ELEMENT(XMLSIG_NS,RetrievalMethod);
 159     REGISTER_ELEMENT(XMLSIG_NS,X509IssuerSerial);
 160     REGISTER_ELEMENT(XMLSIG_NS,X509IssuerName);
 161     REGISTER_ELEMENT(XMLSIG_NS,X509SerialNumber);
 162     REGISTER_ELEMENT(XMLSIG_NS,X509SKI);
 163     REGISTER_ELEMENT(XMLSIG_NS,X509SubjectName);
 164     REGISTER_ELEMENT(XMLSIG_NS,X509Certificate);
 165     REGISTER_ELEMENT(XMLSIG_NS,X509CRL);
 166     REGISTER_ELEMENT(XMLSIG_NS,X509Data);
 167     REGISTER_ELEMENT(XMLSIG_NS,SPKISexp);
 168     REGISTER_ELEMENT(XMLSIG_NS,SPKIData);
 169     REGISTER_ELEMENT(XMLSIG_NS,PGPKeyID);
 170     REGISTER_ELEMENT(XMLSIG_NS,PGPKeyPacket);
 171     REGISTER_ELEMENT(XMLSIG_NS,PGPData);
 172     REGISTER_TYPE(XMLSIG_NS,KeyInfo);
 173     REGISTER_TYPE(XMLSIG_NS,KeyValue);
 174     REGISTER_TYPE(XMLSIG_NS,DSAKeyValue);
 175     REGISTER_TYPE(XMLSIG_NS,RSAKeyValue);
 176     REGISTER_TYPE(XMLSIG_NS,Transform);
 177     REGISTER_TYPE(XMLSIG_NS,Transforms);
 178     REGISTER_TYPE(XMLSIG_NS,RetrievalMethod);
 179     REGISTER_TYPE(XMLSIG_NS,X509IssuerSerial);
 180     REGISTER_TYPE(XMLSIG_NS,X509Data);
 181     REGISTER_TYPE(XMLSIG_NS,SPKIData);
 182     REGISTER_TYPE(XMLSIG_NS,PGPData);
 183 }