kris/boringssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document ERR_error_string_n standalone.

Browse Source 
Also fully deprecate ERR_error_string. Even when passing an external
buffer, passing the length explicitly is better.

Change-Id: Id2eb5723410f4564ef5e27c54ba79672133368e7
Reviewed-on: https://boringssl-review.googlesource.com/15424
Reviewed-by: Adam Langley <agl@google.com>
This commit is contained in:
David Benjamin 2017-04-23 16:00:20 -04:00 committed by Adam Langley
parent a0cb725b39
commit 0d5bf8d86d
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
include/openssl/err.h
View File

@ -192,28 +192,17 @@ OPENSSL_EXPORT uint32_t ERR_peek_last_error_line_data(const char **file,
const char **data,
int *flags);
/* ERR_error_string generates a human-readable string representing
* |packed_error|, places it at |buf| (which must be at least
* ERR_ERROR_STRING_BUF_LEN bytes long) and returns |buf|. If |buf| is NULL,
* the error string is placed in a static buffer which is returned. (The static
* buffer may be overridden by concurrent calls in other threads so this form
* is deprecated.)
/* ERR_error_string_n generates a human-readable string representing
* |packed_error| and places it at |buf|. It writes at most |len| bytes
* (including the terminating NUL) and truncates the string if necessary. If
* |len| is greater than zero then |buf| is always NUL terminated.
*
* The string will have the following format:
*
* error:[error code]:[library name]:OPENSSL_internal:[reason string]
*
* error code is an 8 digit hexadecimal number; library name and reason string
* are ASCII text.
*
* TODO(fork): remove in favour of |ERR_error_string_n|. */
OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf);
#define ERR_ERROR_STRING_BUF_LEN 256
/* ERR_error_string_n is a variant of |ERR_error_string| that writes at most
* len characters (including the terminating NUL) and truncates the string if
* necessary. If |len| is greater than zero then |buf| is always NUL
* terminated. */
* are ASCII text. */
OPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf,
size_t len);
@ -288,6 +277,18 @@ OPENSSL_EXPORT void ERR_remove_state(unsigned long pid);
/* ERR_func_error_string returns the string "OPENSSL_internal". */
OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error);
/* ERR_error_string behaves like |ERR_error_string_n| but |len| is implicitly
* |ERR_ERROR_STRING_BUF_LEN| and it returns |buf|. If |buf| is NULL, the error
* string is placed in a static buffer which is returned. (The static buffer may
* be overridden by concurrent calls in other threads so this form should not be
* used.)
*
* Use |ERR_error_string_n| instead.
*
* TODO(fork): remove this function. */
OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf);
#define ERR_ERROR_STRING_BUF_LEN 256
/* Private functions. */