You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

754 lines
23 KiB

  1. # This file is dual licensed under the terms of the Apache License, Version
  2. # 2.0, and the BSD License. See the LICENSE file in the root of this repository
  3. # for complete details.
  4. from __future__ import absolute_import, division, print_function
  5. import abc
  6. import datetime
  7. import os
  8. from enum import Enum
  9. import six
  10. from cryptography import utils
  11. from cryptography.hazmat.primitives.asymmetric import dsa, ec, rsa
  12. from cryptography.x509.extensions import Extension, ExtensionType
  13. from cryptography.x509.name import Name
  14. _EARLIEST_UTC_TIME = datetime.datetime(1950, 1, 1)
  15. def _reject_duplicate_extension(extension, extensions):
  16. # This is quadratic in the number of extensions
  17. for e in extensions:
  18. if e.oid == extension.oid:
  19. raise ValueError('This extension has already been set.')
  20. def _convert_to_naive_utc_time(time):
  21. """Normalizes a datetime to a naive datetime in UTC.
  22. time -- datetime to normalize. Assumed to be in UTC if not timezone
  23. aware.
  24. """
  25. if time.tzinfo is not None:
  26. offset = time.utcoffset()
  27. offset = offset if offset else datetime.timedelta()
  28. return time.replace(tzinfo=None) - offset
  29. else:
  30. return time
  31. class Version(Enum):
  32. v1 = 0
  33. v3 = 2
  34. def load_pem_x509_certificate(data, backend):
  35. return backend.load_pem_x509_certificate(data)
  36. def load_der_x509_certificate(data, backend):
  37. return backend.load_der_x509_certificate(data)
  38. def load_pem_x509_csr(data, backend):
  39. return backend.load_pem_x509_csr(data)
  40. def load_der_x509_csr(data, backend):
  41. return backend.load_der_x509_csr(data)
  42. def load_pem_x509_crl(data, backend):
  43. return backend.load_pem_x509_crl(data)
  44. def load_der_x509_crl(data, backend):
  45. return backend.load_der_x509_crl(data)
  46. class InvalidVersion(Exception):
  47. def __init__(self, msg, parsed_version):
  48. super(InvalidVersion, self).__init__(msg)
  49. self.parsed_version = parsed_version
  50. @six.add_metaclass(abc.ABCMeta)
  51. class Certificate(object):
  52. @abc.abstractmethod
  53. def fingerprint(self, algorithm):
  54. """
  55. Returns bytes using digest passed.
  56. """
  57. @abc.abstractproperty
  58. def serial_number(self):
  59. """
  60. Returns certificate serial number
  61. """
  62. @abc.abstractproperty
  63. def version(self):
  64. """
  65. Returns the certificate version
  66. """
  67. @abc.abstractmethod
  68. def public_key(self):
  69. """
  70. Returns the public key
  71. """
  72. @abc.abstractproperty
  73. def not_valid_before(self):
  74. """
  75. Not before time (represented as UTC datetime)
  76. """
  77. @abc.abstractproperty
  78. def not_valid_after(self):
  79. """
  80. Not after time (represented as UTC datetime)
  81. """
  82. @abc.abstractproperty
  83. def issuer(self):
  84. """
  85. Returns the issuer name object.
  86. """
  87. @abc.abstractproperty
  88. def subject(self):
  89. """
  90. Returns the subject name object.
  91. """
  92. @abc.abstractproperty
  93. def signature_hash_algorithm(self):
  94. """
  95. Returns a HashAlgorithm corresponding to the type of the digest signed
  96. in the certificate.
  97. """
  98. @abc.abstractproperty
  99. def signature_algorithm_oid(self):
  100. """
  101. Returns the ObjectIdentifier of the signature algorithm.
  102. """
  103. @abc.abstractproperty
  104. def extensions(self):
  105. """
  106. Returns an Extensions object.
  107. """
  108. @abc.abstractproperty
  109. def signature(self):
  110. """
  111. Returns the signature bytes.
  112. """
  113. @abc.abstractproperty
  114. def tbs_certificate_bytes(self):
  115. """
  116. Returns the tbsCertificate payload bytes as defined in RFC 5280.
  117. """
  118. @abc.abstractmethod
  119. def __eq__(self, other):
  120. """
  121. Checks equality.
  122. """
  123. @abc.abstractmethod
  124. def __ne__(self, other):
  125. """
  126. Checks not equal.
  127. """
  128. @abc.abstractmethod
  129. def __hash__(self):
  130. """
  131. Computes a hash.
  132. """
  133. @abc.abstractmethod
  134. def public_bytes(self, encoding):
  135. """
  136. Serializes the certificate to PEM or DER format.
  137. """
  138. @six.add_metaclass(abc.ABCMeta)
  139. class CertificateRevocationList(object):
  140. @abc.abstractmethod
  141. def public_bytes(self, encoding):
  142. """
  143. Serializes the CRL to PEM or DER format.
  144. """
  145. @abc.abstractmethod
  146. def fingerprint(self, algorithm):
  147. """
  148. Returns bytes using digest passed.
  149. """
  150. @abc.abstractmethod
  151. def get_revoked_certificate_by_serial_number(self, serial_number):
  152. """
  153. Returns an instance of RevokedCertificate or None if the serial_number
  154. is not in the CRL.
  155. """
  156. @abc.abstractproperty
  157. def signature_hash_algorithm(self):
  158. """
  159. Returns a HashAlgorithm corresponding to the type of the digest signed
  160. in the certificate.
  161. """
  162. @abc.abstractproperty
  163. def signature_algorithm_oid(self):
  164. """
  165. Returns the ObjectIdentifier of the signature algorithm.
  166. """
  167. @abc.abstractproperty
  168. def issuer(self):
  169. """
  170. Returns the X509Name with the issuer of this CRL.
  171. """
  172. @abc.abstractproperty
  173. def next_update(self):
  174. """
  175. Returns the date of next update for this CRL.
  176. """
  177. @abc.abstractproperty
  178. def last_update(self):
  179. """
  180. Returns the date of last update for this CRL.
  181. """
  182. @abc.abstractproperty
  183. def extensions(self):
  184. """
  185. Returns an Extensions object containing a list of CRL extensions.
  186. """
  187. @abc.abstractproperty
  188. def signature(self):
  189. """
  190. Returns the signature bytes.
  191. """
  192. @abc.abstractproperty
  193. def tbs_certlist_bytes(self):
  194. """
  195. Returns the tbsCertList payload bytes as defined in RFC 5280.
  196. """
  197. @abc.abstractmethod
  198. def __eq__(self, other):
  199. """
  200. Checks equality.
  201. """
  202. @abc.abstractmethod
  203. def __ne__(self, other):
  204. """
  205. Checks not equal.
  206. """
  207. @abc.abstractmethod
  208. def __len__(self):
  209. """
  210. Number of revoked certificates in the CRL.
  211. """
  212. @abc.abstractmethod
  213. def __getitem__(self, idx):
  214. """
  215. Returns a revoked certificate (or slice of revoked certificates).
  216. """
  217. @abc.abstractmethod
  218. def __iter__(self):
  219. """
  220. Iterator over the revoked certificates
  221. """
  222. @abc.abstractmethod
  223. def is_signature_valid(self, public_key):
  224. """
  225. Verifies signature of revocation list against given public key.
  226. """
  227. @six.add_metaclass(abc.ABCMeta)
  228. class CertificateSigningRequest(object):
  229. @abc.abstractmethod
  230. def __eq__(self, other):
  231. """
  232. Checks equality.
  233. """
  234. @abc.abstractmethod
  235. def __ne__(self, other):
  236. """
  237. Checks not equal.
  238. """
  239. @abc.abstractmethod
  240. def __hash__(self):
  241. """
  242. Computes a hash.
  243. """
  244. @abc.abstractmethod
  245. def public_key(self):
  246. """
  247. Returns the public key
  248. """
  249. @abc.abstractproperty
  250. def subject(self):
  251. """
  252. Returns the subject name object.
  253. """
  254. @abc.abstractproperty
  255. def signature_hash_algorithm(self):
  256. """
  257. Returns a HashAlgorithm corresponding to the type of the digest signed
  258. in the certificate.
  259. """
  260. @abc.abstractproperty
  261. def signature_algorithm_oid(self):
  262. """
  263. Returns the ObjectIdentifier of the signature algorithm.
  264. """
  265. @abc.abstractproperty
  266. def extensions(self):
  267. """
  268. Returns the extensions in the signing request.
  269. """
  270. @abc.abstractmethod
  271. def public_bytes(self, encoding):
  272. """
  273. Encodes the request to PEM or DER format.
  274. """
  275. @abc.abstractproperty
  276. def signature(self):
  277. """
  278. Returns the signature bytes.
  279. """
  280. @abc.abstractproperty
  281. def tbs_certrequest_bytes(self):
  282. """
  283. Returns the PKCS#10 CertificationRequestInfo bytes as defined in RFC
  284. 2986.
  285. """
  286. @abc.abstractproperty
  287. def is_signature_valid(self):
  288. """
  289. Verifies signature of signing request.
  290. """
  291. @six.add_metaclass(abc.ABCMeta)
  292. class RevokedCertificate(object):
  293. @abc.abstractproperty
  294. def serial_number(self):
  295. """
  296. Returns the serial number of the revoked certificate.
  297. """
  298. @abc.abstractproperty
  299. def revocation_date(self):
  300. """
  301. Returns the date of when this certificate was revoked.
  302. """
  303. @abc.abstractproperty
  304. def extensions(self):
  305. """
  306. Returns an Extensions object containing a list of Revoked extensions.
  307. """
  308. class CertificateSigningRequestBuilder(object):
  309. def __init__(self, subject_name=None, extensions=[]):
  310. """
  311. Creates an empty X.509 certificate request (v1).
  312. """
  313. self._subject_name = subject_name
  314. self._extensions = extensions
  315. def subject_name(self, name):
  316. """
  317. Sets the certificate requestor's distinguished name.
  318. """
  319. if not isinstance(name, Name):
  320. raise TypeError('Expecting x509.Name object.')
  321. if self._subject_name is not None:
  322. raise ValueError('The subject name may only be set once.')
  323. return CertificateSigningRequestBuilder(name, self._extensions)
  324. def add_extension(self, extension, critical):
  325. """
  326. Adds an X.509 extension to the certificate request.
  327. """
  328. if not isinstance(extension, ExtensionType):
  329. raise TypeError("extension must be an ExtensionType")
  330. extension = Extension(extension.oid, critical, extension)
  331. _reject_duplicate_extension(extension, self._extensions)
  332. return CertificateSigningRequestBuilder(
  333. self._subject_name, self._extensions + [extension]
  334. )
  335. def sign(self, private_key, algorithm, backend):
  336. """
  337. Signs the request using the requestor's private key.
  338. """
  339. if self._subject_name is None:
  340. raise ValueError("A CertificateSigningRequest must have a subject")
  341. return backend.create_x509_csr(self, private_key, algorithm)
  342. class CertificateBuilder(object):
  343. def __init__(self, issuer_name=None, subject_name=None,
  344. public_key=None, serial_number=None, not_valid_before=None,
  345. not_valid_after=None, extensions=[]):
  346. self._version = Version.v3
  347. self._issuer_name = issuer_name
  348. self._subject_name = subject_name
  349. self._public_key = public_key
  350. self._serial_number = serial_number
  351. self._not_valid_before = not_valid_before
  352. self._not_valid_after = not_valid_after
  353. self._extensions = extensions
  354. def issuer_name(self, name):
  355. """
  356. Sets the CA's distinguished name.
  357. """
  358. if not isinstance(name, Name):
  359. raise TypeError('Expecting x509.Name object.')
  360. if self._issuer_name is not None:
  361. raise ValueError('The issuer name may only be set once.')
  362. return CertificateBuilder(
  363. name, self._subject_name, self._public_key,
  364. self._serial_number, self._not_valid_before,
  365. self._not_valid_after, self._extensions
  366. )
  367. def subject_name(self, name):
  368. """
  369. Sets the requestor's distinguished name.
  370. """
  371. if not isinstance(name, Name):
  372. raise TypeError('Expecting x509.Name object.')
  373. if self._subject_name is not None:
  374. raise ValueError('The subject name may only be set once.')
  375. return CertificateBuilder(
  376. self._issuer_name, name, self._public_key,
  377. self._serial_number, self._not_valid_before,
  378. self._not_valid_after, self._extensions
  379. )
  380. def public_key(self, key):
  381. """
  382. Sets the requestor's public key (as found in the signing request).
  383. """
  384. if not isinstance(key, (dsa.DSAPublicKey, rsa.RSAPublicKey,
  385. ec.EllipticCurvePublicKey)):
  386. raise TypeError('Expecting one of DSAPublicKey, RSAPublicKey,'
  387. ' or EllipticCurvePublicKey.')
  388. if self._public_key is not None:
  389. raise ValueError('The public key may only be set once.')
  390. return CertificateBuilder(
  391. self._issuer_name, self._subject_name, key,
  392. self._serial_number, self._not_valid_before,
  393. self._not_valid_after, self._extensions
  394. )
  395. def serial_number(self, number):
  396. """
  397. Sets the certificate serial number.
  398. """
  399. if not isinstance(number, six.integer_types):
  400. raise TypeError('Serial number must be of integral type.')
  401. if self._serial_number is not None:
  402. raise ValueError('The serial number may only be set once.')
  403. if number <= 0:
  404. raise ValueError('The serial number should be positive.')
  405. # ASN.1 integers are always signed, so most significant bit must be
  406. # zero.
  407. if number.bit_length() >= 160: # As defined in RFC 5280
  408. raise ValueError('The serial number should not be more than 159 '
  409. 'bits.')
  410. return CertificateBuilder(
  411. self._issuer_name, self._subject_name,
  412. self._public_key, number, self._not_valid_before,
  413. self._not_valid_after, self._extensions
  414. )
  415. def not_valid_before(self, time):
  416. """
  417. Sets the certificate activation time.
  418. """
  419. if not isinstance(time, datetime.datetime):
  420. raise TypeError('Expecting datetime object.')
  421. if self._not_valid_before is not None:
  422. raise ValueError('The not valid before may only be set once.')
  423. time = _convert_to_naive_utc_time(time)
  424. if time < _EARLIEST_UTC_TIME:
  425. raise ValueError('The not valid before date must be on or after'
  426. ' 1950 January 1).')
  427. if self._not_valid_after is not None and time > self._not_valid_after:
  428. raise ValueError(
  429. 'The not valid before date must be before the not valid after '
  430. 'date.'
  431. )
  432. return CertificateBuilder(
  433. self._issuer_name, self._subject_name,
  434. self._public_key, self._serial_number, time,
  435. self._not_valid_after, self._extensions
  436. )
  437. def not_valid_after(self, time):
  438. """
  439. Sets the certificate expiration time.
  440. """
  441. if not isinstance(time, datetime.datetime):
  442. raise TypeError('Expecting datetime object.')
  443. if self._not_valid_after is not None:
  444. raise ValueError('The not valid after may only be set once.')
  445. time = _convert_to_naive_utc_time(time)
  446. if time < _EARLIEST_UTC_TIME:
  447. raise ValueError('The not valid after date must be on or after'
  448. ' 1950 January 1.')
  449. if (self._not_valid_before is not None and
  450. time < self._not_valid_before):
  451. raise ValueError(
  452. 'The not valid after date must be after the not valid before '
  453. 'date.'
  454. )
  455. return CertificateBuilder(
  456. self._issuer_name, self._subject_name,
  457. self._public_key, self._serial_number, self._not_valid_before,
  458. time, self._extensions
  459. )
  460. def add_extension(self, extension, critical):
  461. """
  462. Adds an X.509 extension to the certificate.
  463. """
  464. if not isinstance(extension, ExtensionType):
  465. raise TypeError("extension must be an ExtensionType")
  466. extension = Extension(extension.oid, critical, extension)
  467. _reject_duplicate_extension(extension, self._extensions)
  468. return CertificateBuilder(
  469. self._issuer_name, self._subject_name,
  470. self._public_key, self._serial_number, self._not_valid_before,
  471. self._not_valid_after, self._extensions + [extension]
  472. )
  473. def sign(self, private_key, algorithm, backend):
  474. """
  475. Signs the certificate using the CA's private key.
  476. """
  477. if self._subject_name is None:
  478. raise ValueError("A certificate must have a subject name")
  479. if self._issuer_name is None:
  480. raise ValueError("A certificate must have an issuer name")
  481. if self._serial_number is None:
  482. raise ValueError("A certificate must have a serial number")
  483. if self._not_valid_before is None:
  484. raise ValueError("A certificate must have a not valid before time")
  485. if self._not_valid_after is None:
  486. raise ValueError("A certificate must have a not valid after time")
  487. if self._public_key is None:
  488. raise ValueError("A certificate must have a public key")
  489. return backend.create_x509_certificate(self, private_key, algorithm)
  490. class CertificateRevocationListBuilder(object):
  491. def __init__(self, issuer_name=None, last_update=None, next_update=None,
  492. extensions=[], revoked_certificates=[]):
  493. self._issuer_name = issuer_name
  494. self._last_update = last_update
  495. self._next_update = next_update
  496. self._extensions = extensions
  497. self._revoked_certificates = revoked_certificates
  498. def issuer_name(self, issuer_name):
  499. if not isinstance(issuer_name, Name):
  500. raise TypeError('Expecting x509.Name object.')
  501. if self._issuer_name is not None:
  502. raise ValueError('The issuer name may only be set once.')
  503. return CertificateRevocationListBuilder(
  504. issuer_name, self._last_update, self._next_update,
  505. self._extensions, self._revoked_certificates
  506. )
  507. def last_update(self, last_update):
  508. if not isinstance(last_update, datetime.datetime):
  509. raise TypeError('Expecting datetime object.')
  510. if self._last_update is not None:
  511. raise ValueError('Last update may only be set once.')
  512. last_update = _convert_to_naive_utc_time(last_update)
  513. if last_update < _EARLIEST_UTC_TIME:
  514. raise ValueError('The last update date must be on or after'
  515. ' 1950 January 1.')
  516. if self._next_update is not None and last_update > self._next_update:
  517. raise ValueError(
  518. 'The last update date must be before the next update date.'
  519. )
  520. return CertificateRevocationListBuilder(
  521. self._issuer_name, last_update, self._next_update,
  522. self._extensions, self._revoked_certificates
  523. )
  524. def next_update(self, next_update):
  525. if not isinstance(next_update, datetime.datetime):
  526. raise TypeError('Expecting datetime object.')
  527. if self._next_update is not None:
  528. raise ValueError('Last update may only be set once.')
  529. next_update = _convert_to_naive_utc_time(next_update)
  530. if next_update < _EARLIEST_UTC_TIME:
  531. raise ValueError('The last update date must be on or after'
  532. ' 1950 January 1.')
  533. if self._last_update is not None and next_update < self._last_update:
  534. raise ValueError(
  535. 'The next update date must be after the last update date.'
  536. )
  537. return CertificateRevocationListBuilder(
  538. self._issuer_name, self._last_update, next_update,
  539. self._extensions, self._revoked_certificates
  540. )
  541. def add_extension(self, extension, critical):
  542. """
  543. Adds an X.509 extension to the certificate revocation list.
  544. """
  545. if not isinstance(extension, ExtensionType):
  546. raise TypeError("extension must be an ExtensionType")
  547. extension = Extension(extension.oid, critical, extension)
  548. _reject_duplicate_extension(extension, self._extensions)
  549. return CertificateRevocationListBuilder(
  550. self._issuer_name, self._last_update, self._next_update,
  551. self._extensions + [extension], self._revoked_certificates
  552. )
  553. def add_revoked_certificate(self, revoked_certificate):
  554. """
  555. Adds a revoked certificate to the CRL.
  556. """
  557. if not isinstance(revoked_certificate, RevokedCertificate):
  558. raise TypeError("Must be an instance of RevokedCertificate")
  559. return CertificateRevocationListBuilder(
  560. self._issuer_name, self._last_update,
  561. self._next_update, self._extensions,
  562. self._revoked_certificates + [revoked_certificate]
  563. )
  564. def sign(self, private_key, algorithm, backend):
  565. if self._issuer_name is None:
  566. raise ValueError("A CRL must have an issuer name")
  567. if self._last_update is None:
  568. raise ValueError("A CRL must have a last update time")
  569. if self._next_update is None:
  570. raise ValueError("A CRL must have a next update time")
  571. return backend.create_x509_crl(self, private_key, algorithm)
  572. class RevokedCertificateBuilder(object):
  573. def __init__(self, serial_number=None, revocation_date=None,
  574. extensions=[]):
  575. self._serial_number = serial_number
  576. self._revocation_date = revocation_date
  577. self._extensions = extensions
  578. def serial_number(self, number):
  579. if not isinstance(number, six.integer_types):
  580. raise TypeError('Serial number must be of integral type.')
  581. if self._serial_number is not None:
  582. raise ValueError('The serial number may only be set once.')
  583. if number <= 0:
  584. raise ValueError('The serial number should be positive')
  585. # ASN.1 integers are always signed, so most significant bit must be
  586. # zero.
  587. if number.bit_length() >= 160: # As defined in RFC 5280
  588. raise ValueError('The serial number should not be more than 159 '
  589. 'bits.')
  590. return RevokedCertificateBuilder(
  591. number, self._revocation_date, self._extensions
  592. )
  593. def revocation_date(self, time):
  594. if not isinstance(time, datetime.datetime):
  595. raise TypeError('Expecting datetime object.')
  596. if self._revocation_date is not None:
  597. raise ValueError('The revocation date may only be set once.')
  598. time = _convert_to_naive_utc_time(time)
  599. if time < _EARLIEST_UTC_TIME:
  600. raise ValueError('The revocation date must be on or after'
  601. ' 1950 January 1.')
  602. return RevokedCertificateBuilder(
  603. self._serial_number, time, self._extensions
  604. )
  605. def add_extension(self, extension, critical):
  606. if not isinstance(extension, ExtensionType):
  607. raise TypeError("extension must be an ExtensionType")
  608. extension = Extension(extension.oid, critical, extension)
  609. _reject_duplicate_extension(extension, self._extensions)
  610. return RevokedCertificateBuilder(
  611. self._serial_number, self._revocation_date,
  612. self._extensions + [extension]
  613. )
  614. def build(self, backend):
  615. if self._serial_number is None:
  616. raise ValueError("A revoked certificate must have a serial number")
  617. if self._revocation_date is None:
  618. raise ValueError(
  619. "A revoked certificate must have a revocation date"
  620. )
  621. return backend.create_x509_revoked_certificate(self)
  622. def random_serial_number():
  623. return utils.int_from_bytes(os.urandom(20), "big") >> 1