Excluding Custom Files from Suspect File Diagnostic

[Craig]

If you have custom files, you can create an md5 sums for your smilie directory if you want. Inside the /do_not_upload folder of your download package is a checksum sub-folder. That will create custom md5_sums files.

1. Copy the included sample_checksum_config.php file to smilies_config.php.
2. Enter in your forum root.
3. Give it a product id like 'smilies'.
4. Delete the existing directories and files in the scanpaths.
5. Add in '/core/images/smilies', under the directories comment.
6. Run the command php vB5Checksum.phar --config smilies_config.php --out md5_sums_smilies.php
   • Depending on location of the files and server permissions you may need to run this as SUDO.
7. Move the file to your /core/includes/ directory.

Here is an example configuration file that I created:

<?php

// Sample config file for creating checksum config.
// Run  php vB5Checksum.phar --help  for sample usage.


//    ****** REQUIRED ******

$forumroot = '/var/www/html/vbulletin5/live';
$productid = 'smilies';
/*
Contents of these directories will be added to the checksum file.
These paths must be relative to $forumroot above and must be
inside $forumroot.

Do not use directory traversals (/../) in these paths as they may
not work as expected and specified files outside of $forumroot
will not be scanned by the diagnostics tool even if listed in the
manifest.

These paths may be directories or files.
 */
$scanpaths = [
# directories
'core/images/smilies',
# single files

# don't do this. It may resolve & add entries to the manifest, but will NOT be scanned
# '../externalfolder',
];


//    ****** OPTIONAL ******

/*
If any of your custom files have a version header like "vBulletin 5.6.0"
you must specify that version here. If missing, the diagnostic tool may
show erroneous warnings like
"File version mismatch: found 5.6.0, expected "
If your files do not have a version header, you can skip this.
 */
//$version = '5.6.0';

This is the file generated:

<?php
// smilies, 09:45:44, Mon Aug 24th 2020
$md5_sums = array(
'/core/images/smilies' => array(
'biggrin.png' => 'aaabf341165fc64cc86c33aa791fc030',
'confused.png' => '6a892dc0ccc349c4653a26dcf0f2956b',
'cool.png' => 'fbfc75e899a2f973db9ec22c02090f39',
'eek.png' => '0fcb5fd47fb0c8d33dc34fb4d96f5ff6',
'frown.png' => 'ade3c5116480bd6c8f53bb7bb7acfa4e',
'index.html' => '68b329da9893e34099c7d8ad5cb9c940',
'mad.png' => '395f02aa18e8003b672e3d896b9a7d9a',
'redface.png' => '1404b771355ed12a0b58a3e7e9b13017',
'rolleyes.png' => '8a7fbb11f2b0b6b0cc45d6edea5150ab',
'smile.png' => '34fc6dc3ee0c950fd5aafc2cb4e9b695',
'tongue.png' => '28e5a34cba8989f2c726d6cee85166a5',
'wink.png' => '5a96cbfc622b34f77f6b5257dd9d300f',
),
);
$md5_sum_softwareid = 'smilies';
$md5_sum_versions['smilies'] = '';
$scanRoot = DIR . '/..';
?>

This article was copied from this discussion.

[Craig]

Does this need to be done with each update/upgrade, or just once?

[Wayne Luke]

You would have to re-run the Checksum script after you add new files to the directory. This particular application shouldn't need to rebuilt on vBulletin Upgrade though.

An example that would need to be updated after vBulletin upgrades would be creating MD5 files for /core/cache/ if you store CSS and/or Templates as files. Or if you delete the contents of these folders and recreated them for any reason.

If you built a file for /core/customavatars, you would probably need to update that periodically. Though, I believe there is an improvement request to skip this directory and prompt for manual inspection. Since it should only contain images, it should be easy to find problematic files here.

[Craig]

Thanks, Wayne.