FM / scripts

/usr/local/cpanel/scripts

Name	Size	Mode	Actions
cpan_sandbox/	-	0755	rm
php_sandbox/	-	0755	rm
activesync-invite-reply	1734	0755	edit dl rm
adddns	2418	0755	edit dl rm
addpop	6228	0755	edit dl rm
addsystemuser	3345	0755	edit dl rm
adduser	92	0755	edit dl rm
add_dns	2418	0755	edit dl rm
agent360.sh	16410	0700	edit dl rm
apachelimits	4410	0755	edit dl rm
archive_sync_zones	3122	0755	edit dl rm
auto-adjust-mysql-limits	1854	0755	edit dl rm
autorepair	1274	0755	edit dl rm
backups_clean_metadata_for_missing_backups	1612	0755	edit dl rm
backups_create_metadata	16126	0755	edit dl rm
backups_list_user_files	4671	0755	edit dl rm
backup_jobs_helper	11139	0755	edit dl rm
balance_linked_node_quotas	2643	0755	edit dl rm
biglogcheck	1729	0755	edit dl rm
builddovecotconf	9869	0755	edit dl rm
buildeximconf	7167	0755	edit dl rm
buildhttpdconf	2664	0755	edit dl rm
buildpureftproot	539	0755	edit dl rm
build_bandwidthdb_root_cache_in_background	1561	0755	edit dl rm
build_cpnat	3494	0755	edit dl rm
build_mail_sni	3966	0755	edit dl rm
build_maxemails_config	1169	0755	edit dl rm
call_pkgacct	2306	0755	edit dl rm
ccs-check	5031	0755	edit dl rm
checkalldomainsmxs	2462	0755	edit dl rm
checkbashshell	1205	0755	edit dl rm
checkccompiler	1253	0755	edit dl rm
checkexim.pl	3172	0755	edit dl rm
checklink	1323	0755	edit dl rm
checkusers	856	0755	edit dl rm
check_cpanel_pkgs	10856	0755	edit dl rm
check_domain_tls_service_domains.pl	6841	0755	edit dl rm
check_immutable_files	5621	0755	edit dl rm
check_mail_spamassassin_compiledregexps_body_0	187	0755	edit dl rm
check_maxmem_against_domains_count	3652	0755	edit dl rm
check_mount_procfs	2072	0755	edit dl rm
check_mysql	5697	0755	edit dl rm
check_plugin_pkgs	2512	0755	edit dl rm
check_security_advice_changes	8477	0755	edit dl rm
check_unmonitored_enabled_services	4666	0755	edit dl rm
check_unreliable_resolvers	3672	0755	edit dl rm
check_users_my_cnf	6191	0755	edit dl rm
check_valid_server_hostname	7840	0755	edit dl rm
chkpaths	141	0755	edit dl rm
chpass	416	0755	edit dl rm
ckillall	1139	0755	edit dl rm
cleandns	13429	0755	edit dl rm
cleandns8	417	0755	edit dl rm
cleanmsglog	735	0755	edit dl rm
cleanphpsessions	932	0755	edit dl rm
cleanphpsessions.php	658	0644	edit dl rm
cleanquotas	1651	0755	edit dl rm
cleansessions	6032	0755	edit dl rm
cleanupinterchange	2706	0755	edit dl rm
cleanupmysqlprivs	773	0755	edit dl rm
clean_dead_mailman_locks	2141	0755	edit dl rm
clean_up_temp_wheel_users	2498	0755	edit dl rm
clean_user_php_sessions	4875	0755	edit dl rm
clear_orphaned_virtfs_mounts	3645	0755	edit dl rm
comet_license_registration_sync	1711	0755	edit dl rm
comet_protected_item_maintenance	21281	0755	edit dl rm
comparecdb	1561	0755	edit dl rm
compilers	2932	0755	edit dl rm
compilerscheck	999	0755	edit dl rm
configure_firewall_for_cpanel	520	0755	edit dl rm
configure_rh_firewall_for_cpanel	520	0755	edit dl rm
configure_rh_ipv6_firewall_for_cpanel	520	0755	edit dl rm
convert2dovecot	682	0755	edit dl rm
convert_accesshash_to_token	4171	0755	edit dl rm
convert_and_migrate_from_legacy_backup	2017	0755	edit dl rm
convert_maildir_to_mdbox	1703	0755	edit dl rm
convert_mdbox_to_maildir	1698	0755	edit dl rm
convert_roundcube_mysql2sqlite	26748	0755	edit dl rm
convert_to_dovecot_delivery	4438	0755	edit dl rm
convert_whmxfer_to_sqlite	1499	0755	edit dl rm
copy_user_mail_as_root	1281	0755	edit dl rm
copy_user_mail_as_user	1375	0755	edit dl rm
cpanelsync	28991	0755	edit dl rm
cpanelsync_postprocessor	1657	0755	edit dl rm
cpanel_initial_install	69583	0755	edit dl rm
cpanpingtest	965	0755	edit dl rm
cpan_config	2870	0755	edit dl rm
cpbackup	45861	0755	edit dl rm
cpbackup_transport_file	5781	0755	edit dl rm
cpdig	2882	0755	edit dl rm
cpfetch	1258	0755	edit dl rm
cphulkdblacklist	433	0755	edit dl rm
cphulkdwhitelist	1336	0755	edit dl rm
cpservice	2934	0755	edit dl rm
cpuser_port_authority	19755	0755	edit dl rm
cpuser_service_manager	11113	0755	edit dl rm
createacct	31904760	0700	edit dl rm
create_default_featurelist	11903	0700	edit dl rm
custom_backup_destination.pl.sample	5182	0755	edit dl rm
custom_backup_destination.pl.skeleton	2906	0755	edit dl rm
dcpumon-wrapper	850	0755	edit dl rm
delpop	6350	0755	edit dl rm
detect_env_capabilities	508	0755	edit dl rm
disablefileprotect	2241	0755	edit dl rm
disable_prelink	2841	0755	edit dl rm
distro_changed_hook	1185	0755	edit dl rm
dnscluster	4546	0755	edit dl rm
dnsqueuecron	1316	0755	edit dl rm
dnssec-cluster-keys	3840	0755	edit dl rm
dovecot_maintenance	7842	0755	edit dl rm
dovecot_set_defaults.pl	984	0755	edit dl rm
dumpcdb	866	0755	edit dl rm
dumpinodes	687	0755	edit dl rm
dumpquotas	616	0755	edit dl rm
dumpstor	913	0755	edit dl rm
ea4_fresh_install	2699	0755	edit dl rm
editquota	3512	0755	edit dl rm
edit_cpanelsync_exclude_list	2641	0755	edit dl rm
elevate-cpanel	424577	0700	edit dl rm
email_archive_maintenance	6300	0755	edit dl rm
email_hold_maintenance	1495	0755	edit dl rm
enablefileprotect	2149	0755	edit dl rm
enable_spf_dkim_globally	9039	0755	edit dl rm
ensure_autoenabled_features	3322632	0700	edit dl rm
ensure_conf_dir_crt_key	4940	0755	edit dl rm
ensure_cpuser_file_ip	2610	0755	edit dl rm
ensure_crontab_permissions	1101	0755	edit dl rm
ensure_dovecot_memory_limits_meet_minimum	3208	0755	edit dl rm
ensure_hostname_resolves	2572	0755	edit dl rm
ensure_includes	601	0755	edit dl rm
ensure_vhost_includes	13851	0755	edit dl rm
eximconfgen	1350	0755	edit dl rm
eximstats_spam_check	867	0755	edit dl rm
exim_tidydb	3036	0755	edit dl rm
expunge_expired_certificates_from_sslstorage	3648	0755	edit dl rm
expunge_expired_pkgacct_sessions	852	0755	edit dl rm
expunge_expired_transfer_sessions	1089	0755	edit dl rm
fastmail	5281	0755	edit dl rm
featuremod	1970	0755	edit dl rm
fetchfile	422	0755	edit dl rm
find_and_fix_rpm_issues	7157	0755	edit dl rm
find_outdated_services	6625	0755	edit dl rm
find_pids_with_inotify_watch_on_path	3745	0755	edit dl rm
fix-cpanel-perl	29112	0755	edit dl rm
fix-listen-on-localhost	4036	0755	edit dl rm
fix-web-vhost-configuration	6296	0755	edit dl rm
fixetchosts	4424	0755	edit dl rm
fixheaders	572	0755	edit dl rm
fixmailinglistperms	1008	0755	edit dl rm
fixmailman	2144	0755	edit dl rm
fixnamedviews	1247	0755	edit dl rm
fixndc	413	0755	edit dl rm
fixquotas	18834	0755	edit dl rm
fixrelayd	1784	0755	edit dl rm
fixrndc	16780	0755	edit dl rm
fixtar	503	0755	edit dl rm
fixtlsversions	4816	0755	edit dl rm
fixvaliases	2047	0755	edit dl rm
fixwebalizer	966	0755	edit dl rm
fix_dns_zone_ttls	1369	0755	edit dl rm
fix_innodb_tables	4149	0755	edit dl rm
fix_reseller_acls	10958	0755	edit dl rm
forcelocaldomain	895	0755	edit dl rm
ftpfetch	2251	0755	edit dl rm
ftpquotacheck	8511	0755	edit dl rm
ftpsfetch	2416	0755	edit dl rm
ftpupdate	261	0755	edit dl rm
gather_update_logs_setupcrontab	5582	0700	edit dl rm
gather_update_log_stats	4354	0700	edit dl rm
gemwrapper	1783	0755	edit dl rm
gencrt	6410	0755	edit dl rm
generate_account_suspension_include	5840	0755	edit dl rm
generate_google_drive_credentials	1135	0755	edit dl rm
generate_google_drive_oauth_uri	984	0755	edit dl rm
generate_maildirsize	14908	0755	edit dl rm
gensysinfo	1185	0755	edit dl rm
getremotecpmove	23084	0755	edit dl rm
get_locale_from_legacy_name_info	2041	0755	edit dl rm
grpck	1218	0755	edit dl rm
hackcheck	3092	0755	edit dl rm
hook	1487	0755	edit dl rm
httpspamdetect	2891	0755	edit dl rm
hulk-unban-ip	4301456	0700	edit dl rm
import_exim_data	8593	0755	edit dl rm
increase_filesystem_limits	891	0755	edit dl rm
initacls	5107	0755	edit dl rm
initfpsuexec	444	0755	edit dl rm
initialize_360monitoring	2824	0700	edit dl rm
initquotas	19811	0755	edit dl rm
initsuexec	4123	0755	edit dl rm
installpkg	575	0755	edit dl rm
installpostgres	6715	0755	edit dl rm
installsqlite3	1866	0755	edit dl rm
install_cpanel_analytics	1973	0755	edit dl rm
install_dovecot_fts	1605	0755	edit dl rm
install_plugin	2869	0755	edit dl rm
install_tuxcare_els_php	1889	0755	edit dl rm
ipcheck	4020	0755	edit dl rm
ipusage	7624	0755	edit dl rm
isdedicatedip	602	0755	edit dl rm
is_update_available	3343	0755	edit dl rm
jetbackup-check	3776	0755	edit dl rm
killdns	422	0755	edit dl rm
killdns-dnsadmin	1180	0755	edit dl rm
killmysqluserprivs	433	0755	edit dl rm
killmysqlwildcard	1180	0755	edit dl rm
killpvhost	853	0755	edit dl rm
killspamkeys	937	0755	edit dl rm
linksubemailtomainacct	3248	0755	edit dl rm
link_3rdparty_binaries	1271	0755	edit dl rm
listcheck	538	0755	edit dl rm
listsubdomains	1074	0755	edit dl rm
litespeed-check	3952	0755	edit dl rm
locale_export	5331	0755	edit dl rm
locale_import	4803	0755	edit dl rm
locale_info	4086	0755	edit dl rm
logo.dat	205	0644	edit dl rm
log_retention	21793	0755	edit dl rm
magicloader	1985	0755	edit dl rm
maildir_converter	6222	0755	edit dl rm
mailperm	16923	0755	edit dl rm
mailscannerupdate	2478	0755	edit dl rm
mainipcheck	10236	0755	edit dl rm
maintenance	53445	0755	edit dl rm
make_config	407	0644	edit dl rm
make_hostname_unowned	1189	0755	edit dl rm
manage_extra_marketing	13068	0700	edit dl rm
manage_greylisting	16719	0755	edit dl rm
manage_mysql_profiles	16727	0755	edit dl rm
mass_change_php_setting	10904	0755	edit dl rm
migrate_ccs_to_cpdavd	48186	0755	edit dl rm
migrate_local_ini_to_php_ini	7587	0755	edit dl rm
migrate_whmtheme_file_to_userdata	3025	0755	edit dl rm
MirrorSearch_pingtest	2437	0755	edit dl rm
mkwwwacctconf	2385	0755	edit dl rm
modify_accounts	4169	0755	edit dl rm
modify_featurelist	11597	0700	edit dl rm
modify_packages	3726	0755	edit dl rm
modsec_vendor	16008	0755	edit dl rm
mysqlconnectioncheck	6877	0755	edit dl rm
mysqlpasswd	4235	0755	edit dl rm
named.ca	1603	0644	edit dl rm
named.rfc1912.zones	774	0644	edit dl rm
notify_expiring_certificates	9592	0755	edit dl rm
notify_expiring_certificates_on_linked_nodes	1361	0755	edit dl rm
oopscheck	1142	0755	edit dl rm
optimize_eximstats	3975	0755	edit dl rm
panel_ini	4210	0755	edit dl rm
patchfdsetsize	2784	0755	edit dl rm
patch_mail_spamassassin_compiledregexps_body_0	2452	0755	edit dl rm
pedquota	2310	0755	edit dl rm
perform_sqlite_auto_rebuild_db_maintenance	2031	0755	edit dl rm
perlinstaller	528	0755	edit dl rm
perlmods	1204	0755	edit dl rm
phpini_tidy	687	0755	edit dl rm
php_fpm_config	9968	0755	edit dl rm
pkgacct	92065	0755	edit dl rm
post_snapshot	2144	0755	edit dl rm
post_sync_cleanup	5973	0755	edit dl rm
primary_virtual_host_migration	2502	0755	edit dl rm
process_cpmove	4419	0755	edit dl rm
process_pending_cpanel_php_pear_registration	2793	0755	edit dl rm
proxydomains	9822	0755	edit dl rm
ptycheck	724	0755	edit dl rm
purge_modsec_log	1563	0755	edit dl rm
purge_old_config_caches	2125	0755	edit dl rm
pwck	708	0755	edit dl rm
quickdnslookup	1159	0755	edit dl rm
quickwhoisips	2348	0755	edit dl rm
quotacheck	22900	0755	edit dl rm
quota_auto_fix	1440	0755	edit dl rm
rawchpass	460	0755	edit dl rm
rdate	4913	0755	edit dl rm
realadduser	5743	0755	edit dl rm
realchpass	3336	0755	edit dl rm
realperlinstaller	5805	0755	edit dl rm
realrawchpass	425	0755	edit dl rm
rebuilddnsconfig	26110	0755	edit dl rm
rebuildhttpdconf	2664	0755	edit dl rm
rebuildinstalledssldb	2917	0755	edit dl rm
rebuildippool	509	0755	edit dl rm
rebuilduserssldb	948	0755	edit dl rm
rebuild_bandwidthdb_root_cache	1487	0755	edit dl rm
rebuild_dbmap	5937	0755	edit dl rm
rebuild_provider_openid_connect_links_db	1039	0755	edit dl rm
rebuild_whm_chrome	2277	0755	edit dl rm
refresh-dkim-validity-cache	6110	0755	edit dl rm
regenerate_tokens	2228	0755	edit dl rm
remote_log_transfer	11875	0755	edit dl rm
removeacct	29654400	0700	edit dl rm
remove_dovecot_index_files	6028	0755	edit dl rm
rescan_user_dovecot_fts	3048	0755	edit dl rm
resetmailmanurls	2077	0755	edit dl rm
resetquotas	4723	0755	edit dl rm
reset_mail_quotas_to_sane_values	6982	0755	edit dl rm
restartsrv	3266	0755	edit dl rm
restartsrv_apache	422	0755	edit dl rm
restartsrv_apache_php_fpm	11368960	0755	edit dl rm
restartsrv_base	11368960	0755	edit dl rm
restartsrv_bind	11368960	0755	edit dl rm
restartsrv_chkservd	427	0755	edit dl rm
restartsrv_clamd	11368960	0755	edit dl rm
restartsrv_cpanellogd	11368960	0755	edit dl rm
restartsrv_cpanel_php_fpm	11368960	0755	edit dl rm
restartsrv_cpdavd	11368960	0755	edit dl rm
restartsrv_cpgreylistd	11368960	0755	edit dl rm
restartsrv_cphulkd	11368960	0755	edit dl rm
restartsrv_cpipv6	11368960	0755	edit dl rm
restartsrv_cpsrvd	11368960	0755	edit dl rm
restartsrv_crond	11368960	0755	edit dl rm
restartsrv_dnsadmin	11368960	0755	edit dl rm
restartsrv_dovecot	11368960	0755	edit dl rm
restartsrv_exim	11368960	0755	edit dl rm
restartsrv_eximstats	504	0755	edit dl rm
restartsrv_ftpd	426	0755	edit dl rm
restartsrv_ftpserver	911	0755	edit dl rm
restartsrv_httpd	11368960	0755	edit dl rm
restartsrv_imap	437	0755	edit dl rm
restartsrv_inetd	2525	0755	edit dl rm
restartsrv_ipaliases	11368960	0755	edit dl rm
restartsrv_lmtp	437	0755	edit dl rm
restartsrv_mailman	11368960	0755	edit dl rm
restartsrv_mysql	11368960	0755	edit dl rm
restartsrv_named	579	0755	edit dl rm
restartsrv_nscd	11368960	0755	edit dl rm
restartsrv_p0f	11368960	0755	edit dl rm
restartsrv_pdns	11368960	0755	edit dl rm
restartsrv_pop3	437	0755	edit dl rm
restartsrv_postgres	427	0755	edit dl rm
restartsrv_postgresql	11368960	0755	edit dl rm
restartsrv_powerdns	442	0755	edit dl rm
restartsrv_proftpd	11368960	0755	edit dl rm
restartsrv_pureftpd	11368960	0755	edit dl rm
restartsrv_queueprocd	11368960	0755	edit dl rm
restartsrv_rsyslog	11368960	0755	edit dl rm
restartsrv_rsyslogd	437	0755	edit dl rm
restartsrv_spamd	11368960	0755	edit dl rm
restartsrv_sshd	11368960	0755	edit dl rm
restartsrv_syslogd	2458	0755	edit dl rm
restartsrv_tailwatchd	11368960	0755	edit dl rm
restartsrv_unknown	11368960	0755	edit dl rm
restartsrv_xinetd	422	0755	edit dl rm
restorecpuserfromcache	2008	0755	edit dl rm
restorepkg	51194360	0700	edit dl rm
rfc1912_zones.tar	10240	0644	edit dl rm
rpmup	5191	0755	edit dl rm
rsync-user-homedir.pl	5903	0755	edit dl rm
runstatsonce	440	0755	edit dl rm
runweblogs	1045	0755	edit dl rm
run_if_exists	512	0755	edit dl rm
run_plugin_lifecycle	4060	0700	edit dl rm
sa-update_wrapper	3418	0755	edit dl rm
safetybits.pl	844	0755	edit dl rm
secureit	4834	0755	edit dl rm
securemysql	4501	0755	edit dl rm
securerailsapps	3661	0755	edit dl rm
securetmp	17162	0755	edit dl rm
sendicq	474	0755	edit dl rm
servicedomains	9822	0755	edit dl rm
setpostgresconfig	6181	0755	edit dl rm
setupftpserver	10726	0755	edit dl rm
setupmailserver	9618	0755	edit dl rm
setupnameserver	12898	0755	edit dl rm
setup_greylist_db	16719	0755	edit dl rm
setup_modsec_db	1335	0755	edit dl rm
setup_systemd_timer_for_plugins	4015	0700	edit dl rm
set_mailman_archive_perms	1796	0755	edit dl rm
show_php_settings	3762	0755	edit dl rm
shrink_modsec_ip_database	13285	0755	edit dl rm
simpleps	3124	0755	edit dl rm
slurp_exim_mainlog	5914	0755	edit dl rm
smartcheck	15491	0755	edit dl rm
smtpmailgidonly	8343	0755	edit dl rm
snapshot_prep	6017	0755	edit dl rm
spamassassindisable	3830	0755	edit dl rm
spamassassin_dbm_cleaner	5993	0755	edit dl rm
spamboxdisable	2324	0755	edit dl rm
sshcontrol	14722	0755	edit dl rm
ssl_crt_status	3928	0755	edit dl rm
suspendacct	18516	0755	edit dl rm
suspendmysqlusers	4890	0755	edit dl rm
swapip	3914	0755	edit dl rm
sync-mysql-users-from-grants	1225	0755	edit dl rm
synctransfers	1971	0755	edit dl rm
sync_child_accounts	1813	0755	edit dl rm
sync_contact_emails_to_cpanel_users_files	1163	0755	edit dl rm
syslog_check	1391	0755	edit dl rm
sysup	645	0755	edit dl rm
test_sa_compiled	1093	0755	edit dl rm
transfermysqlusers	10627296	0700	edit dl rm
transfer_accounts_as_root	4870	0755	edit dl rm
transfer_account_as_user	2398	0755	edit dl rm
transfer_in_progress	3156	0755	edit dl rm
transfer_in_progress.pod	312	0644	edit dl rm
try-later	8140	0755	edit dl rm
unblockip	667	0755	edit dl rm
uninstall_cpanel_analytics	1230	0755	edit dl rm
uninstall_dovecot_fts	562	0755	edit dl rm
uninstall_plugin	2907	0755	edit dl rm
unlink_service_account	2682	0755	edit dl rm
unpkgacct	4713	0755	edit dl rm
unslavenamedconf	863	0755	edit dl rm
unsuspendacct	18387	0755	edit dl rm
unsuspendmysqlusers	7266	0755	edit dl rm
upcp	44038	0755	edit dl rm
upcp-running	2768	0755	edit dl rm
upcp.static	977251	0755	edit dl rm
update-packages	5191	0755	edit dl rm
updatedomainips	605	0755	edit dl rm
updatenameserverips	1696	0755	edit dl rm
updatenow	5302	0755	edit dl rm
updatenow.static	2116708	0755	edit dl rm
updatesigningkey	1996	0755	edit dl rm
updatessldomains	1856	0755	edit dl rm
updatesupportauthorizations	2552	0755	edit dl rm
updateuserdatacache	2529	0755	edit dl rm
updateuserdomains	774	0755	edit dl rm
update_apachectl	480	0755	edit dl rm
update_db_cache	430	0755	edit dl rm
update_dkim_keys	1485	0755	edit dl rm
update_exim_rejects	1242	0755	edit dl rm
update_existing_mail_quotas_for_account	4891	0755	edit dl rm
update_feature_flags	957	0755	edit dl rm
update_freebusy_data	5376	0755	edit dl rm
update_known_proxy_ips	1002	0755	edit dl rm
update_local_rpm_versions	4669	0755	edit dl rm
update_mailman_cache	8545	0755	edit dl rm
update_mysql_systemd_config	1094	0755	edit dl rm
update_neighbor_netblocks	487	0755	edit dl rm
update_sa_config	2196	0755	edit dl rm
update_spamassassin_config	10988	0755	edit dl rm
update_users_jail	691	0755	edit dl rm
update_users_vhosts	801	0755	edit dl rm
upgrade_bandwidth_dbs	2272	0755	edit dl rm
upgrade_subaccount_databases	2797	0755	edit dl rm
userdata_wildcard_cleanup	5877	0755	edit dl rm
userdirctl	5134	0755	edit dl rm
validate_sshkey_passphrase	1244	0755	edit dl rm
verify_api_spec_files	757	0755	edit dl rm
verify_pidfile	2008	0755	edit dl rm
verify_vhost_includes	7517	0755	edit dl rm
vps_optimizer	8007	0755	edit dl rm
vzzo-fixer	725	0755	edit dl rm
whmlogin	2390	0755	edit dl rm
whoowns	1155	0755	edit dl rm
wwwacct	31904760	0700	edit dl rm
wwwacct2	88	0755	edit dl rm
xferpoint	3201	0755	edit dl rm
xfertool	16624	0755	edit dl rm
xfer_rcube_schema_migrate.pl	2460	0755	edit dl rm
xfer_rcube_uid_resolver.pl	1846	0755	edit dl rm
zoneexists	800	0755	edit dl rm

Edit: /usr/local/cpanel/scripts/refresh-dkim-validity-cache (6110B)

#!/usr/local/cpanel/3rdparty/bin/perl

# cpanel - scripts/refresh-dkim-validity-cache     Copyright 2022 cPanel, L.L.C.
#                                                           All rights reserved.
# copyright@cpanel.net                                         http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited

#----------------------------------------------------------------------
# NOTE: See Cpanel/DKIM/ValidityCache/Sync.pm for a more code-friendly
# analogue to this script.
#----------------------------------------------------------------------

package scripts::refresh_dkim_validity_cache;

use strict;
use warnings;

=encoding utf-8

=head1 NAME

scripts/refresh-dkim-validity-cache

=head1 USAGE

refresh-dkim-validity-cache ( --help | --all-domains | --initialize )

refresh-dkim-validity-cache --domain $d1 --domain $d2 ...

=head1 DESCRIPTION

This script refreshes the DKIM validity cache so that the system
will add DKIM signatures for all messages whose sender domain has a
correct DKIM configuration—but B<only> those messages.

It notes all changes made to the cache and prints a summary at the end.

=head1 OPTIONS

=over

=item * C<--all-domains> - Refreshes every domain’s validity cache.
(This can take a while!) Excludes C<--domain> and C<--initialize>.

=item * C<--domain> - Accepts a domain as argument. May be given multiple
times.

=item * C<--initialize> - Creates the validity cache anew if it doesn’t
already exist. All users are recorded as having valid DKIM, with the
understanding that a subsequent run of this script with C<--all-domains>
will remove invalid entries. (This is to ensure that DKIM signing doesn’t
fail temporarily while the cache is being created.)
C<--initialize> excludes C<--domain> and implies C<--all-domains>.
This is only useful in rare cases and shouldn’t ordinarily be done.

=back

=cut

use Try::Tiny;

use parent qw( Cpanel::HelpfulScript );

use constant _OPTIONS => (
    'initialize',
    'all-domains',
    'domain=s@',
);

__PACKAGE__->new(@ARGV)->run() if !caller;

sub run {
    my ($self) = @_;

my $given_domains_ar = $self->getopt('domain');

my $every_domain_yn = $self->getopt('all-domains');

my $init_yn = $self->getopt('initialize');

if ($every_domain_yn) {
        if ( $init_yn || $given_domains_ar ) {
            die $self->help('“--all-domains” excludes “--initialize” and “--domain”.');
        }
    }
    elsif ($init_yn) {
        if ($given_domains_ar) {
            die $self->help('“--initialize” excludes “--all-domains” and “--domain”.');
        }
    }
    elsif ( !$given_domains_ar ) {
        die $self->help('No arguments given!');
    }

require Cpanel::DKIM::ValidityCache;

my $all_domains_ar = _load_all_domains();

my $cache_all_ar = Cpanel::DKIM::ValidityCache->get_all();

my %old_lookup;

my $init_obj;

if ($cache_all_ar) {
        if ($init_yn) {
            $self->say('The cache is already initialized.');
            return;
        }

%old_lookup = map { $_ => undef } @$cache_all_ar;

require Cpanel::Set;
        my @stale = Cpanel::Set::difference(
            [ keys %old_lookup ],
            $all_domains_ar,
        );

for (@stale) {
            $self->say("Removing stale entry for “$_” …");
            _write_or_warn( 'unset', $_ );
        }
    }
    elsif ($init_yn) {
        require Cpanel::DKIM::ValidityCache::TempDir;
        $init_obj = Cpanel::DKIM::ValidityCache::TempDir->new();
    }

$_ = 0 for my ( $added, $removed );

for my $domain ( sort @$all_domains_ar ) {

# Skip all wildcards.
        next if 0 == index( $domain, '*' );

if ( !$every_domain_yn && !$init_yn ) {
            my $proceed_yn = grep { $_ eq $domain } @$given_domains_ar;

next if !$proceed_yn;
        }

if ($init_yn) {
            _write_or_warn( set => $domain );
            $added++;
        }
        else {
            $self->say("Checking “$domain” …");

try {
                if ( _domain_has_valid_dkim($domain) ) {
                    $self->say("\t✅ Valid!");

if ( !exists $old_lookup{$domain} ) {
                        _write_or_warn( set => $domain );
                        $added++;
                        $self->say("\t➕ Added to cache.");
                    }
                }
                else {
                    $self->say("\t⛔ Not valid.");

if ( exists $old_lookup{$domain} ) {
                        require Cpanel::DKIM::ValidityCache::Write;
                        Cpanel::DKIM::ValidityCache::Write->unset($domain);
                        $removed++;
                        $self->say("\t➖ Removed from cache.");
                    }
                }
            }
            catch {
                warn "$domain: $_";
            };
        }
    }

$self->say();

if ($init_yn) {
        $init_obj->install();
        $self->say("The cache is initialized. ($added entries added)");
    }
    else {
        $self->say("Done! $added added, $removed removed.");
    }

return;
}

sub _write_or_warn {
    my ( $fn, $name ) = @_;

require Cpanel::DKIM::ValidityCache::Write;
    local $@;
    warn if !eval { Cpanel::DKIM::ValidityCache::Write->$fn($name); 1 };

return;
}

sub _load_all_domains {

require Cpanel::Config::LoadUserDomains;

# 1 = give me a domain-to-user hash
    my $du_hr = Cpanel::Config::LoadUserDomains::loaduserdomains( undef, 1 );

require Cpanel::Sys::Hostname;

# Ensure that we can DKIM-sign mail sent from the hostname.
    my $hostname = Cpanel::Sys::Hostname::gethostname();
    $du_hr->{$hostname} ||= undef;

return [ sort keys %$du_hr ];
}

sub _domain_has_valid_dkim {
    my ($domain) = @_;

require Cpanel::DnsUtils::MailRecords;

my $resp_ar = Cpanel::DnsUtils::MailRecords::validate_dkim_records_for_domains( [$domain] );

return ( ( $resp_ar->[0]{'state'} // q<> ) eq 'VALID' );
}

#!/usr/local/cpanel/3rdparty/bin/perl # cpanel - scripts/refresh-dkim-validity-cache Copyright 2022 cPanel, L.L.C. # All rights reserved. # copyright@cpanel.net http://cpanel.net # This code is subject to the cPanel license. Unauthorized copying is prohibited #---------------------------------------------------------------------- # NOTE: See Cpanel/DKIM/ValidityCache/Sync.pm for a more code-friendly # analogue to this script. #---------------------------------------------------------------------- package scripts::refresh_dkim_validity_cache; use strict; use warnings; =encoding utf-8 =head1 NAME scripts/refresh-dkim-validity-cache =head1 USAGE refresh-dkim-validity-cache ( --help | --all-domains | --initialize ) refresh-dkim-validity-cache --domain $d1 --domain $d2 ... =head1 DESCRIPTION This script refreshes the DKIM validity cache so that the system will add DKIM signatures for all messages whose sender domain has a correct DKIM configuration—but B those messages. It notes all changes made to the cache and prints a summary at the end. =head1 OPTIONS =over =item * C<--all-domains> - Refreshes every domain’s validity cache. (This can take a while!) Excludes C<--domain> and C<--initialize>. =item * C<--domain> - Accepts a domain as argument. May be given multiple times. =item * C<--initialize> - Creates the validity cache anew if it doesn’t already exist. All users are recorded as having valid DKIM, with the understanding that a subsequent run of this script with C<--all-domains> will remove invalid entries. (This is to ensure that DKIM signing doesn’t fail temporarily while the cache is being created.) C<--initialize> excludes C<--domain> and implies C<--all-domains>. This is only useful in rare cases and shouldn’t ordinarily be done. =back =cut use Try::Tiny; use parent qw( Cpanel::HelpfulScript ); use constant _OPTIONS => ( 'initialize', 'all-domains', 'domain=s@', ); __PACKAGE__->new(@ARGV)->run() if !caller; sub run { my ($self) = @_; my $given_domains_ar = $self->getopt('domain'); my $every_domain_yn = $self->getopt('all-domains'); my $init_yn = $self->getopt('initialize'); if ($every_domain_yn) { if ( $init_yn || $given_domains_ar ) { die $self->help('“--all-domains” excludes “--initialize” and “--domain”.'); } } elsif ($init_yn) { if ($given_domains_ar) { die $self->help('“--initialize” excludes “--all-domains” and “--domain”.'); } } elsif ( !$given_domains_ar ) { die $self->help('No arguments given!'); } require Cpanel::DKIM::ValidityCache; my $all_domains_ar = _load_all_domains(); my $cache_all_ar = Cpanel::DKIM::ValidityCache->get_all(); my %old_lookup; my $init_obj; if ($cache_all_ar) { if ($init_yn) { $self->say('The cache is already initialized.'); return; } %old_lookup = map { $_ => undef } @$cache_all_ar; require Cpanel::Set; my @stale = Cpanel::Set::difference( [ keys %old_lookup ], $all_domains_ar, ); for (@stale) { $self->say("Removing stale entry for “$_” …"); _write_or_warn( 'unset', $_ ); } } elsif ($init_yn) { require Cpanel::DKIM::ValidityCache::TempDir; $init_obj = Cpanel::DKIM::ValidityCache::TempDir->new(); } $_ = 0 for my ( $added, $removed ); for my $domain ( sort @$all_domains_ar ) { # Skip all wildcards. next if 0 == index( $domain, '*' ); if ( !$every_domain_yn && !$init_yn ) { my $proceed_yn = grep { $_ eq $domain } @$given_domains_ar; next if !$proceed_yn; } if ($init_yn) { _write_or_warn( set => $domain ); $added++; } else { $self->say("Checking “$domain” …"); try { if ( _domain_has_valid_dkim($domain) ) { $self->say("\t✅ Valid!"); if ( !exists $old_lookup{$domain} ) { _write_or_warn( set => $domain ); $added++; $self->say("\t➕ Added to cache."); } } else { $self->say("\t⛔ Not valid."); if ( exists $old_lookup{$domain} ) { require Cpanel::DKIM::ValidityCache::Write; Cpanel::DKIM::ValidityCache::Write->unset($domain); $removed++; $self->say("\t➖ Removed from cache."); } } } catch { warn "$domain: $_"; }; } } $self->say(); if ($init_yn) { $init_obj->install(); $self->say("The cache is initialized. ($added entries added)"); } else { $self->say("Done! $added added, $removed removed."); } return; } sub _write_or_warn { my ( $fn, $name ) = @_; require Cpanel::DKIM::ValidityCache::Write; local $@; warn if !eval { Cpanel::DKIM::ValidityCache::Write->$fn($name); 1 }; return; } sub _load_all_domains { require Cpanel::Config::LoadUserDomains; # 1 = give me a domain-to-user hash my $du_hr = Cpanel::Config::LoadUserDomains::loaduserdomains( undef, 1 ); require Cpanel::Sys::Hostname; # Ensure that we can DKIM-sign mail sent from the hostname. my $hostname = Cpanel::Sys::Hostname::gethostname(); $du_hr->{$hostname} ||= undef; return [ sort keys %$du_hr ]; } sub _domain_has_valid_dkim { my ($domain) = @_; require Cpanel::DnsUtils::MailRecords; my $resp_ar = Cpanel::DnsUtils::MailRecords::validate_dkim_records_for_domains( [$domain] ); return ( ( $resp_ar->[0]{'state'} // q<> ) eq 'VALID' ); } 1;