secure/lib/libcrypto/man/SSL_CTX_set_default_passwd_cb.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_SET_DEFAULT_PASSWD_CB 3"
 132 .TH SSL_CTX_SET_DEFAULT_PASSWD_CB 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
 145 \& void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);
 146 \& pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);
 147 \& void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);
 148 \&
 149 \& void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb);
 150 \& void SSL_set_default_passwd_cb_userdata(SSL *s, void *u);
 151 \& pem_password_cb *SSL_get_default_passwd_cb(SSL *s);
 152 \& void *SSL_get_default_passwd_cb_userdata(SSL *s);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_CTX_set_default_passwd_cb()\fR sets the default password callback called
 157 when loading/storing a \s-1PEM\s0 certificate with encryption.
 158 .PP
 159 \&\fISSL_CTX_set_default_passwd_cb_userdata()\fR sets a pointer to userdata, \fBu\fR,
 160 which will be provided to the password callback on invocation.
 161 .PP
 162 \&\fISSL_CTX_get_default_passwd_cb()\fR returns a function pointer to the password
 163 callback currently set in \fBctx\fR. If no callback was explicitly set, the
 164 \&\s-1NULL\s0 pointer is returned.
 165 .PP
 166 \&\fISSL_CTX_get_default_passwd_cb_userdata()\fR returns a pointer to the userdata
 167 currently set in \fBctx\fR. If no userdata was explicitly set, the \s-1NULL\s0 pointer
 168 is returned.
 169 .PP
 170 \&\fISSL_set_default_passwd_cb()\fR, \fISSL_set_default_passwd_cb_userdata()\fR,
 171 \&\fISSL_get_default_passwd_cb()\fR and \fISSL_get_default_passwd_cb_userdata()\fR perform
 172 the same function as their \s-1SSL_CTX\s0 counterparts, but using an \s-1SSL\s0 object.
 173 .PP
 174 The password callback, which must be provided by the application, hands back the
 175 password to be used during decryption.
 176 On invocation a pointer to userdata
 177 is provided. The function must store the password into the provided buffer
 178 \&\fBbuf\fR which is of size \fBsize\fR. The actual length of the password must
 179 be returned to the calling function. \fBrwflag\fR indicates whether the
 180 callback is used for reading/decryption (rwflag=0) or writing/encryption
 181 (rwflag=1).
 182 For more details, see \fIpem_password_cb\fR\|(3).
 183 .SH "NOTES"
 184 .IX Header "NOTES"
 185 When loading or storing private keys, a password might be supplied to
 186 protect the private key. The way this password can be supplied may depend
 187 on the application. If only one private key is handled, it can be practical
 188 to have the callback handle the password dialog interactively. If several
 189 keys have to be handled, it can be practical to ask for the password once,
 190 then keep it in memory and use it several times. In the last case, the
 191 password could be stored into the userdata storage and the
 192 callback only returns the password already stored.
 193 .PP
 194 When asking for the password interactively, the callback can use
 195 \&\fBrwflag\fR to check, whether an item shall be encrypted (rwflag=1).
 196 In this case the password dialog may ask for the same password twice
 197 for comparison in order to catch typos, that would make decryption
 198 impossible.
 199 .PP
 200 Other items in \s-1PEM\s0 formatting (certificates) can also be encrypted, it is
 201 however not usual, as certificate information is considered public.
 202 .SH "RETURN VALUES"
 203 .IX Header "RETURN VALUES"
 204 These functions do not provide diagnostic information.
 205 .SH "EXAMPLES"
 206 .IX Header "EXAMPLES"
 207 The following example returns the password provided as userdata to the
 208 calling function. The password is considered to be a '\e0' terminated
 209 string. If the password does not fit into the buffer, the password is
 210 truncated.
 211 .PP
 212 .Vb 6
 213 \& int my_cb(char *buf, int size, int rwflag, void *u)
 214 \& {
 215 \&     strncpy(buf, (char *)u, size);
 216 \&     buf[size \- 1] = \*(Aq\e0\*(Aq;
 217 \&     return strlen(buf);
 218 \& }
 219 .Ve
 220 .SH "HISTORY"
 221 .IX Header "HISTORY"
 222 \&\fISSL_CTX_get_default_passwd_cb()\fR, \fISSL_CTX_get_default_passwd_cb_userdata()\fR,
 223 \&\fISSL_set_default_passwd_cb()\fR and \fISSL_set_default_passwd_cb_userdata()\fR were
 224 first added to OpenSSL 1.1.0
 225 .SH "SEE ALSO"
 226 .IX Header "SEE ALSO"
 227 \&\fIssl\fR\|(7),
 228 \&\fISSL_CTX_use_certificate\fR\|(3)
 229 .SH "COPYRIGHT"
 230 .IX Header "COPYRIGHT"
 231 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 232 .PP
 233 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 234 this file except in compliance with the License.  You can obtain a copy
 235 in the file \s-1LICENSE\s0 in the source distribution or at
 236 <https://www.openssl.org/source/license.html>.