RSA.sol 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. // SPDX-License-Identifier: MIT
  2. pragma solidity ^0.8.20;
  3. import {Math} from "../math/Math.sol";
  4. /**
  5. * @dev RSA PKCS#1 v1.5 signature verification implementation according to https://datatracker.ietf.org/doc/html/rfc8017[RFC8017].
  6. *
  7. * This library supports PKCS#1 v1.5 padding to avoid malleability via chosen plaintext attacks in practical implementations.
  8. * The padding follows the EMSA-PKCS1-v1_5-ENCODE encoding definition as per section 9.2 of the RFC. This padding makes
  9. * RSA semantically secure for signing messages.
  10. *
  11. * Inspired by https://github.com/adria0/SolRsaVerify/blob/79c6182cabb9102ea69d4a2e996816091d5f1cd1[Adrià Massanet's work] (GNU General Public License v3.0).
  12. *
  13. * _Available since v5.1._
  14. */
  15. library RSA {
  16. /**
  17. * @dev Same as {pkcs1Sha256} but using SHA256 to calculate the digest of `data`.
  18. */
  19. function pkcs1Sha256(
  20. bytes memory data,
  21. bytes memory s,
  22. bytes memory e,
  23. bytes memory n
  24. ) internal view returns (bool) {
  25. return pkcs1Sha256(sha256(data), s, e, n);
  26. }
  27. /**
  28. * @dev Verifies a PKCSv1.5 signature given a digest according to the verification
  29. * method described in https://datatracker.ietf.org/doc/html/rfc8017#section-8.2.2[section 8.2.2 of RFC8017] with
  30. * support for explicit or implicit NULL parameters in the DigestInfo (no other optional parameters are supported).
  31. *
  32. * IMPORTANT: For security reason, this function requires the signature and modulus to have a length of at least
  33. * 2048 bits. If you use a smaller key, consider replacing it with a larger, more secure, one.
  34. *
  35. * WARNING: This verification algorithm doesn't prevent replayability. If called multiple times with the same
  36. * digest, public key and (valid signature), it will return true every time. Consider including an onchain nonce
  37. * or unique identifier in the message to prevent replay attacks.
  38. *
  39. * WARNING: This verification algorithm supports any exponent. NIST recommends using `65537` (or higher).
  40. * That is the default value many libraries use, such as OpenSSL. Developers may choose to reject public keys
  41. * using a low exponent out of security concerns.
  42. *
  43. * @param digest the digest to verify
  44. * @param s is a buffer containing the signature
  45. * @param e is the exponent of the public key
  46. * @param n is the modulus of the public key
  47. */
  48. function pkcs1Sha256(bytes32 digest, bytes memory s, bytes memory e, bytes memory n) internal view returns (bool) {
  49. unchecked {
  50. // cache and check length
  51. uint256 length = n.length;
  52. if (
  53. length < 0x100 || // Enforce 2048 bits minimum
  54. length != s.length // signature must have the same length as the finite field
  55. ) {
  56. return false;
  57. }
  58. // Verify that s < n to ensure there's only one valid signature for a given message
  59. for (uint256 i = 0; i < length; i += 0x20) {
  60. uint256 p = Math.min(i, length - 0x20);
  61. bytes32 sp = _unsafeReadBytes32(s, p);
  62. bytes32 np = _unsafeReadBytes32(n, p);
  63. if (sp < np) {
  64. // s < n in the upper bits (everything before is equal) → s < n globally: ok
  65. break;
  66. } else if (sp > np || p == length - 0x20) {
  67. // s > n in the upper bits (everything before is equal) → s > n globally: fail
  68. // or
  69. // s = n and we are looking at the lower bits → s = n globally: fail
  70. return false;
  71. }
  72. }
  73. // RSAVP1 https://datatracker.ietf.org/doc/html/rfc8017#section-5.2.2
  74. // The previous check guarantees that n > 0. Therefore modExp cannot revert.
  75. bytes memory buffer = Math.modExp(s, e, n);
  76. // Check that buffer is well encoded:
  77. // buffer ::= 0x00 | 0x01 | PS | 0x00 | DigestInfo
  78. //
  79. // With
  80. // - PS is padding filled with 0xFF
  81. // - DigestInfo ::= SEQUENCE {
  82. // digestAlgorithm AlgorithmIdentifier,
  83. // [optional algorithm parameters] -- not currently supported
  84. // digest OCTET STRING
  85. // }
  86. // Get AlgorithmIdentifier from the DigestInfo, and set the config accordingly
  87. // - params: includes 00 + first part of DigestInfo
  88. // - mask: filter to check the params
  89. // - offset: length of the suffix (including digest)
  90. bytes32 params; // 0x00 | DigestInfo
  91. bytes32 mask;
  92. uint256 offset;
  93. // Digest is expected at the end of the buffer. Therefore if NULL param is present,
  94. // it should be at 32 (digest) + 2 bytes from the end. To those 34 bytes, we add the
  95. // OID (9 bytes) and its length (2 bytes) to get the position of the DigestInfo sequence,
  96. // which is expected to have a length of 0x31 when the NULL param is present or 0x2f if not.
  97. if (bytes1(_unsafeReadBytes32(buffer, length - 0x32)) == 0x31) {
  98. offset = 0x34;
  99. // 00 (1 byte) | SEQUENCE length (0x31) = 3031 (2 bytes) | SEQUENCE length (0x0d) = 300d (2 bytes) | OBJECT_IDENTIFIER length (0x09) = 0609 (2 bytes)
  100. // SHA256 OID = 608648016503040201 (9 bytes) | NULL = 0500 (2 bytes) (explicit) | OCTET_STRING length (0x20) = 0420 (2 bytes)
  101. params = 0x003031300d060960864801650304020105000420000000000000000000000000;
  102. mask = 0xffffffffffffffffffffffffffffffffffffffff000000000000000000000000; // (20 bytes)
  103. } else if (bytes1(_unsafeReadBytes32(buffer, length - 0x30)) == 0x2F) {
  104. offset = 0x32;
  105. // 00 (1 byte) | SEQUENCE length (0x2f) = 302f (2 bytes) | SEQUENCE length (0x0b) = 300b (2 bytes) | OBJECT_IDENTIFIER length (0x09) = 0609 (2 bytes)
  106. // SHA256 OID = 608648016503040201 (9 bytes) | NULL = <implicit> | OCTET_STRING length (0x20) = 0420 (2 bytes)
  107. params = 0x00302f300b060960864801650304020104200000000000000000000000000000;
  108. mask = 0xffffffffffffffffffffffffffffffffffff0000000000000000000000000000; // (18 bytes)
  109. } else {
  110. // unknown
  111. return false;
  112. }
  113. // Length is at least 0x100 and offset is at most 0x34, so this is safe. There is always some padding.
  114. uint256 paddingEnd = length - offset;
  115. // The padding has variable (arbitrary) length, so we check it byte per byte in a loop.
  116. // This is required to ensure non-malleability. Not checking would allow an attacker to
  117. // use the padding to manipulate the message in order to create a valid signature out of
  118. // multiple valid signatures.
  119. for (uint256 i = 2; i < paddingEnd; ++i) {
  120. if (bytes1(_unsafeReadBytes32(buffer, i)) != 0xFF) {
  121. return false;
  122. }
  123. }
  124. // All the other parameters are small enough to fit in a bytes32, so we can check them directly.
  125. return
  126. bytes2(0x0001) == bytes2(_unsafeReadBytes32(buffer, 0x00)) && // 00 | 01
  127. // PS was checked in the loop
  128. params == _unsafeReadBytes32(buffer, paddingEnd) & mask && // DigestInfo
  129. // Optional parameters are not checked
  130. digest == _unsafeReadBytes32(buffer, length - 0x20); // Digest
  131. }
  132. }
  133. /// @dev Reads a bytes32 from a bytes array without bounds checking.
  134. function _unsafeReadBytes32(bytes memory array, uint256 offset) private pure returns (bytes32 result) {
  135. // Memory safeness is guaranteed as long as the provided `array` is a Solidity-allocated bytes array
  136. // and `offset` is within bounds. This is the case for all calls to this private function from {pkcs1Sha256}.
  137. assembly ("memory-safe") {
  138. result := mload(add(add(array, 0x20), offset))
  139. }
  140. }
  141. }