xref: /freebsd/crypto/openssl/doc/man3/PKCS12_newpass.pod (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1=pod
2
3=head1 NAME
4
5PKCS12_newpass - change the password of a PKCS12 structure
6
7=head1 SYNOPSIS
8
9 #include <openssl/pkcs12.h>
10
11 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
12
13=head1 DESCRIPTION
14
15PKCS12_newpass() changes the password of a PKCS12 structure.
16
17B<p12> is a pointer to a PKCS12 structure. B<oldpass> is the existing password
18and B<newpass> is the new password.
19
20Each of B<oldpass> and B<newpass> is independently interpreted as a string in
21the UTF-8 encoding. If it is not valid UTF-8, it is assumed to be ISO8859-1
22instead.
23
24In particular, this means that passwords in the locale character set
25(or code page on Windows) must potentially be converted to UTF-8 before
26use. This may include passwords from local text files, or input from
27the terminal or command line. Refer to the documentation of
28L<UI_OpenSSL(3)>, for example.
29
30If the PKCS#12 structure does not have a password, then you must use the empty
31string "" for B<oldpass>. Using NULL for B<oldpass> will result in a
32PKCS12_newpass() failure.
33
34If the wrong password is used for B<oldpass> then the function will fail,
35with a MAC verification error. In rare cases the PKCS12 structure does not
36contain a MAC: in this case it will usually fail with a decryption padding
37error.
38
39=head1 RETURN VALUES
40
41PKCS12_newpass() returns 1 on success or 0 on failure. Applications can
42retrieve the most recent error from PKCS12_newpass() with ERR_get_error().
43
44=head1 EXAMPLES
45
46This example loads a PKCS#12 file, changes its password and writes out
47the result to a new file.
48
49 #include <stdio.h>
50 #include <stdlib.h>
51 #include <openssl/pem.h>
52 #include <openssl/err.h>
53 #include <openssl/pkcs12.h>
54
55 int main(int argc, char **argv)
56 {
57     FILE *fp;
58     PKCS12 *p12;
59
60     if (argc != 5) {
61         fprintf(stderr, "Usage: pkread p12file password newpass opfile\n");
62         return 1;
63     }
64     if ((fp = fopen(argv[1], "rb")) == NULL) {
65         fprintf(stderr, "Error opening file %s\n", argv[1]);
66         return 1;
67     }
68     p12 = d2i_PKCS12_fp(fp, NULL);
69     fclose(fp);
70     if (p12 == NULL) {
71         fprintf(stderr, "Error reading PKCS#12 file\n");
72         ERR_print_errors_fp(stderr);
73         return 1;
74     }
75     if (PKCS12_newpass(p12, argv[2], argv[3]) == 0) {
76         fprintf(stderr, "Error changing password\n");
77         ERR_print_errors_fp(stderr);
78         PKCS12_free(p12);
79         return 1;
80     }
81     if ((fp = fopen(argv[4], "wb")) == NULL) {
82         fprintf(stderr, "Error opening file %s\n", argv[4]);
83         PKCS12_free(p12);
84         return 1;
85     }
86     i2d_PKCS12_fp(fp, p12);
87     PKCS12_free(p12);
88     fclose(fp);
89     return 0;
90 }
91
92
93=head1 BUGS
94
95The password format is a NULL terminated ASCII string which is converted to
96Unicode form internally. As a result some passwords cannot be supplied to
97this function.
98
99=head1 SEE ALSO
100
101L<PKCS12_create(3)>, L<ERR_get_error(3)>,
102L<passphrase-encoding(7)>
103
104=head1 COPYRIGHT
105
106Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
107
108Licensed under the Apache License 2.0 (the "License").  You may not use
109this file except in compliance with the License.  You can obtain a copy
110in the file LICENSE in the source distribution or at
111L<https://www.openssl.org/source/license.html>.
112
113=cut
114