X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=d5b6cb9f4eaeed6ccc33a493ea6766eac9389446;hb=9ec8f4724969c789c3add7edc7c548827f73d8a3;hp=f2728a38d25bbc042025e4e23f6def45e505d752;hpb=781982ea9a78f88fef130dc08cd028b7e5f47937;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index f2728a38..d5b6cb9f 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,66 +1,86 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @file src/util.cc * @brief Utility methods. */ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "KM_util.h" -#include "KM_fileio.h" -#include "AS_DCP.h" #include "util.h" #include "exceptions.h" #include "types.h" -#include "argb_frame.h" -#include "certificates.h" -#include "gamma_lut.h" -#include "xyz_frame.h" +#include "certificate.h" +#include "openjpeg_image.h" +#include "dcp_assert.h" +#include "compose.hpp" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include using std::string; +using std::wstring; using std::cout; -using std::stringstream; using std::min; using std::max; using std::list; using std::setw; using std::setfill; +using std::ostream; using boost::shared_ptr; -using boost::lexical_cast; -using namespace libdcp; +using boost::shared_array; +using boost::optional; +using boost::function; +using boost::algorithm::trim; +using namespace dcp; /** Create a UUID. * @return UUID. */ string -libdcp::make_uuid () +dcp::make_uuid () { char buffer[64]; Kumu::UUID id; @@ -69,21 +89,33 @@ libdcp::make_uuid () return string (buffer); } +string +dcp::make_digest (Data data) +{ + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, data.data().get(), data.size()); + byte_t byte_buffer[SHA_DIGEST_LENGTH]; + SHA1_Final (byte_buffer, &sha); + char digest[64]; + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); +} /** Create a digest for a file. * @param filename File name. - * @param progress Pointer to a progress reporting function, or 0. The function will be called + * @param progress Optional progress reporting function. The function will be called * with a progress value between 0 and 1. * @return Digest. */ string -libdcp::make_digest (string filename, boost::function* progress) +dcp::make_digest (boost::filesystem::path filename, function progress) { Kumu::FileReader reader; - if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) { - boost::throw_exception (FileError ("could not open file to compute digest", filename)); + Kumu::Result_t r = reader.OpenRead (filename.string().c_str ()); + if (ASDCP_FAILURE (r)) { + boost::throw_exception (FileError ("could not open file to compute digest", filename, r)); } - + SHA_CTX sha; SHA1_Init (&sha); @@ -95,134 +127,33 @@ libdcp::make_digest (string filename, boost::function* progress) while (1) { ui32_t read = 0; Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read); - + if (r == Kumu::RESULT_ENDOFFILE) { break; } else if (ASDCP_FAILURE (r)) { - boost::throw_exception (FileError ("could not read file to compute digest", filename)); + boost::throw_exception (FileError ("could not read file to compute digest", filename, r)); } - + SHA1_Update (&sha, read_buffer.Data(), read); if (progress) { - (*progress) (float (done) / size); + progress (float (done) / size); done += read; } } - byte_t byte_buffer[20]; + byte_t byte_buffer[SHA_DIGEST_LENGTH]; SHA1_Final (byte_buffer, &sha); char digest[64]; - return Kumu::base64encode (byte_buffer, 20, digest, 64); -} - -/** Convert a content kind to a string which can be used in a - * node. - * @param kind ContentKind. - * @return string. - */ -string -libdcp::content_kind_to_string (ContentKind kind) -{ - switch (kind) { - case FEATURE: - return "feature"; - case SHORT: - return "short"; - case TRAILER: - return "trailer"; - case TEST: - return "test"; - case TRANSITIONAL: - return "transitional"; - case RATING: - return "rating"; - case TEASER: - return "teaser"; - case POLICY: - return "policy"; - case PUBLIC_SERVICE_ANNOUNCEMENT: - return "psa"; - case ADVERTISEMENT: - return "advertisement"; - } - - assert (false); -} - -/** Convert a string from a node to a libdcp ContentKind. - * Reasonably tolerant about varying case. - * @param type Content kind string. - * @return libdcp ContentKind. - */ -libdcp::ContentKind -libdcp::content_kind_from_string (string type) -{ - /* XXX: should probably just convert type to lower-case and have done with it */ - - if (type == "feature") { - return FEATURE; - } else if (type == "short") { - return SHORT; - } else if (type == "trailer" || type == "Trailer") { - return TRAILER; - } else if (type == "test") { - return TEST; - } else if (type == "transitional") { - return TRANSITIONAL; - } else if (type == "rating") { - return RATING; - } else if (type == "teaser" || type == "Teaser") { - return TEASER; - } else if (type == "policy") { - return POLICY; - } else if (type == "psa") { - return PUBLIC_SERVICE_ANNOUNCEMENT; - } else if (type == "advertisement") { - return ADVERTISEMENT; - } - - assert (false); -} - -/** Decompress a JPEG2000 image to a bitmap. - * @param data JPEG2000 data. - * @param size Size of data in bytes. - * @param reduce A power of 2 by which to reduce the size of the decoded image; - * e.g. 0 reduces by (2^0 == 1), ie keeping the same size. - * 1 reduces by (2^1 == 2), ie halving the size of the image. - * This is useful for scaling 4K DCP images down to 2K. - * @return XYZ image. - */ -shared_ptr -libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) -{ - opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K); - opj_dparameters_t parameters; - opj_set_default_decoder_parameters (¶meters); - parameters.cp_reduce = reduce; - opj_setup_decoder (decoder, ¶meters); - opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size); - opj_image_t* image = opj_decode (decoder, cio); - if (!image) { - opj_destroy_decompress (decoder); - opj_cio_close (cio); - boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream of " + lexical_cast (size) + " bytes.")); - } - - opj_cio_close (cio); - - image->x1 = rint (float(image->x1) / pow (2, reduce)); - image->y1 = rint (float(image->y1) / pow (2, reduce)); - return shared_ptr (new XYZFrame (image)); + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); } /** @param s A string. * @return true if the string contains only space, newline or tab characters, or is empty. */ bool -libdcp::empty_or_white_space (string s) +dcp::empty_or_white_space (string s) { for (size_t i = 0; i < s.length(); ++i) { if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { @@ -233,8 +164,11 @@ libdcp::empty_or_white_space (string s) return true; } +/** Set up various bits that the library needs. Should be called one + * by client applications. + */ void -libdcp::init () +dcp::init () { if (xmlSecInit() < 0) { throw MiscError ("could not initialise xmlsec"); @@ -244,7 +178,7 @@ libdcp::init () if (xmlSecCryptoDLLoadLibrary(BAD_CAST XMLSEC_CRYPTO) < 0) { throw MiscError ("unable to load default xmlsec-crypto library"); } -#endif +#endif if (xmlSecCryptoAppInit(0) < 0) { throw MiscError ("could not initialise crypto"); @@ -253,196 +187,192 @@ libdcp::init () if (xmlSecCryptoInit() < 0) { throw MiscError ("could not initialise xmlsec-crypto"); } + + OpenSSL_add_all_algorithms(); } -/** Sign an XML node. This function takes a certificate chain (to prove that the sender is bona fide) and - * a private key with which to sign the node. +/** Decode a base64 string. The base64 decode routine in KM_util.cpp + * gives different values to both this and the command-line base64 + * for some inputs. Not sure why. * - * @param parent Node to sign. - * @param certificates Certificate chain for the signer. - * @param signer_key Filename of the private key of the signer. - * @param ns Namespace to use for the signature XML nodes. + * @param in base64-encoded string. + * @param out Output buffer. + * @param out_length Length of output buffer. + * @return Number of characters written to the output buffer. */ -void -libdcp::add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, string const & ns) +int +dcp::base64_decode (string const & in, unsigned char* out, int out_length) { - parent->add_child("SignatureValue", ns); - - /* Add the certificate chain to a KeyInfo child node of parent */ - xmlpp::Element* key_info = parent->add_child("KeyInfo", ns); - list > c = certificates.leaf_to_root (); - for (list >::iterator i = c.begin(); i != c.end(); ++i) { - xmlpp::Element* data = key_info->add_child("X509Data", ns); - - { - xmlpp::Element* serial = data->add_child("X509IssuerSerial", ns); - serial->add_child("X509IssuerName", ns)->add_child_text((*i)->issuer ()); - serial->add_child("X509SerialNumber", ns)->add_child_text((*i)->serial ()); + BIO* b64 = BIO_new (BIO_f_base64 ()); + + /* This means the input should have no newlines */ + BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); + + /* Copy our input string, removing newlines */ + char in_buffer[in.size() + 1]; + char* p = in_buffer; + for (size_t i = 0; i < in.size(); ++i) { + if (in[i] != '\n' && in[i] != '\r') { + *p++ = in[i]; } - - data->add_child("X509Certificate", ns)->add_child_text((*i)->certificate()); } - xmlSecDSigCtxPtr signature_context = xmlSecDSigCtxCreate (0); - if (signature_context == 0) { - throw MiscError ("could not create signature context"); - } + BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); + bmem = BIO_push (b64, bmem); + int const N = BIO_read (bmem, out, out_length); + BIO_free_all (bmem); + + return N; +} + +/** @param p Path to open. + * @param t mode flags, as for fopen(3). + * @return FILE pointer or 0 on error. + * + * Apparently there is no way to create an ofstream using a UTF-8 + * filename under Windows. We are hence reduced to using fopen + * with this wrapper. + */ +FILE * +dcp::fopen_boost (boost::filesystem::path p, string t) +{ +#ifdef LIBDCP_WINDOWS + wstring w (t.begin(), t.end()); + /* c_str() here should give a UTF-16 string */ + return _wfopen (p.c_str(), w.c_str ()); +#else + return fopen (p.c_str(), t.c_str ()); +#endif +} - signature_context->signKey = xmlSecCryptoAppKeyLoad (signer_key.c_str(), xmlSecKeyDataFormatPem, 0, 0, 0); - if (signature_context->signKey == 0) { - throw FileError ("could not load private key file", signer_key); +optional +dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path file) +{ + boost::filesystem::path::const_iterator i = root.begin (); + boost::filesystem::path::const_iterator j = file.begin (); + + while (i != root.end() && j != file.end() && *i == *j) { + ++i; + ++j; } - /* XXX: set key name to the file name: is this right? */ - if (xmlSecKeySetName (signature_context->signKey, reinterpret_cast (signer_key.c_str())) < 0) { - throw MiscError ("could not set key name"); + if (i != root.end ()) { + return optional (); } - if (xmlSecDSigCtxSign (signature_context, parent->cobj ()) < 0) { - throw MiscError ("could not sign"); + boost::filesystem::path rel; + while (j != file.end ()) { + rel /= *j++; } - xmlSecDSigCtxDestroy (signature_context); + return rel; } - -void -libdcp::add_signer (xmlpp::Element* parent, CertificateChain const & certificates, string const & ns) +bool +dcp::ids_equal (string a, string b) { - xmlpp::Element* signer = parent->add_child("Signer"); - - { - xmlpp::Element* data = signer->add_child("X509Data", ns); - - { - xmlpp::Element* serial_element = data->add_child("X509IssuerSerial", ns); - serial_element->add_child("X509IssuerName", ns)->add_child_text (certificates.leaf()->issuer()); - serial_element->add_child("X509SerialNumber", ns)->add_child_text (certificates.leaf()->serial()); - } - - data->add_child("X509SubjectName", ns)->add_child_text (certificates.leaf()->subject()); - } + transform (a.begin(), a.end(), a.begin(), ::tolower); + transform (b.begin(), b.end(), b.begin(), ::tolower); + trim (a); + trim (b); + return a == b; } -/** @param signer_key Filename of private key to sign with */ -void -libdcp::sign (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, bool interop) +string +dcp::file_to_string (boost::filesystem::path p, uintmax_t max_length) { - add_signer (parent, certificates, "dsig"); - - xmlpp::Element* signature = parent->add_child("Signature", "dsig"); - - { - xmlpp::Element* signed_info = signature->add_child ("SignedInfo", "dsig"); - signed_info->add_child("CanonicalizationMethod", "dsig")->set_attribute ("Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"); - - if (interop) { - signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#rsa-sha1"); - } else { - signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); - } - - { - xmlpp::Element* reference = signed_info->add_child("Reference", "dsig"); - reference->set_attribute ("URI", ""); - { - xmlpp::Element* transforms = reference->add_child("Transforms", "dsig"); - transforms->add_child("Transform", "dsig")->set_attribute ( - "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature" - ); - } - reference->add_child("DigestMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1"); - /* This will be filled in by the signing later */ - reference->add_child("DigestValue", "dsig"); - } + uintmax_t len = boost::filesystem::file_size (p); + if (len > max_length) { + throw MiscError (String::compose ("Unexpectedly long file (%1)", p.string())); } - - add_signature_value (signature, certificates, signer_key, "dsig"); -} -bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b) -{ - return (a.width == b.width && a.height == b.height); -} + FILE* f = fopen_boost (p, "r"); + if (!f) { + throw FileError ("could not open file", p, errno); + } -bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b) -{ - return !(a == b); + char* c = new char[len]; + /* This may read less than `len' if we are on Windows and we have CRLF in the file */ + int const N = fread (c, 1, len, f); + fclose (f); + + string s (c, N); + delete[] c; + + return s; } -/** The base64 decode routine in KM_util.cpp gives different values to both - * this and the command-line base64 for some inputs. Not sure why. +/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...) + * @return SHA1 fingerprint of key */ -int -libdcp::base64_decode (string const & in, unsigned char* out, int out_length) +string +dcp::private_key_fingerprint (string key) { - BIO* b64 = BIO_new (BIO_f_base64 ()); + boost::replace_all (key, "-----BEGIN RSA PRIVATE KEY-----\n", ""); + boost::replace_all (key, "\n-----END RSA PRIVATE KEY-----\n", ""); - /* This means the input should have no newlines */ - BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); + unsigned char buffer[4096]; + int const N = base64_decode (key, buffer, sizeof (buffer)); - /* Copy our input string, removing newlines */ - char in_buffer[in.size() + 1]; - char* p = in_buffer; - for (size_t i = 0; i < in.size(); ++i) { - if (in[i] != '\n' && in[i] != '\r') { - *p++ = in[i]; - } - } - - BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); - bmem = BIO_push (b64, bmem); - int const N = BIO_read (bmem, out, out_length); - BIO_free_all (bmem); + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, buffer, N); + uint8_t digest[20]; + SHA1_Final (digest, &sha); - return N; + char digest_base64[64]; + return Kumu::base64encode (digest, 20, digest_base64, 64); } -string -libdcp::tm_to_string (struct tm* tm) +xmlpp::Node * +dcp::find_child (xmlpp::Node const * node, string name) { - char buffer[64]; - strftime (buffer, 64, "%Y-%m-%dT%I:%M:%S", tm); - - int offset = 0; + xmlpp::Node::NodeList c = node->get_children (); + xmlpp::Node::NodeList::iterator i = c.begin(); + while (i != c.end() && (*i)->get_name() != name) { + ++i; + } -#ifdef LIBDCP_POSIX - offset = tm->tm_gmtoff / 60; -#else - TIME_ZONE_INFORMATION tz; - GetTimeZoneInformation (&tz); - offset = tz.Bias; -#endif - - return string (buffer) + utc_offset_to_string (offset); + DCP_ASSERT (i != c.end ()); + return *i; } -/** @param b Offset from UTC to local time in minutes. - * @return string of the form e.g. -01:00. - */ string -libdcp::utc_offset_to_string (int b) +dcp::remove_urn_uuid (string raw) { - bool const negative = (b < 0); - b = negative ? -b : b; + DCP_ASSERT (raw.substr(0, 9) == "urn:uuid:"); + return raw.substr (9); +} - int const hours = b / 60; - int const minutes = b % 60; +string +dcp::openjpeg_version () +{ + return opj_version (); +} - stringstream o; - if (negative) { - o << "-"; - } else { - o << "+"; +string +dcp::spaces (int n) +{ + string s = ""; + for (int i = 0; i < n; ++i) { + s += " "; } - - o << setw(2) << setfill('0') << hours << ":" << setw(2) << setfill('0') << minutes; - return o.str (); + return s; } -string -libdcp::ptime_to_string (boost::posix_time::ptime t) +void +dcp::indent (xmlpp::Element* element, int initial) { - struct tm t_tm = boost::posix_time::to_tm (t); - return tm_to_string (&t_tm); + xmlpp::Node* last = 0; + BOOST_FOREACH (xmlpp::Node * n, element->get_children()) { + xmlpp::Element* e = dynamic_cast(n); + if (e) { + element->add_child_text_before (e, "\n" + spaces(initial + 2)); + indent (e, initial + 2); + last = n; + } + } + if (last) { + element->add_child_text (last, "\n" + spaces(initial)); + } }