xmltooling/signature/KeyInfo.h

   1 /*
   2  *  Copyright 2001-2006 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  * @file KeyInfo.h
  19  *
  20  * XMLObjects representing XML Digital Signature, version 20020212, KeyInfo element
  21  * and related content.
  22  */
  23
  24 #ifndef __xmltooling_keyinfo_h__
  25 #define __xmltooling_keyinfo_h__
  26
  27 #include <xmltooling/ElementProxy.h>
  28 #include <xmltooling/exceptions.h>
  29 #include <xmltooling/SimpleElement.h>
  30 #include <xmltooling/XMLObjectBuilder.h>
  31 #include <xmltooling/util/XMLConstants.h>
  32 #include <xmltooling/validation/ValidatingXMLObject.h>
  33
  34 #include <typeinfo>
  35
  36 #define DECL_XMLSIGOBJECTBUILDER(cname) \
  37     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmltooling::XMLConstants::XMLSIG_NS,xmltooling::XMLConstants::XMLSIG_PREFIX)
  38
  39 namespace xmlsignature {
  40
  41     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,KeyName,Name,XML Digital Signature version 20020212 KeyName element);
  42     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,MgmtData,Data,XML Digital Signature version 20020212 MgmtData element);
  43     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Modulus,Value,XML Digital Signature version 20020212 Modulus element);
  44     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Exponent,Value,XML Digital Signature version 20020212 Exponent element);
  45     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Seed,Value,XML Digital Signature version 20020212 Seed element);
  46     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PgenCounter,Value,XML Digital Signature version 20020212 PgenCounter element);
  47     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,P,Value,XML Digital Signature version 20020212 P element);
  48     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Q,Value,XML Digital Signature version 20020212 Q element);
  49     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,G,Value,XML Digital Signature version 20020212 G element);
  50     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Y,Value,XML Digital Signature version 20020212 Y element);
  51     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,J,Value,XML Digital Signature version 20020212 J element);
  52     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,XPath,Expression,XML Digital Signature version 20020212 XPath element);
  53     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509IssuerName,Name,XML Digital Signature version 20020212 X509IssuerName element);
  54     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SerialNumber,SerialNumber,XML Digital Signature version 20020212 X509SerialNumber element);
  55     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SKI,Value,XML Digital Signature version 20020212 X509SKI element);
  56     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SubjectName,Name,XML Digital Signature version 20020212 X509SubjectName element);
  57     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509Certificate,Value,XML Digital Signature version 20020212 X509Certificate element);
  58     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509CRL,Value,XML Digital Signature version 20020212 X509CRL element);
  59     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,SPKISexp,Value,XML Digital Signature version 20020212 SPKISexp element);
  60     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyID,ID,XML Digital Signature version 20020212 PGPKeyID element);
  61     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyPacket,Packet,XML Digital Signature version 20020212 PGPKeyPacket element);
  62
  63     BEGIN_XMLOBJECT(XMLTOOL_API,DSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 DSAKeyValue element);
  64         DECL_XMLOBJECT_CHILD(P);
  65         DECL_XMLOBJECT_CHILD(Q);
  66         DECL_XMLOBJECT_CHILD(G);
  67         DECL_XMLOBJECT_CHILD(Y);
  68         DECL_XMLOBJECT_CHILD(J);
  69         DECL_XMLOBJECT_CHILD(Seed);
  70         DECL_XMLOBJECT_CHILD(PgenCounter);
  71         /** DSAKeyValueType local name */
  72         static const XMLCh TYPE_NAME[];
  73     END_XMLOBJECT;
  74
  75     BEGIN_XMLOBJECT(XMLTOOL_API,RSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 RSAKeyValue element);
  76         DECL_XMLOBJECT_CHILD(Modulus);
  77         DECL_XMLOBJECT_CHILD(Exponent);
  78         /** RSAKeyValueType local name */
  79         static const XMLCh TYPE_NAME[];
  80     END_XMLOBJECT;
  81
  82     BEGIN_XMLOBJECT(XMLTOOL_API,KeyValue,xmltooling::SimpleElement,XML Digital Signature version 20020212 KeyValue element);
  83         DECL_XMLOBJECT_CHILD(DSAKeyValue);
  84         DECL_XMLOBJECT_CHILD(RSAKeyValue);
  85         DECL_XMLOBJECT_CHILD(XMLObject);
  86         /** KeyValueType local name */
  87         static const XMLCh TYPE_NAME[];
  88     END_XMLOBJECT;
  89
  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[];
  95     END_XMLOBJECT;
  96
  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[];
 101     END_XMLOBJECT;
 102
 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[];
 109     END_XMLOBJECT;
 110
 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[];
 116     END_XMLOBJECT;
 117
 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[];
 127     END_XMLOBJECT;
 128
 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[];
 132
 133         /** Returns modifiable collection of SPKIsexp/XMLObject pairs. */
 134         virtual VectorOfPairs(SPKISexp,xmltooling::XMLObject) getSPKISexps()=0;
 135
 136         /** Returns reference to immutable collection of SPKIsexp/XMLObject pairs. */
 137         virtual const std::vector< std::pair<SPKISexp*,xmltooling::XMLObject*> >& getSPKISexps() const=0;
 138     END_XMLOBJECT;
 139
 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[];
 146     END_XMLOBJECT;
 147
 148     BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfo,xmltooling::XMLObject,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         DECL_XMLOBJECT_CHILDREN(XMLObject);
 158         /** KeyInfoType local name */
 159         static const XMLCh TYPE_NAME[];
 160     END_XMLOBJECT;
 161
 162     DECL_XMLSIGOBJECTBUILDER(PGPData);
 163     DECL_XMLSIGOBJECTBUILDER(PGPKeyID);
 164     DECL_XMLSIGOBJECTBUILDER(PGPKeyPacket);
 165     DECL_XMLSIGOBJECTBUILDER(SPKIData);
 166     DECL_XMLSIGOBJECTBUILDER(SPKISexp);
 167     DECL_XMLSIGOBJECTBUILDER(X509IssuerSerial);
 168     DECL_XMLSIGOBJECTBUILDER(X509IssuerName);
 169     DECL_XMLSIGOBJECTBUILDER(X509SerialNumber);
 170     DECL_XMLSIGOBJECTBUILDER(X509SKI);
 171     DECL_XMLSIGOBJECTBUILDER(X509SubjectName);
 172     DECL_XMLSIGOBJECTBUILDER(X509Certificate);
 173     DECL_XMLSIGOBJECTBUILDER(X509CRL);
 174     DECL_XMLSIGOBJECTBUILDER(X509Data);
 175     DECL_XMLSIGOBJECTBUILDER(XPath);
 176     DECL_XMLSIGOBJECTBUILDER(Transform);
 177     DECL_XMLSIGOBJECTBUILDER(Transforms);
 178     DECL_XMLSIGOBJECTBUILDER(RetrievalMethod);
 179     DECL_XMLSIGOBJECTBUILDER(KeyName);
 180     DECL_XMLSIGOBJECTBUILDER(MgmtData);
 181     DECL_XMLSIGOBJECTBUILDER(Modulus);
 182     DECL_XMLSIGOBJECTBUILDER(Exponent);
 183     DECL_XMLSIGOBJECTBUILDER(Seed);
 184     DECL_XMLSIGOBJECTBUILDER(PgenCounter);
 185     DECL_XMLSIGOBJECTBUILDER(P);
 186     DECL_XMLSIGOBJECTBUILDER(Q);
 187     DECL_XMLSIGOBJECTBUILDER(G);
 188     DECL_XMLSIGOBJECTBUILDER(Y);
 189     DECL_XMLSIGOBJECTBUILDER(J);
 190     DECL_XMLSIGOBJECTBUILDER(DSAKeyValue);
 191     DECL_XMLSIGOBJECTBUILDER(RSAKeyValue);
 192     DECL_XMLSIGOBJECTBUILDER(KeyValue);
 193     DECL_XMLSIGOBJECTBUILDER(KeyInfo);
 194
 195 #ifdef XMLTOOLING_DECLARE_VALIDATORS
 196     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,KeyName);
 197     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,MgmtData);
 198     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Modulus);
 199     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Exponent);
 200     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Seed);
 201     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PgenCounter);
 202     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,P);
 203     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Q);
 204     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,G);
 205     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Y);
 206     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,J);
 207     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,XPath);
 208     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509IssuerName);
 209     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SerialNumber);
 210     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SKI);
 211     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509SubjectName);
 212     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509Certificate);
 213     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,X509CRL);
 214     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,SPKISexp);
 215     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyID);
 216     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PGPKeyPacket);
 217
 218     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RSAKeyValue);
 219         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Modulus);
 220         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Exponent);
 221     END_XMLOBJECTVALIDATOR;
 222
 223     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,DSAKeyValue);
 224         XMLOBJECTVALIDATOR_REQUIRE(DSAKeyValue,Y);
 225         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,P,Q);
 226         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,Seed,PgenCounter);
 227     END_XMLOBJECTVALIDATOR;
 228
 229     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyValue);
 230         XMLOBJECTVALIDATOR_ONEOF3(KeyValue,DSAKeyValue,RSAKeyValue,XMLObject);
 231     END_XMLOBJECTVALIDATOR;
 232
 233     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transform);
 234         XMLOBJECTVALIDATOR_REQUIRE(Transform,Algorithm);
 235     END_XMLOBJECTVALIDATOR;
 236
 237     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,Transforms);
 238         XMLOBJECTVALIDATOR_NONEMPTY(Transforms,Transform);
 239     END_XMLOBJECTVALIDATOR;
 240
 241     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RetrievalMethod);
 242         XMLOBJECTVALIDATOR_REQUIRE(RetrievalMethod,URI);
 243     END_XMLOBJECTVALIDATOR;
 244
 245     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509IssuerSerial);
 246         XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509IssuerName);
 247         XMLOBJECTVALIDATOR_REQUIRE(X509IssuerSerial,X509SerialNumber);
 248     END_XMLOBJECTVALIDATOR;
 249
 250     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,X509Data);
 251         if (!ptr->hasChildren())
 252             throw xmltooling::ValidationException("X509Data must have at least one child element.");
 253     END_XMLOBJECTVALIDATOR;
 254
 255     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,SPKIData);
 256         XMLOBJECTVALIDATOR_NONEMPTY(SPKIData,SPKISexp);
 257     END_XMLOBJECTVALIDATOR;
 258
 259     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,PGPData);
 260         XMLOBJECTVALIDATOR_ONEOF(PGPData,PGPKeyID,PGPKeyPacket);
 261     END_XMLOBJECTVALIDATOR;
 262
 263     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyInfo);
 264         XMLOBJECTVALIDATOR_NONEMPTY(KeyInfo,XMLObject);
 265     END_XMLOBJECTVALIDATOR;
 266 #endif /* XMLTOOLING_DECLARE_VALIDATORS */
 267
 268 };
 269
 270 #endif /* __xmltooling_keyinfo_h__ */