CERTMONGER(1)

✨ CERTMONGER ✨

okay bestie, sit down, hydrate, because we're reading CERTMONGER(1) together and it's a whole journey. This is part one of the manual, so no, we're not done yet, don't touch that scroll wheel. πŸ’…


πŸŽ€ NAME πŸŽ€

getcert

that's it. that's the name. short, iconic, does exactly what it says on the tin. πŸ‘‘


🌸 SYNOPSIS 🌸

getcert list [options]

πŸ’– DESCRIPTION πŸ’–

so basically certmonger is out here keeping an eye on your certificates, right? and getcert list is the move where you go "hey bestie, what are you monitoring, what are you trying to get" and it just tells you. it queries certmonger for a list of the certificates it's monitoring, or the ones it's actively trying to obtain. that's the whole vibe. no cap. πŸ¦‹


πŸŽ€ ENROLLMENT OPTIONS πŸŽ€

these are the options that filter by who's issuing the thing.

  • -c NAME, --ca=NAME β€” only show you the entries that use the CA you named. and heads up: the name you put here should be one that getcert list-cas actually lists, so if you're out here making up CA names, that's on you. πŸ™ˆ

πŸ’… LISTING OPTIONS πŸ’…

now the fun part, the filters. pick your fighter.

  • -r, --requests-only β€” only lists the entries that are currently being enrolled or refreshed. the busy ones. the main characters. πŸ”₯
  • -t, --tracking-only β€” the opposite vibe: only lists entries that are not currently being enrolled or refreshed. the chill ones, just vibing, being watched. 😌
  • -u, --utc β€” timestamps in UTC instead of local time. for when you want your times in the universal language. ✨
  • -d DIR, --dbdir=DIR β€” only lists entries using an NSS database in the directory you specify, for storing the certificate. tell it where the db lives and it'll narrow it down. πŸ—‚οΈ
  • -n NAME, --nickname=NAME β€” only lists tracking requests that use an NSS database and the nickname you give, for storing the certificate. two conditions, one flag. slay. πŸŽ€
  • -f FILE, --certfile=FILE β€” only lists tracking requests that say the certificate should be stored in the file you name. πŸ“„
  • -i NAME, --id=NAME β€” only lists tracking requests that use this request nickname. this one's the request's own little name tag. 🏷️

🌈 STATES 🌈

okay this is the big one. certmonger is a whole pipeline girlie and every request moves through states. here's every single one, in order, no skips, because we don't do skipping. πŸ’―

  • NEED_KEY_PAIR β€” the service is about to generate a brand new key pair. getting ready to cook. πŸ”‘
  • GENERATING_KEY_PAIR β€” the service is currently generating that new key pair. it's happening. right now. πŸ”₯
  • NEED_KEY_GEN_PERMS β€” the service hit a filesystem permission error while trying to save the freshly generated key pair. rude. 😭
  • NEED_KEY_GEN_PIN β€” the service is missing the PIN it needs to get into an NSS database so it can save the new key pair, or the PIN it has for a database is wrong. 😬
  • NEED_KEY_GEN_TOKEN β€” the service couldn't find a suitable token to use for generating the new key pair. the token is missing. gone. not here. 🫠
  • HAVE_KEY_PAIR β€” key pair generated successfully. we ate. βœ…
  • NEED_KEYINFO β€” the service needs to read info about the key pair. πŸ“–
  • READING_KEYINFO β€” the service is currently reading that key pair info. πŸ‘€
  • NEED_KEYINFO_READ_PIN β€” the service is missing the PIN it needs to access an NSS database to read info about the newly generated key pair, or the PIN it has for a database is wrong, or it has the wrong password for accessing a key stored in encrypted PEM format. three ways to be locked out, pick your poison. πŸ”
  • NEED_KEYINFO_READ_TOKEN β€” the service couldn't find the token where the key pair is supposed to be stored. where did it go. nobody knows. πŸ’€
  • HAVE_KEYINFO β€” key pair info successfully read. we know things now. 🧠
  • NEED_CSR β€” the service is about to generate a new signing request. πŸ“
  • GENERATING_CSR β€” the service is generating a signing request. as we speak. ✍️
  • NEED_CSR_GEN_PIN β€” the service is missing the PIN it needs to access an NSS database in order to use the key pair, or the PIN it has for a database is wrong, or it has the wrong password for reading a key stored in encrypted PEM format. again. πŸ”
  • NEED_CSR_GEN_TOKEN β€” the service couldn't find the token where the key pair is supposed to be stored. token, where art thou. πŸ«₯
  • HAVE_CSR β€” signing request generated successfully. periodt. βœ…
  • NEED_SCEP_DATA β€” the service is about to generate the data specifically needed for connecting to a CA using SCEP. πŸ›°οΈ
  • GENERATING_SCEP_DATA β€” the service is generating that SCEP-connection data. it's in the lab. πŸ§ͺ
  • NEED_SCEP_GEN_PIN β€” the service is missing the PIN it needs to access an NSS database in order to use the key pair, or the PIN it has for a database is wrong, or it has the wrong password for reading a key stored in encrypted PEM format. (this PIN situation is giving recurring villain honestly) πŸ”
  • NEED_SCEP_GEN_TOKEN β€” the service couldn't find the token where the key pair is supposed to be stored. yes, again. πŸ«₯
  • NEED_SCEP_ENCRYPTION_CERT β€” the service is waiting until it can retrieve a copy of the CA's certificate before it can generate the data it needs to connect to the CA using SCEP. it's just waiting. patiently. mostly. ⏳
  • NEED_SCEP_RSA_CLIENT_KEY β€” so the CA should be contacted using SCEP, but SCEP requires the client key pair to be an RSA key pair, and this one is not. mismatch moment. 😡
  • HAVE_SCEP_DATA β€” SCEP data generated successfully. we move. βœ…
  • NEED_TO_SUBMIT β€” the service is about to submit a signing request to a CA for signing. fingers crossed. 🀞
  • SUBMITTING β€” the service is currently submitting that signing request to a CA for signing. πŸ“€
  • NEED_CA β€” the service can't submit a request to a CA because it doesn't know which CA to use. bestie, pick a CA. πŸ™ˆ
  • CA_UNREACHABLE β€” the service couldn't contact the CA, but it will try again later. it's not giving up, it's just on a little break. πŸ”
  • CA_UNCONFIGURED β€” the service is missing configuration it'll need to actually contact the CA successfully. something's missing from the setup. 🧩
  • CA_REJECTED β€” the CA rejected the signing request. πŸ’”
  • CA_WORKING β€” the CA hasn't approved or rejected the request yet. the service will check on the status later. it's pending, your honor. βŒ›
  • NEED_TO_SAVE_CERT β€” the CA approved the signing request, and the service is about to save the issued certificate to the location it's been told to save it to. πŸ’Ύ
  • PRE_SAVE_CERT β€” the service is running a configured pre-saving command before it saves the newly issued certificate to the location it's been told to save it to. warm-up act. 🎬
  • START_SAVING_CERT β€” the service is starting to save the issued certificate to the location it's been told to save it to. 🏁
  • SAVING_CERT β€” the service is attempting to save the issued certificate to the location it's been told to save it to. ✍️
  • NEED_CERTSAVE_PERMS β€” the service hit a filesystem permission error while trying to save the newly issued certificate to the location it's been told to save it to. 😀
  • NEED_CERTSAVE_TOKEN β€” the service can't find the token where the newly issued certificate is supposed to be stored. πŸ”
  • NEED_CERTSAVE_PIN β€” the service is missing the PIN required to access an NSS database so it can save the newly issued certificate to the location it's been told to save it to. πŸ”
  • NEED_TO_SAVE_CA_CERTS β€” the service is about to save the issuing CA's certificate to the locations it's been told to save them to. (note the plural, there are locations, be ready) πŸ“š
  • START_SAVING_CA_CERTS β€” the service is starting to save the issuing CA's certificate to the locations it's been told to save them to. 🏁
  • SAVING_CA_CERTS β€” the service is saving the issuing CA's certificate to the locations it's been told to save them to. πŸ’Ύ
  • NEED_TO_SAVE_ONLY_CA_CERTS β€” the service is about to save the issuing CA's certificate to the locations it's been told to save them to. yes, it reads a lot like the one above. yes, it's a separate state. we don't question the pipeline. 🀷
  • START_SAVING_ONLY_CA_CERTS β€” the service is starting to save the issuing CA's certificate to the locations it's been told to save them to. 🏁
  • SAVING_ONLY_CA_CERTS β€” the service is saving the issuing CA's certificate to the locations it's been told to save them to. πŸ’Ύ
  • NEED_CA_CERT_SAVE_PERMS, NEED_ONLY_CA_CERT_SAVE_PERMS β€” the service hit a filesystem permission error while trying to save the issuing CA's certificate to the locations it's been told to save them to. (in the source these two are squished together on one line and honestly? we respect the chaos πŸ’…) 😀
  • NEED_TO_READ_CERT β€” the service is about to read the issued certificate from the location it's been told to save it to. πŸ“–
  • READING_CERT β€” the service is reading the issued certificate from the location it's been told to save it to. πŸ‘€
  • SAVED_CERT β€” the service has finished saving the issued certificate and the issuer's certificate to the locations it's been told to save them to. complete. done. gorgeous. βœ…
  • POST_SAVED_CERT β€” the service is running a configured post-saving command after saving the newly issued certificate to the location it's been told to save them to. encore performance. 🎀
  • MONITORING β€” the service is monitoring the certificate and waiting for its not-valid-after date to get close. and btw, this is expected to be the status you see most often. it's the default vibe. this is the state that's just out here living its life. 😌✨
  • NEED_TO_NOTIFY_VALIDITY β€” the service is about to notify the system administrator that the certificate's not-valid-after date is approaching. πŸ“£
  • NOTIFYING_VALIDITY β€” the service is notifying the system administrator that the certificate's not-valid-after date is approaching. πŸ””
  • NEED_TO_NOTIFY_REJECTION β€” the service is about to notify the system administrator that the CA rejected the signing request. πŸ“£
  • NOTIFYING_REJECTION β€” the service is notifying the system administrator that the CA rejected the signing request. πŸ””
  • NEED_TO_NOTIFY_ISSUED_SAVE_FAILED β€” the service needs to notify the system administrator that the CA issued a certificate, but there was a problem saving that certificate to the location the service was told to save it to. πŸ“£
  • NOTIFYING_ISSUED_SAVE_FAILED β€” the service is notifying the system administrator that the CA issued a certificate, but there was a problem saving that certificate to the location the service was told to save it to. πŸ””
  • NEED_TO_NOTIFY_ISSUED_CA_SAVE_FAILED β€” the service needs to notify the system administrator that the CA issued a certificate, and the issued certificate was saved to the location the service has been told to save it to, but there was a problem saving the CA's certificate to the locations the service was told to save it to. so close. πŸ“£
  • NOTIFYING_ISSUED_CA_SAVE_FAILED β€” the service is notifying the system administrator that the CA issued a certificate, and the issued certificate was saved to the location the service has been told to save it to, but there was a problem saving the CA's certificate to the locations the service was told to save it to. πŸ””
  • NEED_TO_NOTIFY_ISSUED_SAVED β€” the service needs to notify the system administrator that the CA issued a certificate and it has been saved to the location the service has been told to save it to. good news state!! we love to see it. πŸŽ‰πŸ’–

NOTIFYING_ISSUED_SAVED πŸ’–

okay so bestie, the service is letting the sysadmin know that the CA issued a certificate AND it got saved to the location the service was told to save it. mission accomplished, we're so back. ✨

NEED_TO_NOTIFY_ONLY_CA_SAVE_FAILED 😭

the service needs to tell the system administrator that there was a problem saving the CA's certificates to the specified location. like, it's got bad news and it hasn't delivered it yet.

NOTIFYING_ONLY_CA_SAVE_FAILED πŸ’€

the service is notifying the system administrator that there was a problem saving the CA's certificates to the specified location. bad news = delivered.

NEED_GUIDANCE πŸ™ˆ

an unhandled error happened while it was trying to contact the CA. OR β€” and this is the second possibility, fr β€” the service has just been told to monitor a certificate which doesn't exist, and it has no location specified for storing a key pair that could be used to generate a signing request to go get one. either way: it's stuck, it needs a human. 🫢

NEWLY_ADDED πŸŽ€

the service has just been told to track a certificate, or to generate a signing request to obtain one. fresh start energy.

NEWLY_ADDED_START_READING_KEYINFO πŸ”₯

same deal β€” just told to track a certificate, or generate a signing request for one β€” and it's about to check if there's already a key pair hanging around.

NEWLY_ADDED_READING_KEYINFO 🌸

just told to track a certificate or generate a signing request, and it is checking if there's already a key pair present. currently investigating, no conclusions yet.

NEWLY_ADDED_NEED_KEYINFO_READ_PIN πŸ’…

just told to track a certificate or generate a signing request, and it could not check whether a key pair was present, because it's missing the PIN required to access an NSS database β€” or because it has an incorrect PIN for a database. so either way, that database said "no πŸ’œ" and here we are.

NEWLY_ADDED_NEED_KEYINFO_READ_TOKEN πŸ¦‹

just told to track a certificate or generate a signing request, and it couldn't check for a key pair because the token that should be used for storing the key pair is not present. no token, no check, no cap.

NEWLY_ADDED_START_READING_CERT 🌈

just told to track a certificate or generate a signing request, and it's about to check whether a certificate is already present in the specified location.

NEWLY_ADDED_READING_CERT ⭐

just told to track a certificate or generate a signing request, and it's checking whether a certificate is already sitting in the specified location. peak detective behavior.

NEWLY_ADDED_DECIDING πŸ‘‘

just told to track a certificate or generate a signing request, and it's figuring out its next course of action. the deliberation era. main character decision moment.


πŸ› BUGS πŸ›

found one? please file tickets for any that you find at

https://fedorahosted.org/certmonger/

we appreciate you, fr fr πŸ’–


πŸ‘€ SEE ALSO πŸ‘€


and that's a wrap on the whole page, bestie πŸŽ€ this lil number is from the certmonger Manual, dated June 28, 2016, and it lives under CERTMONGER(1). slay, go manage some certificates, you've got this πŸ’…βœ¨