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