offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_xml_crypto_xxmlencryptiontemplate_idl_
  21 #define __com_sun_star_xml_crypto_xxmlencryptiontemplate_idl_
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
  26 #include <com/sun/star/xml/crypto/XXMLSecurityTemplate.idl>
  27
  28 module com { module sun { module star { module xml { module crypto {
  29
  30 /**
  31  * Interface of XML encryption template
  32  *
  33  * <p>This interface represents a encryption template, which is the same as the
  34  * desired XML encryption element[ EncryptedType ] but some of the nodes may be
  35  * empty. The empty entities include CipherValue, which is a subset of
  36  * EncryptedData or EncryptedKey. Empty entities are not allowed in a encryption
  37  * template when performing decryption.</p>
  38  *
  39  * <p>In some cases, the encryptor or decryptor can determine and locate the
  40  * EncryptedKey from the encryption template by dereference the RetrievalMethod
  41  * inside EncryptedData.</p>
  42  *
  43  * <p>In some cases, the EncryptedKey need to be clearly pointed out by the
  44  * encryption template.</p>
  45  *
  46  * <p>With the help of encryption context, the encryptor or decryptor specifies
  47  * the key from the KeyInfo in the encryption template.</p>
  48  *
  49  *
  50  * <p>It isn't a good method to set the EncryptedKey here. In general, there is
  51  * a RetrievalMethod in EncryptedData by which we can get the EncryptedKey.
  52  *
  53  * And some times, in the low level, it is hard to determine what the key is
  54  * except that the high level application tell the mechanism and parameters.
  55  *
  56  * So I think it will be more simple that the application set the encrypted key
  57  * information. In this case, the application only need to know the XML schema
  58  * or DTD and the encryption device. If so, the high level application takes the
  59  * action of build the EncryptedKey template and references it in the element of
  60  * EncryptedData. And in this case, the calling to set up EncryptedKey template
  61  * and target is not necessary, because the encryptor or decryptor can determine
  62  * and locate the EncryptedKey from the encryption template of EncryptedData by
  63  * dereference the RetrievalMethod.
  64  *
  65  * In some situation, the high level applications do not want to know anything
  66  * about crypto devices( May be he must, because the lower level do not know
  67  * what the key is ). If it gives the key value, it can get EncryptedKey by
  68  * setting the key template and key value target.</p>
  69  */
  70 interface XXMLEncryptionTemplate : XXMLSecurityTemplate
  71 {
  72     /**
  73      * Get the target XML element, i.e. the element to be encrypted
  74      */
  75     com::sun::star::xml::wrapper::XXMLElementWrapper getTarget(
  76     ) ;
  77 } ;
  78
  79 } ; } ; } ; } ; } ;
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */