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