MSLib.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                 SharkSSL Embedded SSL/TLS Stack
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: MSLib.h 6673 2026-10-29 16:58:52Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2013 - 2026
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://sharkssl.com
 ****************************************************************************
 *
 *  
 *  Minnow Server: SharkSSL WebSocket Server
 */
 
#ifndef _MSLib_h
#define _MSLib_h
 
#include <selib.h>
 
struct MST;
 
/* RFC6455 Page 29: Opcode:  4 bits.
 * WS Opcodes with FIN=1. We do not manage WS fragments (FIN=0/1)
 * to keep the implementation small. Payloads are limited to 65535 bytes;
 * UTF-8 is not validated. Ordinary stream reads may split a frame.
 */
#define WSOP_Text   0x81
#define WSOP_Binary 0x82
/* RFC6455 5.5.  Control Frames */
#define WSOP_Close  0x88
#define WSOP_Ping   0x89
#define WSOP_Pong   0x8A
 
 
#define MS_ERR_ALLOC                 -10
 
#define MS_ERR_AUTHENTICATION        -11
 
#define MS_ERR_HTTP_HEADER_OVERFLOW  -12
 
#define MS_ERR_INVALID_HTTP          -13
 
#define MS_ERR_NOT_WEBSOCKET         -14
 
#define MS_ERR_READ                  -15
 
#define MS_ERR_READ_TMO              -16
 
#define MS_ERR_SSL_HANDSHAKE         -17
 
#define MS_ERR_WRITE                 -18
 
#define MS_ERR_ENCRYPTED_ZIP         -30
 
#define MS_ERR_FILE_IO               -31
 
#define MS_ERR_BUF_OVERFLOW          -40
 
#define MS_ERR_BUF_UNDERFLOW         -41
 /* end group MSLibErrCodes */ 
 
 
#define MAX_HTTP_H_SIZE 20
 
typedef int (*MSFetchPage)(void* hndl, struct MST* mst,U8* path);
 
typedef struct {
   const U8* b64Credent;
 
   const U8* realm;
 
   MSFetchPage fetchPage;
 
   void* fetchPageHndl;
 
   U8* request;
 
   U8* origin;
 
   U8* hKeys[MAX_HTTP_H_SIZE];
 
   U8* hVals[MAX_HTTP_H_SIZE];
} WssProtocolHandshake;
 
 
typedef struct
{
   /* Private members */
   U8* overflowPtr; /* Set if: consumed more data from stream than frame len */ 
   int overflowLen; /* overflowPtr len is used internally in wsRawRead */
   int frameHeaderIx; /* Cursor used when reading frameHeader from socket */
   U8* maskPtr;
   U8 frameHeader[8]; /*[0] FIN+opcode, [1] Payload len, [2-3] Ext payload len*/
 
   int frameLen;
 
   int bytesRead;
 
   U8 isTimeout;
} WssReadState;
 
 
/* Minnow Server Transmission Interface
 */
 
typedef struct {
   U8* recBuf;
   U8* sendBuf;
   U16 recBufSize;
   U16 sendBufSize;
} MSTBuf;
 
 
typedef struct MST
{
   SOCKET* sock;
#ifdef MS_SEC
   union {
      SharkSslCon* sc;
      MSTBuf b;
   } u;
#else
   MSTBuf b;
#endif
   BaBool isSecure;
} MST;
 
U8* MST_getSendBufPtr(MST* o);
 
U16 MST_getSendBufSize(MST* o);
 
int MST_read(MST* o,U8 **buf,U32 timeout);
 
int MST_write(MST* o,U8* buf, int len);
 
 
typedef struct
{
   WssReadState rs;
   MST mst;
} MS;
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Similar to the standard ANSI function strstr, except for that it
   does not rely on str being a zero terminated string. The compare is
   also case insensitive.
 
  \param str string to search.
  \param slen str len
  \param substrs substring to find in str.
*/
 
U8* msstrstrn(U8* str, int slen, const U8* substr);
 
U8* msCpAndInc(U8* dest, int* dlen, const U8* src, int slen);
 
 
U8* msB64Encode(U8* dest, int* dlen, const U8* src, int slen);
 
 
U8* msi2a(U8* dest, int* dlen, U32 n);
 
 
U8* msRespCT(U8* dest, int* dlen, int contentLen, const U8* extHeader);
 /* end group MsHelperFunc */ 
 
 
#define MS_constructor(o) memset(o,0,sizeof(MS))
 
#define MS_setSharkCon(o, sharkCon, socket)                \
   (o)->mst.u.sc=sharkCon,                                 \
      (o)->mst.sock=socket,                                \
      (o)->mst.isSecure=TRUE
   
#ifdef MS_SEC
#define MS_setSocket(o,socket,rec,recSize,send,sendSize)         \
   (o)->mst.sock=socket,                                         \
      (o)->mst.u.b.recBuf=rec,                                   \
      (o)->mst.u.b.recBufSize=recSize,                           \
      (o)->mst.u.b.sendBuf=send,                                 \
      (o)->mst.u.b.sendBufSize=sendSize,                         \
      (o)->mst.isSecure=FALSE
#else
 
#define MS_setSocket(o,socket,rec,recSize,send,sendSize)         \
   (o)->mst.sock=socket,                                         \
      (o)->mst.b.recBuf=rec,                                   \
      (o)->mst.b.recBufSize=recSize,                           \
      (o)->mst.b.sendBuf=send,                                 \
      (o)->mst.b.sendBufSize=sendSize,                         \
      (o)->mst.isSecure=FALSE
#endif      
 
U8* MS_respCT(MS* o, int* dlen, int contentLen, const U8* extHeader);
 
int MS_webServer(MS *o, WssProtocolHandshake* wph);
 
U8* MS_prepSend(MS* o, int extSize, int* maxSize);
 
int MS_send(MS* o, U8 opCode, int len);
 
 
#define MS_sendBin(o, len) MS_send(o, WSOP_Binary, len)
 
 
#define MS_sendText(o, len) MS_send(o, WSOP_Text, len)
 
 
int MS_write(MS *o, U8 opCode,const void* data,int len);
 
#define MS_writeBin(o,data,len) MS_write(o,WSOP_Binary,data,len)
 
#define MS_writeText(o,data,len) MS_write(o,WSOP_Text,data,len)
 
int MS_close(MS *o, int statusCode);
 
int MS_read(MS *o,U8 **buf,U32 timeout);
 
#ifdef __cplusplus
}
#endif
 /* end group MSLib */ 
 
#endif