xref: /trunk/main/offapi/com/sun/star/security/DocumentSignatureInformation.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_security_DocumentSignatureInformation_idl__
#define __com_sun_star_security_DocumentSignatureInformation_idl__

#include <com/sun/star/security/XCertificate.idl>
#include <com/sun/star/security/CertificateValidity.idl>


//=============================================================================

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

//=============================================================================

/** Status of digital signatures in a document.

    <p>
    This structure has the information about a digital signature in a document, and the status if the signature is valid.
    </p>
 */

struct DocumentSignatureInformation
{
    XCertificate    Signer;
    long            SignatureDate;
    long            SignatureTime;
    boolean         SignatureIsValid;
    /* reflects the validity of the certificate.
       Contains a value from the constants of
       <type scope="com::sun::star::security">CertificateValidity</type>.
     */
    long CertificateStatus;
    /* indicates what content of a document is signed.
        <p>
        This value can be ignored when this struct is returned as part of
        a macro signature validation.
        As of OpenOffice.org 3.2 and ODF 1.2 the document signature comprises
        all files except the signature file itself.
        Signatures in OOo 2.x were only
        applied to the files in the root of the document, except mimetype, the
        Pictures and ObjectReplacements/Objects folder. That is, macros
        were not part of the document signature.
        OOo 3.0 signed everthing, execept mimetype and the META-INF folder.
        <p>
        If PartialDocumentSignature is true, then the signature was created by OOo
        with a version less then 3.2. In this case, not all files are signed. The
        signature can still be regarded as valid, as long as SignatureIsValid is true
        and the certificate could be validated. However, users should be notified about
        the fact, that not everything in this document is signed.
    */
    boolean PartialDocumentSignature;

};

//=============================================================================

}; }; }; };

#endif