GFSEC-SPLIT-GPG(1)

πŸ“¦
version 0.5.1 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– GFSEC-SPLIT-GPG(1) πŸ’–

okay bestie, welcome to the Gfsecret Manual β€” this is the page for gfsec-split-gpg, and it's literally the moment your GnuPG primary private key gets the ✨main character treatment✨. sit down, hydrate, let's go 🫢


🌸 NAME 🌸

gfsec-split-gpg β€” split a GnuPG primary private key πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

gfsec-split [-h|--help] [-v|--version] [-u|--user-id id] [-k|--keep]
            [-c|--config file] [-i|--interactive] [-n|--threshold N]
            URI...

(yes the synopsis says gfsec-split, no that's not a typo on my part, that's just how it is, we don't question it, we respect it πŸ’…)


✨ DESCRIPTION ✨

so gfsec-split-gpg is a wrapper script around gfsec-split β€” its whole job is making it easier to split a GnuPG private primary key into a bunch of shares and then send those shares off to live on external storage supports. spreading the vibe out so no single place holds the whole thing 🧚

and then, once you've done all that, the split key can be temporarily reconstructed with gfsec-use(1). iconic behavior honestly.


πŸ‘‘ OPTIONS πŸ‘‘

  • -h, --help β€” show the help message. the classic. the comfort option. πŸ’–
  • -v, --version β€” show the version message. tell me who you are bestie ⭐
  • -u, --user-id uid β€” split the primary key that belongs to the OpenPGP User ID you name here. you only need this if your GnuPG private keyring is out here holding more than one primary private key β€” like, calm down keyring, pick a lane 😭
  • -k, --keep β€” by default, gfsec-split-gpg will remove the key from the GnuPG keyring once it's been successfully split. use this option to stop that from happening and keep the key around 🫢
  • -c, --config file β€” write the configuration file (the one that lets you reconstruct the secret with gfsec-use(1)) to the file you specify. default is $XDG_CONFIG_HOME/gfsecret/masterkey.conf. and here's the cute bit: if FILE is a single filename with no extension and no directory part, the file gets placed under the $XDG_CONFIG_HOME/gfsecret directory with a .conf extension. so you can be lazy and it'll still sort itself out ✨
  • -i, --interactive β€” give the user an interactive menu so they can pick which shares to create. choose-your-own-adventure but make it cryptography 🌈
  • -n, --threshold N β€” set the minimal number of shares needed to re-assemble the split file. default is 2 πŸ“

πŸ’€ NOTES πŸ’€

this script will only work with GnuPG 2.1 or higher. and fr fr, it will abort before attempting anything if it can't detect a binary for the correct GnuPG version. it checks first, it does not gamble. no cap.

πŸŽ€ EXAMPLE INVOCATION πŸŽ€

gfsec-split-gpg alice \
  file:///home/alice/.local/share/gfsecret/mykey \
  label://USBSTICK/mykey \
  mtp://RF2GB6X704P/Documents/mykey \

so what's happening in this little masterpiece? the example above splits Alice's primary private key into three shares:

  1. one on the local filesystem πŸ’Ύ
  2. one on the USB mass storage device with the label USBSTICK πŸ”Œ
  3. one on the MTP-compliant device with the serial RF2GB6X704P πŸ“±

and a configuration file will be written in $XDG_CONFIG_HOME/gfsecret/mysecret, which lets you automatically reconstruct the file with gfsec-use(1) β€” provided at least one of the two removable supports is present. two out of three? we ride. πŸ‘‘


πŸ™ˆ REPORTING BUGS πŸ™ˆ

report bugs to Damien Goutte-Gattat. be nice, be specific, include the details 🫢


πŸ”₯ SEE ALSO πŸ”₯


Copyright Β© 2017 Damien Goutte-Gattat

this program is released under the GNU General Public License. see the COPYING file in the source distribution or http://www.gnu.org/licenses/gpl.html. πŸ’œ


and that's the whole page bestie!! this was gfsecret 0.5.1, dated 2017-08-26, from the Gfsecret Manual β€” mwah, go split that key responsibly, stay hydrated, and remember: threshold 2 is the default but your standards are not πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from