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