1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_security_DocumentSignatureInformation_idl__
25#define __com_sun_star_security_DocumentSignatureInformation_idl__
26
27#include <com/sun/star/security/XCertificate.idl>
28#include <com/sun/star/security/CertificateValidity.idl>
29
30
31//=============================================================================
32
33module com { module sun { module star { module security {
34
35//=============================================================================
36
37/** Status of digital signatures in a document.
38
39    <p>
40    This structure has the information about a digital signature in a document, and the status if the signature is valid.
41    </p>
42 */
43
44struct DocumentSignatureInformation
45{
46    XCertificate    Signer;
47    long            SignatureDate;
48    long            SignatureTime;
49    boolean         SignatureIsValid;
50    /* reflects the validity of the certificate.
51       Contains a value from the constants of
52       <type scope="com::sun::star::security">CertificateValidity</type>.
53     */
54    long CertificateStatus;
55    /* indicates what content of a document is signed.
56        <p>
57        This value can be ignored when this struct is returned as part of
58        a macro signature validation.
59        As of OpenOffice.org 3.2 and ODF 1.2 the document signature comprises
60        all files except the signature file itself.
61        Signatures in OpenOffice 2.x were only
62        applied to the files in the root of the document, except mimetype, the
63        Pictures and ObjectReplacements/Objects folder. That is, macros
64        were not part of the document signature.
65        OpenOffice 3.0 signed everthing, execept mimetype and the META-INF folder.
66        <p>
67        If PartialDocumentSignature is true, then the signature was created by OOo
68        with a version less then 3.2. In this case, not all files are signed. The
69        signature can still be regarded as valid, as long as SignatureIsValid is true
70        and the certificate could be validated. However, users should be notified about
71        the fact, that not everything in this document is signed.
72    */
73    boolean PartialDocumentSignature;
74
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82
83