CF-KEY(8)

📦
version 3.24.1 · 2 versions
, in debian trixie

💖 CF-KEY(8) — bestie's guide to making key-pairs 💖

okay so hi. this is the System Manager's Manual page for cf-key, and if you're setting up CFEngine trust stuff, this is literally your girl. she makes private/public key-pairs for CFEngine authentication. that's it. that's the job. no cap. 🔑

✨ NAME ✨

cf-key — make private/public key-pairs for CFEngine authentication 🗝️✨

🎀 SYNOPSIS 🎀

cf-key [OPTION]...

that's the whole vibe. you give her options, she gives you keys. periodt.

🦋 DESCRIPTION 🦋

The CFEngine key generator makes key pairs for remote authentication. 💅

like. it's the bouncer at the club door, but the club is your infrastructure and the guest list is cryptographic. obsessed honestly.

🌸 OPTIONS 🌸

  • --help, -h — Print the help message. your emotional support flag 🫶
  • --inform, -I — Print basic information about key generation. the tea, but the short version ☕
  • --debug, -d — Enable debugging output. turn this on when everything is on fire and you need to know why 🔥
  • --verbose, -v — Output verbose information about the behaviour of cf-key. she will NOT stop talking and honestly? good for her 💬
  • --version, -V — Output the version of the software. so you know exactly which era of cf-key you're dealing with 👑
  • --log-level, -g value — Specify how detailed logs should be. Possible values: 'error', 'warning', 'notice', 'info', 'verbose', 'debug'. pick your level of yapping 📢
  • --output-file, -f value — Specify an alternative output file than the default. not like other output files 💁
  • --key-type, -T value — Specify a RSA key size in bits, the default value is 2048. bigger = more bits = more secure, and also more math 🧮
  • --show-hosts, -s — Show lastseen hostnames and IP addresses. the who's-who of your network 🌈
  • --no-truncate, -N — Don't truncate -s / --show-hosts output. she said FULL names, no abbreviations 💅
  • --remove-keys, -r value — Remove keys for specified hostname/IP/MD5/SHA (cf-key -r SHA=12345, cf-key -r MD5=12345, cf-key -r host001, cf-key -r 203.0.113.1). block and delete bestie 🚫
  • --force-removal, -x — Force removal of keys. no second thoughts, no takebacks 😤
  • --install-license, -l value — Install license file on Enterprise server (CFEngine Enterprise Only). enterprise girlies only, sorry 🙈
  • --print-digest, -p value — Print digest of the specified public key. fingerprint reveal ✨
  • --trust-key, -t value — Make cf-serverd/cf-agent trust the specified public key. Argument value is of the form [[USER@]IPADDR:]FILENAME where FILENAME is the local path of the public key for client at IPADDR address. this is the "you're in the group chat now" moment 🫶
  • --color, -C value — Enable colorized output. Possible values: 'always', 'auto', 'never'. If option is used, the default value is 'auto'. aesthetics MATTER 🎀
  • --timestamp, -Ò — Log timestamps on each line of log output. so you know exactly WHEN the chaos happened ⏰
  • --numeric, -n — Do not lookup host names. just give me the numbers, i don't need the drama 🔢
ngl, note that -Ò up there in --timestamp is not a typo on my part — it's really written like that in the manual. type it exactly. 💀

👑 CFENGINE 👑

CFEngine provides automated configuration management of large-scale computer systems. A system administrator describes the desired state of a system using CFEngine policy code. The program cf-agent reads policy code and attempts to bring the current system state to the desired state described. Policy code is downloaded by cf-agent from a cf-serverd daemon. The daemon cf-execd is responsible for running cf-agent periodically.

Documentation for CFEngine is available at https://docs.cfengine.com/. 🌐

🌈 PROMISE THEORY 🌈

CFEngine is built on principles from promise theory, proposed by Mark Burgess in 2004. Promise theory is a model of voluntary cooperation between individual, autonomous actors or agents who publish their intentions to one another in the form of promises. A promise is a declaration of intent whose purpose is to increase the recipient's certainty about a claim of past, present or future behaviour. For a promise to increase certainty, the recipient needs to trust the promiser, but trust can also be built on the verification that previous promises have been kept, thus trust plays a symbiotic relationship with promises.

For an introduction to promise theory, please see http://arxiv.org/abs/0810.3294/ 📚

⭐ AVAILABILITY ⭐

cf-key is part of CFEngine.

Binary packages may be downloaded from https://cfengine.com/download/.

The source code is available at https://github.com/cfengine/ 💻

💀 BUGS 💀

Please see the public bug-tracker at https://northerntech.atlassian.net/projects/CFE/.

GitHub pull-requests may be submitted to https://github.com/cfengine/core/. 🐛 (not the cute kind of bug. the "why is prod down" kind.)

🧚 SEE ALSO 🧚

cf-promises(8), cf-agent(8), cf-serverd(8), cf-execd(8), cf-monitord(8), cf-runagent(8), cf-key(8)

(yes, cf-key(8) is referring to herself in the see-also list. main character energy, honestly. 💅)

💜 AUTHOR 💜

Mark Burgess and Northern.tech AS

okay bestie that's the whole page, you're officially certified 🎓✨

this came out of the System Administration corner of the CFEngine manual, so big ups to CFEngine for keeping it real, and that's the sign-off — xoxo, go make some keys 💖🔐

📦 where this page comes from