xsec-xklient.pod(1)

💖 xmlsec-xklient — a Gen Z field guide 💖

okay bestie, so this is a page from the Apache XML Security manual set, and it's all about xmlsec-xklient, the client for an XKMS service. XKMS = XML Key Management Specification, and this little icon is your general-purpose client for web services that speak it. let's get into it 🫶

---

✨ NAME ✨

xmlsec-xklient — Client for an XKMS service

---

🌸 SYNOPSIS 🌸

xmlsec-xklient [-t] msgdump [options] filename

xmlsec-xklient [-t] msgcreate LocateRequest [options]

xmlsec-xklient [-t] dorequest [options] type [options]

---

🦋 DESCRIPTION 🦋

xmlsec-xklient is a general client for web services that follows the XML Key Management Specification (XKMS). It supports three basic operations, and they're each kinda their own whole vibe:

• msgdump — you hand it an input file name containing an XKMS message, and it dumps that message to standard output. that's it, that's the job. 💅
• msgcreate — it creates an XKMS message and prints the resulting message to standard output. the only supported message type to create is "LocateRequest" or "lr".
• dorequest — it sends an XKMS request. the request type is one of:

CompoundRequest (cr)
LocateRequest   (lr)
ValidateRequest (vr)
PendingRequest  (pr)
RegisterRequest (rr)
ReissueRequest  (ir)
RecoverRequest  (or)
RevokeRequest   (er)

Each of these three operations has its own special command-line options that you can give after the operation, and each of the XKMS request types has its own set of options to specify what goes into the request. no cap.

Each operation supports the -h or --help flag to print out usage for that particular operation and — in the case of "dorequest" — that operation and request type. so if you're lost, -h is your bestie fr fr.

not me telling you that all the specific per-operation options are (yet) not documented in this manual page 🙈 use the -h or --help option to get more usage information for the operation you want to perform. it's giving "figure it out, queen," but at least the help text has your back.

---

👑 OPTIONS 👑

This section only documents the general options that are supported before the operation type. the rest? not here yet, as established. 😭

• --text, -t — print out any created XML when performing any of the other operations. basically "show me the receipts." 🔥

---

🌈 AUTHOR 🌈

This manual page was written by Russ Allbery for Debian.

---

💜 MANUAL LICENSE 💜

The authors hereby relinquish any claim to any copyright that they may have in this work, whether granted under contract or by operation of law or international treaty, and hereby commit to the public, at large, that they shall not, at any time in the future, seek to enforce any copyright in this work against any person or entity, or prevent any person or entity from copying, publishing, distributing or creating derivative works of this work.

(translation: it's free, take it, remix it, no drama, no lawyers. iconic behaviour honestly. ✨)

---

k that's the whole page bestie — this was version 2.0.4, dated 2021-12-03, from the Apache XML Security manual set. go forth and manage those keys. periodt. 💅🎀