LibreOffice LibreOffice 25.2 SDK API Reference

XPackageEncryption.idl
Go to the documentation of this file.
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
21module com { module sun { module star { module packages {
22
23
28 interface XPackageEncryption: com::sun::star::uno::XInterface
29{
39 boolean readEncryptionInfo([in] sequence < com::sun::star::beans::NamedValue > rStreams);
40
49 boolean generateEncryptionKey([in] string rPassword);
50
65 boolean decrypt([in] com::sun::star::io::XInputStream rxInputStream,
66 [out] com::sun::star::io::XOutputStream rxOutputStream);
67
84 sequence<com::sun::star::beans::NamedValue> createEncryptionData([in] string rPassword);
85
96 boolean setupEncryption([in] sequence<com::sun::star::beans::NamedValue> rMediaEncData);
97
108 sequence<com::sun::star::beans::NamedValue> encrypt([in] com::sun::star::io::XInputStream rxInputStream);
109
119 boolean checkDataIntegrity();
120};
121
122
123}; }; }; };
124
125/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:30
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition: XOutputStream.idl:30
com::sun::star::packages::XPackageEncryption
Allows to transparently plug-in crypto for PackageStreams.
Definition: XPackageEncryption.idl:29
com::sun::star::packages::XPackageEncryption::readEncryptionInfo
boolean readEncryptionInfo([in] sequence< com::sun::star::beans::NamedValue > rStreams)
Read package crypto information.
com::sun::star::packages::XPackageEncryption::encrypt
sequence< com::sun::star::beans::NamedValue > encrypt([in] com::sun::star::io::XInputStream rxInputStream)
Encrypt given stream.
com::sun::star::packages::XPackageEncryption::decrypt
boolean decrypt([in] com::sun::star::io::XInputStream rxInputStream, [out] com::sun::star::io::XOutputStream rxOutputStream)
Decrypt document content.
com::sun::star::packages::XPackageEncryption::generateEncryptionKey
boolean generateEncryptionKey([in] string rPassword)
Set or refresh encryption key.
com::sun::star::packages::XPackageEncryption::setupEncryption
boolean setupEncryption([in] sequence< com::sun::star::beans::NamedValue > rMediaEncData)
Set key-value list of encryption meta data.
com::sun::star::packages::XPackageEncryption::checkDataIntegrity
boolean checkDataIntegrity()
Check if decryption meta data is valid.
com::sun::star::packages::XPackageEncryption::createEncryptionData
sequence< com::sun::star::beans::NamedValue > createEncryptionData([in] string rPassword)
Create key-value list of encryption meta data.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20