sha256.c 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545
  1. /***************************************************************************
  2. * _ _ ____ _
  3. * Project ___| | | | _ \| |
  4. * / __| | | | |_) | |
  5. * | (__| |_| | _ <| |___
  6. * \___|\___/|_| \_\_____|
  7. *
  8. * Copyright (C) Florin Petriuc, <petriuc.florin@gmail.com>
  9. * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  10. *
  11. * This software is licensed as described in the file COPYING, which
  12. * you should have received as part of this distribution. The terms
  13. * are also available at https://curl.se/docs/copyright.html.
  14. *
  15. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  16. * copies of the Software, and permit persons to whom the Software is
  17. * furnished to do so, under the terms of the COPYING file.
  18. *
  19. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  20. * KIND, either express or implied.
  21. *
  22. * SPDX-License-Identifier: curl
  23. *
  24. ***************************************************************************/
  25. #include "curl_setup.h"
  26. #if !defined(CURL_DISABLE_AWS) || !defined(CURL_DISABLE_DIGEST_AUTH) \
  27. || defined(USE_LIBSSH2)
  28. #include "warnless.h"
  29. #include "curl_sha256.h"
  30. #include "curl_hmac.h"
  31. #ifdef USE_WOLFSSL
  32. #include <wolfssl/options.h>
  33. #ifndef NO_SHA256
  34. #define USE_OPENSSL_SHA256
  35. #endif
  36. #endif
  37. #if defined(USE_OPENSSL)
  38. #include <openssl/opensslv.h>
  39. #if (OPENSSL_VERSION_NUMBER >= 0x0090800fL)
  40. #define USE_OPENSSL_SHA256
  41. #endif
  42. #endif /* USE_OPENSSL */
  43. #ifdef USE_MBEDTLS
  44. #include <mbedtls/version.h>
  45. #if(MBEDTLS_VERSION_NUMBER >= 0x02070000) && \
  46. (MBEDTLS_VERSION_NUMBER < 0x03000000)
  47. #define HAS_MBEDTLS_RESULT_CODE_BASED_FUNCTIONS
  48. #endif
  49. #endif /* USE_MBEDTLS */
  50. #if defined(USE_OPENSSL_SHA256)
  51. /* When OpenSSL or wolfSSL is available we use their SHA256-functions. */
  52. #if defined(USE_OPENSSL)
  53. #include <openssl/evp.h>
  54. #elif defined(USE_WOLFSSL)
  55. #include <wolfssl/openssl/evp.h>
  56. #endif
  57. #elif defined(USE_GNUTLS)
  58. #include <nettle/sha.h>
  59. #elif defined(USE_MBEDTLS)
  60. #include <mbedtls/sha256.h>
  61. #elif (defined(__MAC_OS_X_VERSION_MAX_ALLOWED) && \
  62. (__MAC_OS_X_VERSION_MAX_ALLOWED >= 1040)) || \
  63. (defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && \
  64. (__IPHONE_OS_VERSION_MAX_ALLOWED >= 20000))
  65. #include <CommonCrypto/CommonDigest.h>
  66. #define AN_APPLE_OS
  67. #elif defined(USE_WIN32_CRYPTO)
  68. #include <wincrypt.h>
  69. #endif
  70. /* The last 3 #include files should be in this order */
  71. #include "curl_printf.h"
  72. #include "curl_memory.h"
  73. #include "memdebug.h"
  74. /* Please keep the SSL backend-specific #if branches in this order:
  75. *
  76. * 1. USE_OPENSSL
  77. * 2. USE_GNUTLS
  78. * 3. USE_MBEDTLS
  79. * 4. USE_COMMON_CRYPTO
  80. * 5. USE_WIN32_CRYPTO
  81. *
  82. * This ensures that the same SSL branch gets activated throughout this source
  83. * file even if multiple backends are enabled at the same time.
  84. */
  85. #if defined(USE_OPENSSL_SHA256)
  86. struct sha256_ctx {
  87. EVP_MD_CTX *openssl_ctx;
  88. };
  89. typedef struct sha256_ctx my_sha256_ctx;
  90. static CURLcode my_sha256_init(my_sha256_ctx *ctx)
  91. {
  92. ctx->openssl_ctx = EVP_MD_CTX_create();
  93. if(!ctx->openssl_ctx)
  94. return CURLE_OUT_OF_MEMORY;
  95. if(!EVP_DigestInit_ex(ctx->openssl_ctx, EVP_sha256(), NULL)) {
  96. EVP_MD_CTX_destroy(ctx->openssl_ctx);
  97. return CURLE_FAILED_INIT;
  98. }
  99. return CURLE_OK;
  100. }
  101. static void my_sha256_update(my_sha256_ctx *ctx,
  102. const unsigned char *data,
  103. unsigned int length)
  104. {
  105. EVP_DigestUpdate(ctx->openssl_ctx, data, length);
  106. }
  107. static void my_sha256_final(unsigned char *digest, my_sha256_ctx *ctx)
  108. {
  109. EVP_DigestFinal_ex(ctx->openssl_ctx, digest, NULL);
  110. EVP_MD_CTX_destroy(ctx->openssl_ctx);
  111. }
  112. #elif defined(USE_GNUTLS)
  113. typedef struct sha256_ctx my_sha256_ctx;
  114. static CURLcode my_sha256_init(my_sha256_ctx *ctx)
  115. {
  116. sha256_init(ctx);
  117. return CURLE_OK;
  118. }
  119. static void my_sha256_update(my_sha256_ctx *ctx,
  120. const unsigned char *data,
  121. unsigned int length)
  122. {
  123. sha256_update(ctx, length, data);
  124. }
  125. static void my_sha256_final(unsigned char *digest, my_sha256_ctx *ctx)
  126. {
  127. sha256_digest(ctx, SHA256_DIGEST_SIZE, digest);
  128. }
  129. #elif defined(USE_MBEDTLS)
  130. typedef mbedtls_sha256_context my_sha256_ctx;
  131. static CURLcode my_sha256_init(my_sha256_ctx *ctx)
  132. {
  133. #if !defined(HAS_MBEDTLS_RESULT_CODE_BASED_FUNCTIONS)
  134. (void) mbedtls_sha256_starts(ctx, 0);
  135. #else
  136. (void) mbedtls_sha256_starts_ret(ctx, 0);
  137. #endif
  138. return CURLE_OK;
  139. }
  140. static void my_sha256_update(my_sha256_ctx *ctx,
  141. const unsigned char *data,
  142. unsigned int length)
  143. {
  144. #if !defined(HAS_MBEDTLS_RESULT_CODE_BASED_FUNCTIONS)
  145. (void) mbedtls_sha256_update(ctx, data, length);
  146. #else
  147. (void) mbedtls_sha256_update_ret(ctx, data, length);
  148. #endif
  149. }
  150. static void my_sha256_final(unsigned char *digest, my_sha256_ctx *ctx)
  151. {
  152. #if !defined(HAS_MBEDTLS_RESULT_CODE_BASED_FUNCTIONS)
  153. (void) mbedtls_sha256_finish(ctx, digest);
  154. #else
  155. (void) mbedtls_sha256_finish_ret(ctx, digest);
  156. #endif
  157. }
  158. #elif defined(AN_APPLE_OS)
  159. typedef CC_SHA256_CTX my_sha256_ctx;
  160. static CURLcode my_sha256_init(my_sha256_ctx *ctx)
  161. {
  162. (void) CC_SHA256_Init(ctx);
  163. return CURLE_OK;
  164. }
  165. static void my_sha256_update(my_sha256_ctx *ctx,
  166. const unsigned char *data,
  167. unsigned int length)
  168. {
  169. (void) CC_SHA256_Update(ctx, data, length);
  170. }
  171. static void my_sha256_final(unsigned char *digest, my_sha256_ctx *ctx)
  172. {
  173. (void) CC_SHA256_Final(digest, ctx);
  174. }
  175. #elif defined(USE_WIN32_CRYPTO)
  176. struct sha256_ctx {
  177. HCRYPTPROV hCryptProv;
  178. HCRYPTHASH hHash;
  179. };
  180. typedef struct sha256_ctx my_sha256_ctx;
  181. #if !defined(CALG_SHA_256)
  182. #define CALG_SHA_256 0x0000800c
  183. #endif
  184. static CURLcode my_sha256_init(my_sha256_ctx *ctx)
  185. {
  186. if(!CryptAcquireContext(&ctx->hCryptProv, NULL, NULL, PROV_RSA_AES,
  187. CRYPT_VERIFYCONTEXT | CRYPT_SILENT))
  188. return CURLE_OUT_OF_MEMORY;
  189. if(!CryptCreateHash(ctx->hCryptProv, CALG_SHA_256, 0, 0, &ctx->hHash)) {
  190. CryptReleaseContext(ctx->hCryptProv, 0);
  191. ctx->hCryptProv = 0;
  192. return CURLE_FAILED_INIT;
  193. }
  194. return CURLE_OK;
  195. }
  196. static void my_sha256_update(my_sha256_ctx *ctx,
  197. const unsigned char *data,
  198. unsigned int length)
  199. {
  200. CryptHashData(ctx->hHash, (unsigned char *) data, length, 0);
  201. }
  202. static void my_sha256_final(unsigned char *digest, my_sha256_ctx *ctx)
  203. {
  204. unsigned long length = 0;
  205. CryptGetHashParam(ctx->hHash, HP_HASHVAL, NULL, &length, 0);
  206. if(length == SHA256_DIGEST_LENGTH)
  207. CryptGetHashParam(ctx->hHash, HP_HASHVAL, digest, &length, 0);
  208. if(ctx->hHash)
  209. CryptDestroyHash(ctx->hHash);
  210. if(ctx->hCryptProv)
  211. CryptReleaseContext(ctx->hCryptProv, 0);
  212. }
  213. #else
  214. /* When no other crypto library is available we use this code segment */
  215. /* This is based on SHA256 implementation in LibTomCrypt that was released into
  216. * public domain by Tom St Denis. */
  217. #define WPA_GET_BE32(a) ((((unsigned long)(a)[0]) << 24) | \
  218. (((unsigned long)(a)[1]) << 16) | \
  219. (((unsigned long)(a)[2]) << 8) | \
  220. ((unsigned long)(a)[3]))
  221. #define WPA_PUT_BE32(a, val) \
  222. do { \
  223. (a)[0] = (unsigned char)((((unsigned long) (val)) >> 24) & 0xff); \
  224. (a)[1] = (unsigned char)((((unsigned long) (val)) >> 16) & 0xff); \
  225. (a)[2] = (unsigned char)((((unsigned long) (val)) >> 8) & 0xff); \
  226. (a)[3] = (unsigned char)(((unsigned long) (val)) & 0xff); \
  227. } while(0)
  228. #ifdef HAVE_LONGLONG
  229. #define WPA_PUT_BE64(a, val) \
  230. do { \
  231. (a)[0] = (unsigned char)(((unsigned long long)(val)) >> 56); \
  232. (a)[1] = (unsigned char)(((unsigned long long)(val)) >> 48); \
  233. (a)[2] = (unsigned char)(((unsigned long long)(val)) >> 40); \
  234. (a)[3] = (unsigned char)(((unsigned long long)(val)) >> 32); \
  235. (a)[4] = (unsigned char)(((unsigned long long)(val)) >> 24); \
  236. (a)[5] = (unsigned char)(((unsigned long long)(val)) >> 16); \
  237. (a)[6] = (unsigned char)(((unsigned long long)(val)) >> 8); \
  238. (a)[7] = (unsigned char)(((unsigned long long)(val)) & 0xff); \
  239. } while(0)
  240. #else
  241. #define WPA_PUT_BE64(a, val) \
  242. do { \
  243. (a)[0] = (unsigned char)(((unsigned __int64)(val)) >> 56); \
  244. (a)[1] = (unsigned char)(((unsigned __int64)(val)) >> 48); \
  245. (a)[2] = (unsigned char)(((unsigned __int64)(val)) >> 40); \
  246. (a)[3] = (unsigned char)(((unsigned __int64)(val)) >> 32); \
  247. (a)[4] = (unsigned char)(((unsigned __int64)(val)) >> 24); \
  248. (a)[5] = (unsigned char)(((unsigned __int64)(val)) >> 16); \
  249. (a)[6] = (unsigned char)(((unsigned __int64)(val)) >> 8); \
  250. (a)[7] = (unsigned char)(((unsigned __int64)(val)) & 0xff); \
  251. } while(0)
  252. #endif
  253. struct sha256_state {
  254. #ifdef HAVE_LONGLONG
  255. unsigned long long length;
  256. #else
  257. unsigned __int64 length;
  258. #endif
  259. unsigned long state[8], curlen;
  260. unsigned char buf[64];
  261. };
  262. typedef struct sha256_state my_sha256_ctx;
  263. /* The K array */
  264. static const unsigned long K[64] = {
  265. 0x428a2f98UL, 0x71374491UL, 0xb5c0fbcfUL, 0xe9b5dba5UL, 0x3956c25bUL,
  266. 0x59f111f1UL, 0x923f82a4UL, 0xab1c5ed5UL, 0xd807aa98UL, 0x12835b01UL,
  267. 0x243185beUL, 0x550c7dc3UL, 0x72be5d74UL, 0x80deb1feUL, 0x9bdc06a7UL,
  268. 0xc19bf174UL, 0xe49b69c1UL, 0xefbe4786UL, 0x0fc19dc6UL, 0x240ca1ccUL,
  269. 0x2de92c6fUL, 0x4a7484aaUL, 0x5cb0a9dcUL, 0x76f988daUL, 0x983e5152UL,
  270. 0xa831c66dUL, 0xb00327c8UL, 0xbf597fc7UL, 0xc6e00bf3UL, 0xd5a79147UL,
  271. 0x06ca6351UL, 0x14292967UL, 0x27b70a85UL, 0x2e1b2138UL, 0x4d2c6dfcUL,
  272. 0x53380d13UL, 0x650a7354UL, 0x766a0abbUL, 0x81c2c92eUL, 0x92722c85UL,
  273. 0xa2bfe8a1UL, 0xa81a664bUL, 0xc24b8b70UL, 0xc76c51a3UL, 0xd192e819UL,
  274. 0xd6990624UL, 0xf40e3585UL, 0x106aa070UL, 0x19a4c116UL, 0x1e376c08UL,
  275. 0x2748774cUL, 0x34b0bcb5UL, 0x391c0cb3UL, 0x4ed8aa4aUL, 0x5b9cca4fUL,
  276. 0x682e6ff3UL, 0x748f82eeUL, 0x78a5636fUL, 0x84c87814UL, 0x8cc70208UL,
  277. 0x90befffaUL, 0xa4506cebUL, 0xbef9a3f7UL, 0xc67178f2UL
  278. };
  279. /* Various logical functions */
  280. #define RORc(x, y) \
  281. (((((unsigned long)(x) & 0xFFFFFFFFUL) >> (unsigned long)((y) & 31)) | \
  282. ((unsigned long)(x) << (unsigned long)(32 - ((y) & 31)))) & 0xFFFFFFFFUL)
  283. #define Sha256_Ch(x,y,z) (z ^ (x & (y ^ z)))
  284. #define Sha256_Maj(x,y,z) (((x | y) & z) | (x & y))
  285. #define Sha256_S(x, n) RORc((x), (n))
  286. #define Sha256_R(x, n) (((x)&0xFFFFFFFFUL)>>(n))
  287. #define Sigma0(x) (Sha256_S(x, 2) ^ Sha256_S(x, 13) ^ Sha256_S(x, 22))
  288. #define Sigma1(x) (Sha256_S(x, 6) ^ Sha256_S(x, 11) ^ Sha256_S(x, 25))
  289. #define Gamma0(x) (Sha256_S(x, 7) ^ Sha256_S(x, 18) ^ Sha256_R(x, 3))
  290. #define Gamma1(x) (Sha256_S(x, 17) ^ Sha256_S(x, 19) ^ Sha256_R(x, 10))
  291. /* Compress 512-bits */
  292. static int sha256_compress(struct sha256_state *md,
  293. unsigned char *buf)
  294. {
  295. unsigned long S[8], W[64];
  296. int i;
  297. /* Copy state into S */
  298. for(i = 0; i < 8; i++) {
  299. S[i] = md->state[i];
  300. }
  301. /* copy the state into 512-bits into W[0..15] */
  302. for(i = 0; i < 16; i++)
  303. W[i] = WPA_GET_BE32(buf + (4 * i));
  304. /* fill W[16..63] */
  305. for(i = 16; i < 64; i++) {
  306. W[i] = Gamma1(W[i - 2]) + W[i - 7] + Gamma0(W[i - 15]) +
  307. W[i - 16];
  308. }
  309. /* Compress */
  310. #define RND(a,b,c,d,e,f,g,h,i) \
  311. do { \
  312. unsigned long t0 = h + Sigma1(e) + Sha256_Ch(e, f, g) + K[i] + W[i]; \
  313. unsigned long t1 = Sigma0(a) + Sha256_Maj(a, b, c); \
  314. d += t0; \
  315. h = t0 + t1; \
  316. } while(0)
  317. for(i = 0; i < 64; ++i) {
  318. unsigned long t;
  319. RND(S[0], S[1], S[2], S[3], S[4], S[5], S[6], S[7], i);
  320. t = S[7]; S[7] = S[6]; S[6] = S[5]; S[5] = S[4];
  321. S[4] = S[3]; S[3] = S[2]; S[2] = S[1]; S[1] = S[0]; S[0] = t;
  322. }
  323. /* Feedback */
  324. for(i = 0; i < 8; i++) {
  325. md->state[i] = md->state[i] + S[i];
  326. }
  327. return 0;
  328. }
  329. /* Initialize the hash state */
  330. static CURLcode my_sha256_init(struct sha256_state *md)
  331. {
  332. md->curlen = 0;
  333. md->length = 0;
  334. md->state[0] = 0x6A09E667UL;
  335. md->state[1] = 0xBB67AE85UL;
  336. md->state[2] = 0x3C6EF372UL;
  337. md->state[3] = 0xA54FF53AUL;
  338. md->state[4] = 0x510E527FUL;
  339. md->state[5] = 0x9B05688CUL;
  340. md->state[6] = 0x1F83D9ABUL;
  341. md->state[7] = 0x5BE0CD19UL;
  342. return CURLE_OK;
  343. }
  344. /*
  345. Process a block of memory though the hash
  346. @param md The hash state
  347. @param in The data to hash
  348. @param inlen The length of the data (octets)
  349. @return 0 if successful
  350. */
  351. static int my_sha256_update(struct sha256_state *md,
  352. const unsigned char *in,
  353. unsigned long inlen)
  354. {
  355. unsigned long n;
  356. #define block_size 64
  357. if(md->curlen > sizeof(md->buf))
  358. return -1;
  359. while(inlen > 0) {
  360. if(md->curlen == 0 && inlen >= block_size) {
  361. if(sha256_compress(md, (unsigned char *)in) < 0)
  362. return -1;
  363. md->length += block_size * 8;
  364. in += block_size;
  365. inlen -= block_size;
  366. }
  367. else {
  368. n = CURLMIN(inlen, (block_size - md->curlen));
  369. memcpy(md->buf + md->curlen, in, n);
  370. md->curlen += n;
  371. in += n;
  372. inlen -= n;
  373. if(md->curlen == block_size) {
  374. if(sha256_compress(md, md->buf) < 0)
  375. return -1;
  376. md->length += 8 * block_size;
  377. md->curlen = 0;
  378. }
  379. }
  380. }
  381. return 0;
  382. }
  383. /*
  384. Terminate the hash to get the digest
  385. @param md The hash state
  386. @param out [out] The destination of the hash (32 bytes)
  387. @return 0 if successful
  388. */
  389. static int my_sha256_final(unsigned char *out,
  390. struct sha256_state *md)
  391. {
  392. int i;
  393. if(md->curlen >= sizeof(md->buf))
  394. return -1;
  395. /* Increase the length of the message */
  396. md->length += md->curlen * 8;
  397. /* Append the '1' bit */
  398. md->buf[md->curlen++] = (unsigned char)0x80;
  399. /* If the length is currently above 56 bytes we append zeros
  400. * then compress. Then we can fall back to padding zeros and length
  401. * encoding like normal.
  402. */
  403. if(md->curlen > 56) {
  404. while(md->curlen < 64) {
  405. md->buf[md->curlen++] = (unsigned char)0;
  406. }
  407. sha256_compress(md, md->buf);
  408. md->curlen = 0;
  409. }
  410. /* Pad up to 56 bytes of zeroes */
  411. while(md->curlen < 56) {
  412. md->buf[md->curlen++] = (unsigned char)0;
  413. }
  414. /* Store length */
  415. WPA_PUT_BE64(md->buf + 56, md->length);
  416. sha256_compress(md, md->buf);
  417. /* Copy output */
  418. for(i = 0; i < 8; i++)
  419. WPA_PUT_BE32(out + (4 * i), md->state[i]);
  420. return 0;
  421. }
  422. #endif /* CRYPTO LIBS */
  423. /*
  424. * Curl_sha256it()
  425. *
  426. * Generates a SHA256 hash for the given input data.
  427. *
  428. * Parameters:
  429. *
  430. * output [in/out] - The output buffer.
  431. * input [in] - The input data.
  432. * length [in] - The input length.
  433. *
  434. * Returns CURLE_OK on success.
  435. */
  436. CURLcode Curl_sha256it(unsigned char *output, const unsigned char *input,
  437. const size_t length)
  438. {
  439. CURLcode result;
  440. my_sha256_ctx ctx;
  441. result = my_sha256_init(&ctx);
  442. if(!result) {
  443. my_sha256_update(&ctx, input, curlx_uztoui(length));
  444. my_sha256_final(output, &ctx);
  445. }
  446. return result;
  447. }
  448. const struct HMAC_params Curl_HMAC_SHA256[] = {
  449. {
  450. /* Hash initialization function. */
  451. CURLX_FUNCTION_CAST(HMAC_hinit_func, my_sha256_init),
  452. /* Hash update function. */
  453. CURLX_FUNCTION_CAST(HMAC_hupdate_func, my_sha256_update),
  454. /* Hash computation end function. */
  455. CURLX_FUNCTION_CAST(HMAC_hfinal_func, my_sha256_final),
  456. /* Size of hash context structure. */
  457. sizeof(my_sha256_ctx),
  458. /* Maximum key length. */
  459. 64,
  460. /* Result size. */
  461. 32
  462. }
  463. };
  464. #endif /* AWS, DIGEST, or libSSH2 */