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  * @namespace xmlencryption
  52  * Namespace for XML Encryption schema objects
  53  */
  54 namespace xmlencryption {
  55
  56     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,CarriedKeyName,Name,XML Encryption CarriedKeyName element);
  57     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,CipherValue,Value,XML Encryption CipherValue element);
  58     DECL_XMLOBJECT_SIMPLE(XMLTOOL_API,OAEPparams,Name,XML Encryption OAEPparams element);
  59
  60     BEGIN_XMLOBJECT(XMLTOOL_API,KeySize,xmltooling::XMLObject,XML Encryption KeySize element);
  61         DECL_INTEGER_CONTENT(Size);
  62     END_XMLOBJECT;
  63
  64     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionMethod,xmltooling::ElementExtensibleXMLObject,XML Encryption EncryptionMethod element);
  65         DECL_STRING_ATTRIB(Algorithm,ALGORITHM);
  66         DECL_TYPED_CHILD(KeySize);
  67         DECL_TYPED_CHILD(OAEPparams);
  68         /** EncryptionMethodType local name */
  69         static const XMLCh TYPE_NAME[];
  70     END_XMLOBJECT;
  71
  72     BEGIN_XMLOBJECT(XMLTOOL_API,Transforms,xmltooling::XMLObject,XML Encryption Transforms element);
  73         DECL_TYPED_FOREIGN_CHILDREN(Transform,xmlsignature);
  74         /** TransformsType local name */
  75         static const XMLCh TYPE_NAME[];
  76     END_XMLOBJECT;
  77
  78     BEGIN_XMLOBJECT(XMLTOOL_API,CipherReference,xmltooling::XMLObject,XML Encryption CipherReference element);
  79         DECL_STRING_ATTRIB(URI,URI);
  80         DECL_TYPED_CHILD(Transforms);
  81         /** CipherReferenceType local name */
  82         static const XMLCh TYPE_NAME[];
  83     END_XMLOBJECT;
  84
  85     BEGIN_XMLOBJECT(XMLTOOL_API,CipherData,xmltooling::XMLObject,XML Encryption CipherData element);
  86         DECL_TYPED_CHILD(CipherValue);
  87         DECL_TYPED_CHILD(CipherReference);
  88         /** CipherDataType local name */
  89         static const XMLCh TYPE_NAME[];
  90     END_XMLOBJECT;
  91
  92     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionProperty,xmltooling::ElementProxy,XML Encryption EncryptionProperty element);
  93         DECL_STRING_ATTRIB(Target,TARGET);
  94         DECL_STRING_ATTRIB(Id,ID);
  95         /** EncryptionPropertyType local name */
  96         static const XMLCh TYPE_NAME[];
  97     END_XMLOBJECT;
  98
  99     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptionProperties,xmltooling::XMLObject,XML Encryption EncryptionProperties element);
 100         DECL_STRING_ATTRIB(Id,ID);
 101         DECL_TYPED_CHILDREN(EncryptionProperty);
 102         /** EncryptionPropertiesType local name */
 103         static const XMLCh TYPE_NAME[];
 104     END_XMLOBJECT;
 105
 106     BEGIN_XMLOBJECT(XMLTOOL_API,ReferenceType,xmltooling::ElementExtensibleXMLObject,XML Encryption ReferenceType type);
 107         DECL_STRING_ATTRIB(URI,URI);
 108         /** ReferenceType local name */
 109         static const XMLCh TYPE_NAME[];
 110     END_XMLOBJECT;
 111
 112     BEGIN_XMLOBJECT(XMLTOOL_API,DataReference,ReferenceType,XML Encryption DataReference element);
 113     END_XMLOBJECT;
 114
 115     BEGIN_XMLOBJECT(XMLTOOL_API,KeyReference,ReferenceType,XML Encryption KeyReference element);
 116     END_XMLOBJECT;
 117
 118     BEGIN_XMLOBJECT(XMLTOOL_API,ReferenceList,xmltooling::XMLObject,XML Encryption ReferenceList element);
 119         DECL_TYPED_CHILDREN(DataReference);
 120         DECL_TYPED_CHILDREN(KeyReference);
 121     END_XMLOBJECT;
 122
 123     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedType,xmltooling::XMLObject,XML Encryption EncryptedType abstract type);
 124         DECL_STRING_ATTRIB(Id,ID);
 125         DECL_STRING_ATTRIB(Type,TYPE);
 126         DECL_STRING_ATTRIB(MimeType,MIMETYPE);
 127         DECL_STRING_ATTRIB(Encoding,ENCODING);
 128         DECL_TYPED_CHILD(EncryptionMethod);
 129         DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
 130         DECL_TYPED_CHILD(CipherData);
 131         DECL_TYPED_CHILD(EncryptionProperties);
 132         /** EncryptedType local name */
 133         static const XMLCh TYPE_NAME[];
 134     END_XMLOBJECT;
 135
 136     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedData,EncryptedType,XML Encryption EncryptedData element);
 137         /** EncryptedDataType local name */
 138         static const XMLCh TYPE_NAME[];
 139     END_XMLOBJECT;
 140
 141     BEGIN_XMLOBJECT(XMLTOOL_API,EncryptedKey,EncryptedType,XML Encryption EncryptedKey element);
 142         DECL_STRING_ATTRIB(Recipient,RECIPIENT);
 143         DECL_TYPED_CHILD(ReferenceList);
 144         DECL_TYPED_CHILD(CarriedKeyName);
 145         /** EncryptedKeyType local name */
 146         static const XMLCh TYPE_NAME[];
 147     END_XMLOBJECT;
 148
 149     DECL_XMLENCOBJECTBUILDER(CarriedKeyName);
 150     DECL_XMLENCOBJECTBUILDER(CipherData);
 151     DECL_XMLENCOBJECTBUILDER(CipherReference);
 152     DECL_XMLENCOBJECTBUILDER(CipherValue);
 153     DECL_XMLENCOBJECTBUILDER(DataReference);
 154     DECL_XMLENCOBJECTBUILDER(EncryptedData);
 155     DECL_XMLENCOBJECTBUILDER(EncryptedKey);
 156     DECL_XMLENCOBJECTBUILDER(EncryptionMethod);
 157     DECL_XMLENCOBJECTBUILDER(EncryptionProperties);
 158     DECL_XMLENCOBJECTBUILDER(EncryptionProperty);
 159     DECL_XMLENCOBJECTBUILDER(KeyReference);
 160     DECL_XMLENCOBJECTBUILDER(KeySize);
 161     DECL_XMLENCOBJECTBUILDER(OAEPparams);
 162     DECL_XMLENCOBJECTBUILDER(ReferenceList);
 163     DECL_XMLENCOBJECTBUILDER(Transforms);
 164
 165     /**
 166      * Registers builders and validators for XML Encryption classes into the runtime.
 167      */
 168     void XMLTOOL_API registerEncryptionClasses();
 169 };
 170
 171 #endif /* __xmltooling_encryption_h__ */