Blame crypto/evp/bio_enc.c

Packit c4476c
/*
Packit c4476c
 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <stdio.h>
Packit c4476c
#include <errno.h>
Packit c4476c
#include "internal/cryptlib.h"
Packit c4476c
#include <openssl/buffer.h>
Packit c4476c
#include <openssl/evp.h>
Packit c4476c
#include "internal/bio.h"
Packit c4476c
Packit c4476c
static int enc_write(BIO *h, const char *buf, int num);
Packit c4476c
static int enc_read(BIO *h, char *buf, int size);
Packit c4476c
static long enc_ctrl(BIO *h, int cmd, long arg1, void *arg2);
Packit c4476c
static int enc_new(BIO *h);
Packit c4476c
static int enc_free(BIO *data);
Packit c4476c
static long enc_callback_ctrl(BIO *h, int cmd, BIO_info_cb *fps);
Packit c4476c
#define ENC_BLOCK_SIZE  (1024*4)
Packit c4476c
#define ENC_MIN_CHUNK   (256)
Packit c4476c
#define BUF_OFFSET      (ENC_MIN_CHUNK + EVP_MAX_BLOCK_LENGTH)
Packit c4476c
Packit c4476c
typedef struct enc_struct {
Packit c4476c
    int buf_len;
Packit c4476c
    int buf_off;
Packit c4476c
    int cont;                   /* <= 0 when finished */
Packit c4476c
    int finished;
Packit c4476c
    int ok;                     /* bad decrypt */
Packit c4476c
    EVP_CIPHER_CTX *cipher;
Packit c4476c
    unsigned char *read_start, *read_end;
Packit c4476c
    /*
Packit c4476c
     * buf is larger than ENC_BLOCK_SIZE because EVP_DecryptUpdate can return
Packit c4476c
     * up to a block more data than is presented to it
Packit c4476c
     */
Packit c4476c
    unsigned char buf[BUF_OFFSET + ENC_BLOCK_SIZE];
Packit c4476c
} BIO_ENC_CTX;
Packit c4476c
Packit c4476c
static const BIO_METHOD methods_enc = {
Packit c4476c
    BIO_TYPE_CIPHER,
Packit c4476c
    "cipher",
Packit c4476c
    /* TODO: Convert to new style write function */
Packit c4476c
    bwrite_conv,
Packit c4476c
    enc_write,
Packit c4476c
    /* TODO: Convert to new style read function */
Packit c4476c
    bread_conv,
Packit c4476c
    enc_read,
Packit c4476c
    NULL,                       /* enc_puts, */
Packit c4476c
    NULL,                       /* enc_gets, */
Packit c4476c
    enc_ctrl,
Packit c4476c
    enc_new,
Packit c4476c
    enc_free,
Packit c4476c
    enc_callback_ctrl,
Packit c4476c
};
Packit c4476c
Packit c4476c
const BIO_METHOD *BIO_f_cipher(void)
Packit c4476c
{
Packit c4476c
    return &methods_enc;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int enc_new(BIO *bi)
Packit c4476c
{
Packit c4476c
    BIO_ENC_CTX *ctx;
Packit c4476c
Packit c4476c
    if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL) {
Packit c4476c
        EVPerr(EVP_F_ENC_NEW, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    ctx->cipher = EVP_CIPHER_CTX_new();
Packit c4476c
    if (ctx->cipher == NULL) {
Packit c4476c
        OPENSSL_free(ctx);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    ctx->cont = 1;
Packit c4476c
    ctx->ok = 1;
Packit c4476c
    ctx->read_end = ctx->read_start = &(ctx->buf[BUF_OFFSET]);
Packit c4476c
    BIO_set_data(bi, ctx);
Packit c4476c
    BIO_set_init(bi, 1);
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int enc_free(BIO *a)
Packit c4476c
{
Packit c4476c
    BIO_ENC_CTX *b;
Packit c4476c
Packit c4476c
    if (a == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    b = BIO_get_data(a);
Packit c4476c
    if (b == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    EVP_CIPHER_CTX_free(b->cipher);
Packit c4476c
    OPENSSL_clear_free(b, sizeof(BIO_ENC_CTX));
Packit c4476c
    BIO_set_data(a, NULL);
Packit c4476c
    BIO_set_init(a, 0);
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int enc_read(BIO *b, char *out, int outl)
Packit c4476c
{
Packit c4476c
    int ret = 0, i, blocksize;
Packit c4476c
    BIO_ENC_CTX *ctx;
Packit c4476c
    BIO *next;
Packit c4476c
Packit c4476c
    if (out == NULL)
Packit c4476c
        return 0;
Packit c4476c
    ctx = BIO_get_data(b);
Packit c4476c
Packit c4476c
    next = BIO_next(b);
Packit c4476c
    if ((ctx == NULL) || (next == NULL))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    /* First check if there are bytes decoded/encoded */
Packit c4476c
    if (ctx->buf_len > 0) {
Packit c4476c
        i = ctx->buf_len - ctx->buf_off;
Packit c4476c
        if (i > outl)
Packit c4476c
            i = outl;
Packit c4476c
        memcpy(out, &(ctx->buf[ctx->buf_off]), i);
Packit c4476c
        ret = i;
Packit c4476c
        out += i;
Packit c4476c
        outl -= i;
Packit c4476c
        ctx->buf_off += i;
Packit c4476c
        if (ctx->buf_len == ctx->buf_off) {
Packit c4476c
            ctx->buf_len = 0;
Packit c4476c
            ctx->buf_off = 0;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    blocksize = EVP_CIPHER_CTX_block_size(ctx->cipher);
Packit c4476c
    if (blocksize == 1)
Packit c4476c
        blocksize = 0;
Packit c4476c
Packit c4476c
    /*
Packit c4476c
     * At this point, we have room of outl bytes and an empty buffer, so we
Packit c4476c
     * should read in some more.
Packit c4476c
     */
Packit c4476c
Packit c4476c
    while (outl > 0) {
Packit c4476c
        if (ctx->cont <= 0)
Packit c4476c
            break;
Packit c4476c
Packit c4476c
        if (ctx->read_start == ctx->read_end) { /* time to read more data */
Packit c4476c
            ctx->read_end = ctx->read_start = &(ctx->buf[BUF_OFFSET]);
Packit c4476c
            i = BIO_read(next, ctx->read_start, ENC_BLOCK_SIZE);
Packit c4476c
            if (i > 0)
Packit c4476c
                ctx->read_end += i;
Packit c4476c
        } else {
Packit c4476c
            i = ctx->read_end - ctx->read_start;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        if (i <= 0) {
Packit c4476c
            /* Should be continue next time we are called? */
Packit c4476c
            if (!BIO_should_retry(next)) {
Packit c4476c
                ctx->cont = i;
Packit c4476c
                i = EVP_CipherFinal_ex(ctx->cipher,
Packit c4476c
                                       ctx->buf, &(ctx->buf_len));
Packit c4476c
                ctx->ok = i;
Packit c4476c
                ctx->buf_off = 0;
Packit c4476c
            } else {
Packit c4476c
                ret = (ret == 0) ? i : ret;
Packit c4476c
                break;
Packit c4476c
            }
Packit c4476c
        } else {
Packit c4476c
            if (outl > ENC_MIN_CHUNK) {
Packit c4476c
                /*
Packit c4476c
                 * Depending on flags block cipher decrypt can write
Packit c4476c
                 * one extra block and then back off, i.e. output buffer
Packit c4476c
                 * has to accommodate extra block...
Packit c4476c
                 */
Packit c4476c
                int j = outl - blocksize, buf_len;
Packit c4476c
Packit c4476c
                if (!EVP_CipherUpdate(ctx->cipher,
Packit c4476c
                                      (unsigned char *)out, &buf_len,
Packit c4476c
                                      ctx->read_start, i > j ? j : i)) {
Packit c4476c
                    BIO_clear_retry_flags(b);
Packit c4476c
                    return 0;
Packit c4476c
                }
Packit c4476c
                ret += buf_len;
Packit c4476c
                out += buf_len;
Packit c4476c
                outl -= buf_len;
Packit c4476c
Packit c4476c
                if ((i -= j) <= 0) {
Packit c4476c
                    ctx->read_start = ctx->read_end;
Packit c4476c
                    continue;
Packit c4476c
                }
Packit c4476c
                ctx->read_start += j;
Packit c4476c
            }
Packit c4476c
            if (i > ENC_MIN_CHUNK)
Packit c4476c
                i = ENC_MIN_CHUNK;
Packit c4476c
            if (!EVP_CipherUpdate(ctx->cipher,
Packit c4476c
                                  ctx->buf, &ctx->buf_len,
Packit c4476c
                                  ctx->read_start, i)) {
Packit c4476c
                BIO_clear_retry_flags(b);
Packit c4476c
                ctx->ok = 0;
Packit c4476c
                return 0;
Packit c4476c
            }
Packit c4476c
            ctx->read_start += i;
Packit c4476c
            ctx->cont = 1;
Packit c4476c
            /*
Packit c4476c
             * Note: it is possible for EVP_CipherUpdate to decrypt zero
Packit c4476c
             * bytes because this is or looks like the final block: if this
Packit c4476c
             * happens we should retry and either read more data or decrypt
Packit c4476c
             * the final block
Packit c4476c
             */
Packit c4476c
            if (ctx->buf_len == 0)
Packit c4476c
                continue;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        if (ctx->buf_len <= outl)
Packit c4476c
            i = ctx->buf_len;
Packit c4476c
        else
Packit c4476c
            i = outl;
Packit c4476c
        if (i <= 0)
Packit c4476c
            break;
Packit c4476c
        memcpy(out, ctx->buf, i);
Packit c4476c
        ret += i;
Packit c4476c
        ctx->buf_off = i;
Packit c4476c
        outl -= i;
Packit c4476c
        out += i;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    BIO_clear_retry_flags(b);
Packit c4476c
    BIO_copy_next_retry(b);
Packit c4476c
    return ((ret == 0) ? ctx->cont : ret);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int enc_write(BIO *b, const char *in, int inl)
Packit c4476c
{
Packit c4476c
    int ret = 0, n, i;
Packit c4476c
    BIO_ENC_CTX *ctx;
Packit c4476c
    BIO *next;
Packit c4476c
Packit c4476c
    ctx = BIO_get_data(b);
Packit c4476c
    next = BIO_next(b);
Packit c4476c
    if ((ctx == NULL) || (next == NULL))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    ret = inl;
Packit c4476c
Packit c4476c
    BIO_clear_retry_flags(b);
Packit c4476c
    n = ctx->buf_len - ctx->buf_off;
Packit c4476c
    while (n > 0) {
Packit c4476c
        i = BIO_write(next, &(ctx->buf[ctx->buf_off]), n);
Packit c4476c
        if (i <= 0) {
Packit c4476c
            BIO_copy_next_retry(b);
Packit c4476c
            return i;
Packit c4476c
        }
Packit c4476c
        ctx->buf_off += i;
Packit c4476c
        n -= i;
Packit c4476c
    }
Packit c4476c
    /* at this point all pending data has been written */
Packit c4476c
Packit c4476c
    if ((in == NULL) || (inl <= 0))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    ctx->buf_off = 0;
Packit c4476c
    while (inl > 0) {
Packit c4476c
        n = (inl > ENC_BLOCK_SIZE) ? ENC_BLOCK_SIZE : inl;
Packit c4476c
        if (!EVP_CipherUpdate(ctx->cipher,
Packit c4476c
                              ctx->buf, &ctx->buf_len,
Packit c4476c
                              (const unsigned char *)in, n)) {
Packit c4476c
            BIO_clear_retry_flags(b);
Packit c4476c
            ctx->ok = 0;
Packit c4476c
            return 0;
Packit c4476c
        }
Packit c4476c
        inl -= n;
Packit c4476c
        in += n;
Packit c4476c
Packit c4476c
        ctx->buf_off = 0;
Packit c4476c
        n = ctx->buf_len;
Packit c4476c
        while (n > 0) {
Packit c4476c
            i = BIO_write(next, &(ctx->buf[ctx->buf_off]), n);
Packit c4476c
            if (i <= 0) {
Packit c4476c
                BIO_copy_next_retry(b);
Packit c4476c
                return (ret == inl) ? i : ret - inl;
Packit c4476c
            }
Packit c4476c
            n -= i;
Packit c4476c
            ctx->buf_off += i;
Packit c4476c
        }
Packit c4476c
        ctx->buf_len = 0;
Packit c4476c
        ctx->buf_off = 0;
Packit c4476c
    }
Packit c4476c
    BIO_copy_next_retry(b);
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static long enc_ctrl(BIO *b, int cmd, long num, void *ptr)
Packit c4476c
{
Packit c4476c
    BIO *dbio;
Packit c4476c
    BIO_ENC_CTX *ctx, *dctx;
Packit c4476c
    long ret = 1;
Packit c4476c
    int i;
Packit c4476c
    EVP_CIPHER_CTX **c_ctx;
Packit c4476c
    BIO *next;
Packit c4476c
Packit c4476c
    ctx = BIO_get_data(b);
Packit c4476c
    next = BIO_next(b);
Packit c4476c
    if (ctx == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    switch (cmd) {
Packit c4476c
    case BIO_CTRL_RESET:
Packit c4476c
        ctx->ok = 1;
Packit c4476c
        ctx->finished = 0;
Packit c4476c
        if (!EVP_CipherInit_ex(ctx->cipher, NULL, NULL, NULL, NULL,
Packit c4476c
                               EVP_CIPHER_CTX_encrypting(ctx->cipher)))
Packit c4476c
            return 0;
Packit c4476c
        ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_EOF:         /* More to read */
Packit c4476c
        if (ctx->cont <= 0)
Packit c4476c
            ret = 1;
Packit c4476c
        else
Packit c4476c
            ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_WPENDING:
Packit c4476c
        ret = ctx->buf_len - ctx->buf_off;
Packit c4476c
        if (ret <= 0)
Packit c4476c
            ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_PENDING:     /* More to read in buffer */
Packit c4476c
        ret = ctx->buf_len - ctx->buf_off;
Packit c4476c
        if (ret <= 0)
Packit c4476c
            ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_FLUSH:
Packit c4476c
        /* do a final write */
Packit c4476c
 again:
Packit c4476c
        while (ctx->buf_len != ctx->buf_off) {
Packit c4476c
            i = enc_write(b, NULL, 0);
Packit c4476c
            if (i < 0)
Packit c4476c
                return i;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        if (!ctx->finished) {
Packit c4476c
            ctx->finished = 1;
Packit c4476c
            ctx->buf_off = 0;
Packit c4476c
            ret = EVP_CipherFinal_ex(ctx->cipher,
Packit c4476c
                                     (unsigned char *)ctx->buf,
Packit c4476c
                                     &(ctx->buf_len));
Packit c4476c
            ctx->ok = (int)ret;
Packit c4476c
            if (ret <= 0)
Packit c4476c
                break;
Packit c4476c
Packit c4476c
            /* push out the bytes */
Packit c4476c
            goto again;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        /* Finally flush the underlying BIO */
Packit c4476c
        ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    case BIO_C_GET_CIPHER_STATUS:
Packit c4476c
        ret = (long)ctx->ok;
Packit c4476c
        break;
Packit c4476c
    case BIO_C_DO_STATE_MACHINE:
Packit c4476c
        BIO_clear_retry_flags(b);
Packit c4476c
        ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        BIO_copy_next_retry(b);
Packit c4476c
        break;
Packit c4476c
    case BIO_C_GET_CIPHER_CTX:
Packit c4476c
        c_ctx = (EVP_CIPHER_CTX **)ptr;
Packit c4476c
        *c_ctx = ctx->cipher;
Packit c4476c
        BIO_set_init(b, 1);
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_DUP:
Packit c4476c
        dbio = (BIO *)ptr;
Packit c4476c
        dctx = BIO_get_data(dbio);
Packit c4476c
        dctx->cipher = EVP_CIPHER_CTX_new();
Packit c4476c
        if (dctx->cipher == NULL)
Packit c4476c
            return 0;
Packit c4476c
        ret = EVP_CIPHER_CTX_copy(dctx->cipher, ctx->cipher);
Packit c4476c
        if (ret)
Packit c4476c
            BIO_set_init(dbio, 1);
Packit c4476c
        break;
Packit c4476c
    default:
Packit c4476c
        ret = BIO_ctrl(next, cmd, num, ptr);
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static long enc_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
Packit c4476c
{
Packit c4476c
    long ret = 1;
Packit c4476c
    BIO *next = BIO_next(b);
Packit c4476c
Packit c4476c
    if (next == NULL)
Packit c4476c
        return 0;
Packit c4476c
    switch (cmd) {
Packit c4476c
    default:
Packit c4476c
        ret = BIO_callback_ctrl(next, cmd, fp);
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
int BIO_set_cipher(BIO *b, const EVP_CIPHER *c, const unsigned char *k,
Packit c4476c
                   const unsigned char *i, int e)
Packit c4476c
{
Packit c4476c
    BIO_ENC_CTX *ctx;
Packit c4476c
    long (*callback) (struct bio_st *, int, const char *, int, long, long);
Packit c4476c
Packit c4476c
    ctx = BIO_get_data(b);
Packit c4476c
    if (ctx == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    callback = BIO_get_callback(b);
Packit c4476c
Packit c4476c
    if ((callback != NULL) &&
Packit c4476c
            (callback(b, BIO_CB_CTRL, (const char *)c, BIO_CTRL_SET, e,
Packit c4476c
                      0L) <= 0))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    BIO_set_init(b, 1);
Packit c4476c
Packit c4476c
    if (!EVP_CipherInit_ex(ctx->cipher, c, NULL, k, i, e))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if (callback != NULL)
Packit c4476c
        return callback(b, BIO_CB_CTRL, (const char *)c, BIO_CTRL_SET, e, 1L);
Packit c4476c
    return 1;
Packit c4476c
}