summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl
blob: 7964cca22897d008d0204c3bea4ed893b0272fbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XXMLEncryptionTemplate.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

//i20156 - new file for xmlsecurity module

/** -- idl definition -- **/

#ifndef __com_sun_star_xml_crypto_xxmlencryptiontemplate_idl_
#define __com_sun_star_xml_crypto_xxmlencryptiontemplate_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
#include <com/sun/star/xml/crypto/XXMLSecurityTemplate.idl>

module com { module sun { module star { module xml { module crypto {

/**
 * Interface of XML encryption template
 *
 * <p>This interface represents a encryption template, which is the same as the
 * desired xml encryption element[ EncryptedType ] but some of the nodes may be
 * empty. The empty entities include CipherValue, which is a subset of
 * EncryptedData or EncryptedKey. Empty entities are not allowed in a encryption
 * template when performing decryption.</p>
 *
 * <p>In some cases, the encrypter or decrypter can dertermine and locate the
 * EncrytedKey from the encryption template by dereference the RetrievalMethod
 * inside EncryptedData.</p>
 *
 * <p>In some cases, the EncryptedKey need to be clearly pointed out by the
 * encryption template.</p>
 *
 * <p>With the help of encryption context, the encrypter or decrypter specifies
 * the key from the KeyInfo in the encryption template.</p>
 *
 *
 * <p>It isn't a good method to set the EncryptedKey here. In general, there is
 * a RetrievalMethod in EncryptedData by which we can get the EncryptedKey.
 *
 * And some times, in the low level, it is hard to determine what the key is
 * except that the high level application tell the mechanism and parameters.
 *
 * So I think it will be more simple that the application set the encrypted key
 * information. In this case, the application only need to know the xml schema
 * or DTD and the encryption device. If so, the high level application takes the
 * action of build the EncryptedKey template and references it in the element of
 * EncryptedData. And in this case, the calling to set up EncryptedKey template
 * and target is not necessary, because the encrypter or decrypter can determine
 * and locate the EncrypedKet from the encryption template of EncryptedData by
 * dereference the RetrievalMethod.
 *
 * In some situation, the high level applications do not want to know anything
 * about crypto devices( May be he must, because the lower level do not know
 * what the key is ). If it gives the key value, it can get EncryptedKey by
 * setting the key template and key value target.</p>
 */
interface XXMLEncryptionTemplate : XXMLSecurityTemplate
{
    /**
     * Get the target xml element, i.e. the element to be encrypted
     */
    com::sun::star::xml::wrapper::XXMLElementWrapper getTarget(
    ) ;
} ;


} ; } ; } ; } ; } ;


#endif