xmltooling/encryption/Encryption.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/encryption/Encryption.h
  23  *
  24  * XMLObjects representing XML Encryption content
  25  */
  26
  27 #if !defined(__xmltooling_encryption_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_encryption_h__
  29
  30 #include <xmltooling/ConcreteXMLObjectBuilder.h>
  31 #include <xmltooling/ElementProxy.h>
  32 #include <xmltooling/util/XMLConstants.h>
  33
  34 #include <cstdio>
  35 #include <boost/lexical_cast.hpp>
  36
  37 namespace xmlsignature {
  38     class XMLTOOL_API KeyInfo;
  39     class XMLTOOL_API Transform;
  40 };
  41
  42 /**
  43  * Macro for declaring encryption builders.
  44  *
  45  * @param cname name of class being built
  46  */
  47 #define DECL_XMLENCOBJECTBUILDER(cname) \
  48     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmlconstants::XMLENC_NS,xmlconstants::XMLENC_PREFIX)
  49
  50 /**
  51  * Macro for declaring encryption 1.1 builders.
  52  *
  53  * @param cname name of class being built
  54  */
  55 #define DECL_XMLENC11OBJECTBUILDER(cname) \
  56     DECL_XMLOBJECTBUILDER(XMLTOOL_API,cname,xmlconstants::XMLENC11_NS,xmlconstants::XMLENC11_PREFIX)
  57
  58 /**
  59  * @namespace xmlencryption
  60  * Namespace for XML Encryption schema objects
  61  */
  62 namespace xmlencryption {
  63
  64     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,CarriedKeyName,Name,XML Encryption CarriedKeyName element);
  65     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,CipherValue,Value,XML Encryption CipherValue element);
  66     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,OAEPparams,Name,XML Encryption OAEPparams element);
  67
  68     BEGIN_XMLOBJECT(XMLTOOL_API,KeySize,xmltooling::XMLObject,XML Encryption KeySize element);
  69         DECL_INTEGER_CONTENT(Size);
  70     END_XMLOBJECT;
  71
  72     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionMethod,xmltooling::ElementExtensibleXMLObject,XML Encryption EncryptionMethod element);
  73         DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
  74         DECL_TYPED_CHILD(KeySize);
  75         DECL_TYPED_CHILD(OAEPparams);
  76         /** EncryptionMethodType local name */
  77         static const XMLCh TYPE_NAME[];
  78     END_XMLOBJECT;
  79
  80     BEGIN_XMLOBJECT(XMLTOOL_API,Transforms,xmltooling::XMLObject,XML Encryption Transforms element);
  81         DECL_TYPED_FOREIGN_CHILDREN(Transform,xmlsignature);
  82         /** TransformsType local name */
  83         static const XMLCh TYPE_NAME[];
  84     END_XMLOBJECT;
  85
  86     BEGIN_XMLOBJECT(XMLTOOL_API,CipherReference,xmltooling::XMLObject,XML Encryption CipherReference element);
  87         DECL_STRING_ATTRIB(URI,URI);
  88         DECL_TYPED_CHILD(Transforms);
  89         /** CipherReferenceType local name */
  90         static const XMLCh TYPE_NAME[];
  91     END_XMLOBJECT;
  92
  93     BEGIN_XMLOBJECT(XMLTOOL_API,CipherData,xmltooling::XMLObject,XML Encryption CipherData element);
  94         DECL_TYPED_CHILD(CipherValue);
  95         DECL_TYPED_CHILD(CipherReference);
  96         /** CipherDataType local name */
  97         static const XMLCh TYPE_NAME[];
  98     END_XMLOBJECT;
  99
 100     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionProperty,xmltooling::ElementProxy,XML Encryption EncryptionProperty element);
 101         DECL_STRING_ATTRIB(Target,TARGET);
 102         DECL_STRING_ATTRIB(Id,ID);
 103         /** EncryptionPropertyType local name */
 104         static const XMLCh TYPE_NAME[];
 105     END_XMLOBJECT;
 106
 107     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionProperties,xmltooling::XMLObject,XML Encryption EncryptionProperties element);
 108         DECL_STRING_ATTRIB(Id,ID);
 109         DECL_TYPED_CHILDREN(EncryptionProperty);
 110         /** EncryptionPropertiesType local name */
 111         static const XMLCh TYPE_NAME[];
 112     END_XMLOBJECT;
 113
 114     BEGIN_XMLOBJECT(XMLTOOL_API,ReferenceType,xmltooling::ElementExtensibleXMLObject,XML Encryption ReferenceType type);
 115         DECL_STRING_ATTRIB(URI,URI);
 116         /** ReferenceType local name */
 117         static const XMLCh TYPE_NAME[];
 118     END_XMLOBJECT;
 119
 120     BEGIN_XMLOBJECT(XMLTOOL_API,DataReference,ReferenceType,XML Encryption DataReference element);
 121     END_XMLOBJECT;
 122
 123     BEGIN_XMLOBJECT(XMLTOOL_API,KeyReference,ReferenceType,XML Encryption KeyReference element);
 124     END_XMLOBJECT;
 125
 126     BEGIN_XMLOBJECT(XMLTOOL_API,ReferenceList,xmltooling::XMLObject,XML Encryption ReferenceList element);
 127         DECL_TYPED_CHILDREN(DataReference);
 128         DECL_TYPED_CHILDREN(KeyReference);
 129     END_XMLOBJECT;
 130
 131     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedType,xmltooling::XMLObject,XML Encryption EncryptedType abstract type);
 132         DECL_STRING_ATTRIB(Id,ID);
 133         DECL_STRING_ATTRIB(Type,TYPE);
 134         DECL_STRING_ATTRIB(MimeType,MIMETYPE);
 135         DECL_STRING_ATTRIB(Encoding,ENCODING);
 136         DECL_TYPED_CHILD(EncryptionMethod);
 137         DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
 138         DECL_TYPED_CHILD(CipherData);
 139         DECL_TYPED_CHILD(EncryptionProperties);
 140         /** EncryptedType local name */
 141         static const XMLCh TYPE_NAME[];
 142     END_XMLOBJECT;
 143
 144     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedData,EncryptedType,XML Encryption EncryptedData element);
 145         /** EncryptedDataType local name */
 146         static const XMLCh TYPE_NAME[];
 147     END_XMLOBJECT;
 148
 149     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedKey,EncryptedType,XML Encryption EncryptedKey element);
 150         DECL_STRING_ATTRIB(Recipient,RECIPIENT);
 151         DECL_TYPED_CHILD(ReferenceList);
 152         DECL_TYPED_CHILD(CarriedKeyName);
 153         /** EncryptedKeyType local name */
 154         static const XMLCh TYPE_NAME[];
 155     END_XMLOBJECT;
 156
 157     BEGIN_XMLOBJECT(XMLTOOL_API,MGF,xmltooling::XMLObject,XML Encryption 1.1 MGF element);
 158         DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
 159         /** MGFType local name */
 160         static const XMLCh TYPE_NAME[];
 161     END_XMLOBJECT;
 162
 163     DECL_XMLENCOBJECTBUILDER(CarriedKeyName);
 164     DECL_XMLENCOBJECTBUILDER(CipherData);
 165     DECL_XMLENCOBJECTBUILDER(CipherReference);
 166     DECL_XMLENCOBJECTBUILDER(CipherValue);
 167     DECL_XMLENCOBJECTBUILDER(DataReference);
 168     DECL_XMLENCOBJECTBUILDER(EncryptedData);
 169     DECL_XMLENCOBJECTBUILDER(EncryptedKey);
 170     DECL_XMLENCOBJECTBUILDER(EncryptionMethod);
 171     DECL_XMLENCOBJECTBUILDER(EncryptionProperties);
 172     DECL_XMLENCOBJECTBUILDER(EncryptionProperty);
 173     DECL_XMLENCOBJECTBUILDER(KeyReference);
 174     DECL_XMLENCOBJECTBUILDER(KeySize);
 175     DECL_XMLENCOBJECTBUILDER(OAEPparams);
 176     DECL_XMLENCOBJECTBUILDER(ReferenceList);
 177     DECL_XMLENCOBJECTBUILDER(Transforms);
 178
 179     DECL_XMLENC11OBJECTBUILDER(MGF);
 180
 181     /**
 182      * Registers builders and validators for XML Encryption classes into the runtime.
 183      */
 184     void XMLTOOL_API registerEncryptionClasses();
 185 };
 186
 187 #endif /* __xmltooling_encryption_h__ */