[thirdparty/openssl.git] / crypto / bio / bf_lbuf.c

/*
 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdio.h>
#include <errno.h>
#include "bio_local.h"
#include "internal/cryptlib.h"
#include <openssl/evp.h>

static int linebuffer_write(BIO *h, const char *buf, int num);
static int linebuffer_read(BIO *h, char *buf, int size);
static int linebuffer_puts(BIO *h, const char *str);
static int linebuffer_gets(BIO *h, char *str, int size);
static long linebuffer_ctrl(BIO *h, int cmd, long arg1, void *arg2);
static int linebuffer_new(BIO *h);
static int linebuffer_free(BIO *data);
static long linebuffer_callback_ctrl(BIO *h, int cmd, BIO_info_cb *fp);

/* A 10k maximum should be enough for most purposes */
#define DEFAULT_LINEBUFFER_SIZE 1024*10

/* #define DEBUG */

static const BIO_METHOD methods_linebuffer = {
    BIO_TYPE_LINEBUFFER,
    "linebuffer",
    bwrite_conv,
    linebuffer_write,
    bread_conv,
    linebuffer_read,
    linebuffer_puts,
    linebuffer_gets,
    linebuffer_ctrl,
    linebuffer_new,
    linebuffer_free,
    linebuffer_callback_ctrl,
};

const BIO_METHOD *BIO_f_linebuffer(void)
{
    return &methods_linebuffer;
}

typedef struct bio_linebuffer_ctx_struct {
    char *obuf;                 /* the output char array */
    int obuf_size;              /* how big is the output buffer */
    int obuf_len;               /* how many bytes are in it */
} BIO_LINEBUFFER_CTX;

static int linebuffer_new(BIO *bi)
{
    BIO_LINEBUFFER_CTX *ctx;

    if ((ctx = OPENSSL_malloc(sizeof(*ctx))) == NULL)
        return 0;
    ctx->obuf = OPENSSL_malloc(DEFAULT_LINEBUFFER_SIZE);
    if (ctx->obuf == NULL) {
        OPENSSL_free(ctx);
        return 0;
    }
    ctx->obuf_size = DEFAULT_LINEBUFFER_SIZE;
    ctx->obuf_len = 0;

    bi->init = 1;
    bi->ptr = (char *)ctx;
    bi->flags = 0;
    return 1;
}

static int linebuffer_free(BIO *a)
{
    BIO_LINEBUFFER_CTX *b;

    if (a == NULL)
        return 0;
    b = (BIO_LINEBUFFER_CTX *)a->ptr;
    OPENSSL_free(b->obuf);
    OPENSSL_free(a->ptr);
    a->ptr = NULL;
    a->init = 0;
    a->flags = 0;
    return 1;
}

static int linebuffer_read(BIO *b, char *out, int outl)
{
    int ret = 0;

    if (out == NULL)
        return 0;
    if (b->next_bio == NULL)
        return 0;
    ret = BIO_read(b->next_bio, out, outl);
    BIO_clear_retry_flags(b);
    BIO_copy_next_retry(b);
    return ret;
}

static int linebuffer_write(BIO *b, const char *in, int inl)
{
    int i, num = 0, foundnl;
    BIO_LINEBUFFER_CTX *ctx;

    if ((in == NULL) || (inl <= 0))
        return 0;
    ctx = (BIO_LINEBUFFER_CTX *)b->ptr;
    if ((ctx == NULL) || (b->next_bio == NULL))
        return 0;

    BIO_clear_retry_flags(b);

    do {
        const char *p;
        char c;

        for (p = in, c = '\0'; p < in + inl && (c = *p) != '\n'; p++) ;
        if (c == '\n') {
            p++;
            foundnl = 1;
        } else
            foundnl = 0;

        /*
         * If a NL was found and we already have text in the save buffer,
         * concatenate them and write
         */
        while ((foundnl || p - in > ctx->obuf_size - ctx->obuf_len)
               && ctx->obuf_len > 0) {
            int orig_olen = ctx->obuf_len;

            i = ctx->obuf_size - ctx->obuf_len;
            if (p - in > 0) {
                if (i >= p - in) {
                    memcpy(&(ctx->obuf[ctx->obuf_len]), in, p - in);
                    ctx->obuf_len += p - in;
                    inl -= p - in;
                    num += p - in;
                    in = p;
                } else {
                    memcpy(&(ctx->obuf[ctx->obuf_len]), in, i);
                    ctx->obuf_len += i;
                    inl -= i;
                    in += i;
                    num += i;
                }
            }
            i = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
            if (i <= 0) {
                ctx->obuf_len = orig_olen;
                BIO_copy_next_retry(b);

                if (i < 0)
                    return ((num > 0) ? num : i);
                if (i == 0)
                    return num;
            }
            if (i < ctx->obuf_len)
                memmove(ctx->obuf, ctx->obuf + i, ctx->obuf_len - i);
            ctx->obuf_len -= i;
        }

        /*
         * Now that the save buffer is emptied, let's write the input buffer
         * if a NL was found and there is anything to write.
         */
        if ((foundnl || p - in > ctx->obuf_size) && p - in > 0) {
            i = BIO_write(b->next_bio, in, p - in);
            if (i <= 0) {
                BIO_copy_next_retry(b);
                if (i < 0)
                    return ((num > 0) ? num : i);
                if (i == 0)
                    return num;
            }
            num += i;
            in += i;
            inl -= i;
        }
    }
    while (foundnl && inl > 0);
    /*
     * We've written as much as we can.  The rest of the input buffer, if
     * any, is text that doesn't and with a NL and therefore needs to be
     * saved for the next trip.
     */
    if (inl > 0) {
        memcpy(&(ctx->obuf[ctx->obuf_len]), in, inl);
        ctx->obuf_len += inl;
        num += inl;
    }
    return num;
}

static long linebuffer_ctrl(BIO *b, int cmd, long num, void *ptr)
{
    BIO *dbio;
    BIO_LINEBUFFER_CTX *ctx;
    long ret = 1;
    char *p;
    int r;
    int obs;

    ctx = (BIO_LINEBUFFER_CTX *)b->ptr;

    switch (cmd) {
    case BIO_CTRL_RESET:
        ctx->obuf_len = 0;
        if (b->next_bio == NULL)
            return 0;
        ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
        break;
    case BIO_CTRL_INFO:
        ret = (long)ctx->obuf_len;
        break;
    case BIO_CTRL_WPENDING:
        ret = (long)ctx->obuf_len;
        if (ret == 0) {
            if (b->next_bio == NULL)
                return 0;
            ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
        }
        break;
    case BIO_C_SET_BUFF_SIZE:
        if (num > INT_MAX)
            return 0;
        obs = (int)num;
        p = ctx->obuf;
        if ((obs > DEFAULT_LINEBUFFER_SIZE) && (obs != ctx->obuf_size)) {
            p = OPENSSL_malloc((size_t)obs);
            if (p == NULL)
                return 0;
        }
        if (ctx->obuf != p) {
            if (ctx->obuf_len > obs) {
                ctx->obuf_len = obs;
            }
            memcpy(p, ctx->obuf, ctx->obuf_len);
            OPENSSL_free(ctx->obuf);
            ctx->obuf = p;
            ctx->obuf_size = obs;
        }
        break;
    case BIO_C_DO_STATE_MACHINE:
        if (b->next_bio == NULL)
            return 0;
        BIO_clear_retry_flags(b);
        ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
        BIO_copy_next_retry(b);
        break;

    case BIO_CTRL_FLUSH:
        if (b->next_bio == NULL)
            return 0;
        if (ctx->obuf_len <= 0) {
            ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
            BIO_copy_next_retry(b);
            break;
        }

        for (;;) {
            BIO_clear_retry_flags(b);
            if (ctx->obuf_len > 0) {
                r = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
                BIO_copy_next_retry(b);
                if (r <= 0)
                    return (long)r;
                if (r < ctx->obuf_len)
                    memmove(ctx->obuf, ctx->obuf + r, ctx->obuf_len - r);
                ctx->obuf_len -= r;
            } else {
                ctx->obuf_len = 0;
                break;
            }
        }
        ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
        BIO_copy_next_retry(b);
        break;
    case BIO_CTRL_DUP:
        dbio = (BIO *)ptr;
        if (BIO_set_write_buffer_size(dbio, ctx->obuf_size) <= 0)
            ret = 0;
        break;
    default:
        if (b->next_bio == NULL)
            return 0;
        ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
        break;
    }
    return ret;
}

static long linebuffer_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
{
    if (b->next_bio == NULL)
        return 0;
    return BIO_callback_ctrl(b->next_bio, cmd, fp);
}

static int linebuffer_gets(BIO *b, char *buf, int size)
{
    if (b->next_bio == NULL)
        return 0;
    return BIO_gets(b->next_bio, buf, size);
}

static int linebuffer_puts(BIO *b, const char *str)
{
    return linebuffer_write(b, str, strlen(str));
}
Commit	Line	Data
b1322259	1	/*
da1c088f	2	* Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
645749ef	3	*
09abbca1	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
b1322259 RS	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
645749ef RL	8	*/
	9
	10	#include <stdio.h>
	11	#include <errno.h>
706457b7	12	#include "bio_local.h"
b39fc560	13	#include "internal/cryptlib.h"
645749ef RL	14	#include <openssl/evp.h>
645749ef RL	15
0f113f3e	16	static int linebuffer_write(BIO h, const char buf, int num);
645749ef RL	17	static int linebuffer_read(BIO h, char buf, int size);
	18	static int linebuffer_puts(BIO h, const char str);
	19	static int linebuffer_gets(BIO h, char str, int size);
	20	static long linebuffer_ctrl(BIO h, int cmd, long arg1, void arg2);
	21	static int linebuffer_new(BIO *h);
	22	static int linebuffer_free(BIO *data);
fce78bd4	23	static long linebuffer_callback_ctrl(BIO h, int cmd, BIO_info_cb fp);
645749ef RL	24
645749ef RL	25	/* A 10k maximum should be enough for most purposes */
0f113f3e	26	#define DEFAULT_LINEBUFFER_SIZE 1024*10
645749ef RL	27
	28	/* #define DEBUG */
	29
04f6b0fd	30	static const BIO_METHOD methods_linebuffer = {
0f113f3e MC	31	BIO_TYPE_LINEBUFFER,
0f113f3e MC	32	"linebuffer",
3befffa3	33	bwrite_conv,
0f113f3e	34	linebuffer_write,
d07aee2c	35	bread_conv,
0f113f3e MC	36	linebuffer_read,
	37	linebuffer_puts,
	38	linebuffer_gets,
	39	linebuffer_ctrl,
	40	linebuffer_new,
	41	linebuffer_free,
	42	linebuffer_callback_ctrl,
	43	};
645749ef	44
04f6b0fd	45	const BIO_METHOD *BIO_f_linebuffer(void)
0f113f3e	46	{
26a7d938	47	return &methods_linebuffer;
0f113f3e	48	}
645749ef	49
0f113f3e MC	50	typedef struct bio_linebuffer_ctx_struct {
	51	char obuf; / the output char array */
	52	int obuf_size; /* how big is the output buffer */
	53	int obuf_len; /* how many bytes are in it */
	54	} BIO_LINEBUFFER_CTX;
645749ef RL	55
645749ef RL	56	static int linebuffer_new(BIO *bi)
0f113f3e MC	57	{
	58	BIO_LINEBUFFER_CTX *ctx;
	59
e077455e	60	if ((ctx = OPENSSL_malloc(sizeof(*ctx))) == NULL)
26a7d938	61	return 0;
b196e7d9	62	ctx->obuf = OPENSSL_malloc(DEFAULT_LINEBUFFER_SIZE);
0f113f3e MC	63	if (ctx->obuf == NULL) {
0f113f3e MC	64	OPENSSL_free(ctx);
26a7d938	65	return 0;
0f113f3e MC	66	}
	67	ctx->obuf_size = DEFAULT_LINEBUFFER_SIZE;
	68	ctx->obuf_len = 0;
	69
	70	bi->init = 1;
	71	bi->ptr = (char *)ctx;
	72	bi->flags = 0;
208fb891	73	return 1;
0f113f3e	74	}
645749ef RL	75
645749ef RL	76	static int linebuffer_free(BIO *a)
0f113f3e MC	77	{
	78	BIO_LINEBUFFER_CTX *b;
	79
	80	if (a == NULL)
26a7d938	81	return 0;
0f113f3e	82	b = (BIO_LINEBUFFER_CTX *)a->ptr;
b548a1f1	83	OPENSSL_free(b->obuf);
0f113f3e MC	84	OPENSSL_free(a->ptr);
	85	a->ptr = NULL;
	86	a->init = 0;
	87	a->flags = 0;
208fb891	88	return 1;
0f113f3e MC	89	}
0f113f3e MC	90
645749ef	91	static int linebuffer_read(BIO b, char out, int outl)
0f113f3e MC	92	{
	93	int ret = 0;
	94
	95	if (out == NULL)
26a7d938	96	return 0;
0f113f3e	97	if (b->next_bio == NULL)
26a7d938	98	return 0;
0f113f3e MC	99	ret = BIO_read(b->next_bio, out, outl);
	100	BIO_clear_retry_flags(b);
	101	BIO_copy_next_retry(b);
26a7d938	102	return ret;
0f113f3e	103	}
645749ef RL	104
645749ef RL	105	static int linebuffer_write(BIO b, const char in, int inl)
0f113f3e MC	106	{
	107	int i, num = 0, foundnl;
	108	BIO_LINEBUFFER_CTX *ctx;
	109
	110	if ((in == NULL) \|\| (inl <= 0))
26a7d938	111	return 0;
0f113f3e MC	112	ctx = (BIO_LINEBUFFER_CTX *)b->ptr;
0f113f3e MC	113	if ((ctx == NULL) \|\| (b->next_bio == NULL))
26a7d938	114	return 0;
645749ef	115
0f113f3e MC	116	BIO_clear_retry_flags(b);
	117
	118	do {
	119	const char *p;
f11a023a	120	char c;
0f113f3e	121
f11a023a RL	122	for (p = in, c = '\0'; p < in + inl && (c = *p) != '\n'; p++) ;
f11a023a RL	123	if (c == '\n') {
0f113f3e MC	124	p++;
	125	foundnl = 1;
	126	} else
	127	foundnl = 0;
	128
	129	/*
	130	* If a NL was found and we already have text in the save buffer,
	131	* concatenate them and write
	132	*/
	133	while ((foundnl \|\| p - in > ctx->obuf_size - ctx->obuf_len)
	134	&& ctx->obuf_len > 0) {
	135	int orig_olen = ctx->obuf_len;
	136
	137	i = ctx->obuf_size - ctx->obuf_len;
	138	if (p - in > 0) {
	139	if (i >= p - in) {
	140	memcpy(&(ctx->obuf[ctx->obuf_len]), in, p - in);
	141	ctx->obuf_len += p - in;
	142	inl -= p - in;
	143	num += p - in;
	144	in = p;
	145	} else {
	146	memcpy(&(ctx->obuf[ctx->obuf_len]), in, i);
	147	ctx->obuf_len += i;
	148	inl -= i;
	149	in += i;
	150	num += i;
	151	}
	152	}
0f113f3e MC	153	i = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
	154	if (i <= 0) {
	155	ctx->obuf_len = orig_olen;
	156	BIO_copy_next_retry(b);
645749ef	157
0f113f3e MC	158	if (i < 0)
	159	return ((num > 0) ? num : i);
	160	if (i == 0)
26a7d938	161	return num;
0f113f3e	162	}
0f113f3e MC	163	if (i < ctx->obuf_len)
	164	memmove(ctx->obuf, ctx->obuf + i, ctx->obuf_len - i);
	165	ctx->obuf_len -= i;
	166	}
	167
	168	/*
	169	* Now that the save buffer is emptied, let's write the input buffer
	170	* if a NL was found and there is anything to write.
	171	*/
	172	if ((foundnl \|\| p - in > ctx->obuf_size) && p - in > 0) {
0f113f3e MC	173	i = BIO_write(b->next_bio, in, p - in);
	174	if (i <= 0) {
	175	BIO_copy_next_retry(b);
0f113f3e MC	176	if (i < 0)
	177	return ((num > 0) ? num : i);
	178	if (i == 0)
26a7d938	179	return num;
0f113f3e	180	}
0f113f3e MC	181	num += i;
	182	in += i;
	183	inl -= i;
	184	}
	185	}
	186	while (foundnl && inl > 0);
	187	/*
	188	* We've written as much as we can. The rest of the input buffer, if
	189	* any, is text that doesn't and with a NL and therefore needs to be
	190	* saved for the next trip.
	191	*/
	192	if (inl > 0) {
	193	memcpy(&(ctx->obuf[ctx->obuf_len]), in, inl);
	194	ctx->obuf_len += inl;
	195	num += inl;
	196	}
	197	return num;
	198	}
645749ef RL	199
645749ef RL	200	static long linebuffer_ctrl(BIO b, int cmd, long num, void ptr)
0f113f3e MC	201	{
	202	BIO *dbio;
	203	BIO_LINEBUFFER_CTX *ctx;
	204	long ret = 1;
	205	char *p;
	206	int r;
	207	int obs;
	208
	209	ctx = (BIO_LINEBUFFER_CTX *)b->ptr;
	210
	211	switch (cmd) {
	212	case BIO_CTRL_RESET:
	213	ctx->obuf_len = 0;
	214	if (b->next_bio == NULL)
26a7d938	215	return 0;
0f113f3e MC	216	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
	217	break;
	218	case BIO_CTRL_INFO:
	219	ret = (long)ctx->obuf_len;
	220	break;
	221	case BIO_CTRL_WPENDING:
	222	ret = (long)ctx->obuf_len;
	223	if (ret == 0) {
	224	if (b->next_bio == NULL)
26a7d938	225	return 0;
0f113f3e MC	226	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
	227	}
	228	break;
	229	case BIO_C_SET_BUFF_SIZE:
59088414 TM	230	if (num > INT_MAX)
59088414 TM	231	return 0;
0f113f3e MC	232	obs = (int)num;
	233	p = ctx->obuf;
	234	if ((obs > DEFAULT_LINEBUFFER_SIZE) && (obs != ctx->obuf_size)) {
59088414	235	p = OPENSSL_malloc((size_t)obs);
0f113f3e	236	if (p == NULL)
e077455e	237	return 0;
0f113f3e MC	238	}
	239	if (ctx->obuf != p) {
	240	if (ctx->obuf_len > obs) {
	241	ctx->obuf_len = obs;
	242	}
	243	memcpy(p, ctx->obuf, ctx->obuf_len);
	244	OPENSSL_free(ctx->obuf);
	245	ctx->obuf = p;
	246	ctx->obuf_size = obs;
	247	}
	248	break;
	249	case BIO_C_DO_STATE_MACHINE:
	250	if (b->next_bio == NULL)
26a7d938	251	return 0;
0f113f3e MC	252	BIO_clear_retry_flags(b);
	253	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
	254	BIO_copy_next_retry(b);
	255	break;
	256
	257	case BIO_CTRL_FLUSH:
	258	if (b->next_bio == NULL)
26a7d938	259	return 0;
0f113f3e MC	260	if (ctx->obuf_len <= 0) {
0f113f3e MC	261	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
bcbc7d60	262	BIO_copy_next_retry(b);
0f113f3e MC	263	break;
	264	}
	265
	266	for (;;) {
	267	BIO_clear_retry_flags(b);
	268	if (ctx->obuf_len > 0) {
	269	r = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
0f113f3e MC	270	BIO_copy_next_retry(b);
0f113f3e MC	271	if (r <= 0)
26a7d938	272	return (long)r;
0f113f3e MC	273	if (r < ctx->obuf_len)
	274	memmove(ctx->obuf, ctx->obuf + r, ctx->obuf_len - r);
	275	ctx->obuf_len -= r;
	276	} else {
	277	ctx->obuf_len = 0;
0f113f3e MC	278	break;
	279	}
	280	}
	281	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
bcbc7d60	282	BIO_copy_next_retry(b);
0f113f3e MC	283	break;
	284	case BIO_CTRL_DUP:
	285	dbio = (BIO *)ptr;
25d02f33	286	if (BIO_set_write_buffer_size(dbio, ctx->obuf_size) <= 0)
0f113f3e MC	287	ret = 0;
	288	break;
	289	default:
	290	if (b->next_bio == NULL)
26a7d938	291	return 0;
0f113f3e MC	292	ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
	293	break;
	294	}
26a7d938	295	return ret;
0f113f3e	296	}
645749ef	297
fce78bd4	298	static long linebuffer_callback_ctrl(BIO b, int cmd, BIO_info_cb fp)
0f113f3e	299	{
0f113f3e	300	if (b->next_bio == NULL)
26a7d938	301	return 0;
8f2fe32d	302	return BIO_callback_ctrl(b->next_bio, cmd, fp);
0f113f3e	303	}
645749ef RL	304
645749ef RL	305	static int linebuffer_gets(BIO b, char buf, int size)
0f113f3e MC	306	{
0f113f3e MC	307	if (b->next_bio == NULL)
26a7d938 K	308	return 0;
26a7d938 K	309	return BIO_gets(b->next_bio, buf, size);
0f113f3e	310	}
645749ef RL	311
645749ef RL	312	static int linebuffer_puts(BIO b, const char str)
0f113f3e	313	{
26a7d938	314	return linebuffer_write(b, str, strlen(str));
0f113f3e	315	}