xref: /freebsd/secure/lib/libcrypto/man/man3/PKCS12_newpass.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "PKCS12_NEWPASS 3ossl"
PKCS12_NEWPASS 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
PKCS12_newpass - change the password of a PKCS12 structure
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/pkcs12.h> \& int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBPKCS12_newpass() changes the password of a \s-1PKCS12\s0 structure.

\fBp12 is a pointer to a \s-1PKCS12\s0 structure. oldpass is the existing password and newpass is the new password.

Each of oldpass and newpass is independently interpreted as a string in the \s-1UTF-8\s0 encoding. If it is not valid \s-1UTF-8,\s0 it is assumed to be \s-1ISO8859-1\s0 instead.

In particular, this means that passwords in the locale character set (or code page on Windows) must potentially be converted to \s-1UTF-8\s0 before use. This may include passwords from local text files, or input from the terminal or command line. Refer to the documentation of \fBUI_OpenSSL\|(3), for example.

If the PKCS#12 structure does not have a password, then you must use the empty string "" for oldpass. Using \s-1NULL\s0 for oldpass will result in a \fBPKCS12_newpass() failure.

If the wrong password is used for oldpass then the function will fail, with a \s-1MAC\s0 verification error. In rare cases the \s-1PKCS12\s0 structure does not contain a \s-1MAC:\s0 in this case it will usually fail with a decryption padding error.

"RETURN VALUES"
Header "RETURN VALUES" \fBPKCS12_newpass() returns 1 on success or 0 on failure. Applications can retrieve the most recent error from PKCS12_newpass() with ERR_get_error().
"EXAMPLES"
Header "EXAMPLES" This example loads a PKCS#12 file, changes its password and writes out the result to a new file.

.Vb 5 #include <stdio.h> #include <stdlib.h> #include <openssl/pem.h> #include <openssl/err.h> #include <openssl/pkcs12.h> \& int main(int argc, char **argv) { FILE *fp; PKCS12 *p12; \& if (argc != 5) { fprintf(stderr, "Usage: pkread p12file password newpass opfile\en"); return 1; } if ((fp = fopen(argv[1], "rb")) == NULL) { fprintf(stderr, "Error opening file %s\en", argv[1]); return 1; } p12 = d2i_PKCS12_fp(fp, NULL); fclose(fp); if (p12 == NULL) { fprintf(stderr, "Error reading PKCS#12 file\en"); ERR_print_errors_fp(stderr); return 1; } if (PKCS12_newpass(p12, argv[2], argv[3]) == 0) { fprintf(stderr, "Error changing password\en"); ERR_print_errors_fp(stderr); PKCS12_free(p12); return 1; } if ((fp = fopen(argv[4], "wb")) == NULL) { fprintf(stderr, "Error opening file %s\en", argv[4]); PKCS12_free(p12); return 1; } i2d_PKCS12_fp(fp, p12); PKCS12_free(p12); fclose(fp); return 0; } .Ve

"BUGS"
Header "BUGS" The password format is a \s-1NULL\s0 terminated \s-1ASCII\s0 string which is converted to Unicode form internally. As a result some passwords cannot be supplied to this function.
"SEE ALSO"
Header "SEE ALSO" \fBPKCS12_create\|(3), ERR_get_error\|(3), \fBpassphrase-encoding\|(7)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.