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.
20 * XMLObjects representing XML Digital Signature, version 20020212, KeyInfo element
21 * and related content.
24 #ifndef __xmltooling_keyinfo_h__
25 #define __xmltooling_keyinfo_h__
27 #include <xmltooling/ElementProxy.h>
28 #include <xmltooling/exceptions.h>
29 #include <xmltooling/XMLObjectBuilder.h>
30 #include <xmltooling/util/XMLConstants.h>
31 #include <xmltooling/validation/ValidatingXMLObject.h>
35 #define DECL_XMLSIGOBJECTBUILDER(cname) \
36 DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmltooling::XMLConstants::XMLSIG_NS,xmltooling::XMLConstants::XMLSIG_PREFIX)
38 namespace xmlsignature {
40 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,KeyName,Name,XML Digital Signature version 20020212 KeyName element);
41 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,MgmtData,Data,XML Digital Signature version 20020212 MgmtData element);
42 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Modulus,Value,XML Digital Signature version 20020212 Modulus element);
43 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Exponent,Value,XML Digital Signature version 20020212 Exponent element);
44 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Seed,Value,XML Digital Signature version 20020212 Seed element);
45 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PgenCounter,Value,XML Digital Signature version 20020212 PgenCounter element);
46 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,P,Value,XML Digital Signature version 20020212 P element);
47 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Q,Value,XML Digital Signature version 20020212 Q element);
48 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,G,Value,XML Digital Signature version 20020212 G element);
49 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Y,Value,XML Digital Signature version 20020212 Y element);
50 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,J,Value,XML Digital Signature version 20020212 J element);
51 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,XPath,Expression,XML Digital Signature version 20020212 XPath element);
52 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509IssuerName,Name,XML Digital Signature version 20020212 X509IssuerName element);
53 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SerialNumber,SerialNumber,XML Digital Signature version 20020212 X509SerialNumber element);
54 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SKI,Value,XML Digital Signature version 20020212 X509SKI element);
55 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SubjectName,Name,XML Digital Signature version 20020212 X509SubjectName element);
56 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509Certificate,Value,XML Digital Signature version 20020212 X509Certificate element);
57 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509CRL,Value,XML Digital Signature version 20020212 X509CRL element);
58 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,SPKISexp,Value,XML Digital Signature version 20020212 SPKISexp element);
59 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyID,ID,XML Digital Signature version 20020212 PGPKeyID element);
60 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyPacket,Packet,XML Digital Signature version 20020212 PGPKeyPacket element);
62 BEGIN_XMLOBJECT(XMLTOOL_API,DSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 DSAKeyValue element);
63 DECL_XMLOBJECT_CHILD(P);
64 DECL_XMLOBJECT_CHILD(Q);
65 DECL_XMLOBJECT_CHILD(G);
66 DECL_XMLOBJECT_CHILD(Y);
67 DECL_XMLOBJECT_CHILD(J);
68 DECL_XMLOBJECT_CHILD(Seed);
69 DECL_XMLOBJECT_CHILD(PgenCounter);
70 /** DSAKeyValueType local name */
71 static const XMLCh TYPE_NAME[];
74 BEGIN_XMLOBJECT(XMLTOOL_API,RSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 RSAKeyValue element);
75 DECL_XMLOBJECT_CHILD(Modulus);
76 DECL_XMLOBJECT_CHILD(Exponent);
77 /** RSAKeyValueType local name */
78 static const XMLCh TYPE_NAME[];
81 BEGIN_XMLOBJECT(XMLTOOL_API,KeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 KeyValue element);
82 DECL_XMLOBJECT_CHILD(DSAKeyValue);
83 DECL_XMLOBJECT_CHILD(RSAKeyValue);
84 DECL_XMLOBJECT_CHILD(XMLObject);
85 DECL_XMLOBJECT_CONTENT(TextContent);
86 /** KeyValueType local name */
87 static const XMLCh TYPE_NAME[];
90 BEGIN_XMLOBJECT(XMLTOOL_API,Transform,xmltooling::ElementProxy,XML Digital Signature version 20020212 Transform element);
91 DECL_XMLOBJECT_ATTRIB(Algorithm,ALGORITHM);
92 DECL_XMLOBJECT_CHILDREN(XPath);
93 /** TransformType local name */
94 static const XMLCh TYPE_NAME[];
97 BEGIN_XMLOBJECT(XMLTOOL_API,Transforms,xmltooling::XMLObject,XML Digital Signature version 20020212 Transforms element);
98 DECL_XMLOBJECT_CHILDREN(Transform);
99 /** TransformsType local name */
100 static const XMLCh TYPE_NAME[];
103 BEGIN_XMLOBJECT(XMLTOOL_API,RetrievalMethod,xmltooling::XMLObject,XML Digital Signature version 20020212 RetrievalMethod element);
104 DECL_XMLOBJECT_ATTRIB(URI,URI);
105 DECL_XMLOBJECT_ATTRIB(Type,TYPE);
106 DECL_XMLOBJECT_CHILD(Transforms);
107 /** RetrievalMethodType local name */
108 static const XMLCh TYPE_NAME[];
111 BEGIN_XMLOBJECT(XMLTOOL_API,X509IssuerSerial,xmltooling::XMLObject,XML Digital Signature version 20020212 X509IssuerSerial element);
112 DECL_XMLOBJECT_CHILD(X509IssuerName);
113 DECL_XMLOBJECT_CHILD(X509SerialNumber);
114 /** X509IssuerSerialType local name */
115 static const XMLCh TYPE_NAME[];
118 BEGIN_XMLOBJECT(XMLTOOL_API,X509Data,xmltooling::XMLObject,XML Digital Signature version 20020212 X509Data element);
119 DECL_XMLOBJECT_CHILDREN(X509IssuerSerial);
120 DECL_XMLOBJECT_CHILDREN(X509SKI);
121 DECL_XMLOBJECT_CHILDREN(X509SubjectName);
122 DECL_XMLOBJECT_CHILDREN(X509Certificate);
123 DECL_XMLOBJECT_CHILDREN(X509CRL);
124 DECL_XMLOBJECT_CHILDREN(XMLObject);
125 /** X509DataType local name */
126 static const XMLCh TYPE_NAME[];
129 BEGIN_XMLOBJECT(XMLTOOL_API,SPKIData,xmltooling::XMLObject,XML Digital Signature version 20020212 SPKIData element);
130 /** SPKIDataType local name */
131 static const XMLCh TYPE_NAME[];
133 /** Returns modifiable collection of SPKIsexp/XMLObject pairs. */
134 virtual VectorOfPairs(SPKISexp,xmltooling::XMLObject) getSPKISexps()=0;
136 /** Returns reference to immutable collection of SPKIsexp/XMLObject pairs. */
137 virtual const std::vector< std::pair<SPKISexp*,xmltooling::XMLObject*> >& getSPKISexps() const=0;
140 BEGIN_XMLOBJECT(XMLTOOL_API,PGPData,xmltooling::XMLObject,XML Digital Signature version 20020212 PGPData element);
141 DECL_XMLOBJECT_CHILD(PGPKeyID);
142 DECL_XMLOBJECT_CHILD(PGPKeyPacket);
143 DECL_XMLOBJECT_CHILDREN(XMLObject);
144 /** PGPDataType local name */
145 static const XMLCh TYPE_NAME[];
148 BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfo,xmltooling::ElementProxy,XML Digital Signature version 20020212 KeyInfo element);
149 DECL_XMLOBJECT_ATTRIB(Id,ID);
150 DECL_XMLOBJECT_CHILDREN(X509Data);
151 DECL_XMLOBJECT_CHILDREN(KeyName);
152 DECL_XMLOBJECT_CHILDREN(KeyValue);
153 DECL_XMLOBJECT_CHILDREN(RetrievalMethod);
154 DECL_XMLOBJECT_CHILDREN(MgmtData);
155 DECL_XMLOBJECT_CHILDREN(PGPData);
156 DECL_XMLOBJECT_CHILDREN(SPKIData);
157 /** KeyInfoType local name */
158 static const XMLCh TYPE_NAME[];
161 DECL_XMLSIGOBJECTBUILDER(PGPData);
162 DECL_XMLSIGOBJECTBUILDER(PGPKeyID);
163 DECL_XMLSIGOBJECTBUILDER(PGPKeyPacket);
164 DECL_XMLSIGOBJECTBUILDER(SPKIData);
165 DECL_XMLSIGOBJECTBUILDER(SPKISexp);
166 DECL_XMLSIGOBJECTBUILDER(X509IssuerSerial);
167 DECL_XMLSIGOBJECTBUILDER(X509IssuerName);
168 DECL_XMLSIGOBJECTBUILDER(X509SerialNumber);
169 DECL_XMLSIGOBJECTBUILDER(X509SKI);
170 DECL_XMLSIGOBJECTBUILDER(X509SubjectName);
171 DECL_XMLSIGOBJECTBUILDER(X509Certificate);
172 DECL_XMLSIGOBJECTBUILDER(X509CRL);
173 DECL_XMLSIGOBJECTBUILDER(X509Data);
174 DECL_XMLSIGOBJECTBUILDER(XPath);
175 DECL_XMLSIGOBJECTBUILDER(Transform);
176 DECL_XMLSIGOBJECTBUILDER(Transforms);
177 DECL_XMLSIGOBJECTBUILDER(RetrievalMethod);
178 DECL_XMLSIGOBJECTBUILDER(KeyName);
179 DECL_XMLSIGOBJECTBUILDER(MgmtData);
180 DECL_XMLSIGOBJECTBUILDER(Modulus);
181 DECL_XMLSIGOBJECTBUILDER(Exponent);
182 DECL_XMLSIGOBJECTBUILDER(Seed);
183 DECL_XMLSIGOBJECTBUILDER(PgenCounter);
184 DECL_XMLSIGOBJECTBUILDER(P);
185 DECL_XMLSIGOBJECTBUILDER(Q);
186 DECL_XMLSIGOBJECTBUILDER(G);
187 DECL_XMLSIGOBJECTBUILDER(Y);
188 DECL_XMLSIGOBJECTBUILDER(J);
189 DECL_XMLSIGOBJECTBUILDER(DSAKeyValue);
190 DECL_XMLSIGOBJECTBUILDER(RSAKeyValue);
191 DECL_XMLSIGOBJECTBUILDER(KeyValue);
192 DECL_XMLSIGOBJECTBUILDER(KeyInfo);
194 #ifdef XMLTOOLING_DECLARE_VALIDATORS
195 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,KeyName,Name);
196 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,MgmtData,Data);
197 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Modulus,Value);
198 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Exponent,Value);
199 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Seed,Value);
200 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PgenCounter,Value);
201 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,P,Value);
202 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Q,Value);
203 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,G,Value);
204 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Y,Value);
205 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,J,Value);
206 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,XPath,Expression);
207 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509IssuerName,Name);
208 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SerialNumber,SerialNumber);
209 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SKI,Value);
210 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SubjectName,Name);
211 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509Certificate,Value);
212 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509CRL,Value);
213 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,SPKISexp,Value);
214 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyID,ID);
215 XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyPacket,Packet);
217 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RSAKeyValue);
218 XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Modulus);
219 XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Exponent);
220 END_XMLOBJECTVALIDATOR;
222 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,DSAKeyValue);
223 XMLOBJECTVALIDATOR_REQUIRE(DSAKeyValue,Y);
224 XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,P,Q);
225 XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,Seed,PgenCounter);
226 END_XMLOBJECTVALIDATOR;
228 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyValue);
229 XMLOBJECTVALIDATOR_ONEOF3(KeyValue,DSAKeyValue,RSAKeyValue,XMLObject);
230 END_XMLOBJECTVALIDATOR;
232 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transform);
233 XMLOBJECTVALIDATOR_REQUIRE(Transform,Algorithm);
234 END_XMLOBJECTVALIDATOR;
236 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transforms);
237 XMLOBJECTVALIDATOR_NONEMPTY(Transforms,Transform);
238 END_XMLOBJECTVALIDATOR;
240 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RetrievalMethod);
241 XMLOBJECTVALIDATOR_REQUIRE(RetrievalMethod,URI);
242 END_XMLOBJECTVALIDATOR;
244 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509IssuerSerial);
245 XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509IssuerName);
246 XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509SerialNumber);
247 END_XMLOBJECTVALIDATOR;
249 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509Data);
250 if (!ptr->hasChildren())
251 throw xmltooling::ValidationException("X509Data must have at least one child element.");
252 END_XMLOBJECTVALIDATOR;
254 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,SPKIData);
255 XMLOBJECTVALIDATOR_NONEMPTY(SPKIData,SPKISexp);
256 END_XMLOBJECTVALIDATOR;
258 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,PGPData);
259 XMLOBJECTVALIDATOR_ONEOF(PGPData,PGPKeyID,PGPKeyPacket);
260 END_XMLOBJECTVALIDATOR;
262 BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyInfo);
263 XMLOBJECTVALIDATOR_NONEMPTY(KeyInfo,XMLObject);
264 END_XMLOBJECTVALIDATOR;
265 #endif /* XMLTOOLING_DECLARE_VALIDATORS */
269 #endif /* __xmltooling_keyinfo_h__ */