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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDocumentDigitalSignatures.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 //i20156 - new file for xmlsecurity module
  32
  33 /** -- idl definition -- **/
  34
  35 #ifndef __com_sun_star_security_XDocumentDigitalSignatures_idl_
  36 #define __com_sun_star_security_XDocumentDigitalSignatures_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/io/XInputStream.idl>
  40 #include <com/sun/star/io/XStream.idl>
  41 #include <com/sun/star/embed/XStorage.idl>
  42 #include <com/sun/star/security/DocumentSignatureInformation.idl>
  43 #include <com/sun/star/security/XCertificate.idl>
  44
  45 module com { module sun { module star { module security {
  46
  47 /** interface for signing and verifying digital signatures in office documents
  48
  49     <p>
  50     This interface can be used to digitaly sign different content in a office document.
  51     It can also be used to verify digital signatures.
  52     </p>
  53  */
  54
  55 interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
  56 {
  57     /** signs the content of the document including text and pictures.
  58
  59        <p>Macros will not be signed.</p>
  60      */
  61     boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
  62                                  [in] ::com::sun::star::io::XStream xSignStream);
  63
  64     /** checks for digital signatures and their status.
  65
  66         <p>Only document content will be checked.</p>
  67      */
  68     sequence< com::sun::star::security::DocumentSignatureInformation > verifyDocumentContentSignatures(
  69                                 [in] ::com::sun::star::embed::XStorage xStorage,
  70                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  71
  72     /** shows the digital signatures of the document content
  73      */
  74     void showDocumentContentSignatures(
  75                                 [in] ::com::sun::star::embed::XStorage xStorage,
  76                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  77
  78     /** allows to get the default stream name for storing of the signature of
  79         the document content.
  80      */
  81     string getDocumentContentSignatureDefaultStreamName();
  82
  83     /** signs the content of the Scripting including macros and basic dialogs
  84
  85         <p>The rest of document content will not be signed.</p>
  86      */
  87     boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
  88                                   [in] ::com::sun::star::io::XStream xSignStream);
  89
  90     /** checks for digital signatures and their status.
  91
  92         <p>Only Scripting content will be checked.</p>
  93      */
  94     sequence< com::sun::star::security::DocumentSignatureInformation > verifyScriptingContentSignatures(
  95                                 [in] ::com::sun::star::embed::XStorage xStorage,
  96                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
  97
  98     /** shows the digital signatures of the scripting content
  99      */
 100     void showScriptingContentSignatures(
 101                                 [in] ::com::sun::star::embed::XStorage xStorage,
 102                                 [in] ::com::sun::star::io::XInputStream xSignInStream );
 103
 104     /** allows to get the default stream name for storing of the signature of
 105         the scripting content.
 106      */
 107     string getScriptingContentSignatureDefaultStreamName();
 108
 109     /** signs the full Package, which means everything in the storage excecpt the content of META-INF
 110      */
 111     boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
 112                          [in] ::com::sun::star::io::XStream xSignStream);
 113
 114     /** checks for digital signatures and their status.
 115
 116         <p>Only Package content will be checked.</p>
 117      */
 118     sequence< com::sun::star::security::DocumentSignatureInformation > verifyPackageSignatures(
 119                         [in] ::com::sun::star::embed::XStorage Storage,
 120                         [in] ::com::sun::star::io::XInputStream xSignInStream );
 121
 122     /** shows the digital signatures of the package
 123      */
 124     void showPackageSignatures(
 125                         [in] ::com::sun::star::embed::XStorage xStorage,
 126                         [in] ::com::sun::star::io::XInputStream xSignInStream );
 127
 128     /** allows to get the default stream name for storing of the signature of
 129         the package.
 130      */
 131     string getPackageSignatureDefaultStreamName();
 132
 133
 134     void showCertificate( [in] com::sun::star::security::XCertificate Certificate );
 135
 136
 137        /** manages trusted sources (Authors and pathes )
 138      */
 139
 140     void    manageTrustedSources();
 141     boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
 142     boolean isLocationTrusted( [in] string Location );
 143
 144     // These method should raise confirmation dialog, so it can not used from bad macros...
 145     void    addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
 146     void    addLocationToTrustedSources( [in] string Location );
 147
 148
 149
 150 } ;
 151
 152 } ; } ; } ; } ;
 153
 154 #endif
 155
 156