ec.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  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 annotations
  5. import abc
  6. import typing
  7. from cryptography import utils
  8. from cryptography.exceptions import UnsupportedAlgorithm, _Reasons
  9. from cryptography.hazmat._oid import ObjectIdentifier
  10. from cryptography.hazmat.bindings._rust import openssl as rust_openssl
  11. from cryptography.hazmat.primitives import _serialization, hashes
  12. from cryptography.hazmat.primitives.asymmetric import utils as asym_utils
  13. class EllipticCurveOID:
  14. SECP192R1 = ObjectIdentifier("1.2.840.10045.3.1.1")
  15. SECP224R1 = ObjectIdentifier("1.3.132.0.33")
  16. SECP256K1 = ObjectIdentifier("1.3.132.0.10")
  17. SECP256R1 = ObjectIdentifier("1.2.840.10045.3.1.7")
  18. SECP384R1 = ObjectIdentifier("1.3.132.0.34")
  19. SECP521R1 = ObjectIdentifier("1.3.132.0.35")
  20. BRAINPOOLP256R1 = ObjectIdentifier("1.3.36.3.3.2.8.1.1.7")
  21. BRAINPOOLP384R1 = ObjectIdentifier("1.3.36.3.3.2.8.1.1.11")
  22. BRAINPOOLP512R1 = ObjectIdentifier("1.3.36.3.3.2.8.1.1.13")
  23. SECT163K1 = ObjectIdentifier("1.3.132.0.1")
  24. SECT163R2 = ObjectIdentifier("1.3.132.0.15")
  25. SECT233K1 = ObjectIdentifier("1.3.132.0.26")
  26. SECT233R1 = ObjectIdentifier("1.3.132.0.27")
  27. SECT283K1 = ObjectIdentifier("1.3.132.0.16")
  28. SECT283R1 = ObjectIdentifier("1.3.132.0.17")
  29. SECT409K1 = ObjectIdentifier("1.3.132.0.36")
  30. SECT409R1 = ObjectIdentifier("1.3.132.0.37")
  31. SECT571K1 = ObjectIdentifier("1.3.132.0.38")
  32. SECT571R1 = ObjectIdentifier("1.3.132.0.39")
  33. class EllipticCurve(metaclass=abc.ABCMeta):
  34. @property
  35. @abc.abstractmethod
  36. def name(self) -> str:
  37. """
  38. The name of the curve. e.g. secp256r1.
  39. """
  40. @property
  41. @abc.abstractmethod
  42. def key_size(self) -> int:
  43. """
  44. Bit size of a secret scalar for the curve.
  45. """
  46. @property
  47. @abc.abstractmethod
  48. def group_order(self) -> int:
  49. """
  50. The order of the curve's group.
  51. """
  52. class EllipticCurveSignatureAlgorithm(metaclass=abc.ABCMeta):
  53. @property
  54. @abc.abstractmethod
  55. def algorithm(
  56. self,
  57. ) -> asym_utils.Prehashed | hashes.HashAlgorithm:
  58. """
  59. The digest algorithm used with this signature.
  60. """
  61. class EllipticCurvePrivateKey(metaclass=abc.ABCMeta):
  62. @abc.abstractmethod
  63. def exchange(
  64. self, algorithm: ECDH, peer_public_key: EllipticCurvePublicKey
  65. ) -> bytes:
  66. """
  67. Performs a key exchange operation using the provided algorithm with the
  68. provided peer's public key.
  69. """
  70. @abc.abstractmethod
  71. def public_key(self) -> EllipticCurvePublicKey:
  72. """
  73. The EllipticCurvePublicKey for this private key.
  74. """
  75. @property
  76. @abc.abstractmethod
  77. def curve(self) -> EllipticCurve:
  78. """
  79. The EllipticCurve that this key is on.
  80. """
  81. @property
  82. @abc.abstractmethod
  83. def key_size(self) -> int:
  84. """
  85. Bit size of a secret scalar for the curve.
  86. """
  87. @abc.abstractmethod
  88. def sign(
  89. self,
  90. data: utils.Buffer,
  91. signature_algorithm: EllipticCurveSignatureAlgorithm,
  92. ) -> bytes:
  93. """
  94. Signs the data
  95. """
  96. @abc.abstractmethod
  97. def private_numbers(self) -> EllipticCurvePrivateNumbers:
  98. """
  99. Returns an EllipticCurvePrivateNumbers.
  100. """
  101. @abc.abstractmethod
  102. def private_bytes(
  103. self,
  104. encoding: _serialization.Encoding,
  105. format: _serialization.PrivateFormat,
  106. encryption_algorithm: _serialization.KeySerializationEncryption,
  107. ) -> bytes:
  108. """
  109. Returns the key serialized as bytes.
  110. """
  111. @abc.abstractmethod
  112. def __copy__(self) -> EllipticCurvePrivateKey:
  113. """
  114. Returns a copy.
  115. """
  116. EllipticCurvePrivateKeyWithSerialization = EllipticCurvePrivateKey
  117. EllipticCurvePrivateKey.register(rust_openssl.ec.ECPrivateKey)
  118. class EllipticCurvePublicKey(metaclass=abc.ABCMeta):
  119. @property
  120. @abc.abstractmethod
  121. def curve(self) -> EllipticCurve:
  122. """
  123. The EllipticCurve that this key is on.
  124. """
  125. @property
  126. @abc.abstractmethod
  127. def key_size(self) -> int:
  128. """
  129. Bit size of a secret scalar for the curve.
  130. """
  131. @abc.abstractmethod
  132. def public_numbers(self) -> EllipticCurvePublicNumbers:
  133. """
  134. Returns an EllipticCurvePublicNumbers.
  135. """
  136. @abc.abstractmethod
  137. def public_bytes(
  138. self,
  139. encoding: _serialization.Encoding,
  140. format: _serialization.PublicFormat,
  141. ) -> bytes:
  142. """
  143. Returns the key serialized as bytes.
  144. """
  145. @abc.abstractmethod
  146. def verify(
  147. self,
  148. signature: utils.Buffer,
  149. data: utils.Buffer,
  150. signature_algorithm: EllipticCurveSignatureAlgorithm,
  151. ) -> None:
  152. """
  153. Verifies the signature of the data.
  154. """
  155. @classmethod
  156. def from_encoded_point(
  157. cls, curve: EllipticCurve, data: bytes
  158. ) -> EllipticCurvePublicKey:
  159. utils._check_bytes("data", data)
  160. if len(data) == 0:
  161. raise ValueError("data must not be an empty byte string")
  162. if data[0] not in [0x02, 0x03, 0x04]:
  163. raise ValueError("Unsupported elliptic curve point type")
  164. return rust_openssl.ec.from_public_bytes(curve, data)
  165. @abc.abstractmethod
  166. def __eq__(self, other: object) -> bool:
  167. """
  168. Checks equality.
  169. """
  170. @abc.abstractmethod
  171. def __copy__(self) -> EllipticCurvePublicKey:
  172. """
  173. Returns a copy.
  174. """
  175. EllipticCurvePublicKeyWithSerialization = EllipticCurvePublicKey
  176. EllipticCurvePublicKey.register(rust_openssl.ec.ECPublicKey)
  177. EllipticCurvePrivateNumbers = rust_openssl.ec.EllipticCurvePrivateNumbers
  178. EllipticCurvePublicNumbers = rust_openssl.ec.EllipticCurvePublicNumbers
  179. class SECT571R1(EllipticCurve):
  180. name = "sect571r1"
  181. key_size = 570
  182. group_order = 0x3FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE661CE18FF55987308059B186823851EC7DD9CA1161DE93D5174D66E8382E9BB2FE84E47 # noqa: E501
  183. class SECT409R1(EllipticCurve):
  184. name = "sect409r1"
  185. key_size = 409
  186. group_order = 0x10000000000000000000000000000000000000000000000000001E2AAD6A612F33307BE5FA47C3C9E052F838164CD37D9A21173 # noqa: E501
  187. class SECT283R1(EllipticCurve):
  188. name = "sect283r1"
  189. key_size = 283
  190. group_order = 0x3FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEF90399660FC938A90165B042A7CEFADB307 # noqa: E501
  191. class SECT233R1(EllipticCurve):
  192. name = "sect233r1"
  193. key_size = 233
  194. group_order = 0x1000000000000000000000000000013E974E72F8A6922031D2603CFE0D7
  195. class SECT163R2(EllipticCurve):
  196. name = "sect163r2"
  197. key_size = 163
  198. group_order = 0x40000000000000000000292FE77E70C12A4234C33
  199. class SECT571K1(EllipticCurve):
  200. name = "sect571k1"
  201. key_size = 571
  202. group_order = 0x20000000000000000000000000000000000000000000000000000000000000000000000131850E1F19A63E4B391A8DB917F4138B630D84BE5D639381E91DEB45CFE778F637C1001 # noqa: E501
  203. class SECT409K1(EllipticCurve):
  204. name = "sect409k1"
  205. key_size = 409
  206. group_order = 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE5F83B2D4EA20400EC4557D5ED3E3E7CA5B4B5C83B8E01E5FCF # noqa: E501
  207. class SECT283K1(EllipticCurve):
  208. name = "sect283k1"
  209. key_size = 283
  210. group_order = 0x1FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE9AE2ED07577265DFF7F94451E061E163C61 # noqa: E501
  211. class SECT233K1(EllipticCurve):
  212. name = "sect233k1"
  213. key_size = 233
  214. group_order = 0x8000000000000000000000000000069D5BB915BCD46EFB1AD5F173ABDF
  215. class SECT163K1(EllipticCurve):
  216. name = "sect163k1"
  217. key_size = 163
  218. group_order = 0x4000000000000000000020108A2E0CC0D99F8A5EF
  219. class SECP521R1(EllipticCurve):
  220. name = "secp521r1"
  221. key_size = 521
  222. group_order = 0x1FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFA51868783BF2F966B7FCC0148F709A5D03BB5C9B8899C47AEBB6FB71E91386409 # noqa: E501
  223. class SECP384R1(EllipticCurve):
  224. name = "secp384r1"
  225. key_size = 384
  226. group_order = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFC7634D81F4372DDF581A0DB248B0A77AECEC196ACCC52973 # noqa: E501
  227. class SECP256R1(EllipticCurve):
  228. name = "secp256r1"
  229. key_size = 256
  230. group_order = (
  231. 0xFFFFFFFF00000000FFFFFFFFFFFFFFFFBCE6FAADA7179E84F3B9CAC2FC632551
  232. )
  233. class SECP256K1(EllipticCurve):
  234. name = "secp256k1"
  235. key_size = 256
  236. group_order = (
  237. 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141
  238. )
  239. class SECP224R1(EllipticCurve):
  240. name = "secp224r1"
  241. key_size = 224
  242. group_order = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFF16A2E0B8F03E13DD29455C5C2A3D
  243. class SECP192R1(EllipticCurve):
  244. name = "secp192r1"
  245. key_size = 192
  246. group_order = 0xFFFFFFFFFFFFFFFFFFFFFFFF99DEF836146BC9B1B4D22831
  247. class BrainpoolP256R1(EllipticCurve):
  248. name = "brainpoolP256r1"
  249. key_size = 256
  250. group_order = (
  251. 0xA9FB57DBA1EEA9BC3E660A909D838D718C397AA3B561A6F7901E0E82974856A7
  252. )
  253. class BrainpoolP384R1(EllipticCurve):
  254. name = "brainpoolP384r1"
  255. key_size = 384
  256. group_order = 0x8CB91E82A3386D280F5D6F7E50E641DF152F7109ED5456B31F166E6CAC0425A7CF3AB6AF6B7FC3103B883202E9046565 # noqa: E501
  257. class BrainpoolP512R1(EllipticCurve):
  258. name = "brainpoolP512r1"
  259. key_size = 512
  260. group_order = 0xAADD9DB8DBE9C48B3FD4E6AE33C9FC07CB308DB3B3C9D20ED6639CCA70330870553E5C414CA92619418661197FAC10471DB1D381085DDADDB58796829CA90069 # noqa: E501
  261. _CURVE_TYPES: dict[str, EllipticCurve] = {
  262. "prime192v1": SECP192R1(),
  263. "prime256v1": SECP256R1(),
  264. "secp192r1": SECP192R1(),
  265. "secp224r1": SECP224R1(),
  266. "secp256r1": SECP256R1(),
  267. "secp384r1": SECP384R1(),
  268. "secp521r1": SECP521R1(),
  269. "secp256k1": SECP256K1(),
  270. "sect163k1": SECT163K1(),
  271. "sect233k1": SECT233K1(),
  272. "sect283k1": SECT283K1(),
  273. "sect409k1": SECT409K1(),
  274. "sect571k1": SECT571K1(),
  275. "sect163r2": SECT163R2(),
  276. "sect233r1": SECT233R1(),
  277. "sect283r1": SECT283R1(),
  278. "sect409r1": SECT409R1(),
  279. "sect571r1": SECT571R1(),
  280. "brainpoolP256r1": BrainpoolP256R1(),
  281. "brainpoolP384r1": BrainpoolP384R1(),
  282. "brainpoolP512r1": BrainpoolP512R1(),
  283. }
  284. class ECDSA(EllipticCurveSignatureAlgorithm):
  285. def __init__(
  286. self,
  287. algorithm: asym_utils.Prehashed | hashes.HashAlgorithm,
  288. deterministic_signing: bool = False,
  289. ):
  290. from cryptography.hazmat.backends.openssl.backend import backend
  291. if (
  292. deterministic_signing
  293. and not backend.ecdsa_deterministic_supported()
  294. ):
  295. raise UnsupportedAlgorithm(
  296. "ECDSA with deterministic signature (RFC 6979) is not "
  297. "supported by this version of OpenSSL.",
  298. _Reasons.UNSUPPORTED_PUBLIC_KEY_ALGORITHM,
  299. )
  300. self._algorithm = algorithm
  301. self._deterministic_signing = deterministic_signing
  302. @property
  303. def algorithm(
  304. self,
  305. ) -> asym_utils.Prehashed | hashes.HashAlgorithm:
  306. return self._algorithm
  307. @property
  308. def deterministic_signing(
  309. self,
  310. ) -> bool:
  311. return self._deterministic_signing
  312. generate_private_key = rust_openssl.ec.generate_private_key
  313. def derive_private_key(
  314. private_value: int,
  315. curve: EllipticCurve,
  316. backend: typing.Any = None,
  317. ) -> EllipticCurvePrivateKey:
  318. if not isinstance(private_value, int):
  319. raise TypeError("private_value must be an integer type.")
  320. if private_value <= 0:
  321. raise ValueError("private_value must be a positive integer.")
  322. return rust_openssl.ec.derive_private_key(private_value, curve)
  323. class ECDH:
  324. pass
  325. _OID_TO_CURVE = {
  326. EllipticCurveOID.SECP192R1: SECP192R1,
  327. EllipticCurveOID.SECP224R1: SECP224R1,
  328. EllipticCurveOID.SECP256K1: SECP256K1,
  329. EllipticCurveOID.SECP256R1: SECP256R1,
  330. EllipticCurveOID.SECP384R1: SECP384R1,
  331. EllipticCurveOID.SECP521R1: SECP521R1,
  332. EllipticCurveOID.BRAINPOOLP256R1: BrainpoolP256R1,
  333. EllipticCurveOID.BRAINPOOLP384R1: BrainpoolP384R1,
  334. EllipticCurveOID.BRAINPOOLP512R1: BrainpoolP512R1,
  335. EllipticCurveOID.SECT163K1: SECT163K1,
  336. EllipticCurveOID.SECT163R2: SECT163R2,
  337. EllipticCurveOID.SECT233K1: SECT233K1,
  338. EllipticCurveOID.SECT233R1: SECT233R1,
  339. EllipticCurveOID.SECT283K1: SECT283K1,
  340. EllipticCurveOID.SECT283R1: SECT283R1,
  341. EllipticCurveOID.SECT409K1: SECT409K1,
  342. EllipticCurveOID.SECT409R1: SECT409R1,
  343. EllipticCurveOID.SECT571K1: SECT571K1,
  344. EllipticCurveOID.SECT571R1: SECT571R1,
  345. }
  346. def get_curve_for_oid(oid: ObjectIdentifier) -> type[EllipticCurve]:
  347. try:
  348. return _OID_TO_CURVE[oid]
  349. except KeyError:
  350. raise LookupError(
  351. "The provided object identifier has no matching elliptic "
  352. "curve class"
  353. )
  354. _SECT_CURVES: tuple[type[EllipticCurve], ...] = (
  355. SECT163K1,
  356. SECT163R2,
  357. SECT233K1,
  358. SECT233R1,
  359. SECT283K1,
  360. SECT283R1,
  361. SECT409K1,
  362. SECT409R1,
  363. SECT571K1,
  364. SECT571R1,
  365. )
  366. for _curve_cls in _SECT_CURVES:
  367. utils.deprecated(
  368. _curve_cls,
  369. __name__,
  370. f"{_curve_cls.__name__} will be removed in the next release.",
  371. utils.DeprecatedIn46,
  372. name=_curve_cls.__name__,
  373. )