OSSL_CRMF_MSG_GET0_TMPL(3ossl)

📦

version 15.1 · 2 versions

15.1 · freebsd 15.1 (latest)
14.5 · freebsd 14.5

💅 OSSL_CRMF_MSG_GET0_TMPL 💅

okay so bestie, welcome to OSSL_CRMF_MSG_GET0_TMPL(3ossl) — yes that's the whole manual name, it's a mouthful, we know 😭 — this is the OpenSSL page for the little gang of getters that read stuff out of CRMF CertReqMsg structures. no cap, it's all "get me this field, get me that field" and honestly? we love a low-maintenance API 🫶

✨ NAME ✨

okay so it's a whole squad, one page, here's the full lineup (say hi 👋):

OSSL_CRMF_MSG_get0_tmpl
OSSL_CRMF_CERTTEMPLATE_get0_publicKey
OSSL_CRMF_CERTTEMPLATE_get0_subject
OSSL_CRMF_CERTTEMPLATE_get0_issuer
OSSL_CRMF_CERTTEMPLATE_get0_serialNumber
OSSL_CRMF_CERTTEMPLATE_get0_extensions
OSSL_CRMF_CERTID_get0_serialNumber
OSSL_CRMF_CERTID_get0_issuer
OSSL_CRMF_ENCRYPTEDKEY_get1_encCert
OSSL_CRMF_ENCRYPTEDKEY_get1_pkey
OSSL_CRMF_ENCRYPTEDKEY_init_envdata
OSSL_CRMF_ENCRYPTEDVALUE_decrypt
OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert
OSSL_CRMF_MSG_get_certReqId
OSSL_CRMF_MSG_centralkeygen_requested

and what do they all do? they're functions reading from CRMF CertReqMsg structures. that's the vibe check, periodt. 💖

🎀 SYNOPSIS 🎀

copy this exactly bestie, character for character, no improvising 💅

#include <openssl/crmf.h>

OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
X509_PUBKEY
*OSSL_CRMF_CERTTEMPLATE_get0_publicKey(const OSSL_CRMF_CERTTEMPLATE *tmpl);
const X509_NAME
*OSSL_CRMF_CERTTEMPLATE_get0_subject(const OSSL_CRMF_CERTTEMPLATE *tmpl);
const X509_NAME
*OSSL_CRMF_CERTTEMPLATE_get0_issuer(const OSSL_CRMF_CERTTEMPLATE *tmpl);
const ASN1_INTEGER
*OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(const OSSL_CRMF_CERTTEMPLATE *tmpl);
X509_EXTENSIONS
*OSSL_CRMF_CERTTEMPLATE_get0_extensions(const OSSL_CRMF_CERTTEMPLATE *tmpl);

const ASN1_INTEGER
*OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid);
const X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid);

X509 *OSSL_CRMF_ENCRYPTEDKEY_get1_encCert(const OSSL_CRMF_ENCRYPTEDKEY *ecert,
                                          OSSL_LIB_CTX *libctx, const char *propq,
                                          EVP_PKEY *pkey, unsigned int flags);
EVP_PKEY
*OSSL_CRMF_ENCRYPTEDKEY_get1_pkey(OSSL_CRMF_ENCRYPTEDKEY *encryptedKey,
                                  X509_STORE *ts, STACK_OF(X509) *extra,
                                  EVP_PKEY *pkey, X509 *cert,
                                  ASN1_OCTET_STRING *secret,
                                  OSSL_LIB_CTX *libctx, const char *propq);
OSSL_CRMF_ENCRYPTEDKEY
*OSSL_CRMF_ENCRYPTEDKEY_init_envdata(CMS_EnvelopedData *envdata);

unsigned char
*OSSL_CRMF_ENCRYPTEDVALUE_decrypt(const OSSL_CRMF_ENCRYPTEDVALUE *enc,
                                  OSSL_LIB_CTX *libctx, const char *propq,
                                  EVP_PKEY *pkey, int *outlen);
X509
*OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(const OSSL_CRMF_ENCRYPTEDVALUE *ecert,
                                       OSSL_LIB_CTX *libctx, const char *propq,
                                       EVP_PKEY *pkey);

int OSSL_CRMF_MSG_get_certReqId(const OSSL_CRMF_MSG *crm);
int OSSL_CRMF_MSG_centralkeygen_requested(const OSSL_CRMF_MSG *crm,
                                          const X509_REQ *p10cr);

like, it's giving "wall of prototypes" but every single one of them is serving 💅

🌸 DESCRIPTION 🌸

so here's the tea on each one, going down the list one by one ☕️✨

OSSL_CRMF_MSG_get0_tmpl() — snags the certificate template out of crm. that's it. that's the whole job. iconic behaviour honestly.
OSSL_CRMF_CERTTEMPLATE_get0_publicKey() — pulls out the public key of the certificate template tmpl you handed it. 🔑
OSSL_CRMF_CERTTEMPLATE_get0_subject() — grabs the subject name of the certificate template tmpl. the "who is this even" field 💁‍♀️
OSSL_CRMF_CERTTEMPLATE_get0_issuer() — grabs the issuer name of the certificate template tmpl. the "who signed off on this" field 🖊️
OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() — retrieves the serialNumber of the certificate template tmpl. it's a number, it's serial, we move 🔢
OSSL_CRMF_CERTTEMPLATE_get0_extensions() — retrieves the X.509 extensions of the certificate template tmpl, or NULL if not present. no extensions? no problem, you just get NULL, don't @ me 😌
OSSL_CRMF_CERTID_get0_serialNumber — retrieves the serialNumber of the given CertId cid. (yes, no parentheses on this one in the original, that's just how it's written, we don't fix, we don't argue, we copy 🫡)
OSSL_CRMF_CERTID_get0_issuer — retrieves the issuer name of the given CertId cid, which must be of ASN.1 type GEN_DIRNAME. important!! don't try to be cute with other types, it literally says must 🔥
OSSL_CRMF_ENCRYPTEDKEY_get1_encCert() — decrypts the certificate in the given encryptedKey ecert, using the private key pkey, library context libctx and property query string propq (see OSSL_LIB_CTX(3)). this is needed for the indirect POPO method as in RFC 9810 section 5.2.8.3.2. the function returns the decrypted certificate as a copy, leaving its ownership with the caller, who is responsible for freeing it. ⚠️ you own it, you free it, that's the deal bestie 🫶
OSSL_CRMF_ENCRYPTEDKEY_get1_pkey() — decrypts the private key in encryptedKey. if encryptedKey is not of type OSSL_CRMF_ENCRYPTEDKEY_ENVELOPEDDATA, decryption uses the private key pkey. the library context libctx and property query propq are taken into account as usual. 👑 now, the rest of this paragraph is relevant only if CMS support not disabled for the OpenSSL build and encryptedKey is of type case OSSL_CRMF_ENCRYPTEDKEY_ENVELOPEDDATA. decryption uses the secret parameter if not NULL; otherwise uses the private key <pkey> and the certificate cert related to pkey, where cert is recommended to be given if available. on success, the function verifies the decrypted data as signed data, using the trust store ts and any untrusted certificates in extra. doing so, it checks for the purpose "CMP Key Generation Authority" (cmKGA). like, it's thorough, it's doing the most, and honestly? it should 💅

ngl that paragraph is a lot, so re-read it if you need to — every conditional in there matters and i'm not about to paraphrase away your only warning about CMS support being disabled in your build 😭

OSSL_CRMF_ENCRYPTEDKEY_init_envdata() — returns OSSL_CRMF_ENCRYPTEDKEY, initialized with the enveloped data envdata. fresh out the box, pre-loaded 🎁
OSSL_CRMF_ENCRYPTEDVALUE_decrypt() — decrypts the encrypted value in the given encryptedValue enc, using the private key pkey, library context libctx and property query string propq (see OSSL_LIB_CTX(3)). 🔓
OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() — decrypts the certificate in the given encryptedValue ecert, using the private key pkey, library context libctx and property query string propq (see OSSL_LIB_CTX(3)). this is needed for the indirect POPO method as in RFC 9810 section 5.2.8.3.2. the function returns the decrypted certificate as a copy, leaving its ownership with the caller, who is responsible for freeing it. ⚠️ same drill: caller frees it, don't forget or it's a leak, and leaks are not the aesthetic 🌸
OSSL_CRMF_MSG_get_certReqId() — retrieves the certReqId of crm. short, sweet, to the point ✨
OSSL_CRMF_MSG_centralkeygen_requested() — returns 1 if central key generation is requested, i.e. the public key in the certificate request (crm is taken if it is non-NULL, otherwise p10cr) is NULL or has an empty key value (with length zero). in case crm is non-NULL, this is checked for consistency with its popo field (must be NULL if and only if central key generation is requested). otherwise it returns 0, and on error a negative value. 💀 so: 1 = yes bestie, 0 = nah, negative = something went sideways. got it? got it. 👑

🦋 RETURN VALUES 🦋

OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a nonnegative integer, or -1 on error. 🚩
OSSL_CRMF_MSG_centralkeygen_requested() returns 1 if central key generation is requested, 0 if it is not requested, and a negative value on error.
all the other functions return a pointer with the intended result, or NULL on error. so like, always check for NULL, that's the whole mood 🙈

🌈 SEE ALSO 🌈

RFC 4211 — go read it, i believe in you 📚✨

💜 HISTORY 💜

the lore, chronologically:

the OpenSSL CRMF support was added in OpenSSL 3.0. og era 🕰️
OSSL_CRMF_CERTTEMPLATE_get0_publicKey() was added in OpenSSL 3.2. glow-up era ✨
OSSL_CRMF_ENCRYPTEDKEY_get1_encCert(), OSSL_CRMF_ENCRYPTEDKEY_get1_pkey(), OSSL_CRMF_ENCRYPTEDKEY_init_envdata(), OSSL_CRMF_ENCRYPTEDVALUE_decrypt() and OSSL_CRMF_MSG_centralkeygen_requested() were added in OpenSSL 3.5. fresh drop, new arrivals, we ate 🔥

🍓 COPYRIGHT 🍓

licensed under the Apache License 2.0 (the "License"). you may not use this file except in compliance with the License. you can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. legal stuff, but make it cute 🎀

okay that's the whole page bestie, you're officially CRMF-literate 💅✨ mwah, go forth and check your NULLs. this was OSSL_CRMF_MSG_GET0_TMPL(3ossl) from the 3.5.6 drop, dated 2026-04-07 — see you in the next manpage, love u, bye 🦋💖👑

📦 where this page comes from

freebsd 15.1: base 15.1
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms