xref: /openbsd-src/lib/libcrypto/bio/bss_fd.c (revision acf644016ec1190723fc541ba590471e90a9ef53)
1 /* $OpenBSD: bss_fd.c,v 1.21 2023/07/05 21:23:37 beck Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #include <errno.h>
60 #include <stdio.h>
61 #include <string.h>
62 #include <unistd.h>
63 
64 #include <openssl/opensslconf.h>
65 
66 #include <openssl/bio.h>
67 
68 #include "bio_local.h"
69 
70 static int fd_write(BIO *h, const char *buf, int num);
71 static int fd_read(BIO *h, char *buf, int size);
72 static int fd_puts(BIO *h, const char *str);
73 static int fd_gets(BIO *h, char *buf, int size);
74 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
75 static int fd_new(BIO *h);
76 static int fd_free(BIO *data);
77 int BIO_fd_should_retry(int s);
78 
79 static const BIO_METHOD methods_fdp = {
80 	.type = BIO_TYPE_FD,
81 	.name = "file descriptor",
82 	.bwrite = fd_write,
83 	.bread = fd_read,
84 	.bputs = fd_puts,
85 	.bgets = fd_gets,
86 	.ctrl = fd_ctrl,
87 	.create = fd_new,
88 	.destroy = fd_free
89 };
90 
91 const BIO_METHOD *
BIO_s_fd(void)92 BIO_s_fd(void)
93 {
94 	return (&methods_fdp);
95 }
96 LCRYPTO_ALIAS(BIO_s_fd);
97 
98 BIO *
BIO_new_fd(int fd,int close_flag)99 BIO_new_fd(int fd, int close_flag)
100 {
101 	BIO *ret;
102 	ret = BIO_new(BIO_s_fd());
103 	if (ret == NULL)
104 		return (NULL);
105 	BIO_set_fd(ret, fd, close_flag);
106 	return (ret);
107 }
108 LCRYPTO_ALIAS(BIO_new_fd);
109 
110 static int
fd_new(BIO * bi)111 fd_new(BIO *bi)
112 {
113 	bi->init = 0;
114 	bi->num = -1;
115 	bi->ptr = NULL;
116 	bi->flags=0;
117 	return (1);
118 }
119 
120 static int
fd_free(BIO * a)121 fd_free(BIO *a)
122 {
123 	if (a == NULL)
124 		return (0);
125 	if (a->shutdown) {
126 		if (a->init) {
127 			close(a->num);
128 		}
129 		a->init = 0;
130 		a->flags = 0;
131 	}
132 	return (1);
133 }
134 
135 static int
fd_read(BIO * b,char * out,int outl)136 fd_read(BIO *b, char *out, int outl)
137 {
138 	int ret = 0;
139 
140 	if (out != NULL) {
141 		errno = 0;
142 		ret = read(b->num, out, outl);
143 		BIO_clear_retry_flags(b);
144 		if (ret <= 0) {
145 			if (BIO_fd_should_retry(ret))
146 				BIO_set_retry_read(b);
147 		}
148 	}
149 	return (ret);
150 }
151 
152 static int
fd_write(BIO * b,const char * in,int inl)153 fd_write(BIO *b, const char *in, int inl)
154 {
155 	int ret;
156 	errno = 0;
157 	ret = write(b->num, in, inl);
158 	BIO_clear_retry_flags(b);
159 	if (ret <= 0) {
160 		if (BIO_fd_should_retry(ret))
161 			BIO_set_retry_write(b);
162 	}
163 	return (ret);
164 }
165 
166 static long
fd_ctrl(BIO * b,int cmd,long num,void * ptr)167 fd_ctrl(BIO *b, int cmd, long num, void *ptr)
168 {
169 	long ret = 1;
170 	int *ip;
171 
172 	switch (cmd) {
173 	case BIO_CTRL_RESET:
174 		num = 0;
175 	case BIO_C_FILE_SEEK:
176 		ret = (long)lseek(b->num, num, 0);
177 		break;
178 	case BIO_C_FILE_TELL:
179 	case BIO_CTRL_INFO:
180 		ret = (long)lseek(b->num, 0, 1);
181 		break;
182 	case BIO_C_SET_FD:
183 		fd_free(b);
184 		b->num= *((int *)ptr);
185 		b->shutdown = (int)num;
186 		b->init = 1;
187 		break;
188 	case BIO_C_GET_FD:
189 		if (b->init) {
190 			ip = (int *)ptr;
191 			if (ip != NULL)
192 				*ip = b->num;
193 			ret = b->num;
194 		} else
195 			ret = -1;
196 		break;
197 	case BIO_CTRL_GET_CLOSE:
198 		ret = b->shutdown;
199 		break;
200 	case BIO_CTRL_SET_CLOSE:
201 		b->shutdown = (int)num;
202 		break;
203 	case BIO_CTRL_PENDING:
204 	case BIO_CTRL_WPENDING:
205 		ret = 0;
206 		break;
207 	case BIO_CTRL_DUP:
208 	case BIO_CTRL_FLUSH:
209 		ret = 1;
210 		break;
211 	default:
212 		ret = 0;
213 		break;
214 	}
215 	return (ret);
216 }
217 
218 static int
fd_puts(BIO * bp,const char * str)219 fd_puts(BIO *bp, const char *str)
220 {
221 	int n, ret;
222 
223 	n = strlen(str);
224 	ret = fd_write(bp, str, n);
225 	return (ret);
226 }
227 
228 static int
fd_gets(BIO * bp,char * buf,int size)229 fd_gets(BIO *bp, char *buf, int size)
230 {
231 	int ret = 0;
232 	char *ptr = buf;
233 	char *end = buf + size - 1;
234 
235 	while ((ptr < end) && (fd_read(bp, ptr, 1) > 0) && (ptr[0] != '\n'))
236 		ptr++;
237 
238 	ptr[0] = '\0';
239 
240 	if (buf[0] != '\0')
241 		ret = strlen(buf);
242 	return (ret);
243 }
244 
245 int
BIO_fd_should_retry(int i)246 BIO_fd_should_retry(int i)
247 {
248 	int err;
249 
250 	if ((i == 0) || (i == -1)) {
251 		err = errno;
252 		return (BIO_fd_non_fatal_error(err));
253 	}
254 	return (0);
255 }
256 LCRYPTO_ALIAS(BIO_fd_should_retry);
257 
258 int
BIO_fd_non_fatal_error(int err)259 BIO_fd_non_fatal_error(int err)
260 {
261 	switch (err) {
262 	case ENOTCONN:
263 	case EINTR:
264 	case EAGAIN:
265 	case EINPROGRESS:
266 	case EALREADY:
267 		return (1);
268 	default:
269 		break;
270 	}
271 	return (0);
272 }
273 LCRYPTO_ALIAS(BIO_fd_non_fatal_error);
274