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/XMLObjectBuilder.h>
  30 #include <xmltooling/util/XMLConstants.h>
  31 #include <xmltooling/validation/ValidatingXMLObject.h>
  32
  33 #include <typeinfo>
  34
  35 #define DECL_XMLSIGOBJECTBUILDER(cname) \
  36     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,XMLConstants::XMLSIG_NS,XMLConstants::XMLSIG_PREFIX)
  37
  38 namespace xmltooling {
  39
  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
  52     /**
  53      * XML Digital Signature version 20020212 DSAKeyValue element.
  54      */
  55     BEGIN_XMLOBJECT(XMLTOOL_API,DSAKeyValue,XMLObject);
  56         DECL_XMLOBJECT_CHILD(P);
  57         DECL_XMLOBJECT_CHILD(Q);
  58         DECL_XMLOBJECT_CHILD(G);
  59         DECL_XMLOBJECT_CHILD(Y);
  60         DECL_XMLOBJECT_CHILD(J);
  61         DECL_XMLOBJECT_CHILD(Seed);
  62         DECL_XMLOBJECT_CHILD(PgenCounter);
  63         /** DSAKeyValueType local name */
  64         static const XMLCh TYPE_NAME[];
  65     END_XMLOBJECT;
  66
  67     /**
  68      * XML Digital Signature version 20020212 RSAKeyValue element.
  69      */
  70     BEGIN_XMLOBJECT(XMLTOOL_API,RSAKeyValue,XMLObject);
  71         DECL_XMLOBJECT_CHILD(Modulus);
  72         DECL_XMLOBJECT_CHILD(Exponent);
  73         /** RSAKeyValueType local name */
  74         static const XMLCh TYPE_NAME[];
  75     END_XMLOBJECT;
  76
  77     /**
  78      * XML Digital Signature version 20020212 KeyValue element.
  79      */
  80     BEGIN_XMLOBJECT(XMLTOOL_API,KeyValue,XMLObject);
  81         DECL_XMLOBJECT_CHILD(DSAKeyValue);
  82         DECL_XMLOBJECT_CHILD(RSAKeyValue);
  83         DECL_XMLOBJECT_CHILD(XMLObject);
  84         DECL_XMLOBJECT_CONTENT(TextContent);
  85         /** KeyValueType local name */
  86         static const XMLCh TYPE_NAME[];
  87     END_XMLOBJECT;
  88
  89     /**
  90      * XML Digital Signature version 20020212 KeyInfo element.
  91      */
  92     BEGIN_XMLOBJECT(XMLTOOL_API,KeyInfo,ElementProxy);
  93         DECL_XMLOBJECT_ATTRIB(Id,ID);
  94         DECL_XMLOBJECT_CHILDREN(KeyName);
  95         DECL_XMLOBJECT_CHILDREN(MgmtData);
  96         /** KeyInfoType local name */
  97         static const XMLCh TYPE_NAME[];
  98     END_XMLOBJECT;
  99
 100     DECL_XMLSIGOBJECTBUILDER(KeyName);
 101     DECL_XMLSIGOBJECTBUILDER(MgmtData);
 102     DECL_XMLSIGOBJECTBUILDER(Modulus);
 103     DECL_XMLSIGOBJECTBUILDER(Exponent);
 104     DECL_XMLSIGOBJECTBUILDER(Seed);
 105     DECL_XMLSIGOBJECTBUILDER(PgenCounter);
 106     DECL_XMLSIGOBJECTBUILDER(P);
 107     DECL_XMLSIGOBJECTBUILDER(Q);
 108     DECL_XMLSIGOBJECTBUILDER(G);
 109     DECL_XMLSIGOBJECTBUILDER(Y);
 110     DECL_XMLSIGOBJECTBUILDER(J);
 111     DECL_XMLSIGOBJECTBUILDER(DSAKeyValue);
 112     DECL_XMLSIGOBJECTBUILDER(RSAKeyValue);
 113     DECL_XMLSIGOBJECTBUILDER(KeyValue);
 114     DECL_XMLSIGOBJECTBUILDER(KeyInfo);
 115
 116 #ifdef XMLTOOLING_DECLARE_VALIDATORS
 117     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,KeyName,Name);
 118     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,MgmtData,Data);
 119     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Modulus,Value);
 120     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Exponent,Value);
 121     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Seed,Value);
 122     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,PgenCounter,Value);
 123     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,P,Value);
 124     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Q,Value);
 125     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,G,Value);
 126     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,Y,Value);
 127     XMLOBJECTVALIDATOR_SIMPLE(XMLTOOL_DLLLOCAL,J,Value);
 128
 129     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,RSAKeyValue);
 130         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Modulus);
 131         XMLOBJECTVALIDATOR_REQUIRE(RSAKeyValue,Exponent);
 132     END_XMLOBJECTVALIDATOR;
 133
 134     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,DSAKeyValue);
 135         XMLOBJECTVALIDATOR_REQUIRE(DSAKeyValue,Y);
 136         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,P,Q);
 137         XMLOBJECTVALIDATOR_NONEORBOTH(DSKeyValue,Seed,PgenCounter);
 138     END_XMLOBJECTVALIDATOR;
 139
 140     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyValue);
 141         XMLOBJECTVALIDATOR_ONEOF3(KeyValue,DSAKeyValue,RSAKeyValue,XMLObject);
 142     END_XMLOBJECTVALIDATOR;
 143
 144     BEGIN_XMLOBJECTVALIDATOR(XMLTOOL_DLLLOCAL,KeyInfo);
 145         XMLOBJECTVALIDATOR_NONEMPTY(KeyInfo,XMLObject);
 146     END_XMLOBJECTVALIDATOR;
 147 #endif /* XMLTOOLING_DECLARE_VALIDATORS */
 148
 149 };
 150
 151 #endif /* __xmltooling_keyinfo_h__ */