sfa/trust/certificate.py

   1 #----------------------------------------------------------------------
   2 # Copyright (c) 2008 Board of Trustees, Princeton University
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and/or hardware specification (the "Work") to
   6 # deal in the Work without restriction, including without limitation the
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Work, and to permit persons to whom the Work
   9 # is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Work.
  13 #
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
  21 # IN THE WORK.
  22 #----------------------------------------------------------------------
  23
  24 ##
  25 # SFA uses two crypto libraries: pyOpenSSL and M2Crypto to implement
  26 # the necessary crypto functionality. Ideally just one of these libraries
  27 # would be used, but unfortunately each of these libraries is independently
  28 # lacking. The pyOpenSSL library is missing many necessary functions, and
  29 # the M2Crypto library has crashed inside of some of the functions. The
  30 # design decision is to use pyOpenSSL whenever possible as it seems more
  31 # stable, and only use M2Crypto for those functions that are not possible
  32 # in pyOpenSSL.
  33 #
  34 # This module exports two classes: Keypair and Certificate.
  35 ##
  36 #
  37
  38 from __future__ import print_function
  39
  40 import functools
  41 import os
  42 import tempfile
  43 import base64
  44 from tempfile import mkstemp
  45
  46 import OpenSSL
  47 # M2Crypto is imported on the fly to minimize crashes
  48 #import M2Crypto
  49
  50 from sfa.util.py23 import PY3
  51
  52 from sfa.util.faults import CertExpired, CertMissingParent, CertNotSignedByParent
  53 from sfa.util.sfalogging import logger
  54
  55 # this tends to generate quite some logs for little or no value
  56 debug_verify_chain = False
  57
  58 glo_passphrase_callback = None
  59
  60 ##
  61 # A global callback may be implemented for requesting passphrases from the
  62 # user. The function will be called with three arguments:
  63 #
  64 #    keypair_obj: the keypair object that is calling the passphrase
  65 #    string: the string containing the private key that's being loaded
  66 #    x: unknown, appears to be 0, comes from pyOpenSSL and/or m2crypto
  67 #
  68 # The callback should return a string containing the passphrase.
  69
  70
  71 def set_passphrase_callback(callback_func):
  72     global glo_passphrase_callback
  73
  74     glo_passphrase_callback = callback_func
  75
  76 ##
  77 # Sets a fixed passphrase.
  78
  79
  80 def set_passphrase(passphrase):
  81     set_passphrase_callback(lambda k, s, x: passphrase)
  82
  83 ##
  84 # Check to see if a passphrase works for a particular private key string.
  85 # Intended to be used by passphrase callbacks for input validation.
  86
  87
  88 def test_passphrase(string, passphrase):
  89     try:
  90         OpenSSL.crypto.load_privatekey(
  91             OpenSSL.crypto.FILETYPE_PEM, string, (lambda x: passphrase))
  92         return True
  93     except:
  94         return False
  95
  96
  97 def convert_public_key(key):
  98     keyconvert_path = "/usr/bin/keyconvert.py"
  99     if not os.path.isfile(keyconvert_path):
 100         raise IOError(
 101             "Could not find keyconvert in {}".format(keyconvert_path))
 102
 103     # we can only convert rsa keys
 104     if "ssh-dss" in key:
 105         raise Exception("keyconvert: dss keys are not supported")
 106
 107     (ssh_f, ssh_fn) = tempfile.mkstemp()
 108     ssl_fn = tempfile.mktemp()
 109     os.write(ssh_f, key)
 110     os.close(ssh_f)
 111
 112     cmd = keyconvert_path + " " + ssh_fn + " " + ssl_fn
 113     os.system(cmd)
 114
 115     # this check leaves the temporary file containing the public key so
 116     # that it can be expected to see why it failed.
 117     # TODO: for production, cleanup the temporary files
 118     if not os.path.exists(ssl_fn):
 119         raise Exception(
 120             "keyconvert: generated certificate not found. keyconvert may have failed.")
 121
 122     k = Keypair()
 123     try:
 124         k.load_pubkey_from_file(ssl_fn)
 125         return k
 126     except:
 127         logger.log_exc("convert_public_key caught exception")
 128         raise
 129     finally:
 130         # remove the temporary files
 131         if os.path.exists(ssh_fn):
 132             os.remove(ssh_fn)
 133         if os.path.exists(ssl_fn):
 134             os.remove(ssl_fn)
 135
 136 ##
 137 # Public-private key pairs are implemented by the Keypair class.
 138 # A Keypair object may represent both a public and private key pair, or it
 139 # may represent only a public key (this usage is consistent with OpenSSL).
 140
 141
 142 class Keypair:
 143     key = None       # public/private keypair
 144     m2key = None     # public key (m2crypto format)
 145
 146     ##
 147     # Creates a Keypair object
 148     # @param create If create==True, creates a new public/private key and
 149     #     stores it in the object
 150     # @param string If string != None, load the keypair from the string (PEM)
 151     # @param filename If filename != None, load the keypair from the file
 152
 153     def __init__(self, create=False, string=None, filename=None):
 154         if create:
 155             self.create()
 156         if string:
 157             self.load_from_string(string)
 158         if filename:
 159             self.load_from_file(filename)
 160
 161     ##
 162     # Create a RSA public/private key pair and store it inside the keypair
 163     # object
 164
 165     def create(self):
 166         self.key = OpenSSL.crypto.PKey()
 167         self.key.generate_key(OpenSSL.crypto.TYPE_RSA, 2048)
 168
 169     ##
 170     # Save the private key to a file
 171     # @param filename name of file to store the keypair in
 172
 173     def save_to_file(self, filename):
 174         open(filename, 'w').write(self.as_pem())
 175         self.filename = filename
 176
 177     ##
 178     # Load the private key from a file. Implicity the private key includes the
 179     # public key.
 180
 181     def load_from_file(self, filename):
 182         self.filename = filename
 183         buffer = open(filename, 'r').read()
 184         self.load_from_string(buffer)
 185
 186     ##
 187     # Load the private key from a string. Implicitly the private key includes
 188     # the public key.
 189
 190     def load_from_string(self, string):
 191         import M2Crypto
 192         if glo_passphrase_callback:
 193             self.key = OpenSSL.crypto.load_privatekey(
 194                 OpenSSL.crypto.FILETYPE_PEM, string, functools.partial(glo_passphrase_callback, self, string))
 195             self.m2key = M2Crypto.EVP.load_key_string(
 196                 string, functools.partial(glo_passphrase_callback, self, string))
 197         else:
 198             self.key = OpenSSL.crypto.load_privatekey(
 199                 OpenSSL.crypto.FILETYPE_PEM, string)
 200             self.m2key = M2Crypto.EVP.load_key_string(string)
 201
 202     ##
 203     #  Load the public key from a string. No private key is loaded.
 204
 205     def load_pubkey_from_file(self, filename):
 206         import M2Crypto
 207         # load the m2 public key
 208         m2rsakey = M2Crypto.RSA.load_pub_key(filename)
 209         self.m2key = M2Crypto.EVP.PKey()
 210         self.m2key.assign_rsa(m2rsakey)
 211
 212         # create an m2 x509 cert
 213         m2name = M2Crypto.X509.X509_Name()
 214         m2name.add_entry_by_txt(field="CN", type=0x1001,
 215                                 entry="junk", len=-1, loc=-1, set=0)
 216         m2x509 = M2Crypto.X509.X509()
 217         m2x509.set_pubkey(self.m2key)
 218         m2x509.set_serial_number(0)
 219         m2x509.set_issuer_name(m2name)
 220         m2x509.set_subject_name(m2name)
 221         ASN1 = M2Crypto.ASN1.ASN1_UTCTIME()
 222         ASN1.set_time(500)
 223         m2x509.set_not_before(ASN1)
 224         m2x509.set_not_after(ASN1)
 225         # x509v3 so it can have extensions
 226         # prob not necc since this cert itself is junk but still...
 227         m2x509.set_version(2)
 228         junk_key = Keypair(create=True)
 229         m2x509.sign(pkey=junk_key.get_m2_pubkey(), md="sha1")
 230
 231         # convert the m2 x509 cert to a pyopenssl x509
 232         m2pem = m2x509.as_pem()
 233         pyx509 = OpenSSL.crypto.load_certificate(
 234             OpenSSL.crypto.FILETYPE_PEM, m2pem)
 235
 236         # get the pyopenssl pkey from the pyopenssl x509
 237         self.key = pyx509.get_pubkey()
 238         self.filename = filename
 239
 240     ##
 241     # Load the public key from a string. No private key is loaded.
 242
 243     def load_pubkey_from_string(self, string):
 244         (f, fn) = tempfile.mkstemp()
 245         os.write(f, string)
 246         os.close(f)
 247         self.load_pubkey_from_file(fn)
 248         os.remove(fn)
 249
 250     ##
 251     # Return the private key in PEM format.
 252
 253     def as_pem(self):
 254         return OpenSSL.crypto.dump_privatekey(OpenSSL.crypto.FILETYPE_PEM, self.key)
 255
 256     ##
 257     # Return an M2Crypto key object
 258
 259     def get_m2_pubkey(self):
 260         import M2Crypto
 261         if not self.m2key:
 262             self.m2key = M2Crypto.EVP.load_key_string(self.as_pem())
 263         return self.m2key
 264
 265     ##
 266     # Returns a string containing the public key represented by this object.
 267
 268     def get_pubkey_string(self):
 269         m2pkey = self.get_m2_pubkey()
 270         return base64.b64encode(m2pkey.as_der())
 271
 272     ##
 273     # Return an OpenSSL pkey object
 274
 275     def get_openssl_pkey(self):
 276         return self.key
 277
 278     ##
 279     # Given another Keypair object, return TRUE if the two keys are the same.
 280
 281     def is_same(self, pkey):
 282         return self.as_pem() == pkey.as_pem()
 283
 284     def sign_string(self, data):
 285         k = self.get_m2_pubkey()
 286         k.sign_init()
 287         k.sign_update(data)
 288         return base64.b64encode(k.sign_final())
 289
 290     def verify_string(self, data, sig):
 291         import M2Crypto
 292         k = self.get_m2_pubkey()
 293         k.verify_init()
 294         k.verify_update(data)
 295         return M2Crypto.m2.verify_final(k.ctx, base64.b64decode(sig), k.pkey)
 296
 297     def compute_hash(self, value):
 298         return self.sign_string(str(value))
 299
 300     # only informative
 301     def get_filename(self):
 302         return getattr(self, 'filename', None)
 303
 304     def dump(self, *args, **kwargs):
 305         print(self.dump_string(*args, **kwargs))
 306
 307     def dump_string(self):
 308         result = ""
 309         result += "KEYPAIR: pubkey={:>40}...".format(self.get_pubkey_string())
 310         filename = self.get_filename()
 311         if filename:
 312             result += "Filename {}\n".format(filename)
 313         return result
 314
 315 ##
 316 # The certificate class implements a general purpose X509 certificate, making
 317 # use of the appropriate pyOpenSSL or M2Crypto abstractions. It also adds
 318 # several addition features, such as the ability to maintain a chain of
 319 # parent certificates, and storage of application-specific data.
 320 #
 321 # Certificates include the ability to maintain a chain of parents. Each
 322 # certificate includes a pointer to it's parent certificate. When loaded
 323 # from a file or a string, the parent chain will be automatically loaded.
 324 # When saving a certificate to a file or a string, the caller can choose
 325 # whether to save the parent certificates as well.
 326
 327
 328 class Certificate:
 329     digest = "sha256"
 330
 331 #    x509 = None
 332 #    issuerKey = None
 333 #    issuerSubject = None
 334 #    parent = None
 335     isCA = None  # will be a boolean once set
 336
 337     separator = "-----parent-----"
 338
 339     ##
 340     # Create a certificate object.
 341     #
 342     # @param lifeDays life of cert in days - default is 1825==5 years
 343     # @param create If create==True, then also create a blank X509 certificate.
 344     # @param subject If subject!=None, then create a blank certificate and set
 345     #     it's subject name.
 346     # @param string If string!=None, load the certficate from the string.
 347     # @param filename If filename!=None, load the certficiate from the file.
 348     # @param isCA If !=None, set whether this cert is for a CA
 349
 350     def __init__(self, lifeDays=1825, create=False, subject=None, string=None, filename=None, isCA=None):
 351         # these used to be defined in the class !
 352         self.x509 = None
 353         self.issuerKey = None
 354         self.issuerSubject = None
 355         self.parent = None
 356
 357         self.data = {}
 358         if create or subject:
 359             self.create(lifeDays)
 360         if subject:
 361             self.set_subject(subject)
 362         if string:
 363             self.load_from_string(string)
 364         if filename:
 365             self.load_from_file(filename)
 366
 367         # Set the CA bit if a value was supplied
 368         if isCA != None:
 369             self.set_is_ca(isCA)
 370
 371     # Create a blank X509 certificate and store it in this object.
 372
 373     def create(self, lifeDays=1825):
 374         self.x509 = OpenSSL.crypto.X509()
 375         # FIXME: Use different serial #s
 376         self.x509.set_serial_number(3)
 377         self.x509.gmtime_adj_notBefore(0)  # 0 means now
 378         self.x509.gmtime_adj_notAfter(
 379             lifeDays * 60 * 60 * 24)  # five years is default
 380         self.x509.set_version(2)  # x509v3 so it can have extensions
 381
 382     ##
 383     # Given a pyOpenSSL X509 object, store that object inside of this
 384     # certificate object.
 385
 386     def load_from_pyopenssl_x509(self, x509):
 387         self.x509 = x509
 388
 389     ##
 390     # Load the certificate from a string
 391
 392     def load_from_string(self, string):
 393         # if it is a chain of multiple certs, then split off the first one and
 394         # load it (support for the ---parent--- tag as well as normal chained
 395         # certs)
 396
 397         if string is None or string.strip() == "":
 398             logger.warn("Empty string in load_from_string")
 399             return
 400
 401         string = string.strip()
 402
 403         # If it's not in proper PEM format, wrap it
 404         if string.count('-----BEGIN CERTIFICATE') == 0:
 405             string = '-----BEGIN CERTIFICATE-----\n{}\n-----END CERTIFICATE-----'\
 406                      .format(string)
 407
 408         # If there is a PEM cert in there, but there is some other text first
 409         # such as the text of the certificate, skip the text
 410         beg = string.find('-----BEGIN CERTIFICATE')
 411         if beg > 0:
 412             # skipping over non cert beginning
 413             string = string[beg:]
 414
 415         parts = []
 416
 417         if string.count('-----BEGIN CERTIFICATE-----') > 1 and \
 418                 string.count(Certificate.separator) == 0:
 419             parts = string.split('-----END CERTIFICATE-----', 1)
 420             parts[0] += '-----END CERTIFICATE-----'
 421         else:
 422             parts = string.split(Certificate.separator, 1)
 423
 424         self.x509 = OpenSSL.crypto.load_certificate(
 425             OpenSSL.crypto.FILETYPE_PEM, parts[0])
 426
 427         if self.x509 is None:
 428             logger.warn(
 429                 "Loaded from string but cert is None: {}".format(string))
 430
 431         # if there are more certs, then create a parent and let the parent load
 432         # itself from the remainder of the string
 433         if len(parts) > 1 and parts[1] != '':
 434             self.parent = self.__class__()
 435             self.parent.load_from_string(parts[1])
 436
 437     ##
 438     # Load the certificate from a file
 439
 440     def load_from_file(self, filename):
 441         file = open(filename)
 442         string = file.read()
 443         self.load_from_string(string)
 444         self.filename = filename
 445
 446     ##
 447     # Save the certificate to a string.
 448     #
 449     # @param save_parents If save_parents==True, then also save the parent certificates.
 450
 451     def save_to_string(self, save_parents=True):
 452         if self.x509 is None:
 453             logger.warn("None cert in certificate.save_to_string")
 454             return ""
 455         string = OpenSSL.crypto.dump_certificate(
 456             OpenSSL.crypto.FILETYPE_PEM, self.x509)
 457         if PY3 and isinstance(string, bytes):
 458             string = string.decode()
 459         if save_parents and self.parent:
 460             string = string + self.parent.save_to_string(save_parents)
 461         return string
 462
 463     ##
 464     # Save the certificate to a file.
 465     # @param save_parents If save_parents==True, then also save the parent certificates.
 466
 467     def save_to_file(self, filename, save_parents=True, filep=None):
 468         string = self.save_to_string(save_parents=save_parents)
 469         if filep:
 470             f = filep
 471         else:
 472             f = open(filename, 'w')
 473         if PY3 and isinstance(string, bytes):
 474             string = string.decode()
 475         f.write(string)
 476         f.close()
 477         self.filename = filename
 478
 479     ##
 480     # Save the certificate to a random file in /tmp/
 481     # @param save_parents If save_parents==True, then also save the parent certificates.
 482     def save_to_random_tmp_file(self, save_parents=True):
 483         fp, filename = mkstemp(suffix='cert', text=True)
 484         fp = os.fdopen(fp, "w")
 485         self.save_to_file(filename, save_parents=True, filep=fp)
 486         return filename
 487
 488     ##
 489     # Sets the issuer private key and name
 490     # @param key Keypair object containing the private key of the issuer
 491     # @param subject String containing the name of the issuer
 492     # @param cert (optional) Certificate object containing the name of the issuer
 493
 494     def set_issuer(self, key, subject=None, cert=None):
 495         self.issuerKey = key
 496         if subject:
 497             # it's a mistake to use subject and cert params at the same time
 498             assert(not cert)
 499             if isinstance(subject, dict) or isinstance(subject, str):
 500                 req = OpenSSL.crypto.X509Req()
 501                 reqSubject = req.get_subject()
 502                 if isinstance(subject, dict):
 503                     for key in reqSubject.keys():
 504                         setattr(reqSubject, key, subject[key])
 505                 else:
 506                     setattr(reqSubject, "CN", subject)
 507                 subject = reqSubject
 508                 # subject is not valid once req is out of scope, so save req
 509                 self.issuerReq = req
 510         if cert:
 511             # if a cert was supplied, then get the subject from the cert
 512             subject = cert.x509.get_subject()
 513         assert(subject)
 514         self.issuerSubject = subject
 515
 516     ##
 517     # Get the issuer name
 518
 519     def get_issuer(self, which="CN"):
 520         x = self.x509.get_issuer()
 521         return getattr(x, which)
 522
 523     ##
 524     # Set the subject name of the certificate
 525
 526     def set_subject(self, name):
 527         req = OpenSSL.crypto.X509Req()
 528         subj = req.get_subject()
 529         if isinstance(name, dict):
 530             for key in name.keys():
 531                 setattr(subj, key, name[key])
 532         else:
 533             setattr(subj, "CN", name)
 534         self.x509.set_subject(subj)
 535
 536     ##
 537     # Get the subject name of the certificate
 538
 539     def get_subject(self, which="CN"):
 540         x = self.x509.get_subject()
 541         return getattr(x, which)
 542
 543     ##
 544     # Get a pretty-print subject name of the certificate
 545     # let's try to make this a little more usable as is makes logs hairy
 546     # FIXME: Consider adding 'urn:publicid' and 'uuid' back for GENI?
 547     pretty_fields = ['email']
 548
 549     def filter_chunk(self, chunk):
 550         for field in self.pretty_fields:
 551             if field in chunk:
 552                 return " " + chunk
 553
 554     def pretty_cert(self):
 555         message = "[Cert."
 556         x = self.x509.get_subject()
 557         ou = getattr(x, "OU")
 558         if ou:
 559             message += " OU: {}".format(ou)
 560         cn = getattr(x, "CN")
 561         if cn:
 562             message += " CN: {}".format(cn)
 563         data = self.get_data(field='subjectAltName')
 564         if data:
 565             message += " SubjectAltName:"
 566             counter = 0
 567             filtered = [self.filter_chunk(chunk) for chunk in data.split()]
 568             message += " ".join([f for f in filtered if f])
 569             omitted = len([f for f in filtered if not f])
 570             if omitted:
 571                 message += "..+{} omitted".format(omitted)
 572         message += "]"
 573         return message
 574
 575     def pretty_chain(self):
 576         message = "{}".format(self.x509.get_subject())
 577         parent = self.parent
 578         while parent:
 579             message += " -> {}".format(parent.x509.get_subject())
 580             parent = parent.parent
 581         return message
 582
 583     def pretty_name(self):
 584         return self.get_filename() or self.pretty_chain()
 585
 586     ##
 587     # Get the public key of the certificate.
 588     #
 589     # @param key Keypair object containing the public key
 590
 591     def set_pubkey(self, key):
 592         assert(isinstance(key, Keypair))
 593         self.x509.set_pubkey(key.get_openssl_pkey())
 594
 595     ##
 596     # Get the public key of the certificate.
 597     # It is returned in the form of a Keypair object.
 598
 599     def get_pubkey(self):
 600         import M2Crypto
 601         m2x509 = M2Crypto.X509.load_cert_string(self.save_to_string())
 602         pkey = Keypair()
 603         pkey.key = self.x509.get_pubkey()
 604         pkey.m2key = m2x509.get_pubkey()
 605         return pkey
 606
 607     def set_intermediate_ca(self, val):
 608         return self.set_is_ca(val)
 609
 610     # Set whether this cert is for a CA. All signers and only signers should be CAs.
 611     # The local member starts unset, letting us check that you only set it once
 612     # @param val Boolean indicating whether this cert is for a CA
 613     def set_is_ca(self, val):
 614         if val is None:
 615             return
 616
 617         if self.isCA != None:
 618             # Can't double set properties
 619             raise Exception("Cannot set basicConstraints CA:?? more than once. "
 620                             "Was {}, trying to set as {}%s".format(self.isCA, val))
 621
 622         self.isCA = val
 623         if val:
 624             self.add_extension('basicConstraints', 1, 'CA:TRUE')
 625         else:
 626             self.add_extension('basicConstraints', 1, 'CA:FALSE')
 627
 628     ##
 629     # Add an X509 extension to the certificate. Add_extension can only be called
 630     # once for a particular extension name, due to limitations in the underlying
 631     # library.
 632     #
 633     # @param name string containing name of extension
 634     # @param value string containing value of the extension
 635
 636     def add_extension(self, name, critical, value):
 637         oldExtVal = None
 638         try:
 639             oldExtVal = self.get_extension(name)
 640         except:
 641             # M2Crypto LookupError when the extension isn't there (yet)
 642             pass
 643
 644         # This code limits you from adding the extension with the same value
 645         # The method comment says you shouldn't do this with the same name
 646         # But actually it (m2crypto) appears to allow you to do this.
 647         if oldExtVal and oldExtVal == value:
 648             # don't add this extension again
 649             # just do nothing as here
 650             return
 651         # FIXME: What if they are trying to set with a different value?
 652         # Is this ever OK? Or should we raise an exception?
 653 #        elif oldExtVal:
 654 #            raise "Cannot add extension {} which had val {} with new val {}".format(name, oldExtVal, value)
 655
 656         ext = OpenSSL.crypto.X509Extension(name, critical, value)
 657         self.x509.add_extensions([ext])
 658
 659     ##
 660     # Get an X509 extension from the certificate
 661
 662     def get_extension(self, name):
 663
 664         import M2Crypto
 665         if name is None:
 666             return None
 667
 668         certstr = self.save_to_string()
 669         if certstr is None or certstr == "":
 670             return None
 671         # pyOpenSSL does not have a way to get extensions
 672         m2x509 = M2Crypto.X509.load_cert_string(certstr)
 673         if m2x509 is None:
 674             logger.warn("No cert loaded in get_extension")
 675             return None
 676         if m2x509.get_ext(name) is None:
 677             return None
 678         value = m2x509.get_ext(name).get_value()
 679
 680         return value
 681
 682     ##
 683     # Set_data is a wrapper around add_extension. It stores the parameter str in
 684     # the X509 subject_alt_name extension. Set_data can only be called once, due
 685     # to limitations in the underlying library.
 686
 687     def set_data(self, str, field='subjectAltName'):
 688         # pyOpenSSL only allows us to add extensions, so if we try to set the
 689         # same extension more than once, it will not work
 690         if field in self.data:
 691             raise Exception("Cannot set {} more than once".format(field))
 692         self.data[field] = str
 693         self.add_extension(field, 0, str)
 694
 695     ##
 696     # Return the data string that was previously set with set_data
 697
 698     def get_data(self, field='subjectAltName'):
 699         if field in self.data:
 700             return self.data[field]
 701
 702         try:
 703             uri = self.get_extension(field)
 704             self.data[field] = uri
 705         except LookupError:
 706             return None
 707
 708         return self.data[field]
 709
 710     ##
 711     # Sign the certificate using the issuer private key and issuer subject
 712     # previous set with set_issuer().
 713
 714     def sign(self):
 715         logger.debug('certificate.sign')
 716         assert self.x509 != None
 717         assert self.issuerSubject != None
 718         assert self.issuerKey != None
 719         self.x509.set_issuer(self.issuerSubject)
 720         self.x509.sign(self.issuerKey.get_openssl_pkey(), self.digest)
 721
 722     ##
 723     # Verify the authenticity of a certificate.
 724     # @param pkey is a Keypair object representing a public key. If Pkey
 725     #     did not sign the certificate, then an exception will be thrown.
 726
 727     def verify(self, pubkey):
 728         import M2Crypto
 729         # pyOpenSSL does not have a way to verify signatures
 730         m2x509 = M2Crypto.X509.load_cert_string(self.save_to_string())
 731         m2pubkey = pubkey.get_m2_pubkey()
 732         # verify it
 733         # https://www.openssl.org/docs/man1.1.0/crypto/X509_verify.html
 734         # verify returns
 735         # 1  if it checks out
 736         # 0  if if does not
 737         # -1 if it could not be checked 'for some reason'
 738         m2result = m2x509.verify(m2pubkey)
 739         result = m2result == 1
 740         if debug_verify_chain:
 741             logger.debug("Certificate.verify: <- {} (m2={}) ({} x {})"
 742                          .format(result, m2result, self.pretty_cert(), m2pubkey))
 743         return result
 744
 745         # XXX alternatively, if openssl has been patched, do the much simpler:
 746         # try:
 747         #   self.x509.verify(pkey.get_openssl_key())
 748         #   return 1
 749         # except:
 750         #   return 0
 751
 752     ##
 753     # Return True if pkey is identical to the public key that is contained in the certificate.
 754     # @param pkey Keypair object
 755
 756     def is_pubkey(self, pkey):
 757         return self.get_pubkey().is_same(pkey)
 758
 759     ##
 760     # Given a certificate cert, verify that this certificate was signed by the
 761     # public key contained in cert. Throw an exception otherwise.
 762     #
 763     # @param cert certificate object
 764
 765     def is_signed_by_cert(self, cert):
 766         logger.debug("Certificate.is_signed_by_cert -> invoking verify")
 767         k = cert.get_pubkey()
 768         result = self.verify(k)
 769         return result
 770
 771     ##
 772     # Set the parent certficiate.
 773     #
 774     # @param p certificate object.
 775
 776     def set_parent(self, p):
 777         self.parent = p
 778
 779     ##
 780     # Return the certificate object of the parent of this certificate.
 781
 782     def get_parent(self):
 783         return self.parent
 784
 785     ##
 786     # Verification examines a chain of certificates to ensure that each parent
 787     # signs the child, and that some certificate in the chain is signed by a
 788     # trusted certificate.
 789     #
 790     # Verification is a basic recursion: <pre>
 791     #     if this_certificate was signed by trusted_certs:
 792     #         return
 793     #     else
 794     #         return verify_chain(parent, trusted_certs)
 795     # </pre>
 796     #
 797     # At each recursion, the parent is tested to ensure that it did sign the
 798     # child. If a parent did not sign a child, then an exception is thrown. If
 799     # the bottom of the recursion is reached and the certificate does not match
 800     # a trusted root, then an exception is thrown.
 801     # Also require that parents are CAs.
 802     #
 803     # @param Trusted_certs is a list of certificates that are trusted.
 804     #
 805
 806     def verify_chain(self, trusted_certs=None):
 807         # Verify a chain of certificates. Each certificate must be signed by
 808         # the public key contained in it's parent. The chain is recursed
 809         # until a certificate is found that is signed by a trusted root.
 810
 811         logger.debug("Certificate.verify_chain {}".format(self.pretty_name()))
 812         # verify expiration time
 813         if self.x509.has_expired():
 814             if debug_verify_chain:
 815                 logger.debug("verify_chain: NO, Certificate {} has expired"
 816                              .format(self.pretty_cert()))
 817             raise CertExpired(self.pretty_cert(), "client cert")
 818
 819         # if this cert is signed by a trusted_cert, then we are set
 820         for i, trusted_cert in enumerate(trusted_certs, 1):
 821             logger.debug("Certificate.verify_chain - trying trusted #{} : {}"
 822                          .format(i, trusted_cert.pretty_name()))
 823             if self.is_signed_by_cert(trusted_cert):
 824                 # verify expiration of trusted_cert ?
 825                 if not trusted_cert.x509.has_expired():
 826                     if debug_verify_chain:
 827                         logger.debug("verify_chain: YES. Cert {} signed by trusted cert {}"
 828                                      .format(self.pretty_name(), trusted_cert.pretty_name()))
 829                     return trusted_cert
 830                 else:
 831                     if debug_verify_chain:
 832                         logger.debug("verify_chain: NO. Cert {} is signed by trusted_cert {}, "
 833                                      "but that signer is expired..."
 834                                      .format(self.pretty_cert(), trusted_cert.pretty_cert()))
 835                     raise CertExpired("{} signer trusted_cert {}"
 836                                       .format(self.pretty_name(), trusted_cert.pretty_name()))
 837             else:
 838                 logger.debug("verify_chain: not a direct descendant of a trusted root".
 839                              format(self.pretty_name(), trusted_cert))
 840
 841         # if there is no parent, then no way to verify the chain
 842         if not self.parent:
 843             if debug_verify_chain:
 844                 logger.debug("verify_chain: NO. {} has no parent "
 845                              "and issuer {} is not in {} trusted roots"
 846                              .format(self.pretty_name(), self.get_issuer(), len(trusted_certs)))
 847             raise CertMissingParent("{}: Issuer {} is not one of the {} trusted roots, "
 848                                     "and cert has no parent."
 849                                     .format(self.pretty_name(), self.get_issuer(), len(trusted_certs)))
 850
 851         # if it wasn't signed by the parent...
 852         if not self.is_signed_by_cert(self.parent):
 853             if debug_verify_chain:
 854                 logger.debug("verify_chain: NO. {} is not signed by parent {}"
 855                              .format(self.pretty_name(),
 856                                      self.parent.pretty_name()))
 857                 self.save_to_file("/tmp/xxx-capture.pem", save_parents=True)
 858             raise CertNotSignedByParent("{}: Parent {}, issuer {}"
 859                                         .format(self.pretty_name(),
 860                                                 self.parent.pretty_name(),
 861                                                 self.get_issuer()))
 862
 863         # Confirm that the parent is a CA. Only CAs can be trusted as
 864         # signers.
 865         # Note that trusted roots are not parents, so don't need to be
 866         # CAs.
 867         # Ugly - cert objects aren't parsed so we need to read the
 868         # extension and hope there are no other basicConstraints
 869         if not self.parent.isCA and not (self.parent.get_extension('basicConstraints') == 'CA:TRUE'):
 870             logger.warn("verify_chain: cert {}'s parent {} is not a CA"
 871                         .format(self.pretty_name(), self.parent.pretty_name()))
 872             raise CertNotSignedByParent("{}: Parent {} not a CA"
 873                                         .format(self.pretty_name(), self.parent.pretty_name()))
 874
 875         # if the parent isn't verified...
 876         if debug_verify_chain:
 877             logger.debug("verify_chain: .. {}, -> verifying parent {}"
 878                          .format(self.pretty_name(),self.parent.pretty_name()))
 879         self.parent.verify_chain(trusted_certs)
 880
 881         return
 882
 883     # more introspection
 884     def get_extensions(self):
 885         import M2Crypto
 886         # pyOpenSSL does not have a way to get extensions
 887         triples = []
 888         m2x509 = M2Crypto.X509.load_cert_string(self.save_to_string())
 889         nb_extensions = m2x509.get_ext_count()
 890         logger.debug("X509 had {} extensions".format(nb_extensions))
 891         for i in range(nb_extensions):
 892             ext = m2x509.get_ext_at(i)
 893             triples.append(
 894                 (ext.get_name(), ext.get_value(), ext.get_critical(),))
 895         return triples
 896
 897     def get_data_names(self):
 898         return self.data.keys()
 899
 900     def get_all_datas(self):
 901         triples = self.get_extensions()
 902         for name in self.get_data_names():
 903             triples.append((name, self.get_data(name), 'data',))
 904         return triples
 905
 906     # only informative
 907     def get_filename(self):
 908         return getattr(self, 'filename', None)
 909
 910     def dump(self, *args, **kwargs):
 911         print(self.dump_string(*args, **kwargs))
 912
 913     def dump_string(self, show_extensions=False):
 914         result = ""
 915         result += "CERTIFICATE for {}\n".format(self.pretty_cert())
 916         result += "Issued by {}\n".format(self.get_issuer())
 917         filename = self.get_filename()
 918         if filename:
 919             result += "Filename {}\n".format(filename)
 920         if show_extensions:
 921             all_datas = self.get_all_datas()
 922             result += " has {} extensions/data attached".format(len(all_datas))
 923             for n, v, c in all_datas:
 924                 if c == 'data':
 925                     result += "   data: {}={}\n".format(n, v)
 926                 else:
 927                     result += "    ext: {} (crit={})=<<<{}>>>\n".format(n, c, v)
 928         return result