LibreOffice LibreOffice 6.2 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/uno/XInterface.idl>
24 #include <com/sun/star/io/XInputStream.idl>
25 #include <com/sun/star/io/XStream.idl>
26 #include <com/sun/star/embed/XStorage.idl>
27 #include <com/sun/star/security/DocumentSignatureInformation.idl>
28 #include <com/sun/star/security/XCertificate.idl>
29
30 module com { module sun { module star { module security {
31
40 interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
41 {
46 boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
47 [in] ::com::sun::star::io::XStream xSignStream);
48
59 boolean signSignatureLine( [in] ::com::sun::star::embed::XStorage xStorage,
60 [in] ::com::sun::star::io::XStream xSignStream,
61 [in] string signatureLineId,
62 [in] ::com::sun::star::security::XCertificate xCertificate,
63 [in] ::com::sun::star::graphic::XGraphic xValidGraphic,
64 [in] ::com::sun::star::graphic::XGraphic xInvalidGraphic,
65 [in] string comment);
66
71 sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures(
72 [in] ::com::sun::star::embed::XStorage xStorage,
73 [in] ::com::sun::star::io::XInputStream xSignInStream );
74
77 void showDocumentContentSignatures(
78 [in] ::com::sun::star::embed::XStorage xStorage,
79 [in] ::com::sun::star::io::XInputStream xSignInStream );
80
84 string getDocumentContentSignatureDefaultStreamName();
85
90 boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
91 [in] ::com::sun::star::io::XStream xSignStream);
92
97 sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures(
98 [in] ::com::sun::star::embed::XStorage xStorage,
99 [in] ::com::sun::star::io::XInputStream xSignInStream );
100
103 void showScriptingContentSignatures(
104 [in] ::com::sun::star::embed::XStorage xStorage,
105 [in] ::com::sun::star::io::XInputStream xSignInStream );
106
110 string getScriptingContentSignatureDefaultStreamName();
111
114 boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
115 [in] ::com::sun::star::io::XStream xSignStream);
116
121 sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures(
122 [in] ::com::sun::star::embed::XStorage Storage,
123 [in] ::com::sun::star::io::XInputStream xSignInStream );
124
127 void showPackageSignatures(
128 [in] ::com::sun::star::embed::XStorage xStorage,
129 [in] ::com::sun::star::io::XInputStream xSignInStream );
130
134 string getPackageSignatureDefaultStreamName();
135
136
137 void showCertificate( [in] com::sun::star::security::XCertificate Certificate );
138
139
142 void manageTrustedSources();
143 boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
144 boolean isLocationTrusted( [in] string Location );
145
146 // These methods should raise a confirmation dialog, so they can not be misused from bad macros.
147 void addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
148 void addLocationToTrustedSources( [in] string Location );
149
155 com::sun::star::security::XCertificate chooseCertificate( [out] string Description );
156
162 com::sun::star::security::XCertificate chooseSigningCertificate( [out] string Description );
163
169 com::sun::star::security::XCertificate selectSigningCertificate( [out] string Description );
170
176 com::sun::star::security::XCertificate selectSigningCertificateWithType(
177 [in] CertificateKind certificateKind,
178 [out] string Description);
179
185 sequence< com::sun::star::security::XCertificate > chooseEncryptionCertificate( );
186
192 com::sun::star::security::XCertificate chooseCertificateWithProps( [out] sequence<::com::sun::star::beans::PropertyValue> Properties);
193
198 boolean signDocumentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
199 [in] ::com::sun::star::embed::XStorage xStorage,
200 [in] ::com::sun::star::io::XStream xStream);
201
202 };
203
204 } ; } ; } ; } ;
205
206 #endif
207
208 /* 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::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
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:40
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