src/util.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/util.cc
  21  *  @brief Utility methods.
  22  */
  23
  24 #include <stdexcept>
  25 #include <sstream>
  26 #include <iostream>
  27 #include <iomanip>
  28 #include <boost/filesystem.hpp>
  29 #include <boost/lexical_cast.hpp>
  30 #include <openssl/sha.h>
  31 #include <libxml++/nodes/element.h>
  32 #include <libxml++/document.h>
  33 #include <xmlsec/xmldsig.h>
  34 #include <xmlsec/dl.h>
  35 #include <xmlsec/app.h>
  36 #include "KM_util.h"
  37 #include "KM_fileio.h"
  38 #include "AS_DCP.h"
  39 #include "util.h"
  40 #include "exceptions.h"
  41 #include "types.h"
  42 #include "argb_frame.h"
  43 #include "certificates.h"
  44 #include "gamma_lut.h"
  45 #include "xyz_frame.h"
  46
  47 using std::string;
  48 using std::cout;
  49 using std::stringstream;
  50 using std::min;
  51 using std::max;
  52 using std::list;
  53 using boost::shared_ptr;
  54 using boost::lexical_cast;
  55 using namespace libdcp;
  56
  57 /** Create a UUID.
  58  *  @return UUID.
  59  */
  60 string
  61 libdcp::make_uuid ()
  62 {
  63         char buffer[64];
  64         Kumu::UUID id;
  65         Kumu::GenRandomValue (id);
  66         id.EncodeHex (buffer, 64);
  67         return string (buffer);
  68 }
  69
  70
  71 /** Create a digest for a file.
  72  *  @param filename File name.
  73  *  @return Digest.
  74  */
  75 string
  76 libdcp::make_digest (string filename)
  77 {
  78         Kumu::FileReader reader;
  79         if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) {
  80                 boost::throw_exception (FileError ("could not open file to compute digest", filename));
  81         }
  82
  83         SHA_CTX sha;
  84         SHA1_Init (&sha);
  85
  86         Kumu::ByteString read_buffer (65536);
  87         int done = 0;
  88         while (1) {
  89                 ui32_t read = 0;
  90                 Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read);
  91
  92                 if (r == Kumu::RESULT_ENDOFFILE) {
  93                         break;
  94                 } else if (ASDCP_FAILURE (r)) {
  95                         boost::throw_exception (FileError ("could not read file to compute digest", filename));
  96                 }
  97
  98                 SHA1_Update (&sha, read_buffer.Data(), read);
  99                 done += read;
 100         }
 101
 102         byte_t byte_buffer[20];
 103         SHA1_Final (byte_buffer, &sha);
 104
 105         char digest[64];
 106         return Kumu::base64encode (byte_buffer, 20, digest, 64);
 107 }
 108
 109 /** Convert a content kind to a string which can be used in a
 110  *  <ContentKind> node.
 111  *  @param kind ContentKind.
 112  *  @return string.
 113  */
 114 string
 115 libdcp::content_kind_to_string (ContentKind kind)
 116 {
 117         switch (kind) {
 118         case FEATURE:
 119                 return "feature";
 120         case SHORT:
 121                 return "short";
 122         case TRAILER:
 123                 return "trailer";
 124         case TEST:
 125                 return "test";
 126         case TRANSITIONAL:
 127                 return "transitional";
 128         case RATING:
 129                 return "rating";
 130         case TEASER:
 131                 return "teaser";
 132         case POLICY:
 133                 return "policy";
 134         case PUBLIC_SERVICE_ANNOUNCEMENT:
 135                 return "psa";
 136         case ADVERTISEMENT:
 137                 return "advertisement";
 138         }
 139
 140         assert (false);
 141 }
 142
 143 /** Convert a string from a <ContentKind> node to a libdcp ContentKind.
 144  *  Reasonably tolerant about varying case.
 145  *  @param type Content kind string.
 146  *  @return libdcp ContentKind.
 147  */
 148 libdcp::ContentKind
 149 libdcp::content_kind_from_string (string type)
 150 {
 151         /* XXX: should probably just convert type to lower-case and have done with it */
 152
 153         if (type == "feature") {
 154                 return FEATURE;
 155         } else if (type == "short") {
 156                 return SHORT;
 157         } else if (type == "trailer" || type == "Trailer") {
 158                 return TRAILER;
 159         } else if (type == "test") {
 160                 return TEST;
 161         } else if (type == "transitional") {
 162                 return TRANSITIONAL;
 163         } else if (type == "rating") {
 164                 return RATING;
 165         } else if (type == "teaser" || type == "Teaser") {
 166                 return TEASER;
 167         } else if (type == "policy") {
 168                 return POLICY;
 169         } else if (type == "psa") {
 170                 return PUBLIC_SERVICE_ANNOUNCEMENT;
 171         } else if (type == "advertisement") {
 172                 return ADVERTISEMENT;
 173         }
 174
 175         assert (false);
 176 }
 177
 178 /** Decompress a JPEG2000 image to a bitmap.
 179  *  @param data JPEG2000 data.
 180  *  @param size Size of data in bytes.
 181  *  @param reduce A power of 2 by which to reduce the size of the decoded image;
 182  *  e.g. 0 reduces by (2^0 == 1), ie keeping the same size.
 183  *       1 reduces by (2^1 == 2), ie halving the size of the image.
 184  *  This is useful for scaling 4K DCP images down to 2K.
 185  *  @return XYZ image.
 186  */
 187 shared_ptr<libdcp::XYZFrame>
 188 libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 189 {
 190         opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
 191         opj_dparameters_t parameters;
 192         opj_set_default_decoder_parameters (&parameters);
 193         parameters.cp_reduce = reduce;
 194         opj_setup_decoder (decoder, &parameters);
 195         opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size);
 196         opj_image_t* image = opj_decode (decoder, cio);
 197         if (!image) {
 198                 opj_destroy_decompress (decoder);
 199                 opj_cio_close (cio);
 200                 boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream of " + lexical_cast<string> (size) + " bytes."));
 201         }
 202
 203         opj_cio_close (cio);
 204
 205         image->x1 = rint (float(image->x1) / pow (2, reduce));
 206         image->y1 = rint (float(image->y1) / pow (2, reduce));
 207         return shared_ptr<XYZFrame> (new XYZFrame (image));
 208 }
 209
 210 /** @param s A string.
 211  *  @return true if the string contains only space, newline or tab characters, or is empty.
 212  */
 213 bool
 214 libdcp::empty_or_white_space (string s)
 215 {
 216         for (size_t i = 0; i < s.length(); ++i) {
 217                 if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') {
 218                         return false;
 219                 }
 220         }
 221
 222         return true;
 223 }
 224
 225 void
 226 libdcp::init ()
 227 {
 228         if (xmlSecInit() < 0) {
 229                 throw MiscError ("could not initialise xmlsec");
 230         }
 231 }
 232
 233 void
 234 libdcp::add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key, string const & ns)
 235 {
 236         parent->add_child("SignatureValue", ns);
 237
 238         xmlpp::Element* key_info = parent->add_child("KeyInfo", ns);
 239         list<shared_ptr<Certificate> > c = certificates.leaf_to_root ();
 240         for (list<shared_ptr<Certificate> >::iterator i = c.begin(); i != c.end(); ++i) {
 241                 xmlpp::Element* data = key_info->add_child("X509Data", ns);
 242
 243                 {
 244                         xmlpp::Element* serial = data->add_child("X509IssuerSerial", ns);
 245                         serial->add_child("X509IssuerName", ns)->add_child_text((*i)->issuer ());
 246                         serial->add_child("X509SerialNumber", ns)->add_child_text((*i)->serial ());
 247                 }
 248
 249                 data->add_child("X509Certificate", ns)->add_child_text((*i)->certificate());
 250         }
 251
 252         xmlSecKeysMngrPtr keys_manager = xmlSecKeysMngrCreate();
 253         if (!keys_manager) {
 254                 throw MiscError ("could not create keys manager");
 255         }
 256
 257         xmlSecDSigCtx signature_context;
 258
 259         if (xmlSecDSigCtxInitialize (&signature_context, keys_manager) < 0) {
 260                 throw MiscError ("could not initialise XMLSEC context");
 261         }
 262
 263         if (xmlSecDSigCtxSign (&signature_context, parent->cobj()) < 0) {
 264                 throw MiscError ("could not sign");
 265         }
 266
 267         xmlSecDSigCtxFinalize (&signature_context);
 268         xmlSecKeysMngrDestroy (keys_manager);
 269 }
 270
 271
 272 void
 273 libdcp::add_signer (xmlpp::Element* parent, CertificateChain const & certificates, string const & ns)
 274 {
 275         xmlpp::Element* signer = parent->add_child("Signer");
 276
 277         {
 278                 xmlpp::Element* data = signer->add_child("X509Data", ns);
 279
 280                 {
 281                         xmlpp::Element* serial_element = data->add_child("X509IssuerSerial", ns);
 282                         serial_element->add_child("X509IssuerName", ns)->add_child_text (certificates.leaf()->issuer());
 283                         serial_element->add_child("X509SerialNumber", ns)->add_child_text (certificates.leaf()->serial());
 284                 }
 285
 286                 data->add_child("X509SubjectName", ns)->add_child_text (certificates.leaf()->subject());
 287         }
 288 }
 289
 290 void
 291 libdcp::sign (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key)
 292 {
 293         add_signer (parent, certificates, "dsig");
 294
 295         xmlpp::Element* signature = parent->add_child("Signature", "dsig");
 296
 297         {
 298                 xmlpp::Element* signed_info = signature->add_child ("SignedInfo", "dsig");
 299                 signed_info->add_child("CanonicalizationMethod", "dsig")->set_attribute ("Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315");
 300                 signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
 301                 {
 302                         xmlpp::Element* reference = signed_info->add_child("Reference", "dsig");
 303                         reference->set_attribute ("URI", "");
 304                         {
 305                                 xmlpp::Element* transforms = reference->add_child("Transforms", "dsig");
 306                                 transforms->add_child("Transform", "dsig")->set_attribute (
 307                                         "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature"
 308                                         );
 309                         }
 310                         reference->add_child("DigestMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
 311                         /* This will be filled in by the signing later */
 312                         reference->add_child("DigestValue", "dsig");
 313                 }
 314         }
 315
 316         add_signature_value (signature, certificates, signer_key, "dsig");
 317 }
 318
 319 bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b)
 320 {
 321         return (a.width == b.width && a.height == b.height);
 322 }
 323
 324 bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b)
 325 {
 326         return !(a == b);
 327 }
 328
 329 /** The base64 decode routine in KM_util.cpp gives different values to both
 330  *  this and the command-line base64 for some inputs.  Not sure why.
 331  */
 332 int
 333 libdcp::base64_decode (string const & in, unsigned char* out, int out_length)
 334 {
 335         BIO* b64 = BIO_new (BIO_f_base64 ());
 336
 337         /* This means the input should have no newlines */
 338         BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL);
 339
 340         /* Copy our input string, removing newlines */
 341         char in_buffer[in.size() + 1];
 342         char* p = in_buffer;
 343         for (size_t i = 0; i < in.size(); ++i) {
 344                 if (in[i] != '\n' && in[i] != '\r') {
 345                         *p++ = in[i];
 346                 }
 347         }
 348
 349         BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer);
 350         bmem = BIO_push (b64, bmem);
 351         int const N = BIO_read (bmem, out, out_length);
 352         BIO_free_all (bmem);
 353
 354         return N;
 355 }