LibreOffice LibreOffice 7.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/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
31module 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
215 boolean signScriptingContentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
216 [in] ::com::sun::star::embed::XStorage xStorage,
217 [in] ::com::sun::star::io::XStream xStream);
218
223 boolean signPackageWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
224 [in] ::com::sun::star::embed::XStorage xStorage,
225 [in] ::com::sun::star::io::XStream xStream);
226};
227
228} ; } ; } ; } ;
229
230#endif
231
232/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
DocumentSignatureInformation.idl
XCertificate.idl
XInputStream.idl
XInterface.idl
XStorage.idl
XStream.idl
XWindow.idl
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition: XWindow.idl:51
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:44
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:44
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:38
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:33
com::sun::star::security::XCertificate
Interface of a PKI Certificate.
Definition: XCertificate.idl:36
com::sun::star::security::XDocumentDigitalSignatures
Interface for signing and verifying digital signatures in office documents.
Definition: XDocumentDigitalSignatures.idl:42
com::sun::star::security::XDocumentDigitalSignatures::setParentWindow
void setParentWindow([in] ::com::sun::star::awt::XWindow xParentWindow)
Set parent window to use when showing dialogs.
com::sun::star::security::XDocumentDigitalSignatures::getScriptingContentSignatureDefaultStreamName
string getScriptingContentSignatureDefaultStreamName()
allows to get the default stream name for storing of the signature of the scripting content.
com::sun::star::security::XDocumentDigitalSignatures::chooseSigningCertificate
com::sun::star::security::XCertificate chooseSigningCertificate([out] string Description)
This is an alias for 'chooseCertificate', shows the CertificateChooser dialog with private certificat...
com::sun::star::security::XDocumentDigitalSignatures::signScriptingContentWithCertificate
boolean signScriptingContentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate, [in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xStream)
signs the content of the Scripting including macros and basic dialogs with the provided certificate.
com::sun::star::security::XDocumentDigitalSignatures::showScriptingContentSignatures
void showScriptingContentSignatures([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
shows the digital signatures of the scripting content
com::sun::star::security::XDocumentDigitalSignatures::chooseCertificateWithProps
com::sun::star::security::XCertificate chooseCertificateWithProps([out] sequence<::com::sun::star::beans::PropertyValue > Properties)
This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private ...
com::sun::star::security::XDocumentDigitalSignatures::signDocumentContent
boolean signDocumentContent([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xSignStream)
signs the content of the document including text and pictures.
com::sun::star::security::XDocumentDigitalSignatures::chooseCertificate
com::sun::star::security::XCertificate chooseCertificate([out] string Description)
This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private ...
com::sun::star::security::XDocumentDigitalSignatures::getPackageSignatureDefaultStreamName
string getPackageSignatureDefaultStreamName()
allows to get the default stream name for storing of the signature of the package.
com::sun::star::security::XDocumentDigitalSignatures::signPackageWithCertificate
boolean signPackageWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate, [in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xStream)
signs the full Package, which means everything in the storage except the content of META-INF with the...
com::sun::star::security::XDocumentDigitalSignatures::isAuthorTrusted
boolean isAuthorTrusted([in] com::sun::star::security::XCertificate Author)
com::sun::star::security::XDocumentDigitalSignatures::addAuthorToTrustedSources
void addAuthorToTrustedSources([in] com::sun::star::security::XCertificate Author)
com::sun::star::security::XDocumentDigitalSignatures::signScriptingContent
boolean signScriptingContent([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xSignStream)
signs the content of the Scripting including macros and basic dialogs
com::sun::star::security::XDocumentDigitalSignatures::signSignatureLine
boolean signSignatureLine([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xSignStream, [in] string signatureLineId, [in] ::com::sun::star::security::XCertificate xCertificate, [in] ::com::sun::star::graphic::XGraphic xValidGraphic, [in] ::com::sun::star::graphic::XGraphic xInvalidGraphic, [in] string comment)
Signs the content of the document including text and pictures using the given XCertificate.
com::sun::star::security::XDocumentDigitalSignatures::verifyScriptingContentSignatures
sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
checks for digital signatures and their status.
com::sun::star::security::XDocumentDigitalSignatures::showDocumentContentSignatures
void showDocumentContentSignatures([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
shows the digital signatures of the document content
com::sun::star::security::XDocumentDigitalSignatures::showCertificate
void showCertificate([in] com::sun::star::security::XCertificate Certificate)
com::sun::star::security::XDocumentDigitalSignatures::manageTrustedSources
void manageTrustedSources()
manages trusted sources (Authors and paths )
com::sun::star::security::XDocumentDigitalSignatures::selectSigningCertificate
com::sun::star::security::XCertificate selectSigningCertificate([out] string Description)
This shows the certificate selection dialog and allows to only select the certificate without actuall...
com::sun::star::security::XDocumentDigitalSignatures::verifyPackageSignatures
sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures([in] ::com::sun::star::embed::XStorage Storage, [in] ::com::sun::star::io::XInputStream xSignInStream)
checks for digital signatures and their status.
com::sun::star::security::XDocumentDigitalSignatures::verifyDocumentContentSignatures
sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
checks for digital signatures and their status.
com::sun::star::security::XDocumentDigitalSignatures::selectSigningCertificateWithType
com::sun::star::security::XCertificate selectSigningCertificateWithType([in] CertificateKind certificateKind, [out] string Description)
This shows the certificate selection dialog and allows to only select the certificate without actuall...
com::sun::star::security::XDocumentDigitalSignatures::isLocationTrusted
boolean isLocationTrusted([in] string Location)
com::sun::star::security::XDocumentDigitalSignatures::addLocationToTrustedSources
void addLocationToTrustedSources([in] string Location)
com::sun::star::security::XDocumentDigitalSignatures::signDocumentWithCertificate
boolean signDocumentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate, [in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XStream xStream)
Signs the content of the document with the provided certificate.
com::sun::star::security::XDocumentDigitalSignatures::signPackage
boolean signPackage([in] ::com::sun::star::embed::XStorage Storage, [in] ::com::sun::star::io::XStream xSignStream)
signs the full Package, which means everything in the storage except the content of META-INF
com::sun::star::security::XDocumentDigitalSignatures::showPackageSignatures
void showPackageSignatures([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
shows the digital signatures of the package
com::sun::star::security::XDocumentDigitalSignatures::chooseEncryptionCertificate
sequence< com::sun::star::security::XCertificate > chooseEncryptionCertificate()
This method shows the CertificateChooser dialog with all certificates, private and other people's.
com::sun::star::security::XDocumentDigitalSignatures::getDocumentContentSignatureDefaultStreamName
string getDocumentContentSignatureDefaultStreamName()
allows to get the default stream name for storing of the signature of the document content.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::security::CertificateKind
CertificateKind
Enum definition of a certificate kind ( X509, OpenPGP )
Definition: CertificateKind.idl:21
com
Definition: Accessible.idl:22