offapi/com/sun/star/xml/crypto/XSecurityEnvironment.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module xml { module crypto {
  21
  22 /**
  23  * Interface of Security Environment
  24  */
  25 interface XSecurityEnvironment : com::sun::star::uno::XInterface
  26 {
  27     /**
  28      * Get personal certificates from the environment
  29      */
  30     sequence< com::sun::star::security::XCertificate > getPersonalCertificates() raises( com::sun::star::uno::SecurityException ) ;
  31
  32     /**
  33      * Get certificate from the environment by issuer name and serial number
  34      */
  35     com::sun::star::security::XCertificate getCertificate( [in] string issuerName, [in] sequence< byte > serialNumber ) raises( com::sun::star::uno::SecurityException ) ;
  36
  37     /**
  38      * Build certificate path from a certain certificate
  39      */
  40     sequence< com::sun::star::security::XCertificate > buildCertificatePath( [in] com::sun::star::security::XCertificate beginCert ) raises( com::sun::star::uno::SecurityException ) ;
  41
  42     /**
  43      * Create certificate interface from raw DER encoded certificate
  44      */
  45     com::sun::star::security::XCertificate createCertificateFromRaw( [in] sequence< byte > rawCertificate ) raises( com::sun::star::uno::SecurityException ) ;
  46
  47     /**
  48      * Create certificate interface from a Base64 encoded certificate.
  49      */
  50     com::sun::star::security::XCertificate createCertificateFromAscii( [in] string asciiCertificate ) raises( com::sun::star::uno::SecurityException ) ;
  51
  52     /**
  53       Verify a certificate.
  54
  55       The method provides a way to verify a certificate.
  56       @param xEECertificate
  57           The certificate which is to be validated.
  58
  59       @param intermediateCertificates
  60           Additional certificates which can be used by the method in constructing
  61           the certificate chain. The root certificate may also be contained. However,
  62           the implementation must check if the root certificate is indeed trusted by
  63           the user.
  64           All entries of the sequence must be non-null references.
  65
  66       @return
  67           The validation status will returned as a bit-wise long, please refer to
  68           CertificateValidity definition.
  69      */
  70     long verifyCertificate( [in] com::sun::star::security::XCertificate xEECertificate,
  71         [in] sequence< com::sun::star::security::XCertificate > intermediateCertificates)
  72         raises( com::sun::star::uno::SecurityException ) ;
  73
  74     /**
  75      * Get a certificate characters.
  76      *
  77      * The method provides a way to get certificate characters like:
  78      * 1. Whether or not the certificate have a private key in the user profile.
  79      * 2. Whether or not the certificate is a trusted certificate.
  80      * 3. Whether or not the certificate is a self-signed certificate.
  81      *
  82      * The certificate characters is defined as bit-wise long, please refer to
  83      * CertificateCharacters definition.
  84      */
  85     long getCertificateCharacters( [in] com::sun::star::security::XCertificate xCertificate ) raises( com::sun::star::uno::SecurityException ) ;
  86
  87     /**
  88      * Get the Environment detail information
  89      */
  90     string getSecurityEnvironmentInformation ( );
  91
  92     /**
  93      * List all certificates, private (as returned by getPersonalCertificates) as well as those of other people/orgas
  94      *
  95      * @since LibreOffice 6.0
  96      */
  97     sequence< com::sun::star::security::XCertificate > getAllCertificates() raises( com::sun::star::uno::SecurityException ) ;
  98
  99 } ;
 100
 101 } ; } ; } ; } ; } ;
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */