cryptlib  3.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros
Classes | Macros | Typedefs | Enumerations | Functions | Variables
stream.h File Reference
#include "crypt.h"
#include <stdio.h>

Go to the source code of this file.

Classes

struct  ST
 
struct  URL_INFO
 
struct  HTTP_URI_INFO
 
struct  NET_CONNECT_INFO
 
struct  HTTP_DATA_INFO
 

Macros

#define FILE_FLAG_NONE   0x00 /* No file flag */
 
#define FILE_FLAG_READ   0x01 /* Open file for read access */
 
#define FILE_FLAG_WRITE   0x02 /* Open file for write access */
 
#define FILE_FLAG_EXCLUSIVE_ACCESS   0x04 /* Don't allow others access */
 
#define FILE_FLAG_PRIVATE   0x08 /* Set ACL's to allow owner access only */
 
#define FILE_FLAG_SENSITIVE   0x10 /* Use secure storage if available */
 
#define FILE_FLAG_RW_MASK   0x03 /* Mask for R/W bits */
 
#define FILE_FLAG_MAX   0x1F /* Maximum possible flag value */
 
#define STREAM_BUFSIZE   4096
 
#define initNetConnectInfo(netConnectInfo, netUserObject, netTimeout, netConnectTimeout, netOption)
 
#define initHttpDataInfo(httpDataInfo, dataBuffer, dataLength)
 
#define initHttpDataInfoEx(httpDataInfo, dataBuffer, dataLength, uriInfo)
 
#define sGetStatus(stream)   ( stream )->status
 
#define sStatusOK(stream)   cryptStatusOK( ( stream )->status )
 
#define netInitTCP()   CRYPT_OK
 
#define netSignalShutdown()
 
#define netEndTCP()
 

Typedefs

typedef struct ST STREAM
 

Enumerations

enum  BUILDPATH_OPTION_TYPE {
  BUILDPATH_NONE, BUILDPATH_CREATEPATH, BUILDPATH_GETPATH, BUILDPATH_RNDSEEDFILE,
  BUILDPATH_LAST
}
 
enum  STREAM_IOCTL_TYPE {
  STREAM_IOCTL_NONE, STREAM_IOCTL_IOBUFFER, STREAM_IOCTL_PARTIALREAD, STREAM_IOCTL_PARTIALWRITE,
  STREAM_IOCTL_READTIMEOUT, STREAM_IOCTL_WRITETIMEOUT, STREAM_IOCTL_HANDSHAKECOMPLETE, STREAM_IOCTL_CONNSTATE,
  STREAM_IOCTL_GETCLIENTNAME, STREAM_IOCTL_GETCLIENTNAMELEN, STREAM_IOCTL_GETCLIENTPORT, STREAM_IOCTL_HTTPREQTYPES,
  STREAM_IOCTL_LASTMESSAGE, STREAM_IOCTL_CLOSESENDCHANNEL, STREAM_IOCTL_ERRORINFO, STREAM_IOCTL_LAST
}
 
enum  STREAM_HTTPREQTYPE_TYPE {
  STREAM_HTTPREQTYPE_NONE, STREAM_HTTPREQTYPE_GET, STREAM_HTTPREQTYPE_POST, STREAM_HTTPREQTYPE_ANY,
  STREAM_HTTPREQTYPE_LAST
}
 
enum  STREAM_PROTOCOL_TYPE {
  STREAM_PROTOCOL_NONE, STREAM_PROTOCOL_TCPIP, STREAM_PROTOCOL_HTTP, STREAM_PROTOCOL_CMP,
  STREAM_PROTOCOL_LAST
}
 
enum  URL_TYPE {
  URL_TYPE_NONE, URL_TYPE_HTTP, URL_TYPE_HTTPS, URL_TYPE_SSH,
  URL_TYPE_CMP, URL_TYPE_TSP, URL_TYPE_LDAP, URL_TYPE_LAST
}
 
enum  NET_OPTION_TYPE {
  NET_OPTION_NONE, NET_OPTION_HOSTNAME, NET_OPTION_HOSTNAME_TUNNEL, NET_OPTION_TRANSPORTSESSION,
  NET_OPTION_NETWORKSOCKET, NET_OPTION_NETWORKSOCKET_DUMMY, NET_OPTION_LAST
}
 

Functions

RETVAL STDC_NONNULL_ARG ((1)) int sputc(INOUT STREAM *stream
 
 CHECK_RETVAL_RANGE (MAX_ERROR, 0xFF) STDC_NONNULL_ARG((1)) int sgetc(INOUT STREAM *stream)
 
CHECK_RETVAL STDC_NONNULL_ARG ((1, 2)) int sread(INOUT STREAM *stream
 
CHECK_RETVAL OUT_BUFFER_FIXED (length) void *buffer
 
RETVAL IN_BUFFER (length) const void *buffer
 
 CHECK_RETVAL_RANGE (0, MAX_INTLENGTH) STDC_NONNULL_ARG((1)) int stell(const STREAM *stream)
 
RETVAL IN_ENUM (STREAM_IOCTL) const STREAM_IOCTL_TYPE type
 
RETVAL IN_BUFFER (dataLen) const void *data
 
CHECK_RETVAL OUT_BUFFER_FIXED (dataMaxLen) void *data
 
RETVAL OUT_BUFFER_OPT_FIXED (length) void *buffer
 
CHECK_RETVAL OUT_BUFFER_ALLOC_OPT (dataSize) void **dataPtrPtr
 
CHECK_RETVAL STDC_NONNULL_ARG ((1, 3)) int sMemGetDataBlockAbs(INOUT STREAM *stream
 
CHECK_RETVAL STDC_NONNULL_ARG ((1, 2, 3)) int sMemGetDataBlockRemaining(INOUT STREAM *stream
 
CHECK_RETVAL IN_STRING const char IN_FLAGS (FILE) const int mode)
 
CHECK_RETVAL INOUT STREAM OUT_BUFFER_ALLOC_OPT (length) void **bufPtrPtr
 
CHECK_RETVAL IN_BUFFER (urlLen) const char *url
 
CHECK_RETVAL IN_LENGTH_SHORT
const int 
IN_ENUM_OPT (URL_TYPE) const URL_TYPE urlTypeHint)
 
CHECK_RETVAL STDC_NONNULL_ARG ((1, 3, 4)) int sNetConnect(OUT STREAM *stream
 
CHECK_RETVAL IN_ENUM (STREAM_PROTOCOL) const STREAM_PROTOCOL_TYPE protocol
 
CHECK_RETVAL *pathLen char
IN_LENGTH_SHORT const int
OUT_LENGTH_SHORT_Z int 
IN_BUFFER (fileNameLen) const char *fileName
 
CHECK_RETVAL *pathLen char
IN_LENGTH_SHORT const int
OUT_LENGTH_SHORT_Z int
IN_LENGTH_SHORT const int 
IN_ENUM (BUILDPATH_OPTION) const BUILDPATH_OPTION_TYPE option)
 

Variables

RETVAL IN_BYTE const int ch
 
CHECK_RETVAL IN_LENGTH const int length
 
RETVAL IN_LENGTH_Z const long position
 
RETVAL IN_INT const int value
 
RETVAL IN_LENGTH const int dataLen
 
CHECK_RETVAL IN_LENGTH_SHORT
const int 
dataMaxLen
 
RETVAL IN_LENGTH const long offset
 
RETVAL IN_ERROR const int status
 
CHECK_RETVAL IN_LENGTH const int dataSize
 
CHECK_RETVAL
OUT_BUFFER_ALLOC_OPT length
void ** 
dataPtrPtr
 
CHECK_RETVAL IN_STRING const char * fileName
 
CHECK_RETVAL INOUT STREAMfileStream
 
CHECK_RETVAL IN_LENGTH_SHORT
const int 
urlLen
 
CHECK_RETVAL const
NET_CONNECT_INFO
connectInfo
 
CHECK_RETVAL const
NET_CONNECT_INFO INOUT
ERROR_INFO
errorInfo
 
CHECK_RETVAL *pathLen char * path
 
CHECK_RETVAL *pathLen char
IN_LENGTH_SHORT const int 
pathMaxLen
 
CHECK_RETVAL *pathLen char
IN_LENGTH_SHORT const int
OUT_LENGTH_SHORT_Z int * 
pathLen
 
CHECK_RETVAL *pathLen char
IN_LENGTH_SHORT const int
OUT_LENGTH_SHORT_Z int
IN_LENGTH_SHORT const int 
fileNameLen
 

Macro Definition Documentation

#define FILE_FLAG_EXCLUSIVE_ACCESS   0x04 /* Don't allow others access */

Definition at line 51 of file stream.h.

#define FILE_FLAG_MAX   0x1F /* Maximum possible flag value */

Definition at line 55 of file stream.h.

#define FILE_FLAG_NONE   0x00 /* No file flag */

Definition at line 48 of file stream.h.

#define FILE_FLAG_PRIVATE   0x08 /* Set ACL's to allow owner access only */

Definition at line 52 of file stream.h.

#define FILE_FLAG_READ   0x01 /* Open file for read access */

Definition at line 49 of file stream.h.

#define FILE_FLAG_RW_MASK   0x03 /* Mask for R/W bits */

Definition at line 54 of file stream.h.

#define FILE_FLAG_SENSITIVE   0x10 /* Use secure storage if available */

Definition at line 53 of file stream.h.

#define FILE_FLAG_WRITE   0x02 /* Open file for write access */

Definition at line 50 of file stream.h.

#define initHttpDataInfo (   httpDataInfo,
  dataBuffer,
  dataLength 
)
Value:
{ \
memset( httpDataInfo, 0, sizeof( HTTP_DATA_INFO ) ); \
( httpDataInfo )->buffer= dataBuffer; \
( httpDataInfo )->bufSize = dataLength; \
}

Definition at line 322 of file stream.h.

#define initHttpDataInfoEx (   httpDataInfo,
  dataBuffer,
  dataLength,
  uriInfo 
)
Value:
{ \
memset( httpDataInfo, 0, sizeof( HTTP_DATA_INFO ) ); \
memset( uriInfo, 0, sizeof( HTTP_URI_INFO ) ); \
( httpDataInfo )->buffer= dataBuffer; \
( httpDataInfo )->bufSize = dataLength; \
( httpDataInfo )->reqInfo = uriInfo; \
}

Definition at line 328 of file stream.h.

#define initNetConnectInfo (   netConnectInfo,
  netUserObject,
  netTimeout,
  netConnectTimeout,
  netOption 
)
Value:
{ \
memset( netConnectInfo, 0, sizeof( NET_CONNECT_INFO ) ); \
( netConnectInfo )->networkSocket = CRYPT_ERROR; \
( netConnectInfo )->iCryptSession = CRYPT_ERROR; \
( netConnectInfo )->iUserObject = netUserObject; \
( netConnectInfo )->timeout = netTimeout; \
( netConnectInfo )->connectTimeout = netConnectTimeout; \
( netConnectInfo )->options = netOption; \
}

Definition at line 264 of file stream.h.

#define netEndTCP ( )

Definition at line 532 of file stream.h.

#define netInitTCP ( )    CRYPT_OK

Definition at line 530 of file stream.h.

#define netSignalShutdown ( )

Definition at line 531 of file stream.h.

#define sGetStatus (   stream)    ( stream )->status

Definition at line 391 of file stream.h.

#define sStatusOK (   stream)    cryptStatusOK( ( stream )->status )

Definition at line 392 of file stream.h.

#define STREAM_BUFSIZE   4096

Definition at line 120 of file stream.h.

Typedef Documentation

typedef struct ST STREAM

Enumeration Type Documentation

Enumerator:
BUILDPATH_NONE 
BUILDPATH_CREATEPATH 
BUILDPATH_GETPATH 
BUILDPATH_RNDSEEDFILE 
BUILDPATH_LAST 

Definition at line 59 of file stream.h.

Enumerator:
NET_OPTION_NONE 
NET_OPTION_HOSTNAME 
NET_OPTION_HOSTNAME_TUNNEL 
NET_OPTION_TRANSPORTSESSION 
NET_OPTION_NETWORKSOCKET 
NET_OPTION_NETWORKSOCKET_DUMMY 
NET_OPTION_LAST 

Definition at line 235 of file stream.h.

Enumerator:
STREAM_HTTPREQTYPE_NONE 
STREAM_HTTPREQTYPE_GET 
STREAM_HTTPREQTYPE_POST 
STREAM_HTTPREQTYPE_ANY 
STREAM_HTTPREQTYPE_LAST 

Definition at line 90 of file stream.h.

Enumerator:
STREAM_IOCTL_NONE 
STREAM_IOCTL_IOBUFFER 
STREAM_IOCTL_PARTIALREAD 
STREAM_IOCTL_PARTIALWRITE 
STREAM_IOCTL_READTIMEOUT 
STREAM_IOCTL_WRITETIMEOUT 
STREAM_IOCTL_HANDSHAKECOMPLETE 
STREAM_IOCTL_CONNSTATE 
STREAM_IOCTL_GETCLIENTNAME 
STREAM_IOCTL_GETCLIENTNAMELEN 
STREAM_IOCTL_GETCLIENTPORT 
STREAM_IOCTL_HTTPREQTYPES 
STREAM_IOCTL_LASTMESSAGE 
STREAM_IOCTL_CLOSESENDCHANNEL 
STREAM_IOCTL_ERRORINFO 
STREAM_IOCTL_LAST 

Definition at line 69 of file stream.h.

Enumerator:
STREAM_PROTOCOL_NONE 
STREAM_PROTOCOL_TCPIP 
STREAM_PROTOCOL_HTTP 
STREAM_PROTOCOL_CMP 
STREAM_PROTOCOL_LAST 

Definition at line 100 of file stream.h.

enum URL_TYPE
Enumerator:
URL_TYPE_NONE 
URL_TYPE_HTTP 
URL_TYPE_HTTPS 
URL_TYPE_SSH 
URL_TYPE_CMP 
URL_TYPE_TSP 
URL_TYPE_LDAP 
URL_TYPE_LAST 

Definition at line 194 of file stream.h.

Function Documentation

CHECK_RETVAL_RANGE ( MAX_ERROR  ,
0xFF   
)

Definition at line 356 of file stream.c.

CHECK_RETVAL_RANGE ( ,
MAX_INTLENGTH   
) const
RETVAL IN_BUFFER ( length  ) const
RETVAL IN_BUFFER ( dataLen  ) const
CHECK_RETVAL IN_BUFFER ( urlLen  ) const
RETVAL IN_ENUM ( STREAM_IOCTL  ) const
CHECK_RETVAL IN_ENUM ( STREAM_PROTOCOL  ) const
CHECK_RETVAL * pathLen char IN_LENGTH_SHORT const int OUT_LENGTH_SHORT_Z int IN_LENGTH_SHORT const int IN_ENUM ( BUILDPATH_OPTION  ) const
CHECK_RETVAL IN_LENGTH_SHORT const int IN_ENUM_OPT ( URL_TYPE  ) const
CHECK_RETVAL IN_STRING const char IN_FLAGS ( FILE  ) const
CHECK_RETVAL IN_LENGTH_Z const int OUT_BUFFER_ALLOC_OPT ( dataSize  )
CHECK_RETVAL INOUT STREAM OUT_BUFFER_ALLOC_OPT ( length  )
RETVAL OUT_BUFFER_FIXED ( length  )
CHECK_RETVAL OUT_BUFFER_FIXED ( dataMaxLen  )
RETVAL OUT_BUFFER_OPT_FIXED ( length  )
RETVAL STDC_NONNULL_ARG ( (1)  )

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 26 of file ctx_attr.c.

CHECK_RETVAL STDC_NONNULL_ARG ( (1, 2)  )
CHECK_RETVAL STDC_NONNULL_ARG ( (1, 3)  )
CHECK_RETVAL STDC_NONNULL_ARG ( (1, 2, 3)  )
CHECK_RETVAL STDC_NONNULL_ARG ( (1, 3, 4)  )

Variable Documentation

Definition at line 346 of file stream.h.

Definition at line 492 of file stream.h.

RETVAL IN_LENGTH const int dataLen

Definition at line 371 of file stream.h.

Definition at line 376 of file stream.h.

Definition at line 463 of file stream.h.

Definition at line 455 of file stream.h.

Definition at line 492 of file stream.h.

CHECK_RETVAL IN_STRING const char* fileName

Definition at line 469 of file stream.h.

Definition at line 518 of file stream.h.

CHECK_RETVAL INOUT STREAM* fileStream

Definition at line 477 of file stream.h.

Definition at line 352 of file stream.h.

Definition at line 382 of file stream.h.

CHECK_RETVAL * pathLen char* path

Definition at line 514 of file stream.h.

CHECK_RETVAL * pathLen char IN_LENGTH_SHORT const int OUT_LENGTH_SHORT_Z int* pathLen

Definition at line 514 of file stream.h.

CHECK_RETVAL * pathLen char IN_LENGTH_SHORT const int pathMaxLen

Definition at line 514 of file stream.h.

Definition at line 360 of file stream.h.

RETVAL IN_ERROR const int status

Definition at line 397 of file stream.h.

Definition at line 486 of file stream.h.

Definition at line 366 of file stream.h.