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