[WIP] issuegen: detect util-linux RPM version, set output directory appropriately #40
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,42 +14,67 @@ | |
| set -e | ||
|
|
||
| PKG_NAME=console-login-helper-messages | ||
| ISSUE_SNIPPETS_PATH=${PKG_NAME}/issue.d | ||
|
|
||
| # Snippet locations that are read by issuegen to generate combined snippet | ||
| # data, which is outputted in ${generated_file} (below). | ||
| ETC_SNIPPETS="/etc/${ISSUE_SNIPPETS_PATH}" | ||
| RUN_SNIPPETS="/run/${ISSUE_SNIPPETS_PATH}" | ||
| USR_LIB_SNIPPETS="/usr/lib/${ISSUE_SNIPPETS_PATH}" | ||
|
|
||
| # Output locations for snippets produced by issuegen. | ||
| SNIPPETS_OUTDIR="${RUN_SNIPPETS}" | ||
| GENERATED_FILE_OUTDIR="/run/${PKG_NAME}" | ||
|
|
||
| # Check util-linux version, and set output directories accordingly. | ||
| # If not on an RPM-based system, then just continue keeping the output | ||
| # directories at their defaults. | ||
| if command -v rpm >/dev/null; then | ||
| UTIL_LINUX_VERSION=$(rpm -q --queryformat="%{version}" util-linux) | ||
| UTIL_LINUX_MAJOR_VERSION=$(echo ${UTIL_LINUX_VERSION} | awk -F '.' '{print $1}') | ||
| UTIL_LINUX_MINOR_VERSION=$(echo ${UTIL_LINUX_VERSION} | awk -F '.' '{print $2}') | ||
| # Check that util-linux-2.35 or higher is installed, which includes necessary | ||
| # support for /run/issue.d: https://github.com/karelzak/util-linux/commit/456bcbca6b55fbed33d9f86e69a51abd0e1b8f0b | ||
| if [[ ${UTIL_LINUX_MAJOR_VERSION} -gt 2 ]] || [[ ${UTIL_LINUX_MAJOR_VERSION} -eq 2 && ${UTIL_LINUX_MINOR_VERSION} -ge 35 ]]; then | ||
| SNIPPETS_OUTDIR=/run/issue.d | ||
| GENERATED_FILE_OUTDIR=/run/issue.d | ||
| fi | ||
| fi | ||
|
|
||
| # Make sure the output directories are created upfront, so there is no error | ||
| # writing to them. | ||
| mkdir -p ${SNIPPETS_OUTDIR} ${GENERATED_FILE_OUTDIR} | ||
|
|
||
|
|
||
| # Provide key fingerprints via issue. | ||
| SSH_DIR=/etc/ssh | ||
| # Ensure `${SSH_DIR}` is created and can be searched without error. | ||
| mkdir -p "${SSH_DIR}" | ||
| SSH_KEY_OUTDIR="${SNIPPETS_OUTDIR}" | ||
| for KEY_FILE in $(find "${SSH_DIR}" -name 'ssh_host_*_key') ; do | ||
| ssh-keygen -l -f "${KEY_FILE}" | ||
| done | awk '{print "SSH host key: " $2 " " $4}' > "${SSH_KEY_OUTDIR}/21_ssh_host_keys.issue" | ||
|
|
||
|
|
||
| # Add/remove data from udev rules. | ||
| UDEV_IF_OUTDIR="${SNIPPETS_OUTDIR}" | ||
| case "${ACTION}" in | ||
| add) | ||
| echo "${INTERFACE}: \\4{${INTERFACE}} \\6{${INTERFACE}}" > "${UDEV_IF_OUTDIR}/22_${INTERFACE}.issue" | ||
| ;; | ||
| remove) | ||
| rm -f "${UDEV_IF_OUTDIR}/22_${INTERFACE}.issue" | ||
| ;; | ||
| esac | ||
|
|
||
|
There was a problem hiding this comment. In particular, #7 is tracking this comment - no longer need to mention in the source. |
||
|
|
||
| # Generate a final issue message from compiling the snippets. | ||
| # Pick 40 as a prefix as other files can order around it easily. | ||
| generated_file="${GENERATED_FILE_OUTDIR}/40_${PKG_NAME}.issue" | ||
| generated_string='' | ||
| # Hack around files potentially not existing in the below paths with `|| true`. | ||
| generated_string+=$(cat ${ETC_SNIPPETS}/* 2>/dev/null || true) | ||
| generated_string+=$(cat ${RUN_SNIPPETS}/* 2>/dev/null || true) | ||
| generated_string+=$(cat ${USR_LIB_SNIPPETS}/* 2>/dev/null || true) | ||
|
|
||
| echo "${generated_string}" > "${generated_file}" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm thinking the variable names should not need to distinguish the private/public path, at least for now, since for
issuegenall snippets are written into the "private" directories. Previously,ISSUE_DIR_PUBLICwas unused. The*_SNIPPETSvariables will just refer to the snippet paths that will get read in order to create${generated_file}.For #7, we may allow a choice of using the public or private locations for the snippet locations by invoking e.g.
issuegenorissuegen --legacyrespectively from theconsole-login-helper-messages-issuegen.serviceunit (this choice would be needed for systems that haveutil-linuxversion under 2.35 - e.g. RHCOS). We would probably try to split the ssh, udev, and generated issue parts up and haveSSH_KEY_OUTDIRandUDEV_IF_OUTDIRset to either/run/issue.d(public) or/run/console-login-helper-messages/issue.d(private - i.e. theRUN_SNIPPETSvariable). The private locations would be used for the*_OUTDIRvariables if--legacywas passed. However more discussion can be done on this in #7. In any case, the*_SNIPPETSlocations should be consumed only when creating${generated_file}- the*_SNIPPETSvariables shouldn't need to change after this.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we could either use a config file (like a file in /etc/console-login-helper-messages/foo.conf) to set the paths to output to or we could detect the version of util-linux and switch based on that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
though would we still want to use a private directory for all the snippets and then just write out
generated_fileto the public directory like we do for motdgen in #44There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 a config file would be good at some point. A specfile would make the choice on the output paths set in
/etc/console-login-helper-messages/foo.conf, based on theutil-linuxversion.I'm thinking if a config file is added, we'd want to support an extensible config file format - which would allow on/off configuration for each piece of information (udev interfaces, ssh keys, etc) (#15), and whether the snippets are output in the issue, motd, or other. I've opened this to discuss #45.
For now, going with having
issuegencheck the util-linux version and setSSH_KEY_OUTDIR,UDEV_IF_OUTDIR, andgenerated_fileappropriately seems simplest - this could be default behaviour if a config path was not specified if we added a config file. Will update this PR with the check on the util-linux version and setting the path shortly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now updated with the version check - kept so that the check would only make the switch automatically for RPM-based distributions for now.