CRYPT-XORDATAEXCHANGE(1)

πŸ’– CRYPT-XORDATAEXCHANGE πŸ’–

okay bestie, welcome to the General Commands Manual entry for CRYPT-XORDATAEXCHANGE(1) β€” yes that's a whole mouthful, we're just gonna call her crypt from here on, mwah πŸ’…


✨ NAME ✨

crypt-xordataexchange β€” store and retrieve encrypted configuration parameters from etcd or Consul πŸ¦‹


πŸ“œ SYNOPSIS πŸ“œ

no cap, here's the whole shape of it:

crypt-xordataexchange get [arg...] key
crypt-xordataexchange list [arg...] key
crypt-xordataexchange set [arg...] key file

three little verbs, three little vibes. that's it. that's the whole girlboss pipeline πŸ’–


🌸 DESCRIPTION 🌸

okay so, real talk. fess up. you have passwords and usernames hard coded in your apps. you have IP addresses checked in to your source code repository. you have entire configuration files that were created by the developer who wrote the app and haven't been changed since she typed git init. 😭

and like… we've all been there, but bestie, it's giving security nightmare. πŸ™ˆ

crypt (aka crypt-xordataexchange) is here to lead you back to the Path of Enlightened Configuration. ✨ store encrypted configuration values in etcd or Consul using a command-line application. that's the whole thing. iconic, honestly. πŸ‘‘


πŸŽ€ COMMANDS πŸŽ€

the three moves. learn them, love them, use them 🫢

  • get β€” retrieve the value of a key
  • list β€” retrieve all values under a key
  • set β€” set the value of a key

πŸ‘‘ OPTIONS πŸ‘‘

every single flag, no skips, no cuts, we're thorough in this house πŸ’…

  • -backend="etcd" β€” backend provider. the default is "etcd", so if you say nothing, etcd is what you get 🧚
  • -endpoint="" β€” backend URL. default is empty, empty string, nothing, nada 🌸
  • -keyring=".pubring.gpg" β€” path to armored public keyring. for set only ⚠️ (she's the one who locks things up, so yeah, only the writer needs her)
  • -secret-keyring=".secring.gpg" β€” path to armored secret keyring. for get and list only ⚠️ (she's the one who unlocks things, so only the readers need her)
  • -plaintext=false β€” don't encrypt or decrypt the values before storage or retrieval. default is false. flip her to true and it's just… raw text out here, so know what you're doing, bestie πŸ’€

Copyright Β© 2014 XOR Data Exchange, Inc.

Distributed under the MIT License.

periodt. that's the legal bit, and we respect it. πŸŽ€


πŸ¦‹ SEE ALSO πŸ¦‹

iykyk β€” go read the docs, they're right there πŸ’–


and that's a wrap on the CRYPT-XORDATAEXCHANGE(1) page from the General Commands Manual, dated September 2015 β€” thank you for coming to my ted talk, go encrypt your configs, slay, bye bestie πŸ‘‘πŸ’…βœ¨