CMSUTIL(1)

πŸ’– CMSUTIL(1) β€” the NSS Security Tools girlies πŸ’–

okay so bestie, welcome to cmsutil, a lil member of the NSS Security Tools family πŸŽ€ she does basic cryptographic operations β€” encryption, decryption, that whole vibe β€” on Cryptographic Message Syntax (CMS) messages.


✨ NAME ✨

cmsutil β€” Performs basic cryptograpic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages. πŸ¦‹


🌸 SYNOPSIS 🌸

cmsutil [options] [[arguments]]

πŸ‘‘ STATUS πŸ‘‘

ngl, this documentation is still work in progress. Please contribute to the initial review in Mozilla NSS bug 836477[1] β€” she's a work in progress and the link is down in NOTES if you wanna help a girl out 🫢


πŸ’… DESCRIPTION πŸ’…

The cmsutil command-line uses the S/MIME Toolkit to perform basic operations, such as encryption and decryption, on Cryptographic Message Syntax (CMS) messages.

To run cmsutil, type the command cmsutil option [arguments] where option and arguments are combinations of the options and arguments listed in the following section. Each command takes one option. Each option may take zero or more arguments. To see a usage string, issue the command without options. no cap, that's literally the whole thing 🌈


🌟 OPTIONS AND ARGUMENTS 🌟

πŸ“ Options

Options specify an action. Option arguments modify an action. The options and arguments for the cmsutil command are defined as follows:

  • -C β€” Encrypt a message. πŸ”’
  • -D β€” Decode a message. πŸ”“
  • -E β€” Envelope a message. βœ‰οΈ
  • -O β€” Create a certificates-only message. πŸ“œ
  • -S β€” Sign a message. ✍️

🧚 Arguments

Option arguments modify an action.

  • -b β€” Decode a batch of files named in infile.
  • -c content β€” Use this detached content (decode only).
  • -d dbdir β€” Specify the key/certificate database directory (default is ".")
  • -e envfile β€” Specify a file containing an enveloped message for a set of recipients to which you would like to send an encrypted message. If this is the first encrypted message for that set of recipients, a new enveloped message will be created that you can then use for future messages (encrypt only).
  • -f pwfile β€” Use password file to set password on all PKCS#11 tokens.
  • -G β€” Include a signing time attribute (sign only).
  • -H hash β€” Use specified hash algorithm (default:SHA1).
  • -h num β€” Generate email headers with info about CMS message (decode only).
  • -i infile β€” Use infile as a source of data (default is stdin).
  • -k β€” Keep decoded encryption certs in permanent cert db.
  • -N nickname β€” Specify nickname of certificate to sign with (sign only).
  • -n β€” Suppress output of contents (decode only).
  • -o outfile β€” Use outfile as a destination of data (default is stdout).
  • -P β€” Include an S/MIME capabilities attribute.
  • -p password β€” Use password as key database password.
  • -r recipient1,recipient2, ... β€” Specify list of recipients (email addresses) for an encrypted or enveloped message. For certificates-only message, list of certificates to send.
  • -T β€” Suppress content in CMS message (sign only).
  • -u certusage β€” Set type of cert usage (default is certUsageEmailSigner).
  • -v β€” Print debugging information. πŸ›
  • -Y ekprefnick β€” Specify an encryption key preference by nickname.

πŸŽ€ USAGE πŸŽ€

Encrypt Example

cmsutil -C [-i infile] [-o outfile] [-d dbdir] [-p password] -r "recipient1,recipient2, . . ." -e envfile

Decode Example

cmsutil -D [-i infile] [-o outfile] [-d dbdir] [-p password] [-c content] [-n] [-h num]

Envelope Example

cmsutil -E [-i infile] [-o outfile] [-d dbdir] [-p password] -r "recipient1,recipient2, ..."

Certificate-only Example

cmsutil -O [-i infile] [-o outfile] [-d dbdir] [-p password] -r "cert1,cert2, . . ."

Sign Message Example

cmsutil -S [-i infile] [-o outfile] [-d dbdir] [-p password] -N nickname[-TGP] [-Y ekprefnick]

πŸ¦‹ SEE ALSO πŸ¦‹

certutil(1) β€” go give her a read too, they're besties fr fr πŸ’œ


🌈 ADDITIONAL RESOURCES 🌈

For information about NSS and other tools related to NSS (like JSS), check out the NSS project wiki at http://www.mozilla.org/projects/security/pki/nss/. The NSS site relates directly to NSS code changes and releases.

Mailing lists: https://lists.mozilla.org/listinfo/dev-tech-crypto

IRC: Freenode at #dogtag-pki


πŸ’œ AUTHORS πŸ’œ

The NSS tools were written and maintained by developers with Netscape, Red Hat, Sun, Oracle, Mozilla, and Google. iconic honestly πŸ‘‘

Authors: Elio Maldonado <emaldona@redhat.com>, Deon Lackey <dlackey@redhat.com>.


⭐ LICENSE ⭐

Licensed under the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.


πŸ“ NOTES πŸ“

  1. Mozilla NSS bug 836477 https://bugzilla.mozilla.org/show_bug.cgi?id=836477

this page is from the nss-tools era, dated 5 June 2014 β€” vintage but still serving looks πŸ’…βœ¨ that's the whole manpage bestie, periodt πŸ’–πŸ¦‹
πŸ“¦ where this page comes from