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