diff options
Diffstat (limited to 'offapi/com/sun/star/security/DocumentSignatureInformation.idl')
-rw-r--r-- | offapi/com/sun/star/security/DocumentSignatureInformation.idl | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/offapi/com/sun/star/security/DocumentSignatureInformation.idl b/offapi/com/sun/star/security/DocumentSignatureInformation.idl new file mode 100644 index 000000000..03b2e1f1d --- /dev/null +++ b/offapi/com/sun/star/security/DocumentSignatureInformation.idl @@ -0,0 +1,93 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_security_DocumentSignatureInformation_idl__ +#define __com_sun_star_security_DocumentSignatureInformation_idl__ + +#include <com/sun/star/graphic/XGraphic.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; + /** Time of day, in 100th of seconds. */ + long SignatureTime; + boolean SignatureIsValid; + /** + * Reflects the validity of the certificate. + * Contains a value from the constants of com::sun::star::security::CertificateValidity. + */ + 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 everything, except mimetype and the META-INF folder. + * <p> + * If PartialDocumentSignature is true, then the signature was created by OOo + * with a version lower than 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; + /** + * The ID of the Signature Line + * @since LibreOffice 6.0 + */ + string SignatureLineId; + /** + * The Signature Line Image which is shown when the signature is valid + * @since LibreOffice 6.0 + */ + com::sun::star::graphic::XGraphic ValidSignatureLineImage; + /** + * The Signature Line Image which is shown when the signature is invalid + * @since LibreOffice 6.0 + */ + com::sun::star::graphic::XGraphic InvalidSignatureLineImage; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |