-
Notifications
You must be signed in to change notification settings - Fork 107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
passing args to 'cryptsetup open' #317
Merged
sergio-correia
merged 3 commits into
latchset:master
from
somewhere-or-other:clevis_unlock_params_pullrq
Feb 6, 2023
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
@@ -0,0 +1,68 @@ | ||
#!/bin/bash -ex | ||
# vim: set ts=8 shiftwidth=4 softtabstop=4 expandtab smarttab colorcolumn=80: | ||
# | ||
# 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 3 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, see <http://www.gnu.org/licenses/>. | ||
|
||
TEST=$(basename "${0}") | ||
. tests-common-functions | ||
|
||
. clevis-luks-common-functions | ||
|
||
on_exit() { | ||
[ ! -d "${TMP}" ] && return 0 | ||
tang_stop "${TMP}" | ||
rm -rf "${TMP}" | ||
} | ||
|
||
trap 'on_exit' EXIT | ||
trap 'on_exit' ERR | ||
|
||
TMP="$(mktemp -d)" | ||
|
||
port=$(tang_new_random_port) | ||
tang_run "${TMP}" "${port}" | ||
|
||
url="http://localhost:${port}" | ||
adv="${TMP}/adv" | ||
tang_get_adv "${port}" "${adv}" | ||
|
||
cfg=$(printf '{"url":"%s","adv":"%s"}' "$url" "$adv") | ||
|
||
DEV="${TMP}/luks1-device" | ||
new_device "luks1" "${DEV}" | ||
|
||
if ! clevis luks bind -f -d "${DEV}" tang "${cfg}" <<< "${DEFAULT_PASS}"; then | ||
error "${TEST}: Bind should have succeeded." | ||
fi | ||
|
||
TESTPARAM="arbitrarytestparameter" | ||
|
||
#set up a "cryptsetup" function, to hijack the command | ||
cryptsetup () { | ||
#need to handle "cryptsetup isLuks" from clevis-luks-unlock, among others | ||
if [[ $1 == "isLuks" ]]; then | ||
exit 0; | ||
elif [[ $1 == "luksUUID" ]]; then | ||
echo "TESTINGLUKSUUID" | ||
exit 0; | ||
else | ||
echo "$*" | grep -q -- "${TESTPARAM}" | ||
exit $? | ||
fi | ||
} | ||
export -f cryptsetup | ||
|
||
if ! clevis-luks-unlock -o "$TESTPARAM" -d ${DEV} -n clevis_unlock_test; then | ||
error "${TEST}: clevis luks unlock did not match arbitrary test parameter \"$TESTPARAM\"." | ||
fi |
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 considered putting the new
${OPENARGS}
in double-quotes, but was concerned about what would happen if someone wanted to include a space in their parameter string, like passing two different parameters (eg.-a -b
, as a contrived example), or a space-separated name/value pair. From my tests, it seemed as though enclosing${OPENARGS}
in double-quotes, madecryptsetup
consider it a single parameter that happened to contain spaces.For my personal use, I only had one parameter to pass, so it would work either way. I just wanted to make a solution for a more general use case.
If there's a better way to handle this, I'm happy to take suggestions.
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.
Yes, I had not considered about the issues when using quotes. So change looks good to me.
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.
If I'm being honest, I did put it in quotes in a private/dev repo, and discovered the problem, before removing them, and subsequently squashing/rebasing everything into a single pull request.
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.
Nice. In my opinion, it can be merged, but let's wait for @sergio-correia to review it.
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.
As additional improvement, it would be nice to add a test to src/luks/tests to simulate a call to clevis-luks-unlock with a cryptsetup option
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.
@sarroutbi I've just submitted an initial attempt at a test. Basically it just uses a bash function to hijack cryptsetup temporarily, and verifies that the arbitrary value makes it through.
It's very possible I've done something incorrectly, though, so don't just take my word for it. Took me a while to figure out the testing/development environment. And that's why I'm mostly a sysadmin, not a developer.