backend.py 104 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785
  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 collections
  6. import contextlib
  7. import itertools
  8. import warnings
  9. from contextlib import contextmanager
  10. import six
  11. from six.moves import range
  12. from cryptography import utils, x509
  13. from cryptography.exceptions import UnsupportedAlgorithm, _Reasons
  14. from cryptography.hazmat._der import (
  15. INTEGER,
  16. NULL,
  17. SEQUENCE,
  18. encode_der,
  19. encode_der_integer,
  20. )
  21. from cryptography.hazmat.backends.interfaces import (
  22. CMACBackend,
  23. CipherBackend,
  24. DERSerializationBackend,
  25. DHBackend,
  26. DSABackend,
  27. EllipticCurveBackend,
  28. HMACBackend,
  29. HashBackend,
  30. PBKDF2HMACBackend,
  31. PEMSerializationBackend,
  32. RSABackend,
  33. ScryptBackend,
  34. X509Backend,
  35. )
  36. from cryptography.hazmat.backends.openssl import aead
  37. from cryptography.hazmat.backends.openssl.ciphers import _CipherContext
  38. from cryptography.hazmat.backends.openssl.cmac import _CMACContext
  39. from cryptography.hazmat.backends.openssl.decode_asn1 import (
  40. _CRL_ENTRY_REASON_ENUM_TO_CODE,
  41. _CRL_EXTENSION_HANDLERS,
  42. _EXTENSION_HANDLERS_BASE,
  43. _EXTENSION_HANDLERS_SCT,
  44. _OCSP_BASICRESP_EXTENSION_HANDLERS,
  45. _OCSP_REQ_EXTENSION_HANDLERS,
  46. _OCSP_SINGLERESP_EXTENSION_HANDLERS_SCT,
  47. _REVOKED_EXTENSION_HANDLERS,
  48. _X509ExtensionParser,
  49. )
  50. from cryptography.hazmat.backends.openssl.dh import (
  51. _DHParameters,
  52. _DHPrivateKey,
  53. _DHPublicKey,
  54. _dh_params_dup,
  55. )
  56. from cryptography.hazmat.backends.openssl.dsa import (
  57. _DSAParameters,
  58. _DSAPrivateKey,
  59. _DSAPublicKey,
  60. )
  61. from cryptography.hazmat.backends.openssl.ec import (
  62. _EllipticCurvePrivateKey,
  63. _EllipticCurvePublicKey,
  64. )
  65. from cryptography.hazmat.backends.openssl.ed25519 import (
  66. _Ed25519PrivateKey,
  67. _Ed25519PublicKey,
  68. )
  69. from cryptography.hazmat.backends.openssl.ed448 import (
  70. _ED448_KEY_SIZE,
  71. _Ed448PrivateKey,
  72. _Ed448PublicKey,
  73. )
  74. from cryptography.hazmat.backends.openssl.encode_asn1 import (
  75. _CRL_ENTRY_EXTENSION_ENCODE_HANDLERS,
  76. _CRL_EXTENSION_ENCODE_HANDLERS,
  77. _EXTENSION_ENCODE_HANDLERS,
  78. _OCSP_BASICRESP_EXTENSION_ENCODE_HANDLERS,
  79. _OCSP_REQUEST_EXTENSION_ENCODE_HANDLERS,
  80. _encode_asn1_int_gc,
  81. _encode_asn1_str_gc,
  82. _encode_name_gc,
  83. _txt2obj_gc,
  84. )
  85. from cryptography.hazmat.backends.openssl.hashes import _HashContext
  86. from cryptography.hazmat.backends.openssl.hmac import _HMACContext
  87. from cryptography.hazmat.backends.openssl.ocsp import (
  88. _OCSPRequest,
  89. _OCSPResponse,
  90. )
  91. from cryptography.hazmat.backends.openssl.poly1305 import (
  92. _POLY1305_KEY_SIZE,
  93. _Poly1305Context,
  94. )
  95. from cryptography.hazmat.backends.openssl.rsa import (
  96. _RSAPrivateKey,
  97. _RSAPublicKey,
  98. )
  99. from cryptography.hazmat.backends.openssl.x25519 import (
  100. _X25519PrivateKey,
  101. _X25519PublicKey,
  102. )
  103. from cryptography.hazmat.backends.openssl.x448 import (
  104. _X448PrivateKey,
  105. _X448PublicKey,
  106. )
  107. from cryptography.hazmat.backends.openssl.x509 import (
  108. _Certificate,
  109. _CertificateRevocationList,
  110. _CertificateSigningRequest,
  111. _RevokedCertificate,
  112. )
  113. from cryptography.hazmat.bindings.openssl import binding
  114. from cryptography.hazmat.primitives import hashes, serialization
  115. from cryptography.hazmat.primitives.asymmetric import (
  116. dsa,
  117. ec,
  118. ed25519,
  119. ed448,
  120. rsa,
  121. )
  122. from cryptography.hazmat.primitives.asymmetric.padding import (
  123. MGF1,
  124. OAEP,
  125. PKCS1v15,
  126. PSS,
  127. )
  128. from cryptography.hazmat.primitives.ciphers.algorithms import (
  129. AES,
  130. ARC4,
  131. Blowfish,
  132. CAST5,
  133. Camellia,
  134. ChaCha20,
  135. IDEA,
  136. SEED,
  137. TripleDES,
  138. )
  139. from cryptography.hazmat.primitives.ciphers.modes import (
  140. CBC,
  141. CFB,
  142. CFB8,
  143. CTR,
  144. ECB,
  145. GCM,
  146. OFB,
  147. XTS,
  148. )
  149. from cryptography.hazmat.primitives.kdf import scrypt
  150. from cryptography.hazmat.primitives.serialization import pkcs7, ssh
  151. from cryptography.x509 import ocsp
  152. _MemoryBIO = collections.namedtuple("_MemoryBIO", ["bio", "char_ptr"])
  153. # Not actually supported, just used as a marker for some serialization tests.
  154. class _RC2(object):
  155. pass
  156. @utils.register_interface(CipherBackend)
  157. @utils.register_interface(CMACBackend)
  158. @utils.register_interface(DERSerializationBackend)
  159. @utils.register_interface(DHBackend)
  160. @utils.register_interface(DSABackend)
  161. @utils.register_interface(EllipticCurveBackend)
  162. @utils.register_interface(HashBackend)
  163. @utils.register_interface(HMACBackend)
  164. @utils.register_interface(PBKDF2HMACBackend)
  165. @utils.register_interface(RSABackend)
  166. @utils.register_interface(PEMSerializationBackend)
  167. @utils.register_interface(X509Backend)
  168. @utils.register_interface_if(
  169. binding.Binding().lib.Cryptography_HAS_SCRYPT, ScryptBackend
  170. )
  171. class Backend(object):
  172. """
  173. OpenSSL API binding interfaces.
  174. """
  175. name = "openssl"
  176. # FIPS has opinions about acceptable algorithms and key sizes, but the
  177. # disallowed algorithms are still present in OpenSSL. They just error if
  178. # you try to use them. To avoid that we allowlist the algorithms in
  179. # FIPS 140-3. This isn't ideal, but FIPS 140-3 is trash so here we are.
  180. _fips_aead = {
  181. b"aes-128-ccm",
  182. b"aes-192-ccm",
  183. b"aes-256-ccm",
  184. b"aes-128-gcm",
  185. b"aes-192-gcm",
  186. b"aes-256-gcm",
  187. }
  188. _fips_ciphers = (AES, TripleDES)
  189. _fips_hashes = (
  190. hashes.SHA1,
  191. hashes.SHA224,
  192. hashes.SHA256,
  193. hashes.SHA384,
  194. hashes.SHA512,
  195. hashes.SHA512_224,
  196. hashes.SHA512_256,
  197. hashes.SHA3_224,
  198. hashes.SHA3_256,
  199. hashes.SHA3_384,
  200. hashes.SHA3_512,
  201. hashes.SHAKE128,
  202. hashes.SHAKE256,
  203. )
  204. _fips_rsa_min_key_size = 2048
  205. _fips_rsa_min_public_exponent = 65537
  206. _fips_dsa_min_modulus = 1 << 2048
  207. _fips_dh_min_key_size = 2048
  208. _fips_dh_min_modulus = 1 << _fips_dh_min_key_size
  209. def __init__(self):
  210. self._binding = binding.Binding()
  211. self._ffi = self._binding.ffi
  212. self._lib = self._binding.lib
  213. self._fips_enabled = self._is_fips_enabled()
  214. self._cipher_registry = {}
  215. self._register_default_ciphers()
  216. self._register_x509_ext_parsers()
  217. self._register_x509_encoders()
  218. if self._fips_enabled and self._lib.CRYPTOGRAPHY_NEEDS_OSRANDOM_ENGINE:
  219. warnings.warn(
  220. "OpenSSL FIPS mode is enabled. Can't enable DRBG fork safety.",
  221. UserWarning,
  222. )
  223. else:
  224. self.activate_osrandom_engine()
  225. self._dh_types = [self._lib.EVP_PKEY_DH]
  226. if self._lib.Cryptography_HAS_EVP_PKEY_DHX:
  227. self._dh_types.append(self._lib.EVP_PKEY_DHX)
  228. def openssl_assert(self, ok, errors=None):
  229. return binding._openssl_assert(self._lib, ok, errors=errors)
  230. def _is_fips_enabled(self):
  231. fips_mode = getattr(self._lib, "FIPS_mode", lambda: 0)
  232. mode = fips_mode()
  233. if mode == 0:
  234. # OpenSSL without FIPS pushes an error on the error stack
  235. self._lib.ERR_clear_error()
  236. return bool(mode)
  237. def activate_builtin_random(self):
  238. if self._lib.CRYPTOGRAPHY_NEEDS_OSRANDOM_ENGINE:
  239. # Obtain a new structural reference.
  240. e = self._lib.ENGINE_get_default_RAND()
  241. if e != self._ffi.NULL:
  242. self._lib.ENGINE_unregister_RAND(e)
  243. # Reset the RNG to use the built-in.
  244. res = self._lib.RAND_set_rand_method(self._ffi.NULL)
  245. self.openssl_assert(res == 1)
  246. # decrement the structural reference from get_default_RAND
  247. res = self._lib.ENGINE_finish(e)
  248. self.openssl_assert(res == 1)
  249. @contextlib.contextmanager
  250. def _get_osurandom_engine(self):
  251. # Fetches an engine by id and returns it. This creates a structural
  252. # reference.
  253. e = self._lib.ENGINE_by_id(self._lib.Cryptography_osrandom_engine_id)
  254. self.openssl_assert(e != self._ffi.NULL)
  255. # Initialize the engine for use. This adds a functional reference.
  256. res = self._lib.ENGINE_init(e)
  257. self.openssl_assert(res == 1)
  258. try:
  259. yield e
  260. finally:
  261. # Decrement the structural ref incremented by ENGINE_by_id.
  262. res = self._lib.ENGINE_free(e)
  263. self.openssl_assert(res == 1)
  264. # Decrement the functional ref incremented by ENGINE_init.
  265. res = self._lib.ENGINE_finish(e)
  266. self.openssl_assert(res == 1)
  267. def activate_osrandom_engine(self):
  268. if self._lib.CRYPTOGRAPHY_NEEDS_OSRANDOM_ENGINE:
  269. # Unregister and free the current engine.
  270. self.activate_builtin_random()
  271. with self._get_osurandom_engine() as e:
  272. # Set the engine as the default RAND provider.
  273. res = self._lib.ENGINE_set_default_RAND(e)
  274. self.openssl_assert(res == 1)
  275. # Reset the RNG to use the engine
  276. res = self._lib.RAND_set_rand_method(self._ffi.NULL)
  277. self.openssl_assert(res == 1)
  278. def osrandom_engine_implementation(self):
  279. buf = self._ffi.new("char[]", 64)
  280. with self._get_osurandom_engine() as e:
  281. res = self._lib.ENGINE_ctrl_cmd(
  282. e, b"get_implementation", len(buf), buf, self._ffi.NULL, 0
  283. )
  284. self.openssl_assert(res > 0)
  285. return self._ffi.string(buf).decode("ascii")
  286. def openssl_version_text(self):
  287. """
  288. Friendly string name of the loaded OpenSSL library. This is not
  289. necessarily the same version as it was compiled against.
  290. Example: OpenSSL 1.1.1d 10 Sep 2019
  291. """
  292. return self._ffi.string(
  293. self._lib.OpenSSL_version(self._lib.OPENSSL_VERSION)
  294. ).decode("ascii")
  295. def openssl_version_number(self):
  296. return self._lib.OpenSSL_version_num()
  297. def create_hmac_ctx(self, key, algorithm):
  298. return _HMACContext(self, key, algorithm)
  299. def _evp_md_from_algorithm(self, algorithm):
  300. if algorithm.name == "blake2b" or algorithm.name == "blake2s":
  301. alg = "{}{}".format(
  302. algorithm.name, algorithm.digest_size * 8
  303. ).encode("ascii")
  304. else:
  305. alg = algorithm.name.encode("ascii")
  306. evp_md = self._lib.EVP_get_digestbyname(alg)
  307. return evp_md
  308. def _evp_md_non_null_from_algorithm(self, algorithm):
  309. evp_md = self._evp_md_from_algorithm(algorithm)
  310. self.openssl_assert(evp_md != self._ffi.NULL)
  311. return evp_md
  312. def hash_supported(self, algorithm):
  313. if self._fips_enabled and not isinstance(algorithm, self._fips_hashes):
  314. return False
  315. evp_md = self._evp_md_from_algorithm(algorithm)
  316. return evp_md != self._ffi.NULL
  317. def hmac_supported(self, algorithm):
  318. return self.hash_supported(algorithm)
  319. def create_hash_ctx(self, algorithm):
  320. return _HashContext(self, algorithm)
  321. def cipher_supported(self, cipher, mode):
  322. if self._fips_enabled and not isinstance(cipher, self._fips_ciphers):
  323. return False
  324. try:
  325. adapter = self._cipher_registry[type(cipher), type(mode)]
  326. except KeyError:
  327. return False
  328. evp_cipher = adapter(self, cipher, mode)
  329. return self._ffi.NULL != evp_cipher
  330. def register_cipher_adapter(self, cipher_cls, mode_cls, adapter):
  331. if (cipher_cls, mode_cls) in self._cipher_registry:
  332. raise ValueError(
  333. "Duplicate registration for: {} {}.".format(
  334. cipher_cls, mode_cls
  335. )
  336. )
  337. self._cipher_registry[cipher_cls, mode_cls] = adapter
  338. def _register_default_ciphers(self):
  339. for mode_cls in [CBC, CTR, ECB, OFB, CFB, CFB8, GCM]:
  340. self.register_cipher_adapter(
  341. AES,
  342. mode_cls,
  343. GetCipherByName("{cipher.name}-{cipher.key_size}-{mode.name}"),
  344. )
  345. for mode_cls in [CBC, CTR, ECB, OFB, CFB]:
  346. self.register_cipher_adapter(
  347. Camellia,
  348. mode_cls,
  349. GetCipherByName("{cipher.name}-{cipher.key_size}-{mode.name}"),
  350. )
  351. for mode_cls in [CBC, CFB, CFB8, OFB]:
  352. self.register_cipher_adapter(
  353. TripleDES, mode_cls, GetCipherByName("des-ede3-{mode.name}")
  354. )
  355. self.register_cipher_adapter(
  356. TripleDES, ECB, GetCipherByName("des-ede3")
  357. )
  358. for mode_cls in [CBC, CFB, OFB, ECB]:
  359. self.register_cipher_adapter(
  360. Blowfish, mode_cls, GetCipherByName("bf-{mode.name}")
  361. )
  362. for mode_cls in [CBC, CFB, OFB, ECB]:
  363. self.register_cipher_adapter(
  364. SEED, mode_cls, GetCipherByName("seed-{mode.name}")
  365. )
  366. for cipher_cls, mode_cls in itertools.product(
  367. [CAST5, IDEA],
  368. [CBC, OFB, CFB, ECB],
  369. ):
  370. self.register_cipher_adapter(
  371. cipher_cls,
  372. mode_cls,
  373. GetCipherByName("{cipher.name}-{mode.name}"),
  374. )
  375. self.register_cipher_adapter(ARC4, type(None), GetCipherByName("rc4"))
  376. # We don't actually support RC2, this is just used by some tests.
  377. self.register_cipher_adapter(_RC2, type(None), GetCipherByName("rc2"))
  378. self.register_cipher_adapter(
  379. ChaCha20, type(None), GetCipherByName("chacha20")
  380. )
  381. self.register_cipher_adapter(AES, XTS, _get_xts_cipher)
  382. def _register_x509_ext_parsers(self):
  383. ext_handlers = _EXTENSION_HANDLERS_BASE.copy()
  384. # All revoked extensions are valid single response extensions, see:
  385. # https://tools.ietf.org/html/rfc6960#section-4.4.5
  386. singleresp_handlers = _REVOKED_EXTENSION_HANDLERS.copy()
  387. if self._lib.Cryptography_HAS_SCT:
  388. ext_handlers.update(_EXTENSION_HANDLERS_SCT)
  389. singleresp_handlers.update(_OCSP_SINGLERESP_EXTENSION_HANDLERS_SCT)
  390. self._certificate_extension_parser = _X509ExtensionParser(
  391. self,
  392. ext_count=self._lib.X509_get_ext_count,
  393. get_ext=self._lib.X509_get_ext,
  394. handlers=ext_handlers,
  395. )
  396. self._csr_extension_parser = _X509ExtensionParser(
  397. self,
  398. ext_count=self._lib.sk_X509_EXTENSION_num,
  399. get_ext=self._lib.sk_X509_EXTENSION_value,
  400. handlers=ext_handlers,
  401. )
  402. self._revoked_cert_extension_parser = _X509ExtensionParser(
  403. self,
  404. ext_count=self._lib.X509_REVOKED_get_ext_count,
  405. get_ext=self._lib.X509_REVOKED_get_ext,
  406. handlers=_REVOKED_EXTENSION_HANDLERS,
  407. )
  408. self._crl_extension_parser = _X509ExtensionParser(
  409. self,
  410. ext_count=self._lib.X509_CRL_get_ext_count,
  411. get_ext=self._lib.X509_CRL_get_ext,
  412. handlers=_CRL_EXTENSION_HANDLERS,
  413. )
  414. self._ocsp_req_ext_parser = _X509ExtensionParser(
  415. self,
  416. ext_count=self._lib.OCSP_REQUEST_get_ext_count,
  417. get_ext=self._lib.OCSP_REQUEST_get_ext,
  418. handlers=_OCSP_REQ_EXTENSION_HANDLERS,
  419. )
  420. self._ocsp_basicresp_ext_parser = _X509ExtensionParser(
  421. self,
  422. ext_count=self._lib.OCSP_BASICRESP_get_ext_count,
  423. get_ext=self._lib.OCSP_BASICRESP_get_ext,
  424. handlers=_OCSP_BASICRESP_EXTENSION_HANDLERS,
  425. )
  426. self._ocsp_singleresp_ext_parser = _X509ExtensionParser(
  427. self,
  428. ext_count=self._lib.OCSP_SINGLERESP_get_ext_count,
  429. get_ext=self._lib.OCSP_SINGLERESP_get_ext,
  430. handlers=singleresp_handlers,
  431. )
  432. def _register_x509_encoders(self):
  433. self._extension_encode_handlers = _EXTENSION_ENCODE_HANDLERS.copy()
  434. self._crl_extension_encode_handlers = (
  435. _CRL_EXTENSION_ENCODE_HANDLERS.copy()
  436. )
  437. self._crl_entry_extension_encode_handlers = (
  438. _CRL_ENTRY_EXTENSION_ENCODE_HANDLERS.copy()
  439. )
  440. self._ocsp_request_extension_encode_handlers = (
  441. _OCSP_REQUEST_EXTENSION_ENCODE_HANDLERS.copy()
  442. )
  443. self._ocsp_basicresp_extension_encode_handlers = (
  444. _OCSP_BASICRESP_EXTENSION_ENCODE_HANDLERS.copy()
  445. )
  446. def create_symmetric_encryption_ctx(self, cipher, mode):
  447. return _CipherContext(self, cipher, mode, _CipherContext._ENCRYPT)
  448. def create_symmetric_decryption_ctx(self, cipher, mode):
  449. return _CipherContext(self, cipher, mode, _CipherContext._DECRYPT)
  450. def pbkdf2_hmac_supported(self, algorithm):
  451. return self.hmac_supported(algorithm)
  452. def derive_pbkdf2_hmac(
  453. self, algorithm, length, salt, iterations, key_material
  454. ):
  455. buf = self._ffi.new("unsigned char[]", length)
  456. evp_md = self._evp_md_non_null_from_algorithm(algorithm)
  457. key_material_ptr = self._ffi.from_buffer(key_material)
  458. res = self._lib.PKCS5_PBKDF2_HMAC(
  459. key_material_ptr,
  460. len(key_material),
  461. salt,
  462. len(salt),
  463. iterations,
  464. evp_md,
  465. length,
  466. buf,
  467. )
  468. self.openssl_assert(res == 1)
  469. return self._ffi.buffer(buf)[:]
  470. def _consume_errors(self):
  471. return binding._consume_errors(self._lib)
  472. def _consume_errors_with_text(self):
  473. return binding._consume_errors_with_text(self._lib)
  474. def _bn_to_int(self, bn):
  475. assert bn != self._ffi.NULL
  476. if not six.PY2:
  477. # Python 3 has constant time from_bytes, so use that.
  478. bn_num_bytes = self._lib.BN_num_bytes(bn)
  479. bin_ptr = self._ffi.new("unsigned char[]", bn_num_bytes)
  480. bin_len = self._lib.BN_bn2bin(bn, bin_ptr)
  481. # A zero length means the BN has value 0
  482. self.openssl_assert(bin_len >= 0)
  483. val = int.from_bytes(self._ffi.buffer(bin_ptr)[:bin_len], "big")
  484. if self._lib.BN_is_negative(bn):
  485. val = -val
  486. return val
  487. else:
  488. # Under Python 2 the best we can do is hex()
  489. hex_cdata = self._lib.BN_bn2hex(bn)
  490. self.openssl_assert(hex_cdata != self._ffi.NULL)
  491. hex_str = self._ffi.string(hex_cdata)
  492. self._lib.OPENSSL_free(hex_cdata)
  493. return int(hex_str, 16)
  494. def _int_to_bn(self, num, bn=None):
  495. """
  496. Converts a python integer to a BIGNUM. The returned BIGNUM will not
  497. be garbage collected (to support adding them to structs that take
  498. ownership of the object). Be sure to register it for GC if it will
  499. be discarded after use.
  500. """
  501. assert bn is None or bn != self._ffi.NULL
  502. if bn is None:
  503. bn = self._ffi.NULL
  504. if not six.PY2:
  505. # Python 3 has constant time to_bytes, so use that.
  506. binary = num.to_bytes(int(num.bit_length() / 8.0 + 1), "big")
  507. bn_ptr = self._lib.BN_bin2bn(binary, len(binary), bn)
  508. self.openssl_assert(bn_ptr != self._ffi.NULL)
  509. return bn_ptr
  510. else:
  511. # Under Python 2 the best we can do is hex(), [2:] removes the 0x
  512. # prefix.
  513. hex_num = hex(num).rstrip("L")[2:].encode("ascii")
  514. bn_ptr = self._ffi.new("BIGNUM **")
  515. bn_ptr[0] = bn
  516. res = self._lib.BN_hex2bn(bn_ptr, hex_num)
  517. self.openssl_assert(res != 0)
  518. self.openssl_assert(bn_ptr[0] != self._ffi.NULL)
  519. return bn_ptr[0]
  520. def generate_rsa_private_key(self, public_exponent, key_size):
  521. rsa._verify_rsa_parameters(public_exponent, key_size)
  522. rsa_cdata = self._lib.RSA_new()
  523. self.openssl_assert(rsa_cdata != self._ffi.NULL)
  524. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  525. bn = self._int_to_bn(public_exponent)
  526. bn = self._ffi.gc(bn, self._lib.BN_free)
  527. res = self._lib.RSA_generate_key_ex(
  528. rsa_cdata, key_size, bn, self._ffi.NULL
  529. )
  530. self.openssl_assert(res == 1)
  531. evp_pkey = self._rsa_cdata_to_evp_pkey(rsa_cdata)
  532. return _RSAPrivateKey(self, rsa_cdata, evp_pkey)
  533. def generate_rsa_parameters_supported(self, public_exponent, key_size):
  534. return (
  535. public_exponent >= 3
  536. and public_exponent & 1 != 0
  537. and key_size >= 512
  538. )
  539. def load_rsa_private_numbers(self, numbers):
  540. rsa._check_private_key_components(
  541. numbers.p,
  542. numbers.q,
  543. numbers.d,
  544. numbers.dmp1,
  545. numbers.dmq1,
  546. numbers.iqmp,
  547. numbers.public_numbers.e,
  548. numbers.public_numbers.n,
  549. )
  550. rsa_cdata = self._lib.RSA_new()
  551. self.openssl_assert(rsa_cdata != self._ffi.NULL)
  552. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  553. p = self._int_to_bn(numbers.p)
  554. q = self._int_to_bn(numbers.q)
  555. d = self._int_to_bn(numbers.d)
  556. dmp1 = self._int_to_bn(numbers.dmp1)
  557. dmq1 = self._int_to_bn(numbers.dmq1)
  558. iqmp = self._int_to_bn(numbers.iqmp)
  559. e = self._int_to_bn(numbers.public_numbers.e)
  560. n = self._int_to_bn(numbers.public_numbers.n)
  561. res = self._lib.RSA_set0_factors(rsa_cdata, p, q)
  562. self.openssl_assert(res == 1)
  563. res = self._lib.RSA_set0_key(rsa_cdata, n, e, d)
  564. self.openssl_assert(res == 1)
  565. res = self._lib.RSA_set0_crt_params(rsa_cdata, dmp1, dmq1, iqmp)
  566. self.openssl_assert(res == 1)
  567. evp_pkey = self._rsa_cdata_to_evp_pkey(rsa_cdata)
  568. return _RSAPrivateKey(self, rsa_cdata, evp_pkey)
  569. def load_rsa_public_numbers(self, numbers):
  570. rsa._check_public_key_components(numbers.e, numbers.n)
  571. rsa_cdata = self._lib.RSA_new()
  572. self.openssl_assert(rsa_cdata != self._ffi.NULL)
  573. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  574. e = self._int_to_bn(numbers.e)
  575. n = self._int_to_bn(numbers.n)
  576. res = self._lib.RSA_set0_key(rsa_cdata, n, e, self._ffi.NULL)
  577. self.openssl_assert(res == 1)
  578. evp_pkey = self._rsa_cdata_to_evp_pkey(rsa_cdata)
  579. return _RSAPublicKey(self, rsa_cdata, evp_pkey)
  580. def _create_evp_pkey_gc(self):
  581. evp_pkey = self._lib.EVP_PKEY_new()
  582. self.openssl_assert(evp_pkey != self._ffi.NULL)
  583. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  584. return evp_pkey
  585. def _rsa_cdata_to_evp_pkey(self, rsa_cdata):
  586. evp_pkey = self._create_evp_pkey_gc()
  587. res = self._lib.EVP_PKEY_set1_RSA(evp_pkey, rsa_cdata)
  588. self.openssl_assert(res == 1)
  589. return evp_pkey
  590. def _bytes_to_bio(self, data):
  591. """
  592. Return a _MemoryBIO namedtuple of (BIO, char*).
  593. The char* is the storage for the BIO and it must stay alive until the
  594. BIO is finished with.
  595. """
  596. data_ptr = self._ffi.from_buffer(data)
  597. bio = self._lib.BIO_new_mem_buf(data_ptr, len(data))
  598. self.openssl_assert(bio != self._ffi.NULL)
  599. return _MemoryBIO(self._ffi.gc(bio, self._lib.BIO_free), data_ptr)
  600. def _create_mem_bio_gc(self):
  601. """
  602. Creates an empty memory BIO.
  603. """
  604. bio_method = self._lib.BIO_s_mem()
  605. self.openssl_assert(bio_method != self._ffi.NULL)
  606. bio = self._lib.BIO_new(bio_method)
  607. self.openssl_assert(bio != self._ffi.NULL)
  608. bio = self._ffi.gc(bio, self._lib.BIO_free)
  609. return bio
  610. def _read_mem_bio(self, bio):
  611. """
  612. Reads a memory BIO. This only works on memory BIOs.
  613. """
  614. buf = self._ffi.new("char **")
  615. buf_len = self._lib.BIO_get_mem_data(bio, buf)
  616. self.openssl_assert(buf_len > 0)
  617. self.openssl_assert(buf[0] != self._ffi.NULL)
  618. bio_data = self._ffi.buffer(buf[0], buf_len)[:]
  619. return bio_data
  620. def _evp_pkey_to_private_key(self, evp_pkey):
  621. """
  622. Return the appropriate type of PrivateKey given an evp_pkey cdata
  623. pointer.
  624. """
  625. key_type = self._lib.EVP_PKEY_id(evp_pkey)
  626. if key_type == self._lib.EVP_PKEY_RSA:
  627. rsa_cdata = self._lib.EVP_PKEY_get1_RSA(evp_pkey)
  628. self.openssl_assert(rsa_cdata != self._ffi.NULL)
  629. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  630. return _RSAPrivateKey(self, rsa_cdata, evp_pkey)
  631. elif key_type == self._lib.EVP_PKEY_DSA:
  632. dsa_cdata = self._lib.EVP_PKEY_get1_DSA(evp_pkey)
  633. self.openssl_assert(dsa_cdata != self._ffi.NULL)
  634. dsa_cdata = self._ffi.gc(dsa_cdata, self._lib.DSA_free)
  635. return _DSAPrivateKey(self, dsa_cdata, evp_pkey)
  636. elif key_type == self._lib.EVP_PKEY_EC:
  637. ec_cdata = self._lib.EVP_PKEY_get1_EC_KEY(evp_pkey)
  638. self.openssl_assert(ec_cdata != self._ffi.NULL)
  639. ec_cdata = self._ffi.gc(ec_cdata, self._lib.EC_KEY_free)
  640. return _EllipticCurvePrivateKey(self, ec_cdata, evp_pkey)
  641. elif key_type in self._dh_types:
  642. dh_cdata = self._lib.EVP_PKEY_get1_DH(evp_pkey)
  643. self.openssl_assert(dh_cdata != self._ffi.NULL)
  644. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  645. return _DHPrivateKey(self, dh_cdata, evp_pkey)
  646. elif key_type == getattr(self._lib, "EVP_PKEY_ED25519", None):
  647. # EVP_PKEY_ED25519 is not present in OpenSSL < 1.1.1
  648. return _Ed25519PrivateKey(self, evp_pkey)
  649. elif key_type == getattr(self._lib, "EVP_PKEY_X448", None):
  650. # EVP_PKEY_X448 is not present in OpenSSL < 1.1.1
  651. return _X448PrivateKey(self, evp_pkey)
  652. elif key_type == getattr(self._lib, "EVP_PKEY_X25519", None):
  653. # EVP_PKEY_X25519 is not present in OpenSSL < 1.1.0
  654. return _X25519PrivateKey(self, evp_pkey)
  655. elif key_type == getattr(self._lib, "EVP_PKEY_ED448", None):
  656. # EVP_PKEY_ED448 is not present in OpenSSL < 1.1.1
  657. return _Ed448PrivateKey(self, evp_pkey)
  658. else:
  659. raise UnsupportedAlgorithm("Unsupported key type.")
  660. def _evp_pkey_to_public_key(self, evp_pkey):
  661. """
  662. Return the appropriate type of PublicKey given an evp_pkey cdata
  663. pointer.
  664. """
  665. key_type = self._lib.EVP_PKEY_id(evp_pkey)
  666. if key_type == self._lib.EVP_PKEY_RSA:
  667. rsa_cdata = self._lib.EVP_PKEY_get1_RSA(evp_pkey)
  668. self.openssl_assert(rsa_cdata != self._ffi.NULL)
  669. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  670. return _RSAPublicKey(self, rsa_cdata, evp_pkey)
  671. elif key_type == self._lib.EVP_PKEY_DSA:
  672. dsa_cdata = self._lib.EVP_PKEY_get1_DSA(evp_pkey)
  673. self.openssl_assert(dsa_cdata != self._ffi.NULL)
  674. dsa_cdata = self._ffi.gc(dsa_cdata, self._lib.DSA_free)
  675. return _DSAPublicKey(self, dsa_cdata, evp_pkey)
  676. elif key_type == self._lib.EVP_PKEY_EC:
  677. ec_cdata = self._lib.EVP_PKEY_get1_EC_KEY(evp_pkey)
  678. self.openssl_assert(ec_cdata != self._ffi.NULL)
  679. ec_cdata = self._ffi.gc(ec_cdata, self._lib.EC_KEY_free)
  680. return _EllipticCurvePublicKey(self, ec_cdata, evp_pkey)
  681. elif key_type in self._dh_types:
  682. dh_cdata = self._lib.EVP_PKEY_get1_DH(evp_pkey)
  683. self.openssl_assert(dh_cdata != self._ffi.NULL)
  684. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  685. return _DHPublicKey(self, dh_cdata, evp_pkey)
  686. elif key_type == getattr(self._lib, "EVP_PKEY_ED25519", None):
  687. # EVP_PKEY_ED25519 is not present in OpenSSL < 1.1.1
  688. return _Ed25519PublicKey(self, evp_pkey)
  689. elif key_type == getattr(self._lib, "EVP_PKEY_X448", None):
  690. # EVP_PKEY_X448 is not present in OpenSSL < 1.1.1
  691. return _X448PublicKey(self, evp_pkey)
  692. elif key_type == getattr(self._lib, "EVP_PKEY_X25519", None):
  693. # EVP_PKEY_X25519 is not present in OpenSSL < 1.1.0
  694. return _X25519PublicKey(self, evp_pkey)
  695. elif key_type == getattr(self._lib, "EVP_PKEY_ED448", None):
  696. # EVP_PKEY_X25519 is not present in OpenSSL < 1.1.1
  697. return _Ed448PublicKey(self, evp_pkey)
  698. else:
  699. raise UnsupportedAlgorithm("Unsupported key type.")
  700. def _oaep_hash_supported(self, algorithm):
  701. if self._lib.Cryptography_HAS_RSA_OAEP_MD:
  702. return isinstance(
  703. algorithm,
  704. (
  705. hashes.SHA1,
  706. hashes.SHA224,
  707. hashes.SHA256,
  708. hashes.SHA384,
  709. hashes.SHA512,
  710. ),
  711. )
  712. else:
  713. return isinstance(algorithm, hashes.SHA1)
  714. def rsa_padding_supported(self, padding):
  715. if isinstance(padding, PKCS1v15):
  716. return True
  717. elif isinstance(padding, PSS) and isinstance(padding._mgf, MGF1):
  718. return self.hash_supported(padding._mgf._algorithm)
  719. elif isinstance(padding, OAEP) and isinstance(padding._mgf, MGF1):
  720. return (
  721. self._oaep_hash_supported(padding._mgf._algorithm)
  722. and self._oaep_hash_supported(padding._algorithm)
  723. and (
  724. (padding._label is None or len(padding._label) == 0)
  725. or self._lib.Cryptography_HAS_RSA_OAEP_LABEL == 1
  726. )
  727. )
  728. else:
  729. return False
  730. def generate_dsa_parameters(self, key_size):
  731. if key_size not in (1024, 2048, 3072, 4096):
  732. raise ValueError(
  733. "Key size must be 1024, 2048, 3072, or 4096 bits."
  734. )
  735. ctx = self._lib.DSA_new()
  736. self.openssl_assert(ctx != self._ffi.NULL)
  737. ctx = self._ffi.gc(ctx, self._lib.DSA_free)
  738. res = self._lib.DSA_generate_parameters_ex(
  739. ctx,
  740. key_size,
  741. self._ffi.NULL,
  742. 0,
  743. self._ffi.NULL,
  744. self._ffi.NULL,
  745. self._ffi.NULL,
  746. )
  747. self.openssl_assert(res == 1)
  748. return _DSAParameters(self, ctx)
  749. def generate_dsa_private_key(self, parameters):
  750. ctx = self._lib.DSAparams_dup(parameters._dsa_cdata)
  751. self.openssl_assert(ctx != self._ffi.NULL)
  752. ctx = self._ffi.gc(ctx, self._lib.DSA_free)
  753. self._lib.DSA_generate_key(ctx)
  754. evp_pkey = self._dsa_cdata_to_evp_pkey(ctx)
  755. return _DSAPrivateKey(self, ctx, evp_pkey)
  756. def generate_dsa_private_key_and_parameters(self, key_size):
  757. parameters = self.generate_dsa_parameters(key_size)
  758. return self.generate_dsa_private_key(parameters)
  759. def _dsa_cdata_set_values(self, dsa_cdata, p, q, g, pub_key, priv_key):
  760. res = self._lib.DSA_set0_pqg(dsa_cdata, p, q, g)
  761. self.openssl_assert(res == 1)
  762. res = self._lib.DSA_set0_key(dsa_cdata, pub_key, priv_key)
  763. self.openssl_assert(res == 1)
  764. def load_dsa_private_numbers(self, numbers):
  765. dsa._check_dsa_private_numbers(numbers)
  766. parameter_numbers = numbers.public_numbers.parameter_numbers
  767. dsa_cdata = self._lib.DSA_new()
  768. self.openssl_assert(dsa_cdata != self._ffi.NULL)
  769. dsa_cdata = self._ffi.gc(dsa_cdata, self._lib.DSA_free)
  770. p = self._int_to_bn(parameter_numbers.p)
  771. q = self._int_to_bn(parameter_numbers.q)
  772. g = self._int_to_bn(parameter_numbers.g)
  773. pub_key = self._int_to_bn(numbers.public_numbers.y)
  774. priv_key = self._int_to_bn(numbers.x)
  775. self._dsa_cdata_set_values(dsa_cdata, p, q, g, pub_key, priv_key)
  776. evp_pkey = self._dsa_cdata_to_evp_pkey(dsa_cdata)
  777. return _DSAPrivateKey(self, dsa_cdata, evp_pkey)
  778. def load_dsa_public_numbers(self, numbers):
  779. dsa._check_dsa_parameters(numbers.parameter_numbers)
  780. dsa_cdata = self._lib.DSA_new()
  781. self.openssl_assert(dsa_cdata != self._ffi.NULL)
  782. dsa_cdata = self._ffi.gc(dsa_cdata, self._lib.DSA_free)
  783. p = self._int_to_bn(numbers.parameter_numbers.p)
  784. q = self._int_to_bn(numbers.parameter_numbers.q)
  785. g = self._int_to_bn(numbers.parameter_numbers.g)
  786. pub_key = self._int_to_bn(numbers.y)
  787. priv_key = self._ffi.NULL
  788. self._dsa_cdata_set_values(dsa_cdata, p, q, g, pub_key, priv_key)
  789. evp_pkey = self._dsa_cdata_to_evp_pkey(dsa_cdata)
  790. return _DSAPublicKey(self, dsa_cdata, evp_pkey)
  791. def load_dsa_parameter_numbers(self, numbers):
  792. dsa._check_dsa_parameters(numbers)
  793. dsa_cdata = self._lib.DSA_new()
  794. self.openssl_assert(dsa_cdata != self._ffi.NULL)
  795. dsa_cdata = self._ffi.gc(dsa_cdata, self._lib.DSA_free)
  796. p = self._int_to_bn(numbers.p)
  797. q = self._int_to_bn(numbers.q)
  798. g = self._int_to_bn(numbers.g)
  799. res = self._lib.DSA_set0_pqg(dsa_cdata, p, q, g)
  800. self.openssl_assert(res == 1)
  801. return _DSAParameters(self, dsa_cdata)
  802. def _dsa_cdata_to_evp_pkey(self, dsa_cdata):
  803. evp_pkey = self._create_evp_pkey_gc()
  804. res = self._lib.EVP_PKEY_set1_DSA(evp_pkey, dsa_cdata)
  805. self.openssl_assert(res == 1)
  806. return evp_pkey
  807. def dsa_hash_supported(self, algorithm):
  808. return self.hash_supported(algorithm)
  809. def dsa_parameters_supported(self, p, q, g):
  810. return True
  811. def cmac_algorithm_supported(self, algorithm):
  812. return self.cipher_supported(
  813. algorithm, CBC(b"\x00" * algorithm.block_size)
  814. )
  815. def create_cmac_ctx(self, algorithm):
  816. return _CMACContext(self, algorithm)
  817. def _x509_check_signature_params(self, private_key, algorithm):
  818. if isinstance(
  819. private_key, (ed25519.Ed25519PrivateKey, ed448.Ed448PrivateKey)
  820. ):
  821. if algorithm is not None:
  822. raise ValueError(
  823. "algorithm must be None when signing via ed25519 or ed448"
  824. )
  825. elif not isinstance(
  826. private_key,
  827. (rsa.RSAPrivateKey, dsa.DSAPrivateKey, ec.EllipticCurvePrivateKey),
  828. ):
  829. raise TypeError(
  830. "Key must be an rsa, dsa, ec, ed25519, or ed448 private key."
  831. )
  832. elif not isinstance(algorithm, hashes.HashAlgorithm):
  833. raise TypeError("Algorithm must be a registered hash algorithm.")
  834. elif isinstance(algorithm, hashes.MD5) and not isinstance(
  835. private_key, rsa.RSAPrivateKey
  836. ):
  837. raise ValueError(
  838. "MD5 hash algorithm is only supported with RSA keys"
  839. )
  840. def create_x509_csr(self, builder, private_key, algorithm):
  841. if not isinstance(builder, x509.CertificateSigningRequestBuilder):
  842. raise TypeError("Builder type mismatch.")
  843. self._x509_check_signature_params(private_key, algorithm)
  844. # Resolve the signature algorithm.
  845. evp_md = self._evp_md_x509_null_if_eddsa(private_key, algorithm)
  846. # Create an empty request.
  847. x509_req = self._lib.X509_REQ_new()
  848. self.openssl_assert(x509_req != self._ffi.NULL)
  849. x509_req = self._ffi.gc(x509_req, self._lib.X509_REQ_free)
  850. # Set x509 version.
  851. res = self._lib.X509_REQ_set_version(x509_req, x509.Version.v1.value)
  852. self.openssl_assert(res == 1)
  853. # Set subject name.
  854. res = self._lib.X509_REQ_set_subject_name(
  855. x509_req, _encode_name_gc(self, builder._subject_name)
  856. )
  857. self.openssl_assert(res == 1)
  858. # Set subject public key.
  859. public_key = private_key.public_key()
  860. res = self._lib.X509_REQ_set_pubkey(x509_req, public_key._evp_pkey)
  861. self.openssl_assert(res == 1)
  862. # Add extensions.
  863. sk_extension = self._lib.sk_X509_EXTENSION_new_null()
  864. self.openssl_assert(sk_extension != self._ffi.NULL)
  865. sk_extension = self._ffi.gc(
  866. sk_extension,
  867. lambda x: self._lib.sk_X509_EXTENSION_pop_free(
  868. x,
  869. self._ffi.addressof(
  870. self._lib._original_lib, "X509_EXTENSION_free"
  871. ),
  872. ),
  873. )
  874. # Don't GC individual extensions because the memory is owned by
  875. # sk_extensions and will be freed along with it.
  876. self._create_x509_extensions(
  877. extensions=builder._extensions,
  878. handlers=self._extension_encode_handlers,
  879. x509_obj=sk_extension,
  880. add_func=self._lib.sk_X509_EXTENSION_insert,
  881. gc=False,
  882. )
  883. res = self._lib.X509_REQ_add_extensions(x509_req, sk_extension)
  884. self.openssl_assert(res == 1)
  885. # Add attributes (all bytes encoded as ASN1 UTF8_STRING)
  886. for attr_oid, attr_val in builder._attributes:
  887. obj = _txt2obj_gc(self, attr_oid.dotted_string)
  888. res = self._lib.X509_REQ_add1_attr_by_OBJ(
  889. x509_req,
  890. obj,
  891. x509.name._ASN1Type.UTF8String.value,
  892. attr_val,
  893. len(attr_val),
  894. )
  895. self.openssl_assert(res == 1)
  896. # Sign the request using the requester's private key.
  897. res = self._lib.X509_REQ_sign(x509_req, private_key._evp_pkey, evp_md)
  898. if res == 0:
  899. errors = self._consume_errors_with_text()
  900. raise ValueError("Signing failed", errors)
  901. return _CertificateSigningRequest(self, x509_req)
  902. def create_x509_certificate(self, builder, private_key, algorithm):
  903. if not isinstance(builder, x509.CertificateBuilder):
  904. raise TypeError("Builder type mismatch.")
  905. self._x509_check_signature_params(private_key, algorithm)
  906. # Resolve the signature algorithm.
  907. evp_md = self._evp_md_x509_null_if_eddsa(private_key, algorithm)
  908. # Create an empty certificate.
  909. x509_cert = self._lib.X509_new()
  910. x509_cert = self._ffi.gc(x509_cert, self._lib.X509_free)
  911. # Set the x509 version.
  912. res = self._lib.X509_set_version(x509_cert, builder._version.value)
  913. self.openssl_assert(res == 1)
  914. # Set the subject's name.
  915. res = self._lib.X509_set_subject_name(
  916. x509_cert, _encode_name_gc(self, builder._subject_name)
  917. )
  918. self.openssl_assert(res == 1)
  919. # Set the subject's public key.
  920. res = self._lib.X509_set_pubkey(
  921. x509_cert, builder._public_key._evp_pkey
  922. )
  923. self.openssl_assert(res == 1)
  924. # Set the certificate serial number.
  925. serial_number = _encode_asn1_int_gc(self, builder._serial_number)
  926. res = self._lib.X509_set_serialNumber(x509_cert, serial_number)
  927. self.openssl_assert(res == 1)
  928. # Set the "not before" time.
  929. self._set_asn1_time(
  930. self._lib.X509_getm_notBefore(x509_cert), builder._not_valid_before
  931. )
  932. # Set the "not after" time.
  933. self._set_asn1_time(
  934. self._lib.X509_getm_notAfter(x509_cert), builder._not_valid_after
  935. )
  936. # Add extensions.
  937. self._create_x509_extensions(
  938. extensions=builder._extensions,
  939. handlers=self._extension_encode_handlers,
  940. x509_obj=x509_cert,
  941. add_func=self._lib.X509_add_ext,
  942. gc=True,
  943. )
  944. # Set the issuer name.
  945. res = self._lib.X509_set_issuer_name(
  946. x509_cert, _encode_name_gc(self, builder._issuer_name)
  947. )
  948. self.openssl_assert(res == 1)
  949. # Sign the certificate with the issuer's private key.
  950. res = self._lib.X509_sign(x509_cert, private_key._evp_pkey, evp_md)
  951. if res == 0:
  952. errors = self._consume_errors_with_text()
  953. raise ValueError("Signing failed", errors)
  954. return _Certificate(self, x509_cert)
  955. def _evp_md_x509_null_if_eddsa(self, private_key, algorithm):
  956. if isinstance(
  957. private_key, (ed25519.Ed25519PrivateKey, ed448.Ed448PrivateKey)
  958. ):
  959. # OpenSSL requires us to pass NULL for EVP_MD for ed25519/ed448
  960. return self._ffi.NULL
  961. else:
  962. return self._evp_md_non_null_from_algorithm(algorithm)
  963. def _set_asn1_time(self, asn1_time, time):
  964. if time.year >= 2050:
  965. asn1_str = time.strftime("%Y%m%d%H%M%SZ").encode("ascii")
  966. else:
  967. asn1_str = time.strftime("%y%m%d%H%M%SZ").encode("ascii")
  968. res = self._lib.ASN1_TIME_set_string(asn1_time, asn1_str)
  969. self.openssl_assert(res == 1)
  970. def _create_asn1_time(self, time):
  971. asn1_time = self._lib.ASN1_TIME_new()
  972. self.openssl_assert(asn1_time != self._ffi.NULL)
  973. asn1_time = self._ffi.gc(asn1_time, self._lib.ASN1_TIME_free)
  974. self._set_asn1_time(asn1_time, time)
  975. return asn1_time
  976. def create_x509_crl(self, builder, private_key, algorithm):
  977. if not isinstance(builder, x509.CertificateRevocationListBuilder):
  978. raise TypeError("Builder type mismatch.")
  979. self._x509_check_signature_params(private_key, algorithm)
  980. evp_md = self._evp_md_x509_null_if_eddsa(private_key, algorithm)
  981. # Create an empty CRL.
  982. x509_crl = self._lib.X509_CRL_new()
  983. x509_crl = self._ffi.gc(x509_crl, self._lib.X509_CRL_free)
  984. # Set the x509 CRL version. We only support v2 (integer value 1).
  985. res = self._lib.X509_CRL_set_version(x509_crl, 1)
  986. self.openssl_assert(res == 1)
  987. # Set the issuer name.
  988. res = self._lib.X509_CRL_set_issuer_name(
  989. x509_crl, _encode_name_gc(self, builder._issuer_name)
  990. )
  991. self.openssl_assert(res == 1)
  992. # Set the last update time.
  993. last_update = self._create_asn1_time(builder._last_update)
  994. res = self._lib.X509_CRL_set_lastUpdate(x509_crl, last_update)
  995. self.openssl_assert(res == 1)
  996. # Set the next update time.
  997. next_update = self._create_asn1_time(builder._next_update)
  998. res = self._lib.X509_CRL_set_nextUpdate(x509_crl, next_update)
  999. self.openssl_assert(res == 1)
  1000. # Add extensions.
  1001. self._create_x509_extensions(
  1002. extensions=builder._extensions,
  1003. handlers=self._crl_extension_encode_handlers,
  1004. x509_obj=x509_crl,
  1005. add_func=self._lib.X509_CRL_add_ext,
  1006. gc=True,
  1007. )
  1008. # add revoked certificates
  1009. for revoked_cert in builder._revoked_certificates:
  1010. # Duplicating because the X509_CRL takes ownership and will free
  1011. # this memory when X509_CRL_free is called.
  1012. revoked = self._lib.X509_REVOKED_dup(revoked_cert._x509_revoked)
  1013. self.openssl_assert(revoked != self._ffi.NULL)
  1014. res = self._lib.X509_CRL_add0_revoked(x509_crl, revoked)
  1015. self.openssl_assert(res == 1)
  1016. res = self._lib.X509_CRL_sign(x509_crl, private_key._evp_pkey, evp_md)
  1017. if res == 0:
  1018. errors = self._consume_errors_with_text()
  1019. raise ValueError("Signing failed", errors)
  1020. return _CertificateRevocationList(self, x509_crl)
  1021. def _create_x509_extensions(
  1022. self, extensions, handlers, x509_obj, add_func, gc
  1023. ):
  1024. for i, extension in enumerate(extensions):
  1025. x509_extension = self._create_x509_extension(handlers, extension)
  1026. self.openssl_assert(x509_extension != self._ffi.NULL)
  1027. if gc:
  1028. x509_extension = self._ffi.gc(
  1029. x509_extension, self._lib.X509_EXTENSION_free
  1030. )
  1031. res = add_func(x509_obj, x509_extension, i)
  1032. self.openssl_assert(res >= 1)
  1033. def _create_raw_x509_extension(self, extension, value):
  1034. obj = _txt2obj_gc(self, extension.oid.dotted_string)
  1035. return self._lib.X509_EXTENSION_create_by_OBJ(
  1036. self._ffi.NULL, obj, 1 if extension.critical else 0, value
  1037. )
  1038. def _create_x509_extension(self, handlers, extension):
  1039. if isinstance(extension.value, x509.UnrecognizedExtension):
  1040. value = _encode_asn1_str_gc(self, extension.value.value)
  1041. return self._create_raw_x509_extension(extension, value)
  1042. elif isinstance(extension.value, x509.TLSFeature):
  1043. asn1 = encode_der(
  1044. SEQUENCE,
  1045. *[
  1046. encode_der(INTEGER, encode_der_integer(x.value))
  1047. for x in extension.value
  1048. ]
  1049. )
  1050. value = _encode_asn1_str_gc(self, asn1)
  1051. return self._create_raw_x509_extension(extension, value)
  1052. elif isinstance(extension.value, x509.PrecertPoison):
  1053. value = _encode_asn1_str_gc(self, encode_der(NULL))
  1054. return self._create_raw_x509_extension(extension, value)
  1055. else:
  1056. try:
  1057. encode = handlers[extension.oid]
  1058. except KeyError:
  1059. raise NotImplementedError(
  1060. "Extension not supported: {}".format(extension.oid)
  1061. )
  1062. ext_struct = encode(self, extension.value)
  1063. nid = self._lib.OBJ_txt2nid(
  1064. extension.oid.dotted_string.encode("ascii")
  1065. )
  1066. self.openssl_assert(nid != self._lib.NID_undef)
  1067. return self._lib.X509V3_EXT_i2d(
  1068. nid, 1 if extension.critical else 0, ext_struct
  1069. )
  1070. def create_x509_revoked_certificate(self, builder):
  1071. if not isinstance(builder, x509.RevokedCertificateBuilder):
  1072. raise TypeError("Builder type mismatch.")
  1073. x509_revoked = self._lib.X509_REVOKED_new()
  1074. self.openssl_assert(x509_revoked != self._ffi.NULL)
  1075. x509_revoked = self._ffi.gc(x509_revoked, self._lib.X509_REVOKED_free)
  1076. serial_number = _encode_asn1_int_gc(self, builder._serial_number)
  1077. res = self._lib.X509_REVOKED_set_serialNumber(
  1078. x509_revoked, serial_number
  1079. )
  1080. self.openssl_assert(res == 1)
  1081. rev_date = self._create_asn1_time(builder._revocation_date)
  1082. res = self._lib.X509_REVOKED_set_revocationDate(x509_revoked, rev_date)
  1083. self.openssl_assert(res == 1)
  1084. # add CRL entry extensions
  1085. self._create_x509_extensions(
  1086. extensions=builder._extensions,
  1087. handlers=self._crl_entry_extension_encode_handlers,
  1088. x509_obj=x509_revoked,
  1089. add_func=self._lib.X509_REVOKED_add_ext,
  1090. gc=True,
  1091. )
  1092. return _RevokedCertificate(self, None, x509_revoked)
  1093. def load_pem_private_key(self, data, password):
  1094. return self._load_key(
  1095. self._lib.PEM_read_bio_PrivateKey,
  1096. self._evp_pkey_to_private_key,
  1097. data,
  1098. password,
  1099. )
  1100. def load_pem_public_key(self, data):
  1101. mem_bio = self._bytes_to_bio(data)
  1102. evp_pkey = self._lib.PEM_read_bio_PUBKEY(
  1103. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1104. )
  1105. if evp_pkey != self._ffi.NULL:
  1106. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  1107. return self._evp_pkey_to_public_key(evp_pkey)
  1108. else:
  1109. # It's not a (RSA/DSA/ECDSA) subjectPublicKeyInfo, but we still
  1110. # need to check to see if it is a pure PKCS1 RSA public key (not
  1111. # embedded in a subjectPublicKeyInfo)
  1112. self._consume_errors()
  1113. res = self._lib.BIO_reset(mem_bio.bio)
  1114. self.openssl_assert(res == 1)
  1115. rsa_cdata = self._lib.PEM_read_bio_RSAPublicKey(
  1116. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1117. )
  1118. if rsa_cdata != self._ffi.NULL:
  1119. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  1120. evp_pkey = self._rsa_cdata_to_evp_pkey(rsa_cdata)
  1121. return _RSAPublicKey(self, rsa_cdata, evp_pkey)
  1122. else:
  1123. self._handle_key_loading_error()
  1124. def load_pem_parameters(self, data):
  1125. mem_bio = self._bytes_to_bio(data)
  1126. # only DH is supported currently
  1127. dh_cdata = self._lib.PEM_read_bio_DHparams(
  1128. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1129. )
  1130. if dh_cdata != self._ffi.NULL:
  1131. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1132. return _DHParameters(self, dh_cdata)
  1133. else:
  1134. self._handle_key_loading_error()
  1135. def load_der_private_key(self, data, password):
  1136. # OpenSSL has a function called d2i_AutoPrivateKey that in theory
  1137. # handles this automatically, however it doesn't handle encrypted
  1138. # private keys. Instead we try to load the key two different ways.
  1139. # First we'll try to load it as a traditional key.
  1140. bio_data = self._bytes_to_bio(data)
  1141. key = self._evp_pkey_from_der_traditional_key(bio_data, password)
  1142. if key:
  1143. return self._evp_pkey_to_private_key(key)
  1144. else:
  1145. # Finally we try to load it with the method that handles encrypted
  1146. # PKCS8 properly.
  1147. return self._load_key(
  1148. self._lib.d2i_PKCS8PrivateKey_bio,
  1149. self._evp_pkey_to_private_key,
  1150. data,
  1151. password,
  1152. )
  1153. def _evp_pkey_from_der_traditional_key(self, bio_data, password):
  1154. key = self._lib.d2i_PrivateKey_bio(bio_data.bio, self._ffi.NULL)
  1155. if key != self._ffi.NULL:
  1156. key = self._ffi.gc(key, self._lib.EVP_PKEY_free)
  1157. if password is not None:
  1158. raise TypeError(
  1159. "Password was given but private key is not encrypted."
  1160. )
  1161. return key
  1162. else:
  1163. self._consume_errors()
  1164. return None
  1165. def load_der_public_key(self, data):
  1166. mem_bio = self._bytes_to_bio(data)
  1167. evp_pkey = self._lib.d2i_PUBKEY_bio(mem_bio.bio, self._ffi.NULL)
  1168. if evp_pkey != self._ffi.NULL:
  1169. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  1170. return self._evp_pkey_to_public_key(evp_pkey)
  1171. else:
  1172. # It's not a (RSA/DSA/ECDSA) subjectPublicKeyInfo, but we still
  1173. # need to check to see if it is a pure PKCS1 RSA public key (not
  1174. # embedded in a subjectPublicKeyInfo)
  1175. self._consume_errors()
  1176. res = self._lib.BIO_reset(mem_bio.bio)
  1177. self.openssl_assert(res == 1)
  1178. rsa_cdata = self._lib.d2i_RSAPublicKey_bio(
  1179. mem_bio.bio, self._ffi.NULL
  1180. )
  1181. if rsa_cdata != self._ffi.NULL:
  1182. rsa_cdata = self._ffi.gc(rsa_cdata, self._lib.RSA_free)
  1183. evp_pkey = self._rsa_cdata_to_evp_pkey(rsa_cdata)
  1184. return _RSAPublicKey(self, rsa_cdata, evp_pkey)
  1185. else:
  1186. self._handle_key_loading_error()
  1187. def load_der_parameters(self, data):
  1188. mem_bio = self._bytes_to_bio(data)
  1189. dh_cdata = self._lib.d2i_DHparams_bio(mem_bio.bio, self._ffi.NULL)
  1190. if dh_cdata != self._ffi.NULL:
  1191. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1192. return _DHParameters(self, dh_cdata)
  1193. elif self._lib.Cryptography_HAS_EVP_PKEY_DHX:
  1194. # We check to see if the is dhx.
  1195. self._consume_errors()
  1196. res = self._lib.BIO_reset(mem_bio.bio)
  1197. self.openssl_assert(res == 1)
  1198. dh_cdata = self._lib.Cryptography_d2i_DHxparams_bio(
  1199. mem_bio.bio, self._ffi.NULL
  1200. )
  1201. if dh_cdata != self._ffi.NULL:
  1202. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1203. return _DHParameters(self, dh_cdata)
  1204. self._handle_key_loading_error()
  1205. def load_pem_x509_certificate(self, data):
  1206. mem_bio = self._bytes_to_bio(data)
  1207. x509 = self._lib.PEM_read_bio_X509(
  1208. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1209. )
  1210. if x509 == self._ffi.NULL:
  1211. self._consume_errors()
  1212. raise ValueError(
  1213. "Unable to load certificate. See https://cryptography.io/en/la"
  1214. "test/faq/#why-can-t-i-import-my-pem-file for more details."
  1215. )
  1216. x509 = self._ffi.gc(x509, self._lib.X509_free)
  1217. return _Certificate(self, x509)
  1218. def load_der_x509_certificate(self, data):
  1219. mem_bio = self._bytes_to_bio(data)
  1220. x509 = self._lib.d2i_X509_bio(mem_bio.bio, self._ffi.NULL)
  1221. if x509 == self._ffi.NULL:
  1222. self._consume_errors()
  1223. raise ValueError("Unable to load certificate")
  1224. x509 = self._ffi.gc(x509, self._lib.X509_free)
  1225. return _Certificate(self, x509)
  1226. def load_pem_x509_crl(self, data):
  1227. mem_bio = self._bytes_to_bio(data)
  1228. x509_crl = self._lib.PEM_read_bio_X509_CRL(
  1229. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1230. )
  1231. if x509_crl == self._ffi.NULL:
  1232. self._consume_errors()
  1233. raise ValueError(
  1234. "Unable to load CRL. See https://cryptography.io/en/la"
  1235. "test/faq/#why-can-t-i-import-my-pem-file for more details."
  1236. )
  1237. x509_crl = self._ffi.gc(x509_crl, self._lib.X509_CRL_free)
  1238. return _CertificateRevocationList(self, x509_crl)
  1239. def load_der_x509_crl(self, data):
  1240. mem_bio = self._bytes_to_bio(data)
  1241. x509_crl = self._lib.d2i_X509_CRL_bio(mem_bio.bio, self._ffi.NULL)
  1242. if x509_crl == self._ffi.NULL:
  1243. self._consume_errors()
  1244. raise ValueError("Unable to load CRL")
  1245. x509_crl = self._ffi.gc(x509_crl, self._lib.X509_CRL_free)
  1246. return _CertificateRevocationList(self, x509_crl)
  1247. def load_pem_x509_csr(self, data):
  1248. mem_bio = self._bytes_to_bio(data)
  1249. x509_req = self._lib.PEM_read_bio_X509_REQ(
  1250. mem_bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  1251. )
  1252. if x509_req == self._ffi.NULL:
  1253. self._consume_errors()
  1254. raise ValueError(
  1255. "Unable to load request. See https://cryptography.io/en/la"
  1256. "test/faq/#why-can-t-i-import-my-pem-file for more details."
  1257. )
  1258. x509_req = self._ffi.gc(x509_req, self._lib.X509_REQ_free)
  1259. return _CertificateSigningRequest(self, x509_req)
  1260. def load_der_x509_csr(self, data):
  1261. mem_bio = self._bytes_to_bio(data)
  1262. x509_req = self._lib.d2i_X509_REQ_bio(mem_bio.bio, self._ffi.NULL)
  1263. if x509_req == self._ffi.NULL:
  1264. self._consume_errors()
  1265. raise ValueError("Unable to load request")
  1266. x509_req = self._ffi.gc(x509_req, self._lib.X509_REQ_free)
  1267. return _CertificateSigningRequest(self, x509_req)
  1268. def _load_key(self, openssl_read_func, convert_func, data, password):
  1269. mem_bio = self._bytes_to_bio(data)
  1270. userdata = self._ffi.new("CRYPTOGRAPHY_PASSWORD_DATA *")
  1271. if password is not None:
  1272. utils._check_byteslike("password", password)
  1273. password_ptr = self._ffi.from_buffer(password)
  1274. userdata.password = password_ptr
  1275. userdata.length = len(password)
  1276. evp_pkey = openssl_read_func(
  1277. mem_bio.bio,
  1278. self._ffi.NULL,
  1279. self._ffi.addressof(
  1280. self._lib._original_lib, "Cryptography_pem_password_cb"
  1281. ),
  1282. userdata,
  1283. )
  1284. if evp_pkey == self._ffi.NULL:
  1285. if userdata.error != 0:
  1286. errors = self._consume_errors()
  1287. self.openssl_assert(errors)
  1288. if userdata.error == -1:
  1289. raise TypeError(
  1290. "Password was not given but private key is encrypted"
  1291. )
  1292. else:
  1293. assert userdata.error == -2
  1294. raise ValueError(
  1295. "Passwords longer than {} bytes are not supported "
  1296. "by this backend.".format(userdata.maxsize - 1)
  1297. )
  1298. else:
  1299. self._handle_key_loading_error()
  1300. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  1301. if password is not None and userdata.called == 0:
  1302. raise TypeError(
  1303. "Password was given but private key is not encrypted."
  1304. )
  1305. assert (
  1306. password is not None and userdata.called == 1
  1307. ) or password is None
  1308. return convert_func(evp_pkey)
  1309. def _handle_key_loading_error(self):
  1310. errors = self._consume_errors()
  1311. if not errors:
  1312. raise ValueError("Could not deserialize key data.")
  1313. elif errors[0]._lib_reason_match(
  1314. self._lib.ERR_LIB_EVP, self._lib.EVP_R_BAD_DECRYPT
  1315. ) or errors[0]._lib_reason_match(
  1316. self._lib.ERR_LIB_PKCS12,
  1317. self._lib.PKCS12_R_PKCS12_CIPHERFINAL_ERROR,
  1318. ):
  1319. raise ValueError("Bad decrypt. Incorrect password?")
  1320. elif errors[0]._lib_reason_match(
  1321. self._lib.ERR_LIB_EVP, self._lib.EVP_R_UNKNOWN_PBE_ALGORITHM
  1322. ) or errors[0]._lib_reason_match(
  1323. self._lib.ERR_LIB_PEM, self._lib.PEM_R_UNSUPPORTED_ENCRYPTION
  1324. ):
  1325. raise UnsupportedAlgorithm(
  1326. "PEM data is encrypted with an unsupported cipher",
  1327. _Reasons.UNSUPPORTED_CIPHER,
  1328. )
  1329. elif any(
  1330. error._lib_reason_match(
  1331. self._lib.ERR_LIB_EVP,
  1332. self._lib.EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM,
  1333. )
  1334. for error in errors
  1335. ):
  1336. raise ValueError("Unsupported public key algorithm.")
  1337. else:
  1338. assert errors[0].lib in (
  1339. self._lib.ERR_LIB_EVP,
  1340. self._lib.ERR_LIB_PEM,
  1341. self._lib.ERR_LIB_ASN1,
  1342. )
  1343. raise ValueError("Could not deserialize key data.")
  1344. def elliptic_curve_supported(self, curve):
  1345. try:
  1346. curve_nid = self._elliptic_curve_to_nid(curve)
  1347. except UnsupportedAlgorithm:
  1348. curve_nid = self._lib.NID_undef
  1349. group = self._lib.EC_GROUP_new_by_curve_name(curve_nid)
  1350. if group == self._ffi.NULL:
  1351. self._consume_errors()
  1352. return False
  1353. else:
  1354. self.openssl_assert(curve_nid != self._lib.NID_undef)
  1355. self._lib.EC_GROUP_free(group)
  1356. return True
  1357. def elliptic_curve_signature_algorithm_supported(
  1358. self, signature_algorithm, curve
  1359. ):
  1360. # We only support ECDSA right now.
  1361. if not isinstance(signature_algorithm, ec.ECDSA):
  1362. return False
  1363. return self.elliptic_curve_supported(curve)
  1364. def generate_elliptic_curve_private_key(self, curve):
  1365. """
  1366. Generate a new private key on the named curve.
  1367. """
  1368. if self.elliptic_curve_supported(curve):
  1369. ec_cdata = self._ec_key_new_by_curve(curve)
  1370. res = self._lib.EC_KEY_generate_key(ec_cdata)
  1371. self.openssl_assert(res == 1)
  1372. evp_pkey = self._ec_cdata_to_evp_pkey(ec_cdata)
  1373. return _EllipticCurvePrivateKey(self, ec_cdata, evp_pkey)
  1374. else:
  1375. raise UnsupportedAlgorithm(
  1376. "Backend object does not support {}.".format(curve.name),
  1377. _Reasons.UNSUPPORTED_ELLIPTIC_CURVE,
  1378. )
  1379. def load_elliptic_curve_private_numbers(self, numbers):
  1380. public = numbers.public_numbers
  1381. ec_cdata = self._ec_key_new_by_curve(public.curve)
  1382. private_value = self._ffi.gc(
  1383. self._int_to_bn(numbers.private_value), self._lib.BN_clear_free
  1384. )
  1385. res = self._lib.EC_KEY_set_private_key(ec_cdata, private_value)
  1386. self.openssl_assert(res == 1)
  1387. ec_cdata = self._ec_key_set_public_key_affine_coordinates(
  1388. ec_cdata, public.x, public.y
  1389. )
  1390. evp_pkey = self._ec_cdata_to_evp_pkey(ec_cdata)
  1391. return _EllipticCurvePrivateKey(self, ec_cdata, evp_pkey)
  1392. def load_elliptic_curve_public_numbers(self, numbers):
  1393. ec_cdata = self._ec_key_new_by_curve(numbers.curve)
  1394. ec_cdata = self._ec_key_set_public_key_affine_coordinates(
  1395. ec_cdata, numbers.x, numbers.y
  1396. )
  1397. evp_pkey = self._ec_cdata_to_evp_pkey(ec_cdata)
  1398. return _EllipticCurvePublicKey(self, ec_cdata, evp_pkey)
  1399. def load_elliptic_curve_public_bytes(self, curve, point_bytes):
  1400. ec_cdata = self._ec_key_new_by_curve(curve)
  1401. group = self._lib.EC_KEY_get0_group(ec_cdata)
  1402. self.openssl_assert(group != self._ffi.NULL)
  1403. point = self._lib.EC_POINT_new(group)
  1404. self.openssl_assert(point != self._ffi.NULL)
  1405. point = self._ffi.gc(point, self._lib.EC_POINT_free)
  1406. with self._tmp_bn_ctx() as bn_ctx:
  1407. res = self._lib.EC_POINT_oct2point(
  1408. group, point, point_bytes, len(point_bytes), bn_ctx
  1409. )
  1410. if res != 1:
  1411. self._consume_errors()
  1412. raise ValueError("Invalid public bytes for the given curve")
  1413. res = self._lib.EC_KEY_set_public_key(ec_cdata, point)
  1414. self.openssl_assert(res == 1)
  1415. evp_pkey = self._ec_cdata_to_evp_pkey(ec_cdata)
  1416. return _EllipticCurvePublicKey(self, ec_cdata, evp_pkey)
  1417. def derive_elliptic_curve_private_key(self, private_value, curve):
  1418. ec_cdata = self._ec_key_new_by_curve(curve)
  1419. get_func, group = self._ec_key_determine_group_get_func(ec_cdata)
  1420. point = self._lib.EC_POINT_new(group)
  1421. self.openssl_assert(point != self._ffi.NULL)
  1422. point = self._ffi.gc(point, self._lib.EC_POINT_free)
  1423. value = self._int_to_bn(private_value)
  1424. value = self._ffi.gc(value, self._lib.BN_clear_free)
  1425. with self._tmp_bn_ctx() as bn_ctx:
  1426. res = self._lib.EC_POINT_mul(
  1427. group, point, value, self._ffi.NULL, self._ffi.NULL, bn_ctx
  1428. )
  1429. self.openssl_assert(res == 1)
  1430. bn_x = self._lib.BN_CTX_get(bn_ctx)
  1431. bn_y = self._lib.BN_CTX_get(bn_ctx)
  1432. res = get_func(group, point, bn_x, bn_y, bn_ctx)
  1433. self.openssl_assert(res == 1)
  1434. res = self._lib.EC_KEY_set_public_key(ec_cdata, point)
  1435. self.openssl_assert(res == 1)
  1436. private = self._int_to_bn(private_value)
  1437. private = self._ffi.gc(private, self._lib.BN_clear_free)
  1438. res = self._lib.EC_KEY_set_private_key(ec_cdata, private)
  1439. self.openssl_assert(res == 1)
  1440. evp_pkey = self._ec_cdata_to_evp_pkey(ec_cdata)
  1441. return _EllipticCurvePrivateKey(self, ec_cdata, evp_pkey)
  1442. def _ec_key_new_by_curve(self, curve):
  1443. curve_nid = self._elliptic_curve_to_nid(curve)
  1444. return self._ec_key_new_by_curve_nid(curve_nid)
  1445. def _ec_key_new_by_curve_nid(self, curve_nid):
  1446. ec_cdata = self._lib.EC_KEY_new_by_curve_name(curve_nid)
  1447. self.openssl_assert(ec_cdata != self._ffi.NULL)
  1448. # Setting the ASN.1 flag to OPENSSL_EC_NAMED_CURVE is
  1449. # only necessary on OpenSSL 1.0.2t/u. Once we drop support for 1.0.2
  1450. # we can remove this as it's done automatically when getting an EC_KEY
  1451. # from new_by_curve_name
  1452. # CRYPTOGRAPHY_OPENSSL_102U_OR_GREATER
  1453. self._lib.EC_KEY_set_asn1_flag(
  1454. ec_cdata, backend._lib.OPENSSL_EC_NAMED_CURVE
  1455. )
  1456. return self._ffi.gc(ec_cdata, self._lib.EC_KEY_free)
  1457. def load_der_ocsp_request(self, data):
  1458. mem_bio = self._bytes_to_bio(data)
  1459. request = self._lib.d2i_OCSP_REQUEST_bio(mem_bio.bio, self._ffi.NULL)
  1460. if request == self._ffi.NULL:
  1461. self._consume_errors()
  1462. raise ValueError("Unable to load OCSP request")
  1463. request = self._ffi.gc(request, self._lib.OCSP_REQUEST_free)
  1464. return _OCSPRequest(self, request)
  1465. def load_der_ocsp_response(self, data):
  1466. mem_bio = self._bytes_to_bio(data)
  1467. response = self._lib.d2i_OCSP_RESPONSE_bio(mem_bio.bio, self._ffi.NULL)
  1468. if response == self._ffi.NULL:
  1469. self._consume_errors()
  1470. raise ValueError("Unable to load OCSP response")
  1471. response = self._ffi.gc(response, self._lib.OCSP_RESPONSE_free)
  1472. return _OCSPResponse(self, response)
  1473. def create_ocsp_request(self, builder):
  1474. ocsp_req = self._lib.OCSP_REQUEST_new()
  1475. self.openssl_assert(ocsp_req != self._ffi.NULL)
  1476. ocsp_req = self._ffi.gc(ocsp_req, self._lib.OCSP_REQUEST_free)
  1477. cert, issuer, algorithm = builder._request
  1478. evp_md = self._evp_md_non_null_from_algorithm(algorithm)
  1479. certid = self._lib.OCSP_cert_to_id(evp_md, cert._x509, issuer._x509)
  1480. self.openssl_assert(certid != self._ffi.NULL)
  1481. onereq = self._lib.OCSP_request_add0_id(ocsp_req, certid)
  1482. self.openssl_assert(onereq != self._ffi.NULL)
  1483. self._create_x509_extensions(
  1484. extensions=builder._extensions,
  1485. handlers=self._ocsp_request_extension_encode_handlers,
  1486. x509_obj=ocsp_req,
  1487. add_func=self._lib.OCSP_REQUEST_add_ext,
  1488. gc=True,
  1489. )
  1490. return _OCSPRequest(self, ocsp_req)
  1491. def _create_ocsp_basic_response(self, builder, private_key, algorithm):
  1492. self._x509_check_signature_params(private_key, algorithm)
  1493. basic = self._lib.OCSP_BASICRESP_new()
  1494. self.openssl_assert(basic != self._ffi.NULL)
  1495. basic = self._ffi.gc(basic, self._lib.OCSP_BASICRESP_free)
  1496. evp_md = self._evp_md_non_null_from_algorithm(
  1497. builder._response._algorithm
  1498. )
  1499. certid = self._lib.OCSP_cert_to_id(
  1500. evp_md,
  1501. builder._response._cert._x509,
  1502. builder._response._issuer._x509,
  1503. )
  1504. self.openssl_assert(certid != self._ffi.NULL)
  1505. certid = self._ffi.gc(certid, self._lib.OCSP_CERTID_free)
  1506. if builder._response._revocation_reason is None:
  1507. reason = -1
  1508. else:
  1509. reason = _CRL_ENTRY_REASON_ENUM_TO_CODE[
  1510. builder._response._revocation_reason
  1511. ]
  1512. if builder._response._revocation_time is None:
  1513. rev_time = self._ffi.NULL
  1514. else:
  1515. rev_time = self._create_asn1_time(
  1516. builder._response._revocation_time
  1517. )
  1518. next_update = self._ffi.NULL
  1519. if builder._response._next_update is not None:
  1520. next_update = self._create_asn1_time(
  1521. builder._response._next_update
  1522. )
  1523. this_update = self._create_asn1_time(builder._response._this_update)
  1524. res = self._lib.OCSP_basic_add1_status(
  1525. basic,
  1526. certid,
  1527. builder._response._cert_status.value,
  1528. reason,
  1529. rev_time,
  1530. this_update,
  1531. next_update,
  1532. )
  1533. self.openssl_assert(res != self._ffi.NULL)
  1534. # okay, now sign the basic structure
  1535. evp_md = self._evp_md_x509_null_if_eddsa(private_key, algorithm)
  1536. responder_cert, responder_encoding = builder._responder_id
  1537. flags = self._lib.OCSP_NOCERTS
  1538. if responder_encoding is ocsp.OCSPResponderEncoding.HASH:
  1539. flags |= self._lib.OCSP_RESPID_KEY
  1540. if builder._certs is not None:
  1541. for cert in builder._certs:
  1542. res = self._lib.OCSP_basic_add1_cert(basic, cert._x509)
  1543. self.openssl_assert(res == 1)
  1544. self._create_x509_extensions(
  1545. extensions=builder._extensions,
  1546. handlers=self._ocsp_basicresp_extension_encode_handlers,
  1547. x509_obj=basic,
  1548. add_func=self._lib.OCSP_BASICRESP_add_ext,
  1549. gc=True,
  1550. )
  1551. res = self._lib.OCSP_basic_sign(
  1552. basic,
  1553. responder_cert._x509,
  1554. private_key._evp_pkey,
  1555. evp_md,
  1556. self._ffi.NULL,
  1557. flags,
  1558. )
  1559. if res != 1:
  1560. errors = self._consume_errors_with_text()
  1561. raise ValueError(
  1562. "Error while signing. responder_cert must be signed "
  1563. "by private_key",
  1564. errors,
  1565. )
  1566. return basic
  1567. def create_ocsp_response(
  1568. self, response_status, builder, private_key, algorithm
  1569. ):
  1570. if response_status is ocsp.OCSPResponseStatus.SUCCESSFUL:
  1571. basic = self._create_ocsp_basic_response(
  1572. builder, private_key, algorithm
  1573. )
  1574. else:
  1575. basic = self._ffi.NULL
  1576. ocsp_resp = self._lib.OCSP_response_create(
  1577. response_status.value, basic
  1578. )
  1579. self.openssl_assert(ocsp_resp != self._ffi.NULL)
  1580. ocsp_resp = self._ffi.gc(ocsp_resp, self._lib.OCSP_RESPONSE_free)
  1581. return _OCSPResponse(self, ocsp_resp)
  1582. def elliptic_curve_exchange_algorithm_supported(self, algorithm, curve):
  1583. return self.elliptic_curve_supported(curve) and isinstance(
  1584. algorithm, ec.ECDH
  1585. )
  1586. def _ec_cdata_to_evp_pkey(self, ec_cdata):
  1587. evp_pkey = self._create_evp_pkey_gc()
  1588. res = self._lib.EVP_PKEY_set1_EC_KEY(evp_pkey, ec_cdata)
  1589. self.openssl_assert(res == 1)
  1590. return evp_pkey
  1591. def _elliptic_curve_to_nid(self, curve):
  1592. """
  1593. Get the NID for a curve name.
  1594. """
  1595. curve_aliases = {"secp192r1": "prime192v1", "secp256r1": "prime256v1"}
  1596. curve_name = curve_aliases.get(curve.name, curve.name)
  1597. curve_nid = self._lib.OBJ_sn2nid(curve_name.encode())
  1598. if curve_nid == self._lib.NID_undef:
  1599. raise UnsupportedAlgorithm(
  1600. "{} is not a supported elliptic curve".format(curve.name),
  1601. _Reasons.UNSUPPORTED_ELLIPTIC_CURVE,
  1602. )
  1603. return curve_nid
  1604. @contextmanager
  1605. def _tmp_bn_ctx(self):
  1606. bn_ctx = self._lib.BN_CTX_new()
  1607. self.openssl_assert(bn_ctx != self._ffi.NULL)
  1608. bn_ctx = self._ffi.gc(bn_ctx, self._lib.BN_CTX_free)
  1609. self._lib.BN_CTX_start(bn_ctx)
  1610. try:
  1611. yield bn_ctx
  1612. finally:
  1613. self._lib.BN_CTX_end(bn_ctx)
  1614. def _ec_key_determine_group_get_func(self, ctx):
  1615. """
  1616. Given an EC_KEY determine the group and what function is required to
  1617. get point coordinates.
  1618. """
  1619. self.openssl_assert(ctx != self._ffi.NULL)
  1620. nid_two_field = self._lib.OBJ_sn2nid(b"characteristic-two-field")
  1621. self.openssl_assert(nid_two_field != self._lib.NID_undef)
  1622. group = self._lib.EC_KEY_get0_group(ctx)
  1623. self.openssl_assert(group != self._ffi.NULL)
  1624. method = self._lib.EC_GROUP_method_of(group)
  1625. self.openssl_assert(method != self._ffi.NULL)
  1626. nid = self._lib.EC_METHOD_get_field_type(method)
  1627. self.openssl_assert(nid != self._lib.NID_undef)
  1628. if nid == nid_two_field and self._lib.Cryptography_HAS_EC2M:
  1629. get_func = self._lib.EC_POINT_get_affine_coordinates_GF2m
  1630. else:
  1631. get_func = self._lib.EC_POINT_get_affine_coordinates_GFp
  1632. assert get_func
  1633. return get_func, group
  1634. def _ec_key_set_public_key_affine_coordinates(self, ctx, x, y):
  1635. """
  1636. Sets the public key point in the EC_KEY context to the affine x and y
  1637. values.
  1638. """
  1639. if x < 0 or y < 0:
  1640. raise ValueError(
  1641. "Invalid EC key. Both x and y must be non-negative."
  1642. )
  1643. x = self._ffi.gc(self._int_to_bn(x), self._lib.BN_free)
  1644. y = self._ffi.gc(self._int_to_bn(y), self._lib.BN_free)
  1645. res = self._lib.EC_KEY_set_public_key_affine_coordinates(ctx, x, y)
  1646. if res != 1:
  1647. self._consume_errors()
  1648. raise ValueError("Invalid EC key.")
  1649. return ctx
  1650. def _private_key_bytes(
  1651. self, encoding, format, encryption_algorithm, key, evp_pkey, cdata
  1652. ):
  1653. # validate argument types
  1654. if not isinstance(encoding, serialization.Encoding):
  1655. raise TypeError("encoding must be an item from the Encoding enum")
  1656. if not isinstance(format, serialization.PrivateFormat):
  1657. raise TypeError(
  1658. "format must be an item from the PrivateFormat enum"
  1659. )
  1660. if not isinstance(
  1661. encryption_algorithm, serialization.KeySerializationEncryption
  1662. ):
  1663. raise TypeError(
  1664. "Encryption algorithm must be a KeySerializationEncryption "
  1665. "instance"
  1666. )
  1667. # validate password
  1668. if isinstance(encryption_algorithm, serialization.NoEncryption):
  1669. password = b""
  1670. elif isinstance(
  1671. encryption_algorithm, serialization.BestAvailableEncryption
  1672. ):
  1673. password = encryption_algorithm.password
  1674. if len(password) > 1023:
  1675. raise ValueError(
  1676. "Passwords longer than 1023 bytes are not supported by "
  1677. "this backend"
  1678. )
  1679. else:
  1680. raise ValueError("Unsupported encryption type")
  1681. # PKCS8 + PEM/DER
  1682. if format is serialization.PrivateFormat.PKCS8:
  1683. if encoding is serialization.Encoding.PEM:
  1684. write_bio = self._lib.PEM_write_bio_PKCS8PrivateKey
  1685. elif encoding is serialization.Encoding.DER:
  1686. write_bio = self._lib.i2d_PKCS8PrivateKey_bio
  1687. else:
  1688. raise ValueError("Unsupported encoding for PKCS8")
  1689. return self._private_key_bytes_via_bio(
  1690. write_bio, evp_pkey, password
  1691. )
  1692. # TraditionalOpenSSL + PEM/DER
  1693. if format is serialization.PrivateFormat.TraditionalOpenSSL:
  1694. if self._fips_enabled and not isinstance(
  1695. encryption_algorithm, serialization.NoEncryption
  1696. ):
  1697. raise ValueError(
  1698. "Encrypted traditional OpenSSL format is not "
  1699. "supported in FIPS mode."
  1700. )
  1701. key_type = self._lib.EVP_PKEY_id(evp_pkey)
  1702. if encoding is serialization.Encoding.PEM:
  1703. if key_type == self._lib.EVP_PKEY_RSA:
  1704. write_bio = self._lib.PEM_write_bio_RSAPrivateKey
  1705. elif key_type == self._lib.EVP_PKEY_DSA:
  1706. write_bio = self._lib.PEM_write_bio_DSAPrivateKey
  1707. elif key_type == self._lib.EVP_PKEY_EC:
  1708. write_bio = self._lib.PEM_write_bio_ECPrivateKey
  1709. else:
  1710. raise ValueError(
  1711. "Unsupported key type for TraditionalOpenSSL"
  1712. )
  1713. return self._private_key_bytes_via_bio(
  1714. write_bio, cdata, password
  1715. )
  1716. if encoding is serialization.Encoding.DER:
  1717. if password:
  1718. raise ValueError(
  1719. "Encryption is not supported for DER encoded "
  1720. "traditional OpenSSL keys"
  1721. )
  1722. if key_type == self._lib.EVP_PKEY_RSA:
  1723. write_bio = self._lib.i2d_RSAPrivateKey_bio
  1724. elif key_type == self._lib.EVP_PKEY_EC:
  1725. write_bio = self._lib.i2d_ECPrivateKey_bio
  1726. elif key_type == self._lib.EVP_PKEY_DSA:
  1727. write_bio = self._lib.i2d_DSAPrivateKey_bio
  1728. else:
  1729. raise ValueError(
  1730. "Unsupported key type for TraditionalOpenSSL"
  1731. )
  1732. return self._bio_func_output(write_bio, cdata)
  1733. raise ValueError("Unsupported encoding for TraditionalOpenSSL")
  1734. # OpenSSH + PEM
  1735. if format is serialization.PrivateFormat.OpenSSH:
  1736. if encoding is serialization.Encoding.PEM:
  1737. return ssh.serialize_ssh_private_key(key, password)
  1738. raise ValueError(
  1739. "OpenSSH private key format can only be used"
  1740. " with PEM encoding"
  1741. )
  1742. # Anything that key-specific code was supposed to handle earlier,
  1743. # like Raw.
  1744. raise ValueError("format is invalid with this key")
  1745. def _private_key_bytes_via_bio(self, write_bio, evp_pkey, password):
  1746. if not password:
  1747. evp_cipher = self._ffi.NULL
  1748. else:
  1749. # This is a curated value that we will update over time.
  1750. evp_cipher = self._lib.EVP_get_cipherbyname(b"aes-256-cbc")
  1751. return self._bio_func_output(
  1752. write_bio,
  1753. evp_pkey,
  1754. evp_cipher,
  1755. password,
  1756. len(password),
  1757. self._ffi.NULL,
  1758. self._ffi.NULL,
  1759. )
  1760. def _bio_func_output(self, write_bio, *args):
  1761. bio = self._create_mem_bio_gc()
  1762. res = write_bio(bio, *args)
  1763. self.openssl_assert(res == 1)
  1764. return self._read_mem_bio(bio)
  1765. def _public_key_bytes(self, encoding, format, key, evp_pkey, cdata):
  1766. if not isinstance(encoding, serialization.Encoding):
  1767. raise TypeError("encoding must be an item from the Encoding enum")
  1768. if not isinstance(format, serialization.PublicFormat):
  1769. raise TypeError(
  1770. "format must be an item from the PublicFormat enum"
  1771. )
  1772. # SubjectPublicKeyInfo + PEM/DER
  1773. if format is serialization.PublicFormat.SubjectPublicKeyInfo:
  1774. if encoding is serialization.Encoding.PEM:
  1775. write_bio = self._lib.PEM_write_bio_PUBKEY
  1776. elif encoding is serialization.Encoding.DER:
  1777. write_bio = self._lib.i2d_PUBKEY_bio
  1778. else:
  1779. raise ValueError(
  1780. "SubjectPublicKeyInfo works only with PEM or DER encoding"
  1781. )
  1782. return self._bio_func_output(write_bio, evp_pkey)
  1783. # PKCS1 + PEM/DER
  1784. if format is serialization.PublicFormat.PKCS1:
  1785. # Only RSA is supported here.
  1786. key_type = self._lib.EVP_PKEY_id(evp_pkey)
  1787. if key_type != self._lib.EVP_PKEY_RSA:
  1788. raise ValueError("PKCS1 format is supported only for RSA keys")
  1789. if encoding is serialization.Encoding.PEM:
  1790. write_bio = self._lib.PEM_write_bio_RSAPublicKey
  1791. elif encoding is serialization.Encoding.DER:
  1792. write_bio = self._lib.i2d_RSAPublicKey_bio
  1793. else:
  1794. raise ValueError("PKCS1 works only with PEM or DER encoding")
  1795. return self._bio_func_output(write_bio, cdata)
  1796. # OpenSSH + OpenSSH
  1797. if format is serialization.PublicFormat.OpenSSH:
  1798. if encoding is serialization.Encoding.OpenSSH:
  1799. return ssh.serialize_ssh_public_key(key)
  1800. raise ValueError(
  1801. "OpenSSH format must be used with OpenSSH encoding"
  1802. )
  1803. # Anything that key-specific code was supposed to handle earlier,
  1804. # like Raw, CompressedPoint, UncompressedPoint
  1805. raise ValueError("format is invalid with this key")
  1806. def _parameter_bytes(self, encoding, format, cdata):
  1807. if encoding is serialization.Encoding.OpenSSH:
  1808. raise TypeError("OpenSSH encoding is not supported")
  1809. # Only DH is supported here currently.
  1810. q = self._ffi.new("BIGNUM **")
  1811. self._lib.DH_get0_pqg(cdata, self._ffi.NULL, q, self._ffi.NULL)
  1812. if encoding is serialization.Encoding.PEM:
  1813. if q[0] != self._ffi.NULL:
  1814. write_bio = self._lib.PEM_write_bio_DHxparams
  1815. else:
  1816. write_bio = self._lib.PEM_write_bio_DHparams
  1817. elif encoding is serialization.Encoding.DER:
  1818. if q[0] != self._ffi.NULL:
  1819. write_bio = self._lib.Cryptography_i2d_DHxparams_bio
  1820. else:
  1821. write_bio = self._lib.i2d_DHparams_bio
  1822. else:
  1823. raise TypeError("encoding must be an item from the Encoding enum")
  1824. bio = self._create_mem_bio_gc()
  1825. res = write_bio(bio, cdata)
  1826. self.openssl_assert(res == 1)
  1827. return self._read_mem_bio(bio)
  1828. def generate_dh_parameters(self, generator, key_size):
  1829. if key_size < 512:
  1830. raise ValueError("DH key_size must be at least 512 bits")
  1831. if generator not in (2, 5):
  1832. raise ValueError("DH generator must be 2 or 5")
  1833. dh_param_cdata = self._lib.DH_new()
  1834. self.openssl_assert(dh_param_cdata != self._ffi.NULL)
  1835. dh_param_cdata = self._ffi.gc(dh_param_cdata, self._lib.DH_free)
  1836. res = self._lib.DH_generate_parameters_ex(
  1837. dh_param_cdata, key_size, generator, self._ffi.NULL
  1838. )
  1839. self.openssl_assert(res == 1)
  1840. return _DHParameters(self, dh_param_cdata)
  1841. def _dh_cdata_to_evp_pkey(self, dh_cdata):
  1842. evp_pkey = self._create_evp_pkey_gc()
  1843. res = self._lib.EVP_PKEY_set1_DH(evp_pkey, dh_cdata)
  1844. self.openssl_assert(res == 1)
  1845. return evp_pkey
  1846. def generate_dh_private_key(self, parameters):
  1847. dh_key_cdata = _dh_params_dup(parameters._dh_cdata, self)
  1848. res = self._lib.DH_generate_key(dh_key_cdata)
  1849. self.openssl_assert(res == 1)
  1850. evp_pkey = self._dh_cdata_to_evp_pkey(dh_key_cdata)
  1851. return _DHPrivateKey(self, dh_key_cdata, evp_pkey)
  1852. def generate_dh_private_key_and_parameters(self, generator, key_size):
  1853. return self.generate_dh_private_key(
  1854. self.generate_dh_parameters(generator, key_size)
  1855. )
  1856. def load_dh_private_numbers(self, numbers):
  1857. parameter_numbers = numbers.public_numbers.parameter_numbers
  1858. dh_cdata = self._lib.DH_new()
  1859. self.openssl_assert(dh_cdata != self._ffi.NULL)
  1860. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1861. p = self._int_to_bn(parameter_numbers.p)
  1862. g = self._int_to_bn(parameter_numbers.g)
  1863. if parameter_numbers.q is not None:
  1864. q = self._int_to_bn(parameter_numbers.q)
  1865. else:
  1866. q = self._ffi.NULL
  1867. pub_key = self._int_to_bn(numbers.public_numbers.y)
  1868. priv_key = self._int_to_bn(numbers.x)
  1869. res = self._lib.DH_set0_pqg(dh_cdata, p, q, g)
  1870. self.openssl_assert(res == 1)
  1871. res = self._lib.DH_set0_key(dh_cdata, pub_key, priv_key)
  1872. self.openssl_assert(res == 1)
  1873. codes = self._ffi.new("int[]", 1)
  1874. res = self._lib.Cryptography_DH_check(dh_cdata, codes)
  1875. self.openssl_assert(res == 1)
  1876. # DH_check will return DH_NOT_SUITABLE_GENERATOR if p % 24 does not
  1877. # equal 11 when the generator is 2 (a quadratic nonresidue).
  1878. # We want to ignore that error because p % 24 == 23 is also fine.
  1879. # Specifically, g is then a quadratic residue. Within the context of
  1880. # Diffie-Hellman this means it can only generate half the possible
  1881. # values. That sounds bad, but quadratic nonresidues leak a bit of
  1882. # the key to the attacker in exchange for having the full key space
  1883. # available. See: https://crypto.stackexchange.com/questions/12961
  1884. if codes[0] != 0 and not (
  1885. parameter_numbers.g == 2
  1886. and codes[0] ^ self._lib.DH_NOT_SUITABLE_GENERATOR == 0
  1887. ):
  1888. raise ValueError("DH private numbers did not pass safety checks.")
  1889. evp_pkey = self._dh_cdata_to_evp_pkey(dh_cdata)
  1890. return _DHPrivateKey(self, dh_cdata, evp_pkey)
  1891. def load_dh_public_numbers(self, numbers):
  1892. dh_cdata = self._lib.DH_new()
  1893. self.openssl_assert(dh_cdata != self._ffi.NULL)
  1894. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1895. parameter_numbers = numbers.parameter_numbers
  1896. p = self._int_to_bn(parameter_numbers.p)
  1897. g = self._int_to_bn(parameter_numbers.g)
  1898. if parameter_numbers.q is not None:
  1899. q = self._int_to_bn(parameter_numbers.q)
  1900. else:
  1901. q = self._ffi.NULL
  1902. pub_key = self._int_to_bn(numbers.y)
  1903. res = self._lib.DH_set0_pqg(dh_cdata, p, q, g)
  1904. self.openssl_assert(res == 1)
  1905. res = self._lib.DH_set0_key(dh_cdata, pub_key, self._ffi.NULL)
  1906. self.openssl_assert(res == 1)
  1907. evp_pkey = self._dh_cdata_to_evp_pkey(dh_cdata)
  1908. return _DHPublicKey(self, dh_cdata, evp_pkey)
  1909. def load_dh_parameter_numbers(self, numbers):
  1910. dh_cdata = self._lib.DH_new()
  1911. self.openssl_assert(dh_cdata != self._ffi.NULL)
  1912. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1913. p = self._int_to_bn(numbers.p)
  1914. g = self._int_to_bn(numbers.g)
  1915. if numbers.q is not None:
  1916. q = self._int_to_bn(numbers.q)
  1917. else:
  1918. q = self._ffi.NULL
  1919. res = self._lib.DH_set0_pqg(dh_cdata, p, q, g)
  1920. self.openssl_assert(res == 1)
  1921. return _DHParameters(self, dh_cdata)
  1922. def dh_parameters_supported(self, p, g, q=None):
  1923. dh_cdata = self._lib.DH_new()
  1924. self.openssl_assert(dh_cdata != self._ffi.NULL)
  1925. dh_cdata = self._ffi.gc(dh_cdata, self._lib.DH_free)
  1926. p = self._int_to_bn(p)
  1927. g = self._int_to_bn(g)
  1928. if q is not None:
  1929. q = self._int_to_bn(q)
  1930. else:
  1931. q = self._ffi.NULL
  1932. res = self._lib.DH_set0_pqg(dh_cdata, p, q, g)
  1933. self.openssl_assert(res == 1)
  1934. codes = self._ffi.new("int[]", 1)
  1935. res = self._lib.Cryptography_DH_check(dh_cdata, codes)
  1936. self.openssl_assert(res == 1)
  1937. return codes[0] == 0
  1938. def dh_x942_serialization_supported(self):
  1939. return self._lib.Cryptography_HAS_EVP_PKEY_DHX == 1
  1940. def x509_name_bytes(self, name):
  1941. x509_name = _encode_name_gc(self, name)
  1942. pp = self._ffi.new("unsigned char **")
  1943. res = self._lib.i2d_X509_NAME(x509_name, pp)
  1944. self.openssl_assert(pp[0] != self._ffi.NULL)
  1945. pp = self._ffi.gc(
  1946. pp, lambda pointer: self._lib.OPENSSL_free(pointer[0])
  1947. )
  1948. self.openssl_assert(res > 0)
  1949. return self._ffi.buffer(pp[0], res)[:]
  1950. def x25519_load_public_bytes(self, data):
  1951. # When we drop support for CRYPTOGRAPHY_OPENSSL_LESS_THAN_111 we can
  1952. # switch this to EVP_PKEY_new_raw_public_key
  1953. if len(data) != 32:
  1954. raise ValueError("An X25519 public key is 32 bytes long")
  1955. evp_pkey = self._create_evp_pkey_gc()
  1956. res = self._lib.EVP_PKEY_set_type(evp_pkey, self._lib.NID_X25519)
  1957. self.openssl_assert(res == 1)
  1958. res = self._lib.EVP_PKEY_set1_tls_encodedpoint(
  1959. evp_pkey, data, len(data)
  1960. )
  1961. self.openssl_assert(res == 1)
  1962. return _X25519PublicKey(self, evp_pkey)
  1963. def x25519_load_private_bytes(self, data):
  1964. # When we drop support for CRYPTOGRAPHY_OPENSSL_LESS_THAN_111 we can
  1965. # switch this to EVP_PKEY_new_raw_private_key and drop the
  1966. # zeroed_bytearray garbage.
  1967. # OpenSSL only has facilities for loading PKCS8 formatted private
  1968. # keys using the algorithm identifiers specified in
  1969. # https://tools.ietf.org/html/draft-ietf-curdle-pkix-09.
  1970. # This is the standard PKCS8 prefix for a 32 byte X25519 key.
  1971. # The form is:
  1972. # 0:d=0 hl=2 l= 46 cons: SEQUENCE
  1973. # 2:d=1 hl=2 l= 1 prim: INTEGER :00
  1974. # 5:d=1 hl=2 l= 5 cons: SEQUENCE
  1975. # 7:d=2 hl=2 l= 3 prim: OBJECT :1.3.101.110
  1976. # 12:d=1 hl=2 l= 34 prim: OCTET STRING (the key)
  1977. # Of course there's a bit more complexity. In reality OCTET STRING
  1978. # contains an OCTET STRING of length 32! So the last two bytes here
  1979. # are \x04\x20, which is an OCTET STRING of length 32.
  1980. if len(data) != 32:
  1981. raise ValueError("An X25519 private key is 32 bytes long")
  1982. pkcs8_prefix = b'0.\x02\x01\x000\x05\x06\x03+en\x04"\x04 '
  1983. with self._zeroed_bytearray(48) as ba:
  1984. ba[0:16] = pkcs8_prefix
  1985. ba[16:] = data
  1986. bio = self._bytes_to_bio(ba)
  1987. evp_pkey = self._lib.d2i_PrivateKey_bio(bio.bio, self._ffi.NULL)
  1988. self.openssl_assert(evp_pkey != self._ffi.NULL)
  1989. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  1990. self.openssl_assert(
  1991. self._lib.EVP_PKEY_id(evp_pkey) == self._lib.EVP_PKEY_X25519
  1992. )
  1993. return _X25519PrivateKey(self, evp_pkey)
  1994. def _evp_pkey_keygen_gc(self, nid):
  1995. evp_pkey_ctx = self._lib.EVP_PKEY_CTX_new_id(nid, self._ffi.NULL)
  1996. self.openssl_assert(evp_pkey_ctx != self._ffi.NULL)
  1997. evp_pkey_ctx = self._ffi.gc(evp_pkey_ctx, self._lib.EVP_PKEY_CTX_free)
  1998. res = self._lib.EVP_PKEY_keygen_init(evp_pkey_ctx)
  1999. self.openssl_assert(res == 1)
  2000. evp_ppkey = self._ffi.new("EVP_PKEY **")
  2001. res = self._lib.EVP_PKEY_keygen(evp_pkey_ctx, evp_ppkey)
  2002. self.openssl_assert(res == 1)
  2003. self.openssl_assert(evp_ppkey[0] != self._ffi.NULL)
  2004. evp_pkey = self._ffi.gc(evp_ppkey[0], self._lib.EVP_PKEY_free)
  2005. return evp_pkey
  2006. def x25519_generate_key(self):
  2007. evp_pkey = self._evp_pkey_keygen_gc(self._lib.NID_X25519)
  2008. return _X25519PrivateKey(self, evp_pkey)
  2009. def x25519_supported(self):
  2010. if self._fips_enabled:
  2011. return False
  2012. return self._lib.CRYPTOGRAPHY_OPENSSL_110_OR_GREATER
  2013. def x448_load_public_bytes(self, data):
  2014. if len(data) != 56:
  2015. raise ValueError("An X448 public key is 56 bytes long")
  2016. evp_pkey = self._lib.EVP_PKEY_new_raw_public_key(
  2017. self._lib.NID_X448, self._ffi.NULL, data, len(data)
  2018. )
  2019. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2020. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2021. return _X448PublicKey(self, evp_pkey)
  2022. def x448_load_private_bytes(self, data):
  2023. if len(data) != 56:
  2024. raise ValueError("An X448 private key is 56 bytes long")
  2025. data_ptr = self._ffi.from_buffer(data)
  2026. evp_pkey = self._lib.EVP_PKEY_new_raw_private_key(
  2027. self._lib.NID_X448, self._ffi.NULL, data_ptr, len(data)
  2028. )
  2029. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2030. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2031. return _X448PrivateKey(self, evp_pkey)
  2032. def x448_generate_key(self):
  2033. evp_pkey = self._evp_pkey_keygen_gc(self._lib.NID_X448)
  2034. return _X448PrivateKey(self, evp_pkey)
  2035. def x448_supported(self):
  2036. if self._fips_enabled:
  2037. return False
  2038. return not self._lib.CRYPTOGRAPHY_OPENSSL_LESS_THAN_111
  2039. def ed25519_supported(self):
  2040. if self._fips_enabled:
  2041. return False
  2042. return not self._lib.CRYPTOGRAPHY_OPENSSL_LESS_THAN_111B
  2043. def ed25519_load_public_bytes(self, data):
  2044. utils._check_bytes("data", data)
  2045. if len(data) != ed25519._ED25519_KEY_SIZE:
  2046. raise ValueError("An Ed25519 public key is 32 bytes long")
  2047. evp_pkey = self._lib.EVP_PKEY_new_raw_public_key(
  2048. self._lib.NID_ED25519, self._ffi.NULL, data, len(data)
  2049. )
  2050. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2051. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2052. return _Ed25519PublicKey(self, evp_pkey)
  2053. def ed25519_load_private_bytes(self, data):
  2054. if len(data) != ed25519._ED25519_KEY_SIZE:
  2055. raise ValueError("An Ed25519 private key is 32 bytes long")
  2056. utils._check_byteslike("data", data)
  2057. data_ptr = self._ffi.from_buffer(data)
  2058. evp_pkey = self._lib.EVP_PKEY_new_raw_private_key(
  2059. self._lib.NID_ED25519, self._ffi.NULL, data_ptr, len(data)
  2060. )
  2061. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2062. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2063. return _Ed25519PrivateKey(self, evp_pkey)
  2064. def ed25519_generate_key(self):
  2065. evp_pkey = self._evp_pkey_keygen_gc(self._lib.NID_ED25519)
  2066. return _Ed25519PrivateKey(self, evp_pkey)
  2067. def ed448_supported(self):
  2068. if self._fips_enabled:
  2069. return False
  2070. return not self._lib.CRYPTOGRAPHY_OPENSSL_LESS_THAN_111B
  2071. def ed448_load_public_bytes(self, data):
  2072. utils._check_bytes("data", data)
  2073. if len(data) != _ED448_KEY_SIZE:
  2074. raise ValueError("An Ed448 public key is 57 bytes long")
  2075. evp_pkey = self._lib.EVP_PKEY_new_raw_public_key(
  2076. self._lib.NID_ED448, self._ffi.NULL, data, len(data)
  2077. )
  2078. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2079. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2080. return _Ed448PublicKey(self, evp_pkey)
  2081. def ed448_load_private_bytes(self, data):
  2082. utils._check_byteslike("data", data)
  2083. if len(data) != _ED448_KEY_SIZE:
  2084. raise ValueError("An Ed448 private key is 57 bytes long")
  2085. data_ptr = self._ffi.from_buffer(data)
  2086. evp_pkey = self._lib.EVP_PKEY_new_raw_private_key(
  2087. self._lib.NID_ED448, self._ffi.NULL, data_ptr, len(data)
  2088. )
  2089. self.openssl_assert(evp_pkey != self._ffi.NULL)
  2090. evp_pkey = self._ffi.gc(evp_pkey, self._lib.EVP_PKEY_free)
  2091. return _Ed448PrivateKey(self, evp_pkey)
  2092. def ed448_generate_key(self):
  2093. evp_pkey = self._evp_pkey_keygen_gc(self._lib.NID_ED448)
  2094. return _Ed448PrivateKey(self, evp_pkey)
  2095. def derive_scrypt(self, key_material, salt, length, n, r, p):
  2096. buf = self._ffi.new("unsigned char[]", length)
  2097. key_material_ptr = self._ffi.from_buffer(key_material)
  2098. res = self._lib.EVP_PBE_scrypt(
  2099. key_material_ptr,
  2100. len(key_material),
  2101. salt,
  2102. len(salt),
  2103. n,
  2104. r,
  2105. p,
  2106. scrypt._MEM_LIMIT,
  2107. buf,
  2108. length,
  2109. )
  2110. if res != 1:
  2111. errors = self._consume_errors_with_text()
  2112. # memory required formula explained here:
  2113. # https://blog.filippo.io/the-scrypt-parameters/
  2114. min_memory = 128 * n * r // (1024 ** 2)
  2115. raise MemoryError(
  2116. "Not enough memory to derive key. These parameters require"
  2117. " {} MB of memory.".format(min_memory),
  2118. errors,
  2119. )
  2120. return self._ffi.buffer(buf)[:]
  2121. def aead_cipher_supported(self, cipher):
  2122. cipher_name = aead._aead_cipher_name(cipher)
  2123. if self._fips_enabled and cipher_name not in self._fips_aead:
  2124. return False
  2125. return self._lib.EVP_get_cipherbyname(cipher_name) != self._ffi.NULL
  2126. @contextlib.contextmanager
  2127. def _zeroed_bytearray(self, length):
  2128. """
  2129. This method creates a bytearray, which we copy data into (hopefully
  2130. also from a mutable buffer that can be dynamically erased!), and then
  2131. zero when we're done.
  2132. """
  2133. ba = bytearray(length)
  2134. try:
  2135. yield ba
  2136. finally:
  2137. self._zero_data(ba, length)
  2138. def _zero_data(self, data, length):
  2139. # We clear things this way because at the moment we're not
  2140. # sure of a better way that can guarantee it overwrites the
  2141. # memory of a bytearray and doesn't just replace the underlying char *.
  2142. for i in range(length):
  2143. data[i] = 0
  2144. @contextlib.contextmanager
  2145. def _zeroed_null_terminated_buf(self, data):
  2146. """
  2147. This method takes bytes, which can be a bytestring or a mutable
  2148. buffer like a bytearray, and yields a null-terminated version of that
  2149. data. This is required because PKCS12_parse doesn't take a length with
  2150. its password char * and ffi.from_buffer doesn't provide null
  2151. termination. So, to support zeroing the data via bytearray we
  2152. need to build this ridiculous construct that copies the memory, but
  2153. zeroes it after use.
  2154. """
  2155. if data is None:
  2156. yield self._ffi.NULL
  2157. else:
  2158. data_len = len(data)
  2159. buf = self._ffi.new("char[]", data_len + 1)
  2160. self._ffi.memmove(buf, data, data_len)
  2161. try:
  2162. yield buf
  2163. finally:
  2164. # Cast to a uint8_t * so we can assign by integer
  2165. self._zero_data(self._ffi.cast("uint8_t *", buf), data_len)
  2166. def load_key_and_certificates_from_pkcs12(self, data, password):
  2167. if password is not None:
  2168. utils._check_byteslike("password", password)
  2169. bio = self._bytes_to_bio(data)
  2170. p12 = self._lib.d2i_PKCS12_bio(bio.bio, self._ffi.NULL)
  2171. if p12 == self._ffi.NULL:
  2172. self._consume_errors()
  2173. raise ValueError("Could not deserialize PKCS12 data")
  2174. p12 = self._ffi.gc(p12, self._lib.PKCS12_free)
  2175. evp_pkey_ptr = self._ffi.new("EVP_PKEY **")
  2176. x509_ptr = self._ffi.new("X509 **")
  2177. sk_x509_ptr = self._ffi.new("Cryptography_STACK_OF_X509 **")
  2178. with self._zeroed_null_terminated_buf(password) as password_buf:
  2179. res = self._lib.PKCS12_parse(
  2180. p12, password_buf, evp_pkey_ptr, x509_ptr, sk_x509_ptr
  2181. )
  2182. if res == 0:
  2183. self._consume_errors()
  2184. raise ValueError("Invalid password or PKCS12 data")
  2185. cert = None
  2186. key = None
  2187. additional_certificates = []
  2188. if evp_pkey_ptr[0] != self._ffi.NULL:
  2189. evp_pkey = self._ffi.gc(evp_pkey_ptr[0], self._lib.EVP_PKEY_free)
  2190. key = self._evp_pkey_to_private_key(evp_pkey)
  2191. if x509_ptr[0] != self._ffi.NULL:
  2192. x509 = self._ffi.gc(x509_ptr[0], self._lib.X509_free)
  2193. cert = _Certificate(self, x509)
  2194. if sk_x509_ptr[0] != self._ffi.NULL:
  2195. sk_x509 = self._ffi.gc(sk_x509_ptr[0], self._lib.sk_X509_free)
  2196. num = self._lib.sk_X509_num(sk_x509_ptr[0])
  2197. for i in range(num):
  2198. x509 = self._lib.sk_X509_value(sk_x509, i)
  2199. self.openssl_assert(x509 != self._ffi.NULL)
  2200. x509 = self._ffi.gc(x509, self._lib.X509_free)
  2201. additional_certificates.append(_Certificate(self, x509))
  2202. return (key, cert, additional_certificates)
  2203. def serialize_key_and_certificates_to_pkcs12(
  2204. self, name, key, cert, cas, encryption_algorithm
  2205. ):
  2206. password = None
  2207. if name is not None:
  2208. utils._check_bytes("name", name)
  2209. if isinstance(encryption_algorithm, serialization.NoEncryption):
  2210. nid_cert = -1
  2211. nid_key = -1
  2212. pkcs12_iter = 0
  2213. mac_iter = 0
  2214. elif isinstance(
  2215. encryption_algorithm, serialization.BestAvailableEncryption
  2216. ):
  2217. # PKCS12 encryption is hopeless trash and can never be fixed.
  2218. # This is the least terrible option.
  2219. nid_cert = self._lib.NID_pbe_WithSHA1And3_Key_TripleDES_CBC
  2220. nid_key = self._lib.NID_pbe_WithSHA1And3_Key_TripleDES_CBC
  2221. # At least we can set this higher than OpenSSL's default
  2222. pkcs12_iter = 20000
  2223. # mac_iter chosen for compatibility reasons, see:
  2224. # https://www.openssl.org/docs/man1.1.1/man3/PKCS12_create.html
  2225. # Did we mention how lousy PKCS12 encryption is?
  2226. mac_iter = 1
  2227. password = encryption_algorithm.password
  2228. else:
  2229. raise ValueError("Unsupported key encryption type")
  2230. if cas is None or len(cas) == 0:
  2231. sk_x509 = self._ffi.NULL
  2232. else:
  2233. sk_x509 = self._lib.sk_X509_new_null()
  2234. sk_x509 = self._ffi.gc(sk_x509, self._lib.sk_X509_free)
  2235. # reverse the list when building the stack so that they're encoded
  2236. # in the order they were originally provided. it is a mystery
  2237. for ca in reversed(cas):
  2238. res = self._lib.sk_X509_push(sk_x509, ca._x509)
  2239. backend.openssl_assert(res >= 1)
  2240. with self._zeroed_null_terminated_buf(password) as password_buf:
  2241. with self._zeroed_null_terminated_buf(name) as name_buf:
  2242. p12 = self._lib.PKCS12_create(
  2243. password_buf,
  2244. name_buf,
  2245. key._evp_pkey if key else self._ffi.NULL,
  2246. cert._x509 if cert else self._ffi.NULL,
  2247. sk_x509,
  2248. nid_key,
  2249. nid_cert,
  2250. pkcs12_iter,
  2251. mac_iter,
  2252. 0,
  2253. )
  2254. self.openssl_assert(p12 != self._ffi.NULL)
  2255. p12 = self._ffi.gc(p12, self._lib.PKCS12_free)
  2256. bio = self._create_mem_bio_gc()
  2257. res = self._lib.i2d_PKCS12_bio(bio, p12)
  2258. self.openssl_assert(res > 0)
  2259. return self._read_mem_bio(bio)
  2260. def poly1305_supported(self):
  2261. if self._fips_enabled:
  2262. return False
  2263. return self._lib.Cryptography_HAS_POLY1305 == 1
  2264. def create_poly1305_ctx(self, key):
  2265. utils._check_byteslike("key", key)
  2266. if len(key) != _POLY1305_KEY_SIZE:
  2267. raise ValueError("A poly1305 key is 32 bytes long")
  2268. return _Poly1305Context(self, key)
  2269. def load_pem_pkcs7_certificates(self, data):
  2270. utils._check_bytes("data", data)
  2271. bio = self._bytes_to_bio(data)
  2272. p7 = self._lib.PEM_read_bio_PKCS7(
  2273. bio.bio, self._ffi.NULL, self._ffi.NULL, self._ffi.NULL
  2274. )
  2275. if p7 == self._ffi.NULL:
  2276. self._consume_errors()
  2277. raise ValueError("Unable to parse PKCS7 data")
  2278. p7 = self._ffi.gc(p7, self._lib.PKCS7_free)
  2279. return self._load_pkcs7_certificates(p7)
  2280. def load_der_pkcs7_certificates(self, data):
  2281. utils._check_bytes("data", data)
  2282. bio = self._bytes_to_bio(data)
  2283. p7 = self._lib.d2i_PKCS7_bio(bio.bio, self._ffi.NULL)
  2284. if p7 == self._ffi.NULL:
  2285. self._consume_errors()
  2286. raise ValueError("Unable to parse PKCS7 data")
  2287. p7 = self._ffi.gc(p7, self._lib.PKCS7_free)
  2288. return self._load_pkcs7_certificates(p7)
  2289. def _load_pkcs7_certificates(self, p7):
  2290. nid = self._lib.OBJ_obj2nid(p7.type)
  2291. self.openssl_assert(nid != self._lib.NID_undef)
  2292. if nid != self._lib.NID_pkcs7_signed:
  2293. raise UnsupportedAlgorithm(
  2294. "Only basic signed structures are currently supported. NID"
  2295. " for this data was {}".format(nid),
  2296. _Reasons.UNSUPPORTED_SERIALIZATION,
  2297. )
  2298. sk_x509 = p7.d.sign.cert
  2299. num = self._lib.sk_X509_num(sk_x509)
  2300. certs = []
  2301. for i in range(num):
  2302. x509 = self._lib.sk_X509_value(sk_x509, i)
  2303. self.openssl_assert(x509 != self._ffi.NULL)
  2304. res = self._lib.X509_up_ref(x509)
  2305. # When OpenSSL is less than 1.1.0 up_ref returns the current
  2306. # refcount. On 1.1.0+ it returns 1 for success.
  2307. self.openssl_assert(res >= 1)
  2308. x509 = self._ffi.gc(x509, self._lib.X509_free)
  2309. certs.append(_Certificate(self, x509))
  2310. return certs
  2311. def pkcs7_sign(self, builder, encoding, options):
  2312. bio = self._bytes_to_bio(builder._data)
  2313. init_flags = self._lib.PKCS7_PARTIAL
  2314. final_flags = 0
  2315. if len(builder._additional_certs) == 0:
  2316. certs = self._ffi.NULL
  2317. else:
  2318. certs = self._lib.sk_X509_new_null()
  2319. certs = self._ffi.gc(certs, self._lib.sk_X509_free)
  2320. for cert in builder._additional_certs:
  2321. res = self._lib.sk_X509_push(certs, cert._x509)
  2322. self.openssl_assert(res >= 1)
  2323. if pkcs7.PKCS7Options.DetachedSignature in options:
  2324. # Don't embed the data in the PKCS7 structure
  2325. init_flags |= self._lib.PKCS7_DETACHED
  2326. final_flags |= self._lib.PKCS7_DETACHED
  2327. # This just inits a structure for us. However, there
  2328. # are flags we need to set, joy.
  2329. p7 = self._lib.PKCS7_sign(
  2330. self._ffi.NULL,
  2331. self._ffi.NULL,
  2332. certs,
  2333. self._ffi.NULL,
  2334. init_flags,
  2335. )
  2336. self.openssl_assert(p7 != self._ffi.NULL)
  2337. p7 = self._ffi.gc(p7, self._lib.PKCS7_free)
  2338. signer_flags = 0
  2339. # These flags are configurable on a per-signature basis
  2340. # but we've deliberately chosen to make the API only allow
  2341. # setting it across all signatures for now.
  2342. if pkcs7.PKCS7Options.NoCapabilities in options:
  2343. signer_flags |= self._lib.PKCS7_NOSMIMECAP
  2344. elif pkcs7.PKCS7Options.NoAttributes in options:
  2345. signer_flags |= self._lib.PKCS7_NOATTR
  2346. if pkcs7.PKCS7Options.NoCerts in options:
  2347. signer_flags |= self._lib.PKCS7_NOCERTS
  2348. for certificate, private_key, hash_algorithm in builder._signers:
  2349. md = self._evp_md_non_null_from_algorithm(hash_algorithm)
  2350. p7signerinfo = self._lib.PKCS7_sign_add_signer(
  2351. p7, certificate._x509, private_key._evp_pkey, md, signer_flags
  2352. )
  2353. self.openssl_assert(p7signerinfo != self._ffi.NULL)
  2354. for option in options:
  2355. # DetachedSignature, NoCapabilities, and NoAttributes are already
  2356. # handled so we just need to check these last two options.
  2357. if option is pkcs7.PKCS7Options.Text:
  2358. final_flags |= self._lib.PKCS7_TEXT
  2359. elif option is pkcs7.PKCS7Options.Binary:
  2360. final_flags |= self._lib.PKCS7_BINARY
  2361. bio_out = self._create_mem_bio_gc()
  2362. if encoding is serialization.Encoding.SMIME:
  2363. # This finalizes the structure
  2364. res = self._lib.SMIME_write_PKCS7(
  2365. bio_out, p7, bio.bio, final_flags
  2366. )
  2367. elif encoding is serialization.Encoding.PEM:
  2368. res = self._lib.PKCS7_final(p7, bio.bio, final_flags)
  2369. self.openssl_assert(res == 1)
  2370. res = self._lib.PEM_write_bio_PKCS7_stream(
  2371. bio_out, p7, bio.bio, final_flags
  2372. )
  2373. else:
  2374. assert encoding is serialization.Encoding.DER
  2375. # We need to call finalize here becauase i2d_PKCS7_bio does not
  2376. # finalize.
  2377. res = self._lib.PKCS7_final(p7, bio.bio, final_flags)
  2378. self.openssl_assert(res == 1)
  2379. res = self._lib.i2d_PKCS7_bio(bio_out, p7)
  2380. self.openssl_assert(res == 1)
  2381. return self._read_mem_bio(bio_out)
  2382. class GetCipherByName(object):
  2383. def __init__(self, fmt):
  2384. self._fmt = fmt
  2385. def __call__(self, backend, cipher, mode):
  2386. cipher_name = self._fmt.format(cipher=cipher, mode=mode).lower()
  2387. return backend._lib.EVP_get_cipherbyname(cipher_name.encode("ascii"))
  2388. def _get_xts_cipher(backend, cipher, mode):
  2389. cipher_name = "aes-{}-xts".format(cipher.key_size // 2)
  2390. return backend._lib.EVP_get_cipherbyname(cipher_name.encode("ascii"))
  2391. backend = Backend()