checksum.c

   1 /*
   2  * Routines to support checksumming of bytes.
   3  *
   4  * Copyright (C) 1996 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2004-2023 Wayne Davison
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * In addition, as a special exception, the copyright holders give
  14  * permission to dynamically link rsync with the OpenSSL and xxhash
  15  * libraries when those libraries are being distributed in compliance
  16  * with their license terms, and to distribute a dynamically linked
  17  * combination of rsync and these libraries.  This is also considered
  18  * to be covered under the GPL's System Libraries exception.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License along
  26  * with this program; if not, visit the http://fsf.org website.
  27  */
  28
  29 #include "rsync.h"
  30
  31 #ifdef SUPPORT_XXHASH
  32 #include <xxhash.h>
  33 # if XXH_VERSION_NUMBER >= 800
  34 #  define SUPPORT_XXH3 1
  35 # endif
  36 #endif
  37
  38 extern int am_server;
  39 extern int whole_file;
  40 extern int checksum_seed;
  41 extern int protocol_version;
  42 extern int proper_seed_order;
  43 extern const char *checksum_choice;
  44
  45 #define NNI_BUILTIN (1<<0)
  46 #define NNI_EVP (1<<1)
  47 #define NNI_EVP_OK (1<<2)
  48
  49 struct name_num_item valid_checksums_items[] = {
  50 #ifdef SUPPORT_XXH3
  51         { CSUM_XXH3_128, 0, "xxh128", NULL },
  52         { CSUM_XXH3_64, 0, "xxh3", NULL },
  53 #endif
  54 #ifdef SUPPORT_XXHASH
  55         { CSUM_XXH64, 0, "xxh64", NULL },
  56         { CSUM_XXH64, 0, "xxhash", NULL },
  57 #endif
  58         { CSUM_MD5, NNI_BUILTIN|NNI_EVP, "md5", NULL },
  59         { CSUM_MD4, NNI_BUILTIN|NNI_EVP, "md4", NULL },
  60 #ifdef SHA_DIGEST_LENGTH
  61         { CSUM_SHA1, NNI_EVP, "sha1", NULL },
  62 #endif
  63         { CSUM_NONE, 0, "none", NULL },
  64         { 0, 0, NULL, NULL }
  65 };
  66
  67 struct name_num_obj valid_checksums = {
  68         "checksum", NULL, 0, 0, valid_checksums_items
  69 };
  70
  71 struct name_num_item valid_auth_checksums_items[] = {
  72 #ifdef SHA512_DIGEST_LENGTH
  73         { CSUM_SHA512, NNI_EVP, "sha512", NULL },
  74 #endif
  75 #ifdef SHA256_DIGEST_LENGTH
  76         { CSUM_SHA256, NNI_EVP, "sha256", NULL },
  77 #endif
  78 #ifdef SHA_DIGEST_LENGTH
  79         { CSUM_SHA1, NNI_EVP, "sha1", NULL },
  80 #endif
  81         { CSUM_MD5, NNI_BUILTIN|NNI_EVP, "md5", NULL },
  82         { CSUM_MD4, NNI_BUILTIN|NNI_EVP, "md4", NULL },
  83         { 0, 0, NULL, NULL }
  84 };
  85
  86 struct name_num_obj valid_auth_checksums = {
  87         "daemon auth checksum", NULL, 0, 0, valid_auth_checksums_items
  88 };
  89
  90 /* These cannot make use of openssl, so they're marked just as built-in */
  91 struct name_num_item implied_checksum_md4 =
  92     { CSUM_MD4, NNI_BUILTIN, "md4", NULL };
  93 struct name_num_item implied_checksum_md5 =
  94     { CSUM_MD5, NNI_BUILTIN, "md5", NULL };
  95
  96 struct name_num_item *xfer_sum_nni; /* used for the transfer checksum2 computations */
  97 int xfer_sum_len;
  98 struct name_num_item *file_sum_nni; /* used for the pre-transfer --checksum computations */
  99 int file_sum_len, file_sum_extra_cnt;
 100
 101 #ifdef USE_OPENSSL
 102 const EVP_MD *xfer_sum_evp_md;
 103 const EVP_MD *file_sum_evp_md;
 104 EVP_MD_CTX *ctx_evp = NULL;
 105 #endif
 106
 107 static int initialized_choices = 0;
 108
 109 struct name_num_item *parse_csum_name(const char *name, int len)
 110 {
 111         struct name_num_item *nni;
 112
 113         if (len < 0 && name)
 114                 len = strlen(name);
 115
 116         init_checksum_choices();
 117
 118         if (!name || (len == 4 && strncasecmp(name, "auto", 4) == 0)) {
 119                 if (protocol_version >= 30) {
 120                         if (!proper_seed_order)
 121                                 return &implied_checksum_md5;
 122                         name = "md5";
 123                         len = 3;
 124                 } else {
 125                         if (protocol_version >= 27)
 126                                 implied_checksum_md4.num = CSUM_MD4_OLD;
 127                         else if (protocol_version >= 21)
 128                                 implied_checksum_md4.num = CSUM_MD4_BUSTED;
 129                         else
 130                                 implied_checksum_md4.num = CSUM_MD4_ARCHAIC;
 131                         return &implied_checksum_md4;
 132                 }
 133         }
 134
 135         nni = get_nni_by_name(&valid_checksums, name, len);
 136
 137         if (!nni) {
 138                 rprintf(FERROR, "unknown checksum name: %s\n", name);
 139                 exit_cleanup(RERR_UNSUPPORTED);
 140         }
 141
 142         return nni;
 143 }
 144
 145 #ifdef USE_OPENSSL
 146 static const EVP_MD *csum_evp_md(struct name_num_item *nni)
 147 {
 148         const EVP_MD *emd;
 149         if (!(nni->flags & NNI_EVP))
 150                 return NULL;
 151
 152 #ifdef USE_MD5_ASM
 153         if (nni->num == CSUM_MD5)
 154                 emd = NULL;
 155         else
 156 #endif
 157                 emd = EVP_get_digestbyname(nni->name);
 158         if (emd && !(nni->flags & NNI_EVP_OK)) { /* Make sure it works before we advertise it */
 159                 if (!ctx_evp && !(ctx_evp = EVP_MD_CTX_create()))
 160                         out_of_memory("csum_evp_md");
 161                 /* Some routines are marked as legacy and are not enabled in the openssl.cnf file.
 162                  * If we can't init the emd, we'll fall back to our built-in code. */
 163                 if (EVP_DigestInit_ex(ctx_evp, emd, NULL) == 0)
 164                         emd = NULL;
 165                 else
 166                         nni->flags = (nni->flags & ~NNI_BUILTIN) | NNI_EVP_OK;
 167         }
 168         if (!emd)
 169                 nni->flags &= ~NNI_EVP;
 170         return emd;
 171 }
 172 #endif
 173
 174 void parse_checksum_choice(int final_call)
 175 {
 176         if (valid_checksums.negotiated_nni)
 177                 xfer_sum_nni = file_sum_nni = valid_checksums.negotiated_nni;
 178         else {
 179                 char *cp = checksum_choice ? strchr(checksum_choice, ',') : NULL;
 180                 if (cp) {
 181                         xfer_sum_nni = parse_csum_name(checksum_choice, cp - checksum_choice);
 182                         file_sum_nni = parse_csum_name(cp+1, -1);
 183                 } else
 184                         xfer_sum_nni = file_sum_nni = parse_csum_name(checksum_choice, -1);
 185                 if (am_server && checksum_choice)
 186                         validate_choice_vs_env(NSTR_CHECKSUM, xfer_sum_nni->num, file_sum_nni->num);
 187         }
 188         xfer_sum_len = csum_len_for_type(xfer_sum_nni->num, 0);
 189         file_sum_len = csum_len_for_type(file_sum_nni->num, 0);
 190 #ifdef USE_OPENSSL
 191         xfer_sum_evp_md = csum_evp_md(xfer_sum_nni);
 192         file_sum_evp_md = csum_evp_md(file_sum_nni);
 193 #endif
 194
 195         file_sum_extra_cnt = (file_sum_len + EXTRA_LEN - 1) / EXTRA_LEN;
 196
 197         if (xfer_sum_nni->num == CSUM_NONE)
 198                 whole_file = 1;
 199
 200         /* Snag the checksum name for both write_batch's option output & the following debug output. */
 201         if (valid_checksums.negotiated_nni)
 202                 checksum_choice = valid_checksums.negotiated_nni->name;
 203         else if (checksum_choice == NULL)
 204                 checksum_choice = xfer_sum_nni->name;
 205
 206         if (final_call && DEBUG_GTE(NSTR, am_server ? 3 : 1)) {
 207                 rprintf(FINFO, "%s%s checksum: %s\n",
 208                         am_server ? "Server" : "Client",
 209                         valid_checksums.negotiated_nni ? " negotiated" : "",
 210                         checksum_choice);
 211         }
 212 }
 213
 214 int csum_len_for_type(int cst, BOOL flist_csum)
 215 {
 216         switch (cst) {
 217           case CSUM_NONE:
 218                 return 1;
 219           case CSUM_MD4_ARCHAIC:
 220                 /* The oldest checksum code is rather weird: the file-list code only sent
 221                  * 2-byte checksums, but all other checksums were full MD4 length. */
 222                 return flist_csum ? 2 : MD4_DIGEST_LEN;
 223           case CSUM_MD4:
 224           case CSUM_MD4_OLD:
 225           case CSUM_MD4_BUSTED:
 226                 return MD4_DIGEST_LEN;
 227           case CSUM_MD5:
 228                 return MD5_DIGEST_LEN;
 229 #ifdef SHA_DIGEST_LENGTH
 230           case CSUM_SHA1:
 231                 return SHA_DIGEST_LENGTH;
 232 #endif
 233 #ifdef SHA256_DIGEST_LENGTH
 234           case CSUM_SHA256:
 235                 return SHA256_DIGEST_LENGTH;
 236 #endif
 237 #ifdef SHA512_DIGEST_LENGTH
 238           case CSUM_SHA512:
 239                 return SHA512_DIGEST_LENGTH;
 240 #endif
 241           case CSUM_XXH64:
 242           case CSUM_XXH3_64:
 243                 return 64/8;
 244           case CSUM_XXH3_128:
 245                 return 128/8;
 246           default: /* paranoia to prevent missing case values */
 247                 exit_cleanup(RERR_UNSUPPORTED);
 248         }
 249         return 0;
 250 }
 251
 252 /* Returns 0 if the checksum is not canonical (i.e. it includes a seed value).
 253  * Returns 1 if the public sum order matches our internal sum order.
 254  * Returns -1 if the public sum order is the reverse of our internal sum order.
 255  */
 256 int canonical_checksum(int csum_type)
 257 {
 258         switch (csum_type) {
 259           case CSUM_NONE:
 260           case CSUM_MD4_ARCHAIC:
 261           case CSUM_MD4_OLD:
 262           case CSUM_MD4_BUSTED:
 263                 break;
 264           case CSUM_MD4:
 265           case CSUM_MD5:
 266           case CSUM_SHA1:
 267           case CSUM_SHA256:
 268           case CSUM_SHA512:
 269                 return -1;
 270           case CSUM_XXH64:
 271           case CSUM_XXH3_64:
 272           case CSUM_XXH3_128:
 273                 return 1;
 274           default: /* paranoia to prevent missing case values */
 275                 exit_cleanup(RERR_UNSUPPORTED);
 276         }
 277         return 0;
 278 }
 279
 280 #ifndef USE_ROLL_SIMD /* See simd-checksum-*.cpp. */
 281 /*
 282   a simple 32 bit checksum that can be updated from either end
 283   (inspired by Mark Adler's Adler-32 checksum)
 284   */
 285 uint32 get_checksum1(char *buf1, int32 len)
 286 {
 287         int32 i;
 288         uint32 s1, s2;
 289         schar *buf = (schar *)buf1;
 290
 291         s1 = s2 = 0;
 292         for (i = 0; i < (len-4); i+=4) {
 293                 s2 += 4*(s1 + buf[i]) + 3*buf[i+1] + 2*buf[i+2] + buf[i+3] + 10*CHAR_OFFSET;
 294                 s1 += (buf[i+0] + buf[i+1] + buf[i+2] + buf[i+3] + 4*CHAR_OFFSET);
 295         }
 296         for (; i < len; i++) {
 297                 s1 += (buf[i]+CHAR_OFFSET); s2 += s1;
 298         }
 299         return (s1 & 0xffff) + (s2 << 16);
 300 }
 301 #endif
 302
 303 /* The "sum" buffer must be at least MAX_DIGEST_LEN bytes! */
 304 void get_checksum2(char *buf, int32 len, char *sum)
 305 {
 306 #ifdef USE_OPENSSL
 307         if (xfer_sum_evp_md) {
 308                 static EVP_MD_CTX *evp = NULL;
 309                 uchar seedbuf[4];
 310                 if (!evp && !(evp = EVP_MD_CTX_create()))
 311                         out_of_memory("get_checksum2");
 312                 EVP_DigestInit_ex(evp, xfer_sum_evp_md, NULL);
 313                 if (checksum_seed) {
 314                         SIVALu(seedbuf, 0, checksum_seed);
 315                         EVP_DigestUpdate(evp, seedbuf, 4);
 316                 }
 317                 EVP_DigestUpdate(evp, (uchar *)buf, len);
 318                 EVP_DigestFinal_ex(evp, (uchar *)sum, NULL);
 319         } else
 320 #endif
 321         switch (xfer_sum_nni->num) {
 322 #ifdef SUPPORT_XXHASH
 323           case CSUM_XXH64:
 324                 SIVAL64(sum, 0, XXH64(buf, len, checksum_seed));
 325                 break;
 326 #endif
 327 #ifdef SUPPORT_XXH3
 328           case CSUM_XXH3_64:
 329                 SIVAL64(sum, 0, XXH3_64bits_withSeed(buf, len, checksum_seed));
 330                 break;
 331           case CSUM_XXH3_128: {
 332                 XXH128_hash_t digest = XXH3_128bits_withSeed(buf, len, checksum_seed);
 333                 SIVAL64(sum, 0, digest.low64);
 334                 SIVAL64(sum, 8, digest.high64);
 335                 break;
 336           }
 337 #endif
 338           case CSUM_MD5: {
 339                 md_context m5;
 340                 uchar seedbuf[4];
 341                 md5_begin(&m5);
 342                 if (proper_seed_order) {
 343                         if (checksum_seed) {
 344                                 SIVALu(seedbuf, 0, checksum_seed);
 345                                 md5_update(&m5, seedbuf, 4);
 346                         }
 347                         md5_update(&m5, (uchar *)buf, len);
 348                 } else {
 349                         md5_update(&m5, (uchar *)buf, len);
 350                         if (checksum_seed) {
 351                                 SIVALu(seedbuf, 0, checksum_seed);
 352                                 md5_update(&m5, seedbuf, 4);
 353                         }
 354                 }
 355                 md5_result(&m5, (uchar *)sum);
 356                 break;
 357           }
 358           case CSUM_MD4:
 359           case CSUM_MD4_OLD:
 360           case CSUM_MD4_BUSTED:
 361           case CSUM_MD4_ARCHAIC: {
 362                 md_context m;
 363                 int32 i;
 364                 static char *buf1;
 365                 static int32 len1;
 366
 367                 mdfour_begin(&m);
 368
 369                 if (len > len1) {
 370                         if (buf1)
 371                                 free(buf1);
 372                         buf1 = new_array(char, len+4);
 373                         len1 = len;
 374                 }
 375
 376                 memcpy(buf1, buf, len);
 377                 if (checksum_seed) {
 378                         SIVAL(buf1,len,checksum_seed);
 379                         len += 4;
 380                 }
 381
 382                 for (i = 0; i + CSUM_CHUNK <= len; i += CSUM_CHUNK)
 383                         mdfour_update(&m, (uchar *)(buf1+i), CSUM_CHUNK);
 384
 385                 /*
 386                  * Prior to version 27 an incorrect MD4 checksum was computed
 387                  * by failing to call mdfour_tail() for block sizes that
 388                  * are multiples of 64.  This is fixed by calling mdfour_update()
 389                  * even when there are no more bytes.
 390                  */
 391                 if (len - i > 0 || xfer_sum_nni->num > CSUM_MD4_BUSTED)
 392                         mdfour_update(&m, (uchar *)(buf1+i), len-i);
 393
 394                 mdfour_result(&m, (uchar *)sum);
 395                 break;
 396           }
 397           default: /* paranoia to prevent missing case values */
 398                 exit_cleanup(RERR_UNSUPPORTED);
 399         }
 400 }
 401
 402 void file_checksum(const char *fname, const STRUCT_STAT *st_p, char *sum)
 403 {
 404         struct map_struct *buf;
 405         OFF_T i, len = st_p->st_size;
 406         int32 remainder;
 407         int fd;
 408
 409         fd = do_open(fname, O_RDONLY, 0);
 410         if (fd == -1) {
 411                 memset(sum, 0, file_sum_len);
 412                 return;
 413         }
 414
 415         buf = map_file(fd, len, MAX_MAP_SIZE, CHUNK_SIZE);
 416
 417 #ifdef USE_OPENSSL
 418         if (file_sum_evp_md) {
 419                 static EVP_MD_CTX *evp = NULL;
 420                 if (!evp && !(evp = EVP_MD_CTX_create()))
 421                         out_of_memory("file_checksum");
 422
 423                 EVP_DigestInit_ex(evp, file_sum_evp_md, NULL);
 424
 425                 for (i = 0; i + CHUNK_SIZE <= len; i += CHUNK_SIZE)
 426                         EVP_DigestUpdate(evp, (uchar *)map_ptr(buf, i, CHUNK_SIZE), CHUNK_SIZE);
 427
 428                 remainder = (int32)(len - i);
 429                 if (remainder > 0)
 430                         EVP_DigestUpdate(evp, (uchar *)map_ptr(buf, i, remainder), remainder);
 431
 432                 EVP_DigestFinal_ex(evp, (uchar *)sum, NULL);
 433         } else
 434 #endif
 435         switch (file_sum_nni->num) {
 436 #ifdef SUPPORT_XXHASH
 437           case CSUM_XXH64: {
 438                 static XXH64_state_t* state = NULL;
 439                 if (!state && !(state = XXH64_createState()))
 440                         out_of_memory("file_checksum");
 441
 442                 XXH64_reset(state, 0);
 443
 444                 for (i = 0; i + CHUNK_SIZE <= len; i += CHUNK_SIZE)
 445                         XXH64_update(state, (uchar *)map_ptr(buf, i, CHUNK_SIZE), CHUNK_SIZE);
 446
 447                 remainder = (int32)(len - i);
 448                 if (remainder > 0)
 449                         XXH64_update(state, (uchar *)map_ptr(buf, i, remainder), remainder);
 450
 451                 SIVAL64(sum, 0, XXH64_digest(state));
 452                 break;
 453           }
 454 #endif
 455 #ifdef SUPPORT_XXH3
 456           case CSUM_XXH3_64: {
 457                 static XXH3_state_t* state = NULL;
 458                 if (!state && !(state = XXH3_createState()))
 459                         out_of_memory("file_checksum");
 460
 461                 XXH3_64bits_reset(state);
 462
 463                 for (i = 0; i + CHUNK_SIZE <= len; i += CHUNK_SIZE)
 464                         XXH3_64bits_update(state, (uchar *)map_ptr(buf, i, CHUNK_SIZE), CHUNK_SIZE);
 465
 466                 remainder = (int32)(len - i);
 467                 if (remainder > 0)
 468                         XXH3_64bits_update(state, (uchar *)map_ptr(buf, i, remainder), remainder);
 469
 470                 SIVAL64(sum, 0, XXH3_64bits_digest(state));
 471                 break;
 472           }
 473           case CSUM_XXH3_128: {
 474                 XXH128_hash_t digest;
 475                 static XXH3_state_t* state = NULL;
 476                 if (!state && !(state = XXH3_createState()))
 477                         out_of_memory("file_checksum");
 478
 479                 XXH3_128bits_reset(state);
 480
 481                 for (i = 0; i + CHUNK_SIZE <= len; i += CHUNK_SIZE)
 482                         XXH3_128bits_update(state, (uchar *)map_ptr(buf, i, CHUNK_SIZE), CHUNK_SIZE);
 483
 484                 remainder = (int32)(len - i);
 485                 if (remainder > 0)
 486                         XXH3_128bits_update(state, (uchar *)map_ptr(buf, i, remainder), remainder);
 487
 488                 digest = XXH3_128bits_digest(state);
 489                 SIVAL64(sum, 0, digest.low64);
 490                 SIVAL64(sum, 8, digest.high64);
 491                 break;
 492           }
 493 #endif
 494           case CSUM_MD5: {
 495                 md_context m5;
 496
 497                 md5_begin(&m5);
 498
 499                 for (i = 0; i + CHUNK_SIZE <= len; i += CHUNK_SIZE)
 500                         md5_update(&m5, (uchar *)map_ptr(buf, i, CHUNK_SIZE), CHUNK_SIZE);
 501
 502                 remainder = (int32)(len - i);
 503                 if (remainder > 0)
 504                         md5_update(&m5, (uchar *)map_ptr(buf, i, remainder), remainder);
 505
 506                 md5_result(&m5, (uchar *)sum);
 507                 break;
 508           }
 509           case CSUM_MD4:
 510           case CSUM_MD4_OLD:
 511           case CSUM_MD4_BUSTED:
 512           case CSUM_MD4_ARCHAIC: {
 513                 md_context m;
 514
 515                 mdfour_begin(&m);
 516
 517                 for (i = 0; i + CSUM_CHUNK <= len; i += CSUM_CHUNK)
 518                         mdfour_update(&m, (uchar *)map_ptr(buf, i, CSUM_CHUNK), CSUM_CHUNK);
 519
 520                 /* Prior to version 27 an incorrect MD4 checksum was computed
 521                  * by failing to call mdfour_tail() for block sizes that
 522                  * are multiples of 64.  This is fixed by calling mdfour_update()
 523                  * even when there are no more bytes. */
 524                 remainder = (int32)(len - i);
 525                 if (remainder > 0 || file_sum_nni->num > CSUM_MD4_BUSTED)
 526                         mdfour_update(&m, (uchar *)map_ptr(buf, i, remainder), remainder);
 527
 528                 mdfour_result(&m, (uchar *)sum);
 529                 break;
 530           }
 531           default:
 532                 rprintf(FERROR, "Invalid checksum-choice for --checksum: %s (%d)\n",
 533                         file_sum_nni->name, file_sum_nni->num);
 534                 exit_cleanup(RERR_UNSUPPORTED);
 535         }
 536
 537         close(fd);
 538         unmap_file(buf);
 539 }
 540
 541 static int32 sumresidue;
 542 static md_context ctx_md;
 543 #ifdef SUPPORT_XXHASH
 544 static XXH64_state_t* xxh64_state;
 545 #endif
 546 #ifdef SUPPORT_XXH3
 547 static XXH3_state_t* xxh3_state;
 548 #endif
 549 static struct name_num_item *cur_sum_nni;
 550 int cur_sum_len;
 551
 552 #ifdef USE_OPENSSL
 553 static const EVP_MD *cur_sum_evp_md;
 554 #endif
 555
 556 /* Initialize a hash digest accumulator.  Data is supplied via
 557  * sum_update() and the resulting binary digest is retrieved via
 558  * sum_end().  This only supports one active sum at a time. */
 559 int sum_init(struct name_num_item *nni, int seed)
 560 {
 561         char s[4];
 562
 563         if (!nni)
 564                 nni = parse_csum_name(NULL, 0);
 565         cur_sum_nni = nni;
 566         cur_sum_len = csum_len_for_type(nni->num, 0);
 567 #ifdef USE_OPENSSL
 568         cur_sum_evp_md = csum_evp_md(nni);
 569 #endif
 570
 571 #ifdef USE_OPENSSL
 572         if (cur_sum_evp_md) {
 573                 if (!ctx_evp && !(ctx_evp = EVP_MD_CTX_create()))
 574                         out_of_memory("file_checksum");
 575                 EVP_DigestInit_ex(ctx_evp, cur_sum_evp_md, NULL);
 576         } else
 577 #endif
 578         switch (cur_sum_nni->num) {
 579 #ifdef SUPPORT_XXHASH
 580           case CSUM_XXH64:
 581                 if (!xxh64_state && !(xxh64_state = XXH64_createState()))
 582                         out_of_memory("sum_init");
 583                 XXH64_reset(xxh64_state, 0);
 584                 break;
 585 #endif
 586 #ifdef SUPPORT_XXH3
 587           case CSUM_XXH3_64:
 588                 if (!xxh3_state && !(xxh3_state = XXH3_createState()))
 589                         out_of_memory("sum_init");
 590                 XXH3_64bits_reset(xxh3_state);
 591                 break;
 592           case CSUM_XXH3_128:
 593                 if (!xxh3_state && !(xxh3_state = XXH3_createState()))
 594                         out_of_memory("sum_init");
 595                 XXH3_128bits_reset(xxh3_state);
 596                 break;
 597 #endif
 598           case CSUM_MD5:
 599                 md5_begin(&ctx_md);
 600                 break;
 601           case CSUM_MD4:
 602                 mdfour_begin(&ctx_md);
 603                 sumresidue = 0;
 604                 break;
 605           case CSUM_MD4_OLD:
 606           case CSUM_MD4_BUSTED:
 607           case CSUM_MD4_ARCHAIC:
 608                 mdfour_begin(&ctx_md);
 609                 sumresidue = 0;
 610                 SIVAL(s, 0, seed);
 611                 sum_update(s, 4);
 612                 break;
 613           case CSUM_NONE:
 614                 break;
 615           default: /* paranoia to prevent missing case values */
 616                 exit_cleanup(RERR_UNSUPPORTED);
 617         }
 618
 619         return cur_sum_len;
 620 }
 621
 622 /* Feed data into a hash digest accumulator. */
 623 void sum_update(const char *p, int32 len)
 624 {
 625 #ifdef USE_OPENSSL
 626         if (cur_sum_evp_md) {
 627                 EVP_DigestUpdate(ctx_evp, (uchar *)p, len);
 628         } else
 629 #endif
 630         switch (cur_sum_nni->num) {
 631 #ifdef SUPPORT_XXHASH
 632           case CSUM_XXH64:
 633                 XXH64_update(xxh64_state, p, len);
 634                 break;
 635 #endif
 636 #ifdef SUPPORT_XXH3
 637           case CSUM_XXH3_64:
 638                 XXH3_64bits_update(xxh3_state, p, len);
 639                 break;
 640           case CSUM_XXH3_128:
 641                 XXH3_128bits_update(xxh3_state, p, len);
 642                 break;
 643 #endif
 644           case CSUM_MD5:
 645                 md5_update(&ctx_md, (uchar *)p, len);
 646                 break;
 647           case CSUM_MD4:
 648           case CSUM_MD4_OLD:
 649           case CSUM_MD4_BUSTED:
 650           case CSUM_MD4_ARCHAIC:
 651                 if (len + sumresidue < CSUM_CHUNK) {
 652                         memcpy(ctx_md.buffer + sumresidue, p, len);
 653                         sumresidue += len;
 654                         break;
 655                 }
 656
 657                 if (sumresidue) {
 658                         int32 i = CSUM_CHUNK - sumresidue;
 659                         memcpy(ctx_md.buffer + sumresidue, p, i);
 660                         mdfour_update(&ctx_md, (uchar *)ctx_md.buffer, CSUM_CHUNK);
 661                         len -= i;
 662                         p += i;
 663                 }
 664
 665                 while (len >= CSUM_CHUNK) {
 666                         mdfour_update(&ctx_md, (uchar *)p, CSUM_CHUNK);
 667                         len -= CSUM_CHUNK;
 668                         p += CSUM_CHUNK;
 669                 }
 670
 671                 sumresidue = len;
 672                 if (sumresidue)
 673                         memcpy(ctx_md.buffer, p, sumresidue);
 674                 break;
 675           case CSUM_NONE:
 676                 break;
 677           default: /* paranoia to prevent missing case values */
 678                 exit_cleanup(RERR_UNSUPPORTED);
 679         }
 680 }
 681
 682 /* The sum buffer only needs to be as long as the current checksum's digest
 683  * len, not MAX_DIGEST_LEN. Note that for CSUM_MD4_ARCHAIC that is the full
 684  * MD4_DIGEST_LEN even if the file-list code is going to ignore all but the
 685  * first 2 bytes of it. */
 686 void sum_end(char *sum)
 687 {
 688 #ifdef USE_OPENSSL
 689         if (cur_sum_evp_md) {
 690                 EVP_DigestFinal_ex(ctx_evp, (uchar *)sum, NULL);
 691         } else
 692 #endif
 693         switch (cur_sum_nni->num) {
 694 #ifdef SUPPORT_XXHASH
 695           case CSUM_XXH64:
 696                 SIVAL64(sum, 0, XXH64_digest(xxh64_state));
 697                 break;
 698 #endif
 699 #ifdef SUPPORT_XXH3
 700           case CSUM_XXH3_64:
 701                 SIVAL64(sum, 0, XXH3_64bits_digest(xxh3_state));
 702                 break;
 703           case CSUM_XXH3_128: {
 704                 XXH128_hash_t digest = XXH3_128bits_digest(xxh3_state);
 705                 SIVAL64(sum, 0, digest.low64);
 706                 SIVAL64(sum, 8, digest.high64);
 707                 break;
 708           }
 709 #endif
 710           case CSUM_MD5:
 711                 md5_result(&ctx_md, (uchar *)sum);
 712                 break;
 713           case CSUM_MD4:
 714           case CSUM_MD4_OLD:
 715                 mdfour_update(&ctx_md, (uchar *)ctx_md.buffer, sumresidue);
 716                 mdfour_result(&ctx_md, (uchar *)sum);
 717                 break;
 718           case CSUM_MD4_BUSTED:
 719           case CSUM_MD4_ARCHAIC:
 720                 if (sumresidue)
 721                         mdfour_update(&ctx_md, (uchar *)ctx_md.buffer, sumresidue);
 722                 mdfour_result(&ctx_md, (uchar *)sum);
 723                 break;
 724           case CSUM_NONE:
 725                 *sum = '\0';
 726                 break;
 727           default: /* paranoia to prevent missing case values */
 728                 exit_cleanup(RERR_UNSUPPORTED);
 729         }
 730 }
 731
 732 #if defined SUPPORT_XXH3 || defined USE_OPENSSL
 733 static void verify_digest(struct name_num_item *nni, BOOL check_auth_list)
 734 {
 735 #ifdef SUPPORT_XXH3
 736         static int xxh3_result = 0;
 737 #endif
 738 #ifdef USE_OPENSSL
 739         static int prior_num = 0, prior_flags = 0, prior_result = 0;
 740 #endif
 741
 742 #ifdef SUPPORT_XXH3
 743         if (nni->num == CSUM_XXH3_64 || nni->num == CSUM_XXH3_128) {
 744                 if (!xxh3_result) {
 745                         char buf[32816];
 746                         int j;
 747                         for (j = 0; j < (int)sizeof buf; j++)
 748                                 buf[j] = ' ' + (j % 96);
 749                         sum_init(nni, 0);
 750                         sum_update(buf, 32816);
 751                         sum_update(buf, 31152);
 752                         sum_update(buf, 32474);
 753                         sum_update(buf, 9322);
 754                         xxh3_result = XXH3_64bits_digest(xxh3_state) != 0xadbcf16d4678d1de ? -1 : 1;
 755                 }
 756                 if (xxh3_result < 0)
 757                         nni->num = CSUM_gone;
 758                 return;
 759         }
 760 #endif
 761
 762 #ifdef USE_OPENSSL
 763         if (BITS_SETnUNSET(nni->flags, NNI_EVP, NNI_BUILTIN|NNI_EVP_OK)) {
 764                 if (nni->num == prior_num && nni->flags == prior_flags) {
 765                         nni->flags = prior_result;
 766                         if (!(nni->flags & NNI_EVP))
 767                                 nni->num = CSUM_gone;
 768                 } else {
 769                         prior_num = nni->num;
 770                         prior_flags = nni->flags;
 771                         if (!csum_evp_md(nni))
 772                                 nni->num = CSUM_gone;
 773                         prior_result = nni->flags;
 774                         if (check_auth_list && (nni = get_nni_by_num(&valid_auth_checksums, prior_num)) != NULL)
 775                                 verify_digest(nni, False);
 776                 }
 777         }
 778 #endif
 779 }
 780 #endif
 781
 782 void init_checksum_choices()
 783 {
 784 #if defined SUPPORT_XXH3 || defined USE_OPENSSL
 785         struct name_num_item *nni;
 786 #endif
 787
 788         if (initialized_choices)
 789                 return;
 790
 791 #if defined USE_OPENSSL && OPENSSL_VERSION_NUMBER < 0x10100000L
 792         OpenSSL_add_all_algorithms();
 793 #endif
 794
 795 #if defined SUPPORT_XXH3 || defined USE_OPENSSL
 796         for (nni = valid_checksums.list; nni->name; nni++)
 797                 verify_digest(nni, True);
 798
 799         for (nni = valid_auth_checksums.list; nni->name; nni++)
 800                 verify_digest(nni, False);
 801 #endif
 802
 803         initialized_choices = 1;
 804 }