LibreOffice: com/sun/star/security/XDocumentDigitalSignatures.idl Source File

LibreOffice LibreOffice 7.6 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module security {
21
30 interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
31{
36 boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
37 [in] ::com::sun::star::io::XStream xSignStream);
38
49 boolean signSignatureLine( [in] ::com::sun::star::embed::XStorage xStorage,
50 [in] ::com::sun::star::io::XStream xSignStream,
51 [in] string signatureLineId,
52 [in] ::com::sun::star::security::XCertificate xCertificate,
53 [in] ::com::sun::star::graphic::XGraphic xValidGraphic,
54 [in] ::com::sun::star::graphic::XGraphic xInvalidGraphic,
55 [in] string comment);
56
61 sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures(
62 [in] ::com::sun::star::embed::XStorage xStorage,
63 [in] ::com::sun::star::io::XInputStream xSignInStream );
64
67 void showDocumentContentSignatures(
68 [in] ::com::sun::star::embed::XStorage xStorage,
69 [in] ::com::sun::star::io::XInputStream xSignInStream );
70
74 string getDocumentContentSignatureDefaultStreamName();
75
80 boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
81 [in] ::com::sun::star::io::XStream xSignStream);
82
87 sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures(
88 [in] ::com::sun::star::embed::XStorage xStorage,
89 [in] ::com::sun::star::io::XInputStream xSignInStream );
90
93 void showScriptingContentSignatures(
94 [in] ::com::sun::star::embed::XStorage xStorage,
95 [in] ::com::sun::star::io::XInputStream xSignInStream );
96
100 string getScriptingContentSignatureDefaultStreamName();
101
104 boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
105 [in] ::com::sun::star::io::XStream xSignStream);
106
111 sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures(
112 [in] ::com::sun::star::embed::XStorage Storage,
113 [in] ::com::sun::star::io::XInputStream xSignInStream );
114
117 void showPackageSignatures(
118 [in] ::com::sun::star::embed::XStorage xStorage,
119 [in] ::com::sun::star::io::XInputStream xSignInStream );
120
124 string getPackageSignatureDefaultStreamName();
125
126
127 void showCertificate( [in] com::sun::star::security::XCertificate Certificate );
128
129
132 void manageTrustedSources();
133 boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
134 boolean isLocationTrusted( [in] string Location );
135
136 // These methods should raise a confirmation dialog, so they can not be misused from bad macros.
137 void addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
138 void addLocationToTrustedSources( [in] string Location );
139
145 com::sun::star::security::XCertificate chooseCertificate( [out] string Description );
146
152 com::sun::star::security::XCertificate chooseSigningCertificate( [out] string Description );
153
159 com::sun::star::security::XCertificate selectSigningCertificate( [out] string Description );
160
166 com::sun::star::security::XCertificate selectSigningCertificateWithType(
167 [in] CertificateKind certificateKind,
168 [out] string Description);
169
175 sequence< com::sun::star::security::XCertificate > chooseEncryptionCertificate( );
176
182 com::sun::star::security::XCertificate chooseCertificateWithProps( [out] sequence<::com::sun::star::beans::PropertyValue> Properties);
183
188 boolean signDocumentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
189 [in] ::com::sun::star::embed::XStorage xStorage,
190 [in] ::com::sun::star::io::XStream xStream);
191
196 void setParentWindow([in] ::com::sun::star::awt::XWindow xParentWindow);
197
204 boolean signScriptingContentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
205 [in] ::com::sun::star::embed::XStorage xStorage,
206 [in] ::com::sun::star::io::XStream xStream);
207
212 boolean signPackageWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
213 [in] ::com::sun::star::embed::XStorage xStorage,
214 [in] ::com::sun::star::io::XStream xStream);
215};
216
217} ; } ; } ; } ;
218
219/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition XWindow.idl:33
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition XStorage.idl:27
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition XGraphic.idl:38
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition XInputStream.idl:30
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition XStream.idl:27
com::sun::star::security::XCertificate
Interface of a PKI Certificate.
Definition XCertificate.idl:28
com::sun::star::security::XDocumentDigitalSignatures
Interface for signing and verifying digital signatures in office documents.
Definition XDocumentDigitalSignatures.idl:31
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:46
com::sun::star::security::CertificateKind
CertificateKind
Enum definition of a certificate kind ( X509, OpenPGP )
Definition CertificateKind.idl:18
com
Definition Ambiguous.idl:20