src/node_crypto_bio.h

   1 // Copyright Joyent, Inc. and other Node contributors.
   2 //
   3 // Permission is hereby granted, free of charge, to any person obtaining a
   4 // copy of this software and associated documentation files (the
   5 // "Software"), to deal in the Software without restriction, including
   6 // without limitation the rights to use, copy, modify, merge, publish,
   7 // distribute, sublicense, and/or sell copies of the Software, and to permit
   8 // persons to whom the Software is furnished to do so, subject to the
   9 // following conditions:
  10 //
  11 // The above copyright notice and this permission notice shall be included
  12 // in all copies or substantial portions of the Software.
  13 //
  14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
  17 // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  18 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
  21
  22 #ifndef SRC_NODE_CRYPTO_BIO_H_
  23 #define SRC_NODE_CRYPTO_BIO_H_
  24
  25 #include "openssl/bio.h"
  26 #include <assert.h>
  27
  28 namespace node {
  29
  30 class NodeBIO {
  31  public:
  32   NodeBIO() : length_(0), read_head_(&head_), write_head_(&head_) {
  33     // Loop head
  34     head_.next_ = &head_;
  35   }
  36
  37   ~NodeBIO();
  38
  39   static BIO* New();
  40
  41   // Allocate new buffer for write if needed
  42   void TryAllocateForWrite();
  43
  44   // Read `len` bytes maximum into `out`, return actual number of read bytes
  45   size_t Read(char* out, size_t size);
  46
  47   // Memory optimization:
  48   // Deallocate children of write head's child if they're empty
  49   void FreeEmpty();
  50
  51   // Return pointer to internal data and amount of
  52   // contiguous data available to read
  53   char* Peek(size_t* size);
  54
  55   // Find first appearance of `delim` in buffer or `limit` if `delim`
  56   // wasn't found.
  57   size_t IndexOf(char delim, size_t limit);
  58
  59   // Discard all available data
  60   void Reset();
  61
  62   // Put `len` bytes from `data` into buffer
  63   void Write(const char* data, size_t size);
  64
  65   // Return pointer to internal data and amount of
  66   // contiguous data available for future writes
  67   char* PeekWritable(size_t* size);
  68
  69   // Commit reserved data
  70   void Commit(size_t size);
  71
  72   // Return size of buffer in bytes
  73   size_t inline Length() {
  74     return length_;
  75   }
  76
  77   static inline NodeBIO* FromBIO(BIO* bio) {
  78     assert(bio->ptr != NULL);
  79     return static_cast<NodeBIO*>(bio->ptr);
  80   }
  81
  82  private:
  83   static int New(BIO* bio);
  84   static int Free(BIO* bio);
  85   static int Read(BIO* bio, char* out, int len);
  86   static int Write(BIO* bio, const char* data, int len);
  87   static int Puts(BIO* bio, const char* str);
  88   static int Gets(BIO* bio, char* out, int size);
  89   static long Ctrl(BIO* bio, int cmd, long num, void* ptr);
  90
  91   // NOTE: Size is maximum TLS frame length, this is required if we want
  92   // to fit whole ClientHello into one Buffer of NodeBIO.
  93   static const size_t kBufferLength = 16 * 1024 + 5;
  94   static const BIO_METHOD method;
  95
  96   class Buffer {
  97    public:
  98     Buffer() : read_pos_(0), write_pos_(0), next_(NULL) {
  99     }
 100
 101     size_t read_pos_;
 102     size_t write_pos_;
 103     Buffer* next_;
 104     char data_[kBufferLength];
 105   };
 106
 107   size_t length_;
 108   Buffer head_;
 109   Buffer* read_head_;
 110   Buffer* write_head_;
 111 };
 112
 113 }  // namespace node
 114
 115 #endif  // SRC_NODE_CRYPTO_BIO_H_