:: com :: sun :: star :: security ::

interface XDocumentDigitalSignatures

Methods' Summary
signDocumentContent signs the content of the document including text and pictures.  
signSignatureLine Signs the content of the document including text and pictures using the given XCertificate. Also adds the given Signature Line Id and the signed and unsigned graphics to the signature. Macros will not be signed.
Since LibreOffice 6.1  
verifyDocumentContentSignatures checks for digital signatures and their status.  
showDocumentContentSignatures shows the digital signatures of the document content  
getDocumentContentSignatureDefaultStreamName allows to get the default stream name for storing of the signature of the document content.  
signScriptingContent signs the content of the Scripting including macros and basic dialogs  
verifyScriptingContentSignatures checks for digital signatures and their status.  
showScriptingContentSignatures shows the digital signatures of the scripting content  
getScriptingContentSignatureDefaultStreamName allows to get the default stream name for storing of the signature of the scripting content.  
signPackage signs the full Package, which means everything in the storage except the content of META-INF  
verifyPackageSignatures checks for digital signatures and their status.  
showPackageSignatures shows the digital signatures of the package  
getPackageSignatureDefaultStreamName allows to get the default stream name for storing of the signature of the package.  
showCertificate  
manageTrustedSources manages trusted sources (Authors and paths )  
isAuthorTrusted  
isLocationTrusted  
addAuthorToTrustedSources  
addLocationToTrustedSources  
chooseCertificate This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private certificates
Since LibreOffice 5.3  
chooseSigningCertificate This is an alias for 'chooseCertificate', shows the CertificateChooser dialog with private certificates
Since LibreOffice 6.0  
selectSigningCertificate This shows the certificate selection dialog and allows to only select the certificate without actually signing the document.
Since LibreOffice 6.1  
selectSigningCertificateWithType This shows the certificate selection dialog and allows to only select the certificate without actually signing the document. Only certificates of the given type will be shown.
Since LibreOffice 6.2  
chooseEncryptionCertificate This method shows the CertificateChooser dialog with all certificates, private and other people's. Useful when choosing certificate/key for encryption
Since LibreOffice 6.0  
chooseCertificateWithProps This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private certificates and returns usage string in addition to description.
Since LibreOffice 6.0  
signDocumentWithCertificate Signs the content of the document with the provided certificate.
Since LibreOffice 6.2  
setParentWindow Set parent window to use when showing dialogs
Since LibreOffice 6.3  
Methods' Details
signDocumentContent
boolean
signDocumentContent( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XStream  xSignStream );

Description
signs the content of the document including text and pictures.

Macros will not be signed.

signSignatureLine
boolean
signSignatureLine( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XStream  xSignStream,
[in] string  signatureLineId,
[in] XCertificate  xCertificate,
[in] ::com::sun::star::graphic::XGraphic  xValidGraphic,
[in] ::com::sun::star::graphic::XGraphic  xInvalidGraphic,
[in] string  comment );

Description
Signs the content of the document including text and pictures using the given XCertificate. Also adds the given Signature Line Id and the signed and unsigned graphics to the signature. Macros will not be signed.
Since LibreOffice 6.1
verifyDocumentContentSignatures
sequence< DocumentSignatureInformation >
verifyDocumentContentSignatures( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
checks for digital signatures and their status.

Only document content will be checked.

showDocumentContentSignatures
void
showDocumentContentSignatures( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
shows the digital signatures of the document content
getDocumentContentSignatureDefaultStreamName
string
getDocumentContentSignatureDefaultStreamName();

Description
allows to get the default stream name for storing of the signature of the document content.
signScriptingContent
boolean
signScriptingContent( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XStream  xSignStream );

Description
signs the content of the Scripting including macros and basic dialogs

The rest of document content will not be signed.

verifyScriptingContentSignatures
sequence< DocumentSignatureInformation >
verifyScriptingContentSignatures( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
checks for digital signatures and their status.

Only Scripting content will be checked.

showScriptingContentSignatures
void
showScriptingContentSignatures( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
shows the digital signatures of the scripting content
getScriptingContentSignatureDefaultStreamName
string
getScriptingContentSignatureDefaultStreamName();

Description
allows to get the default stream name for storing of the signature of the scripting content.
signPackage
boolean
signPackage( [in] ::com::sun::star::embed::XStorage  Storage,
[in] ::com::sun::star::io::XStream  xSignStream );

Description
signs the full Package, which means everything in the storage except the content of META-INF
verifyPackageSignatures
sequence< DocumentSignatureInformation >
verifyPackageSignatures( [in] ::com::sun::star::embed::XStorage  Storage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
checks for digital signatures and their status.

Only Package content will be checked.

showPackageSignatures
void
showPackageSignatures( [in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XInputStream  xSignInStream );

Description
shows the digital signatures of the package
getPackageSignatureDefaultStreamName
string
getPackageSignatureDefaultStreamName();

Description
allows to get the default stream name for storing of the signature of the package.
showCertificate
void
showCertificate( [in] XCertificate  Certificate );

manageTrustedSources
void
manageTrustedSources();

Description
manages trusted sources (Authors and paths )
isAuthorTrusted
boolean
isAuthorTrusted( [in] XCertificate  Author );

isLocationTrusted
boolean
isLocationTrusted( [in] string  Location );

addAuthorToTrustedSources
void
addAuthorToTrustedSources( [in] XCertificate  Author );

addLocationToTrustedSources
void
addLocationToTrustedSources( [in] string  Location );

chooseCertificate
XCertificate
chooseCertificate( [out] string  Description );

Description
This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private certificates
Since LibreOffice 5.3
chooseSigningCertificate
XCertificate
chooseSigningCertificate( [out] string  Description );

Description
This is an alias for 'chooseCertificate', shows the CertificateChooser dialog with private certificates
Since LibreOffice 6.0
selectSigningCertificate
XCertificate
selectSigningCertificate( [out] string  Description );

Description
This shows the certificate selection dialog and allows to only select the certificate without actually signing the document.
Since LibreOffice 6.1
selectSigningCertificateWithType
XCertificate
selectSigningCertificateWithType( [in] CertificateKind  certificateKind,
[out] string  Description );

Description
This shows the certificate selection dialog and allows to only select the certificate without actually signing the document. Only certificates of the given type will be shown.
Since LibreOffice 6.2
chooseEncryptionCertificate
sequence< XCertificate >
chooseEncryptionCertificate();

Description
This method shows the CertificateChooser dialog with all certificates, private and other people's. Useful when choosing certificate/key for encryption
Since LibreOffice 6.0
chooseCertificateWithProps
XCertificate
chooseCertificateWithProps( [out] sequence< ::com::sun::star::beans::PropertyValue >  Properties );

Description
This method shows the CertificateChooser dialog, used by document and PDF signing Shows only private certificates and returns usage string in addition to description.
Since LibreOffice 6.0
signDocumentWithCertificate
boolean
signDocumentWithCertificate( [in] XCertificate  xCertificate,
[in] ::com::sun::star::embed::XStorage  xStorage,
[in] ::com::sun::star::io::XStream  xStream );

Description
Signs the content of the document with the provided certificate.
Since LibreOffice 6.2
setParentWindow
void
setParentWindow( [in] ::com::sun::star::awt::XWindow  xParentWindow );

Description
Set parent window to use when showing dialogs
Since LibreOffice 6.3
Top of Page