LibreOffice LibreOffice 6.4 SDK API Reference

XDocumentDigitalSignatures.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 #ifndef __com_sun_star_security_XDocumentDigitalSignatures_idl_
21 #define __com_sun_star_security_XDocumentDigitalSignatures_idl_
22
23 #include <com/sun/star/awt/XWindow.idl>
24 #include <com/sun/star/uno/XInterface.idl>
25 #include <com/sun/star/io/XInputStream.idl>
26 #include <com/sun/star/io/XStream.idl>
27 #include <com/sun/star/embed/XStorage.idl>
28 #include <com/sun/star/security/DocumentSignatureInformation.idl>
29 #include <com/sun/star/security/XCertificate.idl>
30
31 module com { module sun { module star { module security {
32
41 interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
42 {
47 boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
48 [in] ::com::sun::star::io::XStream xSignStream);
49
60 boolean signSignatureLine( [in] ::com::sun::star::embed::XStorage xStorage,
61 [in] ::com::sun::star::io::XStream xSignStream,
62 [in] string signatureLineId,
63 [in] ::com::sun::star::security::XCertificate xCertificate,
64 [in] ::com::sun::star::graphic::XGraphic xValidGraphic,
65 [in] ::com::sun::star::graphic::XGraphic xInvalidGraphic,
66 [in] string comment);
67
72 sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures(
73 [in] ::com::sun::star::embed::XStorage xStorage,
74 [in] ::com::sun::star::io::XInputStream xSignInStream );
75
78 void showDocumentContentSignatures(
79 [in] ::com::sun::star::embed::XStorage xStorage,
80 [in] ::com::sun::star::io::XInputStream xSignInStream );
81
85 string getDocumentContentSignatureDefaultStreamName();
86
91 boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
92 [in] ::com::sun::star::io::XStream xSignStream);
93
98 sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures(
99 [in] ::com::sun::star::embed::XStorage xStorage,
100 [in] ::com::sun::star::io::XInputStream xSignInStream );
101
104 void showScriptingContentSignatures(
105 [in] ::com::sun::star::embed::XStorage xStorage,
106 [in] ::com::sun::star::io::XInputStream xSignInStream );
107
111 string getScriptingContentSignatureDefaultStreamName();
112
115 boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
116 [in] ::com::sun::star::io::XStream xSignStream);
117
122 sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures(
123 [in] ::com::sun::star::embed::XStorage Storage,
124 [in] ::com::sun::star::io::XInputStream xSignInStream );
125
128 void showPackageSignatures(
129 [in] ::com::sun::star::embed::XStorage xStorage,
130 [in] ::com::sun::star::io::XInputStream xSignInStream );
131
135 string getPackageSignatureDefaultStreamName();
136
137
138 void showCertificate( [in] com::sun::star::security::XCertificate Certificate );
139
140
143 void manageTrustedSources();
144 boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
145 boolean isLocationTrusted( [in] string Location );
146
147 // These methods should raise a confirmation dialog, so they can not be misused from bad macros.
148 void addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
149 void addLocationToTrustedSources( [in] string Location );
150
156 com::sun::star::security::XCertificate chooseCertificate( [out] string Description );
157
163 com::sun::star::security::XCertificate chooseSigningCertificate( [out] string Description );
164
170 com::sun::star::security::XCertificate selectSigningCertificate( [out] string Description );
171
177 com::sun::star::security::XCertificate selectSigningCertificateWithType(
178 [in] CertificateKind certificateKind,
179 [out] string Description);
180
186 sequence< com::sun::star::security::XCertificate > chooseEncryptionCertificate( );
187
193 com::sun::star::security::XCertificate chooseCertificateWithProps( [out] sequence<::com::sun::star::beans::PropertyValue> Properties);
194
199 boolean signDocumentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
200 [in] ::com::sun::star::embed::XStorage xStorage,
201 [in] ::com::sun::star::io::XStream xStream);
202
207 void setParentWindow([in] ::com::sun::star::awt::XWindow xParentWindow);
208 };
209
210 } ; } ; } ; } ;
211
212 #endif
213
214 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:43
XStorage.idl
com
Definition: Ambiguous.idl:22
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition: XWindow.idl:50
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:32
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
com::sun::star::security::CertificateKind
CertificateKind
Enum definition of a certificate kind ( X509, OpenPGP )
Definition: CertificateKind.idl:20
XInterface.idl
XWindow.idl
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:37
com::sun::star::security::XDocumentDigitalSignatures
Interface for signing and verifying digital signatures in office documents.
Definition: XDocumentDigitalSignatures.idl:41
XCertificate.idl
XInputStream.idl
XStream.idl
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:47
DocumentSignatureInformation.idl
com::sun::star::security::XCertificate
Interface of a PKI Certificate.
Definition: XCertificate.idl:35