secure/lib/libcrypto/man/PKCS12_newpass.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 "PKCS12_NEWPASS 3"
 132 .TH PKCS12_NEWPASS 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 PKCS12_newpass \- change the password of a PKCS12 structure
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/pkcs12.h>
 143 \&
 144 \& int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fIPKCS12_newpass()\fR changes the password of a \s-1PKCS12\s0 structure.
 149 .PP
 150 \&\fBp12\fR is a pointer to a \s-1PKCS12\s0 structure. \fBoldpass\fR is the existing password
 151 and \fBnewpass\fR is the new password.
 152 .SH "NOTES"
 153 .IX Header "NOTES"
 154 Each of \fBoldpass\fR and \fBnewpass\fR is independently interpreted as a string in
 155 the \s-1UTF\-8\s0 encoding. If it is not valid \s-1UTF\-8,\s0 it is assumed to be \s-1ISO8859\-1\s0
 156 instead.
 157 .PP
 158 In particular, this means that passwords in the locale character set
 159 (or code page on Windows) must potentially be converted to \s-1UTF\-8\s0 before
 160 use. This may include passwords from local text files, or input from
 161 the terminal or command line. Refer to the documentation of
 162 \&\fIUI_OpenSSL\fR\|(3), for example.
 163 .SH "RETURN VALUES"
 164 .IX Header "RETURN VALUES"
 165 \&\fIPKCS12_newpass()\fR returns 1 on success or 0 on failure. Applications can
 166 retrieve the most recent error from \fIPKCS12_newpass()\fR with \fIERR_get_error()\fR.
 167 .SH "EXAMPLE"
 168 .IX Header "EXAMPLE"
 169 This example loads a PKCS#12 file, changes its password and writes out
 170 the result to a new file.
 171 .PP
 172 .Vb 5
 173 \& #include <stdio.h>
 174 \& #include <stdlib.h>
 175 \& #include <openssl/pem.h>
 176 \& #include <openssl/err.h>
 177 \& #include <openssl/pkcs12.h>
 178 \&
 179 \& int main(int argc, char **argv)
 180 \& {
 181 \&     FILE *fp;
 182 \&     PKCS12 *p12;
 183 \&
 184 \&     if (argc != 5) {
 185 \&         fprintf(stderr, "Usage: pkread p12file password newpass opfile\en");
 186 \&         return 1;
 187 \&     }
 188 \&     if ((fp = fopen(argv[1], "rb")) == NULL) {
 189 \&         fprintf(stderr, "Error opening file %s\en", argv[1]);
 190 \&         return 1;
 191 \&     }
 192 \&     p12 = d2i_PKCS12_fp(fp, NULL);
 193 \&     fclose(fp);
 194 \&     if (p12 == NULL) {
 195 \&         fprintf(stderr, "Error reading PKCS#12 file\en");
 196 \&         ERR_print_errors_fp(stderr);
 197 \&         return 1;
 198 \&     }
 199 \&     if (PKCS12_newpass(p12, argv[2], argv[3]) == 0) {
 200 \&         fprintf(stderr, "Error changing password\en");
 201 \&         ERR_print_errors_fp(stderr);
 202 \&         PKCS12_free(p12);
 203 \&         return 1;
 204 \&     }
 205 \&     if ((fp = fopen(argv[4], "wb")) == NULL) {
 206 \&         fprintf(stderr, "Error opening file %s\en", argv[4]);
 207 \&         PKCS12_free(p12);
 208 \&         return 1;
 209 \&     }
 210 \&     i2d_PKCS12_fp(fp, p12);
 211 \&     PKCS12_free(p12);
 212 \&     fclose(fp);
 213 \&     return 0;
 214 \& }
 215 .Ve
 216 .SH "NOTES"
 217 .IX Header "NOTES"
 218 If the PKCS#12 structure does not have a password, then you must use the empty
 219 string "" for \fBoldpass\fR. Using \s-1NULL\s0 for \fBoldpass\fR will result in a
 220 \&\fIPKCS12_newpass()\fR failure.
 221 .PP
 222 If the wrong password is used for \fBoldpass\fR then the function will fail,
 223 with a \s-1MAC\s0 verification error. In rare cases the \s-1PKCS12\s0 structure does not
 224 contain a \s-1MAC:\s0 in this case it will usually fail with a decryption padding
 225 error.
 226 .SH "BUGS"
 227 .IX Header "BUGS"
 228 The password format is a \s-1NULL\s0 terminated \s-1ASCII\s0 string which is converted to
 229 Unicode form internally. As a result some passwords cannot be supplied to
 230 this function.
 231 .SH "SEE ALSO"
 232 .IX Header "SEE ALSO"
 233 \&\fIPKCS12_create\fR\|(3), \fIERR_get_error\fR\|(3),
 234 \&\fIpassphrase\-encoding\fR\|(7)
 235 .SH "COPYRIGHT"
 236 .IX Header "COPYRIGHT"
 237 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 238 .PP
 239 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 240 this file except in compliance with the License.  You can obtain a copy
 241 in the file \s-1LICENSE\s0 in the source distribution or at
 242 <https://www.openssl.org/source/license.html>.