src/ssl/ring_buffer_bio.cpp

/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

// Based on the ring buffer implementation in
// NodeBIO (https://github.com/joyent/node/blob/master/src/node_crypto_bio.h).
// The following is the license for that implementation:

// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

#include "ring_buffer_bio.hpp"

#include <string.h>

#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
#define BIO_set_data(b, p) ((b)->ptr = p)
#define BIO_get_shutdown(b) ((b)->shutdown)
#define BIO_set_shutdown(b, s) ((b)->shutdown = s)
#define BIO_set_init(b, i) ((b)->init = i)
#endif

using namespace datastax::internal::rb;

#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
const BIO_METHOD RingBufferBio::method_ = { BIO_TYPE_MEM,           "ring buffer",
                                            RingBufferBio::write,   RingBufferBio::read,
                                            RingBufferBio::puts,    RingBufferBio::gets,
                                            RingBufferBio::ctrl,    RingBufferBio::create,
                                            RingBufferBio::destroy, NULL };
#else
BIO_METHOD* RingBufferBio::method_ = NULL;

void RingBufferBio::initialize() {
  method_ = BIO_meth_new(BIO_TYPE_MEM, "ring buffer");
  if (method_) {
    BIO_meth_set_write(method_, RingBufferBio::write);
    BIO_meth_set_read(method_, RingBufferBio::read);
    BIO_meth_set_puts(method_, RingBufferBio::puts);
    BIO_meth_set_gets(method_, RingBufferBio::gets);
    BIO_meth_set_ctrl(method_, RingBufferBio::ctrl);
    BIO_meth_set_create(method_, RingBufferBio::create);
    BIO_meth_set_destroy(method_, RingBufferBio::destroy);
  }
}

void RingBufferBio::cleanup() { BIO_meth_free(method_); }
#endif

BIO* RingBufferBio::create(RingBufferState* state) {
  // The const_cast doesn't violate const correctness.  OpenSSL's usage of
  // BIO_METHOD is effectively const but BIO_new() takes a non-const argument.
#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
  BIO* bio = BIO_new(const_cast<BIO_METHOD*>(&method_));
#else
  BIO* bio = BIO_new(method_);
#endif
  BIO_set_data(bio, state);
  return bio;
}

int RingBufferBio::create(BIO* bio) {
  // XXX Why am I doing it?!
  BIO_set_shutdown(bio, 1);
  BIO_set_init(bio, 1);

  return 1;
}

int RingBufferBio::destroy(BIO* bio) {
  if (bio == NULL) return 0;

  return 1;
}

int RingBufferBio::read(BIO* bio, char* out, int len) {
  int bytes;
  BIO_clear_retry_flags(bio);

  bytes = from_bio(bio)->ring_buffer->read(out, len);

  if (bytes == 0) {
    bytes = from_bio(bio)->ret;
    if (bytes != 0) {
      BIO_set_retry_read(bio);
    }
  }

  return bytes;
}

int RingBufferBio::write(BIO* bio, const char* data, int len) {
  BIO_clear_retry_flags(bio);

  from_bio(bio)->ring_buffer->write(data, len);

  return len;
}

int RingBufferBio::puts(BIO* bio, const char* str) { return write(bio, str, strlen(str)); }

int RingBufferBio::gets(BIO* bio, char* out, int size) {
  RingBuffer* ring_buffer = from_bio(bio)->ring_buffer;

  if (ring_buffer->length() == 0) return 0;

  int i = ring_buffer->index_of('\n', size);

  // Include '\n', if it's there.  If not, don't read off the end.
  if (i < size && i >= 0 && static_cast<size_t>(i) < ring_buffer->length()) i++;

  // Shift `i` a bit to NULL-terminate string later
  if (size == i) i--;

  // Flush read data
  ring_buffer->read(out, i);

  out[i] = 0;

  return i;
}

long RingBufferBio::ctrl(BIO* bio, int cmd, long num, void* ptr) {
  long ret = 1;

  switch (cmd) {
    case BIO_CTRL_RESET:
      from_bio(bio)->ring_buffer->reset();
      break;
    case BIO_CTRL_EOF:
      ret = from_bio(bio)->ring_buffer->length() == 0;
      break;
    case BIO_C_SET_BUF_MEM_EOF_RETURN:
      from_bio(bio)->ret = num;
      break;
    case BIO_CTRL_INFO:
      ret = from_bio(bio)->ring_buffer->length();
      if (ptr != NULL) *reinterpret_cast<void**>(ptr) = NULL;
      break;
    case BIO_C_SET_BUF_MEM:
      assert(0 && "Can't use SET_BUF_MEM_PTR with RingBufferBio");
      abort();
      break;
    case BIO_C_GET_BUF_MEM_PTR:
      assert(0 && "Can't use GET_BUF_MEM_PTR with RingBufferBio");
      ret = 0;
      break;
    case BIO_CTRL_GET_CLOSE:
      ret = BIO_get_shutdown(bio);
      break;
    case BIO_CTRL_SET_CLOSE:
      BIO_set_shutdown(bio, num);
      break;
    case BIO_CTRL_WPENDING:
      ret = 0;
      break;
    case BIO_CTRL_PENDING:
      ret = from_bio(bio)->ring_buffer->length();
      break;
    case BIO_CTRL_DUP:
    case BIO_CTRL_FLUSH:
      ret = 1;
      break;
    case BIO_CTRL_PUSH:
    case BIO_CTRL_POP:
    default:
      ret = 0;
      break;
  }
  return ret;
}