diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-12-03 13:40:20 +0100 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2021-12-07 11:23:59 +0100 |
commit | 67890a738c0eb5e92c41189ba3c744fbc98a97ac (patch) | |
tree | 449dc02840c9c1c728ac2af421718864c49bf436 /doc | |
parent | d09f4501e47e0b969caec5a3059af52d227e961a (diff) | |
download | openssl-67890a738c0eb5e92c41189ba3c744fbc98a97ac.tar.gz |
OBJ_obj2txt(): fix off-by-one documentation of the result
Also remove the outdated BUGS section and fix the coding style of the function.
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17188)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/OBJ_nid2obj.pod | 28 |
1 files changed, 11 insertions, 17 deletions
diff --git a/doc/man3/OBJ_nid2obj.pod b/doc/man3/OBJ_nid2obj.pod index ec12b842a5..748e76a584 100644 --- a/doc/man3/OBJ_nid2obj.pod +++ b/doc/man3/OBJ_nid2obj.pod @@ -71,12 +71,14 @@ as well as numerical forms. If I<no_name> is 1 only the numerical form is acceptable. OBJ_obj2txt() converts the B<ASN1_OBJECT> I<a> into a textual representation. -The representation is written as a null terminated string to I<buf> +Unless I<buf> is NULL, +the representation is written as a NUL-terminated string to I<buf>, where at most I<buf_len> bytes are written, truncating the result if necessary. -The total amount of space required is returned. If I<no_name> is 0 then -if the object has a long or short name then that will be used, otherwise -the numerical form will be used. If I<no_name> is 1 then the numerical -form will always be used. +In any case it returns the total string length, excluding the NUL character, +required for non-truncated representation, or -1 on error. +If I<no_name> is 0 then if the object has a long or short name +then that will be used, otherwise the numerical form will be used. +If I<no_name> is 1 then the numerical form will always be used. i2t_ASN1_OBJECT() is the same as OBJ_obj2txt() with the I<no_name> set to zero. @@ -155,9 +157,10 @@ a NID or B<NID_undef> on error. OBJ_add_sigid() returns 1 on success or 0 on error. -OBJ_obj2txt() returns the number of bytes written to I<buf> if I<buf_len> is big enough. -Otherwise, the result is truncated and the total amount of space required is returned. -It also returns -1 on error. +i2t_ASN1_OBJECT() an OBJ_obj2txt() return -1 on error. +On success, they return the length of the string written to I<buf> if I<buf> is +not NULL and I<buf_len> is big enough, otherwise the total string length. +Note that this does not count the trailing NUL character. =head1 EXAMPLES @@ -179,15 +182,6 @@ Create a new object directly: obj = OBJ_txt2obj("1.2.3.4", 1); -=head1 BUGS - -OBJ_obj2txt() is awkward and messy to use: it doesn't follow the -convention of other OpenSSL functions where the buffer can be set -to B<NULL> to determine the amount of data that should be written. -Instead I<buf> must point to a valid buffer and I<buf_len> should -be set to a positive value. A buffer length of 80 should be more -than enough to handle any OID encountered in practice. - =head1 SEE ALSO L<ERR_get_error(3)> |