From 768f4c673e8262a34b19242e5f508c8e3f85a625 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Fri, 18 Nov 2016 18:44:11 +0000 Subject: Add Copyright and license. Bring in two clarifying sentences from OpenSSL. --- src/lib/libcrypto/man/BIO_read.3 | 57 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-) diff --git a/src/lib/libcrypto/man/BIO_read.3 b/src/lib/libcrypto/man/BIO_read.3 index f19c31ecab..896e41dd43 100644 --- a/src/lib/libcrypto/man/BIO_read.3 +++ b/src/lib/libcrypto/man/BIO_read.3 @@ -1,6 +1,54 @@ -.\" $OpenBSD: BIO_read.3,v 1.3 2016/11/07 15:52:47 jmc Exp $ +.\" $OpenBSD: BIO_read.3,v 1.4 2016/11/18 18:44:11 schwarze Exp $ +.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 .\" -.Dd $Mdocdate: November 7 2016 $ +.\" This file was written by Dr. Stephen Henson . +.\" Copyright (c) 2000, 2016 The OpenSSL Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" +.\" 3. All advertising materials mentioning features or use of this +.\" software must display the following acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" +.\" +.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to +.\" endorse or promote products derived from this software without +.\" prior written permission. For written permission, please contact +.\" openssl-core@openssl.org. +.\" +.\" 5. Products derived from this software may not be called "OpenSSL" +.\" nor may "OpenSSL" appear in their names without prior written +.\" permission of the OpenSSL Project. +.\" +.\" 6. Redistributions of any form whatsoever must retain the following +.\" acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY +.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR +.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +.\" OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd $Mdocdate: November 18 2016 $ .Dt BIO_READ 3 .Os .Sh NAME @@ -48,13 +96,14 @@ performs the BIOs "gets" operation and places the data in .Fa buf . Usually this operation will attempt to read a line of data from the BIO of maximum length -.Fa len . +.Fa len No - 1 . There are exceptions to this however, for example .Fn BIO_gets on a digest BIO will calculate and return the digest and other BIOs may not support .Fn BIO_gets at all. +The returned string is always NUL-terminated. .Pp .Fn BIO_write attempts to write @@ -108,6 +157,8 @@ read or written (if the return value is positive) or that no data was successfully read or written if the result is 0 or -1. If the return value is -2, then the operation is not implemented in the specific BIO type. +The trailing NUL is not included in the length returned by +.Fn BIO_gets . .Pp A 0 or -1 return is not necessarily an indication of an error. In particular when the source/sink is non-blocking or of a certain type -- cgit v1.2.3-55-g6feb