2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
35 /** @file src/certificate.h
36 * @brief Certificate class
40 #ifndef LIBDCP_CERTIFICATE_H
41 #define LIBDCP_CERTIFICATE_H
45 #include <openssl/x509.h>
46 #include <boost/filesystem.hpp>
59 /** @class Certificate
60 * @brief A wrapper for an X509 certificate
62 * This class can take a Certificate from a string or an OpenSSL X509 object
72 /** Load an X509 certificate from a string
73 * @param cert String to read from
75 explicit Certificate (std::string);
77 /** @param c X509 certificate, which this object will take ownership of */
78 explicit Certificate (X509 *);
80 Certificate (Certificate const &);
83 Certificate& operator= (Certificate const &);
85 /** Read a certificate from a string.
86 * @param cert String to read.
87 * @return remaining part of the input string after the certificate which was read.
89 std::string read_string (std::string);
91 /** Return the certificate as a string
92 * @param with_begin_end true to include the -----BEGIN CERTIFICATE--- / -----END CERTIFICATE----- markers
93 * @return Certificate string
95 std::string certificate (bool with_begin_end = false) const;
97 std::string serial () const;
99 /** @return Certificate's issuer, in the form
100 * dnqualifier=<dnQualififer>,CN=<commonName>,OU=<organizationalUnitName>,O=<organizationName>
101 * and with + signs escaped to \+
103 std::string issuer () const;
105 std::string subject () const;
106 std::string subject_common_name () const;
107 std::string subject_organization_name () const;
108 std::string subject_organizational_unit_name () const;
109 struct tm not_before () const;
110 struct tm not_after () const;
112 X509* x509 () const {
116 /** @return RSA public key from this Certificate. Caller must not free the returned value. */
117 RSA* public_key () const;
119 /** @return thumbprint of the to-be-signed portion of this certificate */
120 std::string thumbprint () const;
122 bool has_utf8_strings () const;
126 static std::string name_for_xml (X509_NAME *);
127 static std::string asn_to_utf8 (ASN1_STRING *);
128 static std::string get_name_part (X509_NAME *, int);
130 X509* _certificate = nullptr;
131 mutable RSA* _public_key = nullptr;
135 bool operator== (Certificate const & a, Certificate const & b);
136 bool operator< (Certificate const & a, Certificate const & b);
137 std::ostream& operator<< (std::ostream&s, Certificate const & c);