PKCS12_ADD_CERT(3ossl)

📦 version 3.5.0, in opensuse-leap 16.0

✨ NAME ✨

Okay so PKCS12_ADD_CERT(3ossl) is the manual for a whole little squad: PKCS12_add_cert, PKCS12_add_key, PKCS12_add_key_ex, and PKCS12_add_secret. Their collective vibe? Add an object to a set of PKCS#12 safeBags. That's the job, bestie 💅.

🌸 SYNOPSIS 🌸

        #include <openssl/pkcs12.h>

        PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
        PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
                                      EVP_PKEY *key, int key_usage, int iter,
                                      int key_nid, const char *pass);
        PKCS12_SAFEBAG *PKCS12_add_key_ex(STACK_OF(PKCS12_SAFEBAG) **pbags,
                                          EVP_PKEY *key, int key_usage, int iter,
                                          int key_nid, const char *pass,
                                          OSSL_LIB_CTX *ctx, const char *propq);

        PKCS12_SAFEBAG *PKCS12_add_secret(STACK_OF(PKCS12_SAFEBAG) **pbags,
                                         int nid_type, const unsigned char *value, int len);

🦋 DESCRIPTION 🦋

These functions create a new PKCS12_SAFEBAG and add it to the set of safeBags in pbags. It's giving "make a bag, put it with the other bags" ✨.

  • PKCS12_add_cert() — creates a PKCS#12 certBag containing the supplied certificate and adds this to the set of PKCS#12 safeBags. Cert bag, but make it iconic 🎀.
  • PKCS12_add_key() — creates a PKCS#12 keyBag (unencrypted) or a pkcs8shroudedKeyBag (encrypted) containing the supplied EVP_PKEY and adds this to the set of PKCS#12 safeBags. If key_nid is not -1 then the key is encrypted with the supplied algorithm, using pass as the passphrase and iter as the iteration count. If iter is zero then a default value for iteration count of 2048 is used. Not the default being 2048 and me feeling powerful 😭.
  • PKCS12_add_key_ex() — identical to PKCS12_add_key() but allows for a library context ctx and property query propq to be used to select algorithm implementations. Same function, extra little settings, highkey slay 💅.
  • PKCS12_add_secret() — creates a PKCS#12 secretBag with an OID corresponding to the supplied nid_type containing the supplied value as an ASN1 octet string. This is then added to the set of PKCS#12 safeBags. Secret bag? More like main character bag 🔥.

💜 NOTES 💜

  • If a certificate contains an alias or a keyid then this will be used for the corresponding friendlyName or localKeyID in the PKCS12 structure. Your cert is basically picking its own nickname, no cap 💅.
  • PKCS12_add_key() makes assumptions regarding the encoding of the given pass phrase. See passphrase-encoding(7) for more information. Go read that one, bestie 🫶.

🥺 RETURN VALUES 🥺

A valid PKCS12_SAFEBAG structure or NULL if an error occurred. That's the whole mood: valid struct or sad little NULL 😭.

🌈 CONFORMING TO 🌈

IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>). Standards bestie behavior ⭐.

👑 SEE ALSO 👑

PKCS12_create(3) — go peek at that one too, iykyk 🦋.

⭐ HISTORY ⭐

PKCS12_add_secret() and PKCS12_add_key_ex() were added in OpenSSL 3.0. They're the newer additions to the squad, periodt 💖.

Copyright 2020-2021 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.

xoxo, your Unix bestie 💖 — OpenSSL 3.5.0, dated 2026-09-25, manual PKCS12_ADD_CERT(3ossl) 🫶

📦 where this page comes from