src/certificate.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/certificate.h
  36  *  @brief Certificate class
  37  */
  38
  39
  40 #ifndef LIBDCP_CERTIFICATE_H
  41 #define LIBDCP_CERTIFICATE_H
  42
  43
  44 #include "local_time.h"
  45 #undef X509_NAME
  46 #include <openssl/x509.h>
  47 #include <boost/filesystem.hpp>
  48 #include <string>
  49 #include <list>
  50
  51
  52 namespace xmlpp {
  53         class Element;
  54 }
  55
  56
  57 namespace dcp {
  58
  59
  60 /** @class Certificate
  61  *  @brief A wrapper for an X509 certificate
  62  *
  63  *  This class can take a Certificate from a string or an OpenSSL X509 object
  64  */
  65 class Certificate
  66 {
  67 public:
  68         Certificate ()
  69                 : _certificate (0)
  70                 , _public_key (0)
  71         {}
  72
  73         /** Load an X509 certificate from a string
  74          *  @param cert String to read from
  75          */
  76         explicit Certificate (std::string);
  77
  78         /** @param c X509 certificate, which this object will take ownership of */
  79         explicit Certificate (X509 *);
  80
  81         Certificate (Certificate const &);
  82         ~Certificate ();
  83
  84         Certificate& operator= (Certificate const &);
  85
  86         /** Read a certificate from a string.
  87          *  @param cert String to read.
  88          *  @return remaining part of the input string after the certificate which was read.
  89          */
  90         std::string read_string (std::string);
  91
  92         /** Return the certificate as a string
  93          *  @param with_begin_end true to include the -----BEGIN CERTIFICATE--- / -----END CERTIFICATE----- markers
  94          *  @return Certificate string
  95          */
  96         std::string certificate (bool with_begin_end = false) const;
  97
  98         std::string serial () const;
  99
 100         /** @return Certificate's issuer, in the form
 101          *  dnqualifier=&lt;dnQualififer&gt;,CN=&lt;commonName&gt;,OU=&lt;organizationalUnitName&gt,O=&lt;organizationName&gt;
 102          *  and with + signs escaped to \+
 103          */
 104         std::string issuer () const;
 105         std::string issuer_common_name() const;
 106         std::string issuer_organization_name() const;
 107         std::string issuer_organizational_unit_name() const;
 108
 109         std::string subject () const;
 110         std::string subject_common_name () const;
 111         std::string subject_organization_name () const;
 112         std::string subject_organizational_unit_name () const;
 113
 114         LocalTime not_before () const;
 115         LocalTime not_after () const;
 116
 117         X509* x509 () const {
 118                 return _certificate;
 119         }
 120
 121         /** @return RSA public key from this Certificate.  Caller must not free the returned value. */
 122         RSA* public_key () const;
 123
 124         /** @return thumbprint of the to-be-signed portion of this certificate */
 125         std::string thumbprint () const;
 126
 127         bool has_utf8_strings () const;
 128
 129 private:
 130
 131         static std::string name_for_xml (X509_NAME *);
 132         static std::string asn_to_utf8 (ASN1_STRING *);
 133         static std::string get_name_part (X509_NAME *, int);
 134
 135         X509* _certificate = nullptr;
 136         mutable RSA* _public_key = nullptr;
 137 };
 138
 139
 140 bool operator== (Certificate const & a, Certificate const & b);
 141 bool operator< (Certificate const & a, Certificate const & b);
 142 std::ostream& operator<< (std::ostream&s, Certificate const & c);
 143
 144
 145 }
 146
 147
 148 #endif