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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSecurityEnvironment.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 //i20156 - new file for xmlsecurity module
  32
  33 /** -- idl definition -- **/
  34
  35 #ifndef __com_sun_star_xml_crypto_xsecurityenvironment_idl_
  36 #define __com_sun_star_xml_crypto_xsecurityenvironment_idl_
  37
  38 #ifndef __com_sun_star_uno_SecurityException_idl__
  39 #include <com/sun/star/uno/SecurityException.idl>
  40 #endif
  41
  42 #include <com/sun/star/uno/XInterface.idl>
  43 #include <com/sun/star/uno/Exception.idl>
  44 #include <com/sun/star/security/XCertificate.idl>
  45 #include <com/sun/star/security/CertificateCharacters.idl>
  46 #include <com/sun/star/security/CertificateValidity.idl>
  47
  48 module com { module sun { module star { module xml { module crypto {
  49
  50 /**
  51  * Interface of Security Environment
  52  */
  53 interface XSecurityEnvironment : com::sun::star::uno::XInterface
  54 {
  55     /**
  56      * Get personal certificate from the environment
  57      */
  58     sequence< com::sun::star::security::XCertificate > getPersonalCertificates() raises( com::sun::star::uno::SecurityException ) ;
  59
  60     /**
  61      * Get certificate from the environment by issuer name and serial number
  62      */
  63     com::sun::star::security::XCertificate getCertificate( [in] string issuerName, [in] sequence< byte > serialNumber ) raises( com::sun::star::uno::SecurityException ) ;
  64
  65     /**
  66      * build certificate path from a certain certificate
  67      */
  68     sequence< com::sun::star::security::XCertificate > buildCertificatePath( [in] com::sun::star::security::XCertificate beginCert ) raises( com::sun::star::uno::SecurityException ) ;
  69
  70     /**
  71      * Create certificate interface from raw DER encoded certificate
  72      */
  73     com::sun::star::security::XCertificate createCertificateFromRaw( [in] sequence< byte > rawCertificate ) raises( com::sun::star::uno::SecurityException ) ;
  74
  75     /**
  76      * Create certificate interface from a BASE64 encoded certificate.
  77      */
  78     com::sun::star::security::XCertificate createCertificateFromAscii( [in] string asciiCertificate ) raises( com::sun::star::uno::SecurityException ) ;
  79
  80     /**
  81       Verify a certificate.
  82
  83       The method provides a way to verify a certificate.
  84       @param xEECertificate
  85           The certificate which is to be validated.
  86
  87       @param intermediateCertificates
  88           Additional certificates which can be used by the method in constructing
  89           the certificate chain. The root certificate may also be contained. However,
  90           the implementation must check if the root certificate is indeed trusted by
  91           the user.
  92           All entries of the sequence must be non-null references.
  93
  94       @return
  95           The validation status will returned as a bit-wise long, please refer to
  96           CertificateValidity definition.
  97      */
  98     long verifyCertificate( [in] com::sun::star::security::XCertificate xEECertificate,
  99         [in] sequence< com::sun::star::security::XCertificate > intermediateCertificates)
 100         raises( com::sun::star::uno::SecurityException ) ;
 101
 102     /**
 103      * Get a certificate characters.
 104      *
 105      * The method provides a way to get certificate characters like:
 106      * 1. Whether or not the certificate have a private key in the user profile.
 107      * 2. Whether or not the certificate is a trusted certificate.
 108      * 3. Whether or not the certificate is a self-signed certificate.
 109      *
 110      * The certificate characters is defined as bit-wise long, please refer to
 111      * CertificateCharacters definition.
 112      */
 113     long getCertificateCharacters( [in] com::sun::star::security::XCertificate xCertificate ) raises( com::sun::star::uno::SecurityException ) ;
 114
 115     /**
 116      * Get the Environment detail infos
 117      */
 118     string getSecurityEnvironmentInformation ( );
 119
 120 } ;
 121
 122 } ; } ; } ; } ; } ;
 123
 124 #endif
 125