1.\" $OpenBSD: ERR_print_errors.3,v 1.8 2020/03/28 22:40:58 schwarze Exp $ 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 3.\" 4.\" This file was written by Ulf Moeller <ulf@openssl.org>, 5.\" with additions by Rich Salz <rsalz@openssl.org>. 6.\" Copyright (c) 2000, 2016 The OpenSSL Project. All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in 17.\" the documentation and/or other materials provided with the 18.\" distribution. 19.\" 20.\" 3. All advertising materials mentioning features or use of this 21.\" software must display the following acknowledgment: 22.\" "This product includes software developed by the OpenSSL Project 23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 24.\" 25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 26.\" endorse or promote products derived from this software without 27.\" prior written permission. For written permission, please contact 28.\" openssl-core@openssl.org. 29.\" 30.\" 5. Products derived from this software may not be called "OpenSSL" 31.\" nor may "OpenSSL" appear in their names without prior written 32.\" permission of the OpenSSL Project. 33.\" 34.\" 6. Redistributions of any form whatsoever must retain the following 35.\" acknowledgment: 36.\" "This product includes software developed by the OpenSSL Project 37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 38.\" 39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" 52.Dd $Mdocdate: March 28 2020 $ 53.Dt ERR_PRINT_ERRORS 3 54.Os 55.Sh NAME 56.Nm ERR_print_errors , 57.Nm ERR_print_errors_fp , 58.Nm ERR_print_errors_cb 59.Nd print OpenSSL error messages 60.Sh SYNOPSIS 61.In openssl/err.h 62.Ft void 63.Fo ERR_print_errors 64.Fa "BIO *bp" 65.Fc 66.Ft void 67.Fo ERR_print_errors_fp 68.Fa "FILE *fp" 69.Fc 70.Ft void 71.Fo ERR_print_errors_cb 72.Fa "int (*cb)(const char *str, size_t len, void *u)" 73.Fa "void *u" 74.Fc 75.Sh DESCRIPTION 76.Fn ERR_print_errors 77is a convenience function that prints the error strings for all errors 78that OpenSSL has recorded to 79.Fa bp , 80thus emptying the error queue. 81.Pp 82.Fn ERR_print_errors_fp 83is the same, except that the output goes to a 84.Vt FILE . 85.Pp 86.Fn ERR_print_errors_cb 87is the same, except that the callback function, 88.Fa cb , 89is called for each error line with the string, length, and userdata 90.Fa u 91as the callback parameters. 92.Pp 93The error strings have the following format: 94.Bd -literal 95[pid]:error:[error code]:[library name]:[function name]:[reason string]: 96[file name]:[line]:[optional text message] 97.Ed 98.Pp 99The error code is an 8-digit hexadecimal number. 100The library name, the function name, and the reason string are ASCII 101text, as is the optional text message if one was set for the 102respective error code. 103.Pp 104If there is no text string registered for the given error code, the 105error string will contain the numeric code. 106.Sh SEE ALSO 107.Xr ERR 3 , 108.Xr ERR_error_string 3 , 109.Xr ERR_get_error 3 , 110.Xr ERR_load_crypto_strings 3 , 111.Xr SSL_load_error_strings 3 112.Sh HISTORY 113.Fn ERR_print_errors 114first appeared in SSLeay 0.4.5. 115.Fn ERR_print_errors_fp 116first appeared in SSLeay 0.6.0. 117Both functions have been available since 118.Ox 2.4 . 119.Pp 120.Fn ERR_print_errors_cb 121first appeared in OpenSSL 0.9.7 and has been available since 122.Ox 3.2 . 123