Coverage Report

Created: 2025-06-13 06:56

/src/openssl/crypto/bio/bf_prefix.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
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
8
 */
9
10
#include <stdio.h>
11
#include <string.h>
12
#include <errno.h>
13
#include "bio_local.h"
14
15
static int prefix_write(BIO *b, const char *out, size_t outl,
16
                        size_t *numwritten);
17
static int prefix_read(BIO *b, char *buf, size_t size, size_t *numread);
18
static int prefix_puts(BIO *b, const char *str);
19
static int prefix_gets(BIO *b, char *str, int size);
20
static long prefix_ctrl(BIO *b, int cmd, long arg1, void *arg2);
21
static int prefix_create(BIO *b);
22
static int prefix_destroy(BIO *b);
23
static long prefix_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
24
25
static const BIO_METHOD prefix_meth = {
26
    BIO_TYPE_BUFFER,
27
    "prefix",
28
    prefix_write,
29
    NULL,
30
    prefix_read,
31
    NULL,
32
    prefix_puts,
33
    prefix_gets,
34
    prefix_ctrl,
35
    prefix_create,
36
    prefix_destroy,
37
    prefix_callback_ctrl,
38
};
39
40
const BIO_METHOD *BIO_f_prefix(void)
41
0
{
42
0
    return &prefix_meth;
43
0
}
44
45
typedef struct prefix_ctx_st {
46
    char *prefix;              /* Text prefix, given by user */
47
    unsigned int indent;       /* Indentation amount, given by user */
48
49
    int linestart;             /* flag to indicate we're at the line start */
50
} PREFIX_CTX;
51
52
static int prefix_create(BIO *b)
53
0
{
54
0
    PREFIX_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
55
56
0
    if (ctx == NULL)
57
0
        return 0;
58
59
0
    ctx->prefix = NULL;
60
0
    ctx->indent = 0;
61
0
    ctx->linestart = 1;
62
0
    BIO_set_data(b, ctx);
63
0
    BIO_set_init(b, 1);
64
0
    return 1;
65
0
}
66
67
static int prefix_destroy(BIO *b)
68
0
{
69
0
    PREFIX_CTX *ctx = BIO_get_data(b);
70
71
0
    OPENSSL_free(ctx->prefix);
72
0
    OPENSSL_free(ctx);
73
0
    return 1;
74
0
}
75
76
static int prefix_read(BIO *b, char *in, size_t size, size_t *numread)
77
0
{
78
0
    return BIO_read_ex(BIO_next(b), in, size, numread);
79
0
}
80
81
static int prefix_write(BIO *b, const char *out, size_t outl,
82
                        size_t *numwritten)
83
0
{
84
0
    PREFIX_CTX *ctx = BIO_get_data(b);
85
86
0
    if (ctx == NULL)
87
0
        return 0;
88
89
    /*
90
     * If no prefix is set or if it's empty, and no indentation amount is set,
91
     * we've got nothing to do here
92
     */
93
0
    if ((ctx->prefix == NULL || *ctx->prefix == '\0')
94
0
        && ctx->indent == 0) {
95
        /*
96
         * We do note if what comes next will be a new line, though, so we're
97
         * prepared to handle prefix and indentation the next time around.
98
         */
99
0
        if (outl > 0)
100
0
            ctx->linestart = (out[outl-1] == '\n');
101
0
        return BIO_write_ex(BIO_next(b), out, outl, numwritten);
102
0
    }
103
104
0
    *numwritten = 0;
105
106
0
    while (outl > 0) {
107
0
        size_t i;
108
0
        char c;
109
110
        /*
111
         * If we know that we're at the start of the line, output prefix and
112
         * indentation.
113
         */
114
0
        if (ctx->linestart) {
115
0
            size_t dontcare;
116
117
0
            if (ctx->prefix != NULL
118
0
                && !BIO_write_ex(BIO_next(b), ctx->prefix, strlen(ctx->prefix),
119
0
                                 &dontcare))
120
0
                return 0;
121
0
            BIO_printf(BIO_next(b), "%*s", ctx->indent, "");
122
0
            ctx->linestart = 0;
123
0
        }
124
125
        /* Now, go look for the next LF, or the end of the string */
126
0
        for (i = 0, c = '\0'; i < outl && (c = out[i]) != '\n'; i++)
127
0
            continue;
128
0
        if (c == '\n')
129
0
            i++;
130
131
        /* Output what we found so far */
132
0
        while (i > 0) {
133
0
            size_t num = 0;
134
135
0
            if (!BIO_write_ex(BIO_next(b), out, i, &num))
136
0
                return 0;
137
0
            out += num;
138
0
            outl -= num;
139
0
            *numwritten += num;
140
0
            i -= num;
141
0
        }
142
143
        /* If we found a LF, what follows is a new line, so take note */
144
0
        if (c == '\n')
145
0
            ctx->linestart = 1;
146
0
    }
147
148
0
    return 1;
149
0
}
150
151
static long prefix_ctrl(BIO *b, int cmd, long num, void *ptr)
152
0
{
153
0
    long ret = 0;
154
0
    PREFIX_CTX *ctx;
155
156
0
    if (b == NULL || (ctx = BIO_get_data(b)) == NULL)
157
0
        return -1;
158
159
0
    switch (cmd) {
160
0
    case BIO_CTRL_SET_PREFIX:
161
0
        OPENSSL_free(ctx->prefix);
162
0
        if (ptr == NULL) {
163
0
            ctx->prefix = NULL;
164
0
            ret = 1;
165
0
        } else {
166
0
            ctx->prefix = OPENSSL_strdup((const char *)ptr);
167
0
            ret = ctx->prefix != NULL;
168
0
        }
169
0
        break;
170
0
    case BIO_CTRL_SET_INDENT:
171
0
        if (num >= 0) {
172
0
            ctx->indent = (unsigned int)num;
173
0
            ret = 1;
174
0
        }
175
0
        break;
176
0
    case BIO_CTRL_GET_INDENT:
177
0
        ret = (long)ctx->indent;
178
0
        break;
179
0
    default:
180
        /* Commands that we intercept before passing them along */
181
0
        switch (cmd) {
182
0
        case BIO_C_FILE_SEEK:
183
0
        case BIO_CTRL_RESET:
184
0
            ctx->linestart = 1;
185
0
            break;
186
0
        }
187
0
        if (BIO_next(b) != NULL)
188
0
            ret = BIO_ctrl(BIO_next(b), cmd, num, ptr);
189
0
        break;
190
0
    }
191
0
    return ret;
192
0
}
193
194
static long prefix_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
195
0
{
196
0
    return BIO_callback_ctrl(BIO_next(b), cmd, fp);
197
0
}
198
199
static int prefix_gets(BIO *b, char *buf, int size)
200
0
{
201
0
    return BIO_gets(BIO_next(b), buf, size);
202
0
}
203
204
static int prefix_puts(BIO *b, const char *str)
205
0
{
206
0
    return BIO_write(b, str, strlen(str));
207
0
}