Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_CTX_set1_pbe_pass.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 "EVP_PKEY_CTX_SET1_PBE_PASS 3SSL"
58 .TH EVP_PKEY_CTX_SET1_PBE_PASS 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 EVP_PKEY_CTX_set1_pbe_pass
65 \&\- generic KDF support functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/kdf.h>
70 \&
71 \& int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX *pctx, unsigned char *pass,
72 \& int passlen);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 These functions are generic support functions for all KDF algorithms.
77 .PP
78 \&\fBEVP_PKEY_CTX_set1_pbe_pass()\fR sets the password to the \fBpasslen\fR first
79 bytes from \fBpass\fR.
80 .SH "STRING CTRLS"
81 .IX Header "STRING CTRLS"
82 There is also support for string based control operations via
83 \&\fBEVP_PKEY_CTX_ctrl_str\fR\|(3).
84 The \fBpassword\fR can be directly specified using the \fBtype\fR parameter
85 "pass" or given in hex encoding using the "hexpass" parameter.
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 All these functions return 1 for success and 0 or a negative value for failure.
89 In particular a return value of \-2 indicates the operation is not supported by
90 the public key algorithm.
91 .SH "SEE ALSO"
92 .IX Header "SEE ALSO"
93 \&\fBEVP_PKEY_CTX_new\fR\|(3),
94 \&\fBEVP_PKEY_CTX_ctrl_str\fR\|(3),
95 \&\fBEVP_PKEY_derive\fR\|(3)
96 .SH HISTORY
97 .IX Header "HISTORY"
98 \&\fBEVP_PKEY_CTX_set1_pbe_pass()\fR was converted from a macro to a function in
99 OpenSSL 3.0.
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2018\-2020 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.