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