Blame crypto/bio/bss_fd.c

Packit c4476c
/*
Packit c4476c
 * Copyright 1995-2020 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
Packit c4476c
#include "bio_local.h"
Packit c4476c
Packit c4476c
#if defined(OPENSSL_NO_POSIX_IO)
Packit c4476c
/*
Packit c4476c
 * Dummy placeholder for BIO_s_fd...
Packit c4476c
 */
Packit c4476c
BIO *BIO_new_fd(int fd, int close_flag)
Packit c4476c
{
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int BIO_fd_non_fatal_error(int err)
Packit c4476c
{
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
int BIO_fd_should_retry(int i)
Packit c4476c
{
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
const BIO_METHOD *BIO_s_fd(void)
Packit c4476c
{
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
#else
Packit c4476c
/*
Packit c4476c
 * As for unconditional usage of "UPLINK" interface in this module.
Packit c4476c
 * Trouble is that unlike Unix file descriptors [which are indexes
Packit c4476c
 * in kernel-side per-process table], corresponding descriptors on
Packit c4476c
 * platforms which require "UPLINK" interface seem to be indexes
Packit c4476c
 * in a user-land, non-global table. Well, in fact they are indexes
Packit c4476c
 * in stdio _iob[], and recall that _iob[] was the very reason why
Packit c4476c
 * "UPLINK" interface was introduced in first place. But one way on
Packit c4476c
 * another. Neither libcrypto or libssl use this BIO meaning that
Packit c4476c
 * file descriptors can only be provided by application. Therefore
Packit c4476c
 * "UPLINK" calls are due...
Packit c4476c
 */
Packit c4476c
static int fd_write(BIO *h, const char *buf, int num);
Packit c4476c
static int fd_read(BIO *h, char *buf, int size);
Packit c4476c
static int fd_puts(BIO *h, const char *str);
Packit c4476c
static int fd_gets(BIO *h, char *buf, int size);
Packit c4476c
static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
Packit c4476c
static int fd_new(BIO *h);
Packit c4476c
static int fd_free(BIO *data);
Packit c4476c
int BIO_fd_should_retry(int s);
Packit c4476c
Packit c4476c
static const BIO_METHOD methods_fdp = {
Packit c4476c
    BIO_TYPE_FD,
Packit c4476c
    "file descriptor",
Packit c4476c
    /* TODO: Convert to new style write function */
Packit c4476c
    bwrite_conv,
Packit c4476c
    fd_write,
Packit c4476c
    /* TODO: Convert to new style read function */
Packit c4476c
    bread_conv,
Packit c4476c
    fd_read,
Packit c4476c
    fd_puts,
Packit c4476c
    fd_gets,
Packit c4476c
    fd_ctrl,
Packit c4476c
    fd_new,
Packit c4476c
    fd_free,
Packit c4476c
    NULL,                       /* fd_callback_ctrl */
Packit c4476c
};
Packit c4476c
Packit c4476c
const BIO_METHOD *BIO_s_fd(void)
Packit c4476c
{
Packit c4476c
    return &methods_fdp;
Packit c4476c
}
Packit c4476c
Packit c4476c
BIO *BIO_new_fd(int fd, int close_flag)
Packit c4476c
{
Packit c4476c
    BIO *ret;
Packit c4476c
    ret = BIO_new(BIO_s_fd());
Packit c4476c
    if (ret == NULL)
Packit c4476c
        return NULL;
Packit c4476c
    BIO_set_fd(ret, fd, close_flag);
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_new(BIO *bi)
Packit c4476c
{
Packit c4476c
    bi->init = 0;
Packit c4476c
    bi->num = -1;
Packit c4476c
    bi->ptr = NULL;
Packit c4476c
    bi->flags = BIO_FLAGS_UPLINK; /* essentially redundant */
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_free(BIO *a)
Packit c4476c
{
Packit c4476c
    if (a == NULL)
Packit c4476c
        return 0;
Packit c4476c
    if (a->shutdown) {
Packit c4476c
        if (a->init) {
Packit c4476c
            UP_close(a->num);
Packit c4476c
        }
Packit c4476c
        a->init = 0;
Packit c4476c
        a->flags = BIO_FLAGS_UPLINK;
Packit c4476c
    }
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_read(BIO *b, char *out, int outl)
Packit c4476c
{
Packit c4476c
    int ret = 0;
Packit c4476c
Packit c4476c
    if (out != NULL) {
Packit c4476c
        clear_sys_error();
Packit c4476c
        ret = UP_read(b->num, out, outl);
Packit c4476c
        BIO_clear_retry_flags(b);
Packit c4476c
        if (ret <= 0) {
Packit c4476c
            if (BIO_fd_should_retry(ret))
Packit c4476c
                BIO_set_retry_read(b);
Packit c4476c
            else if (ret == 0)
Packit c4476c
                b->flags |= BIO_FLAGS_IN_EOF;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_write(BIO *b, const char *in, int inl)
Packit c4476c
{
Packit c4476c
    int ret;
Packit c4476c
    clear_sys_error();
Packit c4476c
    ret = UP_write(b->num, in, inl);
Packit c4476c
    BIO_clear_retry_flags(b);
Packit c4476c
    if (ret <= 0) {
Packit c4476c
        if (BIO_fd_should_retry(ret))
Packit c4476c
            BIO_set_retry_write(b);
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static long fd_ctrl(BIO *b, int cmd, long num, void *ptr)
Packit c4476c
{
Packit c4476c
    long ret = 1;
Packit c4476c
    int *ip;
Packit c4476c
Packit c4476c
    switch (cmd) {
Packit c4476c
    case BIO_CTRL_RESET:
Packit c4476c
        num = 0;
Packit c4476c
        /* fall thru */
Packit c4476c
    case BIO_C_FILE_SEEK:
Packit c4476c
        ret = (long)UP_lseek(b->num, num, 0);
Packit c4476c
        break;
Packit c4476c
    case BIO_C_FILE_TELL:
Packit c4476c
    case BIO_CTRL_INFO:
Packit c4476c
        ret = (long)UP_lseek(b->num, 0, 1);
Packit c4476c
        break;
Packit c4476c
    case BIO_C_SET_FD:
Packit c4476c
        fd_free(b);
Packit c4476c
        b->num = *((int *)ptr);
Packit c4476c
        b->shutdown = (int)num;
Packit c4476c
        b->init = 1;
Packit c4476c
        break;
Packit c4476c
    case BIO_C_GET_FD:
Packit c4476c
        if (b->init) {
Packit c4476c
            ip = (int *)ptr;
Packit c4476c
            if (ip != NULL)
Packit c4476c
                *ip = b->num;
Packit c4476c
            ret = b->num;
Packit c4476c
        } else
Packit c4476c
            ret = -1;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_GET_CLOSE:
Packit c4476c
        ret = b->shutdown;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_SET_CLOSE:
Packit c4476c
        b->shutdown = (int)num;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_PENDING:
Packit c4476c
    case BIO_CTRL_WPENDING:
Packit c4476c
        ret = 0;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_DUP:
Packit c4476c
    case BIO_CTRL_FLUSH:
Packit c4476c
        ret = 1;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_EOF:
Packit c4476c
        ret = (b->flags & BIO_FLAGS_IN_EOF) != 0 ? 1 : 0;
Packit c4476c
        break;
Packit c4476c
    default:
Packit c4476c
        ret = 0;
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_puts(BIO *bp, const char *str)
Packit c4476c
{
Packit c4476c
    int n, ret;
Packit c4476c
Packit c4476c
    n = strlen(str);
Packit c4476c
    ret = fd_write(bp, str, n);
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int fd_gets(BIO *bp, char *buf, int size)
Packit c4476c
{
Packit c4476c
    int ret = 0;
Packit c4476c
    char *ptr = buf;
Packit c4476c
    char *end = buf + size - 1;
Packit c4476c
Packit c4476c
    while (ptr < end && fd_read(bp, ptr, 1) > 0) {
Packit c4476c
        if (*ptr++ == '\n')
Packit c4476c
           break;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    ptr[0] = '\0';
Packit c4476c
Packit c4476c
    if (buf[0] != '\0')
Packit c4476c
        ret = strlen(buf);
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
int BIO_fd_should_retry(int i)
Packit c4476c
{
Packit c4476c
    int err;
Packit c4476c
Packit c4476c
    if ((i == 0) || (i == -1)) {
Packit c4476c
        err = get_last_sys_error();
Packit c4476c
Packit c4476c
        return BIO_fd_non_fatal_error(err);
Packit c4476c
    }
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
int BIO_fd_non_fatal_error(int err)
Packit c4476c
{
Packit c4476c
    switch (err) {
Packit c4476c
Packit c4476c
# ifdef EWOULDBLOCK
Packit c4476c
#  ifdef WSAEWOULDBLOCK
Packit c4476c
#   if WSAEWOULDBLOCK != EWOULDBLOCK
Packit c4476c
    case EWOULDBLOCK:
Packit c4476c
#   endif
Packit c4476c
#  else
Packit c4476c
    case EWOULDBLOCK:
Packit c4476c
#  endif
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# if defined(ENOTCONN)
Packit c4476c
    case ENOTCONN:
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# ifdef EINTR
Packit c4476c
    case EINTR:
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# ifdef EAGAIN
Packit c4476c
#  if EWOULDBLOCK != EAGAIN
Packit c4476c
    case EAGAIN:
Packit c4476c
#  endif
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# ifdef EPROTO
Packit c4476c
    case EPROTO:
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# ifdef EINPROGRESS
Packit c4476c
    case EINPROGRESS:
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# ifdef EALREADY
Packit c4476c
    case EALREADY:
Packit c4476c
# endif
Packit c4476c
        return 1;
Packit c4476c
    default:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
#endif