LibreOffice LibreOffice 5.3 SDK API Reference

Public Member Functions | List of all members
XDocumentDigitalSignatures Interface Reference

interface for signing and verifying digital signatures in office documents More...

`import"XDocumentDigitalSignatures.idl";`

Inheritance diagram for XDocumentDigitalSignatures:

## Public Member Functions
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. More...
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. More...
void | showDocumentContentSignatures ([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
| shows the digital signatures of the document content More...
string | getDocumentContentSignatureDefaultStreamName ()
| allows to get the default stream name for storing of the signature of the document content. More...
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 More...
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. More...
void | showScriptingContentSignatures ([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
| shows the digital signatures of the scripting content More...
string | getScriptingContentSignatureDefaultStreamName ()
| allows to get the default stream name for storing of the signature of the scripting content. More...
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 More...
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. More...
void | showPackageSignatures ([in] ::com::sun::star::embed::XStorage xStorage, [in] ::com::sun::star::io::XInputStream xSignInStream)
| shows the digital signatures of the package More...
string | getPackageSignatureDefaultStreamName ()
| allows to get the default stream name for storing of the signature of the package. More...
void | showCertificate ([in] com::sun::star::security::XCertificate Certificate)
void | manageTrustedSources ()
| manages trusted sources (Authors and paths ) More...
boolean | isAuthorTrusted ([in] com::sun::star::security::XCertificate Author)
boolean | isLocationTrusted ([in] string Location)
void | addAuthorToTrustedSources ([in] com::sun::star::security::XCertificate Author)
void | addLocationToTrustedSources ([in] string Location)
com::sun::star::security::XCertificate | chooseCertificate ([out] string Description)
| This method shows CertificateChooser dialog, used by document and PDF signing. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...

## Detailed Description

interface for signing and verifying digital signatures in office documents

This interface can be used to digitally sign different content in a office document. It can also be used to verify digital signatures.

## Member Function Documentation

## ◆ addAuthorToTrustedSources()

void addAuthorToTrustedSources | ( | [in] com::sun::star::security::XCertificate | Author | ) |

## ◆ addLocationToTrustedSources()

void addLocationToTrustedSources | ( | [in] string | Location | ) |

## ◆ chooseCertificate()

com::sun::star::security::XCertificate chooseCertificate | ( | [out] string | Description | ) |

This method shows CertificateChooser dialog, used by document and PDF signing.

Since
  LibreOffice 5.3

## ◆ getDocumentContentSignatureDefaultStreamName()

string getDocumentContentSignatureDefaultStreamName | ( |  | ) |

allows to get the default stream name for storing of the signature of the document content.

## ◆ getPackageSignatureDefaultStreamName()

string getPackageSignatureDefaultStreamName | ( |  | ) |

allows to get the default stream name for storing of the signature of the package.

## ◆ getScriptingContentSignatureDefaultStreamName()

string getScriptingContentSignatureDefaultStreamName | ( |  | ) |

allows to get the default stream name for storing of the signature of the scripting content.

## ◆ isAuthorTrusted()

boolean isAuthorTrusted | ( | [in] com::sun::star::security::XCertificate | Author | ) |

## ◆ isLocationTrusted()

boolean isLocationTrusted | ( | [in] string | Location | ) |

## ◆ manageTrustedSources()

void manageTrustedSources | ( |  | ) |

manages trusted sources (Authors and paths )

## ◆ showCertificate()

void showCertificate | ( | [in] com::sun::star::security::XCertificate | Certificate | ) |

## ◆ 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

## ◆ showPackageSignatures()

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

shows the digital signatures of the package

## ◆ 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

## ◆ 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.

Macros will not be signed.

## ◆ 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

## ◆ 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

The rest of document content will not be signed.

## ◆ 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.

Only document content will be checked.

## ◆ 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.

Only Package content will be checked.

## ◆ 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.

Only Scripting content will be checked.

The documentation for this interface was generated from the following file:

- com/sun/star/security/XDocumentDigitalSignatures.idl