xmltooling/signature/KeyInfo.h

   1 /*
   2  *  Copyright 2001-2007 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 xmltooling/signature/KeyInfo.h
  19  *
  20  * XMLObjects representing XML Digital Signature, version 20020212, KeyInfo element
  21  * and related content.
  22  */
  23
  24 #if !defined(__xmltooling_keyinfo_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  25 #define __xmltooling_keyinfo_h__
  26
  27 #include <xmltooling/ConcreteXMLObjectBuilder.h>
  28 #include <xmltooling/ElementProxy.h>
  29 #include <xmltooling/util/XMLConstants.h>
  30
  31 /**
  32  * Macro for declaring signature builders.
  33  *
  34  * @param cname name of class being built
  35  */
  36 #define DECL_XMLSIGOBJECTBUILDER(cname) \
  37     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmlconstants::XMLSIG_NS,xmlconstants::XMLSIG_PREFIX)
  38
  39 /**
  40  * Macro for declaring signature builders.
  41  *
  42  * @param cname name of class being built
  43  */
  44 #define DECL_XMLSIG11OBJECTBUILDER(cname) \
  45     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmlconstants::XMLSIG11_NS,xmlconstants::XMLSIG11_PREFIX)
  46
  47 namespace xmlsignature {
  48
  49     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,KeyName,Name,XML Digital Signature version 20020212 KeyName element);
  50     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,MgmtData,Data,XML Digital Signature version 20020212 MgmtData element);
  51     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Modulus,Value,XML Digital Signature version 20020212 Modulus element);
  52     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Exponent,Value,XML Digital Signature version 20020212 Exponent element);
  53     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Seed,Value,XML Digital Signature version 20020212 Seed element);
  54     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PgenCounter,Value,XML Digital Signature version 20020212 PgenCounter element);
  55     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,P,Value,XML Digital Signature version 20020212 P element);
  56     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Q,Value,XML Digital Signature version 20020212 Q element);
  57     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,G,Value,XML Digital Signature version 20020212 G element);
  58     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,Y,Value,XML Digital Signature version 20020212 Y element);
  59     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,J,Value,XML Digital Signature version 20020212 J element);
  60     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,XPath,Expression,XML Digital Signature version 20020212 XPath element);
  61     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509IssuerName,Name,XML Digital Signature version 20020212 X509IssuerName element);
  62     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SerialNumber,SerialNumber,XML Digital Signature version 20020212 X509SerialNumber element);
  63     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SKI,Value,XML Digital Signature version 20020212 X509SKI element);
  64     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509SubjectName,Name,XML Digital Signature version 20020212 X509SubjectName element);
  65     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509Certificate,Value,XML Digital Signature version 20020212 X509Certificate element);
  66     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,X509CRL,Value,XML Digital Signature version 20020212 X509CRL element);
  67     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,SPKISexp,Value,XML Digital Signature version 20020212 SPKISexp element);
  68     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyID,ID,XML Digital Signature version 20020212 PGPKeyID element);
  69     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PGPKeyPacket,Packet,XML Digital Signature version 20020212 PGPKeyPacket element);
  70
  71     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,OCSPResponse,Response,XML Digital Signature version 1.1 OCSPResponse element);
  72     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,PublicKey,Value,XML Digital Signature version 1.1 PublicKey element);
  73
  74     BEGIN_XMLOBJECT(XMLTOOL_API,DSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 DSAKeyValue element);
  75         DECL_TYPED_CHILD(P);
  76         DECL_TYPED_CHILD(Q);
  77         DECL_TYPED_CHILD(G);
  78         DECL_TYPED_CHILD(Y);
  79         DECL_TYPED_CHILD(J);
  80         DECL_TYPED_CHILD(Seed);
  81         DECL_TYPED_CHILD(PgenCounter);
  82         /** DSAKeyValueType local name */
  83         static const XMLCh TYPE_NAME[];
  84     END_XMLOBJECT;
  85
  86     BEGIN_XMLOBJECT(XMLTOOL_API,RSAKeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 RSAKeyValue element);
  87         DECL_TYPED_CHILD(Modulus);
  88         DECL_TYPED_CHILD(Exponent);
  89         /** RSAKeyValueType local name */
  90         static const XMLCh TYPE_NAME[];
  91     END_XMLOBJECT;
  92
  93     BEGIN_XMLOBJECT(XMLTOOL_API,NamedCurve,xmltooling::XMLObject,XML Digital Signature version 1.1 NamedCurve element);
  94         DECL_STRING_ATTRIB(URI,URI);
  95         /** NamedCurveType local name */
  96         static const XMLCh TYPE_NAME[];
  97     END_XMLOBJECT;
  98
  99     BEGIN_XMLOBJECT(XMLTOOL_API,ECKeyValue,xmltooling::XMLObject,XML Digital Signature version 1.1 ECKeyValue element);
 100         DECL_STRING_ATTRIB(Id,ID);
 101         DECL_XMLOBJECT_CHILD(ECParameters);
 102         DECL_TYPED_CHILD(NamedCurve);
 103         DECL_TYPED_CHILD(PublicKey);
 104         /** ECKeyValueType local name */
 105         static const XMLCh TYPE_NAME[];
 106     END_XMLOBJECT;
 107
 108     BEGIN_XMLOBJECT(XMLTOOL_API,KeyValue,xmltooling::XMLObject,XML Digital Signature version 20020212 KeyValue element);
 109         DECL_TYPED_CHILD(DSAKeyValue);
 110         DECL_TYPED_CHILD(RSAKeyValue);
 111         DECL_TYPED_CHILD(ECKeyValue);
 112         DECL_XMLOBJECT_CHILD(UnknownXMLObject);
 113         /** KeyValueType local name */
 114         static const XMLCh TYPE_NAME[];
 115     END_XMLOBJECT;
 116
 117     BEGIN_XMLOBJECT(XMLTOOL_API,Transform,xmltooling::ElementExtensibleXMLObject,XML Digital Signature version 20020212 Transform element);
 118         DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
 119         DECL_TYPED_CHILDREN(XPath);
 120         /** TransformType local name */
 121         static const XMLCh TYPE_NAME[];
 122     END_XMLOBJECT;
 123
 124     BEGIN_XMLOBJECT(XMLTOOL_API,Transforms,xmltooling::XMLObject,XML Digital Signature version 20020212 Transforms element);
 125         DECL_TYPED_CHILDREN(Transform);
 126         /** TransformsType local name */
 127         static const XMLCh TYPE_NAME[];
 128     END_XMLOBJECT;
 129
 130     BEGIN_XMLOBJECT(XMLTOOL_API,RetrievalMethod,xmltooling::XMLObject,XML Digital Signature version 20020212 RetrievalMethod element);
 131         DECL_STRING_ATTRIB(URI,URI);
 132         DECL_STRING_ATTRIB(Type,TYPE);
 133         DECL_TYPED_CHILD(Transforms);
 134         /** RetrievalMethodType local name */
 135         static const XMLCh TYPE_NAME[];
 136         /** DSAKeyValue RetrievalMethod Type */
 137         static const XMLCh TYPE_DSAKEYVALUE[];
 138         /** RSAKeyValue RetrievalMethod Type */
 139         static const XMLCh TYPE_RSAKEYVALUE[];
 140         /** X509Data RetrievalMethod Type */
 141         static const XMLCh TYPE_X509DATA[];
 142     END_XMLOBJECT;
 143
 144     BEGIN_XMLOBJECT(XMLTOOL_API,X509IssuerSerial,xmltooling::XMLObject,XML Digital Signature version 20020212 X509IssuerSerial element);
 145         DECL_TYPED_CHILD(X509IssuerName);
 146         DECL_TYPED_CHILD(X509SerialNumber);
 147         /** X509IssuerSerialType local name */
 148         static const XMLCh TYPE_NAME[];
 149     END_XMLOBJECT;
 150
 151     BEGIN_XMLOBJECT(XMLTOOL_API,X509Digest,xmltooling::XMLObject,XML Digital Signature version 1.1 X509Digest element);
 152         DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
 153         DECL_SIMPLE_CONTENT(Value);
 154         /** X509DigestType local name */
 155         static const XMLCh TYPE_NAME[];
 156     END_XMLOBJECT;
 157
 158     BEGIN_XMLOBJECT(XMLTOOL_API,X509Data,xmltooling::ElementExtensibleXMLObject,XML Digital Signature version 20020212 X509Data element);
 159         DECL_TYPED_CHILDREN(X509IssuerSerial);
 160         DECL_TYPED_CHILDREN(X509SKI);
 161         DECL_TYPED_CHILDREN(X509SubjectName);
 162         DECL_TYPED_CHILDREN(X509Certificate);
 163         DECL_TYPED_CHILDREN(X509CRL);
 164         DECL_TYPED_CHILDREN(X509Digest);
 165         DECL_TYPED_CHILDREN(OCSPResponse);
 166         /** X509DataType local name */
 167         static const XMLCh TYPE_NAME[];
 168     END_XMLOBJECT;
 169
 170     BEGIN_XMLOBJECT(XMLTOOL_API,SPKIData,xmltooling::XMLObject,XML Digital Signature version 20020212 SPKIData element);
 171         /** SPKIDataType local name */
 172         static const XMLCh TYPE_NAME[];
 173
 174         /** Returns modifiable collection of SPKIsexp/XMLObject pairs. */
 175         virtual VectorOfPairs(SPKISexp,xmltooling::XMLObject) getSPKISexps()=0;
 176
 177         /** Returns reference to immutable collection of SPKIsexp/XMLObject pairs. */
 178         virtual const std::vector< std::pair<SPKISexp*,xmltooling::XMLObject*> >& getSPKISexps() const=0;
 179     END_XMLOBJECT;
 180
 181     BEGIN_XMLOBJECT(XMLTOOL_API,PGPData,xmltooling::ElementExtensibleXMLObject,XML Digital Signature version 20020212 PGPData element);
 182         DECL_TYPED_CHILD(PGPKeyID);
 183         DECL_TYPED_CHILD(PGPKeyPacket);
 184         /** PGPDataType local name */
 185         static const XMLCh TYPE_NAME[];
 186     END_XMLOBJECT;
 187
 188     BEGIN_XMLOBJECT(XMLTOOL_API,DEREncodedKeyValue,xmltooling::XMLObject,XML Digital Signature version 1.1 DEREncodedKeyValue element);
 189         DECL_STRING_ATTRIB(Id,ID);
 190         DECL_SIMPLE_CONTENT(Value);
 191         /** DEREncodedKeyValueType local name */
 192         static const XMLCh TYPE_NAME[];
 193     END_XMLOBJECT;
 194
 195     BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfoReference,xmltooling::XMLObject,XML Digital Signature version 1.1 KeyInfoReference element);
 196         DECL_STRING_ATTRIB(Id,ID);
 197         DECL_STRING_ATTRIB(URI,URI);
 198         /** KeyInfoReferenceType local name */
 199         static const XMLCh TYPE_NAME[];
 200     END_XMLOBJECT;
 201
 202     BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfo,xmltooling::ElementExtensibleXMLObject,XML Digital Signature version 20020212 KeyInfo element);
 203         DECL_STRING_ATTRIB(Id,ID);
 204         DECL_TYPED_CHILDREN(X509Data);
 205         DECL_TYPED_CHILDREN(KeyName);
 206         DECL_TYPED_CHILDREN(KeyValue);
 207         DECL_TYPED_CHILDREN(DEREncodedKeyValue);
 208         DECL_TYPED_CHILDREN(RetrievalMethod);
 209         DECL_TYPED_CHILDREN(MgmtData);
 210         DECL_TYPED_CHILDREN(PGPData);
 211         DECL_TYPED_CHILDREN(SPKIData);
 212         DECL_TYPED_CHILDREN(KeyInfoReference);
 213         /** KeyInfoType local name */
 214         static const XMLCh TYPE_NAME[];
 215     END_XMLOBJECT;
 216
 217     DECL_XMLSIGOBJECTBUILDER(PGPData);
 218     DECL_XMLSIGOBJECTBUILDER(PGPKeyID);
 219     DECL_XMLSIGOBJECTBUILDER(PGPKeyPacket);
 220     DECL_XMLSIGOBJECTBUILDER(SPKIData);
 221     DECL_XMLSIGOBJECTBUILDER(SPKISexp);
 222     DECL_XMLSIGOBJECTBUILDER(X509IssuerSerial);
 223     DECL_XMLSIGOBJECTBUILDER(X509IssuerName);
 224     DECL_XMLSIGOBJECTBUILDER(X509SerialNumber);
 225     DECL_XMLSIGOBJECTBUILDER(X509SKI);
 226     DECL_XMLSIGOBJECTBUILDER(X509SubjectName);
 227     DECL_XMLSIGOBJECTBUILDER(X509Certificate);
 228     DECL_XMLSIGOBJECTBUILDER(X509CRL);
 229     DECL_XMLSIGOBJECTBUILDER(X509Data);
 230     DECL_XMLSIGOBJECTBUILDER(XPath);
 231     DECL_XMLSIGOBJECTBUILDER(Transform);
 232     DECL_XMLSIGOBJECTBUILDER(Transforms);
 233     DECL_XMLSIGOBJECTBUILDER(RetrievalMethod);
 234     DECL_XMLSIGOBJECTBUILDER(KeyName);
 235     DECL_XMLSIGOBJECTBUILDER(MgmtData);
 236     DECL_XMLSIGOBJECTBUILDER(Modulus);
 237     DECL_XMLSIGOBJECTBUILDER(Exponent);
 238     DECL_XMLSIGOBJECTBUILDER(Seed);
 239     DECL_XMLSIGOBJECTBUILDER(PgenCounter);
 240     DECL_XMLSIGOBJECTBUILDER(P);
 241     DECL_XMLSIGOBJECTBUILDER(Q);
 242     DECL_XMLSIGOBJECTBUILDER(G);
 243     DECL_XMLSIGOBJECTBUILDER(Y);
 244     DECL_XMLSIGOBJECTBUILDER(J);
 245     DECL_XMLSIGOBJECTBUILDER(DSAKeyValue);
 246     DECL_XMLSIGOBJECTBUILDER(RSAKeyValue);
 247     DECL_XMLSIGOBJECTBUILDER(KeyValue);
 248     DECL_XMLSIGOBJECTBUILDER(KeyInfo);
 249
 250     DECL_XMLSIG11OBJECTBUILDER(DEREncodedKeyValue);
 251     DECL_XMLSIG11OBJECTBUILDER(ECKeyValue);
 252     DECL_XMLSIG11OBJECTBUILDER(KeyInfoReference);
 253     DECL_XMLSIG11OBJECTBUILDER(NamedCurve);
 254     DECL_XMLSIG11OBJECTBUILDER(OCSPResponse);
 255     DECL_XMLSIG11OBJECTBUILDER(PublicKey);
 256     DECL_XMLSIG11OBJECTBUILDER(X509Digest);
 257
 258     /**
 259      * Registers builders and validators for KeyInfo classes into the runtime.
 260      */
 261     void XMLTOOL_API registerKeyInfoClasses();
 262
 263 };
 264
 265 #endif /* __xmltooling_keyinfo_h__ */