secure/lib/libcrypto/man/man3/SSL_CTX_set_default_passwd_cb.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_CTX_SET_DEFAULT_PASSWD_CB 3"
 136 .TH SSL_CTX_SET_DEFAULT_PASSWD_CB 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_CTX_set_default_passwd_cb, SSL_CTX_set_default_passwd_cb_userdata, SSL_CTX_get_default_passwd_cb, SSL_CTX_get_default_passwd_cb_userdata, SSL_set_default_passwd_cb, SSL_set_default_passwd_cb_userdata, SSL_get_default_passwd_cb, SSL_get_default_passwd_cb_userdata \- set or get passwd callback for encrypted PEM file handling
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
 149 \& void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);
 150 \& pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);
 151 \& void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);
 152 \&
 153 \& void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb);
 154 \& void SSL_set_default_passwd_cb_userdata(SSL *s, void *u);
 155 \& pem_password_cb *SSL_get_default_passwd_cb(SSL *s);
 156 \& void *SSL_get_default_passwd_cb_userdata(SSL *s);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 \&\fBSSL_CTX_set_default_passwd_cb()\fR sets the default password callback called
 161 when loading/storing a \s-1PEM\s0 certificate with encryption.
 162 .PP
 163 \&\fBSSL_CTX_set_default_passwd_cb_userdata()\fR sets a pointer to userdata, \fBu\fR,
 164 which will be provided to the password callback on invocation.
 165 .PP
 166 \&\fBSSL_CTX_get_default_passwd_cb()\fR returns a function pointer to the password
 167 callback currently set in \fBctx\fR. If no callback was explicitly set, the
 168 \&\s-1NULL\s0 pointer is returned.
 169 .PP
 170 \&\fBSSL_CTX_get_default_passwd_cb_userdata()\fR returns a pointer to the userdata
 171 currently set in \fBctx\fR. If no userdata was explicitly set, the \s-1NULL\s0 pointer
 172 is returned.
 173 .PP
 174 \&\fBSSL_set_default_passwd_cb()\fR, \fBSSL_set_default_passwd_cb_userdata()\fR,
 175 \&\fBSSL_get_default_passwd_cb()\fR and \fBSSL_get_default_passwd_cb_userdata()\fR perform
 176 the same function as their \s-1SSL_CTX\s0 counterparts, but using an \s-1SSL\s0 object.
 177 .PP
 178 The password callback, which must be provided by the application, hands back the
 179 password to be used during decryption.
 180 On invocation a pointer to userdata
 181 is provided. The function must store the password into the provided buffer
 182 \&\fBbuf\fR which is of size \fBsize\fR. The actual length of the password must
 183 be returned to the calling function. \fBrwflag\fR indicates whether the
 184 callback is used for reading/decryption (rwflag=0) or writing/encryption
 185 (rwflag=1).
 186 For more details, see \fBpem_password_cb\fR\|(3).
 187 .SH "NOTES"
 188 .IX Header "NOTES"
 189 When loading or storing private keys, a password might be supplied to
 190 protect the private key. The way this password can be supplied may depend
 191 on the application. If only one private key is handled, it can be practical
 192 to have the callback handle the password dialog interactively. If several
 193 keys have to be handled, it can be practical to ask for the password once,
 194 then keep it in memory and use it several times. In the last case, the
 195 password could be stored into the userdata storage and the
 196 callback only returns the password already stored.
 197 .PP
 198 When asking for the password interactively, the callback can use
 199 \&\fBrwflag\fR to check, whether an item shall be encrypted (rwflag=1).
 200 In this case the password dialog may ask for the same password twice
 201 for comparison in order to catch typos, that would make decryption
 202 impossible.
 203 .PP
 204 Other items in \s-1PEM\s0 formatting (certificates) can also be encrypted, it is
 205 however not usual, as certificate information is considered public.
 206 .SH "RETURN VALUES"
 207 .IX Header "RETURN VALUES"
 208 These functions do not provide diagnostic information.
 209 .SH "EXAMPLES"
 210 .IX Header "EXAMPLES"
 211 The following example returns the password provided as userdata to the
 212 calling function. The password is considered to be a '\e0' terminated
 213 string. If the password does not fit into the buffer, the password is
 214 truncated.
 215 .PP
 216 .Vb 6
 217 \& int my_cb(char *buf, int size, int rwflag, void *u)
 218 \& {
 219 \&     strncpy(buf, (char *)u, size);
 220 \&     buf[size \- 1] = \*(Aq\e0\*(Aq;
 221 \&     return strlen(buf);
 222 \& }
 223 .Ve
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fBssl\fR\|(7),
 227 \&\fBSSL_CTX_use_certificate\fR\|(3)
 228 .SH "HISTORY"
 229 .IX Header "HISTORY"
 230 \&\fBSSL_CTX_get_default_passwd_cb()\fR, \fBSSL_CTX_get_default_passwd_cb_userdata()\fR,
 231 \&\fBSSL_set_default_passwd_cb()\fR and \fBSSL_set_default_passwd_cb_userdata()\fR were
 232 added in OpenSSL 1.1.0.
 233 .SH "COPYRIGHT"
 234 .IX Header "COPYRIGHT"
 235 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 236 .PP
 237 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 238 this file except in compliance with the License.  You can obtain a copy
 239 in the file \s-1LICENSE\s0 in the source distribution or at
 240 <https://www.openssl.org/source/license.html>.