xref: /openbsd/lib/libcrypto/bio/bss_sock.c (revision 733f90f0)
1 /* $OpenBSD: bss_sock.c,v 1.27 2023/08/07 10:54:14 tb 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 <sys/socket.h>
60 
61 #include <errno.h>
62 #include <stdio.h>
63 #include <string.h>
64 #include <unistd.h>
65 
66 #include <openssl/bio.h>
67 
68 #include "bio_local.h"
69 
70 static int sock_write(BIO *h, const char *buf, int num);
71 static int sock_read(BIO *h, char *buf, int size);
72 static int sock_puts(BIO *h, const char *str);
73 static long sock_ctrl(BIO *h, int cmd, long arg1, void *arg2);
74 static int sock_new(BIO *h);
75 static int sock_free(BIO *data);
76 int BIO_sock_should_retry(int s);
77 
78 static const BIO_METHOD methods_sockp = {
79 	.type = BIO_TYPE_SOCKET,
80 	.name = "socket",
81 	.bwrite = sock_write,
82 	.bread = sock_read,
83 	.bputs = sock_puts,
84 	.ctrl = sock_ctrl,
85 	.create = sock_new,
86 	.destroy = sock_free
87 };
88 
89 const BIO_METHOD *
BIO_s_socket(void)90 BIO_s_socket(void)
91 {
92 	return (&methods_sockp);
93 }
94 LCRYPTO_ALIAS(BIO_s_socket);
95 
96 BIO *
BIO_new_socket(int fd,int close_flag)97 BIO_new_socket(int fd, int close_flag)
98 {
99 	BIO *ret;
100 
101 	ret = BIO_new(BIO_s_socket());
102 	if (ret == NULL)
103 		return (NULL);
104 	BIO_set_fd(ret, fd, close_flag);
105 	return (ret);
106 }
107 LCRYPTO_ALIAS(BIO_new_socket);
108 
109 static int
sock_new(BIO * bi)110 sock_new(BIO *bi)
111 {
112 	bi->init = 0;
113 	bi->num = 0;
114 	bi->ptr = NULL;
115 	bi->flags = 0;
116 	return (1);
117 }
118 
119 static int
sock_free(BIO * a)120 sock_free(BIO *a)
121 {
122 	if (a == NULL)
123 		return (0);
124 	if (a->shutdown) {
125 		if (a->init) {
126 			shutdown(a->num, SHUT_RDWR);
127 			close(a->num);
128 		}
129 		a->init = 0;
130 		a->flags = 0;
131 	}
132 	return (1);
133 }
134 
135 static int
sock_read(BIO * b,char * out,int outl)136 sock_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_sock_should_retry(ret))
146 				BIO_set_retry_read(b);
147 		}
148 	}
149 	return (ret);
150 }
151 
152 static int
sock_write(BIO * b,const char * in,int inl)153 sock_write(BIO *b, const char *in, int inl)
154 {
155 	int ret;
156 
157 	errno = 0;
158 	ret = write(b->num, in, inl);
159 	BIO_clear_retry_flags(b);
160 	if (ret <= 0) {
161 		if (BIO_sock_should_retry(ret))
162 			BIO_set_retry_write(b);
163 	}
164 	return (ret);
165 }
166 
167 static long
sock_ctrl(BIO * b,int cmd,long num,void * ptr)168 sock_ctrl(BIO *b, int cmd, long num, void *ptr)
169 {
170 	long ret = 1;
171 	int *ip;
172 
173 	switch (cmd) {
174 	case BIO_C_SET_FD:
175 		sock_free(b);
176 		b->num = *((int *)ptr);
177 		b->shutdown = (int)num;
178 		b->init = 1;
179 		break;
180 	case BIO_C_GET_FD:
181 		if (b->init) {
182 			ip = (int *)ptr;
183 			if (ip != NULL)
184 				*ip = b->num;
185 			ret = b->num;
186 		} else
187 			ret = -1;
188 		break;
189 	case BIO_CTRL_GET_CLOSE:
190 		ret = b->shutdown;
191 		break;
192 	case BIO_CTRL_SET_CLOSE:
193 		b->shutdown = (int)num;
194 		break;
195 	case BIO_CTRL_DUP:
196 	case BIO_CTRL_FLUSH:
197 		ret = 1;
198 		break;
199 	default:
200 		ret = 0;
201 		break;
202 	}
203 	return (ret);
204 }
205 
206 static int
sock_puts(BIO * bp,const char * str)207 sock_puts(BIO *bp, const char *str)
208 {
209 	int n, ret;
210 
211 	n = strlen(str);
212 	ret = sock_write(bp, str, n);
213 	return (ret);
214 }
215 
216 int
BIO_sock_should_retry(int i)217 BIO_sock_should_retry(int i)
218 {
219 	int err;
220 
221 	if ((i == 0) || (i == -1)) {
222 		err = errno;
223 		return (BIO_sock_non_fatal_error(err));
224 	}
225 	return (0);
226 }
227 LCRYPTO_ALIAS(BIO_sock_should_retry);
228 
229 int
BIO_sock_non_fatal_error(int err)230 BIO_sock_non_fatal_error(int err)
231 {
232 	switch (err) {
233 	case ENOTCONN:
234 	case EINTR:
235 	case EAGAIN:
236 	case EINPROGRESS:
237 	case EALREADY:
238 		return (1);
239 	default:
240 		break;
241 	}
242 	return (0);
243 }
244 LCRYPTO_ALIAS(BIO_sock_non_fatal_error);
245