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

   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
  32 /** interface for signing and verifying digital signatures in office documents
  33
  34     <p>
  35     This interface can be used to digitally sign different content in a office document.
  36     It can also be used to verify digital signatures.
  37     </p>
  38  */
  39
  40 interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
  41 {
  42     /** signs the content of the document including text and pictures.
  43
  44        <p>Macros will not be signed.</p>
  45      */
  46     boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
  47                                  [in] ::com::sun::star::io::XStream xSignStream);
  48
  49     /** checks for digital signatures and their status.
  50
  51         <p>Only document content will be checked.</p>
  52      */
  53     sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures(
  54                                 [in] ::com::sun::star::embed::XStorage xStorage,
  55                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  56
  57     /** shows the digital signatures of the document content
  58      */
  59     void showDocumentContentSignatures(
  60                                 [in] ::com::sun::star::embed::XStorage xStorage,
  61                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  62
  63     /** allows to get the default stream name for storing of the signature of
  64         the document content.
  65      */
  66     string getDocumentContentSignatureDefaultStreamName();
  67
  68     /** signs the content of the Scripting including macros and basic dialogs
  69
  70         <p>The rest of document content will not be signed.</p>
  71      */
  72     boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
  73                                   [in] ::com::sun::star::io::XStream xSignStream);
  74
  75     /** checks for digital signatures and their status.
  76
  77         <p>Only Scripting content will be checked.</p>
  78      */
  79     sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures(
  80                                 [in] ::com::sun::star::embed::XStorage xStorage,
  81                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  82
  83     /** shows the digital signatures of the scripting content
  84      */
  85     void showScriptingContentSignatures(
  86                                 [in] ::com::sun::star::embed::XStorage xStorage,
  87                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  88
  89     /** allows to get the default stream name for storing of the signature of
  90         the scripting content.
  91      */
  92     string getScriptingContentSignatureDefaultStreamName();
  93
  94     /** signs the full Package, which means everything in the storage except the content of META-INF
  95      */
  96     boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
  97                          [in] ::com::sun::star::io::XStream xSignStream);
  98
  99     /** checks for digital signatures and their status.
 100
 101         <p>Only Package content will be checked.</p>
 102      */
 103     sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures(
 104                         [in] ::com::sun::star::embed::XStorage Storage,
 105                         [in] ::com::sun::star::io::XInputStream xSignInStream );
 106
 107     /** shows the digital signatures of the package
 108      */
 109     void showPackageSignatures(
 110                         [in] ::com::sun::star::embed::XStorage xStorage,
 111                         [in] ::com::sun::star::io::XInputStream xSignInStream );
 112
 113     /** allows to get the default stream name for storing of the signature of
 114         the package.
 115      */
 116     string getPackageSignatureDefaultStreamName();
 117
 118
 119     void showCertificate( [in] com::sun::star::security::XCertificate Certificate );
 120
 121
 122        /** manages trusted sources (Authors and paths )
 123      */
 124
 125     void    manageTrustedSources();
 126     boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
 127     boolean isLocationTrusted( [in] string Location );
 128
 129     // These method should raise confirmation dialog, so it can not used from bad macros...
 130     void    addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
 131     void    addLocationToTrustedSources( [in] string Location );
 132
 133     /**  This method shows CertificateChooser dialog, used by document and PDF signing
 134      */
 135     com::sun::star::security::XCertificate chooseCertificate();
 136
 137 } ;
 138
 139 } ; } ; } ; } ;
 140
 141 #endif
 142
 143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */