diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d159169d --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md index 073afdb3..c9a21a78 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ SUSE Linux Enterprise support utilities. Gathers system information. ## Branching Strategy -**dev**: Unstable branch with current fixes. +**dev**: Unstable branch with current fixes to SLE15 and SLE16 -**sle12**: SUSE Linux Enterprise Server 12 branch for all changes to SLE12 +**master**: Current stable changes for SLE15 and SLE16. Protected branch requires pull request from **dev** branch. -**sle11**: SUSE Linux Enterprise Server 11 branch for all changes to SLE11 +**sle15sp3**: SUSE Linux Enterprise Server 15 branch. Derived from master but contains scplugin.rc. -**master**: Current stable changes for SLE15 and beyond. Protected branch requires pull request from **dev** branch. +**sle12**: SUSE Linux Enterprise Server 12 branch for all changes to SLE12 -**sle15: DEPRICATED Do not use.** SUSE Linux Enterprise Server 15 branch for all changes to SLE15 +**sle11**: SUSE Linux Enterprise Server 11 branch for all changes to SLE11 Applicable fixes must be checked into each corresponding branch. diff --git a/bin/supportconfig b/bin/supportconfig index b35f6568..49ad2f88 100755 --- a/bin/supportconfig +++ b/bin/supportconfig @@ -98,6 +98,8 @@ show_help() { echo " -f From directory. Don't collect report files, just use the directory or files in that" echo " directory." echo " -g Use gzip instead of the default xz compression" + echo " -j Scrub sensitive data with supportutils-scrub before packing." + echo " Use SUPPORTUTILS_SCRUB_OPTS env var for extra options (--verify, --keywords ...)." echo " -i " echo " Include keywords. A comma separated list of feature keywords that specify" echo " which features to include. Use -F to see a list of valid keywords." @@ -336,7 +338,6 @@ basic_healthcheck() { rm -f $TOPTMP fi - if grep 'security=apparmor' /proc/cmdline &>/dev/null; then log_write $AARTMP "#==[ Summary ]======================================#" log_write $AARTMP "# AppArmor REJECT Messages" @@ -372,6 +373,8 @@ basic_healthcheck() { cat $PSPTMP >> $LOG/$OF rm $PSPTMP + rpm_verify $OF procps + echolog Done } @@ -402,7 +405,6 @@ rpm_info() { printf "%-63s %-35s %s\n" SIGNATURE VENDOR PACKAGE >> $LOGFILE $RPM_BIN -qa --queryformat "%{SIGPGP:pgpsig} %-35{VENDOR} %{NAME}-%{VERSION}-%{RELEASE}\n" | sort -k 11 -t " " -i >> $LOGFILE 2>&1 log_write $RPMFILE - # Jul 12, 2018 ; Added by Ahmad AL Zayed to get a list of RPM DB Backups RETURN=$(grep RPMDB_BACKUP_DIR /etc/sysconfig/backup 2>/dev/null | grep -v "^#" | cut -d= -f2 | tr -d "\"") [[ -d $RETURN ]] && { log_cmd $RPMFILE "ls -ltr $RETURN" ;} fi @@ -655,7 +657,13 @@ boot_info() { OF=boot.txt addHeaderFile $OF log_cmd $OF "uname -a" - # Feb 6, 2024 - Ahmad Alzayed - Added grep -E '[0-9]' to avoid getting duplicated output + if [[ "$(readlink -f /boot/initrd)" == *"$(uname -r)"* ]]; then + echo -e "Current running kernel matches /boot/initrd\n" >> $LOG/$OF + else + echo "**WARNING -- MISMATCH**: Running kernel DOES NOT match version of $(readlink -f /boot/initrd)" >> $LOG/$OF + echo -e "This could be due to a different kernel installed but not rebooted, booted to a different kernel, chrooted in rescue, or other cause.\n" >> $LOG/$OF + fi + KERNELS=$(cat $LOG/$RPMFILE | grep '^kernel-' | grep -v 'kernel-source' | awk '{print $1}' | grep -E '[0-9]') for KERNEL in $KERNELS do @@ -668,9 +676,10 @@ boot_info() { fi if $RPM_BIN -q grub2 &> /dev/null; then rpm_verify $OF grub2 - conf_files $OF /etc/default/grub /etc/default/grub_installdevice /boot/grub2/device.map + conf_files $OF /etc/default/grub /etc/default/grub_installdevice /boot/grub2/device.map /boot/grub2/grubenv BKOP=$ADD_OPTION_LOGS - ADD_OPTION_LOGS=1 conf_files $OF /boot/grub2/grub.cfg + ADD_OPTION_LOGS=1 + conf_files $OF /boot/grub2/grub.cfg ADD_OPTION_LOGS=$BKOP fi if $RPM_BIN -q lilo &> /dev/null; then @@ -709,7 +718,7 @@ boot_info() { conf_files $OF /proc/cmdline /etc/sysconfig/kernel $FILES log_cmd $OF 'ls -lR --time-style=long-iso /boot/' - log_cmd $OF "lsinitrd -k $(uname -r)" + log_cmd $OF 'lsinitrd $(readlink -f /boot/initrd)' (( $ADD_OPTION_LOGS )) && log_files $OF 0 $FILES || log_files $OF $VAR_OPTION_LINE_COUNT $FILES log_cmd $OF 'journalctl --boot=0 --no-pager --disk-usage' if [[ -x $JOURNALCTL_BIN ]]; then @@ -776,6 +785,7 @@ bpf_info() { fi fi else + log_entry $OF note "Install bpftool to display more information." log_cmd $OF 'grep -E bpf_prog_[a-f0-9]{16} /proc/kallsyms' fi echolog Done @@ -948,11 +958,16 @@ pam_info() { log_write $OF "#==[ Files in /etc/security ]=======================#" [[ -d /etc/security ]] && FILES="$(find -L /etc/security/ -type f -name \*conf)" || FILES="" conf_files $OF $FILES - # Nov 24, 2023 ,, Added by Ahmad Alzayed log_cmd $OF "ls -lt --time-style=long-iso /etc/pam.d/" log_write $OF "#==[ Files in /etc/pam.d ]==========================#" [[ -d /etc/pam.d ]] && FILES="$(find -L /etc/pam.d/ -type f | sort)" || FILES="" conf_files $OF $FILES + if [[ -d /usr/lib/pam.d ]]; then + log_write $OF "#==[ Files in /usr/lib/pam.d ]==========================#" + log_cmd $OF "ls -lt --time-style=long-iso /usr/lib/pam.d/" + FILES="$(find -L /usr/lib/pam.d/ -type f | sort)" || FILES="" + conf_files $OF $FILES + fi echolog Done else log_entry $OF note "Restricted" @@ -1063,6 +1078,8 @@ environment_info() { conf_files $OF /etc/profile /etc/profile.local /etc/profile.d/* conf_files $OF /etc/bash.bashrc /etc/csh\.* /etc/ksh* sed -i -e 's/\r//g' $LOG/$OF + # Mar 26, 2026 - Added by Ahmad Alzayed to remove proxy information from env file. + _sanitize_file $OF echolog Done } @@ -1112,6 +1129,10 @@ systemd_info() { do log_cmd $OF2 "systemctl status '$i'" done + for i in $($SYSTEMCTL_BIN --no-pager list-unit-files --type=service 2>/dev/null | sed 's/^[^-_:\\a-zA-Z0-9]*//' | grep -vE '^UNIT |^LOAD |^ACTIVE |^SUB |^To |^[[:digit:]]* ' | awk '{print $1}') + do + log_cmd $OF "systemctl cat '$i'" + done fi log_cmd $OF 'ls -alR /etc/systemd/' log_cmd $OF 'ls -alR /usr/lib/systemd/' @@ -2518,7 +2539,7 @@ crash_info() { log_cmd $OF 'sysctl kernel 2>/dev/null | grep panic' if rpm -q kdump &>/dev/null ; then if [[ -x $READ_KDUMP_CONFIG ]]; then - . $READ_KDUMP_CONFIG + source $READ_KDUMP_CONFIG 2>&1 | grep -v "deprecated, ignoring" DUMPDIR=${KDUMP_SAVEDIR#file://} else DUMPDIR='' @@ -2825,10 +2846,8 @@ ha_info() { log_cmd $OF 'chronyc sources -v' log_cmd $OF 'crm_mon -r -1' log_cmd $OF 'crm_mon -r -n -1' - # Display node attributes ; Nov 15, 2018 ; Added by Ahmad Al Zayed log_cmd $OF 'crm_mon -A -1' log_cmd $OF 'corosync-cfgtool -s' - # More corosync information ; Dec 6, 2018 ; Added by Ahmad Al Zayed log_cmd $OF 'crm corosync status' log_cmd $OF 'crm configure show' conf_files $OF $CONF_FILES @@ -2857,6 +2876,8 @@ ha_info() { done fi done + log_cmd $OF "grep -E '^hacluster:[x*]:' /etc/passwd" + log_cmd $OF "grep -E '^haclient:[x*]:' /etc/group" cd $CURRENT_PATH CURRENT_CIB='' FILES='' @@ -3081,7 +3102,6 @@ drbd_info() { log_cmd $OF "grep drbd /proc/modules" log_cmd $OF "modinfo drbd" log_cmd $OF "drbd-overview" - # Added By Ahmad Al Zayed - Feb 21, 2019 to get few drbd output & configuration log_cmd $OF "drbdadm status" log_cmd $OF "drbdadm dump" log_cmd $OF "cat /proc/drbd" @@ -3714,7 +3734,9 @@ ssh_info() { if rpm_verify $OF openssh then log_cmd $OF "systemctl status sshd.service" - conf_files $OF /etc/ssh/sshd_config /etc/ssh/ssh_config /etc/pam.d/sshd + FILES=({/usr,}/etc/ssh/ssh_config {/usr,}/etc/ssh/sshd_config {/usr/lib,/etc}/pam.d/sshd) + INCLUDE_FILES=($(expand_globs_to_paths $(grep -Pho '^\s*Include\s+\K([^$#]+)' {/usr,}/etc/ssh/ssh_config {/usr,}/etc/ssh/sshd_config 2>/dev/null))) + conf_files $OF ${FILES[@]} ${INCLUDE_FILES[@]} log_cmd $OF 'ss -nlp | grep sshd' echolog Done else @@ -4208,7 +4230,7 @@ get_sles_ver NSA_CHECK=0 ALL_ARGS="$@" declare -a KV_PAIRS -while getopts :\#AB:CDE:FG:H:I:JLM:N:O:P:QR:S:T:U:W:X:V:abcdef:ghi:klmo:pqr:st:uvwx:yz TMPOPT +while getopts :\#AB:CDE:FG:H:I:JLM:N:O:P:QR:S:T:U:W:X:V:abcdef:ghi:jklmo:pqr:st:uvwx:yz TMPOPT do case $TMPOPT in \:) clear; title @@ -4257,6 +4279,7 @@ do g) COMPRESS="tgz"; COMPRESS_OPT="zcf" ;; h) title; show_help; exit_code 0 ;; i) SELECTED_FEATURE_LIST=$OPTARG; set_to_min; selected_features on ;; + j) ADD_OPTION_SCRUB=1 ;; k) MIN_OPTION_AUTOMOD=0 ;; l) ADD_OPTION_LOGS=1 ;; m) set_to_min ;; @@ -4283,6 +4306,8 @@ do esac done +(( $ADD_OPTION_SCRUB )) && validate_scrubbing + (( $ADD_OPTION_LOGS )) && ADD_OPTION_MAXYAST=1 umask 0077 @@ -4506,6 +4531,8 @@ else (( $VAR_OPTION_SILENT )) || { clear; title; } fi +(( ADD_OPTION_SCRUB )) && scrub_dir + # don't continue if SAVE_LOGS_ONLY is set (( $SAVE_LOGS_ONLY )) && exit_code 0; diff --git a/bin/supportconfig.rc b/bin/supportconfig.rc index 55d0745f..98319782 100644 --- a/bin/supportconfig.rc +++ b/bin/supportconfig.rc @@ -101,6 +101,7 @@ ADD_OPTION_LOGS=0 ADD_OPTION_MINDISK=0 ADD_OPTION_MAXYAST=0 ADD_OPTION_RPMV=0 +ADD_OPTION_SCRUB=0 ADD_OPTION_SLP=0 ADD_OPTION_LOCAL_ONLY=0 @@ -145,6 +146,7 @@ VAR_OPTION_WAIT_TRACE=0 : ${FORCE_OPTION_PAM:=0} : ${LOCAL_PODMAN_USERS:=''} + LANG=C PATH="/sbin:/usr/sbin:/bin:/usr/bin:$PATH" PATH_ORIG=$PATH @@ -152,6 +154,7 @@ export PATH LANG LIB_DIR='/usr/lib/supportconfig' CONFIG_DIR='/etc/supportutils' SC_RESOURCE_FILE="${LIB_DIR}/resources/supportconfig.rc" +SCRUB_PKG="supportutils-scrub" XPLUGIN_DIR="${LIB_DIR}/plugins" CURRENT_SCRIPT=$(basename $0) ARCHIVE_PREFIX='scc_' @@ -195,7 +198,7 @@ EXT_SCALING_PID_LIMIT=1000 EXT_SCALING_IRQ_LIMIT=1000 EXT_SCALING_EXEC_LIMIT=9000000 -PROC_FILES="/proc/mounts /proc/zoneinfo" +PROC_FILES="/proc/mounts /proc/zoneinfo /proc/softirqs" PROC_DIRS_DEPTH_ONE="/proc/sys/kernel/ /proc/scsi/ /proc/net/ /proc/dasd/" PROC_DIRS_DEPTH_FULL="/proc/irq/ /proc/sys/" PROC_DIRS_DEPTH_ONE_FILTER_OUT="rt_acct$|/sched_domain/" @@ -237,6 +240,8 @@ IP_BIN=$(command -v ip) BRCTL_BIN=$(command -v brctl) LOGGER_BIN=$(command -v logger) KLP_BIN=$(command -v klp) +SCRUB_BIN=$(command -v supportutils-scrub 2>/dev/null) + trap "{ echolog TERMINATED BY USER; echo; exit 5; }" SIGINT trap "{ echolog SKIPPED BY USER; return 4; }" SIGQUIT @@ -528,6 +533,81 @@ printlog() { fi } +validate_scrubbing() { + if rpm -q $SCRUB_PKG &> /dev/null; then + if ! [[ -x $SCRUB_BIN ]]; then + title + echo "ERROR: Unable to scrub data files, invalid or missing supportutils-scrub utility." + echo " Please reinstall the $SCRUB_PKG package or turn off scrubbing with ADD_OPTION_SCRUB=0" + echo + exit 15 + fi + else + title + echo "ERROR: Unable to scrub data files, missing $SCRUB_PKG package." + echo " Please install the $SCRUB_PKG package or turn off scrubbing with ADD_OPTION_SCRUB=0" + echo + exit 15 + fi + SCRUB_VER=$(rpm -q --queryformat '%{VERSION}' supportutils-scrub 2>/dev/null) + if [[ $(echo -e "1.2\n$SCRUB_VER" | sort -V | head -1) != "1.2" ]]; then + title + echo "ERROR: supportutils-scrub version $SCRUB_VER is too old. Version 1.4 or later required." + echo " Please update the supportutils-scrub package." + echo + exit 15 + fi + export SCRUB_VER +} + +scrub_dir() { + echolog "Scrubbing supportconfig files..." + + # supportutils-scrub v1.4 returns the supportconfig scrubbed path to stdout + if [[ $(echo -e "1.4\n$SCRUB_VER" | sort -V | head -1) == "1.4" ]]; then + local SCRUBBED_DIR RC NEW_BASE NEW_LOG + SCRUBBED_DIR=$("$SCRUB_BIN" --quiet "$LOG") + RC=$? + + if (( RC == 0 )) || (( RC == 2 )); then + if [[ -d "$SCRUBBED_DIR" ]]; then + rm -rf "$LOG" + NEW_BASE=$(basename "$SCRUBBED_DIR" | sed 's/_scrubbed$//') + NEW_LOG="$(dirname "$LOG")/$NEW_BASE" + mv "$SCRUBBED_DIR" "$NEW_LOG" + LOG="$NEW_LOG" + BASE="$NEW_BASE" + export LOG BASE + echolog "Supportconfig scrubbing complete. " + else + echo "WARNING: supportutils-scrub did not produce output directory." >&2 + fi + elif (( RC == 3 )); then + echo "ERROR: supportutils-scrub --verify found remaining sensitive data." >&2 + echo " Removing the original and the scrubbed supportconfig to prevent any potential leak." >&2 + rm -rf "$LOG" + [[ -n "$SCRUBBED_DIR" ]] && rm -rf "$SCRUBBED_DIR" + exit 15 + else + echo "WARNING: supportutils-scrub exited with rc=$RC -- data not scrubbed." >&2 + fi + else + # v1.2/v1.3 does not support hostname scrubbing from folder name + # the --quiet option is supported from v1.3 + local QUIET_OPT="" + [[ $(echo -e "1.3\n$SCRUB_VER" | sort -V | head -1) == "1.3" ]] && QUIET_OPT="--quiet" + $SCRUB_BIN "$LOG" $QUIET_OPT ${SUPPORTUTILS_SCRUB_OPTS} + if [[ -d "${LOG}_scrubbed" ]]; then + LOG="${LOG}_scrubbed" + BASE="${BASE}_scrubbed" + export LOG BASE + echolog "Data scrubbing complete." + else + echo "WARNING: supportutils-scrub did not produce ${LOG}_scrubbed -- data not scrubbed." >&2 + fi + fi +} + printvrpmlog() { CSLOGFILE=$LOG/${CSFILE} (( $VAR_OPTION_SILENT )) && printf " %-40s %12s ... " "$1" "$2" >> $CSLOGFILE || printf " %-40s %12s ... " "$1" "$2" | tee -a $CSLOGFILE @@ -1058,6 +1138,7 @@ ehr() { echo "-----------------------------------------------------------------------------" } + encrypt_tarball() { log2sys "Encrypt Tar Ball" if [[ -x $GPG_BIN ]]; then @@ -1490,4 +1571,18 @@ get_sles_ver() { fi } +expand_globs_to_paths() { + local pattern file + local -a results=() + shopt -s nullglob + for pattern in "$@"; do + for file in $pattern; do + if [[ -e $file ]]; then + results+=( "$(realpath -e -- "$file")" ) + fi + done + done + shopt -u nullglob + printf '%s\n' "${results[@]}" | awk '!seen[$0]++' +} diff --git a/man/supportconfig.8 b/man/supportconfig.8 index 24566ea5..1c40bd05 100644 --- a/man/supportconfig.8 +++ b/man/supportconfig.8 @@ -141,9 +141,24 @@ Disables extended scaling. By default extended scaling is disabled. However, if \fB\-f\fR \fIdirectory\fR From directory. Don't collect report files, just use files in that directory. This option is most often used in connection with -t and the YaST support module. If a regular directory is used, supportconfig looks for the most recent supportconfig archive directory and uses it. If a valid supportconfig directory is specified, it is used. .TP -\fB\-g\fR +\fB\-g\fR Use gzip instead of the default bzip2 compression. .TP +\fB\-j\fR +Scrub sensitive data from the collected files before packing the archive. +Requires the +.B supportutils-scrub +package (version 1.2 or later) to be installed. +Obfuscates IP addresses, MAC addresses, hostnames, domain names, usernames, and serial numbers. +With version 1.4 or later, the hostname is also scrubbed from the archive folder name. +Additional options can be passed to supportutils-scrub via the +.B SUPPORTUTILS_SCRUB_OPTS +environment variable. +Scrubbing can be enabled permanently without using this flag by setting +.B ADD_OPTION_SCRUB=1 +in +.IR /etc/supportutils/supportconfig.conf . +.TP \fB\-i\fR \fIkeyword[,keyword]\fR Include keywords. A comma separated list of feature keywords that specify which features to include. Use -F to see a list of valid keywords. Do not use spaces and keywords are case-sensitive. @@ -214,6 +229,18 @@ You can use the SC_CONF environment variable to specify an alternate configurati .RS .B Example: export SC_CONF=/opt/supportconfig.conf .RE +.PP +.I SUPPORTUTILS_SCRUB_OPTS +.RS +Extra options passed to +.B supportutils-scrub +when +.B \-j +is used. +.RE +.RS +.B Example: SUPPORTUTILS_SCRUB_OPTS="--verify --keywords mycompany,myserver --hostname terminus,vmhost1" supportconfig -j +.RE .SH FILES .I /etc/supportutils/supportconfig.conf .RS diff --git a/man/supportconfig.conf.5 b/man/supportconfig.conf.5 index 43a4f17d..83a568d5 100644 --- a/man/supportconfig.conf.5 +++ b/man/supportconfig.conf.5 @@ -225,6 +225,15 @@ Normally VAR_OPTION_LINE_COUNT lines are gathered from all /var/log/YaST2/* file ADD_OPTION_RPMV Runs an rpm -V on every installed RPM package. This takes some time to complete. \fB\-v\fR, \fBrpm-verify.txt\fR (0) .TP +ADD_OPTION_SCRUB +Scrub sensitive data from all collected files before packing the archive. Requires the +.B supportutils-scrub +package (version 1.2 or later). Obfuscates IP addresses, MAC addresses, hostnames, domain names, usernames, and serial numbers. Equivalent to passing +.B \-j +on the command line. Use +.B SUPPORTUTILS_SCRUB_OPTS +to pass additional options to supportutils-scrub. \fB\-j\fR (0) +.TP ADD_OPTION_SLP Normally only the base SLP service types are listed. This option allows you to query each of the discovered service types individually. \fB\-s\fR, \fBslp.txt\fR (0) .PD diff --git a/spec/supportutils.changes b/spec/supportutils.changes index f7c04582..3cd8f146 100644 --- a/spec/supportutils.changes +++ b/spec/supportutils.changes @@ -1,3 +1,11 @@ +------------------------------------------------------------------- +Wed Jan 28 20:23:39 UTC 2026 - jason.record@suse.com + + - scplugin.rc is restored in package 3.2.12.1 for continued compatibility. + There is no furture development for scplugin.rc. Use supportconfig.rc. + Package version 3.2.12.2 does not have scplugin.rc. Supportconfig + itself is the same for both versions. (bsc#1256709) + ------------------------------------------------------------------- Fri Dec 12 20:05:09 UTC 2025 - jason.record@suse.com