PKCS12_SAFEBAG_GET1_CERT(3ossl)

πŸ’… NAME πŸ’…

PKCS12_SAFEBAG_get0_attr, PKCS12_SAFEBAG_get0_type, PKCS12_SAFEBAG_get_nid, PKCS12_SAFEBAG_get_bag_nid, PKCS12_SAFEBAG_get0_bag_obj, PKCS12_SAFEBAG_get0_bag_type, PKCS12_SAFEBAG_get1_cert_ex, PKCS12_SAFEBAG_get1_cert, PKCS12_SAFEBAG_get1_crl_ex, PKCS12_SAFEBAG_get1_crl, PKCS12_SAFEBAG_get0_safes, PKCS12_SAFEBAG_get0_p8inf, PKCS12_SAFEBAG_get0_pkcs8 β€” get objects from a PKCS#12 safeBag πŸŽ€

okay bestie, this is the OpenSSL manual page for PKCS12_SAFEBAG_GET1_CERT(3ossl) β€” it's giving ✨"I just want to peek inside the bag"✨ and honestly? iconic.


✨ SYNOPSIS ✨

#include <openssl/pkcs12.h>

const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
                                          int attr_nid);
const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag);
int PKCS12_SAFEBAG_get_nid(const PKCS12_SAFEBAG *bag);
int PKCS12_SAFEBAG_get_bag_nid(const PKCS12_SAFEBAG *bag);
const ASN1_TYPE *PKCS12_SAFEBAG_get0_bag_obj(const PKCS12_SAFEBAG *bag);
const ASN1_OBJECT *PKCS12_SAFEBAG_get0_bag_type(const PKCS12_SAFEBAG *bag);
X509_CRL *PKCS12_SAFEBAG_get1_cert_ex(const PKCS12_SAFEBAG *bag,
                                      OSSL_LIB_CTX *libctx, const char *propq);
X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
X509_CRL *PKCS12_SAFEBAG_get1_crl_ex(const PKCS12_SAFEBAG *bag,
                                     OSSL_LIB_CTX *libctx, const char *propq);
X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
const STACK_OF(PKCS12_SAFEBAG) *PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);

πŸ¦‹ DESCRIPTION πŸ¦‹

so like. a PKCS12_SAFEBAG is a little bag πŸ‘œ and every function here is basically you unzipping the bag and going "what's in here tho". let's go one by one, no cap:

  • PKCS12_SAFEBAG_get0_attr() β€” grabs the attribute value that corresponds to the attr_nid. like, you say "give me the thing tagged with this NID" and it hands it over. πŸ’–
  • PKCS12_SAFEBAG_get0_type() β€” gets the safeBag type as an OID. meanwhile PKCS12_SAFEBAG_get_nid() gets the safeBag type as an NID, which could be NID_certBag, NID_crlBag, NID_keyBag, NID_secretBag, NID_safeContentsBag or NID_pkcs8ShroudedKeyBag. same vibe, different flavour of identifier ✨
  • PKCS12_SAFEBAG_get_bag_nid() β€” gets the type of the object contained within the PKCS12_SAFEBAG. for most bags this matches the bag type, but for secretBags it can be arbitrary (yes really, it's giving chaos πŸ™ˆ). and PKCS12_SAFEBAG_get0_bag_type() gets this same type but as an OID. πŸŽ€
  • PKCS12_SAFEBAG_get0_bag_obj() β€” retrieves the actual object chillin' inside the safeBag. the main character of the bag, fr fr. πŸ‘‘
  • PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex() β€” return new X509 or X509_CRL objects made from the item in the safeBag. libctx and propq get used when fetching algorithms, and both may optionally be set to NULL. 🧚
  • PKCS12_SAFEBAG_get1_cert() and PKCS12_SAFEBAG_get1_crl() β€” literally the same as PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex(), except they set the libctx and prop to NULL. which means they use the default library context. slay, convenience. πŸ’…
  • PKCS12_SAFEBAG_get0_p8inf() and PKCS12_SAFEBAG_get0_pkcs8() β€” return the PKCS8 object from a PKCS8shroudedKeyBag or a keyBag. πŸ”‘
  • PKCS12_SAFEBAG_get0_safes() β€” retrieves the set of safeBags contained within a safeContentsBag. bags inside bags inside bags, it's giving inception πŸŒ€βœ¨

🌈 RETURN VALUES 🌈

  • PKCS12_SAFEBAG_get_nid() and PKCS12_SAFEBAG_get_bag_nid() return the NID of the safeBag or bag object, or -1 if there's no corresponding NID. 😭
  • every other function here returns a valid object of the specified type, or NULL if an error occurred. πŸ’€

πŸ‘€ SEE ALSO πŸ‘€

PKCS12_create(3), PKCS12_add_safe(3), PKCS12_add_safes(3)


πŸ“œ HISTORY πŸ“œ

the functions PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex() were added in OpenSSL 3.2. newer girls on the block, and we're obsessed 🫢


Copyright 2019-2023 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 OpenSSL 3.5.9 version, dated 2026-09-29 β€” go forth and peek inside your safeBags responsibly, mwah πŸŽ€βœ¨πŸ’…

πŸ“¦ where this page comes from