xref: /openbsd-src/lib/libcrypto/bio/bss_fd.c (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1 /* $OpenBSD: bss_fd.c,v 1.17 2014/07/11 08:44:47 jsing 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 #if defined(OPENSSL_NO_POSIX_IO)
67 /*
68  * One can argue that one should implement dummy placeholder for
69  * BIO_s_fd here...
70  */
71 #else
72 #include <openssl/bio.h>
73 
74 static int fd_write(BIO *h, const char *buf, int num);
75 static int fd_read(BIO *h, char *buf, int size);
76 static int fd_puts(BIO *h, const char *str);
77 static int fd_gets(BIO *h, char *buf, int size);
78 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
79 static int fd_new(BIO *h);
80 static int fd_free(BIO *data);
81 int BIO_fd_should_retry(int s);
82 
83 static BIO_METHOD methods_fdp = {
84 	.type = BIO_TYPE_FD,
85 	.name = "file descriptor",
86 	.bwrite = fd_write,
87 	.bread = fd_read,
88 	.bputs = fd_puts,
89 	.bgets = fd_gets,
90 	.ctrl = fd_ctrl,
91 	.create = fd_new,
92 	.destroy = fd_free
93 };
94 
95 BIO_METHOD *
96 BIO_s_fd(void)
97 {
98 	return (&methods_fdp);
99 }
100 
101 BIO *
102 BIO_new_fd(int fd, int close_flag)
103 {
104 	BIO *ret;
105 	ret = BIO_new(BIO_s_fd());
106 	if (ret == NULL)
107 		return (NULL);
108 	BIO_set_fd(ret, fd, close_flag);
109 	return (ret);
110 }
111 
112 static int
113 fd_new(BIO *bi)
114 {
115 	bi->init = 0;
116 	bi->num = -1;
117 	bi->ptr = NULL;
118 	bi->flags=0;
119 	return (1);
120 }
121 
122 static int
123 fd_free(BIO *a)
124 {
125 	if (a == NULL)
126 		return (0);
127 	if (a->shutdown) {
128 		if (a->init) {
129 			close(a->num);
130 		}
131 		a->init = 0;
132 		a->flags = 0;
133 	}
134 	return (1);
135 }
136 
137 static int
138 fd_read(BIO *b, char *out, int outl)
139 {
140 	int ret = 0;
141 
142 	if (out != NULL) {
143 		errno = 0;
144 		ret = read(b->num, out, outl);
145 		BIO_clear_retry_flags(b);
146 		if (ret <= 0) {
147 			if (BIO_fd_should_retry(ret))
148 				BIO_set_retry_read(b);
149 		}
150 	}
151 	return (ret);
152 }
153 
154 static int
155 fd_write(BIO *b, const char *in, int inl)
156 {
157 	int ret;
158 	errno = 0;
159 	ret = write(b->num, in, inl);
160 	BIO_clear_retry_flags(b);
161 	if (ret <= 0) {
162 		if (BIO_fd_should_retry(ret))
163 			BIO_set_retry_write(b);
164 	}
165 	return (ret);
166 }
167 
168 static long
169 fd_ctrl(BIO *b, int cmd, long num, void *ptr)
170 {
171 	long ret = 1;
172 	int *ip;
173 
174 	switch (cmd) {
175 	case BIO_CTRL_RESET:
176 		num = 0;
177 	case BIO_C_FILE_SEEK:
178 		ret = (long)lseek(b->num, num, 0);
179 		break;
180 	case BIO_C_FILE_TELL:
181 	case BIO_CTRL_INFO:
182 		ret = (long)lseek(b->num, 0, 1);
183 		break;
184 	case BIO_C_SET_FD:
185 		fd_free(b);
186 		b->num= *((int *)ptr);
187 		b->shutdown = (int)num;
188 		b->init = 1;
189 		break;
190 	case BIO_C_GET_FD:
191 		if (b->init) {
192 			ip = (int *)ptr;
193 			if (ip != NULL)
194 				*ip = b->num;
195 			ret = b->num;
196 		} else
197 			ret = -1;
198 		break;
199 	case BIO_CTRL_GET_CLOSE:
200 		ret = b->shutdown;
201 		break;
202 	case BIO_CTRL_SET_CLOSE:
203 		b->shutdown = (int)num;
204 		break;
205 	case BIO_CTRL_PENDING:
206 	case BIO_CTRL_WPENDING:
207 		ret = 0;
208 		break;
209 	case BIO_CTRL_DUP:
210 	case BIO_CTRL_FLUSH:
211 		ret = 1;
212 		break;
213 	default:
214 		ret = 0;
215 		break;
216 	}
217 	return (ret);
218 }
219 
220 static int
221 fd_puts(BIO *bp, const char *str)
222 {
223 	int n, ret;
224 
225 	n = strlen(str);
226 	ret = fd_write(bp, str, n);
227 	return (ret);
228 }
229 
230 static int
231 fd_gets(BIO *bp, char *buf, int size)
232 {
233 	int ret = 0;
234 	char *ptr = buf;
235 	char *end = buf + size - 1;
236 
237 	while ((ptr < end) && (fd_read(bp, ptr, 1) > 0) && (ptr[0] != '\n'))
238 		ptr++;
239 
240 	ptr[0] = '\0';
241 
242 	if (buf[0] != '\0')
243 		ret = strlen(buf);
244 	return (ret);
245 }
246 
247 int
248 BIO_fd_should_retry(int i)
249 {
250 	int err;
251 
252 	if ((i == 0) || (i == -1)) {
253 		err = errno;
254 		return (BIO_fd_non_fatal_error(err));
255 	}
256 	return (0);
257 }
258 
259 int
260 BIO_fd_non_fatal_error(int err)
261 {
262 	switch (err) {
263 	case ENOTCONN:
264 	case EINTR:
265 	case EAGAIN:
266 	case EINPROGRESS:
267 	case EALREADY:
268 		return (1);
269 	default:
270 		break;
271 	}
272 	return (0);
273 }
274 #endif
275