XDocumentDigitalSignatures.idl

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

module com { module sun { module star { module security {

interface XDocumentDigitalSignatures : com::sun::star::uno::XInterface
{
    boolean signDocumentContent( [in] ::com::sun::star::embed::XStorage xStorage,
                                 [in] ::com::sun::star::io::XStream xSignStream);

    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);

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

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

    string getDocumentContentSignatureDefaultStreamName();

    boolean signScriptingContent( [in] ::com::sun::star::embed::XStorage xStorage,
                                  [in] ::com::sun::star::io::XStream xSignStream);

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

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

    string getScriptingContentSignatureDefaultStreamName();

    boolean signPackage( [in] ::com::sun::star::embed::XStorage Storage,
                         [in] ::com::sun::star::io::XStream xSignStream);

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

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

    string getPackageSignatureDefaultStreamName();


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


    void    manageTrustedSources();
    boolean isAuthorTrusted( [in] com::sun::star::security::XCertificate Author );
    boolean isLocationTrusted( [in] string Location );

    // These methods should raise a confirmation dialog, so they can not be misused from bad macros.
    void    addAuthorToTrustedSources( [in] com::sun::star::security::XCertificate Author );
    void    addLocationToTrustedSources( [in] string Location );

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

    com::sun::star::security::XCertificate chooseSigningCertificate( [out] string Description );

    com::sun::star::security::XCertificate selectSigningCertificate( [out] string Description );

    com::sun::star::security::XCertificate selectSigningCertificateWithType(
        [in] CertificateKind certificateKind,
        [out] string Description);

    sequence< com::sun::star::security::XCertificate > chooseEncryptionCertificate( );

    com::sun::star::security::XCertificate chooseCertificateWithProps( [out] sequence<::com::sun::star::beans::PropertyValue> Properties);

    boolean signDocumentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
                                        [in] ::com::sun::star::embed::XStorage xStorage,
                                        [in] ::com::sun::star::io::XStream xStream);

    void setParentWindow([in] ::com::sun::star::awt::XWindow xParentWindow);

    boolean signScriptingContentWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
                                                [in] ::com::sun::star::embed::XStorage xStorage,
                                                [in] ::com::sun::star::io::XStream xStream);

    boolean signPackageWithCertificate([in] ::com::sun::star::security::XCertificate xCertificate,
                                                [in] ::com::sun::star::embed::XStorage xStorage,
                                                [in] ::com::sun::star::io::XStream xStream);
};

} ; } ; } ; } ;

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */