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/SimpleElement.h>
29 #include <xmltooling/XMLObjectBuilder.h>
30 #include <xmltooling/util/XMLConstants.h>
31 #include <xmltooling/validation/ValidatingXMLObject.h>
32 #include <xmltooling/validation/ValidatorSuite.h>
34 #define DECL_XMLSIGOBJECTBUILDER(cname) \
35 DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmltooling::XMLConstants::XMLSIG_NS,xmltooling::XMLConstants::XMLSIG_PREFIX)
37 namespace xmlsignature {
39 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,KeyName,Name,XML Digital Signature version 20020212 KeyName element);
40 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,MgmtData,Data,XML Digital Signature version 20020212 MgmtData element);
41 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Modulus,Value,XML Digital Signature version 20020212 Modulus element);
42 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Exponent,Value,XML Digital Signature version 20020212 Exponent element);
43 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Seed,Value,XML Digital Signature version 20020212 Seed element);
44 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PgenCounter,Value,XML Digital Signature version 20020212 PgenCounter element);
45 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,P,Value,XML Digital Signature version 20020212 P element);
46 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Q,Value,XML Digital Signature version 20020212 Q element);
47 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,G,Value,XML Digital Signature version 20020212 G element);
48 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Y,Value,XML Digital Signature version 20020212 Y element);
49 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,J,Value,XML Digital Signature version 20020212 J element);
50 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,XPath,Expression,XML Digital Signature version 20020212 XPath element);
51 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509IssuerName,Name,XML Digital Signature version 20020212 X509IssuerName element);
52 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SerialNumber,SerialNumber,XML Digital Signature version 20020212 X509SerialNumber element);
53 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SKI,Value,XML Digital Signature version 20020212 X509SKI element);
54 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SubjectName,Name,XML Digital Signature version 20020212 X509SubjectName element);
55 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509Certificate,Value,XML Digital Signature version 20020212 X509Certificate element);
56 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509CRL,Value,XML Digital Signature version 20020212 X509CRL element);
57 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,SPKISexp,Value,XML Digital Signature version 20020212 SPKISexp element);
58 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyID,ID,XML Digital Signature version 20020212 PGPKeyID element);
59 DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyPacket,Packet,XML Digital Signature version 20020212 PGPKeyPacket element);
61 BEGIN_XMLOBJECT(XMLTOOL_API,DSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 DSAKeyValue element);
67 DECL_TYPED_CHILD(Seed);
68 DECL_TYPED_CHILD(PgenCounter);
69 /** DSAKeyValueType local name */
70 static const XMLCh TYPE_NAME[];
73 BEGIN_XMLOBJECT(XMLTOOL_API,RSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 RSAKeyValue element);
74 DECL_TYPED_CHILD(Modulus);
75 DECL_TYPED_CHILD(Exponent);
76 /** RSAKeyValueType local name */
77 static const XMLCh TYPE_NAME[];
80 BEGIN_XMLOBJECT(XMLTOOL_API,KeyValue,xmltooling::SimpleElement,XML Digital Signature version 20020212 KeyValue element);
81 DECL_TYPED_CHILD(DSAKeyValue);
82 DECL_TYPED_CHILD(RSAKeyValue);
83 DECL_XMLOBJECT_CHILD(OtherKeyValue);
84 /** KeyValueType local name */
85 static const XMLCh TYPE_NAME[];
88 BEGIN_XMLOBJECT(XMLTOOL_API,Transform,xmltooling::ElementProxy,XML Digital Signature version 20020212 Transform element);
89 DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
90 DECL_TYPED_CHILDREN(XPath);
91 /** TransformType local name */
92 static const XMLCh TYPE_NAME[];
95 BEGIN_XMLOBJECT(XMLTOOL_API,Transforms,xmltooling::XMLObject,XML Digital Signature version 20020212 Transforms element);
96 DECL_TYPED_CHILDREN(Transform);
97 /** TransformsType local name */
98 static const XMLCh TYPE_NAME[];
101 BEGIN_XMLOBJECT(XMLTOOL_API,RetrievalMethod,xmltooling::XMLObject,XML Digital Signature version 20020212 RetrievalMethod element);
102 DECL_STRING_ATTRIB(URI,URI);
103 DECL_STRING_ATTRIB(Type,TYPE);
104 DECL_TYPED_CHILD(Transforms);
105 /** RetrievalMethodType local name */
106 static const XMLCh TYPE_NAME[];
109 BEGIN_XMLOBJECT(XMLTOOL_API,X509IssuerSerial,xmltooling::XMLObject,XML Digital Signature version 20020212 X509IssuerSerial element);
110 DECL_TYPED_CHILD(X509IssuerName);
111 DECL_TYPED_CHILD(X509SerialNumber);
112 /** X509IssuerSerialType local name */
113 static const XMLCh TYPE_NAME[];
116 BEGIN_XMLOBJECT(XMLTOOL_API,X509Data,xmltooling::XMLObject,XML Digital Signature version 20020212 X509Data element);
117 DECL_TYPED_CHILDREN(X509IssuerSerial);
118 DECL_TYPED_CHILDREN(X509SKI);
119 DECL_TYPED_CHILDREN(X509SubjectName);
120 DECL_TYPED_CHILDREN(X509Certificate);
121 DECL_TYPED_CHILDREN(X509CRL);
122 DECL_XMLOBJECT_CHILDREN(OtherX509Data);
123 /** X509DataType local name */
124 static const XMLCh TYPE_NAME[];
127 BEGIN_XMLOBJECT(XMLTOOL_API,SPKIData,xmltooling::XMLObject,XML Digital Signature version 20020212 SPKIData element);
128 /** SPKIDataType local name */
129 static const XMLCh TYPE_NAME[];
131 /** Returns modifiable collection of SPKIsexp/XMLObject pairs. */
132 virtual VectorOfPairs(SPKISexp,xmltooling::XMLObject) getSPKISexps()=0;
134 /** Returns reference to immutable collection of SPKIsexp/XMLObject pairs. */
135 virtual const std::vector< std::pair<SPKISexp*,xmltooling::XMLObject*> >& getSPKISexps() const=0;
138 BEGIN_XMLOBJECT(XMLTOOL_API,PGPData,xmltooling::XMLObject,XML Digital Signature version 20020212 PGPData element);
139 DECL_TYPED_CHILD(PGPKeyID);
140 DECL_TYPED_CHILD(PGPKeyPacket);
141 DECL_XMLOBJECT_CHILDREN(PGPDataExtension);
142 /** PGPDataType local name */
143 static const XMLCh TYPE_NAME[];
146 BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfo,xmltooling::XMLObject,XML Digital Signature version 20020212 KeyInfo element);
147 DECL_STRING_ATTRIB(Id,ID);
148 DECL_TYPED_CHILDREN(X509Data);
149 DECL_TYPED_CHILDREN(KeyName);
150 DECL_TYPED_CHILDREN(KeyValue);
151 DECL_TYPED_CHILDREN(RetrievalMethod);
152 DECL_TYPED_CHILDREN(MgmtData);
153 DECL_TYPED_CHILDREN(PGPData);
154 DECL_TYPED_CHILDREN(SPKIData);
155 DECL_XMLOBJECT_CHILDREN(Other);
156 /** KeyInfoType local name */
157 static const XMLCh TYPE_NAME[];
160 DECL_XMLSIGOBJECTBUILDER(PGPData);
161 DECL_XMLSIGOBJECTBUILDER(PGPKeyID);
162 DECL_XMLSIGOBJECTBUILDER(PGPKeyPacket);
163 DECL_XMLSIGOBJECTBUILDER(SPKIData);
164 DECL_XMLSIGOBJECTBUILDER(SPKISexp);
165 DECL_XMLSIGOBJECTBUILDER(X509IssuerSerial);
166 DECL_XMLSIGOBJECTBUILDER(X509IssuerName);
167 DECL_XMLSIGOBJECTBUILDER(X509SerialNumber);
168 DECL_XMLSIGOBJECTBUILDER(X509SKI);
169 DECL_XMLSIGOBJECTBUILDER(X509SubjectName);
170 DECL_XMLSIGOBJECTBUILDER(X509Certificate);
171 DECL_XMLSIGOBJECTBUILDER(X509CRL);
172 DECL_XMLSIGOBJECTBUILDER(X509Data);
173 DECL_XMLSIGOBJECTBUILDER(XPath);
174 DECL_XMLSIGOBJECTBUILDER(Transform);
175 DECL_XMLSIGOBJECTBUILDER(Transforms);
176 DECL_XMLSIGOBJECTBUILDER(RetrievalMethod);
177 DECL_XMLSIGOBJECTBUILDER(KeyName);
178 DECL_XMLSIGOBJECTBUILDER(MgmtData);
179 DECL_XMLSIGOBJECTBUILDER(Modulus);
180 DECL_XMLSIGOBJECTBUILDER(Exponent);
181 DECL_XMLSIGOBJECTBUILDER(Seed);
182 DECL_XMLSIGOBJECTBUILDER(PgenCounter);
183 DECL_XMLSIGOBJECTBUILDER(P);
184 DECL_XMLSIGOBJECTBUILDER(Q);
185 DECL_XMLSIGOBJECTBUILDER(G);
186 DECL_XMLSIGOBJECTBUILDER(Y);
187 DECL_XMLSIGOBJECTBUILDER(J);
188 DECL_XMLSIGOBJECTBUILDER(DSAKeyValue);
189 DECL_XMLSIGOBJECTBUILDER(RSAKeyValue);
190 DECL_XMLSIGOBJECTBUILDER(KeyValue);
191 DECL_XMLSIGOBJECTBUILDER(KeyInfo);
194 * Registers builders and validators for KeyInfo classes into the runtime.
196 void XMLTOOL_API registerKeyInfoClasses();
199 * Validator suite for KeyInfo schema validation.
201 extern XMLTOOL_API xmltooling::ValidatorSuite KeyInfoSchemaValidators;
204 #endif /* __xmltooling_keyinfo_h__ */