dwww Home | Manual pages | Find package

OSSL_CMP_MSG_GET0_HEADER(3SSL)      OpenSSL     OSSL_CMP_MSG_GET0_HEADER(3SSL)

NAME
       OSSL_CMP_MSG_get0_header, OSSL_CMP_MSG_get_bodytype,
       OSSL_CMP_MSG_update_transactionID, OSSL_CMP_CTX_setup_CRM,
       OSSL_CMP_MSG_read, OSSL_CMP_MSG_write, d2i_OSSL_CMP_MSG_bio,
       i2d_OSSL_CMP_MSG_bio - function(s) manipulating CMP messages

SYNOPSIS
         #include <openssl/cmp.h>

         OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg);
         int OSSL_CMP_MSG_get_bodytype(const OSSL_CMP_MSG *msg);
         int OSSL_CMP_MSG_update_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg);
         OSSL_CRMF_MSG *OSSL_CMP_CTX_setup_CRM(OSSL_CMP_CTX *ctx, int for_KUR, int rid);
         OSSL_CMP_MSG *OSSL_CMP_MSG_read(const char *file, OSSL_LIB_CTX *libctx, const char *propq);
         int OSSL_CMP_MSG_write(const char *file, const OSSL_CMP_MSG *msg);
         OSSL_CMP_MSG *d2i_OSSL_CMP_MSG_bio(BIO *bio, OSSL_CMP_MSG **msg);
         int i2d_OSSL_CMP_MSG_bio(BIO *bio, const OSSL_CMP_MSG *msg);

DESCRIPTION
       OSSL_CMP_MSG_get0_header() returns the header of the given CMP message.

       OSSL_CMP_MSG_get_bodytype() returns the body type of the given CMP
       message.

       OSSL_CMP_MSG_update_transactionID() updates the transactionID field in
       the header of the given message according to the CMP_CTX.  This
       requires re-protecting the message (if it was protected).

       OSSL_CMP_CTX_setup_CRM() creates a CRMF certificate request message
       from various information provided in the CMP context argument ctx for
       inclusion in a CMP request message based on details contained in ctx.
       The rid argument defines the request identifier to use, which typically
       is 0.

       The subject DN to include in the certificate template is determined as
       follows.  If ctx includes a subject name set via
       OSSL_CMP_CTX_set1_subjectName(3), this name is used.  Otherwise, if a
       PKCS#10 CSR is given in ctx, its subject is used.  Otherwise, if a
       reference certificate is given in ctx (see
       OSSL_CMP_CTX_set1_oldCert(3)), its subject is used if for_KUR is
       nonzero or the ctx does not include a Subject Alternative Name.

       The public key to include is taken from any value set via
       OSSL_CMP_CTX_set0_newPkey(3), otherwise the public key of any PKCS#10
       CSR is given in ctx, otherwise the public key of any reference
       certificate given in ctx, otherwise it is derived from the client
       private key if given in ctx.

       The set of X.509 extensions to include is computed as follows.  If a
       PKCS#10 CSR is present in ctx, default extensions are taken from there,
       otherwise the empty set is taken as the initial value.  If there is a
       reference certificate in ctx and contains Subject Alternative Names
       (SANs) and OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT is not set, these
       override any SANs from the PKCS#10 CSR.  The extensions are further
       augmented or overridden by any extensions with the same OIDs included
       in the ctx via OSSL_CMP_CTX_set0_reqExtensions(3).  The SANs are
       further overridden by any SANs included in ctx via
       OSSL_CMP_CTX_push1_subjectAltName(3).  Finally, policies are overridden
       by any policies included in ctx via OSSL_CMP_CTX_push0_policy(3).

       OSSL_CMP_CTX_setup_CRM() also sets the sets the regToken control
       oldCertID for KUR messages using the issuer name and serial number of
       the reference certificate, if present.

       OSSL_CMP_MSG_read() loads a DER-encoded OSSL_CMP_MSG from file.

       OSSL_CMP_MSG_write() stores the given OSSL_CMP_MSG to file in DER
       encoding.

       d2i_OSSL_CMP_MSG_bio() parses an ASN.1-encoded OSSL_CMP_MSG from the
       BIO bio.  It assigns a pointer to the new structure to *msg if msg is
       not NULL.

       i2d_OSSL_CMP_MSG_bio() writes the OSSL_CMP_MSG msg in ASN.1 encoding to
       BIO bio.

NOTES
       CMP is defined in RFC 4210.

RETURN VALUES
       OSSL_CMP_MSG_get0_header() returns the intended pointer value as
       described above or NULL if the respective entry does not exist and on
       error.

       OSSL_CMP_MSG_get_bodytype() returns the body type or -1 on error.

       OSSL_CMP_CTX_setup_CRM() returns a pointer to a OSSL_CRMF_MSG on
       success, NULL on error.

       d2i_OSSL_CMP_MSG_bio() returns the parsed message or NULL on error.

       OSSL_CMP_MSG_read() and d2i_OSSL_CMP_MSG_bio() return the parsed CMP
       message or NULL on error.

       OSSL_CMP_MSG_write() and i2d_OSSL_CMP_MSG_bio() return the number of
       bytes successfully encoded or a negative value if an error occurs.

       OSSL_CMP_MSG_update_transactionID() returns 1 on success, 0 on error.

HISTORY
       The OpenSSL CMP support was added in OpenSSL 3.0.

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

3.0.2                             2024-08-20    OSSL_CMP_MSG_GET0_HEADER(3SSL)

Generated by dwww version 1.14 on Thu Jan 23 11:51:46 CET 2025.