offapi/com/sun/star/security/XCertificate.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: XCertificate.idl,v $
  10  * $Revision: 1.5 $
  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_security_XCertificate_idl_
  36 #define __com_sun_star_security_XCertificate_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/util/DateTime.idl>
  40 #include <com/sun/star/security/XCertificateExtension.idl>
  41
  42 module com { module sun { module star { module security {
  43
  44 /**
  45  * Interface of a PKI Certificate
  46  *
  47  * <p>This interface represents a x509 certificate.</p>
  48  */
  49 interface XCertificate : com::sun::star::uno::XInterface
  50 {
  51     /**
  52      * the version number attribute of the certificate.
  53      */
  54     [attribute, readonly] short Version ;
  55
  56     /**
  57      * the serial number attribute of the certificate.
  58      */
  59     [attribute, readonly] sequence< byte > SerialNumber ;
  60
  61     /**
  62      * the issuer name attribute of the certificate.
  63      */
  64     [attribute, readonly] string IssuerName ;
  65
  66     /**
  67      * the subject name attribute of the certificate.
  68      */
  69     [attribute, readonly] string SubjectName ;
  70
  71     /**
  72      * the validity NotBefore date attribute of the certificate.
  73      */
  74     [attribute, readonly] com::sun::star::util::DateTime NotValidBefore ;
  75
  76     /**
  77      * the validity NotAfter date attribute of the certificate.
  78      */
  79     [attribute, readonly] com::sun::star::util::DateTime NotValidAfter ;
  80
  81     /**
  82      * the issuer unique ID attribute of the certificate.
  83      */
  84     [attribute, readonly] sequence< byte > IssuerUniqueID ;
  85
  86     /**
  87      * the subject unique ID attribute of the certificate.
  88      */
  89     [attribute, readonly] sequence< byte > SubjectUniqueID ;
  90
  91     /**
  92      * all extensions of a certificate.
  93      */
  94     [attribute, readonly] sequence< XCertificateExtension > Extensions ;
  95
  96     /**
  97      * the DER encoded form of the certificate
  98      */
  99     [attribute, readonly] sequence< byte > Encoded ;
 100
 101     /**
 102      * the algorithm of the subject public key
 103      */
 104     [attribute, readonly] string SubjectPublicKeyAlgorithm;
 105
 106     /**
 107      * the value of the subject public key
 108      */
 109     [attribute, readonly] sequence< byte > SubjectPublicKeyValue;
 110
 111     /**
 112      * the signature algorithm
 113      */
 114     [attribute, readonly] string SignatureAlgorithm;
 115
 116     /**
 117      * the SHA1 thumbprint
 118      */
 119     [attribute, readonly] sequence< byte > SHA1Thumbprint;
 120
 121     /**
 122      * the MD5 thumbprint
 123      */
 124     [attribute, readonly] sequence< byte > MD5Thumbprint;
 125
 126     /**
 127      * Find a extension with a object identifier.
 128      */
 129     XCertificateExtension findCertificateExtension( [in]sequence< byte > oid ) ;
 130
 131     /**
 132      * get the certificate usage
 133      */
 134     long getCertificateUsage();
 135 } ;
 136
 137 } ; } ; } ; } ;
 138
 139 #endif
 140