lib/libssl/man/SSL_CTX_set_default_passwd_cb.3

   1 .\"     $OpenBSD: SSL_CTX_set_default_passwd_cb.3,v 1.2 2016/11/30 18:05:18 schwarze Exp $
   2 .\"     OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2000, 2001 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: November 30 2016 $
  52 .Dt SSL_CTX_SET_DEFAULT_PASSWD_CB 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_set_default_passwd_cb ,
  56 .Nm SSL_CTX_set_default_passwd_cb_userdata
  57 .Nd set passwd callback for encrypted PEM file handling
  58 .Sh SYNOPSIS
  59 .In openssl/ssl.h
  60 .Ft void
  61 .Fn SSL_CTX_set_default_passwd_cb "SSL_CTX *ctx" "pem_password_cb *cb"
  62 .Ft void
  63 .Fn SSL_CTX_set_default_passwd_cb_userdata "SSL_CTX *ctx" "void *u"
  64 .In openssl/pem.h
  65 .Ft typedef int
  66 .Fn pem_password_cb "char *buf" "int size" "int rwflag" "void *userdata"
  67 .Sh DESCRIPTION
  68 .Fn SSL_CTX_set_default_passwd_cb
  69 sets the default password callback called when loading/storing a PEM
  70 certificate with encryption.
  71 .Pp
  72 .Fn SSL_CTX_set_default_passwd_cb_userdata
  73 sets a pointer to userdata
  74 .Fa u
  75 which will be provided to the password callback on invocation.
  76 .Pp
  77 The
  78 password callback
  79 .Fa cb ,
  80 which must be provided by the application,
  81 hands back the password to be used during decryption.
  82 On invocation a pointer to
  83 .Fa userdata
  84 is provided.
  85 The password callback must write the password into the provided buffer
  86 .Fa buf
  87 which is of size
  88 .Fa size .
  89 The actual length of the password must be returned to the calling function.
  90 .Fa rwflag
  91 indicates whether the callback is used for reading/decryption
  92 .Pq Fa rwflag No = 0
  93 or writing/encryption
  94 .Pq Fa rwflag No = 1 .
  95 .Pp
  96 When loading or storing private keys, a password might be supplied to protect
  97 the private key.
  98 The way this password can be supplied may depend on the application.
  99 If only one private key is handled, it can be practical to have the
 100 callback handle the password dialog interactively.
 101 If several keys have to be handled, it can be practical to ask for the password
 102 once, then keep it in memory and use it several times.
 103 In the last case, the password could be stored into the
 104 .Fa userdata
 105 storage and the callback only returns the password already stored.
 106 .Pp
 107 When asking for the password interactively, the callback can use
 108 .Fa rwflag
 109 to check whether an item shall be encrypted
 110 .Pq Fa rwflag No = 1 .
 111 In this case the password dialog may ask for the same password twice for
 112 comparison in order to catch typos which would make decryption impossible.
 113 .Pp
 114 Other items in PEM formatting (certificates) can also be encrypted; it is
 115 however atypical, as certificate information is considered public.
 116 .Sh EXAMPLES
 117 The following example returns the password provided as
 118 .Fa userdata
 119 to the calling function.
 120 The password is considered to be a
 121 .Sq \e0
 122 terminated string.
 123 If the password does not fit into the buffer, the password is truncated.
 124 .Bd -literal
 125 int pem_passwd_cb(char *buf, int size, int rwflag, void *password)
 126 {
 127         strncpy(buf, (char *)password, size);
 128         buf[size - 1] = '\e0';
 129         return strlen(buf);
 130 }
 131 .Ed
 132 .Sh SEE ALSO
 133 .Xr ssl 3 ,
 134 .Xr SSL_CTX_use_certificate 3