diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl')
-rw-r--r-- | offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl b/offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl new file mode 100644 index 0000000000..33f17d470d --- /dev/null +++ b/offapi/com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl @@ -0,0 +1,73 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +module com { module sun { module star { module xml { module crypto { + +/** + * Interface of XML encryption template + * + * <p>This interface represents an 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 an encryption + * template when performing decryption.</p> + * + * <p>In some cases, the encryptor or decryptor can determine and locate the + * EncryptedKey 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 encryptor or decryptor 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 sometimes, 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 encryptor or decryptor can determine + * and locate the EncryptedKey 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( + ) ; +} ; + +} ; } ; } ; } ; } ; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |