$NetBSD: OSSL_CRMF_pbmp_new.3,v 1.5 2024/09/08 13:08:26 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "OSSL_CRMF_pbmp_new 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OSSL_CRMF_pbm_new, OSSL_CRMF_pbmp_new \- functions for producing Password-Based MAC (PBM) Header "SYNOPSIS" .Vb 1 #include <openssl/crmf.h> \& int OSSL_CRMF_pbm_new(OSSL_LIB_CTX *libctx, const char *propq, const OSSL_CRMF_PBMPARAMETER *pbmp, const unsigned char *msg, size_t msglen, const unsigned char *sec, size_t seclen, unsigned char **mac, size_t *maclen); \& OSSL_CRMF_PBMPARAMETER *OSSL_CRMF_pbmp_new(OSSL_LIB_CTX *libctx, size_t saltlen, int owfnid, size_t itercnt, int macnid); .Ve Header "DESCRIPTION" \fBOSSL_CRMF_pbm_new() generates a PBM (Password-Based MAC) based on given PBM parameters pbmp, message msg, and secret sec, along with the respective lengths msglen and seclen. The optional library context libctx and propq parameters may be used to influence the selection of the MAC algorithm referenced in the pbmp; see "ALGORITHM FETCHING" in crypto\|(7) for further information. On success writes the address of the newly allocated MAC via the mac reference parameter and writes the length via the \fImaclen reference parameter unless it its NULL.

\fBOSSL_CRMF_pbmp_new() initializes and returns a new PBMParameter structure with a new random salt of given length saltlen, OWF (one-way function) NID owfnid, OWF iteration count itercnt, and MAC NID macnid. The library context libctx parameter may be used to select the provider for the random number generation (DRBG) and may be NULL for the default.

Header "NOTES" The algorithms for the OWF (one-way function) and for the MAC (message authentication code) may be any with a NID defined in <openssl/objects.h>. As specified by RFC 4210, these should include NID_hmac_sha1.

RFC 4210 recommends that the salt SHOULD be at least 8 bytes (64 bits) long, where 16 bytes is common.

The iteration count must be at least 100, as stipulated by RFC 4211, and is limited to at most 100000 to avoid DoS through manipulated or otherwise malformed input.

Header "RETURN VALUES" \fBOSSL_CRMF_pbm_new() returns 1 on success, 0 on error.

\fBOSSL_CRMF_pbmp_new() returns a new and initialized OSSL_CRMF_PBMPARAMETER structure, or NULL on error.

Header "EXAMPLES" .Vb 5 OSSL_CRMF_PBMPARAMETER *pbm = NULL; unsigned char *msg = "Hello"; unsigned char *sec = "SeCrEt"; unsigned char *mac = NULL; size_t maclen; \& if ((pbm = OSSL_CRMF_pbmp_new(16, NID_sha256, 500, NID_hmac_sha1) == NULL)) goto err; if (!OSSL_CRMF_pbm_new(pbm, msg, 5, sec, 6, &mac, &maclen)) goto err; .Ve Header "SEE ALSO" RFC 4211 section 4.4 Header "HISTORY" The OpenSSL CRMF support was added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2007-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>.