Skip to content

Commit

Permalink
storage: Move some crypto utils into their own file
Browse files Browse the repository at this point in the history
  • Loading branch information
mvollmer committed Feb 29, 2024
1 parent 6c0ff2c commit dc33b9c
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 65 deletions.
3 changes: 2 additions & 1 deletion pkg/storaged/block/format-dialog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import cockpit from "cockpit";
import client from "../client.js";

import {
edit_crypto_config, parse_options, unparse_options, extract_option,
parse_options, unparse_options, extract_option,
get_parent_blocks, is_netdev,
decode_filename, encode_filename, block_name,
get_active_usage, reload_systemd, teardown_active_usage,
Expand All @@ -42,6 +42,7 @@ import {

import { get_fstab_config, is_valid_mount_point } from "../filesystem/utils.jsx";
import { init_existing_passphrase, unlock_with_type } from "../crypto/keyslots.jsx";
import { edit_crypto_config } from "../crypto/utils.jsx";
import { job_progress_wrapper } from "../jobs-panel.jsx";
import { at_boot_input, mount_options } from "../filesystem/mounting-dialog.jsx";
import { remember_passphrase } from "../anaconda.jsx";
Expand Down
2 changes: 1 addition & 1 deletion pkg/storaged/crypto/actions.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import cockpit from "cockpit";
import client from "../client";

import { get_existing_passphrase, unlock_with_type } from "./keyslots.jsx";
import { set_crypto_auto_option } from "../utils.js";
import { dialog_open, PassInput } from "../dialog.jsx";
import { remember_passphrase } from "../anaconda.jsx";
import { set_crypto_auto_option } from "./utils.jsx";

const _ = cockpit.gettext;

Expand Down
3 changes: 2 additions & 1 deletion pkg/storaged/crypto/encryption.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ import * as python from "python.js";
import * as timeformat from "timeformat.js";

import { dialog_open, TextInput, PassInput } from "../dialog.jsx";
import { block_name, encode_filename, decode_filename, parse_options, unparse_options, extract_option, edit_crypto_config } from "../utils.js";
import { block_name, encode_filename, decode_filename, parse_options, unparse_options, extract_option } from "../utils.js";
import { StorageCard, StorageDescription, new_card } from "../pages.jsx";
import luksmeta_monitor_hack_py from "./luksmeta-monitor-hack.py";
import { is_mounted } from "../filesystem/utils.jsx";
import { StorageLink } from "../storage-controls.jsx";
import { CryptoKeyslots } from "./keyslots.jsx";
import { edit_crypto_config } from "./utils.jsx";

const _ = cockpit.gettext;

Expand Down
3 changes: 2 additions & 1 deletion pkg/storaged/crypto/keyslots.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,12 @@ import {
dialog_open,
SelectOneRadio, TextInput, PassInput, Skip
} from "../dialog.jsx";
import { decode_filename, encode_filename, get_block_mntopts, block_name, for_each_async, get_children, parse_options, unparse_options, edit_crypto_config } from "../utils.js";
import { decode_filename, encode_filename, get_block_mntopts, block_name, for_each_async, get_children, parse_options, unparse_options } from "../utils.js";
import { StorageButton } from "../storage-controls.jsx";

import clevis_luks_passphrase_sh from "./clevis-luks-passphrase.sh";
import { validate_url, get_tang_adv, TangKeyVerification } from "./tang.jsx";
import { edit_crypto_config } from "./utils.jsx";

const _ = cockpit.gettext;

Expand Down
79 changes: 79 additions & 0 deletions pkg/storaged/crypto/utils.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
* This file is part of Cockpit.
*
* Copyright (C) 2024 Red Hat, Inc.
*
* Cockpit is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* Cockpit 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
*/

import { encode_filename, decode_filename, parse_options, extract_option, unparse_options } from "../utils.js";

export function edit_crypto_config(block, modify) {
let old_config, new_config;

function commit() {
new_config[1]["track-parents"] = { t: 'b', v: true };
if (old_config)
return block.UpdateConfigurationItem(old_config, new_config, { });
else
return block.AddConfigurationItem(new_config, { });
}

return block.GetSecretConfiguration({}).then(
function (items) {
old_config = items.find(c => c[0] == "crypttab");
new_config = ["crypttab", old_config ? Object.assign({ }, old_config[1]) : { }];

// UDisks insists on always having a "passphrase-contents" field when
// adding a crypttab entry, but doesn't include one itself when returning
// an entry without a stored passphrase.
//
if (!new_config[1]['passphrase-contents'])
new_config[1]['passphrase-contents'] = { t: 'ay', v: encode_filename("") };

return modify(new_config[1], commit);
});
}

export function set_crypto_options(block, readonly, auto, nofail, netdev) {
return edit_crypto_config(block, (config, commit) => {
const opts = config.options ? parse_options(decode_filename(config.options.v)) : [];
if (readonly !== null) {
extract_option(opts, "readonly");
if (readonly)
opts.push("readonly");
}
if (auto !== null) {
extract_option(opts, "noauto");
if (!auto)
opts.push("noauto");
}
if (nofail !== null) {
extract_option(opts, "nofail");
if (nofail)
opts.push("nofail");
}
if (netdev !== null) {
extract_option(opts, "_netdev");
if (netdev)
opts.push("_netdev");
}
config.options = { t: 'ay', v: encode_filename(unparse_options(opts)) };
return commit();
});
}

export function set_crypto_auto_option(block, flag) {
return set_crypto_options(block, null, flag, null, null);
}
3 changes: 2 additions & 1 deletion pkg/storaged/filesystem/mismounting.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { Alert } from "@patternfly/react-core/dist/esm/components/Alert/index.js
import {
encode_filename,
parse_options, unparse_options, extract_option, reload_systemd,
set_crypto_auto_option, get_mount_points,
get_mount_points,
} from "../utils.js";
import { StorageButton } from "../storage-controls.jsx";
import { set_crypto_auto_option } from "../crypto/utils.jsx";

import { mounting_dialog } from "./mounting-dialog.jsx";
import { get_cryptobacking_noauto } from "./utils.jsx";
Expand Down
3 changes: 2 additions & 1 deletion pkg/storaged/filesystem/mounting-dialog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import client from "../client.js";
import {
encode_filename,
parse_options, unparse_options, extract_option, reload_systemd,
set_crypto_options, is_mounted_synch,
is_mounted_synch,
get_active_usage, teardown_active_usage,
} from "../utils.js";

Expand All @@ -35,6 +35,7 @@ import {
} from "../dialog.jsx";
import { init_existing_passphrase, unlock_with_type } from "../crypto/keyslots.jsx";
import { initial_tab_options, mount_explanation } from "../block/format-dialog.jsx";
import { set_crypto_options } from "../crypto/utils.jsx";

import {
is_mounted, get_fstab_config,
Expand Down
59 changes: 0 additions & 59 deletions pkg/storaged/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,65 +70,6 @@ export function extract_option(split, opt) {
}
}

export function edit_crypto_config(block, modify) {
let old_config, new_config;

function commit() {
new_config[1]["track-parents"] = { t: 'b', v: true };
if (old_config)
return block.UpdateConfigurationItem(old_config, new_config, { });
else
return block.AddConfigurationItem(new_config, { });
}

return block.GetSecretConfiguration({}).then(
function (items) {
old_config = items.find(c => c[0] == "crypttab");
new_config = ["crypttab", old_config ? Object.assign({ }, old_config[1]) : { }];

// UDisks insists on always having a "passphrase-contents" field when
// adding a crypttab entry, but doesn't include one itself when returning
// an entry without a stored passphrase.
//
if (!new_config[1]['passphrase-contents'])
new_config[1]['passphrase-contents'] = { t: 'ay', v: encode_filename("") };

return modify(new_config[1], commit);
});
}

export function set_crypto_options(block, readonly, auto, nofail, netdev) {
return edit_crypto_config(block, (config, commit) => {
const opts = config.options ? parse_options(decode_filename(config.options.v)) : [];
if (readonly !== null) {
extract_option(opts, "readonly");
if (readonly)
opts.push("readonly");
}
if (auto !== null) {
extract_option(opts, "noauto");
if (!auto)
opts.push("noauto");
}
if (nofail !== null) {
extract_option(opts, "nofail");
if (nofail)
opts.push("nofail");
}
if (netdev !== null) {
extract_option(opts, "_netdev");
if (netdev)
opts.push("_netdev");
}
config.options = { t: 'ay', v: encode_filename(unparse_options(opts)) };
return commit();
});
}

export function set_crypto_auto_option(block, flag) {
return set_crypto_options(block, null, flag, null, null);
}

export let hostnamed = cockpit.dbus("org.freedesktop.hostname1").proxy();

// for unit tests
Expand Down

0 comments on commit dc33b9c

Please sign in to comment.