Debian Codegraph @

upstream/debian-unstable/man3/OSSL_CRMF_pbmp_new.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_CRMF_PBMP_NEW 3SSL"
58 .TH OSSL_CRMF_PBMP_NEW 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_CRMF_pbm_new,
65 OSSL_CRMF_pbmp_new
66 \&\- functions for producing Password\-Based MAC (PBM)
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/crmf.h>
71 \&
72 \& int OSSL_CRMF_pbm_new(OSSL_LIB_CTX *libctx, const char *propq,
73 \& const OSSL_CRMF_PBMPARAMETER *pbmp,
74 \& const unsigned char *msg, size_t msglen,
75 \& const unsigned char *sec, size_t seclen,
76 \& unsigned char **mac, size_t *maclen);
77 \&
78 \& OSSL_CRMF_PBMPARAMETER *OSSL_CRMF_pbmp_new(OSSL_LIB_CTX *libctx, size_t saltlen,
79 \& int owfnid, size_t itercnt,
80 \& int macnid);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 \&\fBOSSL_CRMF_pbm_new()\fR generates a PBM (Password-Based MAC) based on given PBM
85 parameters \fIpbmp\fR, message \fImsg\fR, and secret \fIsec\fR, along with the respective
86 lengths \fImsglen\fR and \fIseclen\fR.
87 The optional library context \fIlibctx\fR and \fIpropq\fR parameters may be used
88 to influence the selection of the MAC algorithm referenced in the \fIpbmp\fR;
89 see "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for further information.
90 On success writes the address of the newly
91 allocated MAC via the \fImac\fR reference parameter and writes the length via the
92 \&\fImaclen\fR reference parameter unless it its NULL.
93 .PP
94 \&\fBOSSL_CRMF_pbmp_new()\fR initializes and returns a new \fBPBMParameter\fR structure
95 with a new random salt of given length \fIsaltlen\fR,
96 OWF (one-way function) NID \fIowfnid\fR, OWF iteration count \fIitercnt\fR,
97 and MAC NID \fImacnid\fR.
98 The library context \fIlibctx\fR parameter may be used to select the provider
99 for the random number generation (DRBG) and may be NULL for the default.
100 .SH NOTES
101 .IX Header "NOTES"
102 The algorithms for the OWF (one-way function) and for the MAC (message
103 authentication code) may be any with a NID defined in \fI<openssl/objects.h>\fR.
104 For backward compatibility with RFC 4210, these should include NID_hmac_sha1.
105 .PP
106 RFC 4210 recommended that the salt SHOULD be at least 8 bytes (64 bits) long,
107 where 16 bytes is common.
108 .PP
109 The iteration count must be at least 100, as stipulated by RFC 4211, and is
110 limited to at most 100000 to avoid DoS through manipulated or otherwise
111 malformed input.
112 See RFC 9045 for currently suggested values.
113 .SH "RETURN VALUES"
114 .IX Header "RETURN VALUES"
115 \&\fBOSSL_CRMF_pbm_new()\fR returns 1 on success, 0 on error.
116 .PP
117 \&\fBOSSL_CRMF_pbmp_new()\fR returns a new and initialized OSSL_CRMF_PBMPARAMETER
118 structure, or NULL on error.
119 .SH EXAMPLES
120 .IX Header "EXAMPLES"
121 .Vb 5
122 \& OSSL_CRMF_PBMPARAMETER *pbm = NULL;
123 \& unsigned char *msg = "Hello";
124 \& unsigned char *sec = "SeCrEt";
125 \& unsigned char *mac = NULL;
126 \& size_t maclen;
127 \&
128 \& if ((pbm = OSSL_CRMF_pbmp_new(16, NID_sha256, 500, NID_hmac_sha1) == NULL))
129 \& goto err;
130 \& if (!OSSL_CRMF_pbm_new(pbm, msg, 5, sec, 6, &mac, &maclen))
131 \& goto err;
132 .Ve
133 .SH "SEE ALSO"
134 .IX Header "SEE ALSO"
135 RFC 4211 section 4.4
136 .SH HISTORY
137 .IX Header "HISTORY"
138 The OpenSSL CRMF support was added in OpenSSL 3.0.
139 .SH COPYRIGHT
140 .IX Header "COPYRIGHT"
141 Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved.
142 .PP
143 Licensed under the Apache License 2.0 (the "License"). You may not use
144 this file except in compliance with the License. You can obtain a copy
145 in the file LICENSE in the source distribution or at
146 <https://www.openssl.org/source/license.html>.