What Skarbiec asks you to confirm.
Every warning a Skarbiec functionality declares, as Skarbiec 0.5.0 at b65cf2d8bb982e784f0ad9ebf42a3d08279e4f08 prints it with skarbiec warnings list: what the call would do, what follows from it, how to check first and how to go ahead. A call made without the confirmation answers its warning and changes nothing. Placeholders in braces are filled with the actual names when the warning is answered.
Hazard kinds#
- irreversible: removes or rewrites something nothing in the product restores afterwards.
- overwrites: puts something else in place of the current state; what it replaces is kept only where the warning says.
- cuts-off-access: a person or a program loses access it has now.
- exposes-secret: a secret value leaves the place that protects it: a plain-text file, a screen, another person or system.
- external-change: changes a system outside the product, which the product cannot undo.
- costs-money: spends money.
skarbiec.backup.restore warning vault-replaced#
put a copy of the vault in place of the live vault, keeping the live one beside it. Started by skarbiec backup restore, POST /v1/operator/backup/restore, Desktop: Backups → Restore a backup → Put it in place.
Hazard: overwrites (puts something else in place of the current state; what it replaces is kept only where the warning says). What it does: the live vault {live} is replaced by the copy {backup}, which holds {count} live item(s); {lost_count} live item(s) the copy does not hold go with it: {lost}. What follows: every change made since the copy was taken is replaced; the vault as it is now stays only in <vault>.pre-restore.<stamp> beside it, which this restore names.
Before going ahead: skarbiec backup diff {backup} names every item that differs; skarbiec backup restore <vault>.pre-restore.<stamp> puts the current vault back afterwards. To go ahead: rerun with --yes, or press Put it in place in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/backup/backup.sh::restoring_without_yes_changes_nothing_and_names_the_warning.
skarbiec.ci.set warning secrets-replaced#
set GitHub Actions secrets, one Kubernetes Secret, Vercel environment variables or Cloudflare Workers secrets from the values a bindings file names. Started by skarbiec ci set, skarbiec ci keep, POST /v1/operator/ci-secrets, POST /v1/operator/ci-secrets/keep, Desktop: CI → Actions secrets → Set them, Desktop: CI → Actions secrets → Set and keep them.
Hazard: external-change (changes a system outside the product, which the product cannot undo). What it does: {count} secret(s) are set on {target} {place} from the vault: {secrets}. What follows: a value already held there under any of those names is replaced, and Skarbiec cannot put it back; from then on everything that reads {target}'s secrets reads the vault's values.
Before going ahead: kubectl get secret <name> -n <namespace> -o yaml > <file> keeps a Kubernetes Secret as it is; GitHub keeps no earlier value of an Actions secret, so store any value worth keeping in the vault first; skarbiec bindings check <file> says which item and field each name takes. To go ahead: rerun with --yes, or press Set them or Set and keep them in Skarbiec Desktop's Actions secrets panel.
Without the confirmation nothing is changed; provoked by tests/ci/set.sh::ci_set_without_yes_sets_nothing_and_names_the_warning.
skarbiec.env-import warning bindings-replaced#
store each variable a .env file sets as a token item, and with --bindings write the file exec --env-from reads. Started by skarbiec env import.
Hazard: overwrites (puts something else in place of the current state; what it replaces is kept only where the warning says). What it does: {bindings} is written over with the bindings of the {count} variable(s) {source} sets. What follows: every line it holds now is gone and nothing in Skarbiec keeps a copy, so a program started with skarbiec exec --env-from {bindings} gets only these variables from then on.
Before going ahead: copy {bindings} aside first, or name a new file with --bindings and keep this one. To go ahead: rerun with --replace --yes.
Without the confirmation nothing is changed; provoked by tests/exec/refusals.sh::replacing_an_existing_bindings_file_without_yes_writes_nothing_and_names_the_warning.
skarbiec.lockdown warning every-grant-withdrawn#
withdraw every consumer grant at once, keeping only the consumers named. Started by skarbiec lockdown, POST /v1/operator/lockdown, Desktop: Grants → Withdraw every grant.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: the grants of {count} consumer(s) are withdrawn: {consumers}. What follows: each of them reads nothing from this vault from then on; a withdrawn grant does not come back, and every one of them needs skarbiec grant issue and its new bearer delivered again; kept: {kept}.
Before going ahead: skarbiec grant list > <file> keeps what each consumer was granted, to issue it again; --except <consumer,...> keeps the consumers that must go on reading. To go ahead: rerun with --yes, or press Withdraw them in Skarbiec Desktop's lockdown panel.
Without the confirmation nothing is changed; provoked by tests/lockdown/lockdown.sh::lockdown_without_yes_withdraws_nothing_and_names_the_warning.
skarbiec.login-identity-link warning logins-relinked#
find every login of one account at one identity provider (its context.account_ref, username or email; the provider --via names, or the only one its logins sign in through), make the account's identity with the role named and that provider's site when the vault has none, and, with --yes, name it on each of those logins and move their one working seed and second-factor record onto it; without --yes say what it would do and write nothing. Started by skarbiec login identity link --account <address> [--via <site>] --role <role>, POST /v1/operator/logins/identity/link, Desktop: Accounts → Link logins.
Hazard: overwrites (puts something else in place of the current state; what it replaces is kept only where the warning says). What it does: {count} login(s) of {account} are made to sign in as the identity {identity}, which is made when the vault keeps none: {logins}; the working seed and the second-factor record a login keeps move off it onto the identity (the seed is on {seed_on}). What follows: each of those logins then reads its second factor from the identity alone, and skarbiec login identity unset refuses a login whose seed lives only there; what a login held before stays only among its saved versions.
Before going ahead: read the logins named here, since a login that records {account} without being that account's is linked with the rest; skarbiec history <login> names the stamp skarbiec restore <login> --at <at> takes to put a login back as it was. To go ahead: rerun with --yes, or press Link logins in Skarbiec Desktop's Accounts.
Without the confirmation nothing is changed; provoked by tests/authenticator/identity_link.sh::the_preview_names_what_it_would_do_and_writes_nothing.
skarbiec.purge.item warning removed-for-good#
remove one trashed item and every saved version of it for good. Started by skarbiec purge, POST /v1/operator/items/purge, Desktop: Items → Purge Permanently.
Hazard: irreversible (removes or rewrites something nothing in the product restores afterwards). What it does: {id} and every saved version of it are removed from the vault. What follows: nothing in Skarbiec brings them back: not restore, not restore --at, and its pin, expiry and rotation policy are forgotten with it.
Before going ahead: skarbiec backup <directory> keeps a copy of the vault that skarbiec backup restore puts back; skarbiec history {id} lists the versions that go. To go ahead: rerun with --yes, or press Purge Permanently in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/purge/purge.sh::purge_without_yes_removes_nothing_and_names_the_warning.
skarbiec.purge.trash warning trash-emptied-for-good#
remove every item put in the trash before a moment, with every saved version. Started by skarbiec purge --trashed-before, POST /v1/operator/items/purge-trash, Desktop: Trash → Empty old trash.
Hazard: irreversible (removes or rewrites something nothing in the product restores afterwards). What it does: {count} trashed item(s) put in the trash before {before} are removed with every saved version: {items}. What follows: nothing in Skarbiec brings any of them back, and their pins, expiries and rotation policies are forgotten.
Before going ahead: skarbiec backup <directory> keeps a copy of the vault that skarbiec backup restore puts back; skarbiec restore <id> takes one out of the trash first. To go ahead: rerun with --yes, or confirm Empty old trash in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/purge/purge.sh::emptying_the_trash_without_yes_lists_and_warns.
skarbiec.purge.versions warning versions-forgotten#
remove the saved versions stamped before a moment, keeping current values and later versions. Started by skarbiec purge --versions-before, POST /v1/operator/items/purge-versions, Desktop: Item → Saved versions → Forget versions before a day, Desktop: Settings → Policy → Forget every saved version before a day.
Hazard: irreversible (removes or rewrites something nothing in the product restores afterwards). What it does: the saved versions stamped before {before} are removed from {items}. What follows: restore --at no longer reaches them, and nothing in Skarbiec brings them back; current values and later versions stay.
Before going ahead: skarbiec history <id> lists every stamp that goes; skarbiec backup <directory> keeps a copy that still holds them. To go ahead: rerun with --yes, or confirm Forget versions before a day (one item) or Forget every saved version before a day (every live item) in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/purge/purge.sh::forgetting_versions_without_yes_lists_and_warns.
skarbiec.sources warning source-imported#
find every source on this machine that keeps a secret outside the vault, preview and import it as items, release the source once the vault keeps the value, and forget an import. Started by skarbiec sources, skarbiec sources discover, skarbiec sources preview, skarbiec sources import, skarbiec sources release, skarbiec sources forget, skarbiec sources log, skarbiec sources share, POST /v1/operator/sources.
Hazard: external-change (changes a system outside the product, which the product cannot undo). What it does: every entry {adapter} finds in {source} is stored in the vault as an item tagged skarbiec:source:{adapter}, through the import Skarbiec has for that source, and the import is journaled. What follows: a tool's or a credential helper's own file loses its token as soon as the item reads back, so that tool finds none there and gets it only from Skarbiec from then on; every other source keeps its values until skarbiec sources release {adapter}.
Before going ahead: skarbiec sources preview {adapter} names every entry it would store and prints no value; skarbiec sources forget {adapter} puts what an import stored in the trash. To go ahead: rerun with --yes.
Without the confirmation nothing is changed; provoked by tests/sources/sources.sh::an_import_without_yes_writes_nothing_and_names_the_warning.
skarbiec.sources warning source-released#
find every source on this machine that keeps a secret outside the vault, preview and import it as items, release the source once the vault keeps the value, and forget an import. Started by skarbiec sources, skarbiec sources discover, skarbiec sources preview, skarbiec sources import, skarbiec sources release, skarbiec sources forget, skarbiec sources log, skarbiec sources share, POST /v1/operator/sources.
Hazard: irreversible (removes or rewrites something nothing in the product restores afterwards). What it does: what the vault holds for {adapter} goes out of {source}: the file an import read is removed, or the lines that held a secret are taken out of it or rewritten to read the value from the environment. What follows: nothing in Skarbiec keeps the file as it was, so a program that read the secret from it finds none there and has to be started through skarbiec exec.
Before going ahead: skarbiec list --tag skarbiec:source:{adapter} names the items that hold its values now; a copy of the file made before is the only way back to the file itself. To go ahead: rerun with --yes.
Without the confirmation nothing is changed; provoked by tests/sources/sources.sh::a_release_without_yes_removes_nothing_and_names_the_warning.
skarbiec.sources warning imports-forgotten#
find every source on this machine that keeps a secret outside the vault, preview and import it as items, release the source once the vault keeps the value, and forget an import. Started by skarbiec sources, skarbiec sources discover, skarbiec sources preview, skarbiec sources import, skarbiec sources release, skarbiec sources forget, skarbiec sources log, skarbiec sources share, POST /v1/operator/sources.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: every live item the import(s) {imports} of {adapter} brought in is put in the trash, and the journal records each import as forgotten. What follows: every consumer whose grant names one of them reads nothing for it until it is restored, and a source already released keeps no other copy of the value.
Before going ahead: skarbiec list --tag skarbiec:import:<import> names the items of one import; skarbiec restore --tag skarbiec:import:<import> --yes brings them back. To go ahead: rerun with --yes.
Without the confirmation nothing is changed; provoked by tests/sources/sources.sh::a_forget_without_yes_trashes_nothing_and_names_the_warning.
skarbiec.trash warning consumers-cut-off#
put one item, every live item one tag carries, or every live item nothing used since a moment in the trash. Started by skarbiec delete, POST /v1/operator/items/trash, DELETE /v1/items, Desktop: Items → a selected item → Move to trash, Desktop: Settings → Policy → Tags → Move them to the trash.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: {count} live item(s) are put in the trash: {items}. What follows: every consumer whose grant names one of them reads nothing for it until it is restored, so a program that still needs one fails: {consumers}; the values and every version stay in the trash.
Before going ahead: skarbiec grant list --item <id> names who reads each one; skarbiec restore <id>, or restore --tag <tag>, brings them back. To go ahead: rerun with --yes, or confirm Move them to the trash in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/trash/trash.sh::trashing_a_set_without_yes_moves_nothing_and_names_the_warning.
skarbiec.restore warning consumers-read-again#
bring one item or every trashed item one tag carries back from the trash, or make a saved version the current one. Started by skarbiec restore, POST /v1/operator/items/restore, Desktop: Items → a trashed item → Restore from trash, Desktop: Settings → Policy → Tags → Bring them back, Desktop: Items → a selected item → History → Restore this version.
Hazard: exposes-secret (a secret value leaves the place that protects it: a plain-text file, a screen, another person or system). What it does: {count} trashed item(s) carrying {tag} are put back in the live inventory: {items}. What follows: every consumer whose grant names one of them reads it again from its next request, so an item put in the trash to cut a program off is open to it again: {consumers}.
Before going ahead: skarbiec grant list --item <id> names who reads each one, and skarbiec grant revoke withdraws a grant before they come back; skarbiec delete --tag {tag} puts them back in the trash. To go ahead: rerun with --yes, or confirm Bring them back in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/trash/trash.sh::restoring_a_set_without_yes_restores_nothing_and_names_the_warning.
skarbiec.recipient.remove warning removed-from-every-item#
take one person out of every item, every saved version and the recipient registry. Started by skarbiec recipient remove, POST /v1/operator/recipients/remove, Desktop: Recipients → Remove from vault.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: {uid} is taken out of {count} item(s) and every saved version of them, and out of the recipient registry: {items}. What follows: {uid}'s key opens none of them again, and no command adds them back to the saved versions; a value they already read stays known to them, which is why the items with a rotation policy are marked due.
Before going ahead: skarbiec recipient items {uid} lists what they read; skarbiec revoke <item-id> {uid} takes one item away instead; skarbiec backup <directory> keeps the vault as it is. To go ahead: rerun with --yes, or confirm Remove from vault in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/recipients/withdrawal.sh::recipient_remove_without_yes_changes_nothing_and_names_the_warning.
skarbiec.recipient.rekey warning old-key-retired#
give one recipient a new key and write every live item they read again to it. Started by skarbiec recipient rekey, POST /v1/operator/recipients/rekey, Desktop: Kit → Give them a new key.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: {count} live item(s) {uid} reads are written again to key {to}: {items}. What follows: key {from} opens none of their current values any more, so a device that still holds only {from} reads nothing from them; saved versions stay sealed to {from}.
Before going ahead: make sure {uid} holds the secret half of {to} (skarbiec readers <item-id> names the keys an item is sealed to); skarbiec backup <directory> keeps the vault as it is. To go ahead: rerun with --yes, or press Use this key and rewrite their items in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/recipients/withdrawal.sh::recipient_rekey_without_yes_changes_nothing_and_names_the_warning.
skarbiec.grant.revoke-idle warning idle-grants-withdrawn#
withdraw every consumer grant the audit journal shows unused since a moment. Started by skarbiec grant revoke --idle-since, POST /v1/operator/grants/revoke, Desktop: Grants → Idle grants → Withdraw every grant unused since then.
Hazard: cuts-off-access (a person or a program loses access it has now). What it does: the grants of {count} consumer(s) nothing used since {moment} are withdrawn: {consumers}. What follows: each of them reads nothing from this vault from then on, including one that runs once a year; a withdrawn grant does not come back, and it needs skarbiec grant issue and its new bearer delivered again.
Before going ahead: skarbiec grant list --idle-since {moment} names each with what it was granted; skarbiec grant revoke <consumer> withdraws one at a time. To go ahead: rerun with --yes, or press Withdraw every grant unused since then in Skarbiec Desktop.
Without the confirmation nothing is changed; provoked by tests/grant/idle.sh::grant_revoke_idle_since_without_yes_withdraws_nothing_and_names_the_warning.