OSSL_CRMF_MS...CTRL_REGTOKEN(3ossl)

📦
version 3.5.9 · 8 versions
, in fedora 43, fedora 44

💖 OSSL_CRMF_MS...CTRL_REGTOKEN 💖

okay bestie, gather round, because this is the 3ossl manual page for the CRMF Registration Control getters and setters, and honestly? it's giving certificate request management but make it glam ✨

These are the little functions that reach into an OSSL_CRMF_MSG and either grab a registration control out of it or shove one in. You've got your regToken, your authenticator, your pkiPublicationInfo, your protocolEncrKey, your oldCertID… the whole squad. 🫶

🌸 NAME 🌸

OSSL_CRMF_MSG_get0_regCtrl_regToken, OSSL_CRMF_MSG_set1_regCtrl_regToken, OSSL_CRMF_MSG_get0_regCtrl_authenticator, OSSL_CRMF_MSG_set1_regCtrl_authenticator, OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo, OSSL_CRMF_MSG_set0_SinglePubInfo, OSSL_CRMF_MSG_set_PKIPublicationInfo_action, OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo, OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo, OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey, OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey, OSSL_CRMF_MSG_get0_regCtrl_oldCertID, OSSL_CRMF_MSG_set1_regCtrl_oldCertID, OSSL_CRMF_CERTID_gen — functions getting or setting CRMF Registration Controls 💅

✨ SYNOPSIS ✨

#include <openssl/crmf.h>

ASN1_UTF8STRING
   *OSSL_CRMF_MSG_get0_regCtrl_regToken(const OSSL_CRMF_MSG *msg);
int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
                                        const ASN1_UTF8STRING *tok);
ASN1_UTF8STRING
   *OSSL_CRMF_MSG_get0_regCtrl_authenticator(const OSSL_CRMF_MSG *msg);
int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
                                             const ASN1_UTF8STRING *auth);
int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
                                 OSSL_CRMF_PKIPUBLICATIONINFO *pi,
                                 OSSL_CRMF_SINGLEPUBINFO *spi);
int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
                                     int method, GENERAL_NAME *nm);
int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
                                 OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
OSSL_CRMF_PKIPUBLICATIONINFO
   *OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo(const OSSL_CRMF_MSG *msg);
int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
                                       const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
X509_PUBKEY
   *OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey(const OSSL_CRMF_MSG *msg);
int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
                                               const X509_PUBKEY *pubkey);
OSSL_CRMF_CERTID
   *OSSL_CRMF_MSG_get0_regCtrl_oldCertID(const OSSL_CRMF_MSG *msg);
int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
                                         const OSSL_CRMF_CERTID *cid);
OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
                                       const ASN1_INTEGER *serial);

👑 DESCRIPTION 👑

so here's the tea ☕ — every single one of the OSSL_CRMF_MSG_get0_regCtrl_X() girlies returns the respective control X inside the given msg, if it's actually there. no control, no vibes, no pointer.

OSSL_CRMF_MSG_set1_regCtrl_regToken() sets the regToken control in the given msg, copying the given tok as the value. see RFC 4211, section 6.1. 📜

OSSL_CRMF_MSG_set1_regCtrl_authenticator() sets the authenticator control in the given msg, copying the given auth as the value. see RFC 4211, section 6.2. 🔐

OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo() pushes the given spi to si. consumes the spi pointer. 😳 like, it's gone, it's taken, it belongs to si now.

OSSL_CRMF_MSG_set0_SinglePubInfo() sets, in the given SinglePubInfo spi, the method and the publication location in the form of a GeneralName, nm. the publication location is optional, so nm may be NULL. the function consumes the nm pointer if it's present. 🫶

available methods are:

# define OSSL_CRMF_PUB_METHOD_DONTCARE 0
# define OSSL_CRMF_PUB_METHOD_X500     1
# define OSSL_CRMF_PUB_METHOD_WEB      2
# define OSSL_CRMF_PUB_METHOD_LDAP     3

OSSL_CRMF_MSG_set_PKIPublicationInfo_action() sets the action in the given pi using the given action as the value. see RFC 4211, section 6.3. 🎬

available actions are:

# define OSSL_CRMF_PUB_ACTION_DONTPUBLISH   0
# define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1

OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo() sets the pkiPublicationInfo control in the given msg, copying the given tok as the value. see RFC 4211, section 6.3. 📰

OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey() sets the protocolEncrKey control in the given msg, copying the given pubkey as the value. see RFC 4211, section 6.6. 🔑

OSSL_CRMF_MSG_set1_regCtrl_oldCertID() sets the oldCertID regToken control in the given msg, copying the given cid as the value. see RFC 4211, section 6.5. 🪪

OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure, copying the given issuer name and serial number. 💫

🦋 RETURN VALUES 🦋

  • all OSSL_CRMF_MSG_get0_*() functions return the respective pointer value, or NULL if not present and on error. 😭
  • all OSSL_CRMF_MSG_set1_*() functions return 1 on success, 0 on error. slay or flop, no in-between.
  • OSSL_CRMF_CERTID_gen() returns a pointer to the resulting structure, or NULL on error. 🌈

🙈 NOTES 🙈

heads up bestie: a function called OSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions() for setting an Archive Options Control is not yet implemented — it's missing the features needed to create the required OSSL_CRMF_PKIARCHIVEOPTINS content. so don't go looking for it, she's not here yet. 💀

🎀 SEE ALSO 🎀

⭐ HISTORY ⭐

the OpenSSL CRMF support was added in OpenSSL 3.0. iconic behaviour, honestly. 👑

Copyright 2007-2022 The OpenSSL Project Authors. All Rights Reserved.

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>.

and that's the whole page, bestie!! 💖 this was the 3ossl manual, living in OpenSSL version 3.5.9, dated 2026-09-2 — thanks for reading, mwah, go forth and set those registration controls responsibly 🧚✨💅

📦 where this page comes from