Skip to content

xxhash documentation incomplete

Summary

Reproducibility Platform OS OS Version Product Version
always any any any 15.0.2

Description

User John L on the bacula users mailing list brought something up.

Under the fileset resource, the bacula main manual states that we can use signature=XXHASH but no equivalent verify option is mentioned. I did confirm that the manual currently only shows verify options for md5, sha1, sha256, and sha512.

Martin S reviewed the code and shared the following:

case '6':                 /* compare XXHASH64 */
               do_Digest = CRYPTO_DIGEST_XXHASH64;
               break;
            case '7':                 /* compare XXH3_64 */
               do_Digest = CRYPTO_DIGEST_XXH3_64;
               break;
            case '8':                 /* compare XXH3_128 */
               do_Digest = CRYPTO_DIGEST_XXH3_128;
               break;

So it seems that options 6, 7, and 8 should be usable as verify options. Additionally, while the manual only mentions signature=xxhash, there appear to actually be 3 xxhash-related signature types.

Steps to Reproduce

  1. Go to the bacula 15.0.2 manual >>> Configuring the Director >>> The Fileset Resource. (https://www.bacula.org/15.0.x-manuals/en/main/Configuring_Director.html#SECTION0023700000000000000000)
  2. Search for 'xxhash'
  3. Search for 'verify'

Suggested remediation

If there are actually 3 valid xxhash signature options, signature= entries should be defined for each in the manual.

Similarly, the verify= entry should show how to verify using available xxhash signature types.