offapi/com/sun/star/security/XCertificate.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 #ifndef __com_sun_star_security_XCertificate_idl_
  21 #define __com_sun_star_security_XCertificate_idl_
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/util/DateTime.idl>
  25 #include <com/sun/star/security/XCertificateExtension.idl>
  26
  27 module com { module sun { module star { module security {
  28
  29 /**
  30  * Interface of a PKI Certificate
  31  *
  32  * <p>This interface represents a x509 certificate.</p>
  33  */
  34 interface XCertificate : com::sun::star::uno::XInterface
  35 {
  36     /**
  37      * the version number attribute of the certificate.
  38      */
  39     [attribute, readonly] short Version ;
  40
  41     /**
  42      * the serial number attribute of the certificate.
  43      */
  44     [attribute, readonly] sequence< byte > SerialNumber ;
  45
  46     /**
  47      * the issuer name attribute of the certificate.
  48      */
  49     [attribute, readonly] string IssuerName ;
  50
  51     /**
  52      * the subject name attribute of the certificate.
  53      */
  54     [attribute, readonly] string SubjectName ;
  55
  56     /**
  57      * the validity NotBefore date attribute of the certificate.
  58      */
  59     [attribute, readonly] com::sun::star::util::DateTime NotValidBefore ;
  60
  61     /**
  62      * the validity NotAfter date attribute of the certificate.
  63      */
  64     [attribute, readonly] com::sun::star::util::DateTime NotValidAfter ;
  65
  66     /**
  67      * the issuer unique ID attribute of the certificate.
  68      */
  69     [attribute, readonly] sequence< byte > IssuerUniqueID ;
  70
  71     /**
  72      * the subject unique ID attribute of the certificate.
  73      */
  74     [attribute, readonly] sequence< byte > SubjectUniqueID ;
  75
  76     /**
  77      * all extensions of a certificate.
  78      */
  79     [attribute, readonly] sequence< XCertificateExtension > Extensions ;
  80
  81     /**
  82      * the DER encoded form of the certificate
  83      */
  84     [attribute, readonly] sequence< byte > Encoded ;
  85
  86     /**
  87      * the algorithm of the subject public key
  88      */
  89     [attribute, readonly] string SubjectPublicKeyAlgorithm;
  90
  91     /**
  92      * the value of the subject public key
  93      */
  94     [attribute, readonly] sequence< byte > SubjectPublicKeyValue;
  95
  96     /**
  97      * the signature algorithm
  98      */
  99     [attribute, readonly] string SignatureAlgorithm;
 100
 101     /**
 102      * the SHA-1 thumbprint
 103      */
 104     [attribute, readonly] sequence< byte > SHA1Thumbprint;
 105
 106     /**
 107      * the MD5 thumbprint
 108      */
 109     [attribute, readonly] sequence< byte > MD5Thumbprint;
 110
 111     /**
 112      * Find a extension with a object identifier.
 113      */
 114     XCertificateExtension findCertificateExtension( [in]sequence< byte > oid ) ;
 115
 116     /**
 117      * get the certificate usage. The return value is a set of bits, as defined in RFC3280 for the
 118      * KeyUsage BIT STRING. Note the bit and byte order used in ASN.1, so for instance the bit
 119      * dataEncipherment in KeyUsage, "bit 3", corresponds to CERT_DATA_ENCIPHERMENT_KEY_USAGE in
 120      * Win32 and KU_DATA_ENCIPHERMENT in NSS, both with value 0x10.
 121      */
 122     long getCertificateUsage();
 123 } ;
 124
 125 } ; } ; } ; } ;
 126
 127 #endif
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */