xmltooling/encryption/Encryption.h

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